From: Liming Gao Date: Wed, 15 May 2019 12:02:18 +0000 (+0800) Subject: NetworkPkg: Move Network library and drivers from MdeModulePkg to NetworkPkg X-Git-Tag: edk2-stable201905~44 X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=commitdiff_plain;h=4542f8b8135f1f1ee5654e25139be9769e139ddd NetworkPkg: Move Network library and drivers from MdeModulePkg to NetworkPkg Signed-off-by: Liming Gao Cc: Siyuan Fu Cc: Jiaxin Wu Reviewed-by: Jiaxin Wu Reviewed-by: Siyuan Fu --- diff --git a/MdeModulePkg/Library/DxeDpcLib/DpcLib.c b/MdeModulePkg/Library/DxeDpcLib/DpcLib.c deleted file mode 100644 index 29d810776e..0000000000 --- a/MdeModulePkg/Library/DxeDpcLib/DpcLib.c +++ /dev/null @@ -1,94 +0,0 @@ -/** @file - Help functions to access UDP service. - -Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent -**/ - -#include -#include -#include -#include - -// -// Pointer to the DPC Protocol -// -EFI_DPC_PROTOCOL *mDpc; - -/** - This constructor function caches the EFI_DPC_PROTOCOL pointer. - - @param[in] ImageHandle The firmware allocated handle for the EFI image. - @param[in] SystemTable A pointer to the EFI System Table. - - @retval EFI_SUCCESS The constructor always return EFI_SUCCESS. - -**/ -EFI_STATUS -EFIAPI -DpcLibConstructor ( - IN EFI_HANDLE ImageHandle, - IN EFI_SYSTEM_TABLE *SystemTable - ) -{ - EFI_STATUS Status; - - // - // Locate the EFI_DPC_PROTOCOL in the handle database - // - Status = gBS->LocateProtocol (&gEfiDpcProtocolGuid, NULL, (VOID **)&mDpc); - ASSERT_EFI_ERROR (Status); - - return Status; -} - -/** - Add a Deferred Procedure Call to the end of the DPC queue. - - @param[in] DpcTpl The EFI_TPL that the DPC should be invoked. - @param[in] DpcProcedure Pointer to the DPC's function. - @param[in] DpcContext Pointer to the DPC's context. Passed to DpcProcedure - when DpcProcedure is invoked. - - @retval EFI_SUCCESS The DPC was queued. - @retval EFI_INVALID_PARAMETER DpcTpl is not a valid EFI_TPL. - @retval EFI_INVALID_PARAMETER DpcProcedure is NULL. - @retval EFI_OUT_OF_RESOURCES There are not enough resources available to - add the DPC to the queue. - -**/ -EFI_STATUS -EFIAPI -QueueDpc ( - IN EFI_TPL DpcTpl, - IN EFI_DPC_PROCEDURE DpcProcedure, - IN VOID *DpcContext OPTIONAL - ) -{ - // - // Call the EFI_DPC_PROTOCOL to queue the DPC - // - return mDpc->QueueDpc (mDpc, DpcTpl, DpcProcedure, DpcContext); -} - -/** - Dispatch the queue of DPCs. ALL DPCs that have been queued with a DpcTpl - value greater than or equal to the current TPL are invoked in the order that - they were queued. DPCs with higher DpcTpl values are invoked before DPCs with - lower DpcTpl values. - - @retval EFI_SUCCESS One or more DPCs were invoked. - @retval EFI_NOT_FOUND No DPCs were invoked. - -**/ -EFI_STATUS -EFIAPI -DispatchDpc ( - VOID - ) -{ - // - // Call the EFI_DPC_PROTOCOL to dispatch previously queued DPCs - // - return mDpc->DispatchDpc (mDpc); -} diff --git a/MdeModulePkg/Library/DxeDpcLib/DxeDpcLib.inf b/MdeModulePkg/Library/DxeDpcLib/DxeDpcLib.inf deleted file mode 100644 index 1c23729ce3..0000000000 --- a/MdeModulePkg/Library/DxeDpcLib/DxeDpcLib.inf +++ /dev/null @@ -1,40 +0,0 @@ -## @file -# This library instance provides DPC service by consuming EFI DPC Protocol. -# -# Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
-# SPDX-License-Identifier: BSD-2-Clause-Patent -# -## - -[Defines] - INF_VERSION = 0x00010005 - BASE_NAME = DxeDpcLib - MODULE_UNI_FILE = DxeDpcLib.uni - FILE_GUID = 38897D86-FF36-4472-AE64-1DB9AE715C81 - MODULE_TYPE = DXE_DRIVER - VERSION_STRING = 1.0 - LIBRARY_CLASS = DpcLib|DXE_CORE DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER - CONSTRUCTOR = DpcLibConstructor - -# -# The following information is for reference only and not required by the build tools. -# -# VALID_ARCHITECTURES = IA32 X64 EBC -# - -[Sources] - DpcLib.c - -[Packages] - MdePkg/MdePkg.dec - MdeModulePkg/MdeModulePkg.dec - -[LibraryClasses] - DebugLib - UefiBootServicesTableLib - -[Protocols] - gEfiDpcProtocolGuid ## CONSUMES - -[Depex.common.DXE_DRIVER, Depex.common.DXE_RUNTIME_DRIVER, Depex.common.DXE_SAL_DRIVER, Depex.common.DXE_SMM_DRIVER] - gEfiDpcProtocolGuid diff --git a/MdeModulePkg/Library/DxeDpcLib/DxeDpcLib.uni b/MdeModulePkg/Library/DxeDpcLib/DxeDpcLib.uni deleted file mode 100644 index 3105bbcfe0..0000000000 --- a/MdeModulePkg/Library/DxeDpcLib/DxeDpcLib.uni +++ /dev/null @@ -1,16 +0,0 @@ -// /** @file -// This library instance provides DPC service by consuming EFI DPC Protocol. -// -// This library instance provides the DPC service by consuming EFI DPC Protocol. -// -// Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
-// -// SPDX-License-Identifier: BSD-2-Clause-Patent -// -// **/ - - -#string STR_MODULE_ABSTRACT #language en-US "Provides the DPC service by consuming EFI DPC Protocol" - -#string STR_MODULE_DESCRIPTION #language en-US "This library instance provides the DPC service by consuming EFI DPC Protocol." - diff --git a/MdeModulePkg/Library/DxeHttpLib/DxeHttpLib.c b/MdeModulePkg/Library/DxeHttpLib/DxeHttpLib.c deleted file mode 100644 index 8b74554cd9..0000000000 --- a/MdeModulePkg/Library/DxeHttpLib/DxeHttpLib.c +++ /dev/null @@ -1,2084 +0,0 @@ -/** @file - This library is used to share code between UEFI network stack modules. - It provides the helper routines to parse the HTTP message byte stream. - -Copyright (c) 2015 - 2019, Intel Corporation. All rights reserved.
-(C) Copyright 2016 Hewlett Packard Enterprise Development LP
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "DxeHttpLib.h" - - - -/** - Decode a percent-encoded URI component to the ASCII character. - - Decode the input component in Buffer according to RFC 3986. The caller is responsible to make - sure ResultBuffer points to a buffer with size equal or greater than ((AsciiStrSize (Buffer)) - in bytes. - - @param[in] Buffer The pointer to a percent-encoded URI component. - @param[in] BufferLength Length of Buffer in bytes. - @param[out] ResultBuffer Point to the buffer to store the decode result. - @param[out] ResultLength Length of decoded string in ResultBuffer in bytes. - - @retval EFI_SUCCESS Successfully decoded the URI. - @retval EFI_INVALID_PARAMETER Buffer is not a valid percent-encoded string. - -**/ -EFI_STATUS -EFIAPI -UriPercentDecode ( - IN CHAR8 *Buffer, - IN UINT32 BufferLength, - OUT CHAR8 *ResultBuffer, - OUT UINT32 *ResultLength - ) -{ - UINTN Index; - UINTN Offset; - CHAR8 HexStr[3]; - - if (Buffer == NULL || BufferLength == 0 || ResultBuffer == NULL) { - return EFI_INVALID_PARAMETER; - } - - Index = 0; - Offset = 0; - HexStr[2] = '\0'; - while (Index < BufferLength) { - if (Buffer[Index] == '%') { - if (Index + 1 >= BufferLength || Index + 2 >= BufferLength || - !NET_IS_HEX_CHAR (Buffer[Index+1]) || !NET_IS_HEX_CHAR (Buffer[Index+2])) { - return EFI_INVALID_PARAMETER; - } - HexStr[0] = Buffer[Index+1]; - HexStr[1] = Buffer[Index+2]; - ResultBuffer[Offset] = (CHAR8) AsciiStrHexToUintn (HexStr); - Index += 3; - } else { - ResultBuffer[Offset] = Buffer[Index]; - Index++; - } - Offset++; - } - - *ResultLength = (UINT32) Offset; - - return EFI_SUCCESS; -} - -/** - This function return the updated state according to the input state and next character of - the authority. - - @param[in] Char Next character. - @param[in] State Current value of the parser state machine. - @param[in] IsRightBracket TRUE if there is an sign ']' in the authority component and - indicates the next part is ':' before Port. - - @return Updated state value. -**/ -HTTP_URL_PARSE_STATE -NetHttpParseAuthorityChar ( - IN CHAR8 Char, - IN HTTP_URL_PARSE_STATE State, - IN BOOLEAN *IsRightBracket - ) -{ - - // - // RFC 3986: - // The authority component is preceded by a double slash ("//") and is - // terminated by the next slash ("/"), question mark ("?"), or number - // sign ("#") character, or by the end of the URI. - // - if (Char == ' ' || Char == '\r' || Char == '\n') { - return UrlParserStateMax; - } - - // - // authority = [ userinfo "@" ] host [ ":" port ] - // - switch (State) { - case UrlParserUserInfo: - if (Char == '@') { - return UrlParserHostStart; - } - break; - - case UrlParserHost: - case UrlParserHostStart: - if (Char == '[') { - return UrlParserHostIpv6; - } - - if (Char == ':') { - return UrlParserPortStart; - } - - return UrlParserHost; - - case UrlParserHostIpv6: - if (Char == ']') { - *IsRightBracket = TRUE; - } - - if (Char == ':' && *IsRightBracket) { - return UrlParserPortStart; - } - return UrlParserHostIpv6; - - case UrlParserPort: - case UrlParserPortStart: - return UrlParserPort; - - default: - break; - } - - return State; -} - -/** - This function parse the authority component of the input URL and update the parser. - - @param[in] Url The pointer to a HTTP URL string. - @param[in] FoundAt TRUE if there is an at sign ('@') in the authority component. - @param[in, out] UrlParser Pointer to the buffer of the parse result. - - @retval EFI_SUCCESS Successfully parse the authority. - @retval EFI_INVALID_PARAMETER The Url is invalid to parse the authority component. - -**/ -EFI_STATUS -NetHttpParseAuthority ( - IN CHAR8 *Url, - IN BOOLEAN FoundAt, - IN OUT HTTP_URL_PARSER *UrlParser - ) -{ - CHAR8 *Char; - CHAR8 *Authority; - UINT32 Length; - HTTP_URL_PARSE_STATE State; - UINT32 Field; - UINT32 OldField; - BOOLEAN IsrightBracket; - - ASSERT ((UrlParser->FieldBitMap & BIT (HTTP_URI_FIELD_AUTHORITY)) != 0); - - // - // authority = [ userinfo "@" ] host [ ":" port ] - // - if (FoundAt) { - State = UrlParserUserInfo; - } else { - State = UrlParserHost; - } - - IsrightBracket = FALSE; - Field = HTTP_URI_FIELD_MAX; - OldField = Field; - Authority = Url + UrlParser->FieldData[HTTP_URI_FIELD_AUTHORITY].Offset; - Length = UrlParser->FieldData[HTTP_URI_FIELD_AUTHORITY].Length; - for (Char = Authority; Char < Authority + Length; Char++) { - State = NetHttpParseAuthorityChar (*Char, State, &IsrightBracket); - switch (State) { - case UrlParserStateMax: - return EFI_INVALID_PARAMETER; - - case UrlParserHostStart: - case UrlParserPortStart: - continue; - - case UrlParserUserInfo: - Field = HTTP_URI_FIELD_USERINFO; - break; - - case UrlParserHost: - Field = HTTP_URI_FIELD_HOST; - break; - - case UrlParserHostIpv6: - Field = HTTP_URI_FIELD_HOST; - break; - - case UrlParserPort: - Field = HTTP_URI_FIELD_PORT; - break; - - default: - ASSERT (FALSE); - } - - // - // Field not changed, count the length. - // - ASSERT (Field < HTTP_URI_FIELD_MAX); - if (Field == OldField) { - UrlParser->FieldData[Field].Length++; - continue; - } - - // - // New field start - // - UrlParser->FieldBitMap |= BIT (Field); - UrlParser->FieldData[Field].Offset = (UINT32) (Char - Url); - UrlParser->FieldData[Field].Length = 1; - OldField = Field; - } - - return EFI_SUCCESS; -} - -/** - This function return the updated state according to the input state and next character of a URL. - - @param[in] Char Next character. - @param[in] State Current value of the parser state machine. - - @return Updated state value. - -**/ -HTTP_URL_PARSE_STATE -NetHttpParseUrlChar ( - IN CHAR8 Char, - IN HTTP_URL_PARSE_STATE State - ) -{ - if (Char == ' ' || Char == '\r' || Char == '\n') { - return UrlParserStateMax; - } - - // - // http_URL = "http:" "//" host [ ":" port ] [ abs_path [ "?" query ]] - // - // Request-URI = "*" | absolute-URI | path-absolute | authority - // - // absolute-URI = scheme ":" hier-part [ "?" query ] - // path-absolute = "/" [ segment-nz *( "/" segment ) ] - // authority = [ userinfo "@" ] host [ ":" port ] - // - switch (State) { - case UrlParserUrlStart: - if (Char == '*' || Char == '/') { - return UrlParserPath; - } - return UrlParserScheme; - - case UrlParserScheme: - if (Char == ':') { - return UrlParserSchemeColon; - } - break; - - case UrlParserSchemeColon: - if (Char == '/') { - return UrlParserSchemeColonSlash; - } - break; - - case UrlParserSchemeColonSlash: - if (Char == '/') { - return UrlParserSchemeColonSlashSlash; - } - break; - - case UrlParserAtInAuthority: - if (Char == '@') { - return UrlParserStateMax; - } - - case UrlParserAuthority: - case UrlParserSchemeColonSlashSlash: - if (Char == '@') { - return UrlParserAtInAuthority; - } - if (Char == '/') { - return UrlParserPath; - } - if (Char == '?') { - return UrlParserQueryStart; - } - if (Char == '#') { - return UrlParserFragmentStart; - } - return UrlParserAuthority; - - case UrlParserPath: - if (Char == '?') { - return UrlParserQueryStart; - } - if (Char == '#') { - return UrlParserFragmentStart; - } - break; - - case UrlParserQuery: - case UrlParserQueryStart: - if (Char == '#') { - return UrlParserFragmentStart; - } - return UrlParserQuery; - - case UrlParserFragmentStart: - return UrlParserFragment; - - default: - break; - } - - return State; -} -/** - Create a URL parser for the input URL string. - - This function will parse and dereference the input HTTP URL into it components. The original - content of the URL won't be modified and the result will be returned in UrlParser, which can - be used in other functions like NetHttpUrlGetHostName(). - - @param[in] Url The pointer to a HTTP URL string. - @param[in] Length Length of Url in bytes. - @param[in] IsConnectMethod Whether the Url is used in HTTP CONNECT method or not. - @param[out] UrlParser Pointer to the returned buffer to store the parse result. - - @retval EFI_SUCCESS Successfully dereferenced the HTTP URL. - @retval EFI_INVALID_PARAMETER UrlParser is NULL or Url is not a valid HTTP URL. - @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources. - -**/ -EFI_STATUS -EFIAPI -HttpParseUrl ( - IN CHAR8 *Url, - IN UINT32 Length, - IN BOOLEAN IsConnectMethod, - OUT VOID **UrlParser - ) -{ - HTTP_URL_PARSE_STATE State; - CHAR8 *Char; - UINT32 Field; - UINT32 OldField; - BOOLEAN FoundAt; - EFI_STATUS Status; - HTTP_URL_PARSER *Parser; - - Parser = NULL; - - if (Url == NULL || Length == 0 || UrlParser == NULL) { - return EFI_INVALID_PARAMETER; - } - - Parser = AllocateZeroPool (sizeof (HTTP_URL_PARSER)); - if (Parser == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - if (IsConnectMethod) { - // - // According to RFC 2616, the authority form is only used by the CONNECT method. - // - State = UrlParserAuthority; - } else { - State = UrlParserUrlStart; - } - - Field = HTTP_URI_FIELD_MAX; - OldField = Field; - FoundAt = FALSE; - for (Char = Url; Char < Url + Length; Char++) { - // - // Update state machine according to next char. - // - State = NetHttpParseUrlChar (*Char, State); - - switch (State) { - case UrlParserStateMax: - FreePool (Parser); - return EFI_INVALID_PARAMETER; - - case UrlParserSchemeColon: - case UrlParserSchemeColonSlash: - case UrlParserSchemeColonSlashSlash: - case UrlParserQueryStart: - case UrlParserFragmentStart: - // - // Skip all the delimiting char: "://" "?" "@" - // - continue; - - case UrlParserScheme: - Field = HTTP_URI_FIELD_SCHEME; - break; - - case UrlParserAtInAuthority: - FoundAt = TRUE; - case UrlParserAuthority: - Field = HTTP_URI_FIELD_AUTHORITY; - break; - - case UrlParserPath: - Field = HTTP_URI_FIELD_PATH; - break; - - case UrlParserQuery: - Field = HTTP_URI_FIELD_QUERY; - break; - - case UrlParserFragment: - Field = HTTP_URI_FIELD_FRAGMENT; - break; - - default: - ASSERT (FALSE); - } - - // - // Field not changed, count the length. - // - ASSERT (Field < HTTP_URI_FIELD_MAX); - if (Field == OldField) { - Parser->FieldData[Field].Length++; - continue; - } - - // - // New field start - // - Parser->FieldBitMap |= BIT (Field); - Parser->FieldData[Field].Offset = (UINT32) (Char - Url); - Parser->FieldData[Field].Length = 1; - OldField = Field; - } - - // - // If has authority component, continue to parse the username, host and port. - // - if ((Parser->FieldBitMap & BIT (HTTP_URI_FIELD_AUTHORITY)) != 0) { - Status = NetHttpParseAuthority (Url, FoundAt, Parser); - if (EFI_ERROR (Status)) { - FreePool (Parser); - return Status; - } - } - - *UrlParser = Parser; - return EFI_SUCCESS; -} - -/** - Get the Hostname from a HTTP URL. - - This function will return the HostName according to the Url and previous parse result ,and - it is the caller's responsibility to free the buffer returned in *HostName. - - @param[in] Url The pointer to a HTTP URL string. - @param[in] UrlParser URL Parse result returned by NetHttpParseUrl(). - @param[out] HostName Pointer to a buffer to store the HostName. - - @retval EFI_SUCCESS Successfully get the required component. - @retval EFI_INVALID_PARAMETER Uri is NULL or HostName is NULL or UrlParser is invalid. - @retval EFI_NOT_FOUND No hostName component in the URL. - @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources. - -**/ -EFI_STATUS -EFIAPI -HttpUrlGetHostName ( - IN CHAR8 *Url, - IN VOID *UrlParser, - OUT CHAR8 **HostName - ) -{ - CHAR8 *Name; - EFI_STATUS Status; - UINT32 ResultLength; - HTTP_URL_PARSER *Parser; - - if (Url == NULL || UrlParser == NULL || HostName == NULL) { - return EFI_INVALID_PARAMETER; - } - - Parser = (HTTP_URL_PARSER *) UrlParser; - - if ((Parser->FieldBitMap & BIT (HTTP_URI_FIELD_HOST)) == 0) { - return EFI_NOT_FOUND; - } - - Name = AllocatePool (Parser->FieldData[HTTP_URI_FIELD_HOST].Length + 1); - if (Name == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - Status = UriPercentDecode ( - Url + Parser->FieldData[HTTP_URI_FIELD_HOST].Offset, - Parser->FieldData[HTTP_URI_FIELD_HOST].Length, - Name, - &ResultLength - ); - if (EFI_ERROR (Status)) { - FreePool (Name); - return Status; - } - - Name[ResultLength] = '\0'; - *HostName = Name; - return EFI_SUCCESS; -} - - -/** - Get the IPv4 address from a HTTP URL. - - This function will return the IPv4 address according to the Url and previous parse result. - - @param[in] Url The pointer to a HTTP URL string. - @param[in] UrlParser URL Parse result returned by NetHttpParseUrl(). - @param[out] Ip4Address Pointer to a buffer to store the IP address. - - @retval EFI_SUCCESS Successfully get the required component. - @retval EFI_INVALID_PARAMETER Uri is NULL or Ip4Address is NULL or UrlParser is invalid. - @retval EFI_NOT_FOUND No IPv4 address component in the URL. - @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources. - -**/ -EFI_STATUS -EFIAPI -HttpUrlGetIp4 ( - IN CHAR8 *Url, - IN VOID *UrlParser, - OUT EFI_IPv4_ADDRESS *Ip4Address - ) -{ - CHAR8 *Ip4String; - EFI_STATUS Status; - UINT32 ResultLength; - HTTP_URL_PARSER *Parser; - - if (Url == NULL || UrlParser == NULL || Ip4Address == NULL) { - return EFI_INVALID_PARAMETER; - } - - Parser = (HTTP_URL_PARSER *) UrlParser; - - if ((Parser->FieldBitMap & BIT (HTTP_URI_FIELD_HOST)) == 0) { - return EFI_NOT_FOUND; - } - - Ip4String = AllocatePool (Parser->FieldData[HTTP_URI_FIELD_HOST].Length + 1); - if (Ip4String == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - Status = UriPercentDecode ( - Url + Parser->FieldData[HTTP_URI_FIELD_HOST].Offset, - Parser->FieldData[HTTP_URI_FIELD_HOST].Length, - Ip4String, - &ResultLength - ); - if (EFI_ERROR (Status)) { - FreePool (Ip4String); - return Status; - } - - Ip4String[ResultLength] = '\0'; - Status = NetLibAsciiStrToIp4 (Ip4String, Ip4Address); - FreePool (Ip4String); - - return Status; -} - -/** - Get the IPv6 address from a HTTP URL. - - This function will return the IPv6 address according to the Url and previous parse result. - - @param[in] Url The pointer to a HTTP URL string. - @param[in] UrlParser URL Parse result returned by NetHttpParseUrl(). - @param[out] Ip6Address Pointer to a buffer to store the IP address. - - @retval EFI_SUCCESS Successfully get the required component. - @retval EFI_INVALID_PARAMETER Uri is NULL or Ip6Address is NULL or UrlParser is invalid. - @retval EFI_NOT_FOUND No IPv6 address component in the URL. - @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources. - -**/ -EFI_STATUS -EFIAPI -HttpUrlGetIp6 ( - IN CHAR8 *Url, - IN VOID *UrlParser, - OUT EFI_IPv6_ADDRESS *Ip6Address - ) -{ - CHAR8 *Ip6String; - CHAR8 *Ptr; - UINT32 Length; - EFI_STATUS Status; - UINT32 ResultLength; - HTTP_URL_PARSER *Parser; - - if (Url == NULL || UrlParser == NULL || Ip6Address == NULL) { - return EFI_INVALID_PARAMETER; - } - - Parser = (HTTP_URL_PARSER *) UrlParser; - - if ((Parser->FieldBitMap & BIT (HTTP_URI_FIELD_HOST)) == 0) { - return EFI_NOT_FOUND; - } - - // - // IP-literal = "[" ( IPv6address / IPvFuture ) "]" - // - Length = Parser->FieldData[HTTP_URI_FIELD_HOST].Length; - if (Length < 2) { - return EFI_INVALID_PARAMETER; - } - - Ptr = Url + Parser->FieldData[HTTP_URI_FIELD_HOST].Offset; - if ((Ptr[0] != '[') || (Ptr[Length - 1] != ']')) { - return EFI_INVALID_PARAMETER; - } - - Ip6String = AllocatePool (Length); - if (Ip6String == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - Status = UriPercentDecode ( - Ptr + 1, - Length - 2, - Ip6String, - &ResultLength - ); - if (EFI_ERROR (Status)) { - FreePool (Ip6String); - return Status; - } - - Ip6String[ResultLength] = '\0'; - Status = NetLibAsciiStrToIp6 (Ip6String, Ip6Address); - FreePool (Ip6String); - - return Status; -} - -/** - Get the port number from a HTTP URL. - - This function will return the port number according to the Url and previous parse result. - - @param[in] Url The pointer to a HTTP URL string. - @param[in] UrlParser URL Parse result returned by NetHttpParseUrl(). - @param[out] Port Pointer to a buffer to store the port number. - - @retval EFI_SUCCESS Successfully get the required component. - @retval EFI_INVALID_PARAMETER Uri is NULL or Port is NULL or UrlParser is invalid. - @retval EFI_NOT_FOUND No port number in the URL. - @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources. - -**/ -EFI_STATUS -EFIAPI -HttpUrlGetPort ( - IN CHAR8 *Url, - IN VOID *UrlParser, - OUT UINT16 *Port - ) -{ - CHAR8 *PortString; - EFI_STATUS Status; - UINTN Index; - UINTN Data; - UINT32 ResultLength; - HTTP_URL_PARSER *Parser; - - if (Url == NULL || UrlParser == NULL || Port == NULL) { - return EFI_INVALID_PARAMETER; - } - - *Port = 0; - Index = 0; - - Parser = (HTTP_URL_PARSER *) UrlParser; - - if ((Parser->FieldBitMap & BIT (HTTP_URI_FIELD_PORT)) == 0) { - return EFI_NOT_FOUND; - } - - PortString = AllocatePool (Parser->FieldData[HTTP_URI_FIELD_PORT].Length + 1); - if (PortString == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - Status = UriPercentDecode ( - Url + Parser->FieldData[HTTP_URI_FIELD_PORT].Offset, - Parser->FieldData[HTTP_URI_FIELD_PORT].Length, - PortString, - &ResultLength - ); - if (EFI_ERROR (Status)) { - goto ON_EXIT; - } - - PortString[ResultLength] = '\0'; - - while (Index < ResultLength) { - if (!NET_IS_DIGIT (PortString[Index])) { - Status = EFI_INVALID_PARAMETER; - goto ON_EXIT; - } - Index ++; - } - - Status = AsciiStrDecimalToUintnS (Url + Parser->FieldData[HTTP_URI_FIELD_PORT].Offset, (CHAR8 **) NULL, &Data); - - if (Data > HTTP_URI_PORT_MAX_NUM) { - Status = EFI_INVALID_PARAMETER; - goto ON_EXIT; - } - - *Port = (UINT16) Data; - -ON_EXIT: - FreePool (PortString); - return Status; -} - -/** - Get the Path from a HTTP URL. - - This function will return the Path according to the Url and previous parse result,and - it is the caller's responsibility to free the buffer returned in *Path. - - @param[in] Url The pointer to a HTTP URL string. - @param[in] UrlParser URL Parse result returned by NetHttpParseUrl(). - @param[out] Path Pointer to a buffer to store the Path. - - @retval EFI_SUCCESS Successfully get the required component. - @retval EFI_INVALID_PARAMETER Uri is NULL or HostName is NULL or UrlParser is invalid. - @retval EFI_NOT_FOUND No hostName component in the URL. - @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources. - -**/ -EFI_STATUS -EFIAPI -HttpUrlGetPath ( - IN CHAR8 *Url, - IN VOID *UrlParser, - OUT CHAR8 **Path - ) -{ - CHAR8 *PathStr; - EFI_STATUS Status; - UINT32 ResultLength; - HTTP_URL_PARSER *Parser; - - if (Url == NULL || UrlParser == NULL || Path == NULL) { - return EFI_INVALID_PARAMETER; - } - - Parser = (HTTP_URL_PARSER *) UrlParser; - - if ((Parser->FieldBitMap & BIT (HTTP_URI_FIELD_PATH)) == 0) { - return EFI_NOT_FOUND; - } - - PathStr = AllocatePool (Parser->FieldData[HTTP_URI_FIELD_PATH].Length + 1); - if (PathStr == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - Status = UriPercentDecode ( - Url + Parser->FieldData[HTTP_URI_FIELD_PATH].Offset, - Parser->FieldData[HTTP_URI_FIELD_PATH].Length, - PathStr, - &ResultLength - ); - if (EFI_ERROR (Status)) { - FreePool (PathStr); - return Status; - } - - PathStr[ResultLength] = '\0'; - *Path = PathStr; - return EFI_SUCCESS; -} - -/** - Release the resource of the URL parser. - - @param[in] UrlParser Pointer to the parser. - -**/ -VOID -EFIAPI -HttpUrlFreeParser ( - IN VOID *UrlParser - ) -{ - FreePool (UrlParser); -} - -/** - Find a specified header field according to the field name. - - @param[in] HeaderCount Number of HTTP header structures in Headers list. - @param[in] Headers Array containing list of HTTP headers. - @param[in] FieldName Null terminated string which describes a field name. - - @return Pointer to the found header or NULL. - -**/ -EFI_HTTP_HEADER * -EFIAPI -HttpFindHeader ( - IN UINTN HeaderCount, - IN EFI_HTTP_HEADER *Headers, - IN CHAR8 *FieldName - ) -{ - UINTN Index; - - if (HeaderCount == 0 || Headers == NULL || FieldName == NULL) { - return NULL; - } - - for (Index = 0; Index < HeaderCount; Index++){ - // - // Field names are case-insensitive (RFC 2616). - // - if (AsciiStriCmp (Headers[Index].FieldName, FieldName) == 0) { - return &Headers[Index]; - } - } - return NULL; -} - -typedef enum { - BodyParserBodyStart, - BodyParserBodyIdentity, - BodyParserChunkSizeStart, - BodyParserChunkSize, - BodyParserChunkSizeEndCR, - BodyParserChunkExtStart, - BodyParserChunkDataStart, - BodyParserChunkDataEnd, - BodyParserChunkDataEndCR, - BodyParserTrailer, - BodyParserLastCRLF, - BodyParserLastCRLFEnd, - BodyParserComplete, - BodyParserStateMax -} HTTP_BODY_PARSE_STATE; - -typedef struct { - BOOLEAN IgnoreBody; // "MUST NOT" include a message-body - BOOLEAN IsChunked; // "chunked" transfer-coding. - BOOLEAN ContentLengthIsValid; - UINTN ContentLength; // Entity length (not the message-body length), invalid until ContentLengthIsValid is TRUE - - HTTP_BODY_PARSER_CALLBACK Callback; - VOID *Context; - UINTN ParsedBodyLength; - HTTP_BODY_PARSE_STATE State; - UINTN CurrentChunkSize; - UINTN CurrentChunkParsedSize; -} HTTP_BODY_PARSER; - -/** - Convert an hexadecimal char to a value of type UINTN. - - @param[in] Char Ascii character. - - @return Value translated from Char. - -**/ -UINTN -HttpIoHexCharToUintn ( - IN CHAR8 Char - ) -{ - if (Char >= '0' && Char <= '9') { - return Char - '0'; - } - - return (10 + AsciiCharToUpper (Char) - 'A'); -} - -/** - Get the value of the content length if there is a "Content-Length" header. - - @param[in] HeaderCount Number of HTTP header structures in Headers. - @param[in] Headers Array containing list of HTTP headers. - @param[out] ContentLength Pointer to save the value of the content length. - - @retval EFI_SUCCESS Successfully get the content length. - @retval EFI_NOT_FOUND No "Content-Length" header in the Headers. - -**/ -EFI_STATUS -HttpIoParseContentLengthHeader ( - IN UINTN HeaderCount, - IN EFI_HTTP_HEADER *Headers, - OUT UINTN *ContentLength - ) -{ - EFI_HTTP_HEADER *Header; - - Header = HttpFindHeader (HeaderCount, Headers, HTTP_HEADER_CONTENT_LENGTH); - if (Header == NULL) { - return EFI_NOT_FOUND; - } - - return AsciiStrDecimalToUintnS (Header->FieldValue, (CHAR8 **) NULL, ContentLength); -} - -/** - - Check whether the HTTP message is using the "chunked" transfer-coding. - - @param[in] HeaderCount Number of HTTP header structures in Headers. - @param[in] Headers Array containing list of HTTP headers. - - @return The message is "chunked" transfer-coding (TRUE) or not (FALSE). - -**/ -BOOLEAN -HttpIoIsChunked ( - IN UINTN HeaderCount, - IN EFI_HTTP_HEADER *Headers - ) -{ - EFI_HTTP_HEADER *Header; - - - Header = HttpFindHeader (HeaderCount, Headers, HTTP_HEADER_TRANSFER_ENCODING); - if (Header == NULL) { - return FALSE; - } - - if (AsciiStriCmp (Header->FieldValue, "identity") != 0) { - return TRUE; - } - - return FALSE; -} - -/** - Check whether the HTTP message should have a message-body. - - @param[in] Method The HTTP method (e.g. GET, POST) for this HTTP message. - @param[in] StatusCode Response status code returned by the remote host. - - @return The message should have a message-body (FALSE) or not (TRUE). - -**/ -BOOLEAN -HttpIoNoMessageBody ( - IN EFI_HTTP_METHOD Method, - IN EFI_HTTP_STATUS_CODE StatusCode - ) -{ - // - // RFC 2616: - // All responses to the HEAD request method - // MUST NOT include a message-body, even though the presence of entity- - // header fields might lead one to believe they do. All 1xx - // (informational), 204 (no content), and 304 (not modified) responses - // MUST NOT include a message-body. All other responses do include a - // message-body, although it MAY be of zero length. - // - if (Method == HttpMethodHead) { - return TRUE; - } - - if ((StatusCode == HTTP_STATUS_100_CONTINUE) || - (StatusCode == HTTP_STATUS_101_SWITCHING_PROTOCOLS) || - (StatusCode == HTTP_STATUS_204_NO_CONTENT) || - (StatusCode == HTTP_STATUS_304_NOT_MODIFIED)) - { - return TRUE; - } - - return FALSE; -} - -/** - Initialize a HTTP message-body parser. - - This function will create and initialize a HTTP message parser according to caller provided HTTP message - header information. It is the caller's responsibility to free the buffer returned in *UrlParser by HttpFreeMsgParser(). - - @param[in] Method The HTTP method (e.g. GET, POST) for this HTTP message. - @param[in] StatusCode Response status code returned by the remote host. - @param[in] HeaderCount Number of HTTP header structures in Headers. - @param[in] Headers Array containing list of HTTP headers. - @param[in] Callback Callback function that is invoked when parsing the HTTP message-body, - set to NULL to ignore all events. - @param[in] Context Pointer to the context that will be passed to Callback. - @param[out] MsgParser Pointer to the returned buffer to store the message parser. - - @retval EFI_SUCCESS Successfully initialized the parser. - @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources. - @retval EFI_INVALID_PARAMETER MsgParser is NULL or HeaderCount is not NULL but Headers is NULL. - @retval Others Failed to initialize the parser. - -**/ -EFI_STATUS -EFIAPI -HttpInitMsgParser ( - IN EFI_HTTP_METHOD Method, - IN EFI_HTTP_STATUS_CODE StatusCode, - IN UINTN HeaderCount, - IN EFI_HTTP_HEADER *Headers, - IN HTTP_BODY_PARSER_CALLBACK Callback, - IN VOID *Context, - OUT VOID **MsgParser - ) -{ - EFI_STATUS Status; - HTTP_BODY_PARSER *Parser; - - if (HeaderCount != 0 && Headers == NULL) { - return EFI_INVALID_PARAMETER; - } - - if (MsgParser == NULL) { - return EFI_INVALID_PARAMETER; - } - - Parser = AllocateZeroPool (sizeof (HTTP_BODY_PARSER)); - if (Parser == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - Parser->State = BodyParserBodyStart; - - // - // Determine the message length according to RFC 2616. - // 1. Check whether the message "MUST NOT" have a message-body. - // - Parser->IgnoreBody = HttpIoNoMessageBody (Method, StatusCode); - // - // 2. Check whether the message using "chunked" transfer-coding. - // - Parser->IsChunked = HttpIoIsChunked (HeaderCount, Headers); - // - // 3. Check whether the message has a Content-Length header field. - // - Status = HttpIoParseContentLengthHeader (HeaderCount, Headers, &Parser->ContentLength); - if (!EFI_ERROR (Status)) { - Parser->ContentLengthIsValid = TRUE; - } - // - // 4. Range header is not supported now, so we won't meet media type "multipart/byteranges". - // 5. By server closing the connection - // - - // - // Set state to skip body parser if the message shouldn't have a message body. - // - if (Parser->IgnoreBody) { - Parser->State = BodyParserComplete; - } else { - Parser->Callback = Callback; - Parser->Context = Context; - } - - *MsgParser = Parser; - return EFI_SUCCESS; -} - -/** - Parse message body. - - Parse BodyLength of message-body. This function can be called repeatedly to parse the message-body partially. - - @param[in, out] MsgParser Pointer to the message parser. - @param[in] BodyLength Length in bytes of the Body. - @param[in] Body Pointer to the buffer of the message-body to be parsed. - - @retval EFI_SUCCESS Successfully parse the message-body. - @retval EFI_INVALID_PARAMETER MsgParser is NULL or Body is NULL or BodyLength is 0. - @retval EFI_ABORTED Operation aborted. - @retval Other Error happened while parsing message body. - -**/ -EFI_STATUS -EFIAPI -HttpParseMessageBody ( - IN OUT VOID *MsgParser, - IN UINTN BodyLength, - IN CHAR8 *Body - ) -{ - CHAR8 *Char; - UINTN RemainderLengthInThis; - UINTN LengthForCallback; - EFI_STATUS Status; - HTTP_BODY_PARSER *Parser; - - if (BodyLength == 0 || Body == NULL) { - return EFI_INVALID_PARAMETER; - } - - if (MsgParser == NULL) { - return EFI_INVALID_PARAMETER; - } - - Parser = (HTTP_BODY_PARSER *) MsgParser; - - if (Parser->IgnoreBody) { - Parser->State = BodyParserComplete; - if (Parser->Callback != NULL) { - Status = Parser->Callback ( - BodyParseEventOnComplete, - Body, - 0, - Parser->Context - ); - if (EFI_ERROR (Status)) { - return Status; - } - } - return EFI_SUCCESS; - } - - if (Parser->State == BodyParserBodyStart) { - Parser->ParsedBodyLength = 0; - if (Parser->IsChunked) { - Parser->State = BodyParserChunkSizeStart; - } else { - Parser->State = BodyParserBodyIdentity; - } - } - - // - // The message body might be truncated in anywhere, so we need to parse is byte-by-byte. - // - for (Char = Body; Char < Body + BodyLength; ) { - - switch (Parser->State) { - case BodyParserStateMax: - return EFI_ABORTED; - - case BodyParserBodyIdentity: - // - // Identity transfer-coding, just notify user to save the body data. - // - if (Parser->Callback != NULL) { - Status = Parser->Callback ( - BodyParseEventOnData, - Char, - MIN (BodyLength, Parser->ContentLength - Parser->ParsedBodyLength), - Parser->Context - ); - if (EFI_ERROR (Status)) { - return Status; - } - } - Char += MIN (BodyLength, Parser->ContentLength - Parser->ParsedBodyLength); - Parser->ParsedBodyLength += MIN (BodyLength, Parser->ContentLength - Parser->ParsedBodyLength); - if (Parser->ParsedBodyLength == Parser->ContentLength) { - Parser->State = BodyParserComplete; - if (Parser->Callback != NULL) { - Status = Parser->Callback ( - BodyParseEventOnComplete, - Char, - 0, - Parser->Context - ); - if (EFI_ERROR (Status)) { - return Status; - } - } - } - break; - - case BodyParserChunkSizeStart: - // - // First byte of chunk-size, the chunk-size might be truncated. - // - Parser->CurrentChunkSize = 0; - Parser->State = BodyParserChunkSize; - case BodyParserChunkSize: - if (!NET_IS_HEX_CHAR (*Char)) { - if (*Char == ';') { - Parser->State = BodyParserChunkExtStart; - Char++; - } else if (*Char == '\r') { - Parser->State = BodyParserChunkSizeEndCR; - Char++; - } else { - Parser->State = BodyParserStateMax; - } - break; - } - - if (Parser->CurrentChunkSize > (((~((UINTN) 0)) - 16) / 16)) { - return EFI_INVALID_PARAMETER; - } - Parser->CurrentChunkSize = Parser->CurrentChunkSize * 16 + HttpIoHexCharToUintn (*Char); - Char++; - break; - - case BodyParserChunkExtStart: - // - // Ignore all the chunk extensions. - // - if (*Char == '\r') { - Parser->State = BodyParserChunkSizeEndCR; - } - Char++; - break; - - case BodyParserChunkSizeEndCR: - if (*Char != '\n') { - Parser->State = BodyParserStateMax; - break; - } - Char++; - if (Parser->CurrentChunkSize == 0) { - // - // The last chunk has been parsed and now assumed the state - // of HttpBodyParse is ParserLastCRLF. So it need to decide - // whether the rest message is trailer or last CRLF in the next round. - // - Parser->ContentLengthIsValid = TRUE; - Parser->State = BodyParserLastCRLF; - break; - } - Parser->State = BodyParserChunkDataStart; - Parser->CurrentChunkParsedSize = 0; - break; - - case BodyParserLastCRLF: - // - // Judge the byte is belong to the Last CRLF or trailer, and then - // configure the state of HttpBodyParse to corresponding state. - // - if (*Char == '\r') { - Char++; - Parser->State = BodyParserLastCRLFEnd; - break; - } else { - Parser->State = BodyParserTrailer; - break; - } - - case BodyParserLastCRLFEnd: - if (*Char == '\n') { - Parser->State = BodyParserComplete; - Char++; - if (Parser->Callback != NULL) { - Status = Parser->Callback ( - BodyParseEventOnComplete, - Char, - 0, - Parser->Context - ); - if (EFI_ERROR (Status)) { - return Status; - } - } - break; - } else { - Parser->State = BodyParserStateMax; - break; - } - - case BodyParserTrailer: - if (*Char == '\r') { - Parser->State = BodyParserChunkSizeEndCR; - } - Char++; - break; - - case BodyParserChunkDataStart: - // - // First byte of chunk-data, the chunk data also might be truncated. - // - RemainderLengthInThis = BodyLength - (Char - Body); - LengthForCallback = MIN (Parser->CurrentChunkSize - Parser->CurrentChunkParsedSize, RemainderLengthInThis); - if (Parser->Callback != NULL) { - Status = Parser->Callback ( - BodyParseEventOnData, - Char, - LengthForCallback, - Parser->Context - ); - if (EFI_ERROR (Status)) { - return Status; - } - } - Char += LengthForCallback; - Parser->ContentLength += LengthForCallback; - Parser->CurrentChunkParsedSize += LengthForCallback; - if (Parser->CurrentChunkParsedSize == Parser->CurrentChunkSize) { - Parser->State = BodyParserChunkDataEnd; - } - break; - - case BodyParserChunkDataEnd: - if (*Char == '\r') { - Parser->State = BodyParserChunkDataEndCR; - } else { - Parser->State = BodyParserStateMax; - } - Char++; - break; - - case BodyParserChunkDataEndCR: - if (*Char != '\n') { - Parser->State = BodyParserStateMax; - break; - } - Char++; - Parser->State = BodyParserChunkSizeStart; - break; - - default: - break; - } - - } - - if (Parser->State == BodyParserStateMax) { - return EFI_ABORTED; - } - - return EFI_SUCCESS; -} - -/** - Check whether the message-body is complete or not. - - @param[in] MsgParser Pointer to the message parser. - - @retval TRUE Message-body is complete. - @retval FALSE Message-body is not complete. - -**/ -BOOLEAN -EFIAPI -HttpIsMessageComplete ( - IN VOID *MsgParser - ) -{ - HTTP_BODY_PARSER *Parser; - - if (MsgParser == NULL) { - return FALSE; - } - - Parser = (HTTP_BODY_PARSER *) MsgParser; - - if (Parser->State == BodyParserComplete) { - return TRUE; - } - return FALSE; -} - -/** - Get the content length of the entity. - - Note that in trunk transfer, the entity length is not valid until the whole message body is received. - - @param[in] MsgParser Pointer to the message parser. - @param[out] ContentLength Pointer to store the length of the entity. - - @retval EFI_SUCCESS Successfully to get the entity length. - @retval EFI_NOT_READY Entity length is not valid yet. - @retval EFI_INVALID_PARAMETER MsgParser is NULL or ContentLength is NULL. - -**/ -EFI_STATUS -EFIAPI -HttpGetEntityLength ( - IN VOID *MsgParser, - OUT UINTN *ContentLength - ) -{ - HTTP_BODY_PARSER *Parser; - - if (MsgParser == NULL || ContentLength == NULL) { - return EFI_INVALID_PARAMETER; - } - - Parser = (HTTP_BODY_PARSER *) MsgParser; - - if (!Parser->ContentLengthIsValid) { - return EFI_NOT_READY; - } - - *ContentLength = Parser->ContentLength; - return EFI_SUCCESS; -} - -/** - Release the resource of the message parser. - - @param[in] MsgParser Pointer to the message parser. - -**/ -VOID -EFIAPI -HttpFreeMsgParser ( - IN VOID *MsgParser - ) -{ - FreePool (MsgParser); -} - - -/** - Get the next string, which is distinguished by specified separator. - - @param[in] String Pointer to the string. - @param[in] Separator Specified separator used to distinguish where is the beginning - of next string. - - @return Pointer to the next string. - @return NULL if not find or String is NULL. - -**/ -CHAR8 * -AsciiStrGetNextToken ( - IN CONST CHAR8 *String, - IN CHAR8 Separator - ) -{ - CONST CHAR8 *Token; - - Token = String; - while (TRUE) { - if (*Token == 0) { - return NULL; - } - if (*Token == Separator) { - return (CHAR8 *)(Token + 1); - } - Token++; - } -} - -/** - Set FieldName and FieldValue into specified HttpHeader. - - @param[in,out] HttpHeader Specified HttpHeader. - @param[in] FieldName FieldName of this HttpHeader, a NULL terminated ASCII string. - @param[in] FieldValue FieldValue of this HttpHeader, a NULL terminated ASCII string. - - - @retval EFI_SUCCESS The FieldName and FieldValue are set into HttpHeader successfully. - @retval EFI_INVALID_PARAMETER The parameter is invalid. - @retval EFI_OUT_OF_RESOURCES Failed to allocate resources. - -**/ -EFI_STATUS -EFIAPI -HttpSetFieldNameAndValue ( - IN OUT EFI_HTTP_HEADER *HttpHeader, - IN CONST CHAR8 *FieldName, - IN CONST CHAR8 *FieldValue - ) -{ - UINTN FieldNameSize; - UINTN FieldValueSize; - - if (HttpHeader == NULL || FieldName == NULL || FieldValue == NULL) { - return EFI_INVALID_PARAMETER; - } - - if (HttpHeader->FieldName != NULL) { - FreePool (HttpHeader->FieldName); - } - if (HttpHeader->FieldValue != NULL) { - FreePool (HttpHeader->FieldValue); - } - - FieldNameSize = AsciiStrSize (FieldName); - HttpHeader->FieldName = AllocateZeroPool (FieldNameSize); - if (HttpHeader->FieldName == NULL) { - return EFI_OUT_OF_RESOURCES; - } - CopyMem (HttpHeader->FieldName, FieldName, FieldNameSize); - HttpHeader->FieldName[FieldNameSize - 1] = 0; - - FieldValueSize = AsciiStrSize (FieldValue); - HttpHeader->FieldValue = AllocateZeroPool (FieldValueSize); - if (HttpHeader->FieldValue == NULL) { - FreePool (HttpHeader->FieldName); - return EFI_OUT_OF_RESOURCES; - } - CopyMem (HttpHeader->FieldValue, FieldValue, FieldValueSize); - HttpHeader->FieldValue[FieldValueSize - 1] = 0; - - return EFI_SUCCESS; -} - -/** - Get one key/value header pair from the raw string. - - @param[in] String Pointer to the raw string. - @param[out] FieldName Points directly to field name within 'HttpHeader'. - @param[out] FieldValue Points directly to field value within 'HttpHeader'. - - @return Pointer to the next raw string. - @return NULL if no key/value header pair from this raw string. - -**/ -CHAR8 * -EFIAPI -HttpGetFieldNameAndValue ( - IN CHAR8 *String, - OUT CHAR8 **FieldName, - OUT CHAR8 **FieldValue - ) -{ - CHAR8 *FieldNameStr; - CHAR8 *FieldValueStr; - CHAR8 *StrPtr; - CHAR8 *EndofHeader; - - if (String == NULL || FieldName == NULL || FieldValue == NULL) { - return NULL; - } - - *FieldName = NULL; - *FieldValue = NULL; - FieldNameStr = NULL; - FieldValueStr = NULL; - StrPtr = NULL; - EndofHeader = NULL; - - - // - // Check whether the raw HTTP header string is valid or not. - // - EndofHeader = AsciiStrStr (String, "\r\n\r\n"); - if (EndofHeader == NULL) { - return NULL; - } - - // - // Each header field consists of a name followed by a colon (":") and the field value. - // The field value MAY be preceded by any amount of LWS, though a single SP is preferred. - // - // message-header = field-name ":" [ field-value ] - // field-name = token - // field-value = *( field-content | LWS ) - // - // Note: "*(element)" allows any number element, including zero; "1*(element)" requires at least one element. - // [element] means element is optional. - // LWS = [CRLF] 1*(SP|HT), it can be ' ' or '\t' or '\r\n ' or '\r\n\t'. - // CRLF = '\r\n'. - // SP = ' '. - // HT = '\t' (Tab). - // - FieldNameStr = String; - FieldValueStr = AsciiStrGetNextToken (FieldNameStr, ':'); - if (FieldValueStr == NULL) { - return NULL; - } - - // - // Replace ':' with 0, then FieldName has been retrived from String. - // - *(FieldValueStr - 1) = 0; - - // - // Handle FieldValueStr, skip all the preceded LWS. - // - while (TRUE) { - if (*FieldValueStr == ' ' || *FieldValueStr == '\t') { - // - // Boundary condition check. - // - if ((UINTN) EndofHeader - (UINTN) FieldValueStr < 1) { - // - // Wrong String format! - // - return NULL; - } - - FieldValueStr ++; - } else if (*FieldValueStr == '\r') { - // - // Boundary condition check. - // - if ((UINTN) EndofHeader - (UINTN) FieldValueStr < 3) { - // - // No more preceded LWS, so break here. - // - break; - } - - if (*(FieldValueStr + 1) == '\n' ) { - if (*(FieldValueStr + 2) == ' ' || *(FieldValueStr + 2) == '\t') { - FieldValueStr = FieldValueStr + 3; - } else { - // - // No more preceded LWS, so break here. - // - break; - } - } else { - // - // Wrong String format! - // - return NULL; - } - } else { - // - // No more preceded LWS, so break here. - // - break; - } - } - - StrPtr = FieldValueStr; - do { - // - // Handle the LWS within the field value. - // - StrPtr = AsciiStrGetNextToken (StrPtr, '\r'); - if (StrPtr == NULL || *StrPtr != '\n') { - // - // Wrong String format! - // - return NULL; - } - - StrPtr++; - } while (*StrPtr == ' ' || *StrPtr == '\t'); - - // - // Replace '\r' with 0 - // - *(StrPtr - 2) = 0; - - // - // Get FieldName and FieldValue. - // - *FieldName = FieldNameStr; - *FieldValue = FieldValueStr; - - return StrPtr; -} - -/** - Free existing HeaderFields. - - @param[in] HeaderFields Pointer to array of key/value header pairs waitting for free. - @param[in] FieldCount The number of header pairs in HeaderFields. - -**/ -VOID -EFIAPI -HttpFreeHeaderFields ( - IN EFI_HTTP_HEADER *HeaderFields, - IN UINTN FieldCount - ) -{ - UINTN Index; - - if (HeaderFields != NULL) { - for (Index = 0; Index < FieldCount; Index++) { - if (HeaderFields[Index].FieldName != NULL) { - FreePool (HeaderFields[Index].FieldName); - } - if (HeaderFields[Index].FieldValue != NULL) { - FreePool (HeaderFields[Index].FieldValue); - } - } - - FreePool (HeaderFields); - } -} - -/** - Generate HTTP request message. - - This function will allocate memory for the whole HTTP message and generate a - well formatted HTTP Request message in it, include the Request-Line, header - fields and also the message body. It is the caller's responsibility to free - the buffer returned in *RequestMsg. - - @param[in] Message Pointer to the EFI_HTTP_MESSAGE structure which - contains the required information to generate - the HTTP request message. - @param[in] Url The URL of a remote host. - @param[out] RequestMsg Pointer to the created HTTP request message. - NULL if any error occured. - @param[out] RequestMsgSize Size of the RequestMsg (in bytes). - - @retval EFI_SUCCESS If HTTP request string was created successfully. - @retval EFI_OUT_OF_RESOURCES Failed to allocate resources. - @retval EFI_INVALID_PARAMETER The input arguments are invalid. - -**/ -EFI_STATUS -EFIAPI -HttpGenRequestMessage ( - IN CONST EFI_HTTP_MESSAGE *Message, - IN CONST CHAR8 *Url, - OUT CHAR8 **RequestMsg, - OUT UINTN *RequestMsgSize - ) -{ - EFI_STATUS Status; - UINTN StrLength; - CHAR8 *RequestPtr; - UINTN HttpHdrSize; - UINTN MsgSize; - BOOLEAN Success; - VOID *HttpHdr; - EFI_HTTP_HEADER **AppendList; - UINTN Index; - EFI_HTTP_UTILITIES_PROTOCOL *HttpUtilitiesProtocol; - - Status = EFI_SUCCESS; - HttpHdrSize = 0; - MsgSize = 0; - Success = FALSE; - HttpHdr = NULL; - AppendList = NULL; - HttpUtilitiesProtocol = NULL; - - // - // 1. If we have a Request, we cannot have a NULL Url - // 2. If we have a Request, HeaderCount can not be non-zero - // 3. If we do not have a Request, HeaderCount should be zero - // 4. If we do not have Request and Headers, we need at least a message-body - // - if ((Message == NULL || RequestMsg == NULL || RequestMsgSize == NULL) || - (Message->Data.Request != NULL && Url == NULL) || - (Message->Data.Request != NULL && Message->HeaderCount == 0) || - (Message->Data.Request == NULL && Message->HeaderCount != 0) || - (Message->Data.Request == NULL && Message->HeaderCount == 0 && Message->BodyLength == 0)) { - return EFI_INVALID_PARAMETER; - } - - if (Message->HeaderCount != 0) { - // - // Locate the HTTP_UTILITIES protocol. - // - Status = gBS->LocateProtocol ( - &gEfiHttpUtilitiesProtocolGuid, - NULL, - (VOID **) &HttpUtilitiesProtocol - ); - - if (EFI_ERROR (Status)) { - DEBUG ((DEBUG_ERROR,"Failed to locate Http Utilities protocol. Status = %r.\n", Status)); - return Status; - } - - // - // Build AppendList to send into HttpUtilitiesBuild - // - AppendList = AllocateZeroPool (sizeof (EFI_HTTP_HEADER *) * (Message->HeaderCount)); - if (AppendList == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - for(Index = 0; Index < Message->HeaderCount; Index++){ - AppendList[Index] = &Message->Headers[Index]; - } - - // - // Build raw HTTP Headers - // - Status = HttpUtilitiesProtocol->Build ( - HttpUtilitiesProtocol, - 0, - NULL, - 0, - NULL, - Message->HeaderCount, - AppendList, - &HttpHdrSize, - &HttpHdr - ); - - FreePool (AppendList); - - if (EFI_ERROR (Status) || HttpHdr == NULL){ - return Status; - } - } - - // - // If we have headers to be sent, account for it. - // - if (Message->HeaderCount != 0) { - MsgSize = HttpHdrSize; - } - - // - // If we have a request line, account for the fields. - // - if (Message->Data.Request != NULL) { - MsgSize += HTTP_METHOD_MAXIMUM_LEN + AsciiStrLen (HTTP_VERSION_CRLF_STR) + AsciiStrLen (Url); - } - - - // - // If we have a message body to be sent, account for it. - // - MsgSize += Message->BodyLength; - - // - // memory for the string that needs to be sent to TCP - // - *RequestMsg = NULL; - *RequestMsg = AllocateZeroPool (MsgSize); - if (*RequestMsg == NULL) { - Status = EFI_OUT_OF_RESOURCES; - goto Exit; - } - - RequestPtr = *RequestMsg; - // - // Construct header request - // - if (Message->Data.Request != NULL) { - switch (Message->Data.Request->Method) { - case HttpMethodGet: - StrLength = sizeof (HTTP_METHOD_GET) - 1; - CopyMem (RequestPtr, HTTP_METHOD_GET, StrLength); - RequestPtr += StrLength; - break; - case HttpMethodPut: - StrLength = sizeof (HTTP_METHOD_PUT) - 1; - CopyMem (RequestPtr, HTTP_METHOD_PUT, StrLength); - RequestPtr += StrLength; - break; - case HttpMethodPatch: - StrLength = sizeof (HTTP_METHOD_PATCH) - 1; - CopyMem (RequestPtr, HTTP_METHOD_PATCH, StrLength); - RequestPtr += StrLength; - break; - case HttpMethodPost: - StrLength = sizeof (HTTP_METHOD_POST) - 1; - CopyMem (RequestPtr, HTTP_METHOD_POST, StrLength); - RequestPtr += StrLength; - break; - case HttpMethodHead: - StrLength = sizeof (HTTP_METHOD_HEAD) - 1; - CopyMem (RequestPtr, HTTP_METHOD_HEAD, StrLength); - RequestPtr += StrLength; - break; - case HttpMethodDelete: - StrLength = sizeof (HTTP_METHOD_DELETE) - 1; - CopyMem (RequestPtr, HTTP_METHOD_DELETE, StrLength); - RequestPtr += StrLength; - break; - default: - ASSERT (FALSE); - Status = EFI_INVALID_PARAMETER; - goto Exit; - } - - StrLength = AsciiStrLen(EMPTY_SPACE); - CopyMem (RequestPtr, EMPTY_SPACE, StrLength); - RequestPtr += StrLength; - - StrLength = AsciiStrLen (Url); - CopyMem (RequestPtr, Url, StrLength); - RequestPtr += StrLength; - - StrLength = sizeof (HTTP_VERSION_CRLF_STR) - 1; - CopyMem (RequestPtr, HTTP_VERSION_CRLF_STR, StrLength); - RequestPtr += StrLength; - - if (HttpHdr != NULL) { - // - // Construct header - // - CopyMem (RequestPtr, HttpHdr, HttpHdrSize); - RequestPtr += HttpHdrSize; - } - } - - // - // Construct body - // - if (Message->Body != NULL) { - CopyMem (RequestPtr, Message->Body, Message->BodyLength); - RequestPtr += Message->BodyLength; - } - - // - // Done - // - (*RequestMsgSize) = (UINTN)(RequestPtr) - (UINTN)(*RequestMsg); - Success = TRUE; - -Exit: - - if (!Success) { - if (*RequestMsg != NULL) { - FreePool (*RequestMsg); - } - *RequestMsg = NULL; - return Status; - } - - if (HttpHdr != NULL) { - FreePool (HttpHdr); - } - - return EFI_SUCCESS; -} - -/** - Translate the status code in HTTP message to EFI_HTTP_STATUS_CODE defined - in UEFI 2.5 specification. - - @param[in] StatusCode The status code value in HTTP message. - - @return Value defined in EFI_HTTP_STATUS_CODE . - -**/ -EFI_HTTP_STATUS_CODE -EFIAPI -HttpMappingToStatusCode ( - IN UINTN StatusCode - ) -{ - switch (StatusCode) { - case 100: - return HTTP_STATUS_100_CONTINUE; - case 101: - return HTTP_STATUS_101_SWITCHING_PROTOCOLS; - case 200: - return HTTP_STATUS_200_OK; - case 201: - return HTTP_STATUS_201_CREATED; - case 202: - return HTTP_STATUS_202_ACCEPTED; - case 203: - return HTTP_STATUS_203_NON_AUTHORITATIVE_INFORMATION; - case 204: - return HTTP_STATUS_204_NO_CONTENT; - case 205: - return HTTP_STATUS_205_RESET_CONTENT; - case 206: - return HTTP_STATUS_206_PARTIAL_CONTENT; - case 300: - return HTTP_STATUS_300_MULTIPLE_CHOICES; - case 301: - return HTTP_STATUS_301_MOVED_PERMANENTLY; - case 302: - return HTTP_STATUS_302_FOUND; - case 303: - return HTTP_STATUS_303_SEE_OTHER; - case 304: - return HTTP_STATUS_304_NOT_MODIFIED; - case 305: - return HTTP_STATUS_305_USE_PROXY; - case 307: - return HTTP_STATUS_307_TEMPORARY_REDIRECT; - case 308: - return HTTP_STATUS_308_PERMANENT_REDIRECT; - case 400: - return HTTP_STATUS_400_BAD_REQUEST; - case 401: - return HTTP_STATUS_401_UNAUTHORIZED; - case 402: - return HTTP_STATUS_402_PAYMENT_REQUIRED; - case 403: - return HTTP_STATUS_403_FORBIDDEN; - case 404: - return HTTP_STATUS_404_NOT_FOUND; - case 405: - return HTTP_STATUS_405_METHOD_NOT_ALLOWED; - case 406: - return HTTP_STATUS_406_NOT_ACCEPTABLE; - case 407: - return HTTP_STATUS_407_PROXY_AUTHENTICATION_REQUIRED; - case 408: - return HTTP_STATUS_408_REQUEST_TIME_OUT; - case 409: - return HTTP_STATUS_409_CONFLICT; - case 410: - return HTTP_STATUS_410_GONE; - case 411: - return HTTP_STATUS_411_LENGTH_REQUIRED; - case 412: - return HTTP_STATUS_412_PRECONDITION_FAILED; - case 413: - return HTTP_STATUS_413_REQUEST_ENTITY_TOO_LARGE; - case 414: - return HTTP_STATUS_414_REQUEST_URI_TOO_LARGE; - case 415: - return HTTP_STATUS_415_UNSUPPORTED_MEDIA_TYPE; - case 416: - return HTTP_STATUS_416_REQUESTED_RANGE_NOT_SATISFIED; - case 417: - return HTTP_STATUS_417_EXPECTATION_FAILED; - case 500: - return HTTP_STATUS_500_INTERNAL_SERVER_ERROR; - case 501: - return HTTP_STATUS_501_NOT_IMPLEMENTED; - case 502: - return HTTP_STATUS_502_BAD_GATEWAY; - case 503: - return HTTP_STATUS_503_SERVICE_UNAVAILABLE; - case 504: - return HTTP_STATUS_504_GATEWAY_TIME_OUT; - case 505: - return HTTP_STATUS_505_HTTP_VERSION_NOT_SUPPORTED; - - default: - return HTTP_STATUS_UNSUPPORTED_STATUS; - } -} - -/** - Check whether header field called FieldName is in DeleteList. - - @param[in] DeleteList Pointer to array of key/value header pairs. - @param[in] DeleteCount The number of header pairs. - @param[in] FieldName Pointer to header field's name. - - @return TRUE if FieldName is not in DeleteList, that means this header field is valid. - @return FALSE if FieldName is in DeleteList, that means this header field is invalid. - -**/ -BOOLEAN -EFIAPI -HttpIsValidHttpHeader ( - IN CHAR8 *DeleteList[], - IN UINTN DeleteCount, - IN CHAR8 *FieldName - ) -{ - UINTN Index; - - if (FieldName == NULL) { - return FALSE; - } - - for (Index = 0; Index < DeleteCount; Index++) { - if (DeleteList[Index] == NULL) { - continue; - } - - if (AsciiStrCmp (FieldName, DeleteList[Index]) == 0) { - return FALSE; - } - } - - return TRUE; -} - diff --git a/MdeModulePkg/Library/DxeHttpLib/DxeHttpLib.h b/MdeModulePkg/Library/DxeHttpLib/DxeHttpLib.h deleted file mode 100644 index d064a98438..0000000000 --- a/MdeModulePkg/Library/DxeHttpLib/DxeHttpLib.h +++ /dev/null @@ -1,85 +0,0 @@ -/** @file -Header file for HttpLib. - - Copyright (c) 2016 - 2017, Intel Corporation. All rights reserved.
- (C) Copyright 2016 Hewlett Packard Enterprise Development LP
- - SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef _DXE_HTTP_LIB_H_ -#define _DXE_HTTP_LIB_H_ - -#include -#include -#include -#include -#include -#include -#include -#include -#include - -#define BIT(x) (1 << x) - -#define HTTP_VERSION_CRLF_STR " HTTP/1.1\r\n" -#define EMPTY_SPACE " " - -#define NET_IS_HEX_CHAR(Ch) \ - ((('0' <= (Ch)) && ((Ch) <= '9')) || \ - (('A' <= (Ch)) && ((Ch) <= 'F')) || \ - (('a' <= (Ch)) && ((Ch) <= 'f'))) - -// -// Field index of the HTTP URL parse result. -// -#define HTTP_URI_FIELD_SCHEME 0 -#define HTTP_URI_FIELD_AUTHORITY 1 -#define HTTP_URI_FIELD_PATH 2 -#define HTTP_URI_FIELD_QUERY 3 -#define HTTP_URI_FIELD_FRAGMENT 4 -#define HTTP_URI_FIELD_USERINFO 5 -#define HTTP_URI_FIELD_HOST 6 -#define HTTP_URI_FIELD_PORT 7 -#define HTTP_URI_FIELD_MAX 8 - -#define HTTP_URI_PORT_MAX_NUM 65535 - -// -// Structure to store the parse result of a HTTP URL. -// -typedef struct { - UINT32 Offset; - UINT32 Length; -} HTTP_URL_FILED_DATA; - -typedef struct { - UINT16 FieldBitMap; - HTTP_URL_FILED_DATA FieldData[HTTP_URI_FIELD_MAX]; -} HTTP_URL_PARSER; - -typedef enum { - UrlParserUrlStart, - UrlParserScheme, - UrlParserSchemeColon, // ":" - UrlParserSchemeColonSlash, // ":/" - UrlParserSchemeColonSlashSlash, // "://" - UrlParserAuthority, - UrlParserAtInAuthority, - UrlParserPath, - UrlParserQueryStart, // "?" - UrlParserQuery, - UrlParserFragmentStart, // "#" - UrlParserFragment, - UrlParserUserInfo, - UrlParserHostStart, // "@" - UrlParserHost, - UrlParserHostIpv6, // "["(Ipv6 address) "]" - UrlParserPortStart, // ":" - UrlParserPort, - UrlParserStateMax -} HTTP_URL_PARSE_STATE; - -#endif - diff --git a/MdeModulePkg/Library/DxeHttpLib/DxeHttpLib.inf b/MdeModulePkg/Library/DxeHttpLib/DxeHttpLib.inf deleted file mode 100644 index c613dc1718..0000000000 --- a/MdeModulePkg/Library/DxeHttpLib/DxeHttpLib.inf +++ /dev/null @@ -1,42 +0,0 @@ -## @file -# It provides the helper routines to parse the HTTP message byte stream. -# -# Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.
-# (C) Copyright 2016 Hewlett Packard Enterprise Development LP
-# SPDX-License-Identifier: BSD-2-Clause-Patent -# -## - - -[Defines] - INF_VERSION = 0x00010005 - BASE_NAME = DxeHttpLib - MODULE_UNI_FILE = DxeHttpLib.uni - FILE_GUID = ABBAB4CD-EA88-45b9-8234-C8A7450531FC - MODULE_TYPE = DXE_DRIVER - VERSION_STRING = 1.0 - LIBRARY_CLASS = HttpLib|DXE_CORE DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER - -# -# The following information is for reference only and not required by the build tools. -# -# VALID_ARCHITECTURES = IA32 X64 EBC -# - -[Sources] - DxeHttpLib.c - DxeHttpLib.h - -[Packages] - MdePkg/MdePkg.dec - MdeModulePkg/MdeModulePkg.dec - -[LibraryClasses] - BaseLib - DebugLib - UefiBootServicesTableLib - MemoryAllocationLib - NetLib - -[Protocols] - gEfiHttpUtilitiesProtocolGuid ## SOMETIMES_CONSUMES diff --git a/MdeModulePkg/Library/DxeHttpLib/DxeHttpLib.uni b/MdeModulePkg/Library/DxeHttpLib/DxeHttpLib.uni deleted file mode 100644 index a2954c023e..0000000000 --- a/MdeModulePkg/Library/DxeHttpLib/DxeHttpLib.uni +++ /dev/null @@ -1,16 +0,0 @@ -// /** @file -// Provides the helper routines for HTTP. -// -// This library instance provides the helper routines to parse the HTTP message byte stream. -// -// Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.
-// -// SPDX-License-Identifier: BSD-2-Clause-Patent -// -// **/ - - -#string STR_MODULE_ABSTRACT #language en-US "Provides the helper routines for HTTP" - -#string STR_MODULE_DESCRIPTION #language en-US "This library instance provides the helper routines to parse the HTTP message byte stream." - diff --git a/MdeModulePkg/Library/DxeIpIoLib/DxeIpIoLib.c b/MdeModulePkg/Library/DxeIpIoLib/DxeIpIoLib.c deleted file mode 100644 index d45f0070b3..0000000000 --- a/MdeModulePkg/Library/DxeIpIoLib/DxeIpIoLib.c +++ /dev/null @@ -1,2291 +0,0 @@ -/** @file - IpIo Library. - -(C) Copyright 2014 Hewlett-Packard Development Company, L.P.
-Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent -**/ - -#include - -#include - -#include -#include -#include -#include -#include -#include -#include - - -GLOBAL_REMOVE_IF_UNREFERENCED LIST_ENTRY mActiveIpIoList = { - &mActiveIpIoList, - &mActiveIpIoList -}; - -GLOBAL_REMOVE_IF_UNREFERENCED EFI_IP4_CONFIG_DATA mIp4IoDefaultIpConfigData = { - EFI_IP_PROTO_UDP, - FALSE, - TRUE, - FALSE, - FALSE, - FALSE, - {{0, 0, 0, 0}}, - {{0, 0, 0, 0}}, - 0, - 255, - FALSE, - FALSE, - 0, - 0 -}; - -GLOBAL_REMOVE_IF_UNREFERENCED EFI_IP6_CONFIG_DATA mIp6IoDefaultIpConfigData = { - EFI_IP_PROTO_UDP, - FALSE, - TRUE, - FALSE, - {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}}, - {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}}, - 0, - 255, - 0, - 0, - 0 -}; - -GLOBAL_REMOVE_IF_UNREFERENCED ICMP_ERROR_INFO mIcmpErrMap[10] = { - {FALSE, TRUE }, // ICMP_ERR_UNREACH_NET - {FALSE, TRUE }, // ICMP_ERR_UNREACH_HOST - {TRUE, TRUE }, // ICMP_ERR_UNREACH_PROTOCOL - {TRUE, TRUE }, // ICMP_ERR_UNREACH_PORT - {TRUE, TRUE }, // ICMP_ERR_MSGSIZE - {FALSE, TRUE }, // ICMP_ERR_UNREACH_SRCFAIL - {FALSE, TRUE }, // ICMP_ERR_TIMXCEED_INTRANS - {FALSE, TRUE }, // ICMP_ERR_TIMEXCEED_REASS - {FALSE, FALSE}, // ICMP_ERR_QUENCH - {FALSE, TRUE } // ICMP_ERR_PARAMPROB -}; - -GLOBAL_REMOVE_IF_UNREFERENCED ICMP_ERROR_INFO mIcmp6ErrMap[10] = { - {FALSE, TRUE}, // ICMP6_ERR_UNREACH_NET - {FALSE, TRUE}, // ICMP6_ERR_UNREACH_HOST - {TRUE, TRUE}, // ICMP6_ERR_UNREACH_PROTOCOL - {TRUE, TRUE}, // ICMP6_ERR_UNREACH_PORT - {TRUE, TRUE}, // ICMP6_ERR_PACKAGE_TOOBIG - {FALSE, TRUE}, // ICMP6_ERR_TIMXCEED_HOPLIMIT - {FALSE, TRUE}, // ICMP6_ERR_TIMXCEED_REASS - {FALSE, TRUE}, // ICMP6_ERR_PARAMPROB_HEADER - {FALSE, TRUE}, // ICMP6_ERR_PARAMPROB_NEXHEADER - {FALSE, TRUE} // ICMP6_ERR_PARAMPROB_IPV6OPTION -}; - - -/** - Notify function for IP transmit token. - - @param[in] Context The context passed in by the event notifier. - -**/ -VOID -EFIAPI -IpIoTransmitHandlerDpc ( - IN VOID *Context - ); - - -/** - Notify function for IP transmit token. - - @param[in] Event The event signaled. - @param[in] Context The context passed in by the event notifier. - -**/ -VOID -EFIAPI -IpIoTransmitHandler ( - IN EFI_EVENT Event, - IN VOID *Context - ); - - -/** - This function create an IP child ,open the IP protocol, and return the opened - IP protocol as Interface. - - @param[in] ControllerHandle The controller handle. - @param[in] ImageHandle The image handle. - @param[in] ChildHandle Pointer to the buffer to save the IP child handle. - @param[in] IpVersion The version of the IP protocol to use, either - IPv4 or IPv6. - @param[out] Interface Pointer used to get the IP protocol interface. - - @retval EFI_SUCCESS The IP child is created and the IP protocol - interface is retrieved. - @retval EFI_UNSUPPORTED Upsupported IpVersion. - @retval Others The required operation failed. - -**/ -EFI_STATUS -IpIoCreateIpChildOpenProtocol ( - IN EFI_HANDLE ControllerHandle, - IN EFI_HANDLE ImageHandle, - IN EFI_HANDLE *ChildHandle, - IN UINT8 IpVersion, - OUT VOID **Interface - ) -{ - EFI_STATUS Status; - EFI_GUID *ServiceBindingGuid; - EFI_GUID *IpProtocolGuid; - - if (IpVersion == IP_VERSION_4) { - ServiceBindingGuid = &gEfiIp4ServiceBindingProtocolGuid; - IpProtocolGuid = &gEfiIp4ProtocolGuid; - } else if (IpVersion == IP_VERSION_6){ - ServiceBindingGuid = &gEfiIp6ServiceBindingProtocolGuid; - IpProtocolGuid = &gEfiIp6ProtocolGuid; - } else { - return EFI_UNSUPPORTED; - } - - // - // Create an IP child. - // - Status = NetLibCreateServiceChild ( - ControllerHandle, - ImageHandle, - ServiceBindingGuid, - ChildHandle - ); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Open the IP protocol installed on the *ChildHandle. - // - Status = gBS->OpenProtocol ( - *ChildHandle, - IpProtocolGuid, - Interface, - ImageHandle, - ControllerHandle, - EFI_OPEN_PROTOCOL_BY_DRIVER - ); - if (EFI_ERROR (Status)) { - // - // On failure, destroy the IP child. - // - NetLibDestroyServiceChild ( - ControllerHandle, - ImageHandle, - ServiceBindingGuid, - *ChildHandle - ); - } - - return Status; -} - - -/** - This function close the previously openned IP protocol and destroy the IP child. - - @param[in] ControllerHandle The controller handle. - @param[in] ImageHandle The image handle. - @param[in] ChildHandle The child handle of the IP child. - @param[in] IpVersion The version of the IP protocol to use, either - IPv4 or IPv6. - - @retval EFI_SUCCESS The IP protocol is closed and the relevant IP child - is destroyed. - @retval EFI_UNSUPPORTED Upsupported IpVersion. - @retval Others The required operation failed. - -**/ -EFI_STATUS -IpIoCloseProtocolDestroyIpChild ( - IN EFI_HANDLE ControllerHandle, - IN EFI_HANDLE ImageHandle, - IN EFI_HANDLE ChildHandle, - IN UINT8 IpVersion - ) -{ - EFI_STATUS Status; - EFI_GUID *ServiceBindingGuid; - EFI_GUID *IpProtocolGuid; - - if (IpVersion == IP_VERSION_4) { - ServiceBindingGuid = &gEfiIp4ServiceBindingProtocolGuid; - IpProtocolGuid = &gEfiIp4ProtocolGuid; - } else if (IpVersion == IP_VERSION_6) { - ServiceBindingGuid = &gEfiIp6ServiceBindingProtocolGuid; - IpProtocolGuid = &gEfiIp6ProtocolGuid; - } else { - return EFI_UNSUPPORTED; - } - - // - // Close the previously openned IP protocol. - // - Status = gBS->CloseProtocol ( - ChildHandle, - IpProtocolGuid, - ImageHandle, - ControllerHandle - ); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Destroy the IP child. - // - return NetLibDestroyServiceChild ( - ControllerHandle, - ImageHandle, - ServiceBindingGuid, - ChildHandle - ); -} - -/** - This function handles ICMPv4 packets. It is the worker function of - IpIoIcmpHandler. - - @param[in] IpIo Pointer to the IP_IO instance. - @param[in, out] Pkt Pointer to the ICMPv4 packet. - @param[in] Session Pointer to the net session of this ICMPv4 packet. - - @retval EFI_SUCCESS The ICMPv4 packet is handled successfully. - @retval EFI_ABORTED This type of ICMPv4 packet is not supported. - -**/ -EFI_STATUS -IpIoIcmpv4Handler ( - IN IP_IO *IpIo, - IN OUT NET_BUF *Pkt, - IN EFI_NET_SESSION_DATA *Session - ) -{ - IP4_ICMP_ERROR_HEAD *IcmpHdr; - EFI_IP4_HEADER *IpHdr; - UINT8 IcmpErr; - UINT8 *PayLoadHdr; - UINT8 Type; - UINT8 Code; - UINT32 TrimBytes; - - ASSERT (IpIo != NULL); - ASSERT (Pkt != NULL); - ASSERT (Session != NULL); - ASSERT (IpIo->IpVersion == IP_VERSION_4); - - // - // Check the ICMP packet length. - // - if (Pkt->TotalSize < sizeof (IP4_ICMP_ERROR_HEAD)) { - return EFI_ABORTED; - } - - IcmpHdr = NET_PROTO_HDR (Pkt, IP4_ICMP_ERROR_HEAD); - IpHdr = (EFI_IP4_HEADER *) (&IcmpHdr->IpHead); - - if (Pkt->TotalSize < ICMP_ERRLEN (IpHdr)) { - - return EFI_ABORTED; - } - - Type = IcmpHdr->Head.Type; - Code = IcmpHdr->Head.Code; - - // - // Analyze the ICMP Error in this ICMP pkt - // - switch (Type) { - case ICMP_TYPE_UNREACH: - switch (Code) { - case ICMP_CODE_UNREACH_NET: - case ICMP_CODE_UNREACH_HOST: - case ICMP_CODE_UNREACH_PROTOCOL: - case ICMP_CODE_UNREACH_PORT: - case ICMP_CODE_UNREACH_SRCFAIL: - IcmpErr = (UINT8) (ICMP_ERR_UNREACH_NET + Code); - - break; - - case ICMP_CODE_UNREACH_NEEDFRAG: - IcmpErr = ICMP_ERR_MSGSIZE; - - break; - - case ICMP_CODE_UNREACH_NET_UNKNOWN: - case ICMP_CODE_UNREACH_NET_PROHIB: - case ICMP_CODE_UNREACH_TOSNET: - IcmpErr = ICMP_ERR_UNREACH_NET; - - break; - - case ICMP_CODE_UNREACH_HOST_UNKNOWN: - case ICMP_CODE_UNREACH_ISOLATED: - case ICMP_CODE_UNREACH_HOST_PROHIB: - case ICMP_CODE_UNREACH_TOSHOST: - IcmpErr = ICMP_ERR_UNREACH_HOST; - - break; - - default: - return EFI_ABORTED; - } - - break; - - case ICMP_TYPE_TIMXCEED: - if (Code > 1) { - return EFI_ABORTED; - } - - IcmpErr = (UINT8) (Code + ICMP_ERR_TIMXCEED_INTRANS); - - break; - - case ICMP_TYPE_PARAMPROB: - if (Code > 1) { - return EFI_ABORTED; - } - - IcmpErr = ICMP_ERR_PARAMPROB; - - break; - - case ICMP_TYPE_SOURCEQUENCH: - if (Code != 0) { - return EFI_ABORTED; - } - - IcmpErr = ICMP_ERR_QUENCH; - - break; - - default: - return EFI_ABORTED; - } - - // - // Notify user the ICMP pkt only containing payload except - // IP and ICMP header - // - PayLoadHdr = (UINT8 *) ((UINT8 *) IpHdr + EFI_IP4_HEADER_LEN (IpHdr)); - TrimBytes = (UINT32) (PayLoadHdr - (UINT8 *) IcmpHdr); - - NetbufTrim (Pkt, TrimBytes, TRUE); - - // - // If the input packet has invalid format, and TrimBytes is larger than - // the packet size, the NetbufTrim might trim the packet to zero. - // - if (Pkt->TotalSize != 0) { - IpIo->PktRcvdNotify (EFI_ICMP_ERROR, IcmpErr, Session, Pkt, IpIo->RcvdContext); - } - - return EFI_SUCCESS; -} - -/** - This function handles ICMPv6 packets. It is the worker function of - IpIoIcmpHandler. - - @param[in] IpIo Pointer to the IP_IO instance. - @param[in, out] Pkt Pointer to the ICMPv6 packet. - @param[in] Session Pointer to the net session of this ICMPv6 packet. - - @retval EFI_SUCCESS The ICMPv6 packet is handled successfully. - @retval EFI_ABORTED This type of ICMPv6 packet is not supported. - -**/ -EFI_STATUS -IpIoIcmpv6Handler ( - IN IP_IO *IpIo, - IN OUT NET_BUF *Pkt, - IN EFI_NET_SESSION_DATA *Session - ) -{ - IP6_ICMP_ERROR_HEAD *IcmpHdr; - EFI_IP6_HEADER *IpHdr; - UINT8 IcmpErr; - UINT8 *PayLoadHdr; - UINT8 Type; - UINT8 Code; - UINT8 NextHeader; - UINT32 TrimBytes; - BOOLEAN Flag; - - ASSERT (IpIo != NULL); - ASSERT (Pkt != NULL); - ASSERT (Session != NULL); - ASSERT (IpIo->IpVersion == IP_VERSION_6); - - // - // Check the ICMPv6 packet length. - // - if (Pkt->TotalSize < sizeof (IP6_ICMP_ERROR_HEAD)) { - - return EFI_ABORTED; - } - - IcmpHdr = NET_PROTO_HDR (Pkt, IP6_ICMP_ERROR_HEAD); - Type = IcmpHdr->Head.Type; - Code = IcmpHdr->Head.Code; - - // - // Analyze the ICMPv6 Error in this ICMPv6 packet - // - switch (Type) { - case ICMP_V6_DEST_UNREACHABLE: - switch (Code) { - case ICMP_V6_NO_ROUTE_TO_DEST: - case ICMP_V6_BEYOND_SCOPE: - case ICMP_V6_ROUTE_REJECTED: - IcmpErr = ICMP6_ERR_UNREACH_NET; - - break; - - case ICMP_V6_COMM_PROHIBITED: - case ICMP_V6_ADDR_UNREACHABLE: - case ICMP_V6_SOURCE_ADDR_FAILED: - IcmpErr = ICMP6_ERR_UNREACH_HOST; - - break; - - case ICMP_V6_PORT_UNREACHABLE: - IcmpErr = ICMP6_ERR_UNREACH_PORT; - - break; - - default: - return EFI_ABORTED; - } - - break; - - case ICMP_V6_PACKET_TOO_BIG: - if (Code >= 1) { - return EFI_ABORTED; - } - - IcmpErr = ICMP6_ERR_PACKAGE_TOOBIG; - - break; - - case ICMP_V6_TIME_EXCEEDED: - if (Code > 1) { - return EFI_ABORTED; - } - - IcmpErr = (UINT8) (ICMP6_ERR_TIMXCEED_HOPLIMIT + Code); - - break; - - case ICMP_V6_PARAMETER_PROBLEM: - if (Code > 3) { - return EFI_ABORTED; - } - - IcmpErr = (UINT8) (ICMP6_ERR_PARAMPROB_HEADER + Code); - - break; - - default: - - return EFI_ABORTED; - } - - // - // Notify user the ICMPv6 packet only containing payload except - // IPv6 basic header, extension header and ICMP header - // - - IpHdr = (EFI_IP6_HEADER *) (&IcmpHdr->IpHead); - NextHeader = IpHdr->NextHeader; - PayLoadHdr = (UINT8 *) ((UINT8 *) IcmpHdr + sizeof (IP6_ICMP_ERROR_HEAD)); - Flag = TRUE; - - do { - switch (NextHeader) { - case EFI_IP_PROTO_UDP: - case EFI_IP_PROTO_TCP: - case EFI_IP_PROTO_ICMP: - case IP6_NO_NEXT_HEADER: - Flag = FALSE; - - break; - - case IP6_HOP_BY_HOP: - case IP6_DESTINATION: - // - // The Hdr Ext Len is 8-bit unsigned integer in 8-octet units, not including - // the first 8 octets. - // - NextHeader = *(PayLoadHdr); - PayLoadHdr = (UINT8 *) (PayLoadHdr + (*(PayLoadHdr + 1) + 1) * 8); - - break; - - case IP6_FRAGMENT: - // - // The Fragment Header Length is 8 octets. - // - NextHeader = *(PayLoadHdr); - PayLoadHdr = (UINT8 *) (PayLoadHdr + 8); - - break; - - default: - - return EFI_ABORTED; - } - } while (Flag); - - TrimBytes = (UINT32) (PayLoadHdr - (UINT8 *) IcmpHdr); - - NetbufTrim (Pkt, TrimBytes, TRUE); - - // - // If the input packet has invalid format, and TrimBytes is larger than - // the packet size, the NetbufTrim might trim the packet to zero. - // - if (Pkt->TotalSize != 0) { - IpIo->PktRcvdNotify (EFI_ICMP_ERROR, IcmpErr, Session, Pkt, IpIo->RcvdContext); - } - - return EFI_SUCCESS; -} - -/** - This function handles ICMP packets. - - @param[in] IpIo Pointer to the IP_IO instance. - @param[in, out] Pkt Pointer to the ICMP packet. - @param[in] Session Pointer to the net session of this ICMP packet. - - @retval EFI_SUCCESS The ICMP packet is handled successfully. - @retval EFI_ABORTED This type of ICMP packet is not supported. - @retval EFI_UNSUPPORTED The IP protocol version in IP_IO is not supported. - -**/ -EFI_STATUS -IpIoIcmpHandler ( - IN IP_IO *IpIo, - IN OUT NET_BUF *Pkt, - IN EFI_NET_SESSION_DATA *Session - ) -{ - - if (IpIo->IpVersion == IP_VERSION_4) { - - return IpIoIcmpv4Handler (IpIo, Pkt, Session); - - } else if (IpIo->IpVersion == IP_VERSION_6) { - - return IpIoIcmpv6Handler (IpIo, Pkt, Session); - - } else { - - return EFI_UNSUPPORTED; - } -} - - -/** - Free function for receive token of IP_IO. It is used to - signal the recycle event to notify IP to recycle the - data buffer. - - @param[in] Event The event to be signaled. - -**/ -VOID -EFIAPI -IpIoExtFree ( - IN VOID *Event - ) -{ - gBS->SignalEvent ((EFI_EVENT) Event); -} - - -/** - Create a send entry to wrap a packet before sending - out it through IP. - - @param[in, out] IpIo Pointer to the IP_IO instance. - @param[in, out] Pkt Pointer to the packet. - @param[in] Sender Pointer to the IP sender. - @param[in] Context Pointer to the context. - @param[in] NotifyData Pointer to the notify data. - @param[in] Dest Pointer to the destination IP address. - @param[in] Override Pointer to the overriden IP_IO data. - - @return Pointer to the data structure created to wrap the packet. If any error occurs, - then return NULL. - -**/ -IP_IO_SEND_ENTRY * -IpIoCreateSndEntry ( - IN OUT IP_IO *IpIo, - IN OUT NET_BUF *Pkt, - IN IP_IO_IP_PROTOCOL Sender, - IN VOID *Context OPTIONAL, - IN VOID *NotifyData OPTIONAL, - IN EFI_IP_ADDRESS *Dest OPTIONAL, - IN IP_IO_OVERRIDE *Override - ) -{ - IP_IO_SEND_ENTRY *SndEntry; - EFI_EVENT Event; - EFI_STATUS Status; - NET_FRAGMENT *ExtFragment; - UINT32 FragmentCount; - IP_IO_OVERRIDE *OverrideData; - IP_IO_IP_TX_DATA *TxData; - EFI_IP4_TRANSMIT_DATA *Ip4TxData; - EFI_IP6_TRANSMIT_DATA *Ip6TxData; - - if ((IpIo->IpVersion != IP_VERSION_4) && (IpIo->IpVersion != IP_VERSION_6)) { - return NULL; - } - - Event = NULL; - TxData = NULL; - OverrideData = NULL; - - // - // Allocate resource for SndEntry - // - SndEntry = AllocatePool (sizeof (IP_IO_SEND_ENTRY)); - if (NULL == SndEntry) { - return NULL; - } - - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, - IpIoTransmitHandler, - SndEntry, - &Event - ); - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - FragmentCount = Pkt->BlockOpNum; - - // - // Allocate resource for TxData - // - TxData = (IP_IO_IP_TX_DATA *) AllocatePool ( - sizeof (IP_IO_IP_TX_DATA) + sizeof (NET_FRAGMENT) * (FragmentCount - 1) - ); - - if (NULL == TxData) { - goto ON_ERROR; - } - - // - // Build a fragment table to contain the fragments in the packet. - // - if (IpIo->IpVersion == IP_VERSION_4) { - ExtFragment = (NET_FRAGMENT *) TxData->Ip4TxData.FragmentTable; - } else { - ExtFragment = (NET_FRAGMENT *) TxData->Ip6TxData.FragmentTable; - } - - NetbufBuildExt (Pkt, ExtFragment, &FragmentCount); - - - // - // Allocate resource for OverrideData if needed - // - if (NULL != Override) { - - OverrideData = AllocateCopyPool (sizeof (IP_IO_OVERRIDE), Override); - if (NULL == OverrideData) { - goto ON_ERROR; - } - } - - // - // Set other fields of TxData except the fragment table - // - if (IpIo->IpVersion == IP_VERSION_4) { - - Ip4TxData = &TxData->Ip4TxData; - - IP4_COPY_ADDRESS (&Ip4TxData->DestinationAddress, Dest); - - Ip4TxData->OverrideData = &OverrideData->Ip4OverrideData; - Ip4TxData->OptionsLength = 0; - Ip4TxData->OptionsBuffer = NULL; - Ip4TxData->TotalDataLength = Pkt->TotalSize; - Ip4TxData->FragmentCount = FragmentCount; - - // - // Set the fields of SndToken - // - SndEntry->SndToken.Ip4Token.Event = Event; - SndEntry->SndToken.Ip4Token.Packet.TxData = Ip4TxData; - } else { - - Ip6TxData = &TxData->Ip6TxData; - - if (Dest != NULL) { - CopyMem (&Ip6TxData->DestinationAddress, Dest, sizeof (EFI_IPv6_ADDRESS)); - } else { - ZeroMem (&Ip6TxData->DestinationAddress, sizeof (EFI_IPv6_ADDRESS)); - } - - Ip6TxData->OverrideData = &OverrideData->Ip6OverrideData; - Ip6TxData->DataLength = Pkt->TotalSize; - Ip6TxData->FragmentCount = FragmentCount; - Ip6TxData->ExtHdrsLength = 0; - Ip6TxData->ExtHdrs = NULL; - - // - // Set the fields of SndToken - // - SndEntry->SndToken.Ip6Token.Event = Event; - SndEntry->SndToken.Ip6Token.Packet.TxData = Ip6TxData; - } - - // - // Set the fields of SndEntry - // - SndEntry->IpIo = IpIo; - SndEntry->Ip = Sender; - SndEntry->Context = Context; - SndEntry->NotifyData = NotifyData; - - SndEntry->Pkt = Pkt; - NET_GET_REF (Pkt); - - InsertTailList (&IpIo->PendingSndList, &SndEntry->Entry); - - return SndEntry; - -ON_ERROR: - - if (OverrideData != NULL) { - FreePool (OverrideData); - } - - if (TxData != NULL) { - FreePool (TxData); - } - - if (SndEntry != NULL) { - FreePool (SndEntry); - } - - if (Event != NULL) { - gBS->CloseEvent (Event); - } - - return NULL; -} - - -/** - Destroy the SndEntry. - - This function pairs with IpIoCreateSndEntry(). - - @param[in] SndEntry Pointer to the send entry to be destroyed. - -**/ -VOID -IpIoDestroySndEntry ( - IN IP_IO_SEND_ENTRY *SndEntry - ) -{ - EFI_EVENT Event; - IP_IO_IP_TX_DATA *TxData; - IP_IO_OVERRIDE *Override; - - if (SndEntry->IpIo->IpVersion == IP_VERSION_4) { - Event = SndEntry->SndToken.Ip4Token.Event; - TxData = (IP_IO_IP_TX_DATA *) SndEntry->SndToken.Ip4Token.Packet.TxData; - Override = (IP_IO_OVERRIDE *) TxData->Ip4TxData.OverrideData; - } else if (SndEntry->IpIo->IpVersion == IP_VERSION_6) { - Event = SndEntry->SndToken.Ip6Token.Event; - TxData = (IP_IO_IP_TX_DATA *) SndEntry->SndToken.Ip6Token.Packet.TxData; - Override = (IP_IO_OVERRIDE *) TxData->Ip6TxData.OverrideData; - } else { - return ; - } - - gBS->CloseEvent (Event); - - FreePool (TxData); - - if (NULL != Override) { - FreePool (Override); - } - - NetbufFree (SndEntry->Pkt); - - RemoveEntryList (&SndEntry->Entry); - - FreePool (SndEntry); -} - - -/** - Notify function for IP transmit token. - - @param[in] Context The context passed in by the event notifier. - -**/ -VOID -EFIAPI -IpIoTransmitHandlerDpc ( - IN VOID *Context - ) -{ - IP_IO *IpIo; - IP_IO_SEND_ENTRY *SndEntry; - EFI_STATUS Status; - - SndEntry = (IP_IO_SEND_ENTRY *) Context; - - IpIo = SndEntry->IpIo; - - if (IpIo->IpVersion == IP_VERSION_4) { - Status = SndEntry->SndToken.Ip4Token.Status; - } else if (IpIo->IpVersion == IP_VERSION_6){ - Status = SndEntry->SndToken.Ip6Token.Status; - } else { - return ; - } - - if ((IpIo->PktSentNotify != NULL) && (SndEntry->NotifyData != NULL)) { - IpIo->PktSentNotify ( - Status, - SndEntry->Context, - SndEntry->Ip, - SndEntry->NotifyData - ); - } - - IpIoDestroySndEntry (SndEntry); -} - - -/** - Notify function for IP transmit token. - - @param[in] Event The event signaled. - @param[in] Context The context passed in by the event notifier. - -**/ -VOID -EFIAPI -IpIoTransmitHandler ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - // - // Request IpIoTransmitHandlerDpc as a DPC at TPL_CALLBACK - // - QueueDpc (TPL_CALLBACK, IpIoTransmitHandlerDpc, Context); -} - - -/** - The dummy handler for the dummy IP receive token. - - @param[in] Context The context passed in by the event notifier. - -**/ -VOID -EFIAPI -IpIoDummyHandlerDpc ( - IN VOID *Context - ) -{ - IP_IO_IP_INFO *IpInfo; - EFI_STATUS Status; - EFI_EVENT RecycleEvent; - - IpInfo = (IP_IO_IP_INFO *) Context; - - if ((IpInfo->IpVersion != IP_VERSION_4) && (IpInfo->IpVersion != IP_VERSION_6)) { - return ; - } - - RecycleEvent = NULL; - - if (IpInfo->IpVersion == IP_VERSION_4) { - Status = IpInfo->DummyRcvToken.Ip4Token.Status; - - if (IpInfo->DummyRcvToken.Ip4Token.Packet.RxData != NULL) { - RecycleEvent = IpInfo->DummyRcvToken.Ip4Token.Packet.RxData->RecycleSignal; - } - } else { - Status = IpInfo->DummyRcvToken.Ip6Token.Status; - - if (IpInfo->DummyRcvToken.Ip6Token.Packet.RxData != NULL) { - RecycleEvent = IpInfo->DummyRcvToken.Ip6Token.Packet.RxData->RecycleSignal; - } - } - - - - if (EFI_ABORTED == Status) { - // - // The reception is actively aborted by the consumer, directly return. - // - return; - } else if (EFI_SUCCESS == Status) { - // - // Recycle the RxData. - // - ASSERT (RecycleEvent != NULL); - - gBS->SignalEvent (RecycleEvent); - } - - // - // Continue the receive. - // - if (IpInfo->IpVersion == IP_VERSION_4) { - IpInfo->Ip.Ip4->Receive ( - IpInfo->Ip.Ip4, - &IpInfo->DummyRcvToken.Ip4Token - ); - } else { - IpInfo->Ip.Ip6->Receive ( - IpInfo->Ip.Ip6, - &IpInfo->DummyRcvToken.Ip6Token - ); - } -} - - -/** - This function add IpIoDummyHandlerDpc to the end of the DPC queue. - - @param[in] Event The event signaled. - @param[in] Context The context passed in by the event notifier. - -**/ -VOID -EFIAPI -IpIoDummyHandler ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - // - // Request IpIoDummyHandlerDpc as a DPC at TPL_CALLBACK - // - QueueDpc (TPL_CALLBACK, IpIoDummyHandlerDpc, Context); -} - - -/** - Notify function for the IP receive token, used to process - the received IP packets. - - @param[in] Context The context passed in by the event notifier. - -**/ -VOID -EFIAPI -IpIoListenHandlerDpc ( - IN VOID *Context - ) -{ - IP_IO *IpIo; - EFI_STATUS Status; - IP_IO_IP_RX_DATA *RxData; - EFI_NET_SESSION_DATA Session; - NET_BUF *Pkt; - - IpIo = (IP_IO *) Context; - - if (IpIo->IpVersion == IP_VERSION_4) { - Status = IpIo->RcvToken.Ip4Token.Status; - RxData = (IP_IO_IP_RX_DATA *) IpIo->RcvToken.Ip4Token.Packet.RxData; - } else if (IpIo->IpVersion == IP_VERSION_6) { - Status = IpIo->RcvToken.Ip6Token.Status; - RxData = (IP_IO_IP_RX_DATA *) IpIo->RcvToken.Ip6Token.Packet.RxData; - } else { - return; - } - - if (EFI_ABORTED == Status) { - // - // The reception is actively aborted by the consumer, directly return. - // - return; - } - - if ((EFI_SUCCESS != Status) && (EFI_ICMP_ERROR != Status)) { - // - // Only process the normal packets and the icmp error packets. - // - if (RxData != NULL) { - goto CleanUp; - } else { - goto Resume; - } - } - - // - // if RxData is NULL with Status == EFI_SUCCESS or EFI_ICMP_ERROR, this should be a code issue in the low layer (IP). - // - ASSERT (RxData != NULL); - if (RxData == NULL) { - goto Resume; - } - - if (NULL == IpIo->PktRcvdNotify) { - goto CleanUp; - } - - if (IpIo->IpVersion == IP_VERSION_4) { - ASSERT (RxData->Ip4RxData.Header != NULL); - if (IP4_IS_LOCAL_BROADCAST (EFI_IP4 (RxData->Ip4RxData.Header->SourceAddress))) { - // - // The source address is a broadcast address, discard it. - // - goto CleanUp; - } - if ((EFI_IP4 (RxData->Ip4RxData.Header->SourceAddress) != 0) && - (IpIo->SubnetMask != 0) && - IP4_NET_EQUAL (IpIo->StationIp, EFI_NTOHL (((EFI_IP4_RECEIVE_DATA *) RxData)->Header->SourceAddress), IpIo->SubnetMask) && - !NetIp4IsUnicast (EFI_NTOHL (((EFI_IP4_RECEIVE_DATA *) RxData)->Header->SourceAddress), IpIo->SubnetMask)) { - // - // The source address doesn't match StationIp and it's not a unicast IP address, discard it. - // - goto CleanUp; - } - - if (RxData->Ip4RxData.DataLength == 0) { - // - // Discard zero length data payload packet. - // - goto CleanUp; - } - - // - // The fragment should always be valid for non-zero length packet. - // - ASSERT (RxData->Ip4RxData.FragmentCount != 0); - - // - // Create a netbuffer representing IPv4 packet - // - Pkt = NetbufFromExt ( - (NET_FRAGMENT *) RxData->Ip4RxData.FragmentTable, - RxData->Ip4RxData.FragmentCount, - 0, - 0, - IpIoExtFree, - RxData->Ip4RxData.RecycleSignal - ); - if (NULL == Pkt) { - goto CleanUp; - } - - // - // Create a net session - // - Session.Source.Addr[0] = EFI_IP4 (RxData->Ip4RxData.Header->SourceAddress); - Session.Dest.Addr[0] = EFI_IP4 (RxData->Ip4RxData.Header->DestinationAddress); - Session.IpHdr.Ip4Hdr = RxData->Ip4RxData.Header; - Session.IpHdrLen = RxData->Ip4RxData.HeaderLength; - Session.IpVersion = IP_VERSION_4; - } else { - ASSERT (RxData->Ip6RxData.Header != NULL); - if (!NetIp6IsValidUnicast(&RxData->Ip6RxData.Header->SourceAddress)) { - goto CleanUp; - } - - if (RxData->Ip6RxData.DataLength == 0) { - // - // Discard zero length data payload packet. - // - goto CleanUp; - } - - // - // The fragment should always be valid for non-zero length packet. - // - ASSERT (RxData->Ip6RxData.FragmentCount != 0); - - // - // Create a netbuffer representing IPv6 packet - // - Pkt = NetbufFromExt ( - (NET_FRAGMENT *) RxData->Ip6RxData.FragmentTable, - RxData->Ip6RxData.FragmentCount, - 0, - 0, - IpIoExtFree, - RxData->Ip6RxData.RecycleSignal - ); - if (NULL == Pkt) { - goto CleanUp; - } - - // - // Create a net session - // - CopyMem ( - &Session.Source, - &RxData->Ip6RxData.Header->SourceAddress, - sizeof(EFI_IPv6_ADDRESS) - ); - CopyMem ( - &Session.Dest, - &RxData->Ip6RxData.Header->DestinationAddress, - sizeof(EFI_IPv6_ADDRESS) - ); - Session.IpHdr.Ip6Hdr = RxData->Ip6RxData.Header; - Session.IpHdrLen = RxData->Ip6RxData.HeaderLength; - Session.IpVersion = IP_VERSION_6; - } - - if (EFI_SUCCESS == Status) { - - IpIo->PktRcvdNotify (EFI_SUCCESS, 0, &Session, Pkt, IpIo->RcvdContext); - } else { - // - // Status is EFI_ICMP_ERROR - // - Status = IpIoIcmpHandler (IpIo, Pkt, &Session); - if (EFI_ERROR (Status)) { - NetbufFree (Pkt); - } - } - - goto Resume; - -CleanUp: - - if (IpIo->IpVersion == IP_VERSION_4){ - gBS->SignalEvent (RxData->Ip4RxData.RecycleSignal); - } else { - gBS->SignalEvent (RxData->Ip6RxData.RecycleSignal); - } - -Resume: - - if (IpIo->IpVersion == IP_VERSION_4){ - IpIo->Ip.Ip4->Receive (IpIo->Ip.Ip4, &(IpIo->RcvToken.Ip4Token)); - } else { - IpIo->Ip.Ip6->Receive (IpIo->Ip.Ip6, &(IpIo->RcvToken.Ip6Token)); - } -} - -/** - This function add IpIoListenHandlerDpc to the end of the DPC queue. - - @param[in] Event The event signaled. - @param[in] Context The context passed in by the event notifier. - -**/ -VOID -EFIAPI -IpIoListenHandler ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - // - // Request IpIoListenHandlerDpc as a DPC at TPL_CALLBACK - // - QueueDpc (TPL_CALLBACK, IpIoListenHandlerDpc, Context); -} - - -/** - Create a new IP_IO instance. - - If IpVersion is not IP_VERSION_4 or IP_VERSION_6, then ASSERT(). - - This function uses IP4/IP6 service binding protocol in Controller to create - an IP4/IP6 child (aka IP4/IP6 instance). - - @param[in] Image The image handle of the driver or application that - consumes IP_IO. - @param[in] Controller The controller handle that has IP4 or IP6 service - binding protocol installed. - @param[in] IpVersion The version of the IP protocol to use, either - IPv4 or IPv6. - - @return Pointer to a newly created IP_IO instance, or NULL if failed. - -**/ -IP_IO * -EFIAPI -IpIoCreate ( - IN EFI_HANDLE Image, - IN EFI_HANDLE Controller, - IN UINT8 IpVersion - ) -{ - EFI_STATUS Status; - IP_IO *IpIo; - EFI_EVENT Event; - - ASSERT ((IpVersion == IP_VERSION_4) || (IpVersion == IP_VERSION_6)); - - IpIo = AllocateZeroPool (sizeof (IP_IO)); - if (NULL == IpIo) { - return NULL; - } - - InitializeListHead (&(IpIo->PendingSndList)); - InitializeListHead (&(IpIo->IpList)); - IpIo->Controller = Controller; - IpIo->Image = Image; - IpIo->IpVersion = IpVersion; - Event = NULL; - - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, - IpIoListenHandler, - IpIo, - &Event - ); - if (EFI_ERROR (Status)) { - goto ReleaseIpIo; - } - - if (IpVersion == IP_VERSION_4) { - IpIo->RcvToken.Ip4Token.Event = Event; - } else { - IpIo->RcvToken.Ip6Token.Event = Event; - } - - // - // Create an IP child and open IP protocol - // - Status = IpIoCreateIpChildOpenProtocol ( - Controller, - Image, - &IpIo->ChildHandle, - IpVersion, - (VOID **) & (IpIo->Ip) - ); - if (EFI_ERROR (Status)) { - goto ReleaseIpIo; - } - - return IpIo; - -ReleaseIpIo: - - if (Event != NULL) { - gBS->CloseEvent (Event); - } - - gBS->FreePool (IpIo); - - return NULL; -} - - -/** - Open an IP_IO instance for use. - - If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT(). - - This function is called after IpIoCreate(). It is used for configuring the IP - instance and register the callbacks and their context data for sending and - receiving IP packets. - - @param[in, out] IpIo Pointer to an IP_IO instance that needs - to open. - @param[in] OpenData The configuration data and callbacks for - the IP_IO instance. - - @retval EFI_SUCCESS The IP_IO instance opened with OpenData - successfully. - @retval EFI_ACCESS_DENIED The IP_IO instance is configured, avoid to - reopen it. - @retval EFI_UNSUPPORTED IPv4 RawData mode is no supported. - @retval EFI_INVALID_PARAMETER Invalid input parameter. - @retval Others Error condition occurred. - -**/ -EFI_STATUS -EFIAPI -IpIoOpen ( - IN OUT IP_IO *IpIo, - IN IP_IO_OPEN_DATA *OpenData - ) -{ - EFI_STATUS Status; - UINT8 IpVersion; - - if (IpIo == NULL || OpenData == NULL) { - return EFI_INVALID_PARAMETER; - } - - if (IpIo->IsConfigured) { - return EFI_ACCESS_DENIED; - } - - IpVersion = IpIo->IpVersion; - - ASSERT ((IpVersion == IP_VERSION_4) || (IpVersion == IP_VERSION_6)); - - // - // configure ip - // - if (IpVersion == IP_VERSION_4){ - // - // RawData mode is no supported. - // - ASSERT (!OpenData->IpConfigData.Ip4CfgData.RawData); - if (OpenData->IpConfigData.Ip4CfgData.RawData) { - return EFI_UNSUPPORTED; - } - - if (!OpenData->IpConfigData.Ip4CfgData.UseDefaultAddress) { - IpIo->StationIp = EFI_NTOHL (OpenData->IpConfigData.Ip4CfgData.StationAddress); - IpIo->SubnetMask = EFI_NTOHL (OpenData->IpConfigData.Ip4CfgData.SubnetMask); - } - - Status = IpIo->Ip.Ip4->Configure ( - IpIo->Ip.Ip4, - &OpenData->IpConfigData.Ip4CfgData - ); - } else { - - Status = IpIo->Ip.Ip6->Configure ( - IpIo->Ip.Ip6, - &OpenData->IpConfigData.Ip6CfgData - ); - } - - if (EFI_ERROR (Status)) { - return Status; - } - - // - // @bug To delete the default route entry in this Ip, if it is: - // @bug (0.0.0.0, 0.0.0.0, 0.0.0.0). Delete this statement if Ip modified - // @bug its code - // - if (IpVersion == IP_VERSION_4){ - Status = IpIo->Ip.Ip4->Routes ( - IpIo->Ip.Ip4, - TRUE, - &mZeroIp4Addr, - &mZeroIp4Addr, - &mZeroIp4Addr - ); - - if (EFI_ERROR (Status) && (EFI_NOT_FOUND != Status)) { - return Status; - } - } - - IpIo->PktRcvdNotify = OpenData->PktRcvdNotify; - IpIo->PktSentNotify = OpenData->PktSentNotify; - - IpIo->RcvdContext = OpenData->RcvdContext; - IpIo->SndContext = OpenData->SndContext; - - if (IpVersion == IP_VERSION_4){ - IpIo->Protocol = OpenData->IpConfigData.Ip4CfgData.DefaultProtocol; - - // - // start to listen incoming packet - // - Status = IpIo->Ip.Ip4->Receive ( - IpIo->Ip.Ip4, - &(IpIo->RcvToken.Ip4Token) - ); - if (EFI_ERROR (Status)) { - IpIo->Ip.Ip4->Configure (IpIo->Ip.Ip4, NULL); - return Status; - } - - } else { - - IpIo->Protocol = OpenData->IpConfigData.Ip6CfgData.DefaultProtocol; - Status = IpIo->Ip.Ip6->Receive ( - IpIo->Ip.Ip6, - &(IpIo->RcvToken.Ip6Token) - ); - if (EFI_ERROR (Status)) { - IpIo->Ip.Ip6->Configure (IpIo->Ip.Ip6, NULL); - return Status; - } - } - - IpIo->IsConfigured = TRUE; - InsertTailList (&mActiveIpIoList, &IpIo->Entry); - - return Status; -} - - -/** - Stop an IP_IO instance. - - If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT(). - - This function is paired with IpIoOpen(). The IP_IO will be unconfigured and all - the pending send/receive tokens will be canceled. - - @param[in, out] IpIo Pointer to the IP_IO instance that needs to stop. - - @retval EFI_SUCCESS The IP_IO instance stopped successfully. - @retval EFI_INVALID_PARAMETER Invalid input parameter. - @retval Others Error condition occurred. - -**/ -EFI_STATUS -EFIAPI -IpIoStop ( - IN OUT IP_IO *IpIo - ) -{ - EFI_STATUS Status; - IP_IO_IP_INFO *IpInfo; - UINT8 IpVersion; - - if (IpIo == NULL) { - return EFI_INVALID_PARAMETER; - } - - if (!IpIo->IsConfigured) { - return EFI_SUCCESS; - } - - IpVersion = IpIo->IpVersion; - - ASSERT ((IpVersion == IP_VERSION_4) || (IpVersion == IP_VERSION_6)); - - // - // Remove the IpIo from the active IpIo list. - // - RemoveEntryList (&IpIo->Entry); - - // - // Configure NULL Ip - // - if (IpVersion == IP_VERSION_4) { - Status = IpIo->Ip.Ip4->Configure (IpIo->Ip.Ip4, NULL); - } else { - Status = IpIo->Ip.Ip6->Configure (IpIo->Ip.Ip6, NULL); - } - if (EFI_ERROR (Status)) { - return Status; - } - - IpIo->IsConfigured = FALSE; - - // - // Detroy the Ip List used by IpIo - // - - while (!IsListEmpty (&(IpIo->IpList))) { - IpInfo = NET_LIST_HEAD (&(IpIo->IpList), IP_IO_IP_INFO, Entry); - - IpIoRemoveIp (IpIo, IpInfo); - } - - // - // All pending send tokens should be flushed by resetting the IP instances. - // - ASSERT (IsListEmpty (&IpIo->PendingSndList)); - - // - // Close the receive event. - // - if (IpVersion == IP_VERSION_4){ - gBS->CloseEvent (IpIo->RcvToken.Ip4Token.Event); - } else { - gBS->CloseEvent (IpIo->RcvToken.Ip6Token.Event); - } - - return EFI_SUCCESS; -} - - -/** - Destroy an IP_IO instance. - - This function is paired with IpIoCreate(). The IP_IO will be closed first. - Resource will be freed afterwards. See IpIoCloseProtocolDestroyIpChild(). - - @param[in, out] IpIo Pointer to the IP_IO instance that needs to be - destroyed. - - @retval EFI_SUCCESS The IP_IO instance destroyed successfully. - @retval Others Error condition occurred. - -**/ -EFI_STATUS -EFIAPI -IpIoDestroy ( - IN OUT IP_IO *IpIo - ) -{ - EFI_STATUS Status; - - // - // Stop the IpIo. - // - Status = IpIoStop (IpIo); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Close the IP protocol and destroy the child. - // - Status = IpIoCloseProtocolDestroyIpChild ( - IpIo->Controller, - IpIo->Image, - IpIo->ChildHandle, - IpIo->IpVersion - ); - if (EFI_ERROR (Status)) { - return Status; - } - - gBS->FreePool (IpIo); - - return EFI_SUCCESS; -} - - -/** - Send out an IP packet. - - This function is called after IpIoOpen(). The data to be sent is wrapped in - Pkt. The IP instance wrapped in IpIo is used for sending by default but can be - overriden by Sender. Other sending configs, like source address and gateway - address etc., are specified in OverrideData. - - @param[in, out] IpIo Pointer to an IP_IO instance used for sending IP - packet. - @param[in, out] Pkt Pointer to the IP packet to be sent. - @param[in] Sender The IP protocol instance used for sending. - @param[in] Context Optional context data. - @param[in] NotifyData Optional notify data. - @param[in] Dest The destination IP address to send this packet to. - This parameter is optional when using IPv6. - @param[in] OverrideData The data to override some configuration of the IP - instance used for sending. - - @retval EFI_SUCCESS The operation is completed successfully. - @retval EFI_INVALID_PARAMETER The input parameter is not correct. - @retval EFI_NOT_STARTED The IpIo is not configured. - @retval EFI_OUT_OF_RESOURCES Failed due to resource limit. - @retval Others Error condition occurred. - -**/ -EFI_STATUS -EFIAPI -IpIoSend ( - IN OUT IP_IO *IpIo, - IN OUT NET_BUF *Pkt, - IN IP_IO_IP_INFO *Sender OPTIONAL, - IN VOID *Context OPTIONAL, - IN VOID *NotifyData OPTIONAL, - IN EFI_IP_ADDRESS *Dest OPTIONAL, - IN IP_IO_OVERRIDE *OverrideData OPTIONAL - ) -{ - EFI_STATUS Status; - IP_IO_IP_PROTOCOL Ip; - IP_IO_SEND_ENTRY *SndEntry; - - if ((IpIo == NULL) || (Pkt == NULL)) { - return EFI_INVALID_PARAMETER; - } - - if ((IpIo->IpVersion == IP_VERSION_4) && (Dest == NULL)) { - return EFI_INVALID_PARAMETER; - } - - if (!IpIo->IsConfigured) { - return EFI_NOT_STARTED; - } - - Ip = (NULL == Sender) ? IpIo->Ip : Sender->Ip; - - // - // create a new SndEntry - // - SndEntry = IpIoCreateSndEntry (IpIo, Pkt, Ip, Context, NotifyData, Dest, OverrideData); - if (NULL == SndEntry) { - return EFI_OUT_OF_RESOURCES; - } - - // - // Send this Packet - // - if (IpIo->IpVersion == IP_VERSION_4){ - Status = Ip.Ip4->Transmit ( - Ip.Ip4, - &SndEntry->SndToken.Ip4Token - ); - } else { - Status = Ip.Ip6->Transmit ( - Ip.Ip6, - &SndEntry->SndToken.Ip6Token - ); - } - - if (EFI_ERROR (Status)) { - IpIoDestroySndEntry (SndEntry); - } - - return Status; -} - - -/** - Cancel the IP transmit token which wraps this Packet. - - If IpIo is NULL, then ASSERT(). - If Packet is NULL, then ASSERT(). - - @param[in] IpIo Pointer to the IP_IO instance. - @param[in] Packet Pointer to the packet of NET_BUF to cancel. - -**/ -VOID -EFIAPI -IpIoCancelTxToken ( - IN IP_IO *IpIo, - IN VOID *Packet - ) -{ - LIST_ENTRY *Node; - IP_IO_SEND_ENTRY *SndEntry; - IP_IO_IP_PROTOCOL Ip; - - ASSERT ((IpIo != NULL) && (Packet != NULL)); - - NET_LIST_FOR_EACH (Node, &IpIo->PendingSndList) { - - SndEntry = NET_LIST_USER_STRUCT (Node, IP_IO_SEND_ENTRY, Entry); - - if (SndEntry->Pkt == Packet) { - - Ip = SndEntry->Ip; - - if (IpIo->IpVersion == IP_VERSION_4) { - Ip.Ip4->Cancel ( - Ip.Ip4, - &SndEntry->SndToken.Ip4Token - ); - } else { - Ip.Ip6->Cancel ( - Ip.Ip6, - &SndEntry->SndToken.Ip6Token - ); - } - - break; - } - } - -} - - -/** - Add a new IP instance for sending data. - - If IpIo is NULL, then ASSERT(). - If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT(). - - The function is used to add the IP_IO to the IP_IO sending list. The caller - can later use IpIoFindSender() to get the IP_IO and call IpIoSend() to send - data. - - @param[in, out] IpIo Pointer to a IP_IO instance to add a new IP - instance for sending purpose. - - @return Pointer to the created IP_IO_IP_INFO structure, NULL if failed. - -**/ -IP_IO_IP_INFO * -EFIAPI -IpIoAddIp ( - IN OUT IP_IO *IpIo - ) -{ - EFI_STATUS Status; - IP_IO_IP_INFO *IpInfo; - EFI_EVENT Event; - - ASSERT (IpIo != NULL); - ASSERT ((IpIo->IpVersion == IP_VERSION_4) || (IpIo->IpVersion == IP_VERSION_6)); - - IpInfo = AllocatePool (sizeof (IP_IO_IP_INFO)); - if (IpInfo == NULL) { - return NULL; - } - - // - // Init this IpInfo, set the Addr and SubnetMask to 0 before we configure the IP - // instance. - // - InitializeListHead (&IpInfo->Entry); - IpInfo->ChildHandle = NULL; - ZeroMem (&IpInfo->Addr, sizeof (IpInfo->Addr)); - ZeroMem (&IpInfo->PreMask, sizeof (IpInfo->PreMask)); - - IpInfo->RefCnt = 1; - IpInfo->IpVersion = IpIo->IpVersion; - - // - // Create the IP instance and open the IP protocol. - // - Status = IpIoCreateIpChildOpenProtocol ( - IpIo->Controller, - IpIo->Image, - &IpInfo->ChildHandle, - IpInfo->IpVersion, - (VOID **) &IpInfo->Ip - ); - if (EFI_ERROR (Status)) { - goto ReleaseIpInfo; - } - - // - // Create the event for the DummyRcvToken. - // - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, - IpIoDummyHandler, - IpInfo, - &Event - ); - if (EFI_ERROR (Status)) { - goto ReleaseIpChild; - } - - if (IpInfo->IpVersion == IP_VERSION_4) { - IpInfo->DummyRcvToken.Ip4Token.Event = Event; - } else { - IpInfo->DummyRcvToken.Ip6Token.Event = Event; - } - - // - // Link this IpInfo into the IpIo. - // - InsertTailList (&IpIo->IpList, &IpInfo->Entry); - - return IpInfo; - -ReleaseIpChild: - - IpIoCloseProtocolDestroyIpChild ( - IpIo->Controller, - IpIo->Image, - IpInfo->ChildHandle, - IpInfo->IpVersion - ); - -ReleaseIpInfo: - - gBS->FreePool (IpInfo); - - return NULL; -} - - -/** - Configure the IP instance of this IpInfo and start the receiving if IpConfigData - is not NULL. - - If IpInfo is NULL, then ASSERT(). - If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT(). - - @param[in, out] IpInfo Pointer to the IP_IO_IP_INFO instance. - @param[in, out] IpConfigData The IP configure data used to configure the IP - instance, if NULL the IP instance is reset. If - UseDefaultAddress is set to TRUE, and the configure - operation succeeds, the default address information - is written back in this IpConfigData. - - @retval EFI_SUCCESS The IP instance of this IpInfo is configured successfully - or no need to reconfigure it. - @retval Others Configuration fails. - -**/ -EFI_STATUS -EFIAPI -IpIoConfigIp ( - IN OUT IP_IO_IP_INFO *IpInfo, - IN OUT VOID *IpConfigData OPTIONAL - ) -{ - EFI_STATUS Status; - IP_IO_IP_PROTOCOL Ip; - UINT8 IpVersion; - EFI_IP4_MODE_DATA Ip4ModeData; - EFI_IP6_MODE_DATA Ip6ModeData; - - ASSERT (IpInfo != NULL); - - if (IpInfo->RefCnt > 1) { - // - // This IP instance is shared, don't reconfigure it until it has only one - // consumer. Currently, only the tcp children cloned from their passive parent - // will share the same IP. So this cases only happens while IpConfigData is NULL, - // let the last consumer clean the IP instance. - // - return EFI_SUCCESS; - } - - IpVersion = IpInfo->IpVersion; - ASSERT ((IpVersion == IP_VERSION_4) || (IpVersion == IP_VERSION_6)); - - Ip = IpInfo->Ip; - - if (IpInfo->IpVersion == IP_VERSION_4) { - Status = Ip.Ip4->Configure (Ip.Ip4, IpConfigData); - } else { - Status = Ip.Ip6->Configure (Ip.Ip6, IpConfigData); - } - - if (EFI_ERROR (Status)) { - return Status; - } - - if (IpConfigData != NULL) { - if (IpInfo->IpVersion == IP_VERSION_4) { - - if (((EFI_IP4_CONFIG_DATA *) IpConfigData)->UseDefaultAddress) { - Status = Ip.Ip4->GetModeData ( - Ip.Ip4, - &Ip4ModeData, - NULL, - NULL - ); - if (EFI_ERROR (Status)) { - Ip.Ip4->Configure (Ip.Ip4, NULL); - return Status; - } - - IP4_COPY_ADDRESS (&((EFI_IP4_CONFIG_DATA*) IpConfigData)->StationAddress, &Ip4ModeData.ConfigData.StationAddress); - IP4_COPY_ADDRESS (&((EFI_IP4_CONFIG_DATA*) IpConfigData)->SubnetMask, &Ip4ModeData.ConfigData.SubnetMask); - } - - CopyMem ( - &IpInfo->Addr.Addr, - &((EFI_IP4_CONFIG_DATA *) IpConfigData)->StationAddress, - sizeof (IP4_ADDR) - ); - CopyMem ( - &IpInfo->PreMask.SubnetMask, - &((EFI_IP4_CONFIG_DATA *) IpConfigData)->SubnetMask, - sizeof (IP4_ADDR) - ); - - Status = Ip.Ip4->Receive ( - Ip.Ip4, - &IpInfo->DummyRcvToken.Ip4Token - ); - if (EFI_ERROR (Status)) { - Ip.Ip4->Configure (Ip.Ip4, NULL); - } - } else { - Status = Ip.Ip6->GetModeData ( - Ip.Ip6, - &Ip6ModeData, - NULL, - NULL - ); - if (EFI_ERROR (Status)) { - Ip.Ip6->Configure (Ip.Ip6, NULL); - return Status; - } - - if (Ip6ModeData.IsConfigured) { - CopyMem ( - &((EFI_IP6_CONFIG_DATA *) IpConfigData)->StationAddress, - &Ip6ModeData.ConfigData.StationAddress, - sizeof (EFI_IPv6_ADDRESS) - ); - - if (Ip6ModeData.AddressList != NULL) { - FreePool (Ip6ModeData.AddressList); - } - - if (Ip6ModeData.GroupTable != NULL) { - FreePool (Ip6ModeData.GroupTable); - } - - if (Ip6ModeData.RouteTable != NULL) { - FreePool (Ip6ModeData.RouteTable); - } - - if (Ip6ModeData.NeighborCache != NULL) { - FreePool (Ip6ModeData.NeighborCache); - } - - if (Ip6ModeData.PrefixTable != NULL) { - FreePool (Ip6ModeData.PrefixTable); - } - - if (Ip6ModeData.IcmpTypeList != NULL) { - FreePool (Ip6ModeData.IcmpTypeList); - } - - } else { - Status = EFI_NO_MAPPING; - return Status; - } - - CopyMem ( - &IpInfo->Addr, - &Ip6ModeData.ConfigData.StationAddress, - sizeof (EFI_IPv6_ADDRESS) - ); - - Status = Ip.Ip6->Receive ( - Ip.Ip6, - &IpInfo->DummyRcvToken.Ip6Token - ); - if (EFI_ERROR (Status)) { - Ip.Ip6->Configure (Ip.Ip6, NULL); - } - } - } else { - // - // The IP instance is reset, set the stored Addr and SubnetMask to zero. - // - ZeroMem (&IpInfo->Addr, sizeof (IpInfo->Addr)); - ZeroMem (&IpInfo->PreMask, sizeof (IpInfo->PreMask)); - } - - return Status; -} - - -/** - Destroy an IP instance maintained in IpIo->IpList for - sending purpose. - - If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT(). - - This function pairs with IpIoAddIp(). The IpInfo is previously created by - IpIoAddIp(). The IP_IO_IP_INFO::RefCnt is decremented and the IP instance - will be dstroyed if the RefCnt is zero. - - @param[in] IpIo Pointer to the IP_IO instance. - @param[in] IpInfo Pointer to the IpInfo to be removed. - -**/ -VOID -EFIAPI -IpIoRemoveIp ( - IN IP_IO *IpIo, - IN IP_IO_IP_INFO *IpInfo - ) -{ - - UINT8 IpVersion; - - if (IpIo == NULL || IpInfo == NULL) { - return; - } - - ASSERT (IpInfo->RefCnt > 0); - - NET_PUT_REF (IpInfo); - - if (IpInfo->RefCnt > 0) { - - return; - } - - IpVersion = IpIo->IpVersion; - - ASSERT ((IpVersion == IP_VERSION_4) || (IpVersion == IP_VERSION_6)); - - RemoveEntryList (&IpInfo->Entry); - - if (IpVersion == IP_VERSION_4){ - IpInfo->Ip.Ip4->Configure ( - IpInfo->Ip.Ip4, - NULL - ); - IpIoCloseProtocolDestroyIpChild ( - IpIo->Controller, - IpIo->Image, - IpInfo->ChildHandle, - IP_VERSION_4 - ); - - gBS->CloseEvent (IpInfo->DummyRcvToken.Ip4Token.Event); - - } else { - - IpInfo->Ip.Ip6->Configure ( - IpInfo->Ip.Ip6, - NULL - ); - - IpIoCloseProtocolDestroyIpChild ( - IpIo->Controller, - IpIo->Image, - IpInfo->ChildHandle, - IP_VERSION_6 - ); - - gBS->CloseEvent (IpInfo->DummyRcvToken.Ip6Token.Event); - } - - FreePool (IpInfo); -} - - -/** - Find the first IP protocol maintained in IpIo whose local - address is the same as Src. - - This function is called when the caller needs the IpIo to send data to the - specified Src. The IpIo was added previously by IpIoAddIp(). - - @param[in, out] IpIo Pointer to the pointer of the IP_IO instance. - @param[in] IpVersion The version of the IP protocol to use, either - IPv4 or IPv6. - @param[in] Src The local IP address. - - @return Pointer to the IP protocol can be used for sending purpose and its local - address is the same with Src. NULL if failed. - -**/ -IP_IO_IP_INFO * -EFIAPI -IpIoFindSender ( - IN OUT IP_IO **IpIo, - IN UINT8 IpVersion, - IN EFI_IP_ADDRESS *Src - ) -{ - LIST_ENTRY *IpIoEntry; - IP_IO *IpIoPtr; - LIST_ENTRY *IpInfoEntry; - IP_IO_IP_INFO *IpInfo; - - if (IpIo == NULL || Src == NULL) { - return NULL; - } - - if ((IpVersion != IP_VERSION_4) && (IpVersion != IP_VERSION_6)) { - return NULL; - } - - NET_LIST_FOR_EACH (IpIoEntry, &mActiveIpIoList) { - IpIoPtr = NET_LIST_USER_STRUCT (IpIoEntry, IP_IO, Entry); - - if (((*IpIo != NULL) && (*IpIo != IpIoPtr)) || (IpIoPtr->IpVersion != IpVersion)) { - continue; - } - - NET_LIST_FOR_EACH (IpInfoEntry, &IpIoPtr->IpList) { - IpInfo = NET_LIST_USER_STRUCT (IpInfoEntry, IP_IO_IP_INFO, Entry); - if (IpInfo->IpVersion == IP_VERSION_4){ - - if (EFI_IP4_EQUAL (&IpInfo->Addr.v4, &Src->v4)) { - *IpIo = IpIoPtr; - return IpInfo; - } - - } else { - - if (EFI_IP6_EQUAL (&IpInfo->Addr.v6, &Src->v6)) { - *IpIo = IpIoPtr; - return IpInfo; - } - } - } - } - - // - // No match. - // - return NULL; -} - - -/** - Get the ICMP error map information. - - The ErrorStatus will be returned. The IsHard and Notify are optional. If they - are not NULL, this routine will fill them. - - @param[in] IcmpError IcmpError Type. - @param[in] IpVersion The version of the IP protocol to use, - either IPv4 or IPv6. - @param[out] IsHard If TRUE, indicates that it is a hard error. - @param[out] Notify If TRUE, SockError needs to be notified. - - @retval EFI_UNSUPPORTED Unrecognizable ICMP error code. - @return ICMP Error Status, such as EFI_NETWORK_UNREACHABLE. - -**/ -EFI_STATUS -EFIAPI -IpIoGetIcmpErrStatus ( - IN UINT8 IcmpError, - IN UINT8 IpVersion, - OUT BOOLEAN *IsHard OPTIONAL, - OUT BOOLEAN *Notify OPTIONAL - ) -{ - if (IpVersion == IP_VERSION_4 ) { - ASSERT (IcmpError <= ICMP_ERR_PARAMPROB); - - if (IsHard != NULL) { - *IsHard = mIcmpErrMap[IcmpError].IsHard; - } - - if (Notify != NULL) { - *Notify = mIcmpErrMap[IcmpError].Notify; - } - - switch (IcmpError) { - case ICMP_ERR_UNREACH_NET: - return EFI_NETWORK_UNREACHABLE; - - case ICMP_ERR_TIMXCEED_INTRANS: - case ICMP_ERR_TIMXCEED_REASS: - case ICMP_ERR_UNREACH_HOST: - return EFI_HOST_UNREACHABLE; - - case ICMP_ERR_UNREACH_PROTOCOL: - return EFI_PROTOCOL_UNREACHABLE; - - case ICMP_ERR_UNREACH_PORT: - return EFI_PORT_UNREACHABLE; - - case ICMP_ERR_MSGSIZE: - case ICMP_ERR_UNREACH_SRCFAIL: - case ICMP_ERR_QUENCH: - case ICMP_ERR_PARAMPROB: - return EFI_ICMP_ERROR; - - default: - ASSERT (FALSE); - return EFI_UNSUPPORTED; - } - - } else if (IpVersion == IP_VERSION_6) { - - ASSERT (IcmpError <= ICMP6_ERR_PARAMPROB_IPV6OPTION); - - if (IsHard != NULL) { - *IsHard = mIcmp6ErrMap[IcmpError].IsHard; - } - - if (Notify != NULL) { - *Notify = mIcmp6ErrMap[IcmpError].Notify; - } - - switch (IcmpError) { - case ICMP6_ERR_UNREACH_NET: - return EFI_NETWORK_UNREACHABLE; - - case ICMP6_ERR_UNREACH_HOST: - case ICMP6_ERR_TIMXCEED_HOPLIMIT: - case ICMP6_ERR_TIMXCEED_REASS: - return EFI_HOST_UNREACHABLE; - - case ICMP6_ERR_UNREACH_PROTOCOL: - return EFI_PROTOCOL_UNREACHABLE; - - case ICMP6_ERR_UNREACH_PORT: - return EFI_PORT_UNREACHABLE; - - case ICMP6_ERR_PACKAGE_TOOBIG: - case ICMP6_ERR_PARAMPROB_HEADER: - case ICMP6_ERR_PARAMPROB_NEXHEADER: - case ICMP6_ERR_PARAMPROB_IPV6OPTION: - return EFI_ICMP_ERROR; - - default: - ASSERT (FALSE); - return EFI_UNSUPPORTED; - } - - } else { - // - // Should never be here - // - ASSERT (FALSE); - return EFI_UNSUPPORTED; - } -} - - -/** - Refresh the remote peer's Neighbor Cache entries. - - This function is called when the caller needs the IpIo to refresh the existing - IPv6 neighbor cache entries since the neighbor is considered reachable by the - node has recently received a confirmation that packets sent recently to the - neighbor were received by its IP layer. - - @param[in] IpIo Pointer to an IP_IO instance - @param[in] Neighbor The IP address of the neighbor - @param[in] Timeout Time in 100-ns units that this entry will - remain in the neighbor cache. A value of - zero means that the entry is permanent. - A value of non-zero means that the entry is - dynamic and will be deleted after Timeout. - - @retval EFI_SUCCESS The operation is completed successfully. - @retval EFI_NOT_STARTED The IpIo is not configured. - @retval EFI_INVALID_PARAMETER Neighbor Address is invalid. - @retval EFI_NOT_FOUND The neighbor cache entry is not in the - neighbor table. - @retval EFI_UNSUPPORTED IP version is IPv4, which doesn't support neighbor cache refresh. - @retval EFI_OUT_OF_RESOURCES Failed due to resource limit. - -**/ -EFI_STATUS -EFIAPI -IpIoRefreshNeighbor ( - IN IP_IO *IpIo, - IN EFI_IP_ADDRESS *Neighbor, - IN UINT32 Timeout - ) -{ - EFI_IP6_PROTOCOL *Ip; - - if (!IpIo->IsConfigured) { - return EFI_NOT_STARTED; - } - - if (IpIo->IpVersion != IP_VERSION_6) { - return EFI_UNSUPPORTED; - } - - Ip = IpIo->Ip.Ip6; - - return Ip->Neighbors (Ip, FALSE, &Neighbor->v6, NULL, Timeout, TRUE); -} - diff --git a/MdeModulePkg/Library/DxeIpIoLib/DxeIpIoLib.inf b/MdeModulePkg/Library/DxeIpIoLib/DxeIpIoLib.inf deleted file mode 100644 index a789d80de6..0000000000 --- a/MdeModulePkg/Library/DxeIpIoLib/DxeIpIoLib.inf +++ /dev/null @@ -1,46 +0,0 @@ -## @file -# This library instance provides IP services upon EFI IPv4/IPv6 Protocols. -# -# Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-# SPDX-License-Identifier: BSD-2-Clause-Patent -# -## - - -[Defines] - INF_VERSION = 0x00010005 - BASE_NAME = DxeIpIoLib - MODULE_UNI_FILE = DxeIpIoLib.uni - FILE_GUID = A302F877-8625-425c-B1EC-7487B62C4FDA - MODULE_TYPE = DXE_DRIVER - VERSION_STRING = 1.0 - LIBRARY_CLASS = IpIoLib|DXE_CORE DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER - -# -# The following information is for reference only and not required by the build tools. -# -# VALID_ARCHITECTURES = IA32 X64 EBC -# - -[Sources] - DxeIpIoLib.c - -[Packages] - MdePkg/MdePkg.dec - MdeModulePkg/MdeModulePkg.dec - - -[LibraryClasses] - BaseLib - DebugLib - UefiBootServicesTableLib - MemoryAllocationLib - BaseMemoryLib - DpcLib - -[Protocols] - gEfiIp4ProtocolGuid ## SOMETIMES_CONSUMES - gEfiIp4ServiceBindingProtocolGuid ## SOMETIMES_CONSUMES - gEfiIp6ProtocolGuid ## SOMETIMES_CONSUMES - gEfiIp6ServiceBindingProtocolGuid ## SOMETIMES_CONSUMES - diff --git a/MdeModulePkg/Library/DxeIpIoLib/DxeIpIoLib.uni b/MdeModulePkg/Library/DxeIpIoLib/DxeIpIoLib.uni deleted file mode 100644 index 4af043cfe9..0000000000 --- a/MdeModulePkg/Library/DxeIpIoLib/DxeIpIoLib.uni +++ /dev/null @@ -1,16 +0,0 @@ -// /** @file -// This library instance provides IP services upon EFI IPv4/IPv6 Protocols. -// -// This library instance provides IP services upon EFI IPv4/IPv6 Protocols. -// -// Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-// -// SPDX-License-Identifier: BSD-2-Clause-Patent -// -// **/ - - -#string STR_MODULE_ABSTRACT #language en-US "EFI IPv4/IPv6 IP Services Library" - -#string STR_MODULE_DESCRIPTION #language en-US "This library instance provides IP services upon EFI IPv4/IPv6 Protocols." - diff --git a/MdeModulePkg/Library/DxeNetLib/DxeNetLib.c b/MdeModulePkg/Library/DxeNetLib/DxeNetLib.c deleted file mode 100644 index 8e2f720666..0000000000 --- a/MdeModulePkg/Library/DxeNetLib/DxeNetLib.c +++ /dev/null @@ -1,3394 +0,0 @@ -/** @file - Network library. - -Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
-(C) Copyright 2015 Hewlett Packard Enterprise Development LP
-SPDX-License-Identifier: BSD-2-Clause-Patent -**/ - -#include - -#include - -#include -#include -#include -#include -#include -#include -#include -#include - -#include - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - -#define NIC_ITEM_CONFIG_SIZE (sizeof (NIC_IP4_CONFIG_INFO) + sizeof (EFI_IP4_ROUTE_TABLE) * MAX_IP4_CONFIG_IN_VARIABLE) -#define DEFAULT_ZERO_START ((UINTN) ~0) - -// -// All the supported IP4 maskes in host byte order. -// -GLOBAL_REMOVE_IF_UNREFERENCED IP4_ADDR gIp4AllMasks[IP4_MASK_NUM] = { - 0x00000000, - 0x80000000, - 0xC0000000, - 0xE0000000, - 0xF0000000, - 0xF8000000, - 0xFC000000, - 0xFE000000, - - 0xFF000000, - 0xFF800000, - 0xFFC00000, - 0xFFE00000, - 0xFFF00000, - 0xFFF80000, - 0xFFFC0000, - 0xFFFE0000, - - 0xFFFF0000, - 0xFFFF8000, - 0xFFFFC000, - 0xFFFFE000, - 0xFFFFF000, - 0xFFFFF800, - 0xFFFFFC00, - 0xFFFFFE00, - - 0xFFFFFF00, - 0xFFFFFF80, - 0xFFFFFFC0, - 0xFFFFFFE0, - 0xFFFFFFF0, - 0xFFFFFFF8, - 0xFFFFFFFC, - 0xFFFFFFFE, - 0xFFFFFFFF, -}; - -GLOBAL_REMOVE_IF_UNREFERENCED EFI_IPv4_ADDRESS mZeroIp4Addr = {{0, 0, 0, 0}}; - -// -// Any error level digitally larger than mNetDebugLevelMax -// will be silently discarded. -// -GLOBAL_REMOVE_IF_UNREFERENCED UINTN mNetDebugLevelMax = NETDEBUG_LEVEL_ERROR; -GLOBAL_REMOVE_IF_UNREFERENCED UINT32 mSyslogPacketSeq = 0xDEADBEEF; - -// -// You can change mSyslogDstMac mSyslogDstIp and mSyslogSrcIp -// here to direct the syslog packets to the syslog deamon. The -// default is broadcast to both the ethernet and IP. -// -GLOBAL_REMOVE_IF_UNREFERENCED UINT8 mSyslogDstMac[NET_ETHER_ADDR_LEN] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff}; -GLOBAL_REMOVE_IF_UNREFERENCED UINT32 mSyslogDstIp = 0xffffffff; -GLOBAL_REMOVE_IF_UNREFERENCED UINT32 mSyslogSrcIp = 0; - -GLOBAL_REMOVE_IF_UNREFERENCED CHAR8 *mMonthName[] = { - "Jan", - "Feb", - "Mar", - "Apr", - "May", - "Jun", - "Jul", - "Aug", - "Sep", - "Oct", - "Nov", - "Dec" -}; - -// -// VLAN device path node template -// -GLOBAL_REMOVE_IF_UNREFERENCED VLAN_DEVICE_PATH mNetVlanDevicePathTemplate = { - { - MESSAGING_DEVICE_PATH, - MSG_VLAN_DP, - { - (UINT8) (sizeof (VLAN_DEVICE_PATH)), - (UINT8) ((sizeof (VLAN_DEVICE_PATH)) >> 8) - } - }, - 0 -}; - -/** - Locate the handles that support SNP, then open one of them - to send the syslog packets. The caller isn't required to close - the SNP after use because the SNP is opened by HandleProtocol. - - @return The point to SNP if one is properly openned. Otherwise NULL - -**/ -EFI_SIMPLE_NETWORK_PROTOCOL * -SyslogLocateSnp ( - VOID - ) -{ - EFI_SIMPLE_NETWORK_PROTOCOL *Snp; - EFI_STATUS Status; - EFI_HANDLE *Handles; - UINTN HandleCount; - UINTN Index; - - // - // Locate the handles which has SNP installed. - // - Handles = NULL; - Status = gBS->LocateHandleBuffer ( - ByProtocol, - &gEfiSimpleNetworkProtocolGuid, - NULL, - &HandleCount, - &Handles - ); - - if (EFI_ERROR (Status) || (HandleCount == 0)) { - return NULL; - } - - // - // Try to open one of the ethernet SNP protocol to send packet - // - Snp = NULL; - - for (Index = 0; Index < HandleCount; Index++) { - Status = gBS->HandleProtocol ( - Handles[Index], - &gEfiSimpleNetworkProtocolGuid, - (VOID **) &Snp - ); - - if ((Status == EFI_SUCCESS) && (Snp != NULL) && - (Snp->Mode->IfType == NET_IFTYPE_ETHERNET) && - (Snp->Mode->MaxPacketSize >= NET_SYSLOG_PACKET_LEN)) { - - break; - } - - Snp = NULL; - } - - FreePool (Handles); - return Snp; -} - -/** - Transmit a syslog packet synchronously through SNP. The Packet - already has the ethernet header prepended. This function should - fill in the source MAC because it will try to locate a SNP each - time it is called to avoid the problem if SNP is unloaded. - This code snip is copied from MNP. - If Packet is NULL, then ASSERT(). - - @param[in] Packet The Syslog packet - @param[in] Length The length of the packet - - @retval EFI_DEVICE_ERROR Failed to locate a usable SNP protocol - @retval EFI_TIMEOUT Timeout happened to send the packet. - @retval EFI_SUCCESS Packet is sent. - -**/ -EFI_STATUS -SyslogSendPacket ( - IN CHAR8 *Packet, - IN UINT32 Length - ) -{ - EFI_SIMPLE_NETWORK_PROTOCOL *Snp; - ETHER_HEAD *Ether; - EFI_STATUS Status; - EFI_EVENT TimeoutEvent; - UINT8 *TxBuf; - - ASSERT (Packet != NULL); - - Snp = SyslogLocateSnp (); - - if (Snp == NULL) { - return EFI_DEVICE_ERROR; - } - - Ether = (ETHER_HEAD *) Packet; - CopyMem (Ether->SrcMac, Snp->Mode->CurrentAddress.Addr, NET_ETHER_ADDR_LEN); - - // - // Start the timeout event. - // - Status = gBS->CreateEvent ( - EVT_TIMER, - TPL_NOTIFY, - NULL, - NULL, - &TimeoutEvent - ); - - if (EFI_ERROR (Status)) { - return Status; - } - - Status = gBS->SetTimer (TimeoutEvent, TimerRelative, NET_SYSLOG_TX_TIMEOUT); - - if (EFI_ERROR (Status)) { - goto ON_EXIT; - } - - for (;;) { - // - // Transmit the packet through SNP. - // - Status = Snp->Transmit (Snp, 0, Length, Packet, NULL, NULL, NULL); - - if ((Status != EFI_SUCCESS) && (Status != EFI_NOT_READY)) { - Status = EFI_DEVICE_ERROR; - break; - } - - // - // If Status is EFI_SUCCESS, the packet is put in the transmit queue. - // if Status is EFI_NOT_READY, the transmit engine of the network - // interface is busy. Both need to sync SNP. - // - TxBuf = NULL; - - do { - // - // Get the recycled transmit buffer status. - // - Snp->GetStatus (Snp, NULL, (VOID **) &TxBuf); - - if (!EFI_ERROR (gBS->CheckEvent (TimeoutEvent))) { - Status = EFI_TIMEOUT; - break; - } - - } while (TxBuf == NULL); - - if ((Status == EFI_SUCCESS) || (Status == EFI_TIMEOUT)) { - break; - } - - // - // Status is EFI_NOT_READY. Restart the timer event and - // call Snp->Transmit again. - // - gBS->SetTimer (TimeoutEvent, TimerRelative, NET_SYSLOG_TX_TIMEOUT); - } - - gBS->SetTimer (TimeoutEvent, TimerCancel, 0); - -ON_EXIT: - gBS->CloseEvent (TimeoutEvent); - return Status; -} - -/** - Build a syslog packet, including the Ethernet/Ip/Udp headers - and user's message. - - @param[in] Level Syslog severity level - @param[in] Module The module that generates the log - @param[in] File The file that contains the current log - @param[in] Line The line of code in the File that contains the current log - @param[in] Message The log message - @param[in] BufLen The lenght of the Buf - @param[out] Buf The buffer to put the packet data - - @return The length of the syslog packet built, 0 represents no packet is built. - -**/ -UINT32 -SyslogBuildPacket ( - IN UINT32 Level, - IN UINT8 *Module, - IN UINT8 *File, - IN UINT32 Line, - IN UINT8 *Message, - IN UINT32 BufLen, - OUT CHAR8 *Buf - ) -{ - EFI_STATUS Status; - ETHER_HEAD *Ether; - IP4_HEAD *Ip4; - EFI_UDP_HEADER *Udp4; - EFI_TIME Time; - UINT32 Pri; - UINT32 Len; - - // - // Fill in the Ethernet header. Leave alone the source MAC. - // SyslogSendPacket will fill in the address for us. - // - Ether = (ETHER_HEAD *) Buf; - CopyMem (Ether->DstMac, mSyslogDstMac, NET_ETHER_ADDR_LEN); - ZeroMem (Ether->SrcMac, NET_ETHER_ADDR_LEN); - - Ether->EtherType = HTONS (0x0800); // IPv4 protocol - - Buf += sizeof (ETHER_HEAD); - BufLen -= sizeof (ETHER_HEAD); - - // - // Fill in the IP header - // - Ip4 = (IP4_HEAD *) Buf; - Ip4->HeadLen = 5; - Ip4->Ver = 4; - Ip4->Tos = 0; - Ip4->TotalLen = 0; - Ip4->Id = (UINT16) mSyslogPacketSeq; - Ip4->Fragment = 0; - Ip4->Ttl = 16; - Ip4->Protocol = 0x11; - Ip4->Checksum = 0; - Ip4->Src = mSyslogSrcIp; - Ip4->Dst = mSyslogDstIp; - - Buf += sizeof (IP4_HEAD); - BufLen -= sizeof (IP4_HEAD); - - // - // Fill in the UDP header, Udp checksum is optional. Leave it zero. - // - Udp4 = (EFI_UDP_HEADER *) Buf; - Udp4->SrcPort = HTONS (514); - Udp4->DstPort = HTONS (514); - Udp4->Length = 0; - Udp4->Checksum = 0; - - Buf += sizeof (EFI_UDP_HEADER); - BufLen -= sizeof (EFI_UDP_HEADER); - - // - // Build the syslog message body with Timestamp machine module Message - // - Pri = ((NET_SYSLOG_FACILITY & 31) << 3) | (Level & 7); - Status = gRT->GetTime (&Time, NULL); - if (EFI_ERROR (Status)) { - return 0; - } - - // - // Use %a to format the ASCII strings, %s to format UNICODE strings - // - Len = 0; - Len += (UINT32) AsciiSPrint ( - Buf, - BufLen, - "<%d> %a %d %d:%d:%d ", - Pri, - mMonthName [Time.Month-1], - Time.Day, - Time.Hour, - Time.Minute, - Time.Second - ); - - Len += (UINT32) AsciiSPrint ( - Buf + Len, - BufLen - Len, - "Tiano %a: %a (Line: %d File: %a)", - Module, - Message, - Line, - File - ); - Len ++; - - // - // OK, patch the IP length/checksum and UDP length fields. - // - Len += sizeof (EFI_UDP_HEADER); - Udp4->Length = HTONS ((UINT16) Len); - - Len += sizeof (IP4_HEAD); - Ip4->TotalLen = HTONS ((UINT16) Len); - Ip4->Checksum = (UINT16) (~NetblockChecksum ((UINT8 *) Ip4, sizeof (IP4_HEAD))); - - return Len + sizeof (ETHER_HEAD); -} - -/** - Allocate a buffer, then format the message to it. This is a - help function for the NET_DEBUG_XXX macros. The PrintArg of - these macros treats the variable length print parameters as a - single parameter, and pass it to the NetDebugASPrint. For - example, NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name)) - if extracted to: - - NetDebugOutput ( - NETDEBUG_LEVEL_TRACE, - "Tcp", - __FILE__, - __LINE__, - NetDebugASPrint ("State transit to %a\n", Name) - ) - - If Format is NULL, then ASSERT(). - - @param Format The ASCII format string. - @param ... The variable length parameter whose format is determined - by the Format string. - - @return The buffer containing the formatted message, - or NULL if failed to allocate memory. - -**/ -CHAR8 * -EFIAPI -NetDebugASPrint ( - IN CHAR8 *Format, - ... - ) -{ - VA_LIST Marker; - CHAR8 *Buf; - - ASSERT (Format != NULL); - - Buf = (CHAR8 *) AllocatePool (NET_DEBUG_MSG_LEN); - - if (Buf == NULL) { - return NULL; - } - - VA_START (Marker, Format); - AsciiVSPrint (Buf, NET_DEBUG_MSG_LEN, Format, Marker); - VA_END (Marker); - - return Buf; -} - -/** - Builds an UDP4 syslog packet and send it using SNP. - - This function will locate a instance of SNP then send the message through it. - Because it isn't open the SNP BY_DRIVER, apply caution when using it. - - @param Level The severity level of the message. - @param Module The Moudle that generates the log. - @param File The file that contains the log. - @param Line The exact line that contains the log. - @param Message The user message to log. - - @retval EFI_INVALID_PARAMETER Any input parameter is invalid. - @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the packet. - @retval EFI_DEVICE_ERROR Device error occurs. - @retval EFI_SUCCESS The log is discard because that it is more verbose - than the mNetDebugLevelMax. Or, it has been sent out. -**/ -EFI_STATUS -EFIAPI -NetDebugOutput ( - IN UINT32 Level, - IN UINT8 *Module, - IN UINT8 *File, - IN UINT32 Line, - IN UINT8 *Message - ) -{ - CHAR8 *Packet; - UINT32 Len; - EFI_STATUS Status; - - // - // Check whether the message should be sent out - // - if (Message == NULL || File == NULL || Module == NULL) { - return EFI_INVALID_PARAMETER; - } - - if (Level > mNetDebugLevelMax) { - Status = EFI_SUCCESS; - goto ON_EXIT; - } - - // - // Allocate a maxium of 1024 bytes, the caller should ensure - // that the message plus the ethernet/ip/udp header is shorter - // than this - // - Packet = (CHAR8 *) AllocatePool (NET_SYSLOG_PACKET_LEN); - - if (Packet == NULL) { - Status = EFI_OUT_OF_RESOURCES; - goto ON_EXIT; - } - - // - // Build the message: Ethernet header + IP header + Udp Header + user data - // - Len = SyslogBuildPacket ( - Level, - Module, - File, - Line, - Message, - NET_SYSLOG_PACKET_LEN, - Packet - ); - if (Len == 0) { - Status = EFI_DEVICE_ERROR; - } else { - mSyslogPacketSeq++; - Status = SyslogSendPacket (Packet, Len); - } - - FreePool (Packet); - -ON_EXIT: - FreePool (Message); - return Status; -} -/** - Return the length of the mask. - - Return the length of the mask, the correct value is from 0 to 32. - If the mask is invalid, return the invalid length 33, which is IP4_MASK_NUM. - NetMask is in the host byte order. - - @param[in] NetMask The netmask to get the length from. - - @return The length of the netmask, IP4_MASK_NUM if the mask is invalid. - -**/ -INTN -EFIAPI -NetGetMaskLength ( - IN IP4_ADDR NetMask - ) -{ - INTN Index; - - for (Index = 0; Index <= IP4_MASK_MAX; Index++) { - if (NetMask == gIp4AllMasks[Index]) { - break; - } - } - - return Index; -} - - - -/** - Return the class of the IP address, such as class A, B, C. - Addr is in host byte order. - - [ATTENTION] - Classful addressing (IP class A/B/C) has been deprecated according to RFC4632. - Caller of this function could only check the returned value against - IP4_ADDR_CLASSD (multicast) or IP4_ADDR_CLASSE (reserved) now. - - The address of class A starts with 0. - If the address belong to class A, return IP4_ADDR_CLASSA. - The address of class B starts with 10. - If the address belong to class B, return IP4_ADDR_CLASSB. - The address of class C starts with 110. - If the address belong to class C, return IP4_ADDR_CLASSC. - The address of class D starts with 1110. - If the address belong to class D, return IP4_ADDR_CLASSD. - The address of class E starts with 1111. - If the address belong to class E, return IP4_ADDR_CLASSE. - - - @param[in] Addr The address to get the class from. - - @return IP address class, such as IP4_ADDR_CLASSA. - -**/ -INTN -EFIAPI -NetGetIpClass ( - IN IP4_ADDR Addr - ) -{ - UINT8 ByteOne; - - ByteOne = (UINT8) (Addr >> 24); - - if ((ByteOne & 0x80) == 0) { - return IP4_ADDR_CLASSA; - - } else if ((ByteOne & 0xC0) == 0x80) { - return IP4_ADDR_CLASSB; - - } else if ((ByteOne & 0xE0) == 0xC0) { - return IP4_ADDR_CLASSC; - - } else if ((ByteOne & 0xF0) == 0xE0) { - return IP4_ADDR_CLASSD; - - } else { - return IP4_ADDR_CLASSE; - - } -} - - -/** - Check whether the IP is a valid unicast address according to - the netmask. - - ASSERT if NetMask is zero. - - If all bits of the host address of IP are 0 or 1, IP is also not a valid unicast address, - except when the originator is one of the endpoints of a point-to-point link with a 31-bit - mask (RFC3021), or a 32bit NetMask (all 0xFF) is used for special network environment (e.g. - PPP link). - - @param[in] Ip The IP to check against. - @param[in] NetMask The mask of the IP. - - @return TRUE if IP is a valid unicast address on the network, otherwise FALSE. - -**/ -BOOLEAN -EFIAPI -NetIp4IsUnicast ( - IN IP4_ADDR Ip, - IN IP4_ADDR NetMask - ) -{ - INTN MaskLength; - - ASSERT (NetMask != 0); - - if (Ip == 0 || IP4_IS_LOCAL_BROADCAST (Ip)) { - return FALSE; - } - - MaskLength = NetGetMaskLength (NetMask); - ASSERT ((MaskLength >= 0) && (MaskLength <= IP4_MASK_NUM)); - if (MaskLength < 31) { - if (((Ip &~NetMask) == ~NetMask) || ((Ip &~NetMask) == 0)) { - return FALSE; - } - } - - return TRUE; -} - -/** - Check whether the incoming IPv6 address is a valid unicast address. - - ASSERT if Ip6 is NULL. - - If the address is a multicast address has binary 0xFF at the start, it is not - a valid unicast address. If the address is unspecified ::, it is not a valid - unicast address to be assigned to any node. If the address is loopback address - ::1, it is also not a valid unicast address to be assigned to any physical - interface. - - @param[in] Ip6 The IPv6 address to check against. - - @return TRUE if Ip6 is a valid unicast address on the network, otherwise FALSE. - -**/ -BOOLEAN -EFIAPI -NetIp6IsValidUnicast ( - IN EFI_IPv6_ADDRESS *Ip6 - ) -{ - UINT8 Byte; - UINT8 Index; - - ASSERT (Ip6 != NULL); - - if (Ip6->Addr[0] == 0xFF) { - return FALSE; - } - - for (Index = 0; Index < 15; Index++) { - if (Ip6->Addr[Index] != 0) { - return TRUE; - } - } - - Byte = Ip6->Addr[Index]; - - if (Byte == 0x0 || Byte == 0x1) { - return FALSE; - } - - return TRUE; -} - -/** - Check whether the incoming Ipv6 address is the unspecified address or not. - - ASSERT if Ip6 is NULL. - - @param[in] Ip6 - Ip6 address, in network order. - - @retval TRUE - Yes, unspecified - @retval FALSE - No - -**/ -BOOLEAN -EFIAPI -NetIp6IsUnspecifiedAddr ( - IN EFI_IPv6_ADDRESS *Ip6 - ) -{ - UINT8 Index; - - ASSERT (Ip6 != NULL); - - for (Index = 0; Index < 16; Index++) { - if (Ip6->Addr[Index] != 0) { - return FALSE; - } - } - - return TRUE; -} - -/** - Check whether the incoming Ipv6 address is a link-local address. - - ASSERT if Ip6 is NULL. - - @param[in] Ip6 - Ip6 address, in network order. - - @retval TRUE - Yes, link-local address - @retval FALSE - No - -**/ -BOOLEAN -EFIAPI -NetIp6IsLinkLocalAddr ( - IN EFI_IPv6_ADDRESS *Ip6 - ) -{ - UINT8 Index; - - ASSERT (Ip6 != NULL); - - if (Ip6->Addr[0] != 0xFE) { - return FALSE; - } - - if (Ip6->Addr[1] != 0x80) { - return FALSE; - } - - for (Index = 2; Index < 8; Index++) { - if (Ip6->Addr[Index] != 0) { - return FALSE; - } - } - - return TRUE; -} - -/** - Check whether the Ipv6 address1 and address2 are on the connected network. - - ASSERT if Ip1 or Ip2 is NULL. - ASSERT if PrefixLength exceeds or equals to IP6_PREFIX_MAX. - - @param[in] Ip1 - Ip6 address1, in network order. - @param[in] Ip2 - Ip6 address2, in network order. - @param[in] PrefixLength - The prefix length of the checking net. - - @retval TRUE - Yes, connected. - @retval FALSE - No. - -**/ -BOOLEAN -EFIAPI -NetIp6IsNetEqual ( - EFI_IPv6_ADDRESS *Ip1, - EFI_IPv6_ADDRESS *Ip2, - UINT8 PrefixLength - ) -{ - UINT8 Byte; - UINT8 Bit; - UINT8 Mask; - - ASSERT ((Ip1 != NULL) && (Ip2 != NULL) && (PrefixLength < IP6_PREFIX_MAX)); - - if (PrefixLength == 0) { - return TRUE; - } - - Byte = (UINT8) (PrefixLength / 8); - Bit = (UINT8) (PrefixLength % 8); - - if (CompareMem (Ip1, Ip2, Byte) != 0) { - return FALSE; - } - - if (Bit > 0) { - Mask = (UINT8) (0xFF << (8 - Bit)); - - ASSERT (Byte < 16); - if (Byte >= 16) { - return FALSE; - } - if ((Ip1->Addr[Byte] & Mask) != (Ip2->Addr[Byte] & Mask)) { - return FALSE; - } - } - - return TRUE; -} - - -/** - Switches the endianess of an IPv6 address - - ASSERT if Ip6 is NULL. - - This function swaps the bytes in a 128-bit IPv6 address to switch the value - from little endian to big endian or vice versa. The byte swapped value is - returned. - - @param Ip6 Points to an IPv6 address - - @return The byte swapped IPv6 address. - -**/ -EFI_IPv6_ADDRESS * -EFIAPI -Ip6Swap128 ( - EFI_IPv6_ADDRESS *Ip6 - ) -{ - UINT64 High; - UINT64 Low; - - ASSERT (Ip6 != NULL); - - CopyMem (&High, Ip6, sizeof (UINT64)); - CopyMem (&Low, &Ip6->Addr[8], sizeof (UINT64)); - - High = SwapBytes64 (High); - Low = SwapBytes64 (Low); - - CopyMem (Ip6, &Low, sizeof (UINT64)); - CopyMem (&Ip6->Addr[8], &High, sizeof (UINT64)); - - return Ip6; -} - -/** - Initialize a random seed using current time and monotonic count. - - Get current time and monotonic count first. Then initialize a random seed - based on some basic mathematics operation on the hour, day, minute, second, - nanosecond and year of the current time and the monotonic count value. - - @return The random seed initialized with current time. - -**/ -UINT32 -EFIAPI -NetRandomInitSeed ( - VOID - ) -{ - EFI_TIME Time; - UINT32 Seed; - UINT64 MonotonicCount; - - gRT->GetTime (&Time, NULL); - Seed = (Time.Hour << 24 | Time.Day << 16 | Time.Minute << 8 | Time.Second); - Seed ^= Time.Nanosecond; - Seed ^= Time.Year << 7; - - gBS->GetNextMonotonicCount (&MonotonicCount); - Seed += (UINT32) MonotonicCount; - - return Seed; -} - - -/** - Extract a UINT32 from a byte stream. - - ASSERT if Buf is NULL. - - Copy a UINT32 from a byte stream, then converts it from Network - byte order to host byte order. Use this function to avoid alignment error. - - @param[in] Buf The buffer to extract the UINT32. - - @return The UINT32 extracted. - -**/ -UINT32 -EFIAPI -NetGetUint32 ( - IN UINT8 *Buf - ) -{ - UINT32 Value; - - ASSERT (Buf != NULL); - - CopyMem (&Value, Buf, sizeof (UINT32)); - return NTOHL (Value); -} - - -/** - Put a UINT32 to the byte stream in network byte order. - - ASSERT if Buf is NULL. - - Converts a UINT32 from host byte order to network byte order. Then copy it to the - byte stream. - - @param[in, out] Buf The buffer to put the UINT32. - @param[in] Data The data to be converted and put into the byte stream. - -**/ -VOID -EFIAPI -NetPutUint32 ( - IN OUT UINT8 *Buf, - IN UINT32 Data - ) -{ - ASSERT (Buf != NULL); - - Data = HTONL (Data); - CopyMem (Buf, &Data, sizeof (UINT32)); -} - - -/** - Remove the first node entry on the list, and return the removed node entry. - - Removes the first node Entry from a doubly linked list. It is up to the caller of - this function to release the memory used by the first node if that is required. On - exit, the removed node is returned. - - If Head is NULL, then ASSERT(). - If Head was not initialized, then ASSERT(). - If PcdMaximumLinkedListLength is not zero, and the number of nodes in the - linked list including the head node is greater than or equal to PcdMaximumLinkedListLength, - then ASSERT(). - - @param[in, out] Head The list header. - - @return The first node entry that is removed from the list, NULL if the list is empty. - -**/ -LIST_ENTRY * -EFIAPI -NetListRemoveHead ( - IN OUT LIST_ENTRY *Head - ) -{ - LIST_ENTRY *First; - - ASSERT (Head != NULL); - - if (IsListEmpty (Head)) { - return NULL; - } - - First = Head->ForwardLink; - Head->ForwardLink = First->ForwardLink; - First->ForwardLink->BackLink = Head; - - DEBUG_CODE ( - First->ForwardLink = (LIST_ENTRY *) NULL; - First->BackLink = (LIST_ENTRY *) NULL; - ); - - return First; -} - - -/** - Remove the last node entry on the list and and return the removed node entry. - - Removes the last node entry from a doubly linked list. It is up to the caller of - this function to release the memory used by the first node if that is required. On - exit, the removed node is returned. - - If Head is NULL, then ASSERT(). - If Head was not initialized, then ASSERT(). - If PcdMaximumLinkedListLength is not zero, and the number of nodes in the - linked list including the head node is greater than or equal to PcdMaximumLinkedListLength, - then ASSERT(). - - @param[in, out] Head The list head. - - @return The last node entry that is removed from the list, NULL if the list is empty. - -**/ -LIST_ENTRY * -EFIAPI -NetListRemoveTail ( - IN OUT LIST_ENTRY *Head - ) -{ - LIST_ENTRY *Last; - - ASSERT (Head != NULL); - - if (IsListEmpty (Head)) { - return NULL; - } - - Last = Head->BackLink; - Head->BackLink = Last->BackLink; - Last->BackLink->ForwardLink = Head; - - DEBUG_CODE ( - Last->ForwardLink = (LIST_ENTRY *) NULL; - Last->BackLink = (LIST_ENTRY *) NULL; - ); - - return Last; -} - - -/** - Insert a new node entry after a designated node entry of a doubly linked list. - - ASSERT if PrevEntry or NewEntry is NULL. - - Inserts a new node entry donated by NewEntry after the node entry donated by PrevEntry - of the doubly linked list. - - @param[in, out] PrevEntry The previous entry to insert after. - @param[in, out] NewEntry The new entry to insert. - -**/ -VOID -EFIAPI -NetListInsertAfter ( - IN OUT LIST_ENTRY *PrevEntry, - IN OUT LIST_ENTRY *NewEntry - ) -{ - ASSERT (PrevEntry != NULL && NewEntry != NULL); - - NewEntry->BackLink = PrevEntry; - NewEntry->ForwardLink = PrevEntry->ForwardLink; - PrevEntry->ForwardLink->BackLink = NewEntry; - PrevEntry->ForwardLink = NewEntry; -} - - -/** - Insert a new node entry before a designated node entry of a doubly linked list. - - ASSERT if PostEntry or NewEntry is NULL. - - Inserts a new node entry donated by NewEntry after the node entry donated by PostEntry - of the doubly linked list. - - @param[in, out] PostEntry The entry to insert before. - @param[in, out] NewEntry The new entry to insert. - -**/ -VOID -EFIAPI -NetListInsertBefore ( - IN OUT LIST_ENTRY *PostEntry, - IN OUT LIST_ENTRY *NewEntry - ) -{ - ASSERT (PostEntry != NULL && NewEntry != NULL); - - NewEntry->ForwardLink = PostEntry; - NewEntry->BackLink = PostEntry->BackLink; - PostEntry->BackLink->ForwardLink = NewEntry; - PostEntry->BackLink = NewEntry; -} - -/** - Safe destroy nodes in a linked list, and return the length of the list after all possible operations finished. - - Destroy network child instance list by list traversals is not safe due to graph dependencies between nodes. - This function performs a safe traversal to destroy these nodes by checking to see if the node being destroyed - has been removed from the list or not. - If it has been removed, then restart the traversal from the head. - If it hasn't been removed, then continue with the next node directly. - This function will end the iterate and return the CallBack's last return value if error happens, - or retrun EFI_SUCCESS if 2 complete passes are made with no changes in the number of children in the list. - - @param[in] List The head of the list. - @param[in] CallBack Pointer to the callback function to destroy one node in the list. - @param[in] Context Pointer to the callback function's context: corresponds to the - parameter Context in NET_DESTROY_LINK_LIST_CALLBACK. - @param[out] ListLength The length of the link list if the function returns successfully. - - @retval EFI_SUCCESS Two complete passes are made with no changes in the number of children. - @retval EFI_INVALID_PARAMETER The input parameter is invalid. - @retval Others Return the CallBack's last return value. - -**/ -EFI_STATUS -EFIAPI -NetDestroyLinkList ( - IN LIST_ENTRY *List, - IN NET_DESTROY_LINK_LIST_CALLBACK CallBack, - IN VOID *Context, OPTIONAL - OUT UINTN *ListLength OPTIONAL - ) -{ - UINTN PreviousLength; - LIST_ENTRY *Entry; - LIST_ENTRY *Ptr; - UINTN Length; - EFI_STATUS Status; - - if (List == NULL || CallBack == NULL) { - return EFI_INVALID_PARAMETER; - } - - Length = 0; - do { - PreviousLength = Length; - Entry = GetFirstNode (List); - while (!IsNull (List, Entry)) { - Status = CallBack (Entry, Context); - if (EFI_ERROR (Status)) { - return Status; - } - // - // Walk through the list to see whether the Entry has been removed or not. - // If the Entry still exists, just try to destroy the next one. - // If not, go back to the start point to iterate the list again. - // - for (Ptr = List->ForwardLink; Ptr != List; Ptr = Ptr->ForwardLink) { - if (Ptr == Entry) { - break; - } - } - if (Ptr == Entry) { - Entry = GetNextNode (List, Entry); - } else { - Entry = GetFirstNode (List); - } - } - for (Length = 0, Ptr = List->ForwardLink; Ptr != List; Length++, Ptr = Ptr->ForwardLink); - } while (Length != PreviousLength); - - if (ListLength != NULL) { - *ListLength = Length; - } - return EFI_SUCCESS; -} - -/** - This function checks the input Handle to see if it's one of these handles in ChildHandleBuffer. - - @param[in] Handle Handle to be checked. - @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. - @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL - if NumberOfChildren is 0. - - @retval TRUE Found the input Handle in ChildHandleBuffer. - @retval FALSE Can't find the input Handle in ChildHandleBuffer. - -**/ -BOOLEAN -EFIAPI -NetIsInHandleBuffer ( - IN EFI_HANDLE Handle, - IN UINTN NumberOfChildren, - IN EFI_HANDLE *ChildHandleBuffer OPTIONAL - ) -{ - UINTN Index; - - if (NumberOfChildren == 0 || ChildHandleBuffer == NULL) { - return FALSE; - } - - for (Index = 0; Index < NumberOfChildren; Index++) { - if (Handle == ChildHandleBuffer[Index]) { - return TRUE; - } - } - - return FALSE; -} - - -/** - Initialize the netmap. Netmap is a reposity to keep the pairs. - - Initialize the forward and backward links of two head nodes donated by Map->Used - and Map->Recycled of two doubly linked lists. - Initializes the count of the pairs in the netmap to zero. - - If Map is NULL, then ASSERT(). - If the address of Map->Used is NULL, then ASSERT(). - If the address of Map->Recycled is NULl, then ASSERT(). - - @param[in, out] Map The netmap to initialize. - -**/ -VOID -EFIAPI -NetMapInit ( - IN OUT NET_MAP *Map - ) -{ - ASSERT (Map != NULL); - - InitializeListHead (&Map->Used); - InitializeListHead (&Map->Recycled); - Map->Count = 0; -} - - -/** - To clean up the netmap, that is, release allocated memories. - - Removes all nodes of the Used doubly linked list and free memory of all related netmap items. - Removes all nodes of the Recycled doubly linked list and free memory of all related netmap items. - The number of the pairs in the netmap is set to be zero. - - If Map is NULL, then ASSERT(). - - @param[in, out] Map The netmap to clean up. - -**/ -VOID -EFIAPI -NetMapClean ( - IN OUT NET_MAP *Map - ) -{ - NET_MAP_ITEM *Item; - LIST_ENTRY *Entry; - LIST_ENTRY *Next; - - ASSERT (Map != NULL); - - NET_LIST_FOR_EACH_SAFE (Entry, Next, &Map->Used) { - Item = NET_LIST_USER_STRUCT (Entry, NET_MAP_ITEM, Link); - - RemoveEntryList (&Item->Link); - Map->Count--; - - gBS->FreePool (Item); - } - - ASSERT ((Map->Count == 0) && IsListEmpty (&Map->Used)); - - NET_LIST_FOR_EACH_SAFE (Entry, Next, &Map->Recycled) { - Item = NET_LIST_USER_STRUCT (Entry, NET_MAP_ITEM, Link); - - RemoveEntryList (&Item->Link); - gBS->FreePool (Item); - } - - ASSERT (IsListEmpty (&Map->Recycled)); -} - - -/** - Test whether the netmap is empty and return true if it is. - - If the number of the pairs in the netmap is zero, return TRUE. - - If Map is NULL, then ASSERT(). - - @param[in] Map The net map to test. - - @return TRUE if the netmap is empty, otherwise FALSE. - -**/ -BOOLEAN -EFIAPI -NetMapIsEmpty ( - IN NET_MAP *Map - ) -{ - ASSERT (Map != NULL); - return (BOOLEAN) (Map->Count == 0); -} - - -/** - Return the number of the pairs in the netmap. - - If Map is NULL, then ASSERT(). - - @param[in] Map The netmap to get the entry number. - - @return The entry number in the netmap. - -**/ -UINTN -EFIAPI -NetMapGetCount ( - IN NET_MAP *Map - ) -{ - ASSERT (Map != NULL); - return Map->Count; -} - - -/** - Return one allocated item. - - If the Recycled doubly linked list of the netmap is empty, it will try to allocate - a batch of items if there are enough resources and add corresponding nodes to the begining - of the Recycled doubly linked list of the netmap. Otherwise, it will directly remove - the fist node entry of the Recycled doubly linked list and return the corresponding item. - - If Map is NULL, then ASSERT(). - - @param[in, out] Map The netmap to allocate item for. - - @return The allocated item. If NULL, the - allocation failed due to resource limit. - -**/ -NET_MAP_ITEM * -NetMapAllocItem ( - IN OUT NET_MAP *Map - ) -{ - NET_MAP_ITEM *Item; - LIST_ENTRY *Head; - UINTN Index; - - ASSERT (Map != NULL); - - Head = &Map->Recycled; - - if (IsListEmpty (Head)) { - for (Index = 0; Index < NET_MAP_INCREAMENT; Index++) { - Item = AllocatePool (sizeof (NET_MAP_ITEM)); - - if (Item == NULL) { - if (Index == 0) { - return NULL; - } - - break; - } - - InsertHeadList (Head, &Item->Link); - } - } - - Item = NET_LIST_HEAD (Head, NET_MAP_ITEM, Link); - NetListRemoveHead (Head); - - return Item; -} - - -/** - Allocate an item to save the pair to the head of the netmap. - - Allocate an item to save the pair and add corresponding node entry - to the beginning of the Used doubly linked list. The number of the - pairs in the netmap increase by 1. - - If Map is NULL, then ASSERT(). - If Key is NULL, then ASSERT(). - - @param[in, out] Map The netmap to insert into. - @param[in] Key The user's key. - @param[in] Value The user's value for the key. - - @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item. - @retval EFI_SUCCESS The item is inserted to the head. - -**/ -EFI_STATUS -EFIAPI -NetMapInsertHead ( - IN OUT NET_MAP *Map, - IN VOID *Key, - IN VOID *Value OPTIONAL - ) -{ - NET_MAP_ITEM *Item; - - ASSERT (Map != NULL && Key != NULL); - - Item = NetMapAllocItem (Map); - - if (Item == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - Item->Key = Key; - Item->Value = Value; - InsertHeadList (&Map->Used, &Item->Link); - - Map->Count++; - return EFI_SUCCESS; -} - - -/** - Allocate an item to save the pair to the tail of the netmap. - - Allocate an item to save the pair and add corresponding node entry - to the tail of the Used doubly linked list. The number of the - pairs in the netmap increase by 1. - - If Map is NULL, then ASSERT(). - If Key is NULL, then ASSERT(). - - @param[in, out] Map The netmap to insert into. - @param[in] Key The user's key. - @param[in] Value The user's value for the key. - - @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item. - @retval EFI_SUCCESS The item is inserted to the tail. - -**/ -EFI_STATUS -EFIAPI -NetMapInsertTail ( - IN OUT NET_MAP *Map, - IN VOID *Key, - IN VOID *Value OPTIONAL - ) -{ - NET_MAP_ITEM *Item; - - ASSERT (Map != NULL && Key != NULL); - - Item = NetMapAllocItem (Map); - - if (Item == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - Item->Key = Key; - Item->Value = Value; - InsertTailList (&Map->Used, &Item->Link); - - Map->Count++; - - return EFI_SUCCESS; -} - - -/** - Check whether the item is in the Map and return TRUE if it is. - - If Map is NULL, then ASSERT(). - If Item is NULL, then ASSERT(). - - @param[in] Map The netmap to search within. - @param[in] Item The item to search. - - @return TRUE if the item is in the netmap, otherwise FALSE. - -**/ -BOOLEAN -NetItemInMap ( - IN NET_MAP *Map, - IN NET_MAP_ITEM *Item - ) -{ - LIST_ENTRY *ListEntry; - - ASSERT (Map != NULL && Item != NULL); - - NET_LIST_FOR_EACH (ListEntry, &Map->Used) { - if (ListEntry == &Item->Link) { - return TRUE; - } - } - - return FALSE; -} - - -/** - Find the key in the netmap and returns the point to the item contains the Key. - - Iterate the Used doubly linked list of the netmap to get every item. Compare the key of every - item with the key to search. It returns the point to the item contains the Key if found. - - If Map is NULL, then ASSERT(). - If Key is NULL, then ASSERT(). - - @param[in] Map The netmap to search within. - @param[in] Key The key to search. - - @return The point to the item contains the Key, or NULL if Key isn't in the map. - -**/ -NET_MAP_ITEM * -EFIAPI -NetMapFindKey ( - IN NET_MAP *Map, - IN VOID *Key - ) -{ - LIST_ENTRY *Entry; - NET_MAP_ITEM *Item; - - ASSERT (Map != NULL && Key != NULL); - - NET_LIST_FOR_EACH (Entry, &Map->Used) { - Item = NET_LIST_USER_STRUCT (Entry, NET_MAP_ITEM, Link); - - if (Item->Key == Key) { - return Item; - } - } - - return NULL; -} - - -/** - Remove the node entry of the item from the netmap and return the key of the removed item. - - Remove the node entry of the item from the Used doubly linked list of the netmap. - The number of the pairs in the netmap decrease by 1. Then add the node - entry of the item to the Recycled doubly linked list of the netmap. If Value is not NULL, - Value will point to the value of the item. It returns the key of the removed item. - - If Map is NULL, then ASSERT(). - If Item is NULL, then ASSERT(). - if item in not in the netmap, then ASSERT(). - - @param[in, out] Map The netmap to remove the item from. - @param[in, out] Item The item to remove. - @param[out] Value The variable to receive the value if not NULL. - - @return The key of the removed item. - -**/ -VOID * -EFIAPI -NetMapRemoveItem ( - IN OUT NET_MAP *Map, - IN OUT NET_MAP_ITEM *Item, - OUT VOID **Value OPTIONAL - ) -{ - ASSERT ((Map != NULL) && (Item != NULL)); - ASSERT (NetItemInMap (Map, Item)); - - RemoveEntryList (&Item->Link); - Map->Count--; - InsertHeadList (&Map->Recycled, &Item->Link); - - if (Value != NULL) { - *Value = Item->Value; - } - - return Item->Key; -} - - -/** - Remove the first node entry on the netmap and return the key of the removed item. - - Remove the first node entry from the Used doubly linked list of the netmap. - The number of the pairs in the netmap decrease by 1. Then add the node - entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL, - parameter Value will point to the value of the item. It returns the key of the removed item. - - If Map is NULL, then ASSERT(). - If the Used doubly linked list is empty, then ASSERT(). - - @param[in, out] Map The netmap to remove the head from. - @param[out] Value The variable to receive the value if not NULL. - - @return The key of the item removed. - -**/ -VOID * -EFIAPI -NetMapRemoveHead ( - IN OUT NET_MAP *Map, - OUT VOID **Value OPTIONAL - ) -{ - NET_MAP_ITEM *Item; - - // - // Often, it indicates a programming error to remove - // the first entry in an empty list - // - ASSERT (Map && !IsListEmpty (&Map->Used)); - - Item = NET_LIST_HEAD (&Map->Used, NET_MAP_ITEM, Link); - RemoveEntryList (&Item->Link); - Map->Count--; - InsertHeadList (&Map->Recycled, &Item->Link); - - if (Value != NULL) { - *Value = Item->Value; - } - - return Item->Key; -} - - -/** - Remove the last node entry on the netmap and return the key of the removed item. - - Remove the last node entry from the Used doubly linked list of the netmap. - The number of the pairs in the netmap decrease by 1. Then add the node - entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL, - parameter Value will point to the value of the item. It returns the key of the removed item. - - If Map is NULL, then ASSERT(). - If the Used doubly linked list is empty, then ASSERT(). - - @param[in, out] Map The netmap to remove the tail from. - @param[out] Value The variable to receive the value if not NULL. - - @return The key of the item removed. - -**/ -VOID * -EFIAPI -NetMapRemoveTail ( - IN OUT NET_MAP *Map, - OUT VOID **Value OPTIONAL - ) -{ - NET_MAP_ITEM *Item; - - // - // Often, it indicates a programming error to remove - // the last entry in an empty list - // - ASSERT (Map && !IsListEmpty (&Map->Used)); - - Item = NET_LIST_TAIL (&Map->Used, NET_MAP_ITEM, Link); - RemoveEntryList (&Item->Link); - Map->Count--; - InsertHeadList (&Map->Recycled, &Item->Link); - - if (Value != NULL) { - *Value = Item->Value; - } - - return Item->Key; -} - - -/** - Iterate through the netmap and call CallBack for each item. - - It will continue the traverse if CallBack returns EFI_SUCCESS, otherwise, break - from the loop. It returns the CallBack's last return value. This function is - delete safe for the current item. - - If Map is NULL, then ASSERT(). - If CallBack is NULL, then ASSERT(). - - @param[in] Map The Map to iterate through. - @param[in] CallBack The callback function to call for each item. - @param[in] Arg The opaque parameter to the callback. - - @retval EFI_SUCCESS There is no item in the netmap or CallBack for each item - return EFI_SUCCESS. - @retval Others It returns the CallBack's last return value. - -**/ -EFI_STATUS -EFIAPI -NetMapIterate ( - IN NET_MAP *Map, - IN NET_MAP_CALLBACK CallBack, - IN VOID *Arg OPTIONAL - ) -{ - - LIST_ENTRY *Entry; - LIST_ENTRY *Next; - LIST_ENTRY *Head; - NET_MAP_ITEM *Item; - EFI_STATUS Result; - - ASSERT ((Map != NULL) && (CallBack != NULL)); - - Head = &Map->Used; - - if (IsListEmpty (Head)) { - return EFI_SUCCESS; - } - - NET_LIST_FOR_EACH_SAFE (Entry, Next, Head) { - Item = NET_LIST_USER_STRUCT (Entry, NET_MAP_ITEM, Link); - Result = CallBack (Map, Item, Arg); - - if (EFI_ERROR (Result)) { - return Result; - } - } - - return EFI_SUCCESS; -} - - -/** - This is the default unload handle for all the network drivers. - - Disconnect the driver specified by ImageHandle from all the devices in the handle database. - Uninstall all the protocols installed in the driver entry point. - - @param[in] ImageHandle The drivers' driver image. - - @retval EFI_SUCCESS The image is unloaded. - @retval Others Failed to unload the image. - -**/ -EFI_STATUS -EFIAPI -NetLibDefaultUnload ( - IN EFI_HANDLE ImageHandle - ) -{ - EFI_STATUS Status; - EFI_HANDLE *DeviceHandleBuffer; - UINTN DeviceHandleCount; - UINTN Index; - UINTN Index2; - EFI_DRIVER_BINDING_PROTOCOL *DriverBinding; - EFI_COMPONENT_NAME_PROTOCOL *ComponentName; - EFI_COMPONENT_NAME2_PROTOCOL *ComponentName2; - - // - // Get the list of all the handles in the handle database. - // If there is an error getting the list, then the unload - // operation fails. - // - Status = gBS->LocateHandleBuffer ( - AllHandles, - NULL, - NULL, - &DeviceHandleCount, - &DeviceHandleBuffer - ); - - if (EFI_ERROR (Status)) { - return Status; - } - - for (Index = 0; Index < DeviceHandleCount; Index++) { - Status = gBS->HandleProtocol ( - DeviceHandleBuffer[Index], - &gEfiDriverBindingProtocolGuid, - (VOID **) &DriverBinding - ); - if (EFI_ERROR (Status)) { - continue; - } - - if (DriverBinding->ImageHandle != ImageHandle) { - continue; - } - - // - // Disconnect the driver specified by ImageHandle from all - // the devices in the handle database. - // - for (Index2 = 0; Index2 < DeviceHandleCount; Index2++) { - Status = gBS->DisconnectController ( - DeviceHandleBuffer[Index2], - DriverBinding->DriverBindingHandle, - NULL - ); - } - - // - // Uninstall all the protocols installed in the driver entry point - // - gBS->UninstallProtocolInterface ( - DriverBinding->DriverBindingHandle, - &gEfiDriverBindingProtocolGuid, - DriverBinding - ); - - Status = gBS->HandleProtocol ( - DeviceHandleBuffer[Index], - &gEfiComponentNameProtocolGuid, - (VOID **) &ComponentName - ); - if (!EFI_ERROR (Status)) { - gBS->UninstallProtocolInterface ( - DriverBinding->DriverBindingHandle, - &gEfiComponentNameProtocolGuid, - ComponentName - ); - } - - Status = gBS->HandleProtocol ( - DeviceHandleBuffer[Index], - &gEfiComponentName2ProtocolGuid, - (VOID **) &ComponentName2 - ); - if (!EFI_ERROR (Status)) { - gBS->UninstallProtocolInterface ( - DriverBinding->DriverBindingHandle, - &gEfiComponentName2ProtocolGuid, - ComponentName2 - ); - } - } - - // - // Free the buffer containing the list of handles from the handle database - // - if (DeviceHandleBuffer != NULL) { - gBS->FreePool (DeviceHandleBuffer); - } - - return EFI_SUCCESS; -} - - - -/** - Create a child of the service that is identified by ServiceBindingGuid. - - Get the ServiceBinding Protocol first, then use it to create a child. - - If ServiceBindingGuid is NULL, then ASSERT(). - If ChildHandle is NULL, then ASSERT(). - - @param[in] Controller The controller which has the service installed. - @param[in] Image The image handle used to open service. - @param[in] ServiceBindingGuid The service's Guid. - @param[in, out] ChildHandle The handle to receive the create child. - - @retval EFI_SUCCESS The child is successfully created. - @retval Others Failed to create the child. - -**/ -EFI_STATUS -EFIAPI -NetLibCreateServiceChild ( - IN EFI_HANDLE Controller, - IN EFI_HANDLE Image, - IN EFI_GUID *ServiceBindingGuid, - IN OUT EFI_HANDLE *ChildHandle - ) -{ - EFI_STATUS Status; - EFI_SERVICE_BINDING_PROTOCOL *Service; - - - ASSERT ((ServiceBindingGuid != NULL) && (ChildHandle != NULL)); - - // - // Get the ServiceBinding Protocol - // - Status = gBS->OpenProtocol ( - Controller, - ServiceBindingGuid, - (VOID **) &Service, - Image, - Controller, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Create a child - // - Status = Service->CreateChild (Service, ChildHandle); - return Status; -} - - -/** - Destroy a child of the service that is identified by ServiceBindingGuid. - - Get the ServiceBinding Protocol first, then use it to destroy a child. - - If ServiceBindingGuid is NULL, then ASSERT(). - - @param[in] Controller The controller which has the service installed. - @param[in] Image The image handle used to open service. - @param[in] ServiceBindingGuid The service's Guid. - @param[in] ChildHandle The child to destroy. - - @retval EFI_SUCCESS The child is successfully destroyed. - @retval Others Failed to destroy the child. - -**/ -EFI_STATUS -EFIAPI -NetLibDestroyServiceChild ( - IN EFI_HANDLE Controller, - IN EFI_HANDLE Image, - IN EFI_GUID *ServiceBindingGuid, - IN EFI_HANDLE ChildHandle - ) -{ - EFI_STATUS Status; - EFI_SERVICE_BINDING_PROTOCOL *Service; - - ASSERT (ServiceBindingGuid != NULL); - - // - // Get the ServiceBinding Protocol - // - Status = gBS->OpenProtocol ( - Controller, - ServiceBindingGuid, - (VOID **) &Service, - Image, - Controller, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - - if (EFI_ERROR (Status)) { - return Status; - } - - // - // destroy the child - // - Status = Service->DestroyChild (Service, ChildHandle); - return Status; -} - -/** - Get handle with Simple Network Protocol installed on it. - - There should be MNP Service Binding Protocol installed on the input ServiceHandle. - If Simple Network Protocol is already installed on the ServiceHandle, the - ServiceHandle will be returned. If SNP is not installed on the ServiceHandle, - try to find its parent handle with SNP installed. - - @param[in] ServiceHandle The handle where network service binding protocols are - installed on. - @param[out] Snp The pointer to store the address of the SNP instance. - This is an optional parameter that may be NULL. - - @return The SNP handle, or NULL if not found. - -**/ -EFI_HANDLE -EFIAPI -NetLibGetSnpHandle ( - IN EFI_HANDLE ServiceHandle, - OUT EFI_SIMPLE_NETWORK_PROTOCOL **Snp OPTIONAL - ) -{ - EFI_STATUS Status; - EFI_SIMPLE_NETWORK_PROTOCOL *SnpInstance; - EFI_DEVICE_PATH_PROTOCOL *DevicePath; - EFI_HANDLE SnpHandle; - - // - // Try to open SNP from ServiceHandle - // - SnpInstance = NULL; - Status = gBS->HandleProtocol (ServiceHandle, &gEfiSimpleNetworkProtocolGuid, (VOID **) &SnpInstance); - if (!EFI_ERROR (Status)) { - if (Snp != NULL) { - *Snp = SnpInstance; - } - return ServiceHandle; - } - - // - // Failed to open SNP, try to get SNP handle by LocateDevicePath() - // - DevicePath = DevicePathFromHandle (ServiceHandle); - if (DevicePath == NULL) { - return NULL; - } - - SnpHandle = NULL; - Status = gBS->LocateDevicePath (&gEfiSimpleNetworkProtocolGuid, &DevicePath, &SnpHandle); - if (EFI_ERROR (Status)) { - // - // Failed to find SNP handle - // - return NULL; - } - - Status = gBS->HandleProtocol (SnpHandle, &gEfiSimpleNetworkProtocolGuid, (VOID **) &SnpInstance); - if (!EFI_ERROR (Status)) { - if (Snp != NULL) { - *Snp = SnpInstance; - } - return SnpHandle; - } - - return NULL; -} - -/** - Retrieve VLAN ID of a VLAN device handle. - - Search VLAN device path node in Device Path of specified ServiceHandle and - return its VLAN ID. If no VLAN device path node found, then this ServiceHandle - is not a VLAN device handle, and 0 will be returned. - - @param[in] ServiceHandle The handle where network service binding protocols are - installed on. - - @return VLAN ID of the device handle, or 0 if not a VLAN device. - -**/ -UINT16 -EFIAPI -NetLibGetVlanId ( - IN EFI_HANDLE ServiceHandle - ) -{ - EFI_DEVICE_PATH_PROTOCOL *DevicePath; - EFI_DEVICE_PATH_PROTOCOL *Node; - - DevicePath = DevicePathFromHandle (ServiceHandle); - if (DevicePath == NULL) { - return 0; - } - - Node = DevicePath; - while (!IsDevicePathEnd (Node)) { - if (Node->Type == MESSAGING_DEVICE_PATH && Node->SubType == MSG_VLAN_DP) { - return ((VLAN_DEVICE_PATH *) Node)->VlanId; - } - Node = NextDevicePathNode (Node); - } - - return 0; -} - -/** - Find VLAN device handle with specified VLAN ID. - - The VLAN child device handle is created by VLAN Config Protocol on ControllerHandle. - This function will append VLAN device path node to the parent device path, - and then use LocateDevicePath() to find the correct VLAN device handle. - - @param[in] ControllerHandle The handle where network service binding protocols are - installed on. - @param[in] VlanId The configured VLAN ID for the VLAN device. - - @return The VLAN device handle, or NULL if not found. - -**/ -EFI_HANDLE -EFIAPI -NetLibGetVlanHandle ( - IN EFI_HANDLE ControllerHandle, - IN UINT16 VlanId - ) -{ - EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath; - EFI_DEVICE_PATH_PROTOCOL *VlanDevicePath; - EFI_DEVICE_PATH_PROTOCOL *DevicePath; - VLAN_DEVICE_PATH VlanNode; - EFI_HANDLE Handle; - - ParentDevicePath = DevicePathFromHandle (ControllerHandle); - if (ParentDevicePath == NULL) { - return NULL; - } - - // - // Construct VLAN device path - // - CopyMem (&VlanNode, &mNetVlanDevicePathTemplate, sizeof (VLAN_DEVICE_PATH)); - VlanNode.VlanId = VlanId; - VlanDevicePath = AppendDevicePathNode ( - ParentDevicePath, - (EFI_DEVICE_PATH_PROTOCOL *) &VlanNode - ); - if (VlanDevicePath == NULL) { - return NULL; - } - - // - // Find VLAN device handle - // - Handle = NULL; - DevicePath = VlanDevicePath; - gBS->LocateDevicePath ( - &gEfiDevicePathProtocolGuid, - &DevicePath, - &Handle - ); - if (!IsDevicePathEnd (DevicePath)) { - // - // Device path is not exactly match - // - Handle = NULL; - } - - FreePool (VlanDevicePath); - return Handle; -} - -/** - Get MAC address associated with the network service handle. - - If MacAddress is NULL, then ASSERT(). - If AddressSize is NULL, then ASSERT(). - - There should be MNP Service Binding Protocol installed on the input ServiceHandle. - If SNP is installed on the ServiceHandle or its parent handle, MAC address will - be retrieved from SNP. If no SNP found, try to get SNP mode data use MNP. - - @param[in] ServiceHandle The handle where network service binding protocols are - installed on. - @param[out] MacAddress The pointer to store the returned MAC address. - @param[out] AddressSize The length of returned MAC address. - - @retval EFI_SUCCESS MAC address is returned successfully. - @retval Others Failed to get SNP mode data. - -**/ -EFI_STATUS -EFIAPI -NetLibGetMacAddress ( - IN EFI_HANDLE ServiceHandle, - OUT EFI_MAC_ADDRESS *MacAddress, - OUT UINTN *AddressSize - ) -{ - EFI_STATUS Status; - EFI_SIMPLE_NETWORK_PROTOCOL *Snp; - EFI_SIMPLE_NETWORK_MODE *SnpMode; - EFI_SIMPLE_NETWORK_MODE SnpModeData; - EFI_MANAGED_NETWORK_PROTOCOL *Mnp; - EFI_SERVICE_BINDING_PROTOCOL *MnpSb; - EFI_HANDLE *SnpHandle; - EFI_HANDLE MnpChildHandle; - - ASSERT (MacAddress != NULL); - ASSERT (AddressSize != NULL); - - // - // Try to get SNP handle - // - Snp = NULL; - SnpHandle = NetLibGetSnpHandle (ServiceHandle, &Snp); - if (SnpHandle != NULL) { - // - // SNP found, use it directly - // - SnpMode = Snp->Mode; - } else { - // - // Failed to get SNP handle, try to get MAC address from MNP - // - MnpChildHandle = NULL; - Status = gBS->HandleProtocol ( - ServiceHandle, - &gEfiManagedNetworkServiceBindingProtocolGuid, - (VOID **) &MnpSb - ); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Create a MNP child - // - Status = MnpSb->CreateChild (MnpSb, &MnpChildHandle); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Open MNP protocol - // - Status = gBS->HandleProtocol ( - MnpChildHandle, - &gEfiManagedNetworkProtocolGuid, - (VOID **) &Mnp - ); - if (EFI_ERROR (Status)) { - MnpSb->DestroyChild (MnpSb, MnpChildHandle); - return Status; - } - - // - // Try to get SNP mode from MNP - // - Status = Mnp->GetModeData (Mnp, NULL, &SnpModeData); - if (EFI_ERROR (Status) && (Status != EFI_NOT_STARTED)) { - MnpSb->DestroyChild (MnpSb, MnpChildHandle); - return Status; - } - SnpMode = &SnpModeData; - - // - // Destroy the MNP child - // - MnpSb->DestroyChild (MnpSb, MnpChildHandle); - } - - *AddressSize = SnpMode->HwAddressSize; - CopyMem (MacAddress->Addr, SnpMode->CurrentAddress.Addr, SnpMode->HwAddressSize); - - return EFI_SUCCESS; -} - -/** - Convert MAC address of the NIC associated with specified Service Binding Handle - to a unicode string. Callers are responsible for freeing the string storage. - - If MacString is NULL, then ASSERT(). - - Locate simple network protocol associated with the Service Binding Handle and - get the mac address from SNP. Then convert the mac address into a unicode - string. It takes 2 unicode characters to represent a 1 byte binary buffer. - Plus one unicode character for the null-terminator. - - @param[in] ServiceHandle The handle where network service binding protocol is - installed on. - @param[in] ImageHandle The image handle used to act as the agent handle to - get the simple network protocol. This parameter is - optional and may be NULL. - @param[out] MacString The pointer to store the address of the string - representation of the mac address. - - @retval EFI_SUCCESS Convert the mac address a unicode string successfully. - @retval EFI_OUT_OF_RESOURCES There are not enough memory resource. - @retval Others Failed to open the simple network protocol. - -**/ -EFI_STATUS -EFIAPI -NetLibGetMacString ( - IN EFI_HANDLE ServiceHandle, - IN EFI_HANDLE ImageHandle, OPTIONAL - OUT CHAR16 **MacString - ) -{ - EFI_STATUS Status; - EFI_MAC_ADDRESS MacAddress; - UINT8 *HwAddress; - UINTN HwAddressSize; - UINT16 VlanId; - CHAR16 *String; - UINTN Index; - UINTN BufferSize; - - ASSERT (MacString != NULL); - - // - // Get MAC address of the network device - // - Status = NetLibGetMacAddress (ServiceHandle, &MacAddress, &HwAddressSize); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // It takes 2 unicode characters to represent a 1 byte binary buffer. - // If VLAN is configured, it will need extra 5 characters like "\0005". - // Plus one unicode character for the null-terminator. - // - BufferSize = (2 * HwAddressSize + 5 + 1) * sizeof (CHAR16); - String = AllocateZeroPool (BufferSize); - if (String == NULL) { - return EFI_OUT_OF_RESOURCES; - } - *MacString = String; - - // - // Convert the MAC address into a unicode string. - // - HwAddress = &MacAddress.Addr[0]; - for (Index = 0; Index < HwAddressSize; Index++) { - UnicodeValueToStringS ( - String, - BufferSize - ((UINTN)String - (UINTN)*MacString), - PREFIX_ZERO | RADIX_HEX, - *(HwAddress++), - 2 - ); - String += StrnLenS (String, (BufferSize - ((UINTN)String - (UINTN)*MacString)) / sizeof (CHAR16)); - } - - // - // Append VLAN ID if any - // - VlanId = NetLibGetVlanId (ServiceHandle); - if (VlanId != 0) { - *String++ = L'\\'; - UnicodeValueToStringS ( - String, - BufferSize - ((UINTN)String - (UINTN)*MacString), - PREFIX_ZERO | RADIX_HEX, - VlanId, - 4 - ); - String += StrnLenS (String, (BufferSize - ((UINTN)String - (UINTN)*MacString)) / sizeof (CHAR16)); - } - - // - // Null terminate the Unicode string - // - *String = L'\0'; - - return EFI_SUCCESS; -} - -/** - Detect media status for specified network device. - - If MediaPresent is NULL, then ASSERT(). - - The underlying UNDI driver may or may not support reporting media status from - GET_STATUS command (PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED). This routine - will try to invoke Snp->GetStatus() to get the media status: if media already - present, it return directly; if media not present, it will stop SNP and then - restart SNP to get the latest media status, this give chance to get the correct - media status for old UNDI driver which doesn't support reporting media status - from GET_STATUS command. - Note: there will be two limitations for current algorithm: - 1) for UNDI with this capability, in case of cable is not attached, there will - be an redundant Stop/Start() process; - 2) for UNDI without this capability, in case that network cable is attached when - Snp->Initialize() is invoked while network cable is unattached later, - NetLibDetectMedia() will report MediaPresent as TRUE, causing upper layer - apps to wait for timeout time. - - @param[in] ServiceHandle The handle where network service binding protocols are - installed on. - @param[out] MediaPresent The pointer to store the media status. - - @retval EFI_SUCCESS Media detection success. - @retval EFI_INVALID_PARAMETER ServiceHandle is not valid network device handle. - @retval EFI_UNSUPPORTED Network device does not support media detection. - @retval EFI_DEVICE_ERROR SNP is in unknown state. - -**/ -EFI_STATUS -EFIAPI -NetLibDetectMedia ( - IN EFI_HANDLE ServiceHandle, - OUT BOOLEAN *MediaPresent - ) -{ - EFI_STATUS Status; - EFI_HANDLE SnpHandle; - EFI_SIMPLE_NETWORK_PROTOCOL *Snp; - UINT32 InterruptStatus; - UINT32 OldState; - EFI_MAC_ADDRESS *MCastFilter; - UINT32 MCastFilterCount; - UINT32 EnableFilterBits; - UINT32 DisableFilterBits; - BOOLEAN ResetMCastFilters; - - ASSERT (MediaPresent != NULL); - - // - // Get SNP handle - // - Snp = NULL; - SnpHandle = NetLibGetSnpHandle (ServiceHandle, &Snp); - if (SnpHandle == NULL) { - return EFI_INVALID_PARAMETER; - } - - // - // Check whether SNP support media detection - // - if (!Snp->Mode->MediaPresentSupported) { - return EFI_UNSUPPORTED; - } - - // - // Invoke Snp->GetStatus() to refresh MediaPresent field in SNP mode data - // - Status = Snp->GetStatus (Snp, &InterruptStatus, NULL); - if (EFI_ERROR (Status)) { - return Status; - } - - if (Snp->Mode->MediaPresent) { - // - // Media is present, return directly - // - *MediaPresent = TRUE; - return EFI_SUCCESS; - } - - // - // Till now, GetStatus() report no media; while, in case UNDI not support - // reporting media status from GetStatus(), this media status may be incorrect. - // So, we will stop SNP and then restart it to get the correct media status. - // - OldState = Snp->Mode->State; - if (OldState >= EfiSimpleNetworkMaxState) { - return EFI_DEVICE_ERROR; - } - - MCastFilter = NULL; - - if (OldState == EfiSimpleNetworkInitialized) { - // - // SNP is already in use, need Shutdown/Stop and then Start/Initialize - // - - // - // Backup current SNP receive filter settings - // - EnableFilterBits = Snp->Mode->ReceiveFilterSetting; - DisableFilterBits = Snp->Mode->ReceiveFilterMask ^ EnableFilterBits; - - ResetMCastFilters = TRUE; - MCastFilterCount = Snp->Mode->MCastFilterCount; - if (MCastFilterCount != 0) { - MCastFilter = AllocateCopyPool ( - MCastFilterCount * sizeof (EFI_MAC_ADDRESS), - Snp->Mode->MCastFilter - ); - ASSERT (MCastFilter != NULL); - if (MCastFilter == NULL) { - Status = EFI_OUT_OF_RESOURCES; - goto Exit; - } - - ResetMCastFilters = FALSE; - } - - // - // Shutdown/Stop the simple network - // - Status = Snp->Shutdown (Snp); - if (!EFI_ERROR (Status)) { - Status = Snp->Stop (Snp); - } - if (EFI_ERROR (Status)) { - goto Exit; - } - - // - // Start/Initialize the simple network - // - Status = Snp->Start (Snp); - if (!EFI_ERROR (Status)) { - Status = Snp->Initialize (Snp, 0, 0); - } - if (EFI_ERROR (Status)) { - goto Exit; - } - - // - // Here we get the correct media status - // - *MediaPresent = Snp->Mode->MediaPresent; - - // - // Restore SNP receive filter settings - // - Status = Snp->ReceiveFilters ( - Snp, - EnableFilterBits, - DisableFilterBits, - ResetMCastFilters, - MCastFilterCount, - MCastFilter - ); - - if (MCastFilter != NULL) { - FreePool (MCastFilter); - } - - return Status; - } - - // - // SNP is not in use, it's in state of EfiSimpleNetworkStopped or EfiSimpleNetworkStarted - // - if (OldState == EfiSimpleNetworkStopped) { - // - // SNP not start yet, start it - // - Status = Snp->Start (Snp); - if (EFI_ERROR (Status)) { - goto Exit; - } - } - - // - // Initialize the simple network - // - Status = Snp->Initialize (Snp, 0, 0); - if (EFI_ERROR (Status)) { - Status = EFI_DEVICE_ERROR; - goto Exit; - } - - // - // Here we get the correct media status - // - *MediaPresent = Snp->Mode->MediaPresent; - - // - // Shut down the simple network - // - Snp->Shutdown (Snp); - -Exit: - if (OldState == EfiSimpleNetworkStopped) { - // - // Original SNP sate is Stopped, restore to original state - // - Snp->Stop (Snp); - } - - if (MCastFilter != NULL) { - FreePool (MCastFilter); - } - - return Status; -} - -/** - - Detect media state for a network device. This routine will wait for a period of time at - a specified checking interval when a certain network is under connecting until connection - process finishs or timeout. If Aip protocol is supported by low layer drivers, three kinds - of media states can be detected: EFI_SUCCESS, EFI_NOT_READY and EFI_NO_MEDIA, represents - connected state, connecting state and no media state respectively. When function detects - the current state is EFI_NOT_READY, it will loop to wait for next time's check until state - turns to be EFI_SUCCESS or EFI_NO_MEDIA. If Aip protocol is not supported, function will - call NetLibDetectMedia() and return state directly. - - @param[in] ServiceHandle The handle where network service binding protocols are - installed on. - @param[in] Timeout The maximum number of 100ns units to wait when network - is connecting. Zero value means detect once and return - immediately. - @param[out] MediaState The pointer to the detected media state. - - @retval EFI_SUCCESS Media detection success. - @retval EFI_INVALID_PARAMETER ServiceHandle is not a valid network device handle or - MediaState pointer is NULL. - @retval EFI_DEVICE_ERROR A device error occurred. - @retval EFI_TIMEOUT Network is connecting but timeout. - -**/ -EFI_STATUS -EFIAPI -NetLibDetectMediaWaitTimeout ( - IN EFI_HANDLE ServiceHandle, - IN UINT64 Timeout, - OUT EFI_STATUS *MediaState - ) -{ - EFI_STATUS Status; - EFI_HANDLE SnpHandle; - EFI_SIMPLE_NETWORK_PROTOCOL *Snp; - EFI_ADAPTER_INFORMATION_PROTOCOL *Aip; - EFI_ADAPTER_INFO_MEDIA_STATE *MediaInfo; - BOOLEAN MediaPresent; - UINTN DataSize; - EFI_STATUS TimerStatus; - EFI_EVENT Timer; - UINT64 TimeRemained; - - if (MediaState == NULL) { - return EFI_INVALID_PARAMETER; - } - *MediaState = EFI_SUCCESS; - MediaInfo = NULL; - - // - // Get SNP handle - // - Snp = NULL; - SnpHandle = NetLibGetSnpHandle (ServiceHandle, &Snp); - if (SnpHandle == NULL) { - return EFI_INVALID_PARAMETER; - } - - Status = gBS->HandleProtocol ( - SnpHandle, - &gEfiAdapterInformationProtocolGuid, - (VOID *) &Aip - ); - if (EFI_ERROR (Status)) { - - MediaPresent = TRUE; - Status = NetLibDetectMedia (ServiceHandle, &MediaPresent); - if (!EFI_ERROR (Status)) { - if (MediaPresent) { - *MediaState = EFI_SUCCESS; - } else { - *MediaState = EFI_NO_MEDIA; - } - } - - // - // NetLibDetectMedia doesn't support EFI_NOT_READY status, return now! - // - return Status; - } - - Status = Aip->GetInformation ( - Aip, - &gEfiAdapterInfoMediaStateGuid, - (VOID **) &MediaInfo, - &DataSize - ); - if (!EFI_ERROR (Status)) { - - *MediaState = MediaInfo->MediaState; - FreePool (MediaInfo); - if (*MediaState != EFI_NOT_READY || Timeout < MEDIA_STATE_DETECT_TIME_INTERVAL) { - - return EFI_SUCCESS; - } - } else { - - if (MediaInfo != NULL) { - FreePool (MediaInfo); - } - - if (Status == EFI_UNSUPPORTED) { - - // - // If gEfiAdapterInfoMediaStateGuid is not supported, call NetLibDetectMedia to get media state! - // - MediaPresent = TRUE; - Status = NetLibDetectMedia (ServiceHandle, &MediaPresent); - if (!EFI_ERROR (Status)) { - if (MediaPresent) { - *MediaState = EFI_SUCCESS; - } else { - *MediaState = EFI_NO_MEDIA; - } - } - return Status; - } - - return Status; - } - - // - // Loop to check media state - // - - Timer = NULL; - TimeRemained = Timeout; - Status = gBS->CreateEvent (EVT_TIMER, TPL_CALLBACK, NULL, NULL, &Timer); - if (EFI_ERROR (Status)) { - return EFI_DEVICE_ERROR; - } - - do { - Status = gBS->SetTimer ( - Timer, - TimerRelative, - MEDIA_STATE_DETECT_TIME_INTERVAL - ); - if (EFI_ERROR (Status)) { - gBS->CloseEvent(Timer); - return EFI_DEVICE_ERROR; - } - - do { - TimerStatus = gBS->CheckEvent (Timer); - if (!EFI_ERROR (TimerStatus)) { - - TimeRemained -= MEDIA_STATE_DETECT_TIME_INTERVAL; - Status = Aip->GetInformation ( - Aip, - &gEfiAdapterInfoMediaStateGuid, - (VOID **) &MediaInfo, - &DataSize - ); - if (!EFI_ERROR (Status)) { - - *MediaState = MediaInfo->MediaState; - FreePool (MediaInfo); - } else { - - if (MediaInfo != NULL) { - FreePool (MediaInfo); - } - gBS->CloseEvent(Timer); - return Status; - } - } - } while (TimerStatus == EFI_NOT_READY); - } while (*MediaState == EFI_NOT_READY && TimeRemained >= MEDIA_STATE_DETECT_TIME_INTERVAL); - - gBS->CloseEvent(Timer); - if (*MediaState == EFI_NOT_READY && TimeRemained < MEDIA_STATE_DETECT_TIME_INTERVAL) { - return EFI_TIMEOUT; - } else { - return EFI_SUCCESS; - } -} - -/** - Check the default address used by the IPv4 driver is static or dynamic (acquired - from DHCP). - - If the controller handle does not have the EFI_IP4_CONFIG2_PROTOCOL installed, the - default address is static. If failed to get the policy from Ip4 Config2 Protocol, - the default address is static. Otherwise, get the result from Ip4 Config2 Protocol. - - @param[in] Controller The controller handle which has the EFI_IP4_CONFIG2_PROTOCOL - relative with the default address to judge. - - @retval TRUE If the default address is static. - @retval FALSE If the default address is acquired from DHCP. - -**/ -BOOLEAN -NetLibDefaultAddressIsStatic ( - IN EFI_HANDLE Controller - ) -{ - EFI_STATUS Status; - EFI_IP4_CONFIG2_PROTOCOL *Ip4Config2; - UINTN DataSize; - EFI_IP4_CONFIG2_POLICY Policy; - BOOLEAN IsStatic; - - Ip4Config2 = NULL; - - DataSize = sizeof (EFI_IP4_CONFIG2_POLICY); - - IsStatic = TRUE; - - // - // Get Ip4Config2 policy. - // - Status = gBS->HandleProtocol (Controller, &gEfiIp4Config2ProtocolGuid, (VOID **) &Ip4Config2); - if (EFI_ERROR (Status)) { - goto ON_EXIT; - } - - Status = Ip4Config2->GetData (Ip4Config2, Ip4Config2DataTypePolicy, &DataSize, &Policy); - if (EFI_ERROR (Status)) { - goto ON_EXIT; - } - - IsStatic = (BOOLEAN) (Policy == Ip4Config2PolicyStatic); - -ON_EXIT: - - return IsStatic; -} - -/** - Create an IPv4 device path node. - - If Node is NULL, then ASSERT(). - - The header type of IPv4 device path node is MESSAGING_DEVICE_PATH. - The header subtype of IPv4 device path node is MSG_IPv4_DP. - Get other info from parameters to make up the whole IPv4 device path node. - - @param[in, out] Node Pointer to the IPv4 device path node. - @param[in] Controller The controller handle. - @param[in] LocalIp The local IPv4 address. - @param[in] LocalPort The local port. - @param[in] RemoteIp The remote IPv4 address. - @param[in] RemotePort The remote port. - @param[in] Protocol The protocol type in the IP header. - @param[in] UseDefaultAddress Whether this instance is using default address or not. - -**/ -VOID -EFIAPI -NetLibCreateIPv4DPathNode ( - IN OUT IPv4_DEVICE_PATH *Node, - IN EFI_HANDLE Controller, - IN IP4_ADDR LocalIp, - IN UINT16 LocalPort, - IN IP4_ADDR RemoteIp, - IN UINT16 RemotePort, - IN UINT16 Protocol, - IN BOOLEAN UseDefaultAddress - ) -{ - ASSERT (Node != NULL); - - Node->Header.Type = MESSAGING_DEVICE_PATH; - Node->Header.SubType = MSG_IPv4_DP; - SetDevicePathNodeLength (&Node->Header, sizeof (IPv4_DEVICE_PATH)); - - CopyMem (&Node->LocalIpAddress, &LocalIp, sizeof (EFI_IPv4_ADDRESS)); - CopyMem (&Node->RemoteIpAddress, &RemoteIp, sizeof (EFI_IPv4_ADDRESS)); - - Node->LocalPort = LocalPort; - Node->RemotePort = RemotePort; - - Node->Protocol = Protocol; - - if (!UseDefaultAddress) { - Node->StaticIpAddress = TRUE; - } else { - Node->StaticIpAddress = NetLibDefaultAddressIsStatic (Controller); - } - - // - // Set the Gateway IP address to default value 0:0:0:0. - // Set the Subnet mask to default value 255:255:255:0. - // - ZeroMem (&Node->GatewayIpAddress, sizeof (EFI_IPv4_ADDRESS)); - SetMem (&Node->SubnetMask, sizeof (EFI_IPv4_ADDRESS), 0xff); - Node->SubnetMask.Addr[3] = 0; -} - -/** - Create an IPv6 device path node. - - If Node is NULL, then ASSERT(). - If LocalIp is NULL, then ASSERT(). - If RemoteIp is NULL, then ASSERT(). - - The header type of IPv6 device path node is MESSAGING_DEVICE_PATH. - The header subtype of IPv6 device path node is MSG_IPv6_DP. - Get other info from parameters to make up the whole IPv6 device path node. - - @param[in, out] Node Pointer to the IPv6 device path node. - @param[in] Controller The controller handle. - @param[in] LocalIp The local IPv6 address. - @param[in] LocalPort The local port. - @param[in] RemoteIp The remote IPv6 address. - @param[in] RemotePort The remote port. - @param[in] Protocol The protocol type in the IP header. - -**/ -VOID -EFIAPI -NetLibCreateIPv6DPathNode ( - IN OUT IPv6_DEVICE_PATH *Node, - IN EFI_HANDLE Controller, - IN EFI_IPv6_ADDRESS *LocalIp, - IN UINT16 LocalPort, - IN EFI_IPv6_ADDRESS *RemoteIp, - IN UINT16 RemotePort, - IN UINT16 Protocol - ) -{ - ASSERT (Node != NULL && LocalIp != NULL && RemoteIp != NULL); - - Node->Header.Type = MESSAGING_DEVICE_PATH; - Node->Header.SubType = MSG_IPv6_DP; - SetDevicePathNodeLength (&Node->Header, sizeof (IPv6_DEVICE_PATH)); - - CopyMem (&Node->LocalIpAddress, LocalIp, sizeof (EFI_IPv6_ADDRESS)); - CopyMem (&Node->RemoteIpAddress, RemoteIp, sizeof (EFI_IPv6_ADDRESS)); - - Node->LocalPort = LocalPort; - Node->RemotePort = RemotePort; - - Node->Protocol = Protocol; - - // - // Set default value to IPAddressOrigin, PrefixLength. - // Set the Gateway IP address to unspecified address. - // - Node->IpAddressOrigin = 0; - Node->PrefixLength = IP6_PREFIX_LENGTH; - ZeroMem (&Node->GatewayIpAddress, sizeof (EFI_IPv6_ADDRESS)); -} - -/** - Find the UNDI/SNP handle from controller and protocol GUID. - - If ProtocolGuid is NULL, then ASSERT(). - - For example, IP will open a MNP child to transmit/receive - packets, when MNP is stopped, IP should also be stopped. IP - needs to find its own private data which is related the IP's - service binding instance that is install on UNDI/SNP handle. - Now, the controller is either a MNP or ARP child handle. But - IP opens these handle BY_DRIVER, use that info, we can get the - UNDI/SNP handle. - - @param[in] Controller Then protocol handle to check. - @param[in] ProtocolGuid The protocol that is related with the handle. - - @return The UNDI/SNP handle or NULL for errors. - -**/ -EFI_HANDLE -EFIAPI -NetLibGetNicHandle ( - IN EFI_HANDLE Controller, - IN EFI_GUID *ProtocolGuid - ) -{ - EFI_OPEN_PROTOCOL_INFORMATION_ENTRY *OpenBuffer; - EFI_HANDLE Handle; - EFI_STATUS Status; - UINTN OpenCount; - UINTN Index; - - ASSERT (ProtocolGuid != NULL); - - Status = gBS->OpenProtocolInformation ( - Controller, - ProtocolGuid, - &OpenBuffer, - &OpenCount - ); - - if (EFI_ERROR (Status)) { - return NULL; - } - - Handle = NULL; - - for (Index = 0; Index < OpenCount; Index++) { - if ((OpenBuffer[Index].Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) != 0) { - Handle = OpenBuffer[Index].ControllerHandle; - break; - } - } - - gBS->FreePool (OpenBuffer); - return Handle; -} - -/** - Convert one Null-terminated ASCII string (decimal dotted) to EFI_IPv4_ADDRESS. - - @param[in] String The pointer to the Ascii string. - @param[out] Ip4Address The pointer to the converted IPv4 address. - - @retval EFI_SUCCESS Convert to IPv4 address successfully. - @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip4Address is NULL. - -**/ -EFI_STATUS -EFIAPI -NetLibAsciiStrToIp4 ( - IN CONST CHAR8 *String, - OUT EFI_IPv4_ADDRESS *Ip4Address - ) -{ - RETURN_STATUS Status; - CHAR8 *EndPointer; - - Status = AsciiStrToIpv4Address (String, &EndPointer, Ip4Address, NULL); - if (RETURN_ERROR (Status) || (*EndPointer != '\0')) { - return EFI_INVALID_PARAMETER; - } else { - return EFI_SUCCESS; - } -} - - -/** - Convert one Null-terminated ASCII string to EFI_IPv6_ADDRESS. The format of the - string is defined in RFC 4291 - Text Representation of Addresses. - - @param[in] String The pointer to the Ascii string. - @param[out] Ip6Address The pointer to the converted IPv6 address. - - @retval EFI_SUCCESS Convert to IPv6 address successfully. - @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip6Address is NULL. - -**/ -EFI_STATUS -EFIAPI -NetLibAsciiStrToIp6 ( - IN CONST CHAR8 *String, - OUT EFI_IPv6_ADDRESS *Ip6Address - ) -{ - RETURN_STATUS Status; - CHAR8 *EndPointer; - - Status = AsciiStrToIpv6Address (String, &EndPointer, Ip6Address, NULL); - if (RETURN_ERROR (Status) || (*EndPointer != '\0')) { - return EFI_INVALID_PARAMETER; - } else { - return EFI_SUCCESS; - } -} - - -/** - Convert one Null-terminated Unicode string (decimal dotted) to EFI_IPv4_ADDRESS. - - @param[in] String The pointer to the Ascii string. - @param[out] Ip4Address The pointer to the converted IPv4 address. - - @retval EFI_SUCCESS Convert to IPv4 address successfully. - @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip4Address is NULL. - -**/ -EFI_STATUS -EFIAPI -NetLibStrToIp4 ( - IN CONST CHAR16 *String, - OUT EFI_IPv4_ADDRESS *Ip4Address - ) -{ - RETURN_STATUS Status; - CHAR16 *EndPointer; - - Status = StrToIpv4Address (String, &EndPointer, Ip4Address, NULL); - if (RETURN_ERROR (Status) || (*EndPointer != L'\0')) { - return EFI_INVALID_PARAMETER; - } else { - return EFI_SUCCESS; - } -} - - -/** - Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS. The format of - the string is defined in RFC 4291 - Text Representation of Addresses. - - @param[in] String The pointer to the Ascii string. - @param[out] Ip6Address The pointer to the converted IPv6 address. - - @retval EFI_SUCCESS Convert to IPv6 address successfully. - @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip6Address is NULL. - -**/ -EFI_STATUS -EFIAPI -NetLibStrToIp6 ( - IN CONST CHAR16 *String, - OUT EFI_IPv6_ADDRESS *Ip6Address - ) -{ - RETURN_STATUS Status; - CHAR16 *EndPointer; - - Status = StrToIpv6Address (String, &EndPointer, Ip6Address, NULL); - if (RETURN_ERROR (Status) || (*EndPointer != L'\0')) { - return EFI_INVALID_PARAMETER; - } else { - return EFI_SUCCESS; - } -} - -/** - Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS and prefix length. - The format of the string is defined in RFC 4291 - Text Representation of Addresses - Prefixes: ipv6-address/prefix-length. - - @param[in] String The pointer to the Ascii string. - @param[out] Ip6Address The pointer to the converted IPv6 address. - @param[out] PrefixLength The pointer to the converted prefix length. - - @retval EFI_SUCCESS Convert to IPv6 address successfully. - @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip6Address is NULL. - -**/ -EFI_STATUS -EFIAPI -NetLibStrToIp6andPrefix ( - IN CONST CHAR16 *String, - OUT EFI_IPv6_ADDRESS *Ip6Address, - OUT UINT8 *PrefixLength - ) -{ - RETURN_STATUS Status; - CHAR16 *EndPointer; - - Status = StrToIpv6Address (String, &EndPointer, Ip6Address, PrefixLength); - if (RETURN_ERROR (Status) || (*EndPointer != L'\0')) { - return EFI_INVALID_PARAMETER; - } else { - return EFI_SUCCESS; - } -} - -/** - - Convert one EFI_IPv6_ADDRESS to Null-terminated Unicode string. - The text representation of address is defined in RFC 4291. - - @param[in] Ip6Address The pointer to the IPv6 address. - @param[out] String The buffer to return the converted string. - @param[in] StringSize The length in bytes of the input String. - - @retval EFI_SUCCESS Convert to string successfully. - @retval EFI_INVALID_PARAMETER The input parameter is invalid. - @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result. BufferSize has been - updated with the size needed to complete the request. -**/ -EFI_STATUS -EFIAPI -NetLibIp6ToStr ( - IN EFI_IPv6_ADDRESS *Ip6Address, - OUT CHAR16 *String, - IN UINTN StringSize - ) -{ - UINT16 Ip6Addr[8]; - UINTN Index; - UINTN LongestZerosStart; - UINTN LongestZerosLength; - UINTN CurrentZerosStart; - UINTN CurrentZerosLength; - CHAR16 Buffer[sizeof"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff"]; - CHAR16 *Ptr; - - if (Ip6Address == NULL || String == NULL || StringSize == 0) { - return EFI_INVALID_PARAMETER; - } - - // - // Convert the UINT8 array to an UINT16 array for easy handling. - // - ZeroMem (Ip6Addr, sizeof (Ip6Addr)); - for (Index = 0; Index < 16; Index++) { - Ip6Addr[Index / 2] |= (Ip6Address->Addr[Index] << ((1 - (Index % 2)) << 3)); - } - - // - // Find the longest zeros and mark it. - // - CurrentZerosStart = DEFAULT_ZERO_START; - CurrentZerosLength = 0; - LongestZerosStart = DEFAULT_ZERO_START; - LongestZerosLength = 0; - for (Index = 0; Index < 8; Index++) { - if (Ip6Addr[Index] == 0) { - if (CurrentZerosStart == DEFAULT_ZERO_START) { - CurrentZerosStart = Index; - CurrentZerosLength = 1; - } else { - CurrentZerosLength++; - } - } else { - if (CurrentZerosStart != DEFAULT_ZERO_START) { - if (CurrentZerosLength > 2 && (LongestZerosStart == (DEFAULT_ZERO_START) || CurrentZerosLength > LongestZerosLength)) { - LongestZerosStart = CurrentZerosStart; - LongestZerosLength = CurrentZerosLength; - } - CurrentZerosStart = DEFAULT_ZERO_START; - CurrentZerosLength = 0; - } - } - } - - if (CurrentZerosStart != DEFAULT_ZERO_START && CurrentZerosLength > 2) { - if (LongestZerosStart == DEFAULT_ZERO_START || LongestZerosLength < CurrentZerosLength) { - LongestZerosStart = CurrentZerosStart; - LongestZerosLength = CurrentZerosLength; - } - } - - Ptr = Buffer; - for (Index = 0; Index < 8; Index++) { - if (LongestZerosStart != DEFAULT_ZERO_START && Index >= LongestZerosStart && Index < LongestZerosStart + LongestZerosLength) { - if (Index == LongestZerosStart) { - *Ptr++ = L':'; - } - continue; - } - if (Index != 0) { - *Ptr++ = L':'; - } - Ptr += UnicodeSPrint(Ptr, 10, L"%x", Ip6Addr[Index]); - } - - if (LongestZerosStart != DEFAULT_ZERO_START && LongestZerosStart + LongestZerosLength == 8) { - *Ptr++ = L':'; - } - *Ptr = L'\0'; - - if ((UINTN)Ptr - (UINTN)Buffer > StringSize) { - return EFI_BUFFER_TOO_SMALL; - } - - StrCpyS (String, StringSize / sizeof (CHAR16), Buffer); - - return EFI_SUCCESS; -} - -/** - This function obtains the system guid from the smbios table. - - If SystemGuid is NULL, then ASSERT(). - - @param[out] SystemGuid The pointer of the returned system guid. - - @retval EFI_SUCCESS Successfully obtained the system guid. - @retval EFI_NOT_FOUND Did not find the SMBIOS table. - -**/ -EFI_STATUS -EFIAPI -NetLibGetSystemGuid ( - OUT EFI_GUID *SystemGuid - ) -{ - EFI_STATUS Status; - SMBIOS_TABLE_ENTRY_POINT *SmbiosTable; - SMBIOS_TABLE_3_0_ENTRY_POINT *Smbios30Table; - SMBIOS_STRUCTURE_POINTER Smbios; - SMBIOS_STRUCTURE_POINTER SmbiosEnd; - CHAR8 *String; - - ASSERT (SystemGuid != NULL); - - SmbiosTable = NULL; - Status = EfiGetSystemConfigurationTable (&gEfiSmbios3TableGuid, (VOID **) &Smbios30Table); - if (!(EFI_ERROR (Status) || Smbios30Table == NULL)) { - Smbios.Hdr = (SMBIOS_STRUCTURE *) (UINTN) Smbios30Table->TableAddress; - SmbiosEnd.Raw = (UINT8 *) (UINTN) (Smbios30Table->TableAddress + Smbios30Table->TableMaximumSize); - } else { - Status = EfiGetSystemConfigurationTable (&gEfiSmbiosTableGuid, (VOID **) &SmbiosTable); - if (EFI_ERROR (Status) || SmbiosTable == NULL) { - return EFI_NOT_FOUND; - } - Smbios.Hdr = (SMBIOS_STRUCTURE *) (UINTN) SmbiosTable->TableAddress; - SmbiosEnd.Raw = (UINT8 *) ((UINTN) SmbiosTable->TableAddress + SmbiosTable->TableLength); - } - - do { - if (Smbios.Hdr->Type == 1) { - if (Smbios.Hdr->Length < 0x19) { - // - // Older version did not support UUID. - // - return EFI_NOT_FOUND; - } - - // - // SMBIOS tables are byte packed so we need to do a byte copy to - // prevend alignment faults on Itanium-based platform. - // - CopyMem (SystemGuid, &Smbios.Type1->Uuid, sizeof (EFI_GUID)); - return EFI_SUCCESS; - } - - // - // Go to the next SMBIOS structure. Each SMBIOS structure may include 2 parts: - // 1. Formatted section; 2. Unformatted string section. So, 2 steps are needed - // to skip one SMBIOS structure. - // - - // - // Step 1: Skip over formatted section. - // - String = (CHAR8 *) (Smbios.Raw + Smbios.Hdr->Length); - - // - // Step 2: Skip over unformated string section. - // - do { - // - // Each string is terminated with a NULL(00h) BYTE and the sets of strings - // is terminated with an additional NULL(00h) BYTE. - // - for ( ; *String != 0; String++) { - } - - if (*(UINT8*)++String == 0) { - // - // Pointer to the next SMBIOS structure. - // - Smbios.Raw = (UINT8 *)++String; - break; - } - } while (TRUE); - } while (Smbios.Raw < SmbiosEnd.Raw); - return EFI_NOT_FOUND; -} - -/** - Create Dns QName according the queried domain name. - - If DomainName is NULL, then ASSERT(). - - QName is a domain name represented as a sequence of labels, - where each label consists of a length octet followed by that - number of octets. The QName terminates with the zero - length octet for the null label of the root. Caller should - take responsibility to free the buffer in returned pointer. - - @param DomainName The pointer to the queried domain name string. - - @retval NULL Failed to fill QName. - @return QName filled successfully. - -**/ -CHAR8 * -EFIAPI -NetLibCreateDnsQName ( - IN CHAR16 *DomainName - ) -{ - CHAR8 *QueryName; - UINTN QueryNameSize; - CHAR8 *Header; - CHAR8 *Tail; - UINTN Len; - UINTN Index; - - ASSERT (DomainName != NULL); - - QueryName = NULL; - QueryNameSize = 0; - Header = NULL; - Tail = NULL; - - // - // One byte for first label length, one byte for terminated length zero. - // - QueryNameSize = StrLen (DomainName) + 2; - - if (QueryNameSize > DNS_MAX_NAME_SIZE) { - return NULL; - } - - QueryName = AllocateZeroPool (QueryNameSize); - if (QueryName == NULL) { - return NULL; - } - - Header = QueryName; - Tail = Header + 1; - Len = 0; - for (Index = 0; DomainName[Index] != 0; Index++) { - *Tail = (CHAR8) DomainName[Index]; - if (*Tail == '.') { - *Header = (CHAR8) Len; - Header = Tail; - Tail ++; - Len = 0; - } else { - Tail++; - Len++; - } - } - *Header = (CHAR8) Len; - *Tail = 0; - - return QueryName; -} diff --git a/MdeModulePkg/Library/DxeNetLib/DxeNetLib.inf b/MdeModulePkg/Library/DxeNetLib/DxeNetLib.inf deleted file mode 100644 index 35a8247517..0000000000 --- a/MdeModulePkg/Library/DxeNetLib/DxeNetLib.inf +++ /dev/null @@ -1,61 +0,0 @@ -## @file -# This library instance provides the basic network services. -# -# Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-# (C) Copyright 2015 Hewlett Packard Enterprise Development LP
-# SPDX-License-Identifier: BSD-2-Clause-Patent -# -## - - -[Defines] - INF_VERSION = 0x00010005 - BASE_NAME = DxeNetLib - MODULE_UNI_FILE = DxeNetLib.uni - FILE_GUID = db6dcef3-9f4e-4340-9351-fc35aa8a5888 - MODULE_TYPE = DXE_DRIVER - VERSION_STRING = 1.0 - LIBRARY_CLASS = NetLib|DXE_CORE DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER - -# -# The following information is for reference only and not required by the build tools. -# -# VALID_ARCHITECTURES = IA32 X64 EBC -# - -[Sources] - DxeNetLib.c - NetBuffer.c - - -[Packages] - MdePkg/MdePkg.dec - MdeModulePkg/MdeModulePkg.dec - - -[LibraryClasses] - BaseLib - DebugLib - BaseMemoryLib - UefiBootServicesTableLib - UefiRuntimeServicesTableLib - UefiLib - MemoryAllocationLib - DevicePathLib - PrintLib - - -[Guids] - gEfiSmbiosTableGuid ## SOMETIMES_CONSUMES ## SystemTable - gEfiSmbios3TableGuid ## SOMETIMES_CONSUMES ## SystemTable - gEfiAdapterInfoMediaStateGuid ## SOMETIMES_CONSUMES - - -[Protocols] - gEfiSimpleNetworkProtocolGuid ## SOMETIMES_CONSUMES - gEfiManagedNetworkProtocolGuid ## SOMETIMES_CONSUMES - gEfiManagedNetworkServiceBindingProtocolGuid ## SOMETIMES_CONSUMES - gEfiIp4Config2ProtocolGuid ## SOMETIMES_CONSUMES - gEfiComponentNameProtocolGuid ## SOMETIMES_CONSUMES - gEfiComponentName2ProtocolGuid ## SOMETIMES_CONSUMES - gEfiAdapterInformationProtocolGuid ## SOMETIMES_CONSUMES diff --git a/MdeModulePkg/Library/DxeNetLib/DxeNetLib.uni b/MdeModulePkg/Library/DxeNetLib/DxeNetLib.uni deleted file mode 100644 index 0c9f1fddde..0000000000 --- a/MdeModulePkg/Library/DxeNetLib/DxeNetLib.uni +++ /dev/null @@ -1,16 +0,0 @@ -// /** @file -// This library instance provides the basic network services. -// -// This library instance provides the basic network services. -// -// Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-// -// SPDX-License-Identifier: BSD-2-Clause-Patent -// -// **/ - - -#string STR_MODULE_ABSTRACT #language en-US "Provides the basic network services" - -#string STR_MODULE_DESCRIPTION #language en-US "This library instance provides the basic network services." - diff --git a/MdeModulePkg/Library/DxeNetLib/NetBuffer.c b/MdeModulePkg/Library/DxeNetLib/NetBuffer.c deleted file mode 100644 index 2408e9a104..0000000000 --- a/MdeModulePkg/Library/DxeNetLib/NetBuffer.c +++ /dev/null @@ -1,1890 +0,0 @@ -/** @file - Network library functions providing net buffer operation support. - -Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent -**/ - -#include - -#include -#include -#include -#include -#include -#include - - -/** - Allocate and build up the sketch for a NET_BUF. - - The net buffer allocated has the BlockOpNum's NET_BLOCK_OP, and its associated - NET_VECTOR has the BlockNum's NET_BLOCK. But all the NET_BLOCK_OP and - NET_BLOCK remain un-initialized. - - @param[in] BlockNum The number of NET_BLOCK in the vector of net buffer - @param[in] BlockOpNum The number of NET_BLOCK_OP in the net buffer - - @return Pointer to the allocated NET_BUF, or NULL if the - allocation failed due to resource limit. - -**/ -NET_BUF * -NetbufAllocStruct ( - IN UINT32 BlockNum, - IN UINT32 BlockOpNum - ) -{ - NET_BUF *Nbuf; - NET_VECTOR *Vector; - - ASSERT (BlockOpNum >= 1); - - // - // Allocate three memory blocks. - // - Nbuf = AllocateZeroPool (NET_BUF_SIZE (BlockOpNum)); - - if (Nbuf == NULL) { - return NULL; - } - - Nbuf->Signature = NET_BUF_SIGNATURE; - Nbuf->RefCnt = 1; - Nbuf->BlockOpNum = BlockOpNum; - InitializeListHead (&Nbuf->List); - - if (BlockNum != 0) { - Vector = AllocateZeroPool (NET_VECTOR_SIZE (BlockNum)); - - if (Vector == NULL) { - goto FreeNbuf; - } - - Vector->Signature = NET_VECTOR_SIGNATURE; - Vector->RefCnt = 1; - Vector->BlockNum = BlockNum; - Nbuf->Vector = Vector; - } - - return Nbuf; - -FreeNbuf: - - FreePool (Nbuf); - return NULL; -} - - -/** - Allocate a single block NET_BUF. Upon allocation, all the - free space is in the tail room. - - @param[in] Len The length of the block. - - @return Pointer to the allocated NET_BUF, or NULL if the - allocation failed due to resource limit. - -**/ -NET_BUF * -EFIAPI -NetbufAlloc ( - IN UINT32 Len - ) -{ - NET_BUF *Nbuf; - NET_VECTOR *Vector; - UINT8 *Bulk; - - ASSERT (Len > 0); - - Nbuf = NetbufAllocStruct (1, 1); - - if (Nbuf == NULL) { - return NULL; - } - - Bulk = AllocatePool (Len); - - if (Bulk == NULL) { - goto FreeNBuf; - } - - Vector = Nbuf->Vector; - Vector->Len = Len; - - Vector->Block[0].Bulk = Bulk; - Vector->Block[0].Len = Len; - - Nbuf->BlockOp[0].BlockHead = Bulk; - Nbuf->BlockOp[0].BlockTail = Bulk + Len; - - Nbuf->BlockOp[0].Head = Bulk; - Nbuf->BlockOp[0].Tail = Bulk; - Nbuf->BlockOp[0].Size = 0; - - return Nbuf; - -FreeNBuf: - FreePool (Nbuf); - return NULL; -} - -/** - Free the net vector. - - Decrease the reference count of the net vector by one. The real resource free - operation isn't performed until the reference count of the net vector is - decreased to 0. - - @param[in] Vector Pointer to the NET_VECTOR to be freed. - -**/ -VOID -NetbufFreeVector ( - IN NET_VECTOR *Vector - ) -{ - UINT32 Index; - - ASSERT (Vector != NULL); - NET_CHECK_SIGNATURE (Vector, NET_VECTOR_SIGNATURE); - ASSERT (Vector->RefCnt > 0); - - Vector->RefCnt--; - - if (Vector->RefCnt > 0) { - return; - } - - if (Vector->Free != NULL) { - // - // Call external free function to free the vector if it - // isn't NULL. If NET_VECTOR_OWN_FIRST is set, release the - // first block since it is allocated by us - // - if ((Vector->Flag & NET_VECTOR_OWN_FIRST) != 0) { - gBS->FreePool (Vector->Block[0].Bulk); - } - - Vector->Free (Vector->Arg); - - } else { - // - // Free each memory block associated with the Vector - // - for (Index = 0; Index < Vector->BlockNum; Index++) { - gBS->FreePool (Vector->Block[Index].Bulk); - } - } - - FreePool (Vector); -} - - -/** - Free the net buffer and its associated NET_VECTOR. - - Decrease the reference count of the net buffer by one. Free the associated net - vector and itself if the reference count of the net buffer is decreased to 0. - The net vector free operation just decrease the reference count of the net - vector by one and do the real resource free operation when the reference count - of the net vector is 0. - - @param[in] Nbuf Pointer to the NET_BUF to be freed. - -**/ -VOID -EFIAPI -NetbufFree ( - IN NET_BUF *Nbuf - ) -{ - ASSERT (Nbuf != NULL); - NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); - ASSERT (Nbuf->RefCnt > 0); - - Nbuf->RefCnt--; - - if (Nbuf->RefCnt == 0) { - // - // Update Vector only when NBuf is to be released. That is, - // all the sharing of Nbuf increse Vector's RefCnt by one - // - NetbufFreeVector (Nbuf->Vector); - FreePool (Nbuf); - } -} - - -/** - Create a copy of the net buffer that shares the associated net vector. - - The reference count of the newly created net buffer is set to 1. The reference - count of the associated net vector is increased by one. - - @param[in] Nbuf Pointer to the net buffer to be cloned. - - @return Pointer to the cloned net buffer, or NULL if the - allocation failed due to resource limit. - -**/ -NET_BUF * -EFIAPI -NetbufClone ( - IN NET_BUF *Nbuf - ) -{ - NET_BUF *Clone; - - NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); - - Clone = AllocatePool (NET_BUF_SIZE (Nbuf->BlockOpNum)); - - if (Clone == NULL) { - return NULL; - } - - Clone->Signature = NET_BUF_SIGNATURE; - Clone->RefCnt = 1; - InitializeListHead (&Clone->List); - - Clone->Ip = Nbuf->Ip; - Clone->Tcp = Nbuf->Tcp; - - CopyMem (Clone->ProtoData, Nbuf->ProtoData, NET_PROTO_DATA); - - NET_GET_REF (Nbuf->Vector); - - Clone->Vector = Nbuf->Vector; - Clone->BlockOpNum = Nbuf->BlockOpNum; - Clone->TotalSize = Nbuf->TotalSize; - CopyMem (Clone->BlockOp, Nbuf->BlockOp, sizeof (NET_BLOCK_OP) * Nbuf->BlockOpNum); - - return Clone; -} - - -/** - Create a duplicated copy of the net buffer with data copied and HeadSpace - bytes of head space reserved. - - The duplicated net buffer will allocate its own memory to hold the data of the - source net buffer. - - @param[in] Nbuf Pointer to the net buffer to be duplicated from. - @param[in, out] Duplicate Pointer to the net buffer to duplicate to, if - NULL a new net buffer is allocated. - @param[in] HeadSpace Length of the head space to reserve. - - @return Pointer to the duplicated net buffer, or NULL if - the allocation failed due to resource limit. - -**/ -NET_BUF * -EFIAPI -NetbufDuplicate ( - IN NET_BUF *Nbuf, - IN OUT NET_BUF *Duplicate OPTIONAL, - IN UINT32 HeadSpace - ) -{ - UINT8 *Dst; - - NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); - - if (Duplicate == NULL) { - Duplicate = NetbufAlloc (Nbuf->TotalSize + HeadSpace); - } - - if (Duplicate == NULL) { - return NULL; - } - - // - // Don't set the IP and TCP head point, since it is most - // like that they are pointing to the memory of Nbuf. - // - CopyMem (Duplicate->ProtoData, Nbuf->ProtoData, NET_PROTO_DATA); - NetbufReserve (Duplicate, HeadSpace); - - Dst = NetbufAllocSpace (Duplicate, Nbuf->TotalSize, NET_BUF_TAIL); - NetbufCopy (Nbuf, 0, Nbuf->TotalSize, Dst); - - return Duplicate; -} - - -/** - Free a list of net buffers. - - @param[in, out] Head Pointer to the head of linked net buffers. - -**/ -VOID -EFIAPI -NetbufFreeList ( - IN OUT LIST_ENTRY *Head - ) -{ - LIST_ENTRY *Entry; - LIST_ENTRY *Next; - NET_BUF *Nbuf; - - Entry = Head->ForwardLink; - - NET_LIST_FOR_EACH_SAFE (Entry, Next, Head) { - Nbuf = NET_LIST_USER_STRUCT (Entry, NET_BUF, List); - NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); - - RemoveEntryList (Entry); - NetbufFree (Nbuf); - } - - ASSERT (IsListEmpty (Head)); -} - - -/** - Get the index of NET_BLOCK_OP that contains the byte at Offset in the net - buffer. - - This can be used to, for example, retrieve the IP header in the packet. It - also can be used to get the fragment that contains the byte which is used - mainly by the library implementation itself. - - @param[in] Nbuf Pointer to the net buffer. - @param[in] Offset The offset of the byte. - @param[out] Index Index of the NET_BLOCK_OP that contains the byte at - Offset. - - @return Pointer to the Offset'th byte of data in the net buffer, or NULL - if there is no such data in the net buffer. - -**/ -UINT8 * -EFIAPI -NetbufGetByte ( - IN NET_BUF *Nbuf, - IN UINT32 Offset, - OUT UINT32 *Index OPTIONAL - ) -{ - NET_BLOCK_OP *BlockOp; - UINT32 Loop; - UINT32 Len; - - NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); - - if (Offset >= Nbuf->TotalSize) { - return NULL; - } - - BlockOp = Nbuf->BlockOp; - Len = 0; - - for (Loop = 0; Loop < Nbuf->BlockOpNum; Loop++) { - - if (Len + BlockOp[Loop].Size <= Offset) { - Len += BlockOp[Loop].Size; - continue; - } - - if (Index != NULL) { - *Index = Loop; - } - - return BlockOp[Loop].Head + (Offset - Len); - } - - return NULL; -} - - - -/** - Set the NET_BLOCK and corresponding NET_BLOCK_OP in the net buffer and - corresponding net vector according to the bulk pointer and bulk length. - - All the pointers in the Index'th NET_BLOCK and NET_BLOCK_OP are set to the - bulk's head and tail respectively. So, this function alone can't be used by - NetbufAlloc. - - @param[in, out] Nbuf Pointer to the net buffer. - @param[in] Bulk Pointer to the data. - @param[in] Len Length of the bulk data. - @param[in] Index The data block index in the net buffer the bulk - data should belong to. - -**/ -VOID -NetbufSetBlock ( - IN OUT NET_BUF *Nbuf, - IN UINT8 *Bulk, - IN UINT32 Len, - IN UINT32 Index - ) -{ - NET_BLOCK_OP *BlockOp; - NET_BLOCK *Block; - - NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); - NET_CHECK_SIGNATURE (Nbuf->Vector, NET_VECTOR_SIGNATURE); - ASSERT (Index < Nbuf->BlockOpNum); - - Block = &(Nbuf->Vector->Block[Index]); - BlockOp = &(Nbuf->BlockOp[Index]); - Block->Len = Len; - Block->Bulk = Bulk; - BlockOp->BlockHead = Bulk; - BlockOp->BlockTail = Bulk + Len; - BlockOp->Head = Bulk; - BlockOp->Tail = Bulk + Len; - BlockOp->Size = Len; -} - - - -/** - Set the NET_BLOCK_OP in the net buffer. The corresponding NET_BLOCK - structure is left untouched. - - Some times, there is no 1:1 relationship between NET_BLOCK and NET_BLOCK_OP. - For example, that in NetbufGetFragment. - - @param[in, out] Nbuf Pointer to the net buffer. - @param[in] Bulk Pointer to the data. - @param[in] Len Length of the bulk data. - @param[in] Index The data block index in the net buffer the bulk - data should belong to. - -**/ -VOID -NetbufSetBlockOp ( - IN OUT NET_BUF *Nbuf, - IN UINT8 *Bulk, - IN UINT32 Len, - IN UINT32 Index - ) -{ - NET_BLOCK_OP *BlockOp; - - NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); - ASSERT (Index < Nbuf->BlockOpNum); - - BlockOp = &(Nbuf->BlockOp[Index]); - BlockOp->BlockHead = Bulk; - BlockOp->BlockTail = Bulk + Len; - BlockOp->Head = Bulk; - BlockOp->Tail = Bulk + Len; - BlockOp->Size = Len; -} - - -/** - Helper function for NetbufGetFragment. NetbufGetFragment may allocate the - first block to reserve HeadSpace bytes header space. So it needs to create a - new net vector for the first block and can avoid copy for the remaining data - by sharing the old net vector. - - @param[in] Arg Point to the old NET_VECTOR. - -**/ -VOID -EFIAPI -NetbufGetFragmentFree ( - IN VOID *Arg - ) -{ - NET_VECTOR *Vector; - - Vector = (NET_VECTOR *)Arg; - NetbufFreeVector (Vector); -} - - -/** - Create a NET_BUF structure which contains Len byte data of Nbuf starting from - Offset. - - A new NET_BUF structure will be created but the associated data in NET_VECTOR - is shared. This function exists to do IP packet fragmentation. - - @param[in] Nbuf Pointer to the net buffer to be extracted. - @param[in] Offset Starting point of the data to be included in the new - net buffer. - @param[in] Len Bytes of data to be included in the new net buffer. - @param[in] HeadSpace Bytes of head space to reserve for protocol header. - - @return Pointer to the cloned net buffer, or NULL if the - allocation failed due to resource limit. - -**/ -NET_BUF * -EFIAPI -NetbufGetFragment ( - IN NET_BUF *Nbuf, - IN UINT32 Offset, - IN UINT32 Len, - IN UINT32 HeadSpace - ) -{ - NET_BUF *Child; - NET_VECTOR *Vector; - NET_BLOCK_OP *BlockOp; - UINT32 CurBlockOp; - UINT32 BlockOpNum; - UINT8 *FirstBulk; - UINT32 Index; - UINT32 First; - UINT32 Last; - UINT32 FirstSkip; - UINT32 FirstLen; - UINT32 LastLen; - UINT32 Cur; - - NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); - - if ((Len == 0) || (Offset + Len > Nbuf->TotalSize)) { - return NULL; - } - - // - // First find the first and last BlockOp that contains - // the valid data, and compute the offset of the first - // BlockOp and length of the last BlockOp - // - BlockOp = Nbuf->BlockOp; - Cur = 0; - - for (Index = 0; Index < Nbuf->BlockOpNum; Index++) { - if (Offset < Cur + BlockOp[Index].Size) { - break; - } - - Cur += BlockOp[Index].Size; - } - - // - // First is the index of the first BlockOp, FirstSkip is - // the offset of the first byte in the first BlockOp. - // - First = Index; - FirstSkip = Offset - Cur; - FirstLen = BlockOp[Index].Size - FirstSkip; - - Last = 0; - LastLen = 0; - - if (Len > FirstLen) { - Cur += BlockOp[Index].Size; - Index++; - - for (; Index < Nbuf->BlockOpNum; Index++) { - if (Offset + Len <= Cur + BlockOp[Index].Size) { - Last = Index; - LastLen = Offset + Len - Cur; - break; - } - - Cur += BlockOp[Index].Size; - } - - } else { - Last = First; - LastLen = Len; - FirstLen = Len; - } - - ASSERT (Last >= First); - BlockOpNum = Last - First + 1; - CurBlockOp = 0; - - if (HeadSpace != 0) { - // - // Allocate an extra block to accomdate the head space. - // - BlockOpNum++; - - Child = NetbufAllocStruct (1, BlockOpNum); - - if (Child == NULL) { - return NULL; - } - - FirstBulk = AllocatePool (HeadSpace); - - if (FirstBulk == NULL) { - goto FreeChild; - } - - Vector = Child->Vector; - Vector->Free = NetbufGetFragmentFree; - Vector->Arg = Nbuf->Vector; - Vector->Flag = NET_VECTOR_OWN_FIRST; - Vector->Len = HeadSpace; - - // - // Reserve the head space in the first block - // - NetbufSetBlock (Child, FirstBulk, HeadSpace, 0); - Child->BlockOp[0].Head += HeadSpace; - Child->BlockOp[0].Size = 0; - CurBlockOp++; - - } else { - Child = NetbufAllocStruct (0, BlockOpNum); - - if (Child == NULL) { - return NULL; - } - - Child->Vector = Nbuf->Vector; - } - - NET_GET_REF (Nbuf->Vector); - Child->TotalSize = Len; - - // - // Set all the BlockOp up, the first and last one are special - // and need special process. - // - NetbufSetBlockOp ( - Child, - Nbuf->BlockOp[First].Head + FirstSkip, - FirstLen, - CurBlockOp++ - ); - - for (Index = First + 1; Index < Last; Index++) { - NetbufSetBlockOp ( - Child, - BlockOp[Index].Head, - BlockOp[Index].Size, - CurBlockOp++ - ); - } - - if (First != Last) { - NetbufSetBlockOp ( - Child, - BlockOp[Last].Head, - LastLen, - CurBlockOp - ); - } - - CopyMem (Child->ProtoData, Nbuf->ProtoData, NET_PROTO_DATA); - return Child; - -FreeChild: - - FreePool (Child); - return NULL; -} - - - -/** - Build a NET_BUF from external blocks. - - A new NET_BUF structure will be created from external blocks. Additional block - of memory will be allocated to hold reserved HeadSpace bytes of header room - and existing HeadLen bytes of header but the external blocks are shared by the - net buffer to avoid data copying. - - @param[in] ExtFragment Pointer to the data block. - @param[in] ExtNum The number of the data blocks. - @param[in] HeadSpace The head space to be reserved. - @param[in] HeadLen The length of the protocol header, This function - will pull that number of data into a linear block. - @param[in] ExtFree Pointer to the caller provided free function. - @param[in] Arg The argument passed to ExtFree when ExtFree is - called. - - @return Pointer to the net buffer built from the data blocks, - or NULL if the allocation failed due to resource - limit. - -**/ -NET_BUF * -EFIAPI -NetbufFromExt ( - IN NET_FRAGMENT *ExtFragment, - IN UINT32 ExtNum, - IN UINT32 HeadSpace, - IN UINT32 HeadLen, - IN NET_VECTOR_EXT_FREE ExtFree, - IN VOID *Arg OPTIONAL - ) -{ - NET_BUF *Nbuf; - NET_VECTOR *Vector; - NET_FRAGMENT SavedFragment; - UINT32 SavedIndex; - UINT32 TotalLen; - UINT32 BlockNum; - UINT8 *FirstBlock; - UINT32 FirstBlockLen; - UINT8 *Header; - UINT32 CurBlock; - UINT32 Index; - UINT32 Len; - UINT32 Copied; - - ASSERT ((ExtFragment != NULL) && (ExtNum > 0) && (ExtFree != NULL)); - - SavedFragment.Bulk = NULL; - SavedFragment.Len = 0; - - FirstBlockLen = 0; - FirstBlock = NULL; - BlockNum = ExtNum; - Index = 0; - TotalLen = 0; - SavedIndex = 0; - Len = 0; - Copied = 0; - - // - // No need to consolidate the header if the first block is - // longer than the header length or there is only one block. - // - if ((ExtFragment[0].Len >= HeadLen) || (ExtNum == 1)) { - HeadLen = 0; - } - - // - // Allocate an extra block if we need to: - // 1. Allocate some header space - // 2. aggreate the packet header - // - if ((HeadSpace != 0) || (HeadLen != 0)) { - FirstBlockLen = HeadLen + HeadSpace; - FirstBlock = AllocatePool (FirstBlockLen); - - if (FirstBlock == NULL) { - return NULL; - } - - BlockNum++; - } - - // - // Copy the header to the first block, reduce the NET_BLOCK - // to allocate by one for each block that is completely covered - // by the first bulk. - // - if (HeadLen != 0) { - Len = HeadLen; - Header = FirstBlock + HeadSpace; - - for (Index = 0; Index < ExtNum; Index++) { - if (Len >= ExtFragment[Index].Len) { - CopyMem (Header, ExtFragment[Index].Bulk, ExtFragment[Index].Len); - - Copied += ExtFragment[Index].Len; - Len -= ExtFragment[Index].Len; - Header += ExtFragment[Index].Len; - TotalLen += ExtFragment[Index].Len; - BlockNum--; - - if (Len == 0) { - // - // Increament the index number to point to the next - // non-empty fragment. - // - Index++; - break; - } - - } else { - CopyMem (Header, ExtFragment[Index].Bulk, Len); - - Copied += Len; - TotalLen += Len; - - // - // Adjust the block structure to exclude the data copied, - // So, the left-over block can be processed as other blocks. - // But it must be recovered later. (SavedIndex > 0) always - // holds since we don't aggreate the header if the first block - // is bigger enough that the header is continuous - // - SavedIndex = Index; - SavedFragment = ExtFragment[Index]; - ExtFragment[Index].Bulk += Len; - ExtFragment[Index].Len -= Len; - break; - } - } - } - - Nbuf = NetbufAllocStruct (BlockNum, BlockNum); - - if (Nbuf == NULL) { - goto FreeFirstBlock; - } - - Vector = Nbuf->Vector; - Vector->Free = ExtFree; - Vector->Arg = Arg; - Vector->Flag = ((FirstBlockLen != 0) ? NET_VECTOR_OWN_FIRST : 0); - - // - // Set the first block up which may contain - // some head space and aggregated header - // - CurBlock = 0; - - if (FirstBlockLen != 0) { - NetbufSetBlock (Nbuf, FirstBlock, HeadSpace + Copied, 0); - Nbuf->BlockOp[0].Head += HeadSpace; - Nbuf->BlockOp[0].Size = Copied; - - CurBlock++; - } - - for (; Index < ExtNum; Index++) { - NetbufSetBlock (Nbuf, ExtFragment[Index].Bulk, ExtFragment[Index].Len, CurBlock); - TotalLen += ExtFragment[Index].Len; - CurBlock++; - } - - Vector->Len = TotalLen + HeadSpace; - Nbuf->TotalSize = TotalLen; - - if (SavedIndex != 0) { - ExtFragment[SavedIndex] = SavedFragment; - } - - return Nbuf; - -FreeFirstBlock: - if (FirstBlock != NULL) { - FreePool (FirstBlock); - } - return NULL; -} - - -/** - Build a fragment table to contain the fragments in the net buffer. This is the - opposite operation of the NetbufFromExt. - - @param[in] Nbuf Point to the net buffer. - @param[in, out] ExtFragment Pointer to the data block. - @param[in, out] ExtNum The number of the data blocks. - - @retval EFI_BUFFER_TOO_SMALL The number of non-empty block is bigger than - ExtNum. - @retval EFI_SUCCESS Fragment table is built successfully. - -**/ -EFI_STATUS -EFIAPI -NetbufBuildExt ( - IN NET_BUF *Nbuf, - IN OUT NET_FRAGMENT *ExtFragment, - IN OUT UINT32 *ExtNum - ) -{ - UINT32 Index; - UINT32 Current; - - Current = 0; - - for (Index = 0; (Index < Nbuf->BlockOpNum); Index++) { - if (Nbuf->BlockOp[Index].Size == 0) { - continue; - } - - if (Current < *ExtNum) { - ExtFragment[Current].Bulk = Nbuf->BlockOp[Index].Head; - ExtFragment[Current].Len = Nbuf->BlockOp[Index].Size; - Current++; - } else { - return EFI_BUFFER_TOO_SMALL; - } - } - - *ExtNum = Current; - return EFI_SUCCESS; -} - - -/** - Build a net buffer from a list of net buffers. - - All the fragments will be collected from the list of NEW_BUF and then a new - net buffer will be created through NetbufFromExt. - - @param[in] BufList A List of the net buffer. - @param[in] HeadSpace The head space to be reserved. - @param[in] HeaderLen The length of the protocol header, This function - will pull that number of data into a linear block. - @param[in] ExtFree Pointer to the caller provided free function. - @param[in] Arg The argument passed to ExtFree when ExtFree is called. - - @return Pointer to the net buffer built from the list of net - buffers. - -**/ -NET_BUF * -EFIAPI -NetbufFromBufList ( - IN LIST_ENTRY *BufList, - IN UINT32 HeadSpace, - IN UINT32 HeaderLen, - IN NET_VECTOR_EXT_FREE ExtFree, - IN VOID *Arg OPTIONAL - ) -{ - NET_FRAGMENT *Fragment; - UINT32 FragmentNum; - LIST_ENTRY *Entry; - NET_BUF *Nbuf; - UINT32 Index; - UINT32 Current; - - // - //Compute how many blocks are there - // - FragmentNum = 0; - - NET_LIST_FOR_EACH (Entry, BufList) { - Nbuf = NET_LIST_USER_STRUCT (Entry, NET_BUF, List); - NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); - FragmentNum += Nbuf->BlockOpNum; - } - - // - //Allocate and copy block points - // - Fragment = AllocatePool (sizeof (NET_FRAGMENT) * FragmentNum); - - if (Fragment == NULL) { - return NULL; - } - - Current = 0; - - NET_LIST_FOR_EACH (Entry, BufList) { - Nbuf = NET_LIST_USER_STRUCT (Entry, NET_BUF, List); - NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); - - for (Index = 0; Index < Nbuf->BlockOpNum; Index++) { - if (Nbuf->BlockOp[Index].Size != 0) { - Fragment[Current].Bulk = Nbuf->BlockOp[Index].Head; - Fragment[Current].Len = Nbuf->BlockOp[Index].Size; - Current++; - } - } - } - - Nbuf = NetbufFromExt (Fragment, Current, HeadSpace, HeaderLen, ExtFree, Arg); - FreePool (Fragment); - - return Nbuf; -} - - -/** - Reserve some space in the header room of the net buffer. - - Upon allocation, all the space are in the tail room of the buffer. Call this - function to move some space to the header room. This function is quite limited - in that it can only reserve space from the first block of an empty NET_BUF not - built from the external. But it should be enough for the network stack. - - @param[in, out] Nbuf Pointer to the net buffer. - @param[in] Len The length of buffer to be reserved from the header. - -**/ -VOID -EFIAPI -NetbufReserve ( - IN OUT NET_BUF *Nbuf, - IN UINT32 Len - ) -{ - NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); - NET_CHECK_SIGNATURE (Nbuf->Vector, NET_VECTOR_SIGNATURE); - - ASSERT ((Nbuf->BlockOpNum == 1) && (Nbuf->TotalSize == 0)); - ASSERT ((Nbuf->Vector->Free == NULL) && (Nbuf->Vector->Len >= Len)); - - Nbuf->BlockOp[0].Head += Len; - Nbuf->BlockOp[0].Tail += Len; - - ASSERT (Nbuf->BlockOp[0].Tail <= Nbuf->BlockOp[0].BlockTail); -} - - -/** - Allocate Len bytes of space from the header or tail of the buffer. - - @param[in, out] Nbuf Pointer to the net buffer. - @param[in] Len The length of the buffer to be allocated. - @param[in] FromHead The flag to indicate whether reserve the data - from head (TRUE) or tail (FALSE). - - @return Pointer to the first byte of the allocated buffer, - or NULL if there is no sufficient space. - -**/ -UINT8* -EFIAPI -NetbufAllocSpace ( - IN OUT NET_BUF *Nbuf, - IN UINT32 Len, - IN BOOLEAN FromHead - ) -{ - NET_BLOCK_OP *BlockOp; - UINT32 Index; - UINT8 *SavedTail; - - Index = 0; - - NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); - NET_CHECK_SIGNATURE (Nbuf->Vector, NET_VECTOR_SIGNATURE); - - ASSERT (Len > 0); - - if (FromHead) { - // - // Allocate some space from head. If the buffer is empty, - // allocate from the first block. If it isn't, allocate - // from the first non-empty block, or the block before that. - // - if (Nbuf->TotalSize == 0) { - Index = 0; - } else { - NetbufGetByte (Nbuf, 0, &Index); - - if ((NET_HEADSPACE(&(Nbuf->BlockOp[Index])) < Len) && (Index > 0)) { - Index--; - } - } - - BlockOp = &(Nbuf->BlockOp[Index]); - - if (NET_HEADSPACE (BlockOp) < Len) { - return NULL; - } - - BlockOp->Head -= Len; - BlockOp->Size += Len; - Nbuf->TotalSize += Len; - - return BlockOp->Head; - - } else { - // - // Allocate some space from the tail. If the buffer is empty, - // allocate from the first block. If it isn't, allocate - // from the last non-empty block, or the block after that. - // - if (Nbuf->TotalSize == 0) { - Index = 0; - } else { - NetbufGetByte (Nbuf, Nbuf->TotalSize - 1, &Index); - - if ((NET_TAILSPACE(&(Nbuf->BlockOp[Index])) < Len) && - (Index < Nbuf->BlockOpNum - 1)) { - - Index++; - } - } - - BlockOp = &(Nbuf->BlockOp[Index]); - - if (NET_TAILSPACE (BlockOp) < Len) { - return NULL; - } - - SavedTail = BlockOp->Tail; - - BlockOp->Tail += Len; - BlockOp->Size += Len; - Nbuf->TotalSize += Len; - - return SavedTail; - } -} - - -/** - Trim a single NET_BLOCK by Len bytes from the header or tail. - - @param[in, out] BlockOp Pointer to the NET_BLOCK. - @param[in] Len The length of the data to be trimmed. - @param[in] FromHead The flag to indicate whether trim data from head - (TRUE) or tail (FALSE). - -**/ -VOID -NetblockTrim ( - IN OUT NET_BLOCK_OP *BlockOp, - IN UINT32 Len, - IN BOOLEAN FromHead - ) -{ - ASSERT ((BlockOp != NULL) && (BlockOp->Size >= Len)); - - BlockOp->Size -= Len; - - if (FromHead) { - BlockOp->Head += Len; - } else { - BlockOp->Tail -= Len; - } -} - - -/** - Trim Len bytes from the header or tail of the net buffer. - - @param[in, out] Nbuf Pointer to the net buffer. - @param[in] Len The length of the data to be trimmed. - @param[in] FromHead The flag to indicate whether trim data from head - (TRUE) or tail (FALSE). - - @return Length of the actually trimmed data, which is possible to be less - than Len because the TotalSize of Nbuf is less than Len. - -**/ -UINT32 -EFIAPI -NetbufTrim ( - IN OUT NET_BUF *Nbuf, - IN UINT32 Len, - IN BOOLEAN FromHead - ) -{ - NET_BLOCK_OP *BlockOp; - UINT32 Index; - UINT32 Trimmed; - - NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); - - if (Len == 0 || Nbuf->TotalSize == 0) { - return 0; - } - - if (Len > Nbuf->TotalSize) { - Len = Nbuf->TotalSize; - } - - // - // If FromTail is true, iterate backward. That - // is, init Index to NBuf->BlockNum - 1, and - // decrease it by 1 during each loop. Otherwise, - // iterate forward. That is, init Index to 0, and - // increase it by 1 during each loop. - // - Trimmed = 0; - Nbuf->TotalSize -= Len; - - Index = (FromHead ? 0 : Nbuf->BlockOpNum - 1); - BlockOp = Nbuf->BlockOp; - - for (;;) { - if (BlockOp[Index].Size == 0) { - Index += (FromHead ? 1 : -1); - continue; - } - - if (Len > BlockOp[Index].Size) { - Len -= BlockOp[Index].Size; - Trimmed += BlockOp[Index].Size; - NetblockTrim (&BlockOp[Index], BlockOp[Index].Size, FromHead); - } else { - Trimmed += Len; - NetblockTrim (&BlockOp[Index], Len, FromHead); - break; - } - - Index += (FromHead ? 1 : -1); - } - - return Trimmed; -} - - -/** - Copy Len bytes of data from the specific offset of the net buffer to the - destination memory. - - The Len bytes of data may cross the several fragments of the net buffer. - - @param[in] Nbuf Pointer to the net buffer. - @param[in] Offset The sequence number of the first byte to copy. - @param[in] Len Length of the data to copy. - @param[in] Dest The destination of the data to copy to. - - @return The length of the actual copied data, or 0 if the offset - specified exceeds the total size of net buffer. - -**/ -UINT32 -EFIAPI -NetbufCopy ( - IN NET_BUF *Nbuf, - IN UINT32 Offset, - IN UINT32 Len, - IN UINT8 *Dest - ) -{ - NET_BLOCK_OP *BlockOp; - UINT32 Skip; - UINT32 Left; - UINT32 Copied; - UINT32 Index; - UINT32 Cur; - - NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); - ASSERT (Dest); - - if ((Len == 0) || (Nbuf->TotalSize <= Offset)) { - return 0; - } - - if (Nbuf->TotalSize - Offset < Len) { - Len = Nbuf->TotalSize - Offset; - } - - BlockOp = Nbuf->BlockOp; - - // - // Skip to the offset. Don't make "Offset-By-One" error here. - // Cur + BLOCK.SIZE is the first sequence number of next block. - // So, (Offset < Cur + BLOCK.SIZE) means that the first byte - // is in the current block. if (Offset == Cur + BLOCK.SIZE), the - // first byte is the next block's first byte. - // - Cur = 0; - - for (Index = 0; Index < Nbuf->BlockOpNum; Index++) { - if (BlockOp[Index].Size == 0) { - continue; - } - - if (Offset < Cur + BlockOp[Index].Size) { - break; - } - - Cur += BlockOp[Index].Size; - } - - // - // Cur is the sequence number of the first byte in the block - // Offset - Cur is the number of bytes before first byte to - // to copy in the current block. - // - Skip = Offset - Cur; - Left = BlockOp[Index].Size - Skip; - - if (Len <= Left) { - CopyMem (Dest, BlockOp[Index].Head + Skip, Len); - return Len; - } - - CopyMem (Dest, BlockOp[Index].Head + Skip, Left); - - Dest += Left; - Len -= Left; - Copied = Left; - - Index++; - - for (; Index < Nbuf->BlockOpNum; Index++) { - if (Len > BlockOp[Index].Size) { - Len -= BlockOp[Index].Size; - Copied += BlockOp[Index].Size; - - CopyMem (Dest, BlockOp[Index].Head, BlockOp[Index].Size); - Dest += BlockOp[Index].Size; - } else { - Copied += Len; - CopyMem (Dest, BlockOp[Index].Head, Len); - break; - } - } - - return Copied; -} - - -/** - Initiate the net buffer queue. - - @param[in, out] NbufQue Pointer to the net buffer queue to be initialized. - -**/ -VOID -EFIAPI -NetbufQueInit ( - IN OUT NET_BUF_QUEUE *NbufQue - ) -{ - NbufQue->Signature = NET_QUE_SIGNATURE; - NbufQue->RefCnt = 1; - InitializeListHead (&NbufQue->List); - - InitializeListHead (&NbufQue->BufList); - NbufQue->BufSize = 0; - NbufQue->BufNum = 0; -} - - -/** - Allocate and initialize a net buffer queue. - - @return Pointer to the allocated net buffer queue, or NULL if the - allocation failed due to resource limit. - -**/ -NET_BUF_QUEUE * -EFIAPI -NetbufQueAlloc ( - VOID - ) -{ - NET_BUF_QUEUE *NbufQue; - - NbufQue = AllocatePool (sizeof (NET_BUF_QUEUE)); - if (NbufQue == NULL) { - return NULL; - } - - NetbufQueInit (NbufQue); - - return NbufQue; -} - - -/** - Free a net buffer queue. - - Decrease the reference count of the net buffer queue by one. The real resource - free operation isn't performed until the reference count of the net buffer - queue is decreased to 0. - - @param[in] NbufQue Pointer to the net buffer queue to be freed. - -**/ -VOID -EFIAPI -NetbufQueFree ( - IN NET_BUF_QUEUE *NbufQue - ) -{ - ASSERT (NbufQue != NULL); - NET_CHECK_SIGNATURE (NbufQue, NET_QUE_SIGNATURE); - - NbufQue->RefCnt--; - - if (NbufQue->RefCnt == 0) { - NetbufQueFlush (NbufQue); - FreePool (NbufQue); - } -} - - -/** - Append a net buffer to the net buffer queue. - - @param[in, out] NbufQue Pointer to the net buffer queue. - @param[in, out] Nbuf Pointer to the net buffer to be appended. - -**/ -VOID -EFIAPI -NetbufQueAppend ( - IN OUT NET_BUF_QUEUE *NbufQue, - IN OUT NET_BUF *Nbuf - ) -{ - NET_CHECK_SIGNATURE (NbufQue, NET_QUE_SIGNATURE); - NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); - - InsertTailList (&NbufQue->BufList, &Nbuf->List); - - NbufQue->BufSize += Nbuf->TotalSize; - NbufQue->BufNum++; -} - - -/** - Remove a net buffer from the head in the specific queue and return it. - - @param[in, out] NbufQue Pointer to the net buffer queue. - - @return Pointer to the net buffer removed from the specific queue, - or NULL if there is no net buffer in the specific queue. - -**/ -NET_BUF * -EFIAPI -NetbufQueRemove ( - IN OUT NET_BUF_QUEUE *NbufQue - ) -{ - NET_BUF *First; - - NET_CHECK_SIGNATURE (NbufQue, NET_QUE_SIGNATURE); - - if (NbufQue->BufNum == 0) { - return NULL; - } - - First = NET_LIST_USER_STRUCT (NbufQue->BufList.ForwardLink, NET_BUF, List); - - NetListRemoveHead (&NbufQue->BufList); - - NbufQue->BufSize -= First->TotalSize; - NbufQue->BufNum--; - return First; -} - - -/** - Copy Len bytes of data from the net buffer queue at the specific offset to the - destination memory. - - The copying operation is the same as NetbufCopy but applies to the net buffer - queue instead of the net buffer. - - @param[in] NbufQue Pointer to the net buffer queue. - @param[in] Offset The sequence number of the first byte to copy. - @param[in] Len Length of the data to copy. - @param[out] Dest The destination of the data to copy to. - - @return The length of the actual copied data, or 0 if the offset - specified exceeds the total size of net buffer queue. - -**/ -UINT32 -EFIAPI -NetbufQueCopy ( - IN NET_BUF_QUEUE *NbufQue, - IN UINT32 Offset, - IN UINT32 Len, - OUT UINT8 *Dest - ) -{ - LIST_ENTRY *Entry; - NET_BUF *Nbuf; - UINT32 Skip; - UINT32 Left; - UINT32 Cur; - UINT32 Copied; - - NET_CHECK_SIGNATURE (NbufQue, NET_QUE_SIGNATURE); - ASSERT (Dest != NULL); - - if ((Len == 0) || (NbufQue->BufSize <= Offset)) { - return 0; - } - - if (NbufQue->BufSize - Offset < Len) { - Len = NbufQue->BufSize - Offset; - } - - // - // skip to the Offset - // - Cur = 0; - Nbuf = NULL; - - NET_LIST_FOR_EACH (Entry, &NbufQue->BufList) { - Nbuf = NET_LIST_USER_STRUCT (Entry, NET_BUF, List); - - if (Offset < Cur + Nbuf->TotalSize) { - break; - } - - Cur += Nbuf->TotalSize; - } - - ASSERT (Nbuf != NULL); - - // - // Copy the data in the first buffer. - // - Skip = Offset - Cur; - Left = Nbuf->TotalSize - Skip; - - if (Len < Left) { - return NetbufCopy (Nbuf, Skip, Len, Dest); - } - - NetbufCopy (Nbuf, Skip, Left, Dest); - Dest += Left; - Len -= Left; - Copied = Left; - - // - // Iterate over the others - // - Entry = Entry->ForwardLink; - - while ((Len > 0) && (Entry != &NbufQue->BufList)) { - Nbuf = NET_LIST_USER_STRUCT (Entry, NET_BUF, List); - - if (Len > Nbuf->TotalSize) { - Len -= Nbuf->TotalSize; - Copied += Nbuf->TotalSize; - - NetbufCopy (Nbuf, 0, Nbuf->TotalSize, Dest); - Dest += Nbuf->TotalSize; - - } else { - NetbufCopy (Nbuf, 0, Len, Dest); - Copied += Len; - break; - } - - Entry = Entry->ForwardLink; - } - - return Copied; -} - - -/** - Trim Len bytes of data from the buffer queue and free any net buffer - that is completely trimmed. - - The trimming operation is the same as NetbufTrim but applies to the net buffer - queue instead of the net buffer. - - @param[in, out] NbufQue Pointer to the net buffer queue. - @param[in] Len Length of the data to trim. - - @return The actual length of the data trimmed. - -**/ -UINT32 -EFIAPI -NetbufQueTrim ( - IN OUT NET_BUF_QUEUE *NbufQue, - IN UINT32 Len - ) -{ - LIST_ENTRY *Entry; - LIST_ENTRY *Next; - NET_BUF *Nbuf; - UINT32 Trimmed; - - NET_CHECK_SIGNATURE (NbufQue, NET_QUE_SIGNATURE); - - if (Len == 0) { - return 0; - } - - if (Len > NbufQue->BufSize) { - Len = NbufQue->BufSize; - } - - NbufQue->BufSize -= Len; - Trimmed = 0; - - NET_LIST_FOR_EACH_SAFE (Entry, Next, &NbufQue->BufList) { - Nbuf = NET_LIST_USER_STRUCT (Entry, NET_BUF, List); - - if (Len >= Nbuf->TotalSize) { - Trimmed += Nbuf->TotalSize; - Len -= Nbuf->TotalSize; - - RemoveEntryList (Entry); - NetbufFree (Nbuf); - - NbufQue->BufNum--; - - if (Len == 0) { - break; - } - - } else { - Trimmed += NetbufTrim (Nbuf, Len, NET_BUF_HEAD); - break; - } - } - - return Trimmed; -} - - -/** - Flush the net buffer queue. - - @param[in, out] NbufQue Pointer to the queue to be flushed. - -**/ -VOID -EFIAPI -NetbufQueFlush ( - IN OUT NET_BUF_QUEUE *NbufQue - ) -{ - NET_CHECK_SIGNATURE (NbufQue, NET_QUE_SIGNATURE); - - NetbufFreeList (&NbufQue->BufList); - - NbufQue->BufNum = 0; - NbufQue->BufSize = 0; -} - - -/** - Compute the checksum for a bulk of data. - - @param[in] Bulk Pointer to the data. - @param[in] Len Length of the data, in bytes. - - @return The computed checksum. - -**/ -UINT16 -EFIAPI -NetblockChecksum ( - IN UINT8 *Bulk, - IN UINT32 Len - ) -{ - register UINT32 Sum; - - Sum = 0; - - // - // Add left-over byte, if any - // - if (Len % 2 != 0) { - Sum += *(Bulk + Len - 1); - } - - while (Len > 1) { - Sum += *(UINT16 *) Bulk; - Bulk += 2; - Len -= 2; - } - - // - // Fold 32-bit sum to 16 bits - // - while ((Sum >> 16) != 0) { - Sum = (Sum & 0xffff) + (Sum >> 16); - - } - - return (UINT16) Sum; -} - - -/** - Add two checksums. - - @param[in] Checksum1 The first checksum to be added. - @param[in] Checksum2 The second checksum to be added. - - @return The new checksum. - -**/ -UINT16 -EFIAPI -NetAddChecksum ( - IN UINT16 Checksum1, - IN UINT16 Checksum2 - ) -{ - UINT32 Sum; - - Sum = Checksum1 + Checksum2; - - // - // two UINT16 can only add up to a carry of 1. - // - if ((Sum >> 16) != 0) { - Sum = (Sum & 0xffff) + 1; - - } - - return (UINT16) Sum; -} - - -/** - Compute the checksum for a NET_BUF. - - @param[in] Nbuf Pointer to the net buffer. - - @return The computed checksum. - -**/ -UINT16 -EFIAPI -NetbufChecksum ( - IN NET_BUF *Nbuf - ) -{ - NET_BLOCK_OP *BlockOp; - UINT32 Offset; - UINT16 TotalSum; - UINT16 BlockSum; - UINT32 Index; - - NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); - - TotalSum = 0; - Offset = 0; - BlockOp = Nbuf->BlockOp; - - for (Index = 0; Index < Nbuf->BlockOpNum; Index++) { - if (BlockOp[Index].Size == 0) { - continue; - } - - BlockSum = NetblockChecksum (BlockOp[Index].Head, BlockOp[Index].Size); - - if ((Offset & 0x01) != 0) { - // - // The checksum starts with an odd byte, swap - // the checksum before added to total checksum - // - BlockSum = SwapBytes16 (BlockSum); - } - - TotalSum = NetAddChecksum (BlockSum, TotalSum); - Offset += BlockOp[Index].Size; - } - - return TotalSum; -} - - -/** - Compute the checksum for TCP/UDP pseudo header. - - Src and Dst are in network byte order, and Len is in host byte order. - - @param[in] Src The source address of the packet. - @param[in] Dst The destination address of the packet. - @param[in] Proto The protocol type of the packet. - @param[in] Len The length of the packet. - - @return The computed checksum. - -**/ -UINT16 -EFIAPI -NetPseudoHeadChecksum ( - IN IP4_ADDR Src, - IN IP4_ADDR Dst, - IN UINT8 Proto, - IN UINT16 Len - ) -{ - NET_PSEUDO_HDR Hdr; - - // - // Zero the memory to relieve align problems - // - ZeroMem (&Hdr, sizeof (Hdr)); - - Hdr.SrcIp = Src; - Hdr.DstIp = Dst; - Hdr.Protocol = Proto; - Hdr.Len = HTONS (Len); - - return NetblockChecksum ((UINT8 *) &Hdr, sizeof (Hdr)); -} - -/** - Compute the checksum for TCP6/UDP6 pseudo header. - - Src and Dst are in network byte order, and Len is in host byte order. - - @param[in] Src The source address of the packet. - @param[in] Dst The destination address of the packet. - @param[in] NextHeader The protocol type of the packet. - @param[in] Len The length of the packet. - - @return The computed checksum. - -**/ -UINT16 -EFIAPI -NetIp6PseudoHeadChecksum ( - IN EFI_IPv6_ADDRESS *Src, - IN EFI_IPv6_ADDRESS *Dst, - IN UINT8 NextHeader, - IN UINT32 Len - ) -{ - NET_IP6_PSEUDO_HDR Hdr; - - // - // Zero the memory to relieve align problems - // - ZeroMem (&Hdr, sizeof (Hdr)); - - IP6_COPY_ADDRESS (&Hdr.SrcIp, Src); - IP6_COPY_ADDRESS (&Hdr.DstIp, Dst); - - Hdr.NextHeader = NextHeader; - Hdr.Len = HTONL (Len); - - return NetblockChecksum ((UINT8 *) &Hdr, sizeof (Hdr)); -} - -/** - The function frees the net buffer which allocated by the IP protocol. It releases - only the net buffer and doesn't call the external free function. - - This function should be called after finishing the process of mIpSec->ProcessExt() - for outbound traffic. The (EFI_IPSEC2_PROTOCOL)->ProcessExt() allocates a new - buffer for the ESP, so there needs a function to free the old net buffer. - - @param[in] Nbuf The network buffer to be freed. - -**/ -VOID -NetIpSecNetbufFree ( - NET_BUF *Nbuf - ) -{ - NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); - ASSERT (Nbuf->RefCnt > 0); - - Nbuf->RefCnt--; - - if (Nbuf->RefCnt == 0) { - - // - // Update Vector only when NBuf is to be released. That is, - // all the sharing of Nbuf increse Vector's RefCnt by one - // - NET_CHECK_SIGNATURE (Nbuf->Vector, NET_VECTOR_SIGNATURE); - ASSERT (Nbuf->Vector->RefCnt > 0); - - Nbuf->Vector->RefCnt--; - - if (Nbuf->Vector->RefCnt > 0) { - return; - } - - // - // If NET_VECTOR_OWN_FIRST is set, release the first block since it is - // allocated by us - // - if ((Nbuf->Vector->Flag & NET_VECTOR_OWN_FIRST) != 0) { - FreePool (Nbuf->Vector->Block[0].Bulk); - } - FreePool (Nbuf->Vector); - FreePool (Nbuf); - } -} - diff --git a/MdeModulePkg/Library/DxeTcpIoLib/DxeTcpIoLib.c b/MdeModulePkg/Library/DxeTcpIoLib/DxeTcpIoLib.c deleted file mode 100644 index 341295d0b7..0000000000 --- a/MdeModulePkg/Library/DxeTcpIoLib/DxeTcpIoLib.c +++ /dev/null @@ -1,1011 +0,0 @@ -/** @file - This library is used to share code between UEFI network stack modules. - It provides the helper routines to access TCP service. - -Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include - -#include -#include -#include -#include -#include -#include - -/** - The common notify function associated with various TcpIo events. - - @param[in] Event The event signaled. - @param[in] Context The context. - -**/ -VOID -EFIAPI -TcpIoCommonNotify ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - if ((Event == NULL) || (Context == NULL)) { - return ; - } - - *((BOOLEAN *) Context) = TRUE; -} - -/** - The internal function for delay configuring TCP6 when IP6 driver is still in DAD. - - @param[in] Tcp6 The EFI_TCP6_PROTOCOL protocol instance. - @param[in] Tcp6ConfigData The Tcp6 configuration data. - - @retval EFI_SUCCESS The operational settings successfully - completed. - @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - @retval Others Failed to finish the operation. - -**/ -EFI_STATUS -TcpIoGetMapping ( - IN EFI_TCP6_PROTOCOL *Tcp6, - IN EFI_TCP6_CONFIG_DATA *Tcp6ConfigData - ) -{ - EFI_STATUS Status; - EFI_EVENT Event; - - if ((Tcp6 == NULL) || (Tcp6ConfigData == NULL)) { - return EFI_INVALID_PARAMETER; - } - - Event = NULL; - Status = gBS->CreateEvent ( - EVT_TIMER, - TPL_CALLBACK, - NULL, - NULL, - &Event - ); - if (EFI_ERROR (Status)) { - goto ON_EXIT; - } - - Status = gBS->SetTimer ( - Event, - TimerRelative, - TCP_GET_MAPPING_TIMEOUT - ); - - if (EFI_ERROR (Status)) { - goto ON_EXIT; - } - - while (EFI_ERROR (gBS->CheckEvent (Event))) { - - Tcp6->Poll (Tcp6); - - Status = Tcp6->Configure (Tcp6, Tcp6ConfigData); - - if (!EFI_ERROR (Status)) { - break; - } - } - -ON_EXIT: - - if (Event != NULL) { - gBS->CloseEvent (Event); - } - - return Status; -} - -/** - Create a TCP socket with the specified configuration data. - - @param[in] Image The handle of the driver image. - @param[in] Controller The handle of the controller. - @param[in] TcpVersion The version of Tcp, TCP_VERSION_4 or TCP_VERSION_6. - @param[in] ConfigData The Tcp configuration data. - @param[out] TcpIo The TcpIo. - - @retval EFI_SUCCESS The TCP socket is created and configured. - @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - @retval EFI_UNSUPPORTED One or more of the control options are not - supported in the implementation. - @retval EFI_OUT_OF_RESOURCES Failed to allocate memory. - @retval Others Failed to create the TCP socket or configure it. - -**/ -EFI_STATUS -EFIAPI -TcpIoCreateSocket ( - IN EFI_HANDLE Image, - IN EFI_HANDLE Controller, - IN UINT8 TcpVersion, - IN TCP_IO_CONFIG_DATA *ConfigData, - OUT TCP_IO *TcpIo - ) -{ - EFI_STATUS Status; - EFI_EVENT Event; - EFI_GUID *ServiceBindingGuid; - EFI_GUID *ProtocolGuid; - VOID **Interface; - EFI_TCP4_OPTION ControlOption; - EFI_TCP4_CONFIG_DATA Tcp4ConfigData; - EFI_TCP4_ACCESS_POINT *AccessPoint4; - EFI_TCP4_PROTOCOL *Tcp4; - EFI_TCP6_CONFIG_DATA Tcp6ConfigData; - EFI_TCP6_ACCESS_POINT *AccessPoint6; - EFI_TCP6_PROTOCOL *Tcp6; - EFI_TCP4_RECEIVE_DATA *RxData; - - if ((Image == NULL) || (Controller == NULL) || (ConfigData == NULL) || (TcpIo == NULL)) { - return EFI_INVALID_PARAMETER; - } - - Tcp4 = NULL; - Tcp6 = NULL; - - ZeroMem (TcpIo, sizeof (TCP_IO)); - - if (TcpVersion == TCP_VERSION_4) { - ServiceBindingGuid = &gEfiTcp4ServiceBindingProtocolGuid; - ProtocolGuid = &gEfiTcp4ProtocolGuid; - Interface = (VOID **) (&TcpIo->Tcp.Tcp4); - } else if (TcpVersion == TCP_VERSION_6) { - ServiceBindingGuid = &gEfiTcp6ServiceBindingProtocolGuid; - ProtocolGuid = &gEfiTcp6ProtocolGuid; - Interface = (VOID **) (&TcpIo->Tcp.Tcp6); - } else { - return EFI_UNSUPPORTED; - } - - TcpIo->TcpVersion = TcpVersion; - - // - // Create the TCP child instance and get the TCP protocol. - // - Status = NetLibCreateServiceChild ( - Controller, - Image, - ServiceBindingGuid, - &TcpIo->Handle - ); - if (EFI_ERROR (Status)) { - return Status; - } - - Status = gBS->OpenProtocol ( - TcpIo->Handle, - ProtocolGuid, - Interface, - Image, - Controller, - EFI_OPEN_PROTOCOL_BY_DRIVER - ); - if (EFI_ERROR (Status) || (*Interface == NULL)) { - goto ON_ERROR; - } - - if (TcpVersion == TCP_VERSION_4) { - Tcp4 = TcpIo->Tcp.Tcp4; - } else { - Tcp6 = TcpIo->Tcp.Tcp6; - } - - TcpIo->Image = Image; - TcpIo->Controller = Controller; - - // - // Set the configuration parameters. - // - ControlOption.ReceiveBufferSize = 0x200000; - ControlOption.SendBufferSize = 0x200000; - ControlOption.MaxSynBackLog = 0; - ControlOption.ConnectionTimeout = 0; - ControlOption.DataRetries = 6; - ControlOption.FinTimeout = 0; - ControlOption.TimeWaitTimeout = 0; - ControlOption.KeepAliveProbes = 4; - ControlOption.KeepAliveTime = 0; - ControlOption.KeepAliveInterval = 0; - ControlOption.EnableNagle = FALSE; - ControlOption.EnableTimeStamp = FALSE; - ControlOption.EnableWindowScaling = TRUE; - ControlOption.EnableSelectiveAck = FALSE; - ControlOption.EnablePathMtuDiscovery = FALSE; - - if (TcpVersion == TCP_VERSION_4) { - Tcp4ConfigData.TypeOfService = 8; - Tcp4ConfigData.TimeToLive = 255; - Tcp4ConfigData.ControlOption = &ControlOption; - - AccessPoint4 = &Tcp4ConfigData.AccessPoint; - - ZeroMem (AccessPoint4, sizeof (EFI_TCP4_ACCESS_POINT)); - AccessPoint4->StationPort = ConfigData->Tcp4IoConfigData.StationPort; - AccessPoint4->RemotePort = ConfigData->Tcp4IoConfigData.RemotePort; - AccessPoint4->ActiveFlag = ConfigData->Tcp4IoConfigData.ActiveFlag; - - CopyMem ( - &AccessPoint4->StationAddress, - &ConfigData->Tcp4IoConfigData.LocalIp, - sizeof (EFI_IPv4_ADDRESS) - ); - CopyMem ( - &AccessPoint4->SubnetMask, - &ConfigData->Tcp4IoConfigData.SubnetMask, - sizeof (EFI_IPv4_ADDRESS) - ); - CopyMem ( - &AccessPoint4->RemoteAddress, - &ConfigData->Tcp4IoConfigData.RemoteIp, - sizeof (EFI_IPv4_ADDRESS) - ); - - ASSERT (Tcp4 != NULL); - - // - // Configure the TCP4 protocol. - // - Status = Tcp4->Configure (Tcp4, &Tcp4ConfigData); - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - if (!EFI_IP4_EQUAL (&ConfigData->Tcp4IoConfigData.Gateway, &mZeroIp4Addr)) { - // - // The gateway is not zero. Add the default route manually. - // - Status = Tcp4->Routes ( - Tcp4, - FALSE, - &mZeroIp4Addr, - &mZeroIp4Addr, - &ConfigData->Tcp4IoConfigData.Gateway - ); - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - } - } else { - Tcp6ConfigData.TrafficClass = 0; - Tcp6ConfigData.HopLimit = 255; - Tcp6ConfigData.ControlOption = (EFI_TCP6_OPTION *) &ControlOption; - - AccessPoint6 = &Tcp6ConfigData.AccessPoint; - - ZeroMem (AccessPoint6, sizeof (EFI_TCP6_ACCESS_POINT)); - AccessPoint6->StationPort = ConfigData->Tcp6IoConfigData.StationPort; - AccessPoint6->RemotePort = ConfigData->Tcp6IoConfigData.RemotePort; - AccessPoint6->ActiveFlag = ConfigData->Tcp6IoConfigData.ActiveFlag; - - IP6_COPY_ADDRESS (&AccessPoint6->RemoteAddress, &ConfigData->Tcp6IoConfigData.RemoteIp); - - - ASSERT (Tcp6 != NULL); - // - // Configure the TCP6 protocol. - // - Status = Tcp6->Configure (Tcp6, &Tcp6ConfigData); - if (Status == EFI_NO_MAPPING) { - Status = TcpIoGetMapping (Tcp6, &Tcp6ConfigData); - } - - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - } - - // - // Create events for variuos asynchronous operations. - // - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, - TcpIoCommonNotify, - &TcpIo->IsConnDone, - &Event - ); - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - TcpIo->ConnToken.Tcp4Token.CompletionToken.Event = Event; - - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, - TcpIoCommonNotify, - &TcpIo->IsListenDone, - &Event - ); - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - TcpIo->ListenToken.Tcp4Token.CompletionToken.Event = Event; - - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, - TcpIoCommonNotify, - &TcpIo->IsTxDone, - &Event - ); - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - TcpIo->TxToken.Tcp4Token.CompletionToken.Event = Event; - - - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, - TcpIoCommonNotify, - &TcpIo->IsRxDone, - &Event - ); - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - TcpIo->RxToken.Tcp4Token.CompletionToken.Event = Event; - - RxData = (EFI_TCP4_RECEIVE_DATA *) AllocateZeroPool (sizeof (EFI_TCP4_RECEIVE_DATA)); - if (RxData == NULL) { - Status = EFI_OUT_OF_RESOURCES; - goto ON_ERROR; - } - - TcpIo->RxToken.Tcp4Token.Packet.RxData = RxData; - - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, - TcpIoCommonNotify, - &TcpIo->IsCloseDone, - &Event - ); - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - TcpIo->CloseToken.Tcp4Token.CompletionToken.Event = Event; - - - return EFI_SUCCESS; - -ON_ERROR: - - TcpIoDestroySocket (TcpIo); - - return Status; -} - -/** - Destroy the socket. - - @param[in] TcpIo The TcpIo which wraps the socket to be destroyed. - -**/ -VOID -EFIAPI -TcpIoDestroySocket ( - IN TCP_IO *TcpIo - ) -{ - EFI_EVENT Event; - EFI_TCP4_PROTOCOL *Tcp4; - EFI_TCP6_PROTOCOL *Tcp6; - UINT8 TcpVersion; - EFI_GUID *ServiceBindingGuid; - EFI_GUID *ProtocolGuid; - EFI_HANDLE ChildHandle; - - if (TcpIo == NULL) { - return ; - } - - TcpVersion = TcpIo->TcpVersion; - - if ((TcpVersion != TCP_VERSION_4) && (TcpVersion != TCP_VERSION_6)) { - return ; - } - - Event = TcpIo->ConnToken.Tcp4Token.CompletionToken.Event; - - if (Event != NULL) { - gBS->CloseEvent (Event); - } - - Event = TcpIo->ListenToken.Tcp4Token.CompletionToken.Event; - - if (Event != NULL) { - gBS->CloseEvent (Event); - } - - Event = TcpIo->TxToken.Tcp4Token.CompletionToken.Event; - - if (Event != NULL) { - gBS->CloseEvent (Event); - } - - Event = TcpIo->RxToken.Tcp4Token.CompletionToken.Event; - - if (Event != NULL) { - gBS->CloseEvent (Event); - } - - Event = TcpIo->CloseToken.Tcp4Token.CompletionToken.Event; - - if (Event != NULL) { - gBS->CloseEvent (Event); - } - - if (TcpIo->RxToken.Tcp4Token.Packet.RxData != NULL) { - FreePool (TcpIo->RxToken.Tcp4Token.Packet.RxData); - } - - Tcp4 = NULL; - Tcp6 = NULL; - - - if (TcpVersion == TCP_VERSION_4) { - ServiceBindingGuid = &gEfiTcp4ServiceBindingProtocolGuid; - ProtocolGuid = &gEfiTcp4ProtocolGuid; - Tcp4 = TcpIo->Tcp.Tcp4; - if (Tcp4 != NULL) { - Tcp4->Configure (Tcp4, NULL); - } - } else { - ServiceBindingGuid = &gEfiTcp6ServiceBindingProtocolGuid; - ProtocolGuid = &gEfiTcp6ProtocolGuid; - Tcp6 = TcpIo->Tcp.Tcp6; - if (Tcp6 != NULL) { - Tcp6->Configure (Tcp6, NULL); - } - } - - if ((Tcp4 != NULL) || (Tcp6 != NULL)) { - - gBS->CloseProtocol ( - TcpIo->Handle, - ProtocolGuid, - TcpIo->Image, - TcpIo->Controller - ); - } - - ChildHandle = NULL; - - if (TcpIo->IsListenDone) { - if (TcpVersion == TCP_VERSION_4) { - Tcp4 = TcpIo->NewTcp.Tcp4; - if (Tcp4 != NULL) { - Tcp4->Configure (Tcp4, NULL); - ChildHandle = TcpIo->ListenToken.Tcp4Token.NewChildHandle; - } - } else { - Tcp6 = TcpIo->NewTcp.Tcp6; - if (Tcp6 != NULL) { - Tcp6->Configure (Tcp6, NULL); - ChildHandle = TcpIo->ListenToken.Tcp6Token.NewChildHandle; - } - } - - if (ChildHandle != NULL) { - - gBS->CloseProtocol ( - ChildHandle, - ProtocolGuid, - TcpIo->Image, - TcpIo->Controller - ); - } - } - - NetLibDestroyServiceChild ( - TcpIo->Controller, - TcpIo->Image, - ServiceBindingGuid, - TcpIo->Handle - ); -} - -/** - Connect to the other endpoint of the TCP socket. - - @param[in, out] TcpIo The TcpIo wrapping the TCP socket. - @param[in] Timeout The time to wait for connection done. Set to NULL for infinite wait. - - @retval EFI_SUCCESS Connect to the other endpoint of the TCP socket - successfully. - @retval EFI_TIMEOUT Failed to connect to the other endpoint of the - TCP socket in the specified time period. - @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - @retval EFI_UNSUPPORTED One or more of the control options are not - supported in the implementation. - @retval Others Other errors as indicated. - -**/ -EFI_STATUS -EFIAPI -TcpIoConnect ( - IN OUT TCP_IO *TcpIo, - IN EFI_EVENT Timeout OPTIONAL - ) -{ - EFI_TCP4_PROTOCOL *Tcp4; - EFI_TCP6_PROTOCOL *Tcp6; - EFI_STATUS Status; - - if ((TcpIo == NULL) || (TcpIo->Tcp.Tcp4 == NULL)) { - return EFI_INVALID_PARAMETER; - } - - TcpIo->IsConnDone = FALSE; - - Tcp4 = NULL; - Tcp6 = NULL; - - if (TcpIo->TcpVersion == TCP_VERSION_4) { - Tcp4 = TcpIo->Tcp.Tcp4; - Status = Tcp4->Connect (Tcp4, &TcpIo->ConnToken.Tcp4Token); - } else if (TcpIo->TcpVersion == TCP_VERSION_6) { - Tcp6 = TcpIo->Tcp.Tcp6; - Status = Tcp6->Connect (Tcp6, &TcpIo->ConnToken.Tcp6Token); - } else { - return EFI_UNSUPPORTED; - } - - if (EFI_ERROR (Status)) { - return Status; - } - - while (!TcpIo->IsConnDone && ((Timeout == NULL) || EFI_ERROR (gBS->CheckEvent (Timeout)))) { - if (TcpIo->TcpVersion == TCP_VERSION_4) { - Tcp4->Poll (Tcp4); - } else { - Tcp6->Poll (Tcp6); - } - } - - if (!TcpIo->IsConnDone) { - if (TcpIo->TcpVersion == TCP_VERSION_4) { - Tcp4->Cancel (Tcp4, &TcpIo->ConnToken.Tcp4Token.CompletionToken); - } else { - Tcp6->Cancel (Tcp6, &TcpIo->ConnToken.Tcp6Token.CompletionToken); - } - Status = EFI_TIMEOUT; - } else { - Status = TcpIo->ConnToken.Tcp4Token.CompletionToken.Status; - } - - return Status; -} - -/** - Accept the incomding request from the other endpoint of the TCP socket. - - @param[in, out] TcpIo The TcpIo wrapping the TCP socket. - @param[in] Timeout The time to wait for connection done. Set to NULL for infinite wait. - - - @retval EFI_SUCCESS Connect to the other endpoint of the TCP socket - successfully. - @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - @retval EFI_UNSUPPORTED One or more of the control options are not - supported in the implementation. - - @retval EFI_TIMEOUT Failed to connect to the other endpoint of the - TCP socket in the specified time period. - @retval Others Other errors as indicated. - -**/ -EFI_STATUS -EFIAPI -TcpIoAccept ( - IN OUT TCP_IO *TcpIo, - IN EFI_EVENT Timeout OPTIONAL - ) -{ - EFI_STATUS Status; - EFI_GUID *ProtocolGuid; - EFI_TCP4_PROTOCOL *Tcp4; - EFI_TCP6_PROTOCOL *Tcp6; - - if ((TcpIo == NULL) || (TcpIo->Tcp.Tcp4 == NULL)) { - return EFI_INVALID_PARAMETER; - } - - TcpIo->IsListenDone = FALSE; - - Tcp4 = NULL; - Tcp6 = NULL; - - if (TcpIo->TcpVersion == TCP_VERSION_4) { - Tcp4 = TcpIo->Tcp.Tcp4; - Status = Tcp4->Accept (Tcp4, &TcpIo->ListenToken.Tcp4Token); - } else if (TcpIo->TcpVersion == TCP_VERSION_6) { - Tcp6 = TcpIo->Tcp.Tcp6; - Status = Tcp6->Accept (Tcp6, &TcpIo->ListenToken.Tcp6Token); - } else { - return EFI_UNSUPPORTED; - } - - if (EFI_ERROR (Status)) { - return Status; - } - - while (!TcpIo->IsListenDone && ((Timeout == NULL) || EFI_ERROR (gBS->CheckEvent (Timeout)))) { - if (TcpIo->TcpVersion == TCP_VERSION_4) { - Tcp4->Poll (Tcp4); - } else { - Tcp6->Poll (Tcp6); - } - } - - if (!TcpIo->IsListenDone) { - if (TcpIo->TcpVersion == TCP_VERSION_4) { - Tcp4->Cancel (Tcp4, &TcpIo->ListenToken.Tcp4Token.CompletionToken); - } else { - Tcp6->Cancel (Tcp6, &TcpIo->ListenToken.Tcp6Token.CompletionToken); - } - Status = EFI_TIMEOUT; - } else { - Status = TcpIo->ListenToken.Tcp4Token.CompletionToken.Status; - } - - // - // The new TCP instance handle created for the established connection is - // in ListenToken. - // - if (!EFI_ERROR (Status)) { - if (TcpIo->TcpVersion == TCP_VERSION_4) { - ProtocolGuid = &gEfiTcp4ProtocolGuid; - } else { - ProtocolGuid = &gEfiTcp6ProtocolGuid; - } - - Status = gBS->OpenProtocol ( - TcpIo->ListenToken.Tcp4Token.NewChildHandle, - ProtocolGuid, - (VOID **) (&TcpIo->NewTcp.Tcp4), - TcpIo->Image, - TcpIo->Controller, - EFI_OPEN_PROTOCOL_BY_DRIVER - ); - - } - - return Status; -} - -/** - Reset the socket. - - @param[in, out] TcpIo The TcpIo wrapping the TCP socket. - -**/ -VOID -EFIAPI -TcpIoReset ( - IN OUT TCP_IO *TcpIo - ) -{ - EFI_TCP4_PROTOCOL *Tcp4; - EFI_TCP6_PROTOCOL *Tcp6; - EFI_STATUS Status; - - if ((TcpIo == NULL) || (TcpIo->Tcp.Tcp4 == NULL)) { - return ; - } - - TcpIo->IsCloseDone = FALSE; - Tcp4 = NULL; - Tcp6 = NULL; - - if (TcpIo->TcpVersion == TCP_VERSION_4) { - TcpIo->CloseToken.Tcp4Token.AbortOnClose = TRUE; - Tcp4 = TcpIo->Tcp.Tcp4; - Status = Tcp4->Close (Tcp4, &TcpIo->CloseToken.Tcp4Token); - } else if (TcpIo->TcpVersion == TCP_VERSION_6) { - TcpIo->CloseToken.Tcp6Token.AbortOnClose = TRUE; - Tcp6 = TcpIo->Tcp.Tcp6; - Status = Tcp6->Close (Tcp6, &TcpIo->CloseToken.Tcp6Token); - } else { - return ; - } - - if (EFI_ERROR (Status)) { - return ; - } - - while (!TcpIo->IsCloseDone) { - if (TcpIo->TcpVersion == TCP_VERSION_4) { - Tcp4->Poll (Tcp4); - } else { - Tcp6->Poll (Tcp6); - } - } -} - - -/** - Transmit the Packet to the other endpoint of the socket. - - @param[in] TcpIo The TcpIo wrapping the TCP socket. - @param[in] Packet The packet to transmit. - - @retval EFI_SUCCESS The packet is trasmitted. - @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - @retval EFI_UNSUPPORTED One or more of the control options are not - supported in the implementation. - @retval EFI_OUT_OF_RESOURCES Failed to allocate memory. - @retval EFI_DEVICE_ERROR An unexpected network or system error occurred. - @retval Others Other errors as indicated. - -**/ -EFI_STATUS -EFIAPI -TcpIoTransmit ( - IN TCP_IO *TcpIo, - IN NET_BUF *Packet - ) -{ - EFI_STATUS Status; - VOID *Data; - EFI_TCP4_PROTOCOL *Tcp4; - EFI_TCP6_PROTOCOL *Tcp6; - UINTN Size; - - if ((TcpIo == NULL) || (TcpIo->Tcp.Tcp4 == NULL)|| (Packet == NULL)) { - return EFI_INVALID_PARAMETER; - } - - if (TcpIo->TcpVersion == TCP_VERSION_4) { - - Size = sizeof (EFI_TCP4_TRANSMIT_DATA) + - (Packet->BlockOpNum - 1) * sizeof (EFI_TCP4_FRAGMENT_DATA); - } else if (TcpIo->TcpVersion == TCP_VERSION_6) { - Size = sizeof (EFI_TCP6_TRANSMIT_DATA) + - (Packet->BlockOpNum - 1) * sizeof (EFI_TCP6_FRAGMENT_DATA); - } else { - return EFI_UNSUPPORTED; - } - - Data = AllocatePool (Size); - if (Data == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - ((EFI_TCP4_TRANSMIT_DATA *) Data)->Push = TRUE; - ((EFI_TCP4_TRANSMIT_DATA *) Data)->Urgent = FALSE; - ((EFI_TCP4_TRANSMIT_DATA *) Data)->DataLength = Packet->TotalSize; - - // - // Build the fragment table. - // - ((EFI_TCP4_TRANSMIT_DATA *) Data)->FragmentCount = Packet->BlockOpNum; - - NetbufBuildExt ( - Packet, - (NET_FRAGMENT *) &((EFI_TCP4_TRANSMIT_DATA *) Data)->FragmentTable[0], - &((EFI_TCP4_TRANSMIT_DATA *) Data)->FragmentCount - ); - - Tcp4 = NULL; - Tcp6 = NULL; - Status = EFI_DEVICE_ERROR; - - // - // Trasnmit the packet. - // - if (TcpIo->TcpVersion == TCP_VERSION_4) { - TcpIo->TxToken.Tcp4Token.Packet.TxData = (EFI_TCP4_TRANSMIT_DATA *) Data; - Tcp4 = TcpIo->Tcp.Tcp4; - if (TcpIo->IsListenDone) { - Tcp4 = TcpIo->NewTcp.Tcp4; - } - - if (Tcp4 == NULL) { - goto ON_EXIT; - } - - Status = Tcp4->Transmit (Tcp4, &TcpIo->TxToken.Tcp4Token); - } else { - TcpIo->TxToken.Tcp6Token.Packet.TxData = (EFI_TCP6_TRANSMIT_DATA *) Data; - Tcp6 = TcpIo->Tcp.Tcp6; - if (TcpIo->IsListenDone) { - Tcp6 = TcpIo->NewTcp.Tcp6; - } - - if (Tcp6 == NULL) { - goto ON_EXIT; - } - - Status = Tcp6->Transmit (Tcp6, &TcpIo->TxToken.Tcp6Token); - } - - if (EFI_ERROR (Status)) { - goto ON_EXIT; - } - - while (!TcpIo->IsTxDone) { - if (TcpIo->TcpVersion == TCP_VERSION_4) { - Tcp4->Poll (Tcp4); - } else { - Tcp6->Poll (Tcp6); - } - } - - TcpIo->IsTxDone = FALSE; - Status = TcpIo->TxToken.Tcp4Token.CompletionToken.Status; - -ON_EXIT: - - FreePool (Data); - - return Status; -} - -/** - Receive data from the socket. - - @param[in, out] TcpIo The TcpIo which wraps the socket to be destroyed. - @param[in] Packet The buffer to hold the data copy from the socket rx buffer. - @param[in] AsyncMode Is this receive asyncronous or not. - @param[in] Timeout The time to wait for receiving the amount of data the Packet - can hold. Set to NULL for infinite wait. - - @retval EFI_SUCCESS The required amount of data is received from the socket. - @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - @retval EFI_DEVICE_ERROR An unexpected network or system error occurred. - @retval EFI_OUT_OF_RESOURCES Failed to allocate momery. - @retval EFI_TIMEOUT Failed to receive the required amount of data in the - specified time period. - @retval Others Other errors as indicated. - -**/ -EFI_STATUS -EFIAPI -TcpIoReceive ( - IN OUT TCP_IO *TcpIo, - IN NET_BUF *Packet, - IN BOOLEAN AsyncMode, - IN EFI_EVENT Timeout OPTIONAL - ) -{ - EFI_TCP4_PROTOCOL *Tcp4; - EFI_TCP6_PROTOCOL *Tcp6; - EFI_TCP4_RECEIVE_DATA *RxData; - EFI_STATUS Status; - NET_FRAGMENT *Fragment; - UINT32 FragmentCount; - UINT32 CurrentFragment; - - if ((TcpIo == NULL) || (TcpIo->Tcp.Tcp4 == NULL)|| (Packet == NULL)) { - return EFI_INVALID_PARAMETER; - } - - RxData = TcpIo->RxToken.Tcp4Token.Packet.RxData; - if (RxData == NULL) { - return EFI_INVALID_PARAMETER; - } - - Tcp4 = NULL; - Tcp6 = NULL; - - if (TcpIo->TcpVersion == TCP_VERSION_4) { - Tcp4 = TcpIo->Tcp.Tcp4; - - if (TcpIo->IsListenDone) { - Tcp4 = TcpIo->NewTcp.Tcp4; - } - - if (Tcp4 == NULL) { - return EFI_DEVICE_ERROR; - } - - } else if (TcpIo->TcpVersion == TCP_VERSION_6) { - Tcp6 = TcpIo->Tcp.Tcp6; - - if (TcpIo->IsListenDone) { - Tcp6 = TcpIo->NewTcp.Tcp6; - } - - if (Tcp6 == NULL) { - return EFI_DEVICE_ERROR; - } - - } else { - return EFI_UNSUPPORTED; - } - - FragmentCount = Packet->BlockOpNum; - Fragment = AllocatePool (FragmentCount * sizeof (NET_FRAGMENT)); - if (Fragment == NULL) { - Status = EFI_OUT_OF_RESOURCES; - goto ON_EXIT; - } - // - // Build the fragment table. - // - NetbufBuildExt (Packet, Fragment, &FragmentCount); - - RxData->FragmentCount = 1; - CurrentFragment = 0; - Status = EFI_SUCCESS; - - while (CurrentFragment < FragmentCount) { - RxData->DataLength = Fragment[CurrentFragment].Len; - RxData->FragmentTable[0].FragmentLength = Fragment[CurrentFragment].Len; - RxData->FragmentTable[0].FragmentBuffer = Fragment[CurrentFragment].Bulk; - - if (TcpIo->TcpVersion == TCP_VERSION_4) { - Status = Tcp4->Receive (Tcp4, &TcpIo->RxToken.Tcp4Token); - } else { - Status = Tcp6->Receive (Tcp6, &TcpIo->RxToken.Tcp6Token); - } - - if (EFI_ERROR (Status)) { - goto ON_EXIT; - } - - while (!TcpIo->IsRxDone && ((Timeout == NULL) || EFI_ERROR (gBS->CheckEvent (Timeout)))) { - // - // Poll until some data is received or an error occurs. - // - if (TcpIo->TcpVersion == TCP_VERSION_4) { - Tcp4->Poll (Tcp4); - } else { - Tcp6->Poll (Tcp6); - } - } - - if (!TcpIo->IsRxDone) { - // - // Timeout occurs, cancel the receive request. - // - if (TcpIo->TcpVersion == TCP_VERSION_4) { - Tcp4->Cancel (Tcp4, &TcpIo->RxToken.Tcp4Token.CompletionToken); - } else { - Tcp6->Cancel (Tcp6, &TcpIo->RxToken.Tcp6Token.CompletionToken); - } - - Status = EFI_TIMEOUT; - goto ON_EXIT; - } else { - TcpIo->IsRxDone = FALSE; - } - - Status = TcpIo->RxToken.Tcp4Token.CompletionToken.Status; - - if (EFI_ERROR (Status)) { - goto ON_EXIT; - } - - Fragment[CurrentFragment].Len -= RxData->FragmentTable[0].FragmentLength; - if (Fragment[CurrentFragment].Len == 0) { - CurrentFragment++; - } else { - Fragment[CurrentFragment].Bulk += RxData->FragmentTable[0].FragmentLength; - } - } - -ON_EXIT: - - if (Fragment != NULL) { - FreePool (Fragment); - } - - return Status; -} diff --git a/MdeModulePkg/Library/DxeTcpIoLib/DxeTcpIoLib.inf b/MdeModulePkg/Library/DxeTcpIoLib/DxeTcpIoLib.inf deleted file mode 100644 index 66873d7837..0000000000 --- a/MdeModulePkg/Library/DxeTcpIoLib/DxeTcpIoLib.inf +++ /dev/null @@ -1,44 +0,0 @@ -## @file -# This library instance provides TCP services by EFI TCPv4/TCPv6 Protocols. -# -# Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.
-# SPDX-License-Identifier: BSD-2-Clause-Patent -# -## - - -[Defines] - INF_VERSION = 0x00010005 - BASE_NAME = DxeTcpIoLib - MODULE_UNI_FILE = DxeTcpIoLib.uni - FILE_GUID = D4608509-1AB0-4cc7-827A-AB8E1E7BD3E6 - MODULE_TYPE = DXE_DRIVER - VERSION_STRING = 1.0 - LIBRARY_CLASS = TcpIoLib|DXE_CORE DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER - -# -# The following information is for reference only and not required by the build tools. -# -# VALID_ARCHITECTURES = IA32 X64 EBC -# - -[Sources] - DxeTcpIoLib.c - -[Packages] - MdePkg/MdePkg.dec - MdeModulePkg/MdeModulePkg.dec - - -[LibraryClasses] - BaseLib - DebugLib - UefiBootServicesTableLib - MemoryAllocationLib - BaseMemoryLib - -[Protocols] - gEfiTcp4ServiceBindingProtocolGuid ## SOMETIMES_CONSUMES - gEfiTcp4ProtocolGuid ## SOMETIMES_CONSUMES - gEfiTcp6ServiceBindingProtocolGuid ## SOMETIMES_CONSUMES - gEfiTcp6ProtocolGuid ## SOMETIMES_CONSUMES diff --git a/MdeModulePkg/Library/DxeTcpIoLib/DxeTcpIoLib.uni b/MdeModulePkg/Library/DxeTcpIoLib/DxeTcpIoLib.uni deleted file mode 100644 index 79ad484a65..0000000000 --- a/MdeModulePkg/Library/DxeTcpIoLib/DxeTcpIoLib.uni +++ /dev/null @@ -1,16 +0,0 @@ -// /** @file -// This library instance provides TCP services by EFI TCPv4/TCPv6 Protocols. -// -// This library instance provides TCP services by EFI TCPv4/TCPv6 Protocols. -// -// Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.
-// -// SPDX-License-Identifier: BSD-2-Clause-Patent -// -// **/ - - -#string STR_MODULE_ABSTRACT #language en-US "Provides TCP services by EFI TCPv4/TCPv6 Protocols" - -#string STR_MODULE_DESCRIPTION #language en-US "This library instance provides TCP services by EFI TCPv4/TCPv6 Protocols." - diff --git a/MdeModulePkg/Library/DxeUdpIoLib/DxeUdpIoLib.c b/MdeModulePkg/Library/DxeUdpIoLib/DxeUdpIoLib.c deleted file mode 100644 index 155cb31049..0000000000 --- a/MdeModulePkg/Library/DxeUdpIoLib/DxeUdpIoLib.c +++ /dev/null @@ -1,1119 +0,0 @@ -/** @file - Help functions to access UDP service, it is used by both the DHCP and MTFTP. - -Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent -**/ - -#include - -#include -#include - -#include -#include -#include -#include -#include -#include -#include - - -/** - Free a UDP_TX_TOKEN. The TX event is closed. - - @param[in] TxToken The UDP_TX_TOKEN to release. - -**/ -VOID -UdpIoFreeTxToken ( - IN UDP_TX_TOKEN *TxToken - ) -{ - - if (TxToken->UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { - gBS->CloseEvent (TxToken->Token.Udp4.Event); - } else if (TxToken->UdpIo->UdpVersion == UDP_IO_UDP6_VERSION) { - gBS->CloseEvent (TxToken->Token.Udp6.Event); - } else { - ASSERT (FALSE); - } - - FreePool (TxToken); -} - -/** - Free a UDP_RX_TOKEN. The RX event is closed. - - @param[in] RxToken The UDP_RX_TOKEN to release. - -**/ -VOID -UdpIoFreeRxToken ( - IN UDP_RX_TOKEN *RxToken - ) -{ - if (RxToken->UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { - gBS->CloseEvent (RxToken->Token.Udp4.Event); - } else if (RxToken->UdpIo->UdpVersion == UDP_IO_UDP6_VERSION) { - gBS->CloseEvent (RxToken->Token.Udp6.Event); - } else { - ASSERT (FALSE); - } - - FreePool (RxToken); -} - -/** - The callback function when the packet is sent by UDP. - - It will remove the packet from the local list then call - the packet owner's callback function set by UdpIoSendDatagram. - - @param[in] Context The UDP TX Token. - -**/ -VOID -EFIAPI -UdpIoOnDgramSentDpc ( - IN VOID *Context - ) -{ - UDP_TX_TOKEN *TxToken; - - TxToken = (UDP_TX_TOKEN *) Context; - ASSERT (TxToken->Signature == UDP_IO_TX_SIGNATURE); - ASSERT ((TxToken->UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) || - (TxToken->UdpIo->UdpVersion == UDP_IO_UDP6_VERSION)); - - RemoveEntryList (&TxToken->Link); - - if (TxToken->UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { - TxToken->CallBack (TxToken->Packet, NULL, TxToken->Token.Udp4.Status, TxToken->Context); - } else { - TxToken->CallBack (TxToken->Packet, NULL, TxToken->Token.Udp6.Status, TxToken->Context); - } - - UdpIoFreeTxToken (TxToken); -} - -/** - Request UdpIoOnDgramSentDpc as a DPC at TPL_CALLBACK. - - @param[in] Event The event signaled. - @param[in] Context The UDP TX Token. - -**/ -VOID -EFIAPI -UdpIoOnDgramSent ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - // - // Request UdpIoOnDgramSentDpc as a DPC at TPL_CALLBACK - // - QueueDpc (TPL_CALLBACK, UdpIoOnDgramSentDpc, Context); -} - -/** - Recycle the received UDP data. - - @param[in] Context The UDP_RX_TOKEN. - -**/ -VOID -EFIAPI -UdpIoRecycleDgram ( - IN VOID *Context - ) -{ - UDP_RX_TOKEN *RxToken; - - RxToken = (UDP_RX_TOKEN *) Context; - - if (RxToken->UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { - gBS->SignalEvent (RxToken->Token.Udp4.Packet.RxData->RecycleSignal); - } else if (RxToken->UdpIo->UdpVersion == UDP_IO_UDP6_VERSION) { - gBS->SignalEvent (RxToken->Token.Udp6.Packet.RxData->RecycleSignal); - } else { - ASSERT (FALSE); - } - - UdpIoFreeRxToken (RxToken); -} - -/** - The event handle for UDP receive request. - - It will build a NET_BUF from the recieved UDP data, then deliver it - to the receiver. - - @param[in] Context The UDP RX token. - -**/ -VOID -EFIAPI -UdpIoOnDgramRcvdDpc ( - IN VOID *Context - ) -{ - EFI_STATUS Status; - VOID *Token; - VOID *RxData; - VOID *Session; - UDP_RX_TOKEN *RxToken; - UDP_END_POINT EndPoint; - NET_BUF *Netbuf; - - RxToken = (UDP_RX_TOKEN *) Context; - - ZeroMem (&EndPoint, sizeof(UDP_END_POINT)); - - ASSERT ((RxToken->Signature == UDP_IO_RX_SIGNATURE) && - (RxToken == RxToken->UdpIo->RecvRequest)); - - ASSERT ((RxToken->UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) || - (RxToken->UdpIo->UdpVersion == UDP_IO_UDP6_VERSION)); - - // - // Clear the receive request first in case that the caller - // wants to restart the receive in the callback. - // - RxToken->UdpIo->RecvRequest = NULL; - - if (RxToken->UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { - Token = &RxToken->Token.Udp4; - RxData = ((EFI_UDP4_COMPLETION_TOKEN *) Token)->Packet.RxData; - Status = ((EFI_UDP4_COMPLETION_TOKEN *) Token)->Status; - } else { - Token = &RxToken->Token.Udp6; - RxData = ((EFI_UDP6_COMPLETION_TOKEN *) Token)->Packet.RxData; - Status = ((EFI_UDP6_COMPLETION_TOKEN *) Token)->Status; - } - - if (EFI_ERROR (Status) || RxData == NULL) { - if (Status != EFI_ABORTED) { - // - // Invoke the CallBack only if the reception is not actively aborted. - // - RxToken->CallBack (NULL, NULL, Status, RxToken->Context); - } - - UdpIoFreeRxToken (RxToken); - return; - } - - // - // Build a NET_BUF from the UDP receive data, then deliver it up. - // - if (RxToken->UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { - if (((EFI_UDP4_RECEIVE_DATA *) RxData)->DataLength == 0) { - // - // Discard zero length data payload packet. - // - goto Resume; - } - - Netbuf = NetbufFromExt ( - (NET_FRAGMENT *)((EFI_UDP4_RECEIVE_DATA *) RxData)->FragmentTable, - ((EFI_UDP4_RECEIVE_DATA *) RxData)->FragmentCount, - 0, - (UINT32) RxToken->HeadLen, - UdpIoRecycleDgram, - RxToken - ); - - if (Netbuf == NULL) { - gBS->SignalEvent (((EFI_UDP4_RECEIVE_DATA *) RxData)->RecycleSignal); - RxToken->CallBack (NULL, NULL, EFI_OUT_OF_RESOURCES, RxToken->Context); - - UdpIoFreeRxToken (RxToken); - return; - } - - Session = &((EFI_UDP4_RECEIVE_DATA *) RxData)->UdpSession; - EndPoint.LocalPort = ((EFI_UDP4_SESSION_DATA *) Session)->DestinationPort; - EndPoint.RemotePort = ((EFI_UDP4_SESSION_DATA *) Session)->SourcePort; - - CopyMem ( - &EndPoint.LocalAddr, - &((EFI_UDP4_SESSION_DATA *) Session)->DestinationAddress, - sizeof (EFI_IPv4_ADDRESS) - ); - - CopyMem ( - &EndPoint.RemoteAddr, - &((EFI_UDP4_SESSION_DATA *) Session)->SourceAddress, - sizeof (EFI_IPv4_ADDRESS) - ); - - EndPoint.LocalAddr.Addr[0] = NTOHL (EndPoint.LocalAddr.Addr[0]); - EndPoint.RemoteAddr.Addr[0] = NTOHL (EndPoint.RemoteAddr.Addr[0]); - } else { - if (((EFI_UDP6_RECEIVE_DATA *) RxData)->DataLength == 0) { - // - // Discard zero length data payload packet. - // - goto Resume; - } - - Netbuf = NetbufFromExt ( - (NET_FRAGMENT *)((EFI_UDP6_RECEIVE_DATA *) RxData)->FragmentTable, - ((EFI_UDP6_RECEIVE_DATA *) RxData)->FragmentCount, - 0, - (UINT32) RxToken->HeadLen, - UdpIoRecycleDgram, - RxToken - ); - - if (Netbuf == NULL) { - gBS->SignalEvent (((EFI_UDP6_RECEIVE_DATA *) RxData)->RecycleSignal); - RxToken->CallBack (NULL, NULL, EFI_OUT_OF_RESOURCES, RxToken->Context); - - UdpIoFreeRxToken (RxToken); - return; - } - - Session = &((EFI_UDP6_RECEIVE_DATA *) RxData)->UdpSession; - EndPoint.LocalPort = ((EFI_UDP6_SESSION_DATA *) Session)->DestinationPort; - EndPoint.RemotePort = ((EFI_UDP6_SESSION_DATA *) Session)->SourcePort; - - CopyMem ( - &EndPoint.LocalAddr, - &((EFI_UDP6_SESSION_DATA *) Session)->DestinationAddress, - sizeof (EFI_IPv6_ADDRESS) - ); - - CopyMem ( - &EndPoint.RemoteAddr, - &((EFI_UDP6_SESSION_DATA *) Session)->SourceAddress, - sizeof (EFI_IPv6_ADDRESS) - ); - - Ip6Swap128 (&EndPoint.LocalAddr.v6); - Ip6Swap128 (&EndPoint.RemoteAddr.v6); - } - - RxToken->CallBack (Netbuf, &EndPoint, EFI_SUCCESS, RxToken->Context); - return; - -Resume: - if (RxToken->UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { - gBS->SignalEvent (((EFI_UDP4_RECEIVE_DATA *) RxData)->RecycleSignal); - RxToken->UdpIo->Protocol.Udp4->Receive (RxToken->UdpIo->Protocol.Udp4, &RxToken->Token.Udp4); - } else { - gBS->SignalEvent (((EFI_UDP6_RECEIVE_DATA *) RxData)->RecycleSignal); - RxToken->UdpIo->Protocol.Udp6->Receive (RxToken->UdpIo->Protocol.Udp6, &RxToken->Token.Udp6); - } -} - -/** - Request UdpIoOnDgramRcvdDpc() as a DPC at TPL_CALLBACK. - - @param[in] Event The UDP receive request event. - @param[in] Context The UDP RX token. - -**/ -VOID -EFIAPI -UdpIoOnDgramRcvd ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - // - // Request UdpIoOnDgramRcvdDpc as a DPC at TPL_CALLBACK - // - QueueDpc (TPL_CALLBACK, UdpIoOnDgramRcvdDpc, Context); -} - -/** - Create a UDP_RX_TOKEN to wrap the request. - - @param[in] UdpIo The UdpIo to receive packets from. - @param[in] CallBack The function to call when receive finished. - @param[in] Context The opaque parameter to the CallBack. - @param[in] HeadLen The head length to reserver for the packet. - - @return The Wrapped request or NULL if failed to allocate resources or some errors happened. - -**/ -UDP_RX_TOKEN * -UdpIoCreateRxToken ( - IN UDP_IO *UdpIo, - IN UDP_IO_CALLBACK CallBack, - IN VOID *Context, - IN UINT32 HeadLen - ) -{ - UDP_RX_TOKEN *Token; - EFI_STATUS Status; - - ASSERT ((UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) || - (UdpIo->UdpVersion == UDP_IO_UDP6_VERSION)); - - Token = AllocatePool (sizeof (UDP_RX_TOKEN)); - - if (Token == NULL) { - return NULL; - } - - Token->Signature = UDP_IO_RX_SIGNATURE; - Token->UdpIo = UdpIo; - Token->CallBack = CallBack; - Token->Context = Context; - Token->HeadLen = HeadLen; - - if (UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { - - Token->Token.Udp4.Status = EFI_NOT_READY; - Token->Token.Udp4.Packet.RxData = NULL; - - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, - UdpIoOnDgramRcvd, - Token, - &Token->Token.Udp4.Event - ); - } else { - - Token->Token.Udp6.Status = EFI_NOT_READY; - Token->Token.Udp6.Packet.RxData = NULL; - - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, - UdpIoOnDgramRcvd, - Token, - &Token->Token.Udp6.Event - ); - } - - - if (EFI_ERROR (Status)) { - FreePool (Token); - return NULL; - } - - return Token; -} - -/** - Wrap a transmit request into a new created UDP_TX_TOKEN. - - If Packet is NULL, then ASSERT(). - If Udp version is not UDP_IO_UDP4_VERSION or UDP_IO_UDP6_VERSION, then ASSERT(). - - @param[in] UdpIo The UdpIo to send packet to. - @param[in] Packet The user's packet. - @param[in] EndPoint The local and remote access point. - @param[in] Gateway The overrided next hop. - @param[in] CallBack The function to call when transmission completed. - @param[in] Context The opaque parameter to the call back. - - @return The wrapped transmission request or NULL if failed to allocate resources - or for some errors. - -**/ -UDP_TX_TOKEN * -UdpIoCreateTxToken ( - IN UDP_IO *UdpIo, - IN NET_BUF *Packet, - IN UDP_END_POINT *EndPoint OPTIONAL, - IN EFI_IP_ADDRESS *Gateway OPTIONAL, - IN UDP_IO_CALLBACK CallBack, - IN VOID *Context - ) -{ - UDP_TX_TOKEN *TxToken; - VOID *Token; - VOID *Data; - EFI_STATUS Status; - UINT32 Count; - UINTN Size; - IP4_ADDR Ip; - - ASSERT (Packet != NULL); - ASSERT ((UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) || - (UdpIo->UdpVersion == UDP_IO_UDP6_VERSION)); - - if (UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { - Size = sizeof (UDP_TX_TOKEN) + sizeof (EFI_UDP4_FRAGMENT_DATA) * (Packet->BlockOpNum - 1); - } else { - Size = sizeof (UDP_TX_TOKEN) + sizeof (EFI_UDP6_FRAGMENT_DATA) * (Packet->BlockOpNum - 1); - } - - TxToken = AllocatePool (Size); - - if (TxToken == NULL) { - return NULL; - } - - TxToken->Signature = UDP_IO_TX_SIGNATURE; - InitializeListHead (&TxToken->Link); - - TxToken->UdpIo = UdpIo; - TxToken->CallBack = CallBack; - TxToken->Packet = Packet; - TxToken->Context = Context; - - Token = &(TxToken->Token); - Count = Packet->BlockOpNum; - - if (UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { - - ((EFI_UDP4_COMPLETION_TOKEN *) Token)->Status = EFI_NOT_READY; - - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, - UdpIoOnDgramSent, - TxToken, - &((EFI_UDP4_COMPLETION_TOKEN *) Token)->Event - ); - - if (EFI_ERROR (Status)) { - FreePool (TxToken); - return NULL; - } - - Data = &(TxToken->Data.Udp4); - ((EFI_UDP4_COMPLETION_TOKEN *) Token)->Packet.TxData = Data; - - ((EFI_UDP4_TRANSMIT_DATA *) Data)->UdpSessionData = NULL; - ((EFI_UDP4_TRANSMIT_DATA *) Data)->GatewayAddress = NULL; - ((EFI_UDP4_TRANSMIT_DATA *) Data)->DataLength = Packet->TotalSize; - - NetbufBuildExt ( - Packet, - (NET_FRAGMENT *)((EFI_UDP4_TRANSMIT_DATA *) Data)->FragmentTable, - &Count - ); - - ((EFI_UDP4_TRANSMIT_DATA *) Data)->FragmentCount = Count; - - if (EndPoint != NULL) { - Ip = HTONL (EndPoint->LocalAddr.Addr[0]); - CopyMem ( - &TxToken->Session.Udp4.SourceAddress, - &Ip, - sizeof (EFI_IPv4_ADDRESS) - ); - - Ip = HTONL (EndPoint->RemoteAddr.Addr[0]); - CopyMem ( - &TxToken->Session.Udp4.DestinationAddress, - &Ip, - sizeof (EFI_IPv4_ADDRESS) - ); - - TxToken->Session.Udp4.SourcePort = EndPoint->LocalPort; - TxToken->Session.Udp4.DestinationPort = EndPoint->RemotePort; - ((EFI_UDP4_TRANSMIT_DATA *) Data)->UdpSessionData = &(TxToken->Session.Udp4); - } - - if (Gateway != NULL && (Gateway->Addr[0] != 0)) { - Ip = HTONL (Gateway->Addr[0]); - CopyMem (&TxToken->Gateway, &Ip, sizeof (EFI_IPv4_ADDRESS)); - ((EFI_UDP4_TRANSMIT_DATA *) Data)->GatewayAddress = &TxToken->Gateway; - } - - } else { - - ((EFI_UDP6_COMPLETION_TOKEN *) Token)->Status = EFI_NOT_READY; - - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, - UdpIoOnDgramSent, - TxToken, - &((EFI_UDP6_COMPLETION_TOKEN *) Token)->Event - ); - - if (EFI_ERROR (Status)) { - FreePool (TxToken); - return NULL; - } - - Data = &(TxToken->Data.Udp6); - ((EFI_UDP6_COMPLETION_TOKEN *) Token)->Packet.TxData = Data; - ((EFI_UDP6_TRANSMIT_DATA *) Data)->UdpSessionData = NULL; - ((EFI_UDP6_TRANSMIT_DATA *) Data)->DataLength = Packet->TotalSize; - - NetbufBuildExt ( - Packet, - (NET_FRAGMENT *)((EFI_UDP6_TRANSMIT_DATA *) Data)->FragmentTable, - &Count - ); - - ((EFI_UDP6_TRANSMIT_DATA *) Data)->FragmentCount = Count; - - if (EndPoint != NULL) { - CopyMem ( - &TxToken->Session.Udp6.SourceAddress, - &EndPoint->LocalAddr.v6, - sizeof(EFI_IPv6_ADDRESS) - ); - - CopyMem ( - &TxToken->Session.Udp6.DestinationAddress, - &EndPoint->RemoteAddr.v6, - sizeof(EFI_IPv6_ADDRESS) - ); - - TxToken->Session.Udp6.SourcePort = EndPoint->LocalPort; - TxToken->Session.Udp6.DestinationPort = EndPoint->RemotePort; - ((EFI_UDP6_TRANSMIT_DATA *) Data)->UdpSessionData = &(TxToken->Session.Udp6); - } - } - - return TxToken; -} - -/** - Creates a UDP_IO to access the UDP service. It creates and configures - a UDP child. - - If Configure is NULL, then ASSERT(). - If Udp version is not UDP_IO_UDP4_VERSION or UDP_IO_UDP6_VERSION, then ASSERT(). - - It locates the UDP service binding prototype on the Controller parameter - uses the UDP service binding prototype to create a UDP child (also known as - a UDP instance) configures the UDP child by calling Configure function prototype. - Any failures in creating or configuring the UDP child return NULL for failure. - - @param[in] Controller The controller that has the UDP service binding. - protocol installed. - @param[in] ImageHandle The image handle for the driver. - @param[in] Configure The function to configure the created UDP child. - @param[in] UdpVersion The UDP protocol version, UDP4 or UDP6. - @param[in] Context The opaque parameter for the Configure funtion. - - @return Newly-created UDP_IO or NULL if failed. - -**/ -UDP_IO * -EFIAPI -UdpIoCreateIo ( - IN EFI_HANDLE Controller, - IN EFI_HANDLE ImageHandle, - IN UDP_IO_CONFIG Configure, - IN UINT8 UdpVersion, - IN VOID *Context - ) -{ - UDP_IO *UdpIo; - EFI_STATUS Status; - - ASSERT (Configure != NULL); - ASSERT ((UdpVersion == UDP_IO_UDP4_VERSION) || (UdpVersion == UDP_IO_UDP6_VERSION)); - - UdpIo = AllocatePool (sizeof (UDP_IO)); - - if (UdpIo == NULL) { - return NULL; - } - - UdpIo->UdpVersion = UdpVersion; - UdpIo->Signature = UDP_IO_SIGNATURE; - InitializeListHead (&UdpIo->Link); - UdpIo->RefCnt = 1; - - UdpIo->Controller = Controller; - UdpIo->Image = ImageHandle; - - InitializeListHead (&UdpIo->SentDatagram); - UdpIo->RecvRequest = NULL; - UdpIo->UdpHandle = NULL; - - if (UdpVersion == UDP_IO_UDP4_VERSION) { - // - // Create a UDP child then open and configure it - // - Status = NetLibCreateServiceChild ( - Controller, - ImageHandle, - &gEfiUdp4ServiceBindingProtocolGuid, - &UdpIo->UdpHandle - ); - - if (EFI_ERROR (Status)) { - goto FREE_MEM; - } - - Status = gBS->OpenProtocol ( - UdpIo->UdpHandle, - &gEfiUdp4ProtocolGuid, - (VOID **) &UdpIo->Protocol.Udp4, - ImageHandle, - Controller, - EFI_OPEN_PROTOCOL_BY_DRIVER - ); - - if (EFI_ERROR (Status)) { - goto FREE_CHILD; - } - - if (EFI_ERROR (Configure (UdpIo, Context))) { - goto CLOSE_PROTOCOL; - } - - Status = UdpIo->Protocol.Udp4->GetModeData ( - UdpIo->Protocol.Udp4, - NULL, - NULL, - NULL, - &UdpIo->SnpMode - ); - - if (EFI_ERROR (Status)) { - goto CLOSE_PROTOCOL; - } - - } else { - - Status = NetLibCreateServiceChild ( - Controller, - ImageHandle, - &gEfiUdp6ServiceBindingProtocolGuid, - &UdpIo->UdpHandle - ); - - if (EFI_ERROR (Status)) { - goto FREE_MEM; - } - - Status = gBS->OpenProtocol ( - UdpIo->UdpHandle, - &gEfiUdp6ProtocolGuid, - (VOID **) &UdpIo->Protocol.Udp6, - ImageHandle, - Controller, - EFI_OPEN_PROTOCOL_BY_DRIVER - ); - - if (EFI_ERROR (Status)) { - goto FREE_CHILD; - } - - if (EFI_ERROR (Configure (UdpIo, Context))) { - goto CLOSE_PROTOCOL; - } - - Status = UdpIo->Protocol.Udp6->GetModeData ( - UdpIo->Protocol.Udp6, - NULL, - NULL, - NULL, - &UdpIo->SnpMode - ); - - if (EFI_ERROR (Status)) { - goto CLOSE_PROTOCOL; - } - } - - return UdpIo; - -CLOSE_PROTOCOL: - if (UdpVersion == UDP_IO_UDP4_VERSION) { - gBS->CloseProtocol (UdpIo->UdpHandle, &gEfiUdp4ProtocolGuid, ImageHandle, Controller); - } else { - gBS->CloseProtocol (UdpIo->UdpHandle, &gEfiUdp6ProtocolGuid, ImageHandle, Controller); - } - -FREE_CHILD: - if (UdpVersion == UDP_IO_UDP4_VERSION) { - NetLibDestroyServiceChild ( - Controller, - ImageHandle, - &gEfiUdp4ServiceBindingProtocolGuid, - UdpIo->UdpHandle - ); - } else { - NetLibDestroyServiceChild ( - Controller, - ImageHandle, - &gEfiUdp6ServiceBindingProtocolGuid, - UdpIo->UdpHandle - ); - } - -FREE_MEM: - FreePool (UdpIo); - return NULL; -} - -/** - Cancel all the sent datagram that pass the selection criteria of ToCancel. - - If ToCancel is NULL, all the datagrams are cancelled. - If Udp version is not UDP_IO_UDP4_VERSION or UDP_IO_UDP6_VERSION, then ASSERT(). - - @param[in] UdpIo The UDP_IO to cancel packet. - @param[in] IoStatus The IoStatus to return to the packet owners. - @param[in] ToCancel The select funtion to test whether to cancel this - packet or not. - @param[in] Context The opaque parameter to the ToCancel. - -**/ -VOID -EFIAPI -UdpIoCancelDgrams ( - IN UDP_IO *UdpIo, - IN EFI_STATUS IoStatus, - IN UDP_IO_TO_CANCEL ToCancel, OPTIONAL - IN VOID *Context OPTIONAL - ) -{ - LIST_ENTRY *Entry; - LIST_ENTRY *Next; - UDP_TX_TOKEN *TxToken; - - ASSERT ((UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) || - (UdpIo->UdpVersion == UDP_IO_UDP6_VERSION)); - - NET_LIST_FOR_EACH_SAFE (Entry, Next, &UdpIo->SentDatagram) { - TxToken = NET_LIST_USER_STRUCT (Entry, UDP_TX_TOKEN, Link); - - if ((ToCancel == NULL) || (ToCancel (TxToken, Context))) { - - if (UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { - UdpIo->Protocol.Udp4->Cancel (UdpIo->Protocol.Udp4, &TxToken->Token.Udp4); - } else { - UdpIo->Protocol.Udp6->Cancel (UdpIo->Protocol.Udp6, &TxToken->Token.Udp6); - } - } - } -} - -/** - Free the UDP_IO and all its related resources. - - If Udp version is not UDP_IO_UDP4_VERSION or UDP_IO_UDP6_VERSION, then ASSERT(). - - The function will cancel all sent datagram and receive request. - - @param[in] UdpIo The UDP_IO to free. - - @retval EFI_SUCCESS The UDP_IO is freed. - @retval Others Failed to free UDP_IO. - -**/ -EFI_STATUS -EFIAPI -UdpIoFreeIo ( - IN UDP_IO *UdpIo - ) -{ - EFI_STATUS Status; - UDP_RX_TOKEN *RxToken; - - ASSERT ((UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) || - (UdpIo->UdpVersion == UDP_IO_UDP6_VERSION)); - - // - // Cancel all the sent datagram and receive requests. The - // callbacks of transmit requests are executed to allow the - // caller to release the resource. The callback of receive - // request are NOT executed. This is because it is most - // likely that the current user of the UDP IO port is closing - // itself. - // - UdpIoCancelDgrams (UdpIo, EFI_ABORTED, NULL, NULL); - - if (UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { - - if ((RxToken = UdpIo->RecvRequest) != NULL) { - Status = UdpIo->Protocol.Udp4->Cancel (UdpIo->Protocol.Udp4, &RxToken->Token.Udp4); - if (EFI_ERROR (Status)) { - return Status; - } - } - - // - // Close then destroy the Udp4 child - // - Status = gBS->CloseProtocol ( - UdpIo->UdpHandle, - &gEfiUdp4ProtocolGuid, - UdpIo->Image, - UdpIo->Controller - ); - if (EFI_ERROR (Status)) { - return Status; - } - - Status = NetLibDestroyServiceChild ( - UdpIo->Controller, - UdpIo->Image, - &gEfiUdp4ServiceBindingProtocolGuid, - UdpIo->UdpHandle - ); - if (EFI_ERROR (Status)) { - return Status; - } - - } else { - - if ((RxToken = UdpIo->RecvRequest) != NULL) { - Status = UdpIo->Protocol.Udp6->Cancel (UdpIo->Protocol.Udp6, &RxToken->Token.Udp6); - if (EFI_ERROR (Status)) { - return Status; - } - } - - // - // Close then destroy the Udp6 child - // - Status = gBS->CloseProtocol ( - UdpIo->UdpHandle, - &gEfiUdp6ProtocolGuid, - UdpIo->Image, - UdpIo->Controller - ); - if (EFI_ERROR (Status)) { - return Status; - } - - Status = NetLibDestroyServiceChild ( - UdpIo->Controller, - UdpIo->Image, - &gEfiUdp6ServiceBindingProtocolGuid, - UdpIo->UdpHandle - ); - if (EFI_ERROR (Status)) { - return Status; - } - } - - if (!IsListEmpty(&UdpIo->Link)) { - RemoveEntryList (&UdpIo->Link); - } - - FreePool (UdpIo); - return EFI_SUCCESS; -} - - -/** - Clean up the UDP_IO without freeing it. The function is called when - user wants to re-use the UDP_IO later. - - If Udp version is not UDP_IO_UDP4_VERSION or UDP_IO_UDP6_VERSION, then ASSERT(). - - It will release all the transmitted datagrams and receive request. It will - also configure NULL for the UDP instance. - - @param[in] UdpIo The UDP_IO to clean up. - -**/ -VOID -EFIAPI -UdpIoCleanIo ( - IN UDP_IO *UdpIo - ) -{ - UDP_RX_TOKEN *RxToken; - - ASSERT ((UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) || - (UdpIo->UdpVersion == UDP_IO_UDP6_VERSION)); - - // - // Cancel all the sent datagram and receive requests. - // - UdpIoCancelDgrams (UdpIo, EFI_ABORTED, NULL, NULL); - - if (UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { - if ((RxToken = UdpIo->RecvRequest) != NULL) { - UdpIo->Protocol.Udp4->Cancel (UdpIo->Protocol.Udp4, &RxToken->Token.Udp4); - } - - UdpIo->Protocol.Udp4->Configure (UdpIo->Protocol.Udp4, NULL); - - } else { - if ((RxToken = UdpIo->RecvRequest) != NULL) { - UdpIo->Protocol.Udp6->Cancel (UdpIo->Protocol.Udp6, &RxToken->Token.Udp6); - } - - UdpIo->Protocol.Udp6->Configure (UdpIo->Protocol.Udp6, NULL); - } -} - -/** - Send a packet through the UDP_IO. - - If Udp version is not UDP_IO_UDP4_VERSION or UDP_IO_UDP6_VERSION, then ASSERT(). - - The packet will be wrapped in UDP_TX_TOKEN. Function Callback will be called - when the packet is sent. The optional parameter EndPoint overrides the default - address pair if specified. - - @param[in] UdpIo The UDP_IO to send the packet through. - @param[in] Packet The packet to send. - @param[in] EndPoint The local and remote access point. Override the - default address pair set during configuration. - @param[in] Gateway The gateway to use. - @param[in] CallBack The function being called when packet is - transmitted or failed. - @param[in] Context The opaque parameter passed to CallBack. - - @retval EFI_OUT_OF_RESOURCES Failed to allocate resource for the packet. - @retval EFI_SUCCESS The packet is successfully delivered to UDP for - transmission. - -**/ -EFI_STATUS -EFIAPI -UdpIoSendDatagram ( - IN UDP_IO *UdpIo, - IN NET_BUF *Packet, - IN UDP_END_POINT *EndPoint OPTIONAL, - IN EFI_IP_ADDRESS *Gateway OPTIONAL, - IN UDP_IO_CALLBACK CallBack, - IN VOID *Context - ) -{ - UDP_TX_TOKEN *TxToken; - EFI_STATUS Status; - - ASSERT ((UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) || - (UdpIo->UdpVersion == UDP_IO_UDP6_VERSION)); - - TxToken = UdpIoCreateTxToken (UdpIo, Packet, EndPoint, Gateway, CallBack, Context); - - if (TxToken == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - // - // Insert the tx token into SendDatagram list before transmitting it. Remove - // it from the list if the returned status is not EFI_SUCCESS. - // - InsertHeadList (&UdpIo->SentDatagram, &TxToken->Link); - - if (UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { - Status = UdpIo->Protocol.Udp4->Transmit (UdpIo->Protocol.Udp4, &TxToken->Token.Udp4); - } else { - Status = UdpIo->Protocol.Udp6->Transmit (UdpIo->Protocol.Udp6, &TxToken->Token.Udp6); - } - - if (EFI_ERROR (Status)) { - RemoveEntryList (&TxToken->Link); - UdpIoFreeTxToken (TxToken); - return Status; - } - - return EFI_SUCCESS; -} - - -/** - The select function to cancel a single sent datagram. - - @param[in] Token The UDP_TX_TOKEN to test against - @param[in] Context The NET_BUF of the sent datagram - - @retval TRUE The packet is to be cancelled. - @retval FALSE The packet is not to be cancelled. -**/ -BOOLEAN -EFIAPI -UdpIoCancelSingleDgram ( - IN UDP_TX_TOKEN *Token, - IN VOID *Context - ) -{ - NET_BUF *Packet; - - Packet = (NET_BUF *) Context; - - if (Token->Packet == Packet) { - return TRUE; - } - - return FALSE; -} - -/** - Cancel a single sent datagram. - - @param[in] UdpIo The UDP_IO to cancel the packet from - @param[in] Packet The packet to cancel - -**/ -VOID -EFIAPI -UdpIoCancelSentDatagram ( - IN UDP_IO *UdpIo, - IN NET_BUF *Packet - ) -{ - UdpIoCancelDgrams (UdpIo, EFI_ABORTED, UdpIoCancelSingleDgram, Packet); -} - -/** - Issue a receive request to the UDP_IO. - - If Udp version is not UDP_IO_UDP4_VERSION or UDP_IO_UDP6_VERSION, then ASSERT(). - - This function is called when upper-layer needs packet from UDP for processing. - Only one receive request is acceptable at a time so a common usage model is - to invoke this function inside its Callback function when the former packet - is processed. - - @param[in] UdpIo The UDP_IO to receive the packet from. - @param[in] CallBack The call back function to execute when the packet - is received. - @param[in] Context The opaque context passed to Callback. - @param[in] HeadLen The length of the upper-layer's protocol header. - - @retval EFI_ALREADY_STARTED There is already a pending receive request. Only - one receive request is supported at a time. - @retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources. - @retval EFI_SUCCESS The receive request is issued successfully. - @retval EFI_UNSUPPORTED The UDP version in UDP_IO is not supported. - -**/ -EFI_STATUS -EFIAPI -UdpIoRecvDatagram ( - IN UDP_IO *UdpIo, - IN UDP_IO_CALLBACK CallBack, - IN VOID *Context, - IN UINT32 HeadLen - ) -{ - UDP_RX_TOKEN *RxToken; - EFI_STATUS Status; - - ASSERT ((UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) || - (UdpIo->UdpVersion == UDP_IO_UDP6_VERSION)); - - if (UdpIo->RecvRequest != NULL) { - return EFI_ALREADY_STARTED; - } - - RxToken = UdpIoCreateRxToken (UdpIo, CallBack, Context, HeadLen); - - if (RxToken == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - UdpIo->RecvRequest = RxToken; - if (UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { - Status = UdpIo->Protocol.Udp4->Receive (UdpIo->Protocol.Udp4, &RxToken->Token.Udp4); - } else { - Status = UdpIo->Protocol.Udp6->Receive (UdpIo->Protocol.Udp6, &RxToken->Token.Udp6); - } - - if (EFI_ERROR (Status)) { - UdpIo->RecvRequest = NULL; - UdpIoFreeRxToken (RxToken); - } - - return Status; -} diff --git a/MdeModulePkg/Library/DxeUdpIoLib/DxeUdpIoLib.inf b/MdeModulePkg/Library/DxeUdpIoLib/DxeUdpIoLib.inf deleted file mode 100644 index 483c2cda02..0000000000 --- a/MdeModulePkg/Library/DxeUdpIoLib/DxeUdpIoLib.inf +++ /dev/null @@ -1,46 +0,0 @@ -## @file -# This library instance provides UDP services by consuming EFI UDPv4/UDPv6 Protocols. -# -# Copyright (c) 2008 - 2018, Intel Corporation. All rights reserved.
-# SPDX-License-Identifier: BSD-2-Clause-Patent -# -## - - -[Defines] - INF_VERSION = 0x00010005 - BASE_NAME = DxeUpdIoLib - MODULE_UNI_FILE = DxeUpdIoLib.uni - FILE_GUID = 7E615AA1-41EE-49d4-B7E9-1D7A60AA5C8D - MODULE_TYPE = DXE_DRIVER - VERSION_STRING = 1.0 - LIBRARY_CLASS = UdpIoLib|DXE_CORE DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER - -# -# The following information is for reference only and not required by the build tools. -# -# VALID_ARCHITECTURES = IA32 X64 EBC -# - -[Sources] - DxeUdpIoLib.c - -[Packages] - MdePkg/MdePkg.dec - MdeModulePkg/MdeModulePkg.dec - - -[LibraryClasses] - BaseLib - DebugLib - UefiBootServicesTableLib - MemoryAllocationLib - BaseMemoryLib - DpcLib - -[Protocols] - gEfiUdp4ServiceBindingProtocolGuid ## SOMETIMES_CONSUMES - gEfiUdp4ProtocolGuid ## SOMETIMES_CONSUMES - gEfiUdp6ServiceBindingProtocolGuid ## SOMETIMES_CONSUMES - gEfiUdp6ProtocolGuid ## SOMETIMES_CONSUMES - diff --git a/MdeModulePkg/Library/DxeUdpIoLib/DxeUpdIoLib.uni b/MdeModulePkg/Library/DxeUdpIoLib/DxeUpdIoLib.uni deleted file mode 100644 index bc94905995..0000000000 --- a/MdeModulePkg/Library/DxeUdpIoLib/DxeUpdIoLib.uni +++ /dev/null @@ -1,16 +0,0 @@ -// /** @file -// This library instance provides UDP services by consuming EFI UDPv4/UDPv6 Protocols. -// -// This library instance provides UDP services by consuming EFI UDPv4/UDPv6 Protocols. -// -// Copyright (c) 2008 - 2018, Intel Corporation. All rights reserved.
-// -// SPDX-License-Identifier: BSD-2-Clause-Patent -// -// **/ - - -#string STR_MODULE_ABSTRACT #language en-US "Provides UDP services by consuming EFI UDPv4/UDPv6 Protocols" - -#string STR_MODULE_DESCRIPTION #language en-US "This library instance provides UDP services by consuming EFI UDPv4/UDPv6 Protocols." - diff --git a/MdeModulePkg/Universal/Network/ArpDxe/ArpDriver.c b/MdeModulePkg/Universal/Network/ArpDxe/ArpDriver.c deleted file mode 100644 index 632d691d75..0000000000 --- a/MdeModulePkg/Universal/Network/ArpDxe/ArpDriver.c +++ /dev/null @@ -1,811 +0,0 @@ -/** @file - ARP driver functions. - -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "ArpDriver.h" -#include "ArpImpl.h" - -EFI_DRIVER_BINDING_PROTOCOL gArpDriverBinding = { - ArpDriverBindingSupported, - ArpDriverBindingStart, - ArpDriverBindingStop, - 0xa, - NULL, - NULL -}; - - -/** - Create and initialize the arp service context data. - - @param[in] ImageHandle The image handle representing the loaded driver - image. - @param[in] ControllerHandle The controller handle the driver binds to. - @param[in, out] ArpService Pointer to the buffer containing the arp service - context data. - - @retval EFI_SUCCESS The arp service context is initialized. - - @retval EFI_UNSUPPORTED The underlayer Snp mode type is not ethernet. - Failed to initialize the service context. - @retval other Failed to initialize the arp service context. - -**/ -EFI_STATUS -ArpCreateService ( - IN EFI_HANDLE ImageHandle, - IN EFI_HANDLE ControllerHandle, - IN OUT ARP_SERVICE_DATA *ArpService - ) -{ - EFI_STATUS Status; - - ASSERT (ArpService != NULL); - - ArpService->Signature = ARP_SERVICE_DATA_SIGNATURE; - - // - // Init the lists. - // - InitializeListHead (&ArpService->ChildrenList); - InitializeListHead (&ArpService->PendingRequestTable); - InitializeListHead (&ArpService->DeniedCacheTable); - InitializeListHead (&ArpService->ResolvedCacheTable); - - // - // Init the servicebinding protocol members. - // - ArpService->ServiceBinding.CreateChild = ArpServiceBindingCreateChild; - ArpService->ServiceBinding.DestroyChild = ArpServiceBindingDestroyChild; - - // - // Save the handles. - // - ArpService->ImageHandle = ImageHandle; - ArpService->ControllerHandle = ControllerHandle; - - // - // Create a MNP child instance. - // - Status = NetLibCreateServiceChild ( - ControllerHandle, - ImageHandle, - &gEfiManagedNetworkServiceBindingProtocolGuid, - &ArpService->MnpChildHandle - ); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Open the MNP protocol. - // - Status = gBS->OpenProtocol ( - ArpService->MnpChildHandle, - &gEfiManagedNetworkProtocolGuid, - (VOID **)&ArpService->Mnp, - ImageHandle, - ControllerHandle, - EFI_OPEN_PROTOCOL_BY_DRIVER - ); - if (EFI_ERROR (Status)) { - goto ERROR_EXIT; - } - - // - // Get the underlayer Snp mode data. - // - Status = ArpService->Mnp->GetModeData (ArpService->Mnp, NULL, &ArpService->SnpMode); - if ((Status != EFI_NOT_STARTED) && EFI_ERROR (Status)) { - goto ERROR_EXIT; - } - - if (ArpService->SnpMode.IfType != NET_IFTYPE_ETHERNET) { - // - // Only support the ethernet. - // - Status = EFI_UNSUPPORTED; - goto ERROR_EXIT; - } - - // - // Set the Mnp config parameters. - // - ArpService->MnpConfigData.ReceivedQueueTimeoutValue = 0; - ArpService->MnpConfigData.TransmitQueueTimeoutValue = 0; - ArpService->MnpConfigData.ProtocolTypeFilter = ARP_ETHER_PROTO_TYPE; - ArpService->MnpConfigData.EnableUnicastReceive = TRUE; - ArpService->MnpConfigData.EnableMulticastReceive = FALSE; - ArpService->MnpConfigData.EnableBroadcastReceive = TRUE; - ArpService->MnpConfigData.EnablePromiscuousReceive = FALSE; - ArpService->MnpConfigData.FlushQueuesOnReset = TRUE; - ArpService->MnpConfigData.EnableReceiveTimestamps = FALSE; - ArpService->MnpConfigData.DisableBackgroundPolling = FALSE; - - // - // Configure the Mnp child. - // - Status = ArpService->Mnp->Configure (ArpService->Mnp, &ArpService->MnpConfigData); - if (EFI_ERROR (Status)) { - goto ERROR_EXIT; - } - - // - // Create the event used in the RxToken. - // - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, - ArpOnFrameRcvd, - ArpService, - &ArpService->RxToken.Event - ); - if (EFI_ERROR (Status)) { - goto ERROR_EXIT; - } - - // - // Create the Arp heartbeat timer. - // - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL | EVT_TIMER, - TPL_CALLBACK, - ArpTimerHandler, - ArpService, - &ArpService->PeriodicTimer - ); - if (EFI_ERROR (Status)) { - goto ERROR_EXIT; - } - - // - // Start the heartbeat timer. - // - Status = gBS->SetTimer ( - ArpService->PeriodicTimer, - TimerPeriodic, - ARP_PERIODIC_TIMER_INTERVAL - ); - -ERROR_EXIT: - - return Status; -} - - -/** - Clean the arp service context data. - - @param[in, out] ArpService Pointer to the buffer containing the arp service - context data. - - @return None. - -**/ -VOID -ArpCleanService ( - IN OUT ARP_SERVICE_DATA *ArpService - ) -{ - NET_CHECK_SIGNATURE (ArpService, ARP_SERVICE_DATA_SIGNATURE); - - if (ArpService->PeriodicTimer != NULL) { - // - // Cancle and close the PeriodicTimer. - // - gBS->SetTimer (ArpService->PeriodicTimer, TimerCancel, 0); - gBS->CloseEvent (ArpService->PeriodicTimer); - } - - if (ArpService->RxToken.Event != NULL) { - // - // Cancle the RxToken and close the event in the RxToken. - // - ArpService->Mnp->Cancel (ArpService->Mnp, NULL); - gBS->CloseEvent (ArpService->RxToken.Event); - } - - if (ArpService->Mnp != NULL) { - // - // Reset the Mnp child and close the Mnp protocol. - // - ArpService->Mnp->Configure (ArpService->Mnp, NULL); - gBS->CloseProtocol ( - ArpService->MnpChildHandle, - &gEfiManagedNetworkProtocolGuid, - ArpService->ImageHandle, - ArpService->ControllerHandle - ); - } - - if (ArpService->MnpChildHandle != NULL) { - // - // Destroy the mnp child. - // - NetLibDestroyServiceChild( - ArpService->ControllerHandle, - ArpService->ImageHandle, - &gEfiManagedNetworkServiceBindingProtocolGuid, - ArpService->MnpChildHandle - ); - } -} - -/** - Callback function which provided by user to remove one node in NetDestroyLinkList process. - - @param[in] Entry The entry to be removed. - @param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList. - - @retval EFI_SUCCESS The entry has been removed successfully. - @retval Others Fail to remove the entry. - -**/ -EFI_STATUS -EFIAPI -ArpDestroyChildEntryInHandleBuffer ( - IN LIST_ENTRY *Entry, - IN VOID *Context - ) -{ - ARP_INSTANCE_DATA *Instance; - EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; - - if (Entry == NULL || Context == NULL) { - return EFI_INVALID_PARAMETER; - } - - Instance = NET_LIST_USER_STRUCT_S (Entry, ARP_INSTANCE_DATA, List, ARP_INSTANCE_DATA_SIGNATURE); - ServiceBinding = (EFI_SERVICE_BINDING_PROTOCOL *) Context; - - return ServiceBinding->DestroyChild (ServiceBinding, Instance->Handle); -} - -/** - Tests to see if this driver supports a given controller. - - If a child device is provided, it further tests to see if this driver supports - creating a handle for the specified child device. - - @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. - @param[in] ControllerHandle The handle of the controller to test. This handle - must support a protocol interface that supplies - an I/O abstraction to the driver. - @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. - This parameter is ignored by device drivers, - and is optional for bus drivers. - - @retval EFI_SUCCESS The device specified by ControllerHandle and - RemainingDevicePath is supported by the driver - specified by This. - @retval EFI_ALREADY_STARTED The device specified by ControllerHandle and - RemainingDevicePath is already being managed - by the driver specified by This. - @retval EFI_ACCESS_DENIED The device specified by ControllerHandle and - RemainingDevicePath is already being managed by - a different driver or an application that - requires exclusive acces. Currently not implemented. - @retval EFI_UNSUPPORTED The device specified by ControllerHandle and - RemainingDevicePath is not supported by the - driver specified by This. - -**/ -EFI_STATUS -EFIAPI -ArpDriverBindingSupported ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL - ) -{ - EFI_STATUS Status; - - // - // Test to see if Arp SB is already installed. - // - Status = gBS->OpenProtocol ( - ControllerHandle, - &gEfiArpServiceBindingProtocolGuid, - NULL, - This->DriverBindingHandle, - ControllerHandle, - EFI_OPEN_PROTOCOL_TEST_PROTOCOL - ); - if (Status == EFI_SUCCESS) { - return EFI_ALREADY_STARTED; - } - - // - // Test to see if MNP SB is installed. - // - Status = gBS->OpenProtocol ( - ControllerHandle, - &gEfiManagedNetworkServiceBindingProtocolGuid, - NULL, - This->DriverBindingHandle, - ControllerHandle, - EFI_OPEN_PROTOCOL_TEST_PROTOCOL - ); - - return Status; -} - - -/** - Start this driver on ControllerHandle. - - The Start() function is designed to be invoked from the EFI boot service ConnectController(). - As a result, much of the error checking on the parameters to Start() has been - moved into this common boot service. It is legal to call Start() from other locations, - but the following calling restrictions must be followed or the system behavior - will not be deterministic. - 1. ControllerHandle must be a valid EFI_HANDLE. - 2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally - aligned EFI_DEVICE_PATH_PROTOCOL. - 3. Prior to calling Start(), the Supported() function for the driver specified - by This must have been called with the same calling parameters, and Supported() - must have returned EFI_SUCCESS. - - @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. - @param[in] ControllerHandle The handle of the controller to start. This handle - must support a protocol interface that supplies - an I/O abstraction to the driver. - @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. - This parameter is ignored by device drivers, - and is optional for bus drivers. - - @retval EFI_SUCCESS The device was started. - @retval EFI_DEVICE_ERROR The device could not be started due to a device error. - Currently not implemented. - @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of - resources. - @retval Others The driver failded to start the device. - -**/ -EFI_STATUS -EFIAPI -ArpDriverBindingStart ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL - ) -{ - EFI_STATUS Status; - ARP_SERVICE_DATA *ArpService; - - // - // Allocate a zero pool for ArpService. - // - ArpService = AllocateZeroPool (sizeof(ARP_SERVICE_DATA)); - if (ArpService == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - // - // Initialize the arp service context data. - // - Status = ArpCreateService (This->DriverBindingHandle, ControllerHandle, ArpService); - if (EFI_ERROR (Status)) { - goto ERROR; - } - - // - // Install the ARP service binding protocol. - // - Status = gBS->InstallMultipleProtocolInterfaces ( - &ControllerHandle, - &gEfiArpServiceBindingProtocolGuid, - &ArpService->ServiceBinding, - NULL - ); - if (EFI_ERROR (Status)) { - goto ERROR; - } - - // - // OK, start to receive arp packets from Mnp. - // - Status = ArpService->Mnp->Receive (ArpService->Mnp, &ArpService->RxToken); - if (EFI_ERROR (Status)) { - goto ERROR; - } - - return Status; - -ERROR: - - // - // On error, clean the arp service context data, and free the memory allocated. - // - ArpCleanService (ArpService); - FreePool (ArpService); - - return Status; -} - - -/** - Stop this driver on ControllerHandle. - - Release the control of this controller and remove the IScsi functions. The Stop() - function is designed to be invoked from the EFI boot service DisconnectController(). - As a result, much of the error checking on the parameters to Stop() has been moved - into this common boot service. It is legal to call Stop() from other locations, - but the following calling restrictions must be followed or the system behavior - will not be deterministic. - 1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this - same driver's Start() function. - 2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid - EFI_HANDLE. In addition, all of these handles must have been created in this driver's - Start() function, and the Start() function must have called OpenProtocol() on - ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER. - - @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. - @param[in] ControllerHandle A handle to the device being stopped. The handle must - support a bus specific I/O protocol for the driver - to use to stop the device. - @param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer. - Not used. - @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL - if NumberOfChildren is 0.Not used. - - @retval EFI_SUCCESS The device was stopped. - @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error. - -**/ -EFI_STATUS -EFIAPI -ArpDriverBindingStop ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN UINTN NumberOfChildren, - IN EFI_HANDLE *ChildHandleBuffer - ) -{ - EFI_STATUS Status; - EFI_HANDLE NicHandle; - EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; - ARP_SERVICE_DATA *ArpService; - LIST_ENTRY *List; - - // - // Get the NicHandle which the arp servicebinding is installed on. - // - NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiManagedNetworkProtocolGuid); - if (NicHandle == NULL) { - return EFI_SUCCESS; - } - - // - // Try to get the arp servicebinding protocol on the NicHandle. - // - Status = gBS->OpenProtocol ( - NicHandle, - &gEfiArpServiceBindingProtocolGuid, - (VOID **)&ServiceBinding, - This->DriverBindingHandle, - ControllerHandle, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - if (EFI_ERROR (Status)) { - DEBUG ((EFI_D_ERROR, "ArpDriverBindingStop: Open ArpSb failed, %r.\n", Status)); - return EFI_DEVICE_ERROR; - } - - ArpService = ARP_SERVICE_DATA_FROM_THIS (ServiceBinding); - - if (NumberOfChildren != 0) { - // - // NumberOfChildren is not zero, destroy all the ARP children instances. - // - List = &ArpService->ChildrenList; - Status = NetDestroyLinkList ( - List, - ArpDestroyChildEntryInHandleBuffer, - ServiceBinding, - NULL - ); - ASSERT (IsListEmpty (&ArpService->PendingRequestTable)); - ASSERT (IsListEmpty (&ArpService->DeniedCacheTable)); - ASSERT (IsListEmpty (&ArpService->ResolvedCacheTable)); - } else if (IsListEmpty (&ArpService->ChildrenList)) { - // - // Uninstall the ARP ServiceBinding protocol. - // - gBS->UninstallMultipleProtocolInterfaces ( - NicHandle, - &gEfiArpServiceBindingProtocolGuid, - &ArpService->ServiceBinding, - NULL - ); - - // - // Clean the arp servicebinding context data and free the memory allocated. - // - ArpCleanService (ArpService); - - FreePool (ArpService); - } - - return EFI_SUCCESS; -} - -/** - Creates a child handle and installs a protocol. - - The CreateChild() function installs a protocol on ChildHandle. - If ChildHandle is a pointer to NULL, then a new handle is created and returned - in ChildHandle. If ChildHandle is not a pointer to NULL, then the protocol - installs on the existing ChildHandle. - - @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. - @param ChildHandle Pointer to the handle of the child to create. If it is NULL, - then a new handle is created. If it is a pointer to an existing - UEFI handle, then the protocol is added to the existing UEFI handle. - - @retval EFI_SUCCES The protocol was added to ChildHandle. - @retval EFI_INVALID_PARAMETER ChildHandle is NULL. - @retval EFI_OUT_OF_RESOURCES There are not enough resources available to create - the child - @retval other The child handle was not created - -**/ -EFI_STATUS -EFIAPI -ArpServiceBindingCreateChild ( - IN EFI_SERVICE_BINDING_PROTOCOL *This, - IN EFI_HANDLE *ChildHandle - ) -{ - EFI_STATUS Status; - ARP_SERVICE_DATA *ArpService; - ARP_INSTANCE_DATA *Instance; - VOID *Mnp; - EFI_TPL OldTpl; - - if ((This == NULL) || (ChildHandle == NULL)) { - return EFI_INVALID_PARAMETER; - } - - ArpService = ARP_SERVICE_DATA_FROM_THIS (This); - - // - // Allocate memory for the instance context data. - // - Instance = AllocateZeroPool (sizeof(ARP_INSTANCE_DATA)); - if (Instance == NULL) { - DEBUG ((EFI_D_ERROR, "ArpSBCreateChild: Failed to allocate memory for Instance.\n")); - - return EFI_OUT_OF_RESOURCES; - } - - // - // Init the instance context data. - // - ArpInitInstance (ArpService, Instance); - - // - // Install the ARP protocol onto the ChildHandle. - // - Status = gBS->InstallMultipleProtocolInterfaces ( - ChildHandle, - &gEfiArpProtocolGuid, - (VOID *)&Instance->ArpProto, - NULL - ); - if (EFI_ERROR (Status)) { - DEBUG ((EFI_D_ERROR, "ArpSBCreateChild: faild to install ARP protocol, %r.\n", Status)); - - FreePool (Instance); - return Status; - } - - // - // Save the ChildHandle. - // - Instance->Handle = *ChildHandle; - - // - // Open the Managed Network protocol BY_CHILD. - // - Status = gBS->OpenProtocol ( - ArpService->MnpChildHandle, - &gEfiManagedNetworkProtocolGuid, - (VOID **) &Mnp, - gArpDriverBinding.DriverBindingHandle, - Instance->Handle, - EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER - ); - if (EFI_ERROR (Status)) { - goto ERROR; - } - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - // - // Insert the instance into children list managed by the arp service context data. - // - InsertTailList (&ArpService->ChildrenList, &Instance->List); - ArpService->ChildrenNumber++; - - gBS->RestoreTPL (OldTpl); - -ERROR: - - if (EFI_ERROR (Status)) { - - gBS->CloseProtocol ( - ArpService->MnpChildHandle, - &gEfiManagedNetworkProtocolGuid, - gArpDriverBinding.DriverBindingHandle, - Instance->Handle - ); - - gBS->UninstallMultipleProtocolInterfaces ( - Instance->Handle, - &gEfiArpProtocolGuid, - &Instance->ArpProto, - NULL - ); - - // - // Free the allocated memory. - // - FreePool (Instance); - } - - return Status; -} - - -/** - Destroys a child handle with a protocol installed on it. - - The DestroyChild() function does the opposite of CreateChild(). It removes a protocol - that was installed by CreateChild() from ChildHandle. If the removed protocol is the - last protocol on ChildHandle, then ChildHandle is destroyed. - - @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. - @param ChildHandle Handle of the child to destroy - - @retval EFI_SUCCES The protocol was removed from ChildHandle. - @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is - being removed. - @retval EFI_INVALID_PARAMETER Child handle is NULL. - @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle - because its services are being used. - @retval other The child handle was not destroyed - -**/ -EFI_STATUS -EFIAPI -ArpServiceBindingDestroyChild ( - IN EFI_SERVICE_BINDING_PROTOCOL *This, - IN EFI_HANDLE ChildHandle - ) -{ - EFI_STATUS Status; - ARP_SERVICE_DATA *ArpService; - ARP_INSTANCE_DATA *Instance; - EFI_ARP_PROTOCOL *Arp; - EFI_TPL OldTpl; - - if ((This == NULL) || (ChildHandle == NULL)) { - return EFI_INVALID_PARAMETER; - } - - ArpService = ARP_SERVICE_DATA_FROM_THIS (This); - - // - // Get the arp protocol. - // - Status = gBS->OpenProtocol ( - ChildHandle, - &gEfiArpProtocolGuid, - (VOID **)&Arp, - ArpService->ImageHandle, - ChildHandle, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - if (EFI_ERROR (Status)) { - return EFI_UNSUPPORTED; - } - - Instance = ARP_INSTANCE_DATA_FROM_THIS (Arp); - - if (Instance->InDestroy) { - return EFI_SUCCESS; - } - - // - // Use the InDestroy as a flag to avoid re-entrance. - // - Instance->InDestroy = TRUE; - - // - // Close the Managed Network protocol. - // - gBS->CloseProtocol ( - ArpService->MnpChildHandle, - &gEfiManagedNetworkProtocolGuid, - gArpDriverBinding.DriverBindingHandle, - ChildHandle - ); - - // - // Uninstall the ARP protocol. - // - Status = gBS->UninstallMultipleProtocolInterfaces ( - ChildHandle, - &gEfiArpProtocolGuid, - &Instance->ArpProto, - NULL - ); - if (EFI_ERROR (Status)) { - DEBUG ((EFI_D_ERROR, "ArpSBDestroyChild: Failed to uninstall the arp protocol, %r.\n", - Status)); - - Instance->InDestroy = FALSE; - return Status; - } - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - if (Instance->Configured) { - // - // Delete the related cache entry. - // - ArpDeleteCacheEntry (Instance, FALSE, NULL, TRUE); - - // - // Reset the instance configuration. - // - ArpConfigureInstance (Instance, NULL); - } - - // - // Remove this instance from the ChildrenList. - // - RemoveEntryList (&Instance->List); - ArpService->ChildrenNumber--; - - gBS->RestoreTPL (OldTpl); - - FreePool (Instance); - - return Status; -} - -/** - The entry point for Arp driver which installs the driver binding and component name - protocol on its ImageHandle. - - @param[in] ImageHandle The image handle of the driver. - @param[in] SystemTable The system table. - - @retval EFI_SUCCESS if the driver binding and component name protocols - are successfully - @retval Others Failed to install the protocols. - -**/ -EFI_STATUS -EFIAPI -ArpDriverEntryPoint ( - IN EFI_HANDLE ImageHandle, - IN EFI_SYSTEM_TABLE *SystemTable - ) -{ - return EfiLibInstallDriverBindingComponentName2 ( - ImageHandle, - SystemTable, - &gArpDriverBinding, - ImageHandle, - &gArpComponentName, - &gArpComponentName2 - ); -} - diff --git a/MdeModulePkg/Universal/Network/ArpDxe/ArpDriver.h b/MdeModulePkg/Universal/Network/ArpDxe/ArpDriver.h deleted file mode 100644 index 0b5b06ee37..0000000000 --- a/MdeModulePkg/Universal/Network/ArpDxe/ArpDriver.h +++ /dev/null @@ -1,334 +0,0 @@ -/** @file - ARP driver header file. - -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef _ARP_DRIVER_H_ -#define _ARP_DRIVER_H_ - - -#include - -#include -#include -#include - -#include -#include -#include -#include - - -// -// Global variables -// -extern EFI_DRIVER_BINDING_PROTOCOL gArpDriverBinding; -extern EFI_COMPONENT_NAME_PROTOCOL gArpComponentName; -extern EFI_COMPONENT_NAME2_PROTOCOL gArpComponentName2; - -// -// Function prototypes for the Drivr Binding Protocol -// -/** - Tests to see if this driver supports a given controller. - - If a child device is provided, it further tests to see if this driver supports - creating a handle for the specified child device. - - @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. - @param[in] ControllerHandle The handle of the controller to test. This handle - must support a protocol interface that supplies - an I/O abstraction to the driver. - @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. - This parameter is ignored by device drivers, - and is optional for bus drivers. - - @retval EFI_SUCCESS The device specified by ControllerHandle and - RemainingDevicePath is supported by the driver - specified by This. - @retval EFI_ALREADY_STARTED The device specified by ControllerHandle and - RemainingDevicePath is already being managed - by the driver specified by This. - @retval EFI_ACCESS_DENIED The device specified by ControllerHandle and - RemainingDevicePath is already being managed by - a different driver or an application that - requires exclusive acces. Currently not implemented. - @retval EFI_UNSUPPORTED The device specified by ControllerHandle and - RemainingDevicePath is not supported by the - driver specified by This. - -**/ -EFI_STATUS -EFIAPI -ArpDriverBindingSupported ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL - ); - -/** - Start this driver on ControllerHandle. - - The Start() function is designed to be invoked from the EFI boot service ConnectController(). - As a result, much of the error checking on the parameters to Start() has been - moved into this common boot service. It is legal to call Start() from other locations, - but the following calling restrictions must be followed or the system behavior - will not be deterministic. - 1. ControllerHandle must be a valid EFI_HANDLE. - 2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally - aligned EFI_DEVICE_PATH_PROTOCOL. - 3. Prior to calling Start(), the Supported() function for the driver specified - by This must have been called with the same calling parameters, and Supported() - must have returned EFI_SUCCESS. - - @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. - @param[in] ControllerHandle The handle of the controller to start. This handle - must support a protocol interface that supplies - an I/O abstraction to the driver. - @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. - This parameter is ignored by device drivers, - and is optional for bus drivers. - - @retval EFI_SUCCESS The device was started. - @retval EFI_DEVICE_ERROR The device could not be started due to a device error. - Currently not implemented. - @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of - resources. - @retval Others The driver failded to start the device. - -**/ -EFI_STATUS -EFIAPI -ArpDriverBindingStart ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL - ); - -/** - Stop this driver on ControllerHandle. - - Release the control of this controller and remove the IScsi functions. The Stop() - function is designed to be invoked from the EFI boot service DisconnectController(). - As a result, much of the error checking on the parameters to Stop() has been moved - into this common boot service. It is legal to call Stop() from other locations, - but the following calling restrictions must be followed or the system behavior - will not be deterministic. - 1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this - same driver's Start() function. - 2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid - EFI_HANDLE. In addition, all of these handles must have been created in this driver's - Start() function, and the Start() function must have called OpenProtocol() on - ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER. - - @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. - @param[in] ControllerHandle A handle to the device being stopped. The handle must - support a bus specific I/O protocol for the driver - to use to stop the device. - @param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer. - Not used. - @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL - if NumberOfChildren is 0.Not used. - - @retval EFI_SUCCESS The device was stopped. - @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error. - -**/ -EFI_STATUS -EFIAPI -ArpDriverBindingStop ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN UINTN NumberOfChildren, - IN EFI_HANDLE *ChildHandleBuffer - ); - -/** - Creates a child handle and installs a protocol. - - The CreateChild() function installs a protocol on ChildHandle. - If ChildHandle is a pointer to NULL, then a new handle is created and returned - in ChildHandle. If ChildHandle is not a pointer to NULL, then the protocol - installs on the existing ChildHandle. - - @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. - @param ChildHandle Pointer to the handle of the child to create. If it is NULL, - then a new handle is created. If it is a pointer to an existing - UEFI handle, then the protocol is added to the existing UEFI handle. - - @retval EFI_SUCCES The protocol was added to ChildHandle. - @retval EFI_INVALID_PARAMETER ChildHandle is NULL. - @retval EFI_OUT_OF_RESOURCES There are not enough resources available to create - the child - @retval other The child handle was not created - -**/ -EFI_STATUS -EFIAPI -ArpServiceBindingCreateChild ( - IN EFI_SERVICE_BINDING_PROTOCOL *This, - IN EFI_HANDLE *ChildHandle - ); - -/** - Destroys a child handle with a protocol installed on it. - - The DestroyChild() function does the opposite of CreateChild(). It removes a protocol - that was installed by CreateChild() from ChildHandle. If the removed protocol is the - last protocol on ChildHandle, then ChildHandle is destroyed. - - @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. - @param ChildHandle Handle of the child to destroy - - @retval EFI_SUCCES The protocol was removed from ChildHandle. - @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is - being removed. - @retval EFI_INVALID_PARAMETER Child handle is NULL. - @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle - because its services are being used. - @retval other The child handle was not destroyed - -**/ -EFI_STATUS -EFIAPI -ArpServiceBindingDestroyChild ( - IN EFI_SERVICE_BINDING_PROTOCOL *This, - IN EFI_HANDLE ChildHandle - ); - - -// -// EFI Component Name Functions -// -/** - Retrieves a Unicode string that is the user readable name of the driver. - - This function retrieves the user readable name of a driver in the form of a - Unicode string. If the driver specified by This has a user readable name in - the language specified by Language, then a pointer to the driver name is - returned in DriverName, and EFI_SUCCESS is returned. If the driver specified - by This does not support the language specified by Language, - then EFI_UNSUPPORTED is returned. - - @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param[in] Language A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified - in RFC 4646 or ISO 639-2 language code format. - - @param[out] DriverName A pointer to the Unicode string to return. - This Unicode string is the name of the - driver specified by This in the language - specified by Language. - - @retval EFI_SUCCESS The Unicode string for the Driver specified by - This and the language specified by Language was - returned in DriverName. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER DriverName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -ArpComponentNameGetDriverName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN CHAR8 *Language, - OUT CHAR16 **DriverName - ); - - -/** - Retrieves a Unicode string that is the user readable name of the controller - that is being managed by a driver. - - This function retrieves the user readable name of the controller specified by - ControllerHandle and ChildHandle in the form of a Unicode string. If the - driver specified by This has a user readable name in the language specified by - Language, then a pointer to the controller name is returned in ControllerName, - and EFI_SUCCESS is returned. If the driver specified by This is not currently - managing the controller specified by ControllerHandle and ChildHandle, - then EFI_UNSUPPORTED is returned. If the driver specified by This does not - support the language specified by Language, then EFI_UNSUPPORTED is returned. - - @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param[in] ControllerHandle The handle of a controller that the driver - specified by This is managing. This handle - specifies the controller whose name is to be - returned. - - @param[in] ChildHandle The handle of the child controller to retrieve - the name of. This is an optional parameter that - may be NULL. It will be NULL for device - drivers. It will also be NULL for a bus drivers - that wish to retrieve the name of the bus - controller. It will not be NULL for a bus - driver that wishes to retrieve the name of a - child controller. - - @param[in] Language A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified in - RFC 4646 or ISO 639-2 language code format. - - @param[out] ControllerName A pointer to the Unicode string to return. - This Unicode string is the name of the - controller specified by ControllerHandle and - ChildHandle in the language specified by - Language from the point of view of the driver - specified by This. - - @retval EFI_SUCCESS The Unicode string for the user readable name in - the language specified by Language for the - driver specified by This was returned in - DriverName. - - @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. - - @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid - EFI_HANDLE. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER ControllerName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This is not currently - managing the controller specified by - ControllerHandle and ChildHandle. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -ArpComponentNameGetControllerName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_HANDLE ChildHandle OPTIONAL, - IN CHAR8 *Language, - OUT CHAR16 **ControllerName - ); - - -#endif - diff --git a/MdeModulePkg/Universal/Network/ArpDxe/ArpDxe.inf b/MdeModulePkg/Universal/Network/ArpDxe/ArpDxe.inf deleted file mode 100644 index 78344edf90..0000000000 --- a/MdeModulePkg/Universal/Network/ArpDxe/ArpDxe.inf +++ /dev/null @@ -1,62 +0,0 @@ -## @file -# This module produces EFI ARP Protocol and EFI ARP Service Binding Protocol. -# -# This module produces EFI ARP Protocol upon EFI MNP Protocol, to provide a generic -# implementation of the Address Resolution Protocol that is described in RFCs 826 -# and 1122. -# -# Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-# SPDX-License-Identifier: BSD-2-Clause-Patent -# -# -## - -[Defines] - INF_VERSION = 0x00010005 - BASE_NAME = ArpDxe - MODULE_UNI_FILE = ArpDxe.uni - FILE_GUID = 529D3F93-E8E9-4e73-B1E1-BDF6A9D50113 - MODULE_TYPE = UEFI_DRIVER - VERSION_STRING = 1.0 - ENTRY_POINT = ArpDriverEntryPoint - UNLOAD_IMAGE = NetLibDefaultUnload -# -# The following information is for reference only and not required by the build tools. -# -# VALID_ARCHITECTURES = IA32 X64 EBC -# -# DRIVER_BINDING = gArpDriverBinding -# COMPONENT_NAME = gArpComponentName -# COMPONENT_NAME2 = gArpComponentName2 -# - -[Sources] - ArpMain.c - ArpDriver.h - ComponentName.c - ArpImpl.h - ArpImpl.c - ArpDriver.c - - -[Packages] - MdePkg/MdePkg.dec - MdeModulePkg/MdeModulePkg.dec - - -[LibraryClasses] - UefiLib - UefiBootServicesTableLib - UefiDriverEntryPoint - DebugLib - NetLib - DpcLib - -[Protocols] - gEfiArpServiceBindingProtocolGuid ## BY_START - gEfiManagedNetworkServiceBindingProtocolGuid ## TO_START - gEfiArpProtocolGuid ## BY_START - gEfiManagedNetworkProtocolGuid ## TO_START - -[UserExtensions.TianoCore."ExtraFiles"] - ArpDxeExtra.uni diff --git a/MdeModulePkg/Universal/Network/ArpDxe/ArpDxe.uni b/MdeModulePkg/Universal/Network/ArpDxe/ArpDxe.uni deleted file mode 100644 index f72063dd43..0000000000 --- a/MdeModulePkg/Universal/Network/ArpDxe/ArpDxe.uni +++ /dev/null @@ -1,18 +0,0 @@ -// /** @file -// This module produces EFI ARP Protocol and EFI ARP Service Binding Protocol. -// -// This module produces EFI ARP Protocol upon EFI MNP Protocol, to provide a generic -// implementation of the Address Resolution Protocol that is described in RFCs 826 -// and 1122. -// -// Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-// -// SPDX-License-Identifier: BSD-2-Clause-Patent -// -// **/ - - -#string STR_MODULE_ABSTRACT #language en-US "EFI Address Resolution Protocol" - -#string STR_MODULE_DESCRIPTION #language en-US "This module produces EFI ARP Protocol using the EFI MNP Protocol to provide a generic implementation of the Address Resolution Protocol that is described in RFCs 826 and 1122." - diff --git a/MdeModulePkg/Universal/Network/ArpDxe/ArpDxeExtra.uni b/MdeModulePkg/Universal/Network/ArpDxe/ArpDxeExtra.uni deleted file mode 100644 index be612d002e..0000000000 --- a/MdeModulePkg/Universal/Network/ArpDxe/ArpDxeExtra.uni +++ /dev/null @@ -1,14 +0,0 @@ -// /** @file -// ArpDxe Localized Strings and Content -// -// Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.
-// -// SPDX-License-Identifier: BSD-2-Clause-Patent -// -// **/ - -#string STR_PROPERTIES_MODULE_NAME -#language en-US -"ARP DXE Driver" - - diff --git a/MdeModulePkg/Universal/Network/ArpDxe/ArpImpl.c b/MdeModulePkg/Universal/Network/ArpDxe/ArpImpl.c deleted file mode 100644 index 0e9ef103ef..0000000000 --- a/MdeModulePkg/Universal/Network/ArpDxe/ArpImpl.c +++ /dev/null @@ -1,1667 +0,0 @@ -/** @file - The implementation of the ARP protocol. - -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "ArpImpl.h" - -// -// Global variable of EFI ARP Protocol Interface. -// -EFI_ARP_PROTOCOL mEfiArpProtocolTemplate = { - ArpConfigure, - ArpAdd, - ArpFind, - ArpDelete, - ArpFlush, - ArpRequest, - ArpCancel -}; - - -/** - Initialize the instance context data. - - @param[in] ArpService Pointer to the arp service context data this - instance belongs to. - @param[out] Instance Pointer to the instance context data. - - @return None. - -**/ -VOID -ArpInitInstance ( - IN ARP_SERVICE_DATA *ArpService, - OUT ARP_INSTANCE_DATA *Instance - ) -{ - NET_CHECK_SIGNATURE (ArpService, ARP_SERVICE_DATA_SIGNATURE); - - Instance->Signature = ARP_INSTANCE_DATA_SIGNATURE; - Instance->ArpService = ArpService; - - CopyMem (&Instance->ArpProto, &mEfiArpProtocolTemplate, sizeof (Instance->ArpProto)); - - Instance->Configured = FALSE; - Instance->InDestroy = FALSE; - - InitializeListHead (&Instance->List); -} - - -/** - Process the Arp packets received from Mnp, the procedure conforms to RFC826. - - @param[in] Context Pointer to the context data registerd to the - Event. - - @return None. - -**/ -VOID -EFIAPI -ArpOnFrameRcvdDpc ( - IN VOID *Context - ) -{ - EFI_STATUS Status; - ARP_SERVICE_DATA *ArpService; - EFI_MANAGED_NETWORK_COMPLETION_TOKEN *RxToken; - EFI_MANAGED_NETWORK_RECEIVE_DATA *RxData; - ARP_HEAD *Head; - ARP_ADDRESS ArpAddress; - ARP_CACHE_ENTRY *CacheEntry; - LIST_ENTRY *Entry; - ARP_INSTANCE_DATA *Instance; - EFI_ARP_CONFIG_DATA *ConfigData; - NET_ARP_ADDRESS SenderAddress[2]; - BOOLEAN ProtoMatched; - BOOLEAN IsTarget; - BOOLEAN MergeFlag; - - ArpService = (ARP_SERVICE_DATA *)Context; - NET_CHECK_SIGNATURE (ArpService, ARP_SERVICE_DATA_SIGNATURE); - - RxToken = &ArpService->RxToken; - - if (RxToken->Status == EFI_ABORTED) { - // - // The Token is aborted, possibly by arp itself, just return and the receiving - // process is stopped. - // - return; - } - - if (EFI_ERROR (RxToken->Status)) { - // - // Restart the receiving if any other error Status occurs. - // - goto RESTART_RECEIVE; - } - - // - // Status is EFI_SUCCESS, process the received frame. - // - RxData = RxToken->Packet.RxData; - // - // Sanity check. - // - if (RxData->DataLength < sizeof (ARP_HEAD)) { - // - // Restart the receiving if packet size is not correct. - // - goto RESTART_RECEIVE; - } - - // - // Convert the byte order of the multi-byte fields. - // - Head = (ARP_HEAD *) RxData->PacketData; - Head->HwType = NTOHS (Head->HwType); - Head->ProtoType = NTOHS (Head->ProtoType); - Head->OpCode = NTOHS (Head->OpCode); - - if (RxData->DataLength < (sizeof (ARP_HEAD) + 2 * Head->HwAddrLen + 2 * Head->ProtoAddrLen)) { - goto RESTART_RECEIVE; - } - - if ((Head->HwType != ArpService->SnpMode.IfType) || - (Head->HwAddrLen != ArpService->SnpMode.HwAddressSize) || - (RxData->ProtocolType != ARP_ETHER_PROTO_TYPE)) { - // - // The hardware type or the hardware address length doesn't match. - // There is a sanity check for the protocol type too. - // - goto RECYCLE_RXDATA; - } - - // - // Set the pointers to the addresses contained in the arp packet. - // - ArpAddress.SenderHwAddr = (UINT8 *)(Head + 1); - ArpAddress.SenderProtoAddr = ArpAddress.SenderHwAddr + Head->HwAddrLen; - ArpAddress.TargetHwAddr = ArpAddress.SenderProtoAddr + Head->ProtoAddrLen; - ArpAddress.TargetProtoAddr = ArpAddress.TargetHwAddr + Head->HwAddrLen; - - SenderAddress[Hardware].Type = Head->HwType; - SenderAddress[Hardware].Length = Head->HwAddrLen; - SenderAddress[Hardware].AddressPtr = ArpAddress.SenderHwAddr; - - SenderAddress[Protocol].Type = Head->ProtoType; - SenderAddress[Protocol].Length = Head->ProtoAddrLen; - SenderAddress[Protocol].AddressPtr = ArpAddress.SenderProtoAddr; - - // - // First, check the denied cache table. - // - CacheEntry = ArpFindDeniedCacheEntry ( - ArpService, - &SenderAddress[Protocol], - &SenderAddress[Hardware] - ); - if (CacheEntry != NULL) { - // - // This address (either hardware or protocol address, or both) is configured to - // be a deny entry, silently skip the normal process. - // - goto RECYCLE_RXDATA; - } - - ProtoMatched = FALSE; - IsTarget = FALSE; - Instance = NULL; - NET_LIST_FOR_EACH (Entry, &ArpService->ChildrenList) { - // - // Iterate all the children. - // - Instance = NET_LIST_USER_STRUCT (Entry, ARP_INSTANCE_DATA, List); - NET_CHECK_SIGNATURE (Instance, ARP_INSTANCE_DATA_SIGNATURE); - ConfigData = &Instance->ConfigData; - - if ((Instance->Configured) && - (Head->ProtoType == ConfigData->SwAddressType) && - (Head->ProtoAddrLen == ConfigData->SwAddressLength)) { - // - // The protocol type is matched for the received arp packet. - // - ProtoMatched = TRUE; - if (0 == CompareMem ( - (VOID *)ArpAddress.TargetProtoAddr, - ConfigData->StationAddress, - ConfigData->SwAddressLength - )) { - // - // The arp driver has the target address required by the received arp packet. - // - IsTarget = TRUE; - break; - } - } - } - - if (!ProtoMatched) { - // - // Protocol type unmatchable, skip. - // - goto RECYCLE_RXDATA; - } - - // - // Check whether the sender's address information is already in the cache. - // - MergeFlag = FALSE; - CacheEntry = ArpFindNextCacheEntryInTable ( - &ArpService->ResolvedCacheTable, - NULL, - ByProtoAddress, - &SenderAddress[Protocol], - NULL - ); - if (CacheEntry != NULL) { - // - // Update the entry with the new information. - // - ArpFillAddressInCacheEntry (CacheEntry, &SenderAddress[Hardware], NULL); - CacheEntry->DecayTime = CacheEntry->DefaultDecayTime; - MergeFlag = TRUE; - } - - if (!IsTarget) { - // - // This arp packet isn't targeted to us, skip now. - // - goto RECYCLE_RXDATA; - } - - if (!MergeFlag) { - // - // Add the triplet - // to the translation table. - // - CacheEntry = ArpFindNextCacheEntryInTable ( - &ArpService->PendingRequestTable, - NULL, - ByProtoAddress, - &SenderAddress[Protocol], - NULL - ); - if (CacheEntry == NULL) { - // - // Allocate a new CacheEntry. - // - CacheEntry = ArpAllocCacheEntry (NULL); - if (CacheEntry == NULL) { - goto RECYCLE_RXDATA; - } - } - - if (!IsListEmpty (&CacheEntry->List)) { - RemoveEntryList (&CacheEntry->List); - } - - // - // Fill the addresses into the CacheEntry. - // - ArpFillAddressInCacheEntry ( - CacheEntry, - &SenderAddress[Hardware], - &SenderAddress[Protocol] - ); - - // - // Inform the user. - // - ArpAddressResolved (CacheEntry, NULL, NULL); - - // - // Add this entry into the ResolvedCacheTable - // - InsertHeadList (&ArpService->ResolvedCacheTable, &CacheEntry->List); - } - - if (Head->OpCode == ARP_OPCODE_REQUEST) { - // - // Send back the ARP Reply. If we reach here, Instance is not NULL and CacheEntry - // is not NULL. - // - ArpSendFrame (Instance, CacheEntry, ARP_OPCODE_REPLY); - } - -RECYCLE_RXDATA: - - // - // Signal Mnp to recycle the RxData. - // - gBS->SignalEvent (RxData->RecycleEvent); - -RESTART_RECEIVE: - - // - // Continue to receive packets from Mnp. - // - Status = ArpService->Mnp->Receive (ArpService->Mnp, RxToken); - - DEBUG_CODE ( - if (EFI_ERROR (Status)) { - DEBUG ((EFI_D_ERROR, "ArpOnFrameRcvd: ArpService->Mnp->Receive " - "failed, %r\n.", Status)); - } - ); -} - -/** - Queue ArpOnFrameRcvdDpc as a DPC at TPL_CALLBACK. - - @param[in] Event The Event this notify function registered to. - @param[in] Context Pointer to the context data registerd to the - Event. - - @return None. - -**/ -VOID -EFIAPI -ArpOnFrameRcvd ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - // - // Request ArpOnFrameRcvdDpc as a DPC at TPL_CALLBACK - // - QueueDpc (TPL_CALLBACK, ArpOnFrameRcvdDpc, Context); -} - -/** - Process the already sent arp packets. - - @param[in] Context Pointer to the context data registerd to the - Event. - - @return None. - -**/ -VOID -EFIAPI -ArpOnFrameSentDpc ( - IN VOID *Context - ) -{ - EFI_MANAGED_NETWORK_COMPLETION_TOKEN *TxToken; - EFI_MANAGED_NETWORK_TRANSMIT_DATA *TxData; - - ASSERT (Context != NULL); - - TxToken = (EFI_MANAGED_NETWORK_COMPLETION_TOKEN *)Context; - TxData = TxToken->Packet.TxData; - - DEBUG_CODE ( - if (EFI_ERROR (TxToken->Status)) { - DEBUG ((EFI_D_ERROR, "ArpOnFrameSent: TxToken->Status, %r.\n", TxToken->Status)); - } - ); - - // - // Free the allocated memory and close the event. - // - FreePool (TxData->FragmentTable[0].FragmentBuffer); - FreePool (TxData); - gBS->CloseEvent (TxToken->Event); - FreePool (TxToken); -} - -/** - Request ArpOnFrameSentDpc as a DPC at TPL_CALLBACK. - - @param[in] Event The Event this notify function registered to. - @param[in] Context Pointer to the context data registerd to the - Event. - - @return None. - -**/ -VOID -EFIAPI -ArpOnFrameSent ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - // - // Request ArpOnFrameSentDpc as a DPC at TPL_CALLBACK - // - QueueDpc (TPL_CALLBACK, ArpOnFrameSentDpc, Context); -} - - -/** - Process the arp cache olding and drive the retrying arp requests. - - @param[in] Event The Event this notify function registered to. - @param[in] Context Pointer to the context data registerd to the - Event. - - @return None. - -**/ -VOID -EFIAPI -ArpTimerHandler ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - ARP_SERVICE_DATA *ArpService; - LIST_ENTRY *Entry; - LIST_ENTRY *NextEntry; - LIST_ENTRY *ContextEntry; - ARP_CACHE_ENTRY *CacheEntry; - USER_REQUEST_CONTEXT *RequestContext; - - ASSERT (Context != NULL); - ArpService = (ARP_SERVICE_DATA *)Context; - - // - // Iterate all the pending requests to see whether a retry is needed to send out - // or the request finally fails because the retry time reaches the limitation. - // - NET_LIST_FOR_EACH_SAFE (Entry, NextEntry, &ArpService->PendingRequestTable) { - CacheEntry = NET_LIST_USER_STRUCT (Entry, ARP_CACHE_ENTRY, List); - - if (CacheEntry->NextRetryTime <= ARP_PERIODIC_TIMER_INTERVAL) { - // - // Timeout, if we can retry more, send out the request again, otherwise abort - // this request. - // - if (CacheEntry->RetryCount == 0) { - // - // Abort this request. - // - ArpAddressResolved (CacheEntry, NULL, NULL); - ASSERT (IsListEmpty (&CacheEntry->UserRequestList)); - - RemoveEntryList (&CacheEntry->List); - FreePool (CacheEntry); - } else { - // - // resend the ARP request. - // - ASSERT (!IsListEmpty(&CacheEntry->UserRequestList)); - - ContextEntry = CacheEntry->UserRequestList.ForwardLink; - RequestContext = NET_LIST_USER_STRUCT (ContextEntry, USER_REQUEST_CONTEXT, List); - - ArpSendFrame (RequestContext->Instance, CacheEntry, ARP_OPCODE_REQUEST); - - CacheEntry->RetryCount--; - CacheEntry->NextRetryTime = RequestContext->Instance->ConfigData.RetryTimeOut; - } - } else { - // - // Update the NextRetryTime. - // - CacheEntry->NextRetryTime -= ARP_PERIODIC_TIMER_INTERVAL; - } - } - - // - // Check the timeouts for the DeniedCacheTable. - // - NET_LIST_FOR_EACH_SAFE (Entry, NextEntry, &ArpService->DeniedCacheTable) { - CacheEntry = NET_LIST_USER_STRUCT (Entry, ARP_CACHE_ENTRY, List); - ASSERT (IsListEmpty (&CacheEntry->UserRequestList)); - - if (CacheEntry->DefaultDecayTime == 0) { - // - // It's a static entry, skip it. - // - continue; - } - - if (CacheEntry->DecayTime <= ARP_PERIODIC_TIMER_INTERVAL) { - // - // Time out, remove it. - // - RemoveEntryList (&CacheEntry->List); - FreePool (CacheEntry); - } else { - // - // Update the DecayTime. - // - CacheEntry->DecayTime -= ARP_PERIODIC_TIMER_INTERVAL; - } - } - - // - // Check the timeouts for the ResolvedCacheTable. - // - NET_LIST_FOR_EACH_SAFE (Entry, NextEntry, &ArpService->ResolvedCacheTable) { - CacheEntry = NET_LIST_USER_STRUCT (Entry, ARP_CACHE_ENTRY, List); - ASSERT (IsListEmpty (&CacheEntry->UserRequestList)); - - if (CacheEntry->DefaultDecayTime == 0) { - // - // It's a static entry, skip it. - // - continue; - } - - if (CacheEntry->DecayTime <= ARP_PERIODIC_TIMER_INTERVAL) { - // - // Time out, remove it. - // - RemoveEntryList (&CacheEntry->List); - FreePool (CacheEntry); - } else { - // - // Update the DecayTime. - // - CacheEntry->DecayTime -= ARP_PERIODIC_TIMER_INTERVAL; - } - } -} - - -/** - Match the two NET_ARP_ADDRESSes. - - @param[in] AddressOne Pointer to the first address to match. - @param[in] AddressTwo Pointer to the second address to match. - - @return The two addresses match or not. - -**/ -BOOLEAN -ArpMatchAddress ( - IN NET_ARP_ADDRESS *AddressOne, - IN NET_ARP_ADDRESS *AddressTwo - ) -{ - ASSERT (AddressOne != NULL && AddressTwo != NULL); - - if ((AddressOne->Type != AddressTwo->Type) || - (AddressOne->Length != AddressTwo->Length)) { - // - // Either Type or Length doesn't match. - // - return FALSE; - } - - if ((AddressOne->AddressPtr != NULL) && - (CompareMem ( - AddressOne->AddressPtr, - AddressTwo->AddressPtr, - AddressOne->Length - ) != 0)) { - // - // The address is not the same. - // - return FALSE; - } - - return TRUE; -} - - -/** - Find the CacheEntry which matches the requirements in the specified CacheTable. - - @param[in] CacheTable Pointer to the arp cache table. - @param[in] StartEntry Pointer to the start entry this search begins with - in the cache table. - @param[in] FindOpType The search type. - @param[in] ProtocolAddress Pointer to the protocol address to match. - @param[in] HardwareAddress Pointer to the hardware address to match. - - @return Pointer to the matched arp cache entry, if NULL, no match is found. - -**/ -ARP_CACHE_ENTRY * -ArpFindNextCacheEntryInTable ( - IN LIST_ENTRY *CacheTable, - IN LIST_ENTRY *StartEntry, - IN FIND_OPTYPE FindOpType, - IN NET_ARP_ADDRESS *ProtocolAddress OPTIONAL, - IN NET_ARP_ADDRESS *HardwareAddress OPTIONAL - ) -{ - LIST_ENTRY *Entry; - ARP_CACHE_ENTRY *CacheEntry; - - if (StartEntry == NULL) { - // - // Start from the beginning of the table if no StartEntry is specified. - // - StartEntry = CacheTable; - } - - for (Entry = StartEntry->ForwardLink; Entry != CacheTable; Entry = Entry->ForwardLink) { - CacheEntry = NET_LIST_USER_STRUCT (Entry, ARP_CACHE_ENTRY, List); - - if ((FindOpType & MATCH_SW_ADDRESS) != 0) { - // - // Find by the software address. - // - if (!ArpMatchAddress (ProtocolAddress, &CacheEntry->Addresses[Protocol])) { - // - // The ProtocolAddress doesn't match, continue to the next cache entry. - // - continue; - } - } - - if ((FindOpType & MATCH_HW_ADDRESS) != 0) { - // - // Find by the hardware address. - // - if (!ArpMatchAddress (HardwareAddress, &CacheEntry->Addresses[Hardware])) { - // - // The HardwareAddress doesn't match, continue to the next cache entry. - // - continue; - } - } - - // - // The CacheEntry meets the requirements now, return this entry. - // - return CacheEntry; - } - - // - // No matching. - // - return NULL; -} - - -/** - Find the CacheEntry, using ProtocolAddress or HardwareAddress or both, as the keyword, - in the DeniedCacheTable. - - @param[in] ArpService Pointer to the arp service context data. - @param[in] ProtocolAddress Pointer to the protocol address. - @param[in] HardwareAddress Pointer to the hardware address. - - @return Pointer to the matched cache entry, if NULL no match is found. - -**/ -ARP_CACHE_ENTRY * -ArpFindDeniedCacheEntry ( - IN ARP_SERVICE_DATA *ArpService, - IN NET_ARP_ADDRESS *ProtocolAddress OPTIONAL, - IN NET_ARP_ADDRESS *HardwareAddress OPTIONAL - ) -{ - ARP_CACHE_ENTRY *CacheEntry; - - ASSERT ((ProtocolAddress != NULL) || (HardwareAddress != NULL)); - NET_CHECK_SIGNATURE (ArpService, ARP_SERVICE_DATA_SIGNATURE); - - CacheEntry = NULL; - - if ((ProtocolAddress != NULL) && (ProtocolAddress->AddressPtr != NULL)) { - // - // Find the cache entry in the DeniedCacheTable by the protocol address. - // - CacheEntry = ArpFindNextCacheEntryInTable ( - &ArpService->DeniedCacheTable, - NULL, - ByProtoAddress, - ProtocolAddress, - NULL - ); - if (CacheEntry != NULL) { - // - // There is a match. - // - return CacheEntry; - } - } - - if ((HardwareAddress != NULL) && (HardwareAddress->AddressPtr != NULL)) { - // - // Find the cache entry in the DeniedCacheTable by the hardware address. - // - CacheEntry = ArpFindNextCacheEntryInTable ( - &ArpService->DeniedCacheTable, - NULL, - ByHwAddress, - NULL, - HardwareAddress - ); - } - - return CacheEntry; -} - - -/** - Allocate a cache entry and initialize it. - - @param[in] Instance Pointer to the instance context data. - - @return Pointer to the new created cache entry. - -**/ -ARP_CACHE_ENTRY * -ArpAllocCacheEntry ( - IN ARP_INSTANCE_DATA *Instance - ) -{ - ARP_CACHE_ENTRY *CacheEntry; - NET_ARP_ADDRESS *Address; - UINT16 Index; - - // - // Allocate memory for the cache entry. - // - CacheEntry = AllocatePool (sizeof (ARP_CACHE_ENTRY)); - if (CacheEntry == NULL) { - return NULL; - } - - // - // Init the lists. - // - InitializeListHead (&CacheEntry->List); - InitializeListHead (&CacheEntry->UserRequestList); - - for (Index = 0; Index < 2; Index++) { - // - // Init the address pointers to point to the concrete buffer. - // - Address = &CacheEntry->Addresses[Index]; - Address->AddressPtr = Address->Buffer.ProtoAddress; - } - - // - // Zero the hardware address first. - // - ZeroMem (CacheEntry->Addresses[Hardware].AddressPtr, ARP_MAX_HARDWARE_ADDRESS_LEN); - - if (Instance != NULL) { - // - // Inherit the parameters from the instance configuration. - // - CacheEntry->RetryCount = Instance->ConfigData.RetryCount; - CacheEntry->NextRetryTime = Instance->ConfigData.RetryTimeOut; - CacheEntry->DefaultDecayTime = Instance->ConfigData.EntryTimeOut; - CacheEntry->DecayTime = Instance->ConfigData.EntryTimeOut; - } else { - // - // Use the default parameters if this cache entry isn't allocate in a - // instance's scope. - // - CacheEntry->RetryCount = ARP_DEFAULT_RETRY_COUNT; - CacheEntry->NextRetryTime = ARP_DEFAULT_RETRY_INTERVAL; - CacheEntry->DefaultDecayTime = ARP_DEFAULT_TIMEOUT_VALUE; - CacheEntry->DecayTime = ARP_DEFAULT_TIMEOUT_VALUE; - } - - return CacheEntry; -} - - -/** - Turn the CacheEntry into the resolved status. - - @param[in] CacheEntry Pointer to the resolved cache entry. - @param[in] Instance Pointer to the instance context data. - @param[in] UserEvent Pointer to the UserEvent to notify. - - @return The count of notifications sent to the instance. - -**/ -UINTN -ArpAddressResolved ( - IN ARP_CACHE_ENTRY *CacheEntry, - IN ARP_INSTANCE_DATA *Instance OPTIONAL, - IN EFI_EVENT UserEvent OPTIONAL - ) -{ - LIST_ENTRY *Entry; - LIST_ENTRY *NextEntry; - USER_REQUEST_CONTEXT *Context; - UINTN Count; - - Count = 0; - - // - // Iterate all the linked user requests to notify them. - // - NET_LIST_FOR_EACH_SAFE (Entry, NextEntry, &CacheEntry->UserRequestList) { - Context = NET_LIST_USER_STRUCT (Entry, USER_REQUEST_CONTEXT, List); - - if (((Instance == NULL) || (Context->Instance == Instance)) && - ((UserEvent == NULL) || (Context->UserRequestEvent == UserEvent))) { - // - // Copy the address to the user-provided buffer and notify the user. - // - CopyMem ( - Context->UserHwAddrBuffer, - CacheEntry->Addresses[Hardware].AddressPtr, - CacheEntry->Addresses[Hardware].Length - ); - gBS->SignalEvent (Context->UserRequestEvent); - - // - // Remove this user request and free the context data. - // - RemoveEntryList (&Context->List); - FreePool (Context); - - Count++; - } - } - - // - // Dispatch the DPCs queued by the NotifyFunction of the Context->UserRequestEvent. - // - DispatchDpc (); - - return Count; -} - - -/** - Fill the addresses in the CacheEntry using the information passed in by - HwAddr and SwAddr. - - @param[in] CacheEntry Pointer to the cache entry. - @param[in] HwAddr Pointer to the software address. - @param[in] SwAddr Pointer to the hardware address. - - @return None. - -**/ -VOID -ArpFillAddressInCacheEntry ( - IN ARP_CACHE_ENTRY *CacheEntry, - IN NET_ARP_ADDRESS *HwAddr OPTIONAL, - IN NET_ARP_ADDRESS *SwAddr OPTIONAL - ) -{ - NET_ARP_ADDRESS *Address[2]; - NET_ARP_ADDRESS *CacheAddress; - UINT32 Index; - - Address[Hardware] = HwAddr; - Address[Protocol] = SwAddr; - - for (Index = 0; Index < 2; Index++) { - if (Address[Index] != NULL) { - // - // Fill the address if the passed in pointer is not NULL. - // - CacheAddress = &CacheEntry->Addresses[Index]; - - CacheAddress->Type = Address[Index]->Type; - CacheAddress->Length = Address[Index]->Length; - - if (Address[Index]->AddressPtr != NULL) { - // - // Copy it if the AddressPtr points to some buffer. - // - CopyMem ( - CacheAddress->AddressPtr, - Address[Index]->AddressPtr, - CacheAddress->Length - ); - } else { - // - // Zero the corresponding address buffer in the CacheEntry. - // - ZeroMem (CacheAddress->AddressPtr, CacheAddress->Length); - } - } - } -} - - -/** - Configure the instance using the ConfigData. ConfigData is already validated. - - @param[in] Instance Pointer to the instance context data to be - configured. - @param[in] ConfigData Pointer to the configuration data used to - configure the instance. - - @retval EFI_SUCCESS The instance is configured with the ConfigData. - @retval EFI_ACCESS_DENIED The instance is already configured and the - ConfigData tries to reset some unchangeable - fields. - @retval EFI_INVALID_PARAMETER The ConfigData provides a non-unicast IPv4 address - when the SwAddressType is IPv4. - @retval EFI_OUT_OF_RESOURCES The instance fails to configure due to memory - limitation. - -**/ -EFI_STATUS -ArpConfigureInstance ( - IN ARP_INSTANCE_DATA *Instance, - IN EFI_ARP_CONFIG_DATA *ConfigData OPTIONAL - ) -{ - EFI_ARP_CONFIG_DATA *OldConfigData; - IP4_ADDR Ip; - - OldConfigData = &Instance->ConfigData; - - if (ConfigData != NULL) { - - if (Instance->Configured) { - // - // The instance is configured, check the unchangeable fields. - // - if ((OldConfigData->SwAddressType != ConfigData->SwAddressType) || - (OldConfigData->SwAddressLength != ConfigData->SwAddressLength) || - (CompareMem ( - OldConfigData->StationAddress, - ConfigData->StationAddress, - OldConfigData->SwAddressLength - ) != 0)) { - // - // Deny the unallowed changes. - // - return EFI_ACCESS_DENIED; - } - } else { - // - // The instance is not configured. - // - - if (ConfigData->SwAddressType == IPV4_ETHER_PROTO_TYPE) { - CopyMem (&Ip, ConfigData->StationAddress, sizeof (IP4_ADDR)); - - if (IP4_IS_UNSPECIFIED (Ip) || IP4_IS_LOCAL_BROADCAST (Ip)) { - // - // The station address should not be zero or broadcast address. - // - return EFI_INVALID_PARAMETER; - } - } - - // - // Save the configuration. - // - CopyMem (OldConfigData, ConfigData, sizeof (*OldConfigData)); - - OldConfigData->StationAddress = AllocatePool (OldConfigData->SwAddressLength); - if (OldConfigData->StationAddress == NULL) { - DEBUG ((EFI_D_ERROR, "ArpConfigInstance: AllocatePool for the StationAddress " - "failed.\n")); - return EFI_OUT_OF_RESOURCES; - } - - // - // Save the StationAddress. - // - CopyMem ( - OldConfigData->StationAddress, - ConfigData->StationAddress, - OldConfigData->SwAddressLength - ); - - // - // Set the state to configured. - // - Instance->Configured = TRUE; - } - - // - // Use the implementation specific values if the following field is zero. - // - OldConfigData->EntryTimeOut = (ConfigData->EntryTimeOut == 0) ? - ARP_DEFAULT_TIMEOUT_VALUE : ConfigData->EntryTimeOut; - - OldConfigData->RetryCount = (ConfigData->RetryCount == 0) ? - ARP_DEFAULT_RETRY_COUNT : ConfigData->RetryCount; - - OldConfigData->RetryTimeOut = (ConfigData->RetryTimeOut == 0) ? - ARP_DEFAULT_RETRY_INTERVAL : ConfigData->RetryTimeOut; - } else { - // - // Reset the configuration. - // - - if (Instance->Configured) { - // - // Cancel the arp requests issued by this instance. - // - Instance->ArpProto.Cancel (&Instance->ArpProto, NULL, NULL); - - // - // Free the buffer previously allocated to hold the station address. - // - FreePool (OldConfigData->StationAddress); - } - - Instance->Configured = FALSE; - } - - return EFI_SUCCESS; -} - - -/** - Send out an arp frame using the CachEntry and the ArpOpCode. - - @param[in] Instance Pointer to the instance context data. - @param[in] CacheEntry Pointer to the configuration data used to - configure the instance. - @param[in] ArpOpCode The opcode used to send out this Arp frame, either - request or reply. - - @return None. - -**/ -VOID -ArpSendFrame ( - IN ARP_INSTANCE_DATA *Instance, - IN ARP_CACHE_ENTRY *CacheEntry, - IN UINT16 ArpOpCode - ) -{ - EFI_STATUS Status; - EFI_MANAGED_NETWORK_COMPLETION_TOKEN *TxToken; - EFI_MANAGED_NETWORK_TRANSMIT_DATA *TxData; - UINT32 TotalLength; - UINT8 *Packet; - ARP_SERVICE_DATA *ArpService; - EFI_SIMPLE_NETWORK_MODE *SnpMode; - EFI_ARP_CONFIG_DATA *ConfigData; - UINT8 *TmpPtr; - ARP_HEAD *ArpHead; - - ASSERT ((Instance != NULL) && (CacheEntry != NULL)); - - // - // Allocate memory for the TxToken. - // - TxToken = AllocatePool (sizeof(EFI_MANAGED_NETWORK_COMPLETION_TOKEN)); - if (TxToken == NULL) { - DEBUG ((EFI_D_ERROR, "ArpSendFrame: Allocate memory for TxToken failed.\n")); - return; - } - - TxToken->Event = NULL; - TxData = NULL; - Packet = NULL; - - // - // Create the event for this TxToken. - // - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, - ArpOnFrameSent, - (VOID *)TxToken, - &TxToken->Event - ); - if (EFI_ERROR (Status)) { - DEBUG ((EFI_D_ERROR, "ArpSendFrame: CreateEvent failed for TxToken->Event.\n")); - goto CLEAN_EXIT; - } - - // - // Allocate memory for the TxData used in the TxToken. - // - TxData = AllocatePool (sizeof(EFI_MANAGED_NETWORK_TRANSMIT_DATA)); - if (TxData == NULL) { - DEBUG ((EFI_D_ERROR, "ArpSendFrame: Allocate memory for TxData failed.\n")); - goto CLEAN_EXIT; - } - - ArpService = Instance->ArpService; - SnpMode = &ArpService->SnpMode; - ConfigData = &Instance->ConfigData; - - // - // Calculate the buffer length for this arp frame. - // - TotalLength = SnpMode->MediaHeaderSize + sizeof (ARP_HEAD) + - 2 * (ConfigData->SwAddressLength + SnpMode->HwAddressSize); - - // - // Allocate buffer for the arp frame. - // - Packet = AllocatePool (TotalLength); - if (Packet == NULL) { - DEBUG ((EFI_D_ERROR, "ArpSendFrame: Allocate memory for Packet failed.\n")); - ASSERT (Packet != NULL); - } - - TmpPtr = Packet; - - // - // The destination MAC address. - // - if (ArpOpCode == ARP_OPCODE_REQUEST) { - CopyMem (TmpPtr, &SnpMode->BroadcastAddress, SnpMode->HwAddressSize); - } else { - CopyMem ( - TmpPtr, - CacheEntry->Addresses[Hardware].AddressPtr, - SnpMode->HwAddressSize - ); - } - TmpPtr += SnpMode->HwAddressSize; - - // - // The source MAC address. - // - CopyMem (TmpPtr, &SnpMode->CurrentAddress, SnpMode->HwAddressSize); - TmpPtr += SnpMode->HwAddressSize; - - // - // The ethernet protocol type. - // - *(UINT16 *)TmpPtr = HTONS (ARP_ETHER_PROTO_TYPE); - TmpPtr += 2; - - // - // The ARP Head. - // - ArpHead = (ARP_HEAD *) TmpPtr; - ArpHead->HwType = HTONS ((UINT16)SnpMode->IfType); - ArpHead->ProtoType = HTONS (ConfigData->SwAddressType); - ArpHead->HwAddrLen = (UINT8)SnpMode->HwAddressSize; - ArpHead->ProtoAddrLen = ConfigData->SwAddressLength; - ArpHead->OpCode = HTONS (ArpOpCode); - TmpPtr += sizeof (ARP_HEAD); - - // - // The sender hardware address. - // - CopyMem (TmpPtr, &SnpMode->CurrentAddress, SnpMode->HwAddressSize); - TmpPtr += SnpMode->HwAddressSize; - - // - // The sender protocol address. - // - CopyMem (TmpPtr, ConfigData->StationAddress, ConfigData->SwAddressLength); - TmpPtr += ConfigData->SwAddressLength; - - // - // The target hardware address. - // - CopyMem ( - TmpPtr, - CacheEntry->Addresses[Hardware].AddressPtr, - SnpMode->HwAddressSize - ); - TmpPtr += SnpMode->HwAddressSize; - - // - // The target protocol address. - // - CopyMem ( - TmpPtr, - CacheEntry->Addresses[Protocol].AddressPtr, - ConfigData->SwAddressLength - ); - - // - // Set all the fields of the TxData. - // - TxData->DestinationAddress = NULL; - TxData->SourceAddress = NULL; - TxData->ProtocolType = 0; - TxData->DataLength = TotalLength - SnpMode->MediaHeaderSize; - TxData->HeaderLength = (UINT16) SnpMode->MediaHeaderSize; - TxData->FragmentCount = 1; - - TxData->FragmentTable[0].FragmentBuffer = Packet; - TxData->FragmentTable[0].FragmentLength = TotalLength; - - // - // Associate the TxData with the TxToken. - // - TxToken->Packet.TxData = TxData; - TxToken->Status = EFI_NOT_READY; - - // - // Send out this arp packet by Mnp. - // - Status = ArpService->Mnp->Transmit (ArpService->Mnp, TxToken); - if (EFI_ERROR (Status)) { - DEBUG ((EFI_D_ERROR, "Mnp->Transmit failed, %r.\n", Status)); - goto CLEAN_EXIT; - } - - return; - -CLEAN_EXIT: - - if (Packet != NULL) { - FreePool (Packet); - } - - if (TxData != NULL) { - FreePool (TxData); - } - - if (TxToken->Event != NULL) { - gBS->CloseEvent (TxToken->Event); - } - - FreePool (TxToken); -} - - -/** - Delete the cache entries in the specified CacheTable, using the BySwAddress, - SwAddressType, AddressBuffer combination as the matching key, if Force is TRUE, - the cache is deleted event it's a static entry. - - @param[in] CacheTable Pointer to the cache table to do the deletion. - @param[in] BySwAddress Delete the cache entry by software address or by - hardware address. - @param[in] SwAddressType The software address used to do the deletion. - @param[in] AddressBuffer Pointer to the buffer containing the address to - match for the deletion. - @param[in] Force This deletion is forced or not. - - @return The count of the deleted cache entries. - -**/ -UINTN -ArpDeleteCacheEntryInTable ( - IN LIST_ENTRY *CacheTable, - IN BOOLEAN BySwAddress, - IN UINT16 SwAddressType, - IN UINT8 *AddressBuffer OPTIONAL, - IN BOOLEAN Force - ) -{ - LIST_ENTRY *Entry; - LIST_ENTRY *NextEntry; - ARP_CACHE_ENTRY *CacheEntry; - UINTN Count; - - Count = 0; - - NET_LIST_FOR_EACH_SAFE (Entry, NextEntry, CacheTable) { - CacheEntry = NET_LIST_USER_STRUCT (Entry, ARP_CACHE_ENTRY, List); - - if ((CacheEntry->DefaultDecayTime == 0) && !Force) { - // - // It's a static entry and we are not forced to delete it, skip. - // - continue; - } - - if (BySwAddress) { - if (SwAddressType == CacheEntry->Addresses[Protocol].Type) { - // - // Protocol address type matched. Check the address. - // - if ((AddressBuffer == NULL) || - (CompareMem ( - AddressBuffer, - CacheEntry->Addresses[Protocol].AddressPtr, - CacheEntry->Addresses[Protocol].Length - ) == 0)) { - // - // Address matched. - // - goto MATCHED; - } - } - } else { - if ((AddressBuffer == NULL) || - (CompareMem ( - AddressBuffer, - CacheEntry->Addresses[Hardware].AddressPtr, - CacheEntry->Addresses[Hardware].Length - ) == 0)) { - // - // Address matched. - // - goto MATCHED; - } - } - - continue; - -MATCHED: - - // - // Delete this entry. - // - RemoveEntryList (&CacheEntry->List); - ASSERT (IsListEmpty (&CacheEntry->UserRequestList)); - FreePool (CacheEntry); - - Count++; - } - - return Count; -} - - -/** - Delete cache entries in all the cache tables. - - @param[in] Instance Pointer to the instance context data. - @param[in] BySwAddress Delete the cache entry by software address or by - hardware address. - @param[in] AddressBuffer Pointer to the buffer containing the address to - match for the deletion. - @param[in] Force This deletion is forced or not. - - @return The count of the deleted cache entries. - -**/ -UINTN -ArpDeleteCacheEntry ( - IN ARP_INSTANCE_DATA *Instance, - IN BOOLEAN BySwAddress, - IN UINT8 *AddressBuffer OPTIONAL, - IN BOOLEAN Force - ) -{ - ARP_SERVICE_DATA *ArpService; - UINTN Count; - - NET_CHECK_SIGNATURE (Instance, ARP_INSTANCE_DATA_SIGNATURE); - - ArpService = Instance->ArpService; - - // - // Delete the cache entries in the DeniedCacheTable. - // - Count = ArpDeleteCacheEntryInTable ( - &ArpService->DeniedCacheTable, - BySwAddress, - Instance->ConfigData.SwAddressType, - AddressBuffer, - Force - ); - - // - // Delete the cache entries inthe ResolvedCacheTable. - // - Count += ArpDeleteCacheEntryInTable ( - &ArpService->ResolvedCacheTable, - BySwAddress, - Instance->ConfigData.SwAddressType, - AddressBuffer, - Force - ); - - return Count; -} - - -/** - Cancel the arp request. - - @param[in] Instance Pointer to the instance context data. - @param[in] TargetSwAddress Pointer to the buffer containing the target - software address to match the arp request. - @param[in] UserEvent The user event used to notify this request - cancellation. - - @return The count of the cancelled requests. - -**/ -UINTN -ArpCancelRequest ( - IN ARP_INSTANCE_DATA *Instance, - IN VOID *TargetSwAddress OPTIONAL, - IN EFI_EVENT UserEvent OPTIONAL - ) -{ - ARP_SERVICE_DATA *ArpService; - LIST_ENTRY *Entry; - LIST_ENTRY *NextEntry; - ARP_CACHE_ENTRY *CacheEntry; - UINTN Count; - - NET_CHECK_SIGNATURE (Instance, ARP_INSTANCE_DATA_SIGNATURE); - - ArpService = Instance->ArpService; - - Count = 0; - NET_LIST_FOR_EACH_SAFE (Entry, NextEntry, &ArpService->PendingRequestTable) { - CacheEntry = NET_LIST_USER_STRUCT (Entry, ARP_CACHE_ENTRY, List); - - if ((TargetSwAddress == NULL) || - (CompareMem ( - TargetSwAddress, - CacheEntry->Addresses[Protocol].AddressPtr, - CacheEntry->Addresses[Protocol].Length - ) == 0)) { - // - // This request entry matches the TargetSwAddress or all requests are to be - // cancelled as TargetSwAddress is NULL. - // - Count += ArpAddressResolved (CacheEntry, Instance, UserEvent); - - if (IsListEmpty (&CacheEntry->UserRequestList)) { - // - // No user requests any more, remove this request cache entry. - // - RemoveEntryList (&CacheEntry->List); - FreePool (CacheEntry); - } - } - } - - return Count; -} - - -/** - Find the cache entry in the cache table. - - @param[in] Instance Pointer to the instance context data. - @param[in] BySwAddress Set to TRUE to look for matching software protocol - addresses. Set to FALSE to look for matching - hardware protocol addresses. - @param[in] AddressBuffer Pointer to address buffer. Set to NULL to match - all addresses. - @param[out] EntryLength The size of an entry in the entries buffer. - @param[out] EntryCount The number of ARP cache entries that are found by - the specified criteria. - @param[out] Entries Pointer to the buffer that will receive the ARP - cache entries. - @param[in] Refresh Set to TRUE to refresh the timeout value of the - matching ARP cache entry. - - @retval EFI_SUCCESS The requested ARP cache entries are copied into - the buffer. - @retval EFI_NOT_FOUND No matching entries found. - @retval EFI_OUT_OF_RESOURCE There is a memory allocation failure. - -**/ -EFI_STATUS -ArpFindCacheEntry ( - IN ARP_INSTANCE_DATA *Instance, - IN BOOLEAN BySwAddress, - IN VOID *AddressBuffer OPTIONAL, - OUT UINT32 *EntryLength OPTIONAL, - OUT UINT32 *EntryCount OPTIONAL, - OUT EFI_ARP_FIND_DATA **Entries OPTIONAL, - IN BOOLEAN Refresh - ) -{ - EFI_STATUS Status; - ARP_SERVICE_DATA *ArpService; - NET_ARP_ADDRESS MatchAddress; - FIND_OPTYPE FindOpType; - LIST_ENTRY *StartEntry; - ARP_CACHE_ENTRY *CacheEntry; - NET_MAP FoundEntries; - UINT32 FoundCount; - EFI_ARP_FIND_DATA *FindData; - LIST_ENTRY *CacheTable; - UINT32 FoundEntryLength; - - ArpService = Instance->ArpService; - - // - // Init the FounEntries used to hold the found cache entries. - // - NetMapInit (&FoundEntries); - - // - // Set the MatchAddress. - // - if (BySwAddress) { - MatchAddress.Type = Instance->ConfigData.SwAddressType; - MatchAddress.Length = Instance->ConfigData.SwAddressLength; - FindOpType = ByProtoAddress; - } else { - MatchAddress.Type = ArpService->SnpMode.IfType; - MatchAddress.Length = (UINT8)ArpService->SnpMode.HwAddressSize; - FindOpType = ByHwAddress; - } - - MatchAddress.AddressPtr = AddressBuffer; - - // - // Search the DeniedCacheTable - // - StartEntry = NULL; - while (TRUE) { - // - // Try to find the matched entries in the DeniedCacheTable. - // - CacheEntry = ArpFindNextCacheEntryInTable ( - &ArpService->DeniedCacheTable, - StartEntry, - FindOpType, - &MatchAddress, - &MatchAddress - ); - if (CacheEntry == NULL) { - // - // Once the CacheEntry is NULL, there are no more matches. - // - break; - } - - // - // Insert the found entry into the map. - // - NetMapInsertTail ( - &FoundEntries, - (VOID *)CacheEntry, - (VOID *)&ArpService->DeniedCacheTable - ); - - // - // Let the next search start from this cache entry. - // - StartEntry = &CacheEntry->List; - - if (Refresh) { - // - // Refresh the DecayTime if needed. - // - CacheEntry->DecayTime = CacheEntry->DefaultDecayTime; - } - } - - // - // Search the ResolvedCacheTable - // - StartEntry = NULL; - while (TRUE) { - CacheEntry = ArpFindNextCacheEntryInTable ( - &ArpService->ResolvedCacheTable, - StartEntry, - FindOpType, - &MatchAddress, - &MatchAddress - ); - if (CacheEntry == NULL) { - // - // Once the CacheEntry is NULL, there are no more matches. - // - break; - } - - // - // Insert the found entry into the map. - // - NetMapInsertTail ( - &FoundEntries, - (VOID *)CacheEntry, - (VOID *)&ArpService->ResolvedCacheTable - ); - - // - // Let the next search start from this cache entry. - // - StartEntry = &CacheEntry->List; - - if (Refresh) { - // - // Refresh the DecayTime if needed. - // - CacheEntry->DecayTime = CacheEntry->DefaultDecayTime; - } - } - - Status = EFI_SUCCESS; - - FoundCount = (UINT32) NetMapGetCount (&FoundEntries); - if (FoundCount == 0) { - Status = EFI_NOT_FOUND; - goto CLEAN_EXIT; - } - - // - // Found the entry length, make sure its 8 bytes alignment. - // - FoundEntryLength = (((sizeof (EFI_ARP_FIND_DATA) + Instance->ConfigData.SwAddressLength + - ArpService->SnpMode.HwAddressSize) + 3) & ~(0x3)); - - if (EntryLength != NULL) { - *EntryLength = FoundEntryLength; - } - - if (EntryCount != NULL) { - // - // Return the found entry count. - // - *EntryCount = FoundCount; - } - - if (Entries == NULL) { - goto CLEAN_EXIT; - } - - // - // Allocate buffer to copy the found entries. - // - FindData = AllocatePool (FoundCount * FoundEntryLength); - if (FindData == NULL) { - DEBUG ((EFI_D_ERROR, "ArpFindCacheEntry: Failed to allocate memory.\n")); - Status = EFI_OUT_OF_RESOURCES; - goto CLEAN_EXIT; - } - - // - // Return the address to the user. - // - *Entries = FindData; - - // - // Dump the entries. - // - while (!NetMapIsEmpty (&FoundEntries)) { - // - // Get a cache entry from the map. - // - CacheEntry = NetMapRemoveHead (&FoundEntries, (VOID **)&CacheTable); - - // - // Set the fields in FindData. - // - FindData->Size = FoundEntryLength; - FindData->DenyFlag = (BOOLEAN)(CacheTable == &ArpService->DeniedCacheTable); - FindData->StaticFlag = (BOOLEAN)(CacheEntry->DefaultDecayTime == 0); - FindData->HwAddressType = ArpService->SnpMode.IfType; - FindData->SwAddressType = Instance->ConfigData.SwAddressType; - FindData->HwAddressLength = (UINT8)ArpService->SnpMode.HwAddressSize; - FindData->SwAddressLength = Instance->ConfigData.SwAddressLength; - - // - // Copy the software address. - // - CopyMem ( - FindData + 1, - CacheEntry->Addresses[Protocol].AddressPtr, - FindData->SwAddressLength - ); - - // - // Copy the hardware address. - // - CopyMem ( - (UINT8 *)(FindData + 1) + FindData->SwAddressLength, - CacheEntry->Addresses[Hardware].AddressPtr, - FindData->HwAddressLength - ); - - // - // Slip to the next FindData. - // - FindData = (EFI_ARP_FIND_DATA *)((UINT8 *)FindData + FoundEntryLength); - } - -CLEAN_EXIT: - - NetMapClean (&FoundEntries); - - return Status; -} - diff --git a/MdeModulePkg/Universal/Network/ArpDxe/ArpImpl.h b/MdeModulePkg/Universal/Network/ArpDxe/ArpImpl.h deleted file mode 100644 index 47eedc1cb6..0000000000 --- a/MdeModulePkg/Universal/Network/ArpDxe/ArpImpl.h +++ /dev/null @@ -1,770 +0,0 @@ -/** @file - EFI Address Resolution Protocol (ARP) Protocol interface header file. - -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef _ARP_IMPL_H_ -#define _ARP_IMPL_H_ - - -#include - -#include -#include -#include - -#include -#include -#include -#include -#include -#include -#include -#include -#include - -// -// Ethernet protocol type definitions. -// -#define ARP_ETHER_PROTO_TYPE 0x0806 -#define IPV4_ETHER_PROTO_TYPE 0x0800 -#define IPV6_ETHER_PROTO_TYPE 0x86DD - -// -// ARP opcode definitions. -// -#define ARP_OPCODE_REQUEST 0x0001 -#define ARP_OPCODE_REPLY 0x0002 - -// -// ARP timeout, retry count and interval definitions. -// -#define ARP_DEFAULT_TIMEOUT_VALUE (400 * TICKS_PER_SECOND) -#define ARP_DEFAULT_RETRY_COUNT 2 -#define ARP_DEFAULT_RETRY_INTERVAL (5 * TICKS_PER_MS) -#define ARP_PERIODIC_TIMER_INTERVAL (500 * TICKS_PER_MS) - -// -// ARP packet head definition. -// -#pragma pack(1) -typedef struct { - UINT16 HwType; - UINT16 ProtoType; - UINT8 HwAddrLen; - UINT8 ProtoAddrLen; - UINT16 OpCode; -} ARP_HEAD; -#pragma pack() - -// -// ARP Address definition for internal use. -// -typedef struct { - UINT8 *SenderHwAddr; - UINT8 *SenderProtoAddr; - UINT8 *TargetHwAddr; - UINT8 *TargetProtoAddr; -} ARP_ADDRESS; - -#define MATCH_SW_ADDRESS 0x1 -#define MATCH_HW_ADDRESS 0x2 - -// -// Enumeration for the search type. A search type is specified as the keyword to find -// a cache entry in the cache table. -// -typedef enum { - ByNone = 0, - ByProtoAddress = MATCH_SW_ADDRESS, - ByHwAddress = MATCH_HW_ADDRESS, - ByBoth = MATCH_SW_ADDRESS | MATCH_HW_ADDRESS -} FIND_OPTYPE; - -#define ARP_INSTANCE_DATA_SIGNATURE SIGNATURE_32('A', 'R', 'P', 'I') - -/** - Returns a pointer to the ARP_INSTANCE_DATA structure from the input a. - - If the signatures matches, then a pointer to the data structure that contains - a specified field of that data structure is returned. - - @param a Pointer to the field specified by ArpProto within a data - structure of type ARP_INSTANCE_DATA. - -**/ -#define ARP_INSTANCE_DATA_FROM_THIS(a) \ - CR ( \ - (a), \ - ARP_INSTANCE_DATA, \ - ArpProto, \ - ARP_INSTANCE_DATA_SIGNATURE \ - ) - -typedef struct _ARP_SERVICE_DATA ARP_SERVICE_DATA; - -// -// ARP instance context data structure. -// -typedef struct { - UINT32 Signature; - ARP_SERVICE_DATA *ArpService; - EFI_HANDLE Handle; - EFI_ARP_PROTOCOL ArpProto; - LIST_ENTRY List; - EFI_ARP_CONFIG_DATA ConfigData; - BOOLEAN Configured; - BOOLEAN InDestroy; -} ARP_INSTANCE_DATA; - -#define ARP_SERVICE_DATA_SIGNATURE SIGNATURE_32('A', 'R', 'P', 'S') - -/** - Returns a pointer to the ARP_SERVICE_DATA structure from the input a. - - If the signatures matches, then a pointer to the data structure that contains - a specified field of that data structure is returned. - - @param a Pointer to the field specified by ServiceBinding within - a data structure of type ARP_SERVICE_DATA. - -**/ -#define ARP_SERVICE_DATA_FROM_THIS(a) \ - CR ( \ - (a), \ - ARP_SERVICE_DATA, \ - ServiceBinding, \ - ARP_SERVICE_DATA_SIGNATURE \ - ) - -// -// ARP service data structure. -// -struct _ARP_SERVICE_DATA { - UINT32 Signature; - EFI_SERVICE_BINDING_PROTOCOL ServiceBinding; - - EFI_HANDLE MnpChildHandle; - EFI_HANDLE ImageHandle; - EFI_HANDLE ControllerHandle; - - EFI_MANAGED_NETWORK_PROTOCOL *Mnp; - EFI_MANAGED_NETWORK_CONFIG_DATA MnpConfigData; - EFI_MANAGED_NETWORK_COMPLETION_TOKEN RxToken; - - EFI_SIMPLE_NETWORK_MODE SnpMode; - - UINTN ChildrenNumber; - LIST_ENTRY ChildrenList; - - LIST_ENTRY PendingRequestTable; - LIST_ENTRY DeniedCacheTable; - LIST_ENTRY ResolvedCacheTable; - - EFI_EVENT PeriodicTimer; -}; - -// -// User request context structure. -// -typedef struct { - LIST_ENTRY List; - ARP_INSTANCE_DATA *Instance; - EFI_EVENT UserRequestEvent; - VOID *UserHwAddrBuffer; -} USER_REQUEST_CONTEXT; - -#define ARP_MAX_PROTOCOL_ADDRESS_LEN sizeof(EFI_IP_ADDRESS) -#define ARP_MAX_HARDWARE_ADDRESS_LEN sizeof(EFI_MAC_ADDRESS) - -typedef union { - UINT8 ProtoAddress[ARP_MAX_PROTOCOL_ADDRESS_LEN]; - UINT8 HwAddress[ARP_MAX_HARDWARE_ADDRESS_LEN]; -} NET_ARP_ADDRESS_UNION; - -// -// ARP address structure in an ARP packet. -// -typedef struct { - UINT16 Type; - UINT8 Length; - UINT8 *AddressPtr; - NET_ARP_ADDRESS_UNION Buffer; -} NET_ARP_ADDRESS; - -// -// Enumeration for ARP address type. -// -typedef enum { - Hardware, - Protocol -} ARP_ADDRESS_TYPE; - -// -// ARP cache entry definition. -// -typedef struct { - LIST_ENTRY List; - - UINT32 RetryCount; - UINT32 DefaultDecayTime; - UINT32 DecayTime; - UINT32 NextRetryTime; - - NET_ARP_ADDRESS Addresses[2]; - - LIST_ENTRY UserRequestList; -} ARP_CACHE_ENTRY; - -/** - This function is used to assign a station address to the ARP cache for this instance - of the ARP driver. - - Each ARP instance has one station address. The EFI_ARP_PROTOCOL driver will - respond to ARP requests that match this registered station address. A call to - this function with the ConfigData field set to NULL will reset this ARP instance. - - Once a protocol type and station address have been assigned to this ARP instance, - all the following ARP functions will use this information. Attempting to change - the protocol type or station address to a configured ARP instance will result in errors. - - @param This Pointer to the EFI_ARP_PROTOCOL instance. - @param ConfigData Pointer to the EFI_ARP_CONFIG_DATA structure. - - @retval EFI_SUCCESS The new station address was successfully - registered. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - This is NULL. SwAddressLength is zero when - ConfigData is not NULL. StationAddress is NULL - when ConfigData is not NULL. - @retval EFI_ACCESS_DENIED The SwAddressType, SwAddressLength, or - StationAddress is different from the one that is - already registered. - @retval EFI_OUT_OF_RESOURCES Storage for the new StationAddress could not be - allocated. - -**/ -EFI_STATUS -EFIAPI -ArpConfigure ( - IN EFI_ARP_PROTOCOL *This, - IN EFI_ARP_CONFIG_DATA *ConfigData OPTIONAL - ); - -/** - This function is used to insert entries into the ARP cache. - - ARP cache entries are typically inserted and updated by network protocol drivers - as network traffic is processed. Most ARP cache entries will time out and be - deleted if the network traffic stops. ARP cache entries that were inserted - by the Add() function may be static (will not time out) or dynamic (will time out). - Default ARP cache timeout values are not covered in most network protocol - specifications (although RFC 1122 comes pretty close) and will only be - discussed in general in this specification. The timeout values that are - used in the EFI Sample Implementation should be used only as a guideline. - Final product implementations of the EFI network stack should be tuned for - their expected network environments. - - @param This Pointer to the EFI_ARP_PROTOCOL instance. - @param DenyFlag Set to TRUE if this entry is a deny entry. Set to - FALSE if this entry is a normal entry. - @param TargetSwAddress Pointer to a protocol address to add (or deny). - May be set to NULL if DenyFlag is TRUE. - @param TargetHwAddress Pointer to a hardware address to add (or deny). - May be set to NULL if DenyFlag is TRUE. - @param TimeoutValue Time in 100-ns units that this entry will remain - in the ARP cache. A value of zero means that the - entry is permanent. A nonzero value will override - the one given by Configure() if the entry to be - added is a dynamic entry. - @param Overwrite If TRUE, the matching cache entry will be - overwritten with the supplied parameters. If - FALSE, EFI_ACCESS_DENIED is returned if the - corresponding cache entry already exists. - - @retval EFI_SUCCESS The entry has been added or updated. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - This is NULL. DenyFlag is FALSE and - TargetHwAddress is NULL. DenyFlag is FALSE and - TargetSwAddress is NULL. TargetHwAddress is NULL - and TargetSwAddress is NULL. Both TargetSwAddress - and TargetHwAddress are not NULL when DenyFlag is - TRUE. - @retval EFI_OUT_OF_RESOURCES The new ARP cache entry could not be allocated. - @retval EFI_ACCESS_DENIED The ARP cache entry already exists and Overwrite - is not true. - @retval EFI_NOT_STARTED The ARP driver instance has not been configured. - -**/ -EFI_STATUS -EFIAPI -ArpAdd ( - IN EFI_ARP_PROTOCOL *This, - IN BOOLEAN DenyFlag, - IN VOID *TargetSwAddress OPTIONAL, - IN VOID *TargetHwAddress OPTIONAL, - IN UINT32 TimeoutValue, - IN BOOLEAN Overwrite - ); - -/** - This function searches the ARP cache for matching entries and allocates a buffer into - which those entries are copied. - - The first part of the allocated buffer is EFI_ARP_FIND_DATA, following which - are protocol address pairs and hardware address pairs. - When finding a specific protocol address (BySwAddress is TRUE and AddressBuffer - is not NULL), the ARP cache timeout for the found entry is reset if Refresh is - set to TRUE. If the found ARP cache entry is a permanent entry, it is not - affected by Refresh. - - @param This Pointer to the EFI_ARP_PROTOCOL instance. - @param BySwAddress Set to TRUE to look for matching software protocol - addresses. Set to FALSE to look for matching - hardware protocol addresses. - @param AddressBuffer Pointer to address buffer. Set to NULL to match - all addresses. - @param EntryLength The size of an entry in the entries buffer. - @param EntryCount The number of ARP cache entries that are found by - the specified criteria. - @param Entries Pointer to the buffer that will receive the ARP - cache entries. - @param Refresh Set to TRUE to refresh the timeout value of the - matching ARP cache entry. - - @retval EFI_SUCCESS The requested ARP cache entries were copied into - the buffer. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - This is NULL. Both EntryCount and EntryLength are - NULL, when Refresh is FALSE. - @retval EFI_NOT_FOUND No matching entries were found. - @retval EFI_NOT_STARTED The ARP driver instance has not been configured. - -**/ -EFI_STATUS -EFIAPI -ArpFind ( - IN EFI_ARP_PROTOCOL *This, - IN BOOLEAN BySwAddress, - IN VOID *AddressBuffer OPTIONAL, - OUT UINT32 *EntryLength OPTIONAL, - OUT UINT32 *EntryCount OPTIONAL, - OUT EFI_ARP_FIND_DATA **Entries OPTIONAL, - IN BOOLEAN Refresh - ); - -/** - This function removes specified ARP cache entries. - - @param This Pointer to the EFI_ARP_PROTOCOL instance. - @param BySwAddress Set to TRUE to delete matching protocol addresses. - Set to FALSE to delete matching hardware - addresses. - @param AddressBuffer Pointer to the address buffer that is used as a - key to look for the cache entry. Set to NULL to - delete all entries. - - @retval EFI_SUCCESS The entry was removed from the ARP cache. - @retval EFI_INVALID_PARAMETER This is NULL. - @retval EFI_NOT_FOUND The specified deletion key was not found. - @retval EFI_NOT_STARTED The ARP driver instance has not been configured. - -**/ -EFI_STATUS -EFIAPI -ArpDelete ( - IN EFI_ARP_PROTOCOL *This, - IN BOOLEAN BySwAddress, - IN VOID *AddressBuffer OPTIONAL - ); - -/** - This function delete all dynamic entries from the ARP cache that match the specified - software protocol type. - - @param This Pointer to the EFI_ARP_PROTOCOL instance. - - @retval EFI_SUCCESS The cache has been flushed. - @retval EFI_INVALID_PARAMETER This is NULL. - @retval EFI_NOT_FOUND There are no matching dynamic cache entries. - @retval EFI_NOT_STARTED The ARP driver instance has not been configured. - -**/ -EFI_STATUS -EFIAPI -ArpFlush ( - IN EFI_ARP_PROTOCOL *This - ); - -/** - This function tries to resolve the TargetSwAddress and optionally returns a - TargetHwAddress if it already exists in the ARP cache. - - @param This Pointer to the EFI_ARP_PROTOCOL instance. - @param TargetSwAddress Pointer to the protocol address to resolve. - @param ResolvedEvent Pointer to the event that will be signaled when - the address is resolved or some error occurs. - @param TargetHwAddress Pointer to the buffer for the resolved hardware - address in network byte order. - - @retval EFI_SUCCESS The data is copied from the ARP cache into the - TargetHwAddress buffer. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - This is NULL. TargetHwAddress is NULL. - @retval EFI_ACCESS_DENIED The requested address is not present in the normal - ARP cache but is present in the deny address list. - Outgoing traffic to that address is forbidden. - @retval EFI_NOT_STARTED The ARP driver instance has not been configured. - @retval EFI_NOT_READY The request has been started and is not finished. - -**/ -EFI_STATUS -EFIAPI -ArpRequest ( - IN EFI_ARP_PROTOCOL *This, - IN VOID *TargetSwAddress OPTIONAL, - IN EFI_EVENT ResolvedEvent OPTIONAL, - OUT VOID *TargetHwAddress - ); - -/** - This function aborts the previous ARP request (identified by This, TargetSwAddress - and ResolvedEvent) that is issued by EFI_ARP_PROTOCOL.Request(). - - If the request is in the internal ARP request queue, the request is aborted - immediately and its ResolvedEvent is signaled. Only an asynchronous address - request needs to be canceled. If TargeSwAddress and ResolveEvent are both - NULL, all the pending asynchronous requests that have been issued by This - instance will be cancelled and their corresponding events will be signaled. - - @param This Pointer to the EFI_ARP_PROTOCOL instance. - @param TargetSwAddress Pointer to the protocol address in previous - request session. - @param ResolvedEvent Pointer to the event that is used as the - notification event in previous request session. - - @retval EFI_SUCCESS The pending request session(s) is/are aborted and - corresponding event(s) is/are signaled. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - This is NULL. TargetSwAddress is not NULL and - ResolvedEvent is NULL. TargetSwAddress is NULL and - ResolvedEvent is not NULL. - @retval EFI_NOT_STARTED The ARP driver instance has not been configured. - @retval EFI_NOT_FOUND The request is not issued by - EFI_ARP_PROTOCOL.Request(). - -**/ -EFI_STATUS -EFIAPI -ArpCancel ( - IN EFI_ARP_PROTOCOL *This, - IN VOID *TargetSwAddress OPTIONAL, - IN EFI_EVENT ResolvedEvent OPTIONAL - ); - -/** - Configure the instance using the ConfigData. ConfigData is already validated. - - @param[in] Instance Pointer to the instance context data to be - configured. - @param[in] ConfigData Pointer to the configuration data used to - configure the instance. - - @retval EFI_SUCCESS The instance is configured with the ConfigData. - @retval EFI_ACCESS_DENIED The instance is already configured and the - ConfigData tries to reset some unchangeable - fields. - @retval EFI_INVALID_PARAMETER The ConfigData provides a non-unicast IPv4 address - when the SwAddressType is IPv4. - @retval EFI_OUT_OF_RESOURCES The instance fails to configure due to memory - limitation. - -**/ -EFI_STATUS -ArpConfigureInstance ( - IN ARP_INSTANCE_DATA *Instance, - IN EFI_ARP_CONFIG_DATA *ConfigData OPTIONAL - ); - -/** - Find the CacheEntry, using ProtocolAddress or HardwareAddress or both, as the keyword, - in the DeniedCacheTable. - - @param[in] ArpService Pointer to the arp service context data. - @param[in] ProtocolAddress Pointer to the protocol address. - @param[in] HardwareAddress Pointer to the hardware address. - - @return Pointer to the matched cache entry, if NULL no match is found. - -**/ -ARP_CACHE_ENTRY * -ArpFindDeniedCacheEntry ( - IN ARP_SERVICE_DATA *ArpService, - IN NET_ARP_ADDRESS *ProtocolAddress OPTIONAL, - IN NET_ARP_ADDRESS *HardwareAddress OPTIONAL - ); - -/** - Find the CacheEntry which matches the requirements in the specified CacheTable. - - @param[in] CacheTable Pointer to the arp cache table. - @param[in] StartEntry Pointer to the start entry this search begins with - in the cache table. - @param[in] FindOpType The search type. - @param[in] ProtocolAddress Pointer to the protocol address to match. - @param[in] HardwareAddress Pointer to the hardware address to match. - - @return Pointer to the matched arp cache entry, if NULL, no match is found. - -**/ -ARP_CACHE_ENTRY * -ArpFindNextCacheEntryInTable ( - IN LIST_ENTRY *CacheTable, - IN LIST_ENTRY *StartEntry, - IN FIND_OPTYPE FindOpType, - IN NET_ARP_ADDRESS *ProtocolAddress OPTIONAL, - IN NET_ARP_ADDRESS *HardwareAddress OPTIONAL - ); - -/** - Allocate a cache entry and initialize it. - - @param[in] Instance Pointer to the instance context data. - - @return Pointer to the new created cache entry. - -**/ -ARP_CACHE_ENTRY * -ArpAllocCacheEntry ( - IN ARP_INSTANCE_DATA *Instance - ); - -/** - Fill the addresses in the CacheEntry using the information passed in by - HwAddr and SwAddr. - - @param[in] CacheEntry Pointer to the cache entry. - @param[in] HwAddr Pointer to the software address. - @param[in] SwAddr Pointer to the hardware address. - - @return None. - -**/ -VOID -ArpFillAddressInCacheEntry ( - IN ARP_CACHE_ENTRY *CacheEntry, - IN NET_ARP_ADDRESS *HwAddr OPTIONAL, - IN NET_ARP_ADDRESS *SwAddr OPTIONAL - ); - -/** - Turn the CacheEntry into the resolved status. - - @param[in] CacheEntry Pointer to the resolved cache entry. - @param[in] Instance Pointer to the instance context data. - @param[in] UserEvent Pointer to the UserEvent to notify. - - @return The count of notifications sent to the instance. - -**/ -UINTN -ArpAddressResolved ( - IN ARP_CACHE_ENTRY *CacheEntry, - IN ARP_INSTANCE_DATA *Instance OPTIONAL, - IN EFI_EVENT UserEvent OPTIONAL - ); - -/** - Delete cache entries in all the cache tables. - - @param[in] Instance Pointer to the instance context data. - @param[in] BySwAddress Delete the cache entry by software address or by - hardware address. - @param[in] AddressBuffer Pointer to the buffer containing the address to - match for the deletion. - @param[in] Force This deletion is forced or not. - - @return The count of the deleted cache entries. - -**/ -UINTN -ArpDeleteCacheEntry ( - IN ARP_INSTANCE_DATA *Instance, - IN BOOLEAN BySwAddress, - IN UINT8 *AddressBuffer OPTIONAL, - IN BOOLEAN Force - ); - -/** - Send out an arp frame using the CachEntry and the ArpOpCode. - - @param[in] Instance Pointer to the instance context data. - @param[in] CacheEntry Pointer to the configuration data used to - configure the instance. - @param[in] ArpOpCode The opcode used to send out this Arp frame, either - request or reply. - - @return None. - -**/ -VOID -ArpSendFrame ( - IN ARP_INSTANCE_DATA *Instance, - IN ARP_CACHE_ENTRY *CacheEntry, - IN UINT16 ArpOpCode - ); - -/** - Initialize the instance context data. - - @param[in] ArpService Pointer to the arp service context data this - instance belongs to. - @param[out] Instance Pointer to the instance context data. - - @return None. - -**/ -VOID -ArpInitInstance ( - IN ARP_SERVICE_DATA *ArpService, - OUT ARP_INSTANCE_DATA *Instance - ); - -/** - Process the Arp packets received from Mnp, the procedure conforms to RFC826. - - @param[in] Context Pointer to the context data registerd to the - Event. - - @return None. - -**/ -VOID -EFIAPI -ArpOnFrameRcvdDpc ( - IN VOID *Context - ); - -/** - Queue ArpOnFrameRcvdDpc as a DPC at TPL_CALLBACK. - - @param[in] Event The Event this notify function registered to. - @param[in] Context Pointer to the context data registerd to the - Event. - - @return None. - -**/ -VOID -EFIAPI -ArpOnFrameRcvd ( - IN EFI_EVENT Event, - IN VOID *Context - ); - -/** - Process the already sent arp packets. - - @param[in] Context Pointer to the context data registerd to the - Event. - - @return None. - -**/ -VOID -EFIAPI -ArpOnFrameSentDpc ( - IN VOID *Context - ); - -/** - Request ArpOnFrameSentDpc as a DPC at TPL_CALLBACK. - - @param[in] Event The Event this notify function registered to. - @param[in] Context Pointer to the context data registerd to the - Event. - - @return None. - -**/ -VOID -EFIAPI -ArpOnFrameSent ( - IN EFI_EVENT Event, - IN VOID *Context - ); - -/** - Process the arp cache olding and drive the retrying arp requests. - - @param[in] Event The Event this notify function registered to. - @param[in] Context Pointer to the context data registerd to the - Event. - - @return None. - -**/ -VOID -EFIAPI -ArpTimerHandler ( - IN EFI_EVENT Event, - IN VOID *Context - ); - -/** - Cancel the arp request. - - @param[in] Instance Pointer to the instance context data. - @param[in] TargetSwAddress Pointer to the buffer containing the target - software address to match the arp request. - @param[in] UserEvent The user event used to notify this request - cancellation. - - @return The count of the cancelled requests. - -**/ -UINTN -ArpCancelRequest ( - IN ARP_INSTANCE_DATA *Instance, - IN VOID *TargetSwAddress OPTIONAL, - IN EFI_EVENT UserEvent OPTIONAL - ); - -/** - Find the cache entry in the cache table. - - @param[in] Instance Pointer to the instance context data. - @param[in] BySwAddress Set to TRUE to look for matching software protocol - addresses. Set to FALSE to look for matching - hardware protocol addresses. - @param[in] AddressBuffer Pointer to address buffer. Set to NULL to match - all addresses. - @param[out] EntryLength The size of an entry in the entries buffer. - @param[out] EntryCount The number of ARP cache entries that are found by - the specified criteria. - @param[out] Entries Pointer to the buffer that will receive the ARP - cache entries. - @param[in] Refresh Set to TRUE to refresh the timeout value of the - matching ARP cache entry. - - @retval EFI_SUCCESS The requested ARP cache entries are copied into - the buffer. - @retval EFI_NOT_FOUND No matching entries found. - @retval EFI_OUT_OF_RESOURCE There is a memory allocation failure. - -**/ -EFI_STATUS -ArpFindCacheEntry ( - IN ARP_INSTANCE_DATA *Instance, - IN BOOLEAN BySwAddress, - IN VOID *AddressBuffer OPTIONAL, - OUT UINT32 *EntryLength OPTIONAL, - OUT UINT32 *EntryCount OPTIONAL, - OUT EFI_ARP_FIND_DATA **Entries OPTIONAL, - IN BOOLEAN Refresh - ); - -#endif diff --git a/MdeModulePkg/Universal/Network/ArpDxe/ArpMain.c b/MdeModulePkg/Universal/Network/ArpDxe/ArpMain.c deleted file mode 100644 index f06121fed4..0000000000 --- a/MdeModulePkg/Universal/Network/ArpDxe/ArpMain.c +++ /dev/null @@ -1,739 +0,0 @@ -/** @file - Implementation of EFI Address Resolution Protocol (ARP) Protocol interface functions. - -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "ArpImpl.h" - - -/** - This function is used to assign a station address to the ARP cache for this instance - of the ARP driver. - - Each ARP instance has one station address. The EFI_ARP_PROTOCOL driver will - respond to ARP requests that match this registered station address. A call to - this function with the ConfigData field set to NULL will reset this ARP instance. - - Once a protocol type and station address have been assigned to this ARP instance, - all the following ARP functions will use this information. Attempting to change - the protocol type or station address to a configured ARP instance will result in errors. - - @param This Pointer to the EFI_ARP_PROTOCOL instance. - @param ConfigData Pointer to the EFI_ARP_CONFIG_DATA structure. - - @retval EFI_SUCCESS The new station address was successfully - registered. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - This is NULL. SwAddressLength is zero when - ConfigData is not NULL. StationAddress is NULL - when ConfigData is not NULL. - @retval EFI_ACCESS_DENIED The SwAddressType, SwAddressLength, or - StationAddress is different from the one that is - already registered. - @retval EFI_OUT_OF_RESOURCES Storage for the new StationAddress could not be - allocated. - -**/ -EFI_STATUS -EFIAPI -ArpConfigure ( - IN EFI_ARP_PROTOCOL *This, - IN EFI_ARP_CONFIG_DATA *ConfigData OPTIONAL - ) -{ - EFI_STATUS Status; - ARP_INSTANCE_DATA *Instance; - EFI_TPL OldTpl; - - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - if ((ConfigData != NULL) && - ((ConfigData->SwAddressLength == 0) || - (ConfigData->StationAddress == NULL) || - (ConfigData->SwAddressType <= 1500))) { - return EFI_INVALID_PARAMETER; - } - - Instance = ARP_INSTANCE_DATA_FROM_THIS (This); - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - // - // Configure this instance, the ConfigData has already passed the basic checks. - // - Status = ArpConfigureInstance (Instance, ConfigData); - - gBS->RestoreTPL (OldTpl); - - return Status; -} - - -/** - This function is used to insert entries into the ARP cache. - - ARP cache entries are typically inserted and updated by network protocol drivers - as network traffic is processed. Most ARP cache entries will time out and be - deleted if the network traffic stops. ARP cache entries that were inserted - by the Add() function may be static (will not time out) or dynamic (will time out). - Default ARP cache timeout values are not covered in most network protocol - specifications (although RFC 1122 comes pretty close) and will only be - discussed in general in this specification. The timeout values that are - used in the EFI Sample Implementation should be used only as a guideline. - Final product implementations of the EFI network stack should be tuned for - their expected network environments. - - @param This Pointer to the EFI_ARP_PROTOCOL instance. - @param DenyFlag Set to TRUE if this entry is a deny entry. Set to - FALSE if this entry is a normal entry. - @param TargetSwAddress Pointer to a protocol address to add (or deny). - May be set to NULL if DenyFlag is TRUE. - @param TargetHwAddress Pointer to a hardware address to add (or deny). - May be set to NULL if DenyFlag is TRUE. - @param TimeoutValue Time in 100-ns units that this entry will remain - in the ARP cache. A value of zero means that the - entry is permanent. A nonzero value will override - the one given by Configure() if the entry to be - added is a dynamic entry. - @param Overwrite If TRUE, the matching cache entry will be - overwritten with the supplied parameters. If - FALSE, EFI_ACCESS_DENIED is returned if the - corresponding cache entry already exists. - - @retval EFI_SUCCESS The entry has been added or updated. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - This is NULL. DenyFlag is FALSE and - TargetHwAddress is NULL. DenyFlag is FALSE and - TargetSwAddress is NULL. TargetHwAddress is NULL - and TargetSwAddress is NULL. Both TargetSwAddress - and TargetHwAddress are not NULL when DenyFlag is - TRUE. - @retval EFI_OUT_OF_RESOURCES The new ARP cache entry could not be allocated. - @retval EFI_ACCESS_DENIED The ARP cache entry already exists and Overwrite - is not true. - @retval EFI_NOT_STARTED The ARP driver instance has not been configured. - -**/ -EFI_STATUS -EFIAPI -ArpAdd ( - IN EFI_ARP_PROTOCOL *This, - IN BOOLEAN DenyFlag, - IN VOID *TargetSwAddress OPTIONAL, - IN VOID *TargetHwAddress OPTIONAL, - IN UINT32 TimeoutValue, - IN BOOLEAN Overwrite - ) -{ - EFI_STATUS Status; - ARP_INSTANCE_DATA *Instance; - ARP_SERVICE_DATA *ArpService; - ARP_CACHE_ENTRY *CacheEntry; - EFI_SIMPLE_NETWORK_MODE *SnpMode; - NET_ARP_ADDRESS MatchAddress[2]; - EFI_TPL OldTpl; - - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - if (((!DenyFlag) && ((TargetHwAddress == NULL) || (TargetSwAddress == NULL))) || - (DenyFlag && (TargetHwAddress != NULL) && (TargetSwAddress != NULL)) || - ((TargetHwAddress == NULL) && (TargetSwAddress == NULL))) { - return EFI_INVALID_PARAMETER; - } - - Instance = ARP_INSTANCE_DATA_FROM_THIS (This); - - if (!Instance->Configured) { - return EFI_NOT_STARTED; - } - - Status = EFI_SUCCESS; - ArpService = Instance->ArpService; - SnpMode = &Instance->ArpService->SnpMode; - - // - // Fill the hardware address part in the MatchAddress. - // - MatchAddress[Hardware].Type = SnpMode->IfType; - MatchAddress[Hardware].Length = (UINT8) SnpMode->HwAddressSize; - MatchAddress[Hardware].AddressPtr = TargetHwAddress; - - // - // Fill the software address part in the MatchAddress. - // - MatchAddress[Protocol].Type = Instance->ConfigData.SwAddressType; - MatchAddress[Protocol].Length = Instance->ConfigData.SwAddressLength; - MatchAddress[Protocol].AddressPtr = TargetSwAddress; - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - // - // See whether the entry to add exists. Check the DeinedCacheTable first. - // - CacheEntry = ArpFindDeniedCacheEntry ( - ArpService, - &MatchAddress[Protocol], - &MatchAddress[Hardware] - ); - - if (CacheEntry == NULL) { - // - // Check the ResolvedCacheTable - // - CacheEntry = ArpFindNextCacheEntryInTable ( - &ArpService->ResolvedCacheTable, - NULL, - ByBoth, - &MatchAddress[Protocol], - &MatchAddress[Hardware] - ); - } - - if ((CacheEntry != NULL) && !Overwrite) { - // - // The entry to add exists, if not Overwirte, deny this add request. - // - Status = EFI_ACCESS_DENIED; - goto UNLOCK_EXIT; - } - - if ((CacheEntry == NULL) && (TargetSwAddress != NULL)) { - // - // Check whether there are pending requests matching the entry to be added. - // - CacheEntry = ArpFindNextCacheEntryInTable ( - &ArpService->PendingRequestTable, - NULL, - ByProtoAddress, - &MatchAddress[Protocol], - NULL - ); - } - - if (CacheEntry != NULL) { - // - // Remove it from the Table. - // - RemoveEntryList (&CacheEntry->List); - } else { - // - // It's a new entry, allocate memory for the entry. - // - CacheEntry = ArpAllocCacheEntry (Instance); - - if (CacheEntry == NULL) { - DEBUG ((EFI_D_ERROR, "ArpAdd: Failed to allocate pool for CacheEntry.\n")); - Status = EFI_OUT_OF_RESOURCES; - goto UNLOCK_EXIT; - } - } - - // - // Overwrite these parameters. - // - CacheEntry->DefaultDecayTime = TimeoutValue; - CacheEntry->DecayTime = TimeoutValue; - - // - // Fill in the addresses. - // - ArpFillAddressInCacheEntry ( - CacheEntry, - &MatchAddress[Hardware], - &MatchAddress[Protocol] - ); - - // - // Inform the user if there is any. - // - ArpAddressResolved (CacheEntry, NULL, NULL); - - // - // Add this CacheEntry to the corresponding CacheTable. - // - if (DenyFlag) { - InsertHeadList (&ArpService->DeniedCacheTable, &CacheEntry->List); - } else { - InsertHeadList (&ArpService->ResolvedCacheTable, &CacheEntry->List); - } - -UNLOCK_EXIT: - - gBS->RestoreTPL (OldTpl); - - return Status; -} - - -/** - This function searches the ARP cache for matching entries and allocates a buffer into - which those entries are copied. - - The first part of the allocated buffer is EFI_ARP_FIND_DATA, following which - are protocol address pairs and hardware address pairs. - When finding a specific protocol address (BySwAddress is TRUE and AddressBuffer - is not NULL), the ARP cache timeout for the found entry is reset if Refresh is - set to TRUE. If the found ARP cache entry is a permanent entry, it is not - affected by Refresh. - - @param This Pointer to the EFI_ARP_PROTOCOL instance. - @param BySwAddress Set to TRUE to look for matching software protocol - addresses. Set to FALSE to look for matching - hardware protocol addresses. - @param AddressBuffer Pointer to address buffer. Set to NULL to match - all addresses. - @param EntryLength The size of an entry in the entries buffer. - @param EntryCount The number of ARP cache entries that are found by - the specified criteria. - @param Entries Pointer to the buffer that will receive the ARP - cache entries. - @param Refresh Set to TRUE to refresh the timeout value of the - matching ARP cache entry. - - @retval EFI_SUCCESS The requested ARP cache entries were copied into - the buffer. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - This is NULL. Both EntryCount and EntryLength are - NULL, when Refresh is FALSE. - @retval EFI_NOT_FOUND No matching entries were found. - @retval EFI_NOT_STARTED The ARP driver instance has not been configured. - -**/ -EFI_STATUS -EFIAPI -ArpFind ( - IN EFI_ARP_PROTOCOL *This, - IN BOOLEAN BySwAddress, - IN VOID *AddressBuffer OPTIONAL, - OUT UINT32 *EntryLength OPTIONAL, - OUT UINT32 *EntryCount OPTIONAL, - OUT EFI_ARP_FIND_DATA **Entries OPTIONAL, - IN BOOLEAN Refresh - ) -{ - EFI_STATUS Status; - ARP_INSTANCE_DATA *Instance; - EFI_TPL OldTpl; - - if ((This == NULL) || - (!Refresh && (EntryCount == NULL) && (EntryLength == NULL)) || - ((Entries != NULL) && ((EntryLength == NULL) || (EntryCount == NULL)))) { - return EFI_INVALID_PARAMETER; - } - - Instance = ARP_INSTANCE_DATA_FROM_THIS (This); - - if (!Instance->Configured) { - return EFI_NOT_STARTED; - } - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - // - // All the check passed, find the cache entries now. - // - Status = ArpFindCacheEntry ( - Instance, - BySwAddress, - AddressBuffer, - EntryLength, - EntryCount, - Entries, - Refresh - ); - - gBS->RestoreTPL (OldTpl); - - return Status; -} - - -/** - This function removes specified ARP cache entries. - - @param This Pointer to the EFI_ARP_PROTOCOL instance. - @param BySwAddress Set to TRUE to delete matching protocol addresses. - Set to FALSE to delete matching hardware - addresses. - @param AddressBuffer Pointer to the address buffer that is used as a - key to look for the cache entry. Set to NULL to - delete all entries. - - @retval EFI_SUCCESS The entry was removed from the ARP cache. - @retval EFI_INVALID_PARAMETER This is NULL. - @retval EFI_NOT_FOUND The specified deletion key was not found. - @retval EFI_NOT_STARTED The ARP driver instance has not been configured. - -**/ -EFI_STATUS -EFIAPI -ArpDelete ( - IN EFI_ARP_PROTOCOL *This, - IN BOOLEAN BySwAddress, - IN VOID *AddressBuffer OPTIONAL - ) -{ - ARP_INSTANCE_DATA *Instance; - UINTN Count; - EFI_TPL OldTpl; - - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - Instance = ARP_INSTANCE_DATA_FROM_THIS (This); - - if (!Instance->Configured) { - return EFI_NOT_STARTED; - } - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - // - // Delete the specified cache entries. - // - Count = ArpDeleteCacheEntry (Instance, BySwAddress, AddressBuffer, TRUE); - - gBS->RestoreTPL (OldTpl); - - return (Count == 0) ? EFI_NOT_FOUND : EFI_SUCCESS; -} - - -/** - This function delete all dynamic entries from the ARP cache that match the specified - software protocol type. - - @param This Pointer to the EFI_ARP_PROTOCOL instance. - - @retval EFI_SUCCESS The cache has been flushed. - @retval EFI_INVALID_PARAMETER This is NULL. - @retval EFI_NOT_FOUND There are no matching dynamic cache entries. - @retval EFI_NOT_STARTED The ARP driver instance has not been configured. - -**/ -EFI_STATUS -EFIAPI -ArpFlush ( - IN EFI_ARP_PROTOCOL *This - ) -{ - ARP_INSTANCE_DATA *Instance; - UINTN Count; - EFI_TPL OldTpl; - - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - Instance = ARP_INSTANCE_DATA_FROM_THIS (This); - - if (!Instance->Configured) { - return EFI_NOT_STARTED; - } - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - // - // Delete the dynamic entries from the cache table. - // - Count = ArpDeleteCacheEntry (Instance, FALSE, NULL, FALSE); - - gBS->RestoreTPL (OldTpl); - - return (Count == 0) ? EFI_NOT_FOUND : EFI_SUCCESS; -} - - -/** - This function tries to resolve the TargetSwAddress and optionally returns a - TargetHwAddress if it already exists in the ARP cache. - - @param This Pointer to the EFI_ARP_PROTOCOL instance. - @param TargetSwAddress Pointer to the protocol address to resolve. - @param ResolvedEvent Pointer to the event that will be signaled when - the address is resolved or some error occurs. - @param TargetHwAddress Pointer to the buffer for the resolved hardware - address in network byte order. - - @retval EFI_SUCCESS The data is copied from the ARP cache into the - TargetHwAddress buffer. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - This is NULL. TargetHwAddress is NULL. - @retval EFI_ACCESS_DENIED The requested address is not present in the normal - ARP cache but is present in the deny address list. - Outgoing traffic to that address is forbidden. - @retval EFI_NOT_STARTED The ARP driver instance has not been configured. - @retval EFI_NOT_READY The request has been started and is not finished. - -**/ -EFI_STATUS -EFIAPI -ArpRequest ( - IN EFI_ARP_PROTOCOL *This, - IN VOID *TargetSwAddress OPTIONAL, - IN EFI_EVENT ResolvedEvent OPTIONAL, - OUT VOID *TargetHwAddress - ) -{ - EFI_STATUS Status; - ARP_INSTANCE_DATA *Instance; - ARP_SERVICE_DATA *ArpService; - EFI_SIMPLE_NETWORK_MODE *SnpMode; - ARP_CACHE_ENTRY *CacheEntry; - NET_ARP_ADDRESS HardwareAddress; - NET_ARP_ADDRESS ProtocolAddress; - USER_REQUEST_CONTEXT *RequestContext; - EFI_TPL OldTpl; - - if ((This == NULL) || (TargetHwAddress == NULL)) { - return EFI_INVALID_PARAMETER; - } - - Instance = ARP_INSTANCE_DATA_FROM_THIS (This); - - if (!Instance->Configured) { - return EFI_NOT_STARTED; - } - - Status = EFI_SUCCESS; - ArpService = Instance->ArpService; - SnpMode = &ArpService->SnpMode; - - if ((TargetSwAddress == NULL) || - ((Instance->ConfigData.SwAddressType == IPV4_ETHER_PROTO_TYPE) && - IP4_IS_LOCAL_BROADCAST (*((UINT32 *)TargetSwAddress)))) { - // - // Return the hardware broadcast address. - // - CopyMem (TargetHwAddress, &SnpMode->BroadcastAddress, SnpMode->HwAddressSize); - - goto SIGNAL_USER; - } - - if ((Instance->ConfigData.SwAddressType == IPV4_ETHER_PROTO_TYPE) && - IP4_IS_MULTICAST (NTOHL (*((UINT32 *)TargetSwAddress)))) { - // - // If the software address is an IPv4 multicast address, invoke Mnp to - // resolve the address. - // - Status = ArpService->Mnp->McastIpToMac ( - ArpService->Mnp, - FALSE, - TargetSwAddress, - TargetHwAddress - ); - goto SIGNAL_USER; - } - - HardwareAddress.Type = SnpMode->IfType; - HardwareAddress.Length = (UINT8)SnpMode->HwAddressSize; - HardwareAddress.AddressPtr = NULL; - - ProtocolAddress.Type = Instance->ConfigData.SwAddressType; - ProtocolAddress.Length = Instance->ConfigData.SwAddressLength; - ProtocolAddress.AddressPtr = TargetSwAddress; - - // - // Initialize the TargetHwAddrss to a zero address. - // - ZeroMem (TargetHwAddress, SnpMode->HwAddressSize); - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - // - // Check whether the software address is in the denied table. - // - CacheEntry = ArpFindDeniedCacheEntry (ArpService, &ProtocolAddress, NULL); - if (CacheEntry != NULL) { - Status = EFI_ACCESS_DENIED; - goto UNLOCK_EXIT; - } - - // - // Check whether the software address is already resolved. - // - CacheEntry = ArpFindNextCacheEntryInTable ( - &ArpService->ResolvedCacheTable, - NULL, - ByProtoAddress, - &ProtocolAddress, - NULL - ); - if (CacheEntry != NULL) { - // - // Resolved, copy the address into the user buffer. - // - CopyMem ( - TargetHwAddress, - CacheEntry->Addresses[Hardware].AddressPtr, - CacheEntry->Addresses[Hardware].Length - ); - - goto UNLOCK_EXIT; - } - - if (ResolvedEvent == NULL) { - Status = EFI_NOT_READY; - goto UNLOCK_EXIT; - } - - // - // Create a request context for this arp request. - // - RequestContext = AllocatePool (sizeof(USER_REQUEST_CONTEXT)); - if (RequestContext == NULL) { - DEBUG ((EFI_D_ERROR, "ArpRequest: Allocate memory for RequestContext failed.\n")); - - Status = EFI_OUT_OF_RESOURCES; - goto UNLOCK_EXIT; - } - - RequestContext->Instance = Instance; - RequestContext->UserRequestEvent = ResolvedEvent; - RequestContext->UserHwAddrBuffer = TargetHwAddress; - InitializeListHead (&RequestContext->List); - - // - // Check whether there is a same request. - // - CacheEntry = ArpFindNextCacheEntryInTable ( - &ArpService->PendingRequestTable, - NULL, - ByProtoAddress, - &ProtocolAddress, - NULL - ); - if (CacheEntry != NULL) { - - CacheEntry->NextRetryTime = Instance->ConfigData.RetryTimeOut; - CacheEntry->RetryCount = Instance->ConfigData.RetryCount; - } else { - // - // Allocate a cache entry for this request. - // - CacheEntry = ArpAllocCacheEntry (Instance); - if (CacheEntry == NULL) { - DEBUG ((EFI_D_ERROR, "ArpRequest: Allocate memory for CacheEntry failed.\n")); - FreePool (RequestContext); - - Status = EFI_OUT_OF_RESOURCES; - goto UNLOCK_EXIT; - } - - // - // Fill the software address. - // - ArpFillAddressInCacheEntry (CacheEntry, &HardwareAddress, &ProtocolAddress); - - // - // Add this entry into the PendingRequestTable. - // - InsertTailList (&ArpService->PendingRequestTable, &CacheEntry->List); - } - - // - // Link this request context into the cache entry. - // - InsertHeadList (&CacheEntry->UserRequestList, &RequestContext->List); - - // - // Send out the ARP Request frame. - // - ArpSendFrame (Instance, CacheEntry, ARP_OPCODE_REQUEST); - Status = EFI_NOT_READY; - -UNLOCK_EXIT: - - gBS->RestoreTPL (OldTpl); - -SIGNAL_USER: - - if ((ResolvedEvent != NULL) && (Status == EFI_SUCCESS)) { - gBS->SignalEvent (ResolvedEvent); - - // - // Dispatch the DPC queued by the NotifyFunction of ResolvedEvent. - // - DispatchDpc (); - } - - return Status; -} - - -/** - This function aborts the previous ARP request (identified by This, TargetSwAddress - and ResolvedEvent) that is issued by EFI_ARP_PROTOCOL.Request(). - - If the request is in the internal ARP request queue, the request is aborted - immediately and its ResolvedEvent is signaled. Only an asynchronous address - request needs to be canceled. If TargeSwAddress and ResolveEvent are both - NULL, all the pending asynchronous requests that have been issued by This - instance will be cancelled and their corresponding events will be signaled. - - @param This Pointer to the EFI_ARP_PROTOCOL instance. - @param TargetSwAddress Pointer to the protocol address in previous - request session. - @param ResolvedEvent Pointer to the event that is used as the - notification event in previous request session. - - @retval EFI_SUCCESS The pending request session(s) is/are aborted and - corresponding event(s) is/are signaled. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - This is NULL. TargetSwAddress is not NULL and - ResolvedEvent is NULL. TargetSwAddress is NULL and - ResolvedEvent is not NULL. - @retval EFI_NOT_STARTED The ARP driver instance has not been configured. - @retval EFI_NOT_FOUND The request is not issued by - EFI_ARP_PROTOCOL.Request(). - -**/ -EFI_STATUS -EFIAPI -ArpCancel ( - IN EFI_ARP_PROTOCOL *This, - IN VOID *TargetSwAddress OPTIONAL, - IN EFI_EVENT ResolvedEvent OPTIONAL - ) -{ - ARP_INSTANCE_DATA *Instance; - UINTN Count; - EFI_TPL OldTpl; - - if ((This == NULL) || - ((TargetSwAddress != NULL) && (ResolvedEvent == NULL)) || - ((TargetSwAddress == NULL) && (ResolvedEvent != NULL))) { - return EFI_INVALID_PARAMETER; - } - - Instance = ARP_INSTANCE_DATA_FROM_THIS (This); - - if (!Instance->Configured) { - return EFI_NOT_STARTED; - } - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - // - // Cancel the specified request. - // - Count = ArpCancelRequest (Instance, TargetSwAddress, ResolvedEvent); - - // - // Dispatch the DPCs queued by the NotifyFunction of the events signaled - // by ArpCancleRequest. - // - DispatchDpc (); - - gBS->RestoreTPL (OldTpl); - - return (Count == 0) ? EFI_NOT_FOUND : EFI_SUCCESS; -} diff --git a/MdeModulePkg/Universal/Network/ArpDxe/ComponentName.c b/MdeModulePkg/Universal/Network/ArpDxe/ComponentName.c deleted file mode 100644 index bcee1e1444..0000000000 --- a/MdeModulePkg/Universal/Network/ArpDxe/ComponentName.c +++ /dev/null @@ -1,219 +0,0 @@ -/** @file - UEFI Component Name(2) protocol implementation for ArpDxe driver. - -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "ArpDriver.h" - - -// -// EFI Component Name Protocol -// -GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gArpComponentName = { - ArpComponentNameGetDriverName, - ArpComponentNameGetControllerName, - "eng" -}; - -// -// EFI Component Name 2 Protocol -// -GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gArpComponentName2 = { - (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) ArpComponentNameGetDriverName, - (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) ArpComponentNameGetControllerName, - "en" -}; - - -GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mArpDriverNameTable[] = { - { "eng;en", L"ARP Network Service Driver" }, - { NULL, NULL } -}; - -GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mArpControllerNameTable[] = { - { "eng;en", L"ARP Controller" }, - { NULL, NULL } -}; - -/** - Retrieves a Unicode string that is the user readable name of the driver. - - This function retrieves the user readable name of a driver in the form of a - Unicode string. If the driver specified by This has a user readable name in - the language specified by Language, then a pointer to the driver name is - returned in DriverName, and EFI_SUCCESS is returned. If the driver specified - by This does not support the language specified by Language, - then EFI_UNSUPPORTED is returned. - - @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param[in] Language A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified - in RFC 4646 or ISO 639-2 language code format. - - @param[out] DriverName A pointer to the Unicode string to return. - This Unicode string is the name of the - driver specified by This in the language - specified by Language. - - @retval EFI_SUCCESS The Unicode string for the Driver specified by - This and the language specified by Language was - returned in DriverName. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER DriverName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -ArpComponentNameGetDriverName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN CHAR8 *Language, - OUT CHAR16 **DriverName - ) -{ - return LookupUnicodeString2 ( - Language, - This->SupportedLanguages, - mArpDriverNameTable, - DriverName, - (BOOLEAN)(This == &gArpComponentName) - ); -} - -/** - Retrieves a Unicode string that is the user readable name of the controller - that is being managed by a driver. - - This function retrieves the user readable name of the controller specified by - ControllerHandle and ChildHandle in the form of a Unicode string. If the - driver specified by This has a user readable name in the language specified by - Language, then a pointer to the controller name is returned in ControllerName, - and EFI_SUCCESS is returned. If the driver specified by This is not currently - managing the controller specified by ControllerHandle and ChildHandle, - then EFI_UNSUPPORTED is returned. If the driver specified by This does not - support the language specified by Language, then EFI_UNSUPPORTED is returned. - - @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param[in] ControllerHandle The handle of a controller that the driver - specified by This is managing. This handle - specifies the controller whose name is to be - returned. - - @param[in] ChildHandle The handle of the child controller to retrieve - the name of. This is an optional parameter that - may be NULL. It will be NULL for device - drivers. It will also be NULL for a bus drivers - that wish to retrieve the name of the bus - controller. It will not be NULL for a bus - driver that wishes to retrieve the name of a - child controller. - - @param[in] Language A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified in - RFC 4646 or ISO 639-2 language code format. - - @param[out] ControllerName A pointer to the Unicode string to return. - This Unicode string is the name of the - controller specified by ControllerHandle and - ChildHandle in the language specified by - Language from the point of view of the driver - specified by This. - - @retval EFI_SUCCESS The Unicode string for the user readable name in - the language specified by Language for the - driver specified by This was returned in - DriverName. - - @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. - - @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid - EFI_HANDLE. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER ControllerName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This is not currently - managing the controller specified by - ControllerHandle and ChildHandle. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -ArpComponentNameGetControllerName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_HANDLE ChildHandle OPTIONAL, - IN CHAR8 *Language, - OUT CHAR16 **ControllerName - ) -{ - EFI_STATUS Status; - EFI_ARP_PROTOCOL *Arp; - - // - // Only provide names for child handles. - // - if (ChildHandle == NULL) { - return EFI_UNSUPPORTED; - } - - // - // Make sure this driver produced ChildHandle - // - Status = EfiTestChildHandle ( - ControllerHandle, - ChildHandle, - &gEfiManagedNetworkProtocolGuid - ); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Retrieve an instance of a produced protocol from ChildHandle - // - Status = gBS->OpenProtocol ( - ChildHandle, - &gEfiArpProtocolGuid, - (VOID **)&Arp, - NULL, - NULL, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - if (EFI_ERROR (Status)) { - return Status; - } - - return LookupUnicodeString2 ( - Language, - This->SupportedLanguages, - mArpControllerNameTable, - ControllerName, - (BOOLEAN)(This == &gArpComponentName) - ); -} diff --git a/MdeModulePkg/Universal/Network/Dhcp4Dxe/ComponentName.c b/MdeModulePkg/Universal/Network/Dhcp4Dxe/ComponentName.c deleted file mode 100644 index 7c404fa267..0000000000 --- a/MdeModulePkg/Universal/Network/Dhcp4Dxe/ComponentName.c +++ /dev/null @@ -1,431 +0,0 @@ -/** @file - -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - - -#include "Dhcp4Impl.h" - -// -// EFI Component Name Functions -// -/** - Retrieves a Unicode string that is the user readable name of the driver. - - This function retrieves the user readable name of a driver in the form of a - Unicode string. If the driver specified by This has a user readable name in - the language specified by Language, then a pointer to the driver name is - returned in DriverName, and EFI_SUCCESS is returned. If the driver specified - by This does not support the language specified by Language, - then EFI_UNSUPPORTED is returned. - - @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param[in] Language A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified - in RFC 4646 or ISO 639-2 language code format. - - @param[out] DriverName A pointer to the Unicode string to return. - This Unicode string is the name of the - driver specified by This in the language - specified by Language. - - @retval EFI_SUCCESS The Unicode string for the Driver specified by - This and the language specified by Language was - returned in DriverName. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER DriverName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -DhcpComponentNameGetDriverName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN CHAR8 *Language, - OUT CHAR16 **DriverName - ); - - -/** - Retrieves a Unicode string that is the user readable name of the controller - that is being managed by a driver. - - This function retrieves the user readable name of the controller specified by - ControllerHandle and ChildHandle in the form of a Unicode string. If the - driver specified by This has a user readable name in the language specified by - Language, then a pointer to the controller name is returned in ControllerName, - and EFI_SUCCESS is returned. If the driver specified by This is not currently - managing the controller specified by ControllerHandle and ChildHandle, - then EFI_UNSUPPORTED is returned. If the driver specified by This does not - support the language specified by Language, then EFI_UNSUPPORTED is returned. - - @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param[in] ControllerHandle The handle of a controller that the driver - specified by This is managing. This handle - specifies the controller whose name is to be - returned. - - @param[in] ChildHandle The handle of the child controller to retrieve - the name of. This is an optional parameter that - may be NULL. It will be NULL for device - drivers. It will also be NULL for a bus drivers - that wish to retrieve the name of the bus - controller. It will not be NULL for a bus - driver that wishes to retrieve the name of a - child controller. - - @param[in] Language A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified in - RFC 4646 or ISO 639-2 language code format. - - @param[out] ControllerName A pointer to the Unicode string to return. - This Unicode string is the name of the - controller specified by ControllerHandle and - ChildHandle in the language specified by - Language from the point of view of the driver - specified by This. - - @retval EFI_SUCCESS The Unicode string for the user readable name in - the language specified by Language for the - driver specified by This was returned in - DriverName. - - @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. - - @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid - EFI_HANDLE. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER ControllerName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This is not currently - managing the controller specified by - ControllerHandle and ChildHandle. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -DhcpComponentNameGetControllerName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_HANDLE ChildHandle OPTIONAL, - IN CHAR8 *Language, - OUT CHAR16 **ControllerName - ); - - -// -// EFI Component Name Protocol -// -GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gDhcp4ComponentName = { - DhcpComponentNameGetDriverName, - DhcpComponentNameGetControllerName, - "eng" -}; - -// -// EFI Component Name 2 Protocol -// -GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gDhcp4ComponentName2 = { - (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) DhcpComponentNameGetDriverName, - (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) DhcpComponentNameGetControllerName, - "en" -}; - - -GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mDhcpDriverNameTable[] = { - { - "eng;en", - L"DHCP Protocol Driver" - }, - { - NULL, - NULL - } -}; - -GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE *gDhcpControllerNameTable = NULL; - -CHAR16 *mDhcp4ControllerName[] = { - L"DHCPv4 (State=0, Stopped)", - L"DHCPv4 (State=1, Init)", - L"DHCPv4 (State=2, Selecting)", - L"DHCPv4 (State=3, Requesting)", - L"DHCPv4 (State=4, Bound)", - L"DHCPv4 (State=5, Renewing)", - L"DHCPv4 (State=6, Rebinding)", - L"DHCPv4 (State=7, InitReboot)", - L"DHCPv4 (State=8, Rebooting)" -}; - -/** - Retrieves a Unicode string that is the user readable name of the driver. - - This function retrieves the user readable name of a driver in the form of a - Unicode string. If the driver specified by This has a user readable name in - the language specified by Language, then a pointer to the driver name is - returned in DriverName, and EFI_SUCCESS is returned. If the driver specified - by This does not support the language specified by Language, - then EFI_UNSUPPORTED is returned. - - @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param[in] Language A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified - in RFC 4646 or ISO 639-2 language code format. - - @param[out] DriverName A pointer to the Unicode string to return. - This Unicode string is the name of the - driver specified by This in the language - specified by Language. - - @retval EFI_SUCCESS The Unicode string for the Driver specified by - This and the language specified by Language was - returned in DriverName. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER DriverName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -DhcpComponentNameGetDriverName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN CHAR8 *Language, - OUT CHAR16 **DriverName - ) -{ - return LookupUnicodeString2 ( - Language, - This->SupportedLanguages, - mDhcpDriverNameTable, - DriverName, - (BOOLEAN)(This == &gDhcp4ComponentName) - ); -} - -/** - Update the component name for the Dhcp4 child handle. - - @param Dhcp4[in] A pointer to the EFI_DHCP4_PROTOCOL. - - - @retval EFI_SUCCESS Update the ControllerNameTable of this instance successfully. - @retval EFI_INVALID_PARAMETER The input parameter is invalid. - @retval EFI_DEVICE_ERROR DHCP is in unknown state. - -**/ -EFI_STATUS -UpdateName ( - IN EFI_DHCP4_PROTOCOL *Dhcp4 - ) -{ - EFI_STATUS Status; - EFI_DHCP4_MODE_DATA Dhcp4ModeData; - - if (Dhcp4 == NULL) { - return EFI_INVALID_PARAMETER; - } - - // - // Format the child name into the string buffer. - // - Status = Dhcp4->GetModeData (Dhcp4, &Dhcp4ModeData); - if (EFI_ERROR (Status)) { - return Status; - } - - if (gDhcpControllerNameTable != NULL) { - FreeUnicodeStringTable (gDhcpControllerNameTable); - gDhcpControllerNameTable = NULL; - } - - if (Dhcp4ModeData.State > Dhcp4Rebooting) { - return EFI_DEVICE_ERROR; - } - - Status = AddUnicodeString2 ( - "eng", - gDhcp4ComponentName.SupportedLanguages, - &gDhcpControllerNameTable, - mDhcp4ControllerName[Dhcp4ModeData.State], - TRUE - ); - if (EFI_ERROR (Status)) { - return Status; - } - - return AddUnicodeString2 ( - "en", - gDhcp4ComponentName2.SupportedLanguages, - &gDhcpControllerNameTable, - mDhcp4ControllerName[Dhcp4ModeData.State], - FALSE - ); -} - -/** - Retrieves a Unicode string that is the user readable name of the controller - that is being managed by a driver. - - This function retrieves the user readable name of the controller specified by - ControllerHandle and ChildHandle in the form of a Unicode string. If the - driver specified by This has a user readable name in the language specified by - Language, then a pointer to the controller name is returned in ControllerName, - and EFI_SUCCESS is returned. If the driver specified by This is not currently - managing the controller specified by ControllerHandle and ChildHandle, - then EFI_UNSUPPORTED is returned. If the driver specified by This does not - support the language specified by Language, then EFI_UNSUPPORTED is returned. - - @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param[in] ControllerHandle The handle of a controller that the driver - specified by This is managing. This handle - specifies the controller whose name is to be - returned. - - @param[in] ChildHandle The handle of the child controller to retrieve - the name of. This is an optional parameter that - may be NULL. It will be NULL for device - drivers. It will also be NULL for a bus drivers - that wish to retrieve the name of the bus - controller. It will not be NULL for a bus - driver that wishes to retrieve the name of a - child controller. - - @param[in] Language A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified in - RFC 4646 or ISO 639-2 language code format. - - @param[out] ControllerName A pointer to the Unicode string to return. - This Unicode string is the name of the - controller specified by ControllerHandle and - ChildHandle in the language specified by - Language from the point of view of the driver - specified by This. - - @retval EFI_SUCCESS The Unicode string for the user readable name in - the language specified by Language for the - driver specified by This was returned in - DriverName. - - @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. - - @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid - EFI_HANDLE. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER ControllerName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This is not currently - managing the controller specified by - ControllerHandle and ChildHandle. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -DhcpComponentNameGetControllerName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_HANDLE ChildHandle OPTIONAL, - IN CHAR8 *Language, - OUT CHAR16 **ControllerName - ) -{ - EFI_STATUS Status; - EFI_DHCP4_PROTOCOL *Dhcp4; - - // - // Only provide names for child handles. - // - if (ChildHandle == NULL) { - return EFI_UNSUPPORTED; - } - - // - // Make sure this driver produced ChildHandle - // - Status = EfiTestChildHandle ( - ControllerHandle, - ChildHandle, - &gEfiUdp4ProtocolGuid - ); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Retrieve an instance of a produced protocol from ChildHandle - // - Status = gBS->OpenProtocol ( - ChildHandle, - &gEfiDhcp4ProtocolGuid, - (VOID **)&Dhcp4, - NULL, - NULL, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Update the component name for this child handle. - // - Status = UpdateName (Dhcp4); - if (EFI_ERROR (Status)) { - return Status; - } - - return LookupUnicodeString2 ( - Language, - This->SupportedLanguages, - gDhcpControllerNameTable, - ControllerName, - (BOOLEAN)(This == &gDhcp4ComponentName) - ); -} diff --git a/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Driver.c b/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Driver.c deleted file mode 100644 index e891b68883..0000000000 --- a/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Driver.c +++ /dev/null @@ -1,732 +0,0 @@ -/** @file - -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Dhcp4Impl.h" -#include "Dhcp4Driver.h" - -EFI_DRIVER_BINDING_PROTOCOL gDhcp4DriverBinding = { - Dhcp4DriverBindingSupported, - Dhcp4DriverBindingStart, - Dhcp4DriverBindingStop, - 0xa, - NULL, - NULL -}; - -EFI_SERVICE_BINDING_PROTOCOL mDhcp4ServiceBindingTemplate = { - Dhcp4ServiceBindingCreateChild, - Dhcp4ServiceBindingDestroyChild -}; - -/** - This is the declaration of an EFI image entry point. This entry point is - the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including - both device drivers and bus drivers. - - Entry point of the DHCP driver to install various protocols. - - @param[in] ImageHandle The firmware allocated handle for the UEFI image. - @param[in] SystemTable A pointer to the EFI System Table. - - @retval EFI_SUCCESS The operation completed successfully. - @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. - -**/ -EFI_STATUS -EFIAPI -Dhcp4DriverEntryPoint ( - IN EFI_HANDLE ImageHandle, - IN EFI_SYSTEM_TABLE *SystemTable - ) -{ - return EfiLibInstallDriverBindingComponentName2 ( - ImageHandle, - SystemTable, - &gDhcp4DriverBinding, - ImageHandle, - &gDhcp4ComponentName, - &gDhcp4ComponentName2 - ); -} - - -/** - Test to see if this driver supports ControllerHandle. This service - is called by the EFI boot service ConnectController(). In - order to make drivers as small as possible, there are a few calling - restrictions for this service. ConnectController() must - follow these calling restrictions. If any other agent wishes to call - Supported() it must also follow these calling restrictions. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to test - @param[in] RemainingDevicePath Optional parameter use to pick a specific child - device to start. - - @retval EFI_SUCCESS This driver supports this device - @retval EFI_ALREADY_STARTED This driver is already running on this device - @retval other This driver does not support this device - -**/ -EFI_STATUS -EFIAPI -Dhcp4DriverBindingSupported ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL - ) -{ - EFI_STATUS Status; - - Status = gBS->OpenProtocol ( - ControllerHandle, - &gEfiUdp4ServiceBindingProtocolGuid, - NULL, - This->DriverBindingHandle, - ControllerHandle, - EFI_OPEN_PROTOCOL_TEST_PROTOCOL - ); - - return Status; -} - - - -/** - Configure the default UDP child to receive all the DHCP traffics - on this network interface. - - @param[in] UdpIo The UDP IO to configure - @param[in] Context The context to the function - - @retval EFI_SUCCESS The UDP IO is successfully configured. - @retval Others Failed to configure the UDP child. - -**/ -EFI_STATUS -EFIAPI -DhcpConfigUdpIo ( - IN UDP_IO *UdpIo, - IN VOID *Context - ) -{ - EFI_UDP4_CONFIG_DATA UdpConfigData; - - UdpConfigData.AcceptBroadcast = TRUE; - UdpConfigData.AcceptPromiscuous = FALSE; - UdpConfigData.AcceptAnyPort = FALSE; - UdpConfigData.AllowDuplicatePort = TRUE; - UdpConfigData.TypeOfService = 0; - UdpConfigData.TimeToLive = 64; - UdpConfigData.DoNotFragment = FALSE; - UdpConfigData.ReceiveTimeout = 0; - UdpConfigData.TransmitTimeout = 0; - - UdpConfigData.UseDefaultAddress = FALSE; - UdpConfigData.StationPort = DHCP_CLIENT_PORT; - UdpConfigData.RemotePort = DHCP_SERVER_PORT; - - ZeroMem (&UdpConfigData.StationAddress, sizeof (EFI_IPv4_ADDRESS)); - ZeroMem (&UdpConfigData.SubnetMask, sizeof (EFI_IPv4_ADDRESS)); - ZeroMem (&UdpConfigData.RemoteAddress, sizeof (EFI_IPv4_ADDRESS)); - - return UdpIo->Protocol.Udp4->Configure (UdpIo->Protocol.Udp4, &UdpConfigData);; -} - - - -/** - Destroy the DHCP service. The Dhcp4 service may be partly initialized, - or partly destroyed. If a resource is destroyed, it is marked as so in - case the destroy failed and being called again later. - - @param[in] DhcpSb The DHCP service instance to destroy. - - @retval EFI_SUCCESS Always return success. - -**/ -EFI_STATUS -Dhcp4CloseService ( - IN DHCP_SERVICE *DhcpSb - ) -{ - DhcpCleanLease (DhcpSb); - - if (DhcpSb->UdpIo != NULL) { - UdpIoFreeIo (DhcpSb->UdpIo); - DhcpSb->UdpIo = NULL; - } - - if (DhcpSb->Timer != NULL) { - gBS->SetTimer (DhcpSb->Timer, TimerCancel, 0); - gBS->CloseEvent (DhcpSb->Timer); - - DhcpSb->Timer = NULL; - } - - return EFI_SUCCESS; -} - - - -/** - Create a new DHCP service binding instance for the controller. - - @param[in] Controller The controller to install DHCP service binding - protocol onto - @param[in] ImageHandle The driver's image handle - @param[out] Service The variable to receive the created DHCP service - instance. - - @retval EFI_OUT_OF_RESOURCES Failed to allocate resource . - @retval EFI_SUCCESS The DHCP service instance is created. - @retval other Other error occurs. - -**/ -EFI_STATUS -Dhcp4CreateService ( - IN EFI_HANDLE Controller, - IN EFI_HANDLE ImageHandle, - OUT DHCP_SERVICE **Service - ) -{ - DHCP_SERVICE *DhcpSb; - EFI_STATUS Status; - - *Service = NULL; - DhcpSb = AllocateZeroPool (sizeof (DHCP_SERVICE)); - - if (DhcpSb == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - DhcpSb->Signature = DHCP_SERVICE_SIGNATURE; - DhcpSb->ServiceState = DHCP_UNCONFIGED; - DhcpSb->Controller = Controller; - DhcpSb->Image = ImageHandle; - InitializeListHead (&DhcpSb->Children); - DhcpSb->DhcpState = Dhcp4Stopped; - DhcpSb->Xid = NET_RANDOM (NetRandomInitSeed ()); - CopyMem ( - &DhcpSb->ServiceBinding, - &mDhcp4ServiceBindingTemplate, - sizeof (EFI_SERVICE_BINDING_PROTOCOL) - ); - // - // Create various resources, UdpIo, Timer, and get Mac address - // - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL | EVT_TIMER, - TPL_CALLBACK, - DhcpOnTimerTick, - DhcpSb, - &DhcpSb->Timer - ); - - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - DhcpSb->UdpIo = UdpIoCreateIo ( - Controller, - ImageHandle, - DhcpConfigUdpIo, - UDP_IO_UDP4_VERSION, - NULL - ); - - if (DhcpSb->UdpIo == NULL) { - Status = EFI_OUT_OF_RESOURCES; - goto ON_ERROR; - } - - DhcpSb->HwLen = (UINT8) DhcpSb->UdpIo->SnpMode.HwAddressSize; - DhcpSb->HwType = DhcpSb->UdpIo->SnpMode.IfType; - CopyMem (&DhcpSb->Mac, &DhcpSb->UdpIo->SnpMode.CurrentAddress, sizeof (DhcpSb->Mac)); - - *Service = DhcpSb; - return EFI_SUCCESS; - -ON_ERROR: - Dhcp4CloseService (DhcpSb); - FreePool (DhcpSb); - - return Status; -} - - -/** - Start this driver on ControllerHandle. This service is called by the - EFI boot service ConnectController(). In order to make - drivers as small as possible, there are a few calling restrictions for - this service. ConnectController() must follow these - calling restrictions. If any other agent wishes to call Start() it - must also follow these calling restrictions. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to bind driver to - @param[in] RemainingDevicePath Optional parameter use to pick a specific child - device to start. - - @retval EFI_SUCCESS This driver is added to ControllerHandle - @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle - @retval other This driver does not support this device - -**/ -EFI_STATUS -EFIAPI -Dhcp4DriverBindingStart ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL - ) -{ - DHCP_SERVICE *DhcpSb; - EFI_STATUS Status; - - // - // First: test for the DHCP4 Protocol - // - Status = gBS->OpenProtocol ( - ControllerHandle, - &gEfiDhcp4ServiceBindingProtocolGuid, - NULL, - This->DriverBindingHandle, - ControllerHandle, - EFI_OPEN_PROTOCOL_TEST_PROTOCOL - ); - - if (Status == EFI_SUCCESS) { - return EFI_ALREADY_STARTED; - } - - Status = Dhcp4CreateService (ControllerHandle, This->DriverBindingHandle, &DhcpSb); - - if (EFI_ERROR (Status)) { - return Status; - } - ASSERT (DhcpSb != NULL); - - // - // Start the receiving - // - Status = UdpIoRecvDatagram (DhcpSb->UdpIo, DhcpInput, DhcpSb, 0); - - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - Status = gBS->SetTimer (DhcpSb->Timer, TimerPeriodic, TICKS_PER_SECOND); - - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - // - // Install the Dhcp4ServiceBinding Protocol onto ControlerHandle - // - Status = gBS->InstallMultipleProtocolInterfaces ( - &ControllerHandle, - &gEfiDhcp4ServiceBindingProtocolGuid, - &DhcpSb->ServiceBinding, - NULL - ); - - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - return Status; - -ON_ERROR: - Dhcp4CloseService (DhcpSb); - FreePool (DhcpSb); - return Status; -} - -/** - Callback function which provided by user to remove one node in NetDestroyLinkList process. - - @param[in] Entry The entry to be removed. - @param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList. - - @retval EFI_SUCCESS The entry has been removed successfully. - @retval Others Fail to remove the entry. - -**/ -EFI_STATUS -EFIAPI -Dhcp4DestroyChildEntry ( - IN LIST_ENTRY *Entry, - IN VOID *Context - ) -{ - DHCP_PROTOCOL *Instance; - EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; - - if (Entry == NULL || Context == NULL) { - return EFI_INVALID_PARAMETER; - } - - Instance = NET_LIST_USER_STRUCT_S (Entry, DHCP_PROTOCOL, Link, DHCP_PROTOCOL_SIGNATURE); - ServiceBinding = (EFI_SERVICE_BINDING_PROTOCOL *) Context; - - return ServiceBinding->DestroyChild (ServiceBinding, Instance->Handle); -} - - -/** - Stop this driver on ControllerHandle. This service is called by the - EFI boot service DisconnectController(). In order to - make drivers as small as possible, there are a few calling - restrictions for this service. DisconnectController() - must follow these calling restrictions. If any other agent wishes - to call Stop() it must also follow these calling restrictions. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to stop driver on - @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number of - children is zero stop the entire bus driver. - @param[in] ChildHandleBuffer List of Child Handles to Stop. - - @retval EFI_SUCCESS This driver is removed ControllerHandle - @retval other This driver was not removed from this device - -**/ -EFI_STATUS -EFIAPI -Dhcp4DriverBindingStop ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN UINTN NumberOfChildren, - IN EFI_HANDLE *ChildHandleBuffer - ) -{ - EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; - DHCP_SERVICE *DhcpSb; - EFI_HANDLE NicHandle; - EFI_STATUS Status; - LIST_ENTRY *List; - UINTN ListLength; - - // - // DHCP driver opens UDP child, So, the ControllerHandle is the - // UDP child handle. locate the Nic handle first. - // - NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiUdp4ProtocolGuid); - - if (NicHandle == NULL) { - return EFI_SUCCESS; - } - - Status = gBS->OpenProtocol ( - NicHandle, - &gEfiDhcp4ServiceBindingProtocolGuid, - (VOID **) &ServiceBinding, - This->DriverBindingHandle, - NicHandle, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - - if (EFI_ERROR (Status)) { - return EFI_DEVICE_ERROR; - } - - DhcpSb = DHCP_SERVICE_FROM_THIS (ServiceBinding); - if (!IsListEmpty (&DhcpSb->Children)) { - // - // Destroy all the children instances before destory the service. - // - List = &DhcpSb->Children; - Status = NetDestroyLinkList ( - List, - Dhcp4DestroyChildEntry, - ServiceBinding, - &ListLength - ); - if (EFI_ERROR (Status) || ListLength != 0) { - Status = EFI_DEVICE_ERROR; - } - } - - if (NumberOfChildren == 0 && !IsListEmpty (&DhcpSb->Children)) { - Status = EFI_DEVICE_ERROR; - } - - if (NumberOfChildren == 0 && IsListEmpty (&DhcpSb->Children)) { - // - // Destroy the service itself if no child instance left. - // - DhcpSb->ServiceState = DHCP_DESTROY; - - gBS->UninstallProtocolInterface ( - NicHandle, - &gEfiDhcp4ServiceBindingProtocolGuid, - ServiceBinding - ); - - Dhcp4CloseService (DhcpSb); - - if (gDhcpControllerNameTable != NULL) { - FreeUnicodeStringTable (gDhcpControllerNameTable); - gDhcpControllerNameTable = NULL; - } - FreePool (DhcpSb); - - Status = EFI_SUCCESS; - } - - return Status; -} - - -/** - Initialize a new DHCP instance. - - @param DhcpSb The dhcp service instance - @param Instance The dhcp instance to initialize - -**/ -VOID -DhcpInitProtocol ( - IN DHCP_SERVICE *DhcpSb, - IN OUT DHCP_PROTOCOL *Instance - ) -{ - Instance->Signature = DHCP_PROTOCOL_SIGNATURE; - CopyMem (&Instance->Dhcp4Protocol, &mDhcp4ProtocolTemplate, sizeof (Instance->Dhcp4Protocol)); - InitializeListHead (&Instance->Link); - Instance->Handle = NULL; - Instance->Service = DhcpSb; - Instance->InDestroy = FALSE; - Instance->CompletionEvent = NULL; - Instance->RenewRebindEvent = NULL; - Instance->Token = NULL; - Instance->UdpIo = NULL; - Instance->ElaspedTime = 0; - NetbufQueInit (&Instance->ResponseQueue); -} - - -/** - Creates a child handle and installs a protocol. - - The CreateChild() function installs a protocol on ChildHandle. - If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. - If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle. - - @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. - @param ChildHandle Pointer to the handle of the child to create. If it is NULL, - then a new handle is created. If it is a pointer to an existing UEFI handle, - then the protocol is added to the existing UEFI handle. - - @retval EFI_SUCCES The protocol was added to ChildHandle. - @retval EFI_INVALID_PARAMETER ChildHandle is NULL. - @retval EFI_OUT_OF_RESOURCES There are not enough resources available to create - the child - @retval other The child handle was not created - -**/ -EFI_STATUS -EFIAPI -Dhcp4ServiceBindingCreateChild ( - IN EFI_SERVICE_BINDING_PROTOCOL *This, - IN EFI_HANDLE *ChildHandle - ) -{ - DHCP_SERVICE *DhcpSb; - DHCP_PROTOCOL *Instance; - EFI_STATUS Status; - EFI_TPL OldTpl; - VOID *Udp4; - - if ((This == NULL) || (ChildHandle == NULL)) { - return EFI_INVALID_PARAMETER; - } - - Instance = AllocatePool (sizeof (*Instance)); - - if (Instance == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - DhcpSb = DHCP_SERVICE_FROM_THIS (This); - DhcpInitProtocol (DhcpSb, Instance); - - // - // Install DHCP4 onto ChildHandle - // - Status = gBS->InstallMultipleProtocolInterfaces ( - ChildHandle, - &gEfiDhcp4ProtocolGuid, - &Instance->Dhcp4Protocol, - NULL - ); - - if (EFI_ERROR (Status)) { - FreePool (Instance); - return Status; - } - - Instance->Handle = *ChildHandle; - - // - // Open the Udp4 protocol BY_CHILD. - // - Status = gBS->OpenProtocol ( - DhcpSb->UdpIo->UdpHandle, - &gEfiUdp4ProtocolGuid, - (VOID **) &Udp4, - gDhcp4DriverBinding.DriverBindingHandle, - Instance->Handle, - EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER - ); - if (EFI_ERROR (Status)) { - gBS->UninstallMultipleProtocolInterfaces ( - Instance->Handle, - &gEfiDhcp4ProtocolGuid, - &Instance->Dhcp4Protocol, - NULL - ); - - FreePool (Instance); - return Status; - } - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - InsertTailList (&DhcpSb->Children, &Instance->Link); - DhcpSb->NumChildren++; - - gBS->RestoreTPL (OldTpl); - - return EFI_SUCCESS; -} - - -/** - Destroys a child handle with a protocol installed on it. - - The DestroyChild() function does the opposite of CreateChild(). It removes a protocol - that was installed by CreateChild() from ChildHandle. If the removed protocol is the - last protocol on ChildHandle, then ChildHandle is destroyed. - - @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. - @param ChildHandle Handle of the child to destroy - - @retval EFI_SUCCES The protocol was removed from ChildHandle. - @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed. - @retval EFI_INVALID_PARAMETER Child handle is NULL. - @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle - because its services are being used. - @retval other The child handle was not destroyed - -**/ -EFI_STATUS -EFIAPI -Dhcp4ServiceBindingDestroyChild ( - IN EFI_SERVICE_BINDING_PROTOCOL *This, - IN EFI_HANDLE ChildHandle - ) -{ - DHCP_SERVICE *DhcpSb; - DHCP_PROTOCOL *Instance; - EFI_DHCP4_PROTOCOL *Dhcp; - EFI_TPL OldTpl; - EFI_STATUS Status; - - if ((This == NULL) || (ChildHandle == NULL)) { - return EFI_INVALID_PARAMETER; - } - - // - // Retrieve the private context data structures - // - Status = gBS->OpenProtocol ( - ChildHandle, - &gEfiDhcp4ProtocolGuid, - (VOID **) &Dhcp, - gDhcp4DriverBinding.DriverBindingHandle, - ChildHandle, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - - if (EFI_ERROR (Status)) { - return EFI_UNSUPPORTED; - } - - Instance = DHCP_INSTANCE_FROM_THIS (Dhcp); - DhcpSb = DHCP_SERVICE_FROM_THIS (This); - - if (Instance->Service != DhcpSb) { - return EFI_INVALID_PARAMETER; - } - - // - // A child can be destroyed more than once. For example, - // Dhcp4DriverBindingStop will destroy all of its children. - // when caller driver is being stopped, it will destroy the - // dhcp child it opens. - // - if (Instance->InDestroy) { - return EFI_SUCCESS; - } - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - Instance->InDestroy = TRUE; - - // - // Close the Udp4 protocol. - // - gBS->CloseProtocol ( - DhcpSb->UdpIo->UdpHandle, - &gEfiUdp4ProtocolGuid, - gDhcp4DriverBinding.DriverBindingHandle, - ChildHandle - ); - - // - // Uninstall the DHCP4 protocol first to enable a top down destruction. - // - gBS->RestoreTPL (OldTpl); - Status = gBS->UninstallProtocolInterface ( - ChildHandle, - &gEfiDhcp4ProtocolGuid, - Dhcp - ); - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - if (EFI_ERROR (Status)) { - Instance->InDestroy = FALSE; - - gBS->RestoreTPL (OldTpl); - return Status; - } - - if (DhcpSb->ActiveChild == Instance) { - DhcpYieldControl (DhcpSb); - } - - RemoveEntryList (&Instance->Link); - DhcpSb->NumChildren--; - - if (Instance->UdpIo != NULL) { - UdpIoCleanIo (Instance->UdpIo); - gBS->CloseProtocol ( - Instance->UdpIo->UdpHandle, - &gEfiUdp4ProtocolGuid, - Instance->Service->Image, - Instance->Handle - ); - UdpIoFreeIo (Instance->UdpIo); - Instance->UdpIo = NULL; - Instance->Token = NULL; - } - - gBS->RestoreTPL (OldTpl); - - FreePool (Instance); - return EFI_SUCCESS; -} diff --git a/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Driver.h b/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Driver.h deleted file mode 100644 index cebde20dca..0000000000 --- a/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Driver.h +++ /dev/null @@ -1,146 +0,0 @@ -/** @file - Header for the DHCP4 driver. - -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef __EFI_DHCP4_DRIVER_H__ -#define __EFI_DHCP4_DRIVER_H__ - -extern EFI_COMPONENT_NAME_PROTOCOL gDhcp4ComponentName; -extern EFI_COMPONENT_NAME2_PROTOCOL gDhcp4ComponentName2; -extern EFI_UNICODE_STRING_TABLE *gDhcpControllerNameTable; - -/** - Test to see if this driver supports ControllerHandle. This service - is called by the EFI boot service ConnectController(). In - order to make drivers as small as possible, there are a few calling - restrictions for this service. ConnectController() must - follow these calling restrictions. If any other agent wishes to call - Supported() it must also follow these calling restrictions. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to test - @param[in] RemainingDevicePath Optional parameter use to pick a specific child - device to start. - - @retval EFI_SUCCESS This driver supports this device - @retval EFI_ALREADY_STARTED This driver is already running on this device - @retval other This driver does not support this device - -**/ -EFI_STATUS -EFIAPI -Dhcp4DriverBindingSupported ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL - ); - -/** - Start this driver on ControllerHandle. This service is called by the - EFI boot service ConnectController(). In order to make - drivers as small as possible, there are a few calling restrictions for - this service. ConnectController() must follow these - calling restrictions. If any other agent wishes to call Start() it - must also follow these calling restrictions. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to bind driver to - @param[in] RemainingDevicePath Optional parameter use to pick a specific child - device to start. - - @retval EFI_SUCCESS This driver is added to ControllerHandle - @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle - @retval other This driver does not support this device - -**/ -EFI_STATUS -EFIAPI -Dhcp4DriverBindingStart ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL - ); - -/** - Stop this driver on ControllerHandle. This service is called by the - EFI boot service DisconnectController(). In order to - make drivers as small as possible, there are a few calling - restrictions for this service. DisconnectController() - must follow these calling restrictions. If any other agent wishes - to call Stop() it must also follow these calling restrictions. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to stop driver on - @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number of - children is zero stop the entire bus driver. - @param[in] ChildHandleBuffer List of Child Handles to Stop. - - @retval EFI_SUCCESS This driver is removed ControllerHandle - @retval other This driver was not removed from this device - -**/ -EFI_STATUS -EFIAPI -Dhcp4DriverBindingStop ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN UINTN NumberOfChildren, - IN EFI_HANDLE *ChildHandleBuffer - ); - -/** - Creates a child handle and installs a protocol. - - The CreateChild() function installs a protocol on ChildHandle. - If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. - If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle. - - @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. - @param ChildHandle Pointer to the handle of the child to create. If it is NULL, - then a new handle is created. If it is a pointer to an existing UEFI handle, - then the protocol is added to the existing UEFI handle. - - @retval EFI_SUCCES The protocol was added to ChildHandle. - @retval EFI_INVALID_PARAMETER ChildHandle is NULL. - @retval EFI_OUT_OF_RESOURCES There are not enough resources available to create - the child - @retval other The child handle was not created - -**/ -EFI_STATUS -EFIAPI -Dhcp4ServiceBindingCreateChild ( - IN EFI_SERVICE_BINDING_PROTOCOL *This, - IN EFI_HANDLE *ChildHandle - ); - -/** - Destroys a child handle with a protocol installed on it. - - The DestroyChild() function does the opposite of CreateChild(). It removes a protocol - that was installed by CreateChild() from ChildHandle. If the removed protocol is the - last protocol on ChildHandle, then ChildHandle is destroyed. - - @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. - @param ChildHandle Handle of the child to destroy - - @retval EFI_SUCCES The protocol was removed from ChildHandle. - @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed. - @retval EFI_INVALID_PARAMETER Child handle is NULL. - @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle - because its services are being used. - @retval other The child handle was not destroyed - -**/ -EFI_STATUS -EFIAPI -Dhcp4ServiceBindingDestroyChild ( - IN EFI_SERVICE_BINDING_PROTOCOL *This, - IN EFI_HANDLE ChildHandle - ); - -#endif diff --git a/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Dxe.inf b/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Dxe.inf deleted file mode 100644 index 62883518b2..0000000000 --- a/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Dxe.inf +++ /dev/null @@ -1,66 +0,0 @@ -## @file -# This module produces EFI DHCPv4 Protocol and EFI DHCPv4 Service Binding Protocol. -# -# This module produces EFI DHCPv4 Protocol upon EFI UDPv4 Protocol, to provide the -# capability to collect configuration information for the EFI IPv4 Protocol drivers -# and to provide DHCPv4 server and PXE boot server discovery services. -# -# Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
-# SPDX-License-Identifier: BSD-2-Clause-Patent -# -# -## - -[Defines] - INF_VERSION = 0x00010005 - BASE_NAME = Dhcp4Dxe - MODULE_UNI_FILE = Dhcp4Dxe.uni - FILE_GUID = 94734718-0BBC-47fb-96A5-EE7A5AE6A2AD - MODULE_TYPE = UEFI_DRIVER - VERSION_STRING = 1.0 - ENTRY_POINT = Dhcp4DriverEntryPoint - UNLOAD_IMAGE = NetLibDefaultUnload -# -# The following information is for reference only and not required by the build tools. -# -# VALID_ARCHITECTURES = IA32 X64 EBC -# -# DRIVER_BINDING = gDhcp4DriverBinding -# COMPONENT_NAME = gDhcp4ComponentName -# COMPONENT_NAME2 = gDhcp4ComponentName2 -# - -[Sources] - Dhcp4Impl.c - Dhcp4Io.c - Dhcp4Io.h - ComponentName.c - Dhcp4Driver.h - Dhcp4Driver.c - Dhcp4Option.c - Dhcp4Option.h - Dhcp4Impl.h - -[Packages] - MdePkg/MdePkg.dec - MdeModulePkg/MdeModulePkg.dec - - -[LibraryClasses] - BaseLib - UefiLib - UefiBootServicesTableLib - UefiDriverEntryPoint - DebugLib - NetLib - UdpIoLib - - -[Protocols] - gEfiDhcp4ServiceBindingProtocolGuid ## BY_START - gEfiUdp4ServiceBindingProtocolGuid ## TO_START - gEfiDhcp4ProtocolGuid ## BY_START - gEfiUdp4ProtocolGuid ## TO_START - -[UserExtensions.TianoCore."ExtraFiles"] - Dhcp4DxeExtra.uni diff --git a/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Dxe.uni b/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Dxe.uni deleted file mode 100644 index 5405b88d25..0000000000 --- a/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Dxe.uni +++ /dev/null @@ -1,18 +0,0 @@ -// /** @file -// This module produces EFI DHCPv4 Protocol and EFI DHCPv4 Service Binding Protocol. -// -// This module produces EFI DHCPv4 Protocol upon EFI UDPv4 Protocol, to provide the -// capability to collect configuration information for the EFI IPv4 Protocol drivers -// and to provide DHCPv4 server and PXE boot server discovery services. -// -// Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
-// -// SPDX-License-Identifier: BSD-2-Clause-Patent -// -// **/ - - -#string STR_MODULE_ABSTRACT #language en-US "EFI DHCPv4 Driver" - -#string STR_MODULE_DESCRIPTION #language en-US "This module produces EFI DHCPv4 Protocol using the EFI UDPv4 Protocol, providing the capability to collect configuration information for the EFI IPv4 Protocol drivers and providing DHCPv4 server and PXE boot server discovery services." - diff --git a/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4DxeExtra.uni b/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4DxeExtra.uni deleted file mode 100644 index ca62553f8b..0000000000 --- a/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4DxeExtra.uni +++ /dev/null @@ -1,14 +0,0 @@ -// /** @file -// Dhcp4Dxe Localized Strings and Content -// -// Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.
-// -// SPDX-License-Identifier: BSD-2-Clause-Patent -// -// **/ - -#string STR_PROPERTIES_MODULE_NAME -#language en-US -"DHCP v4 DXE Driver" - - diff --git a/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Impl.c b/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Impl.c deleted file mode 100644 index 0b35bdf4df..0000000000 --- a/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Impl.c +++ /dev/null @@ -1,1802 +0,0 @@ -/** @file - This file implement the EFI_DHCP4_PROTOCOL interface. - -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - - -#include "Dhcp4Impl.h" - -/** - Returns the current operating mode and cached data packet for the EFI DHCPv4 Protocol driver. - - The GetModeData() function returns the current operating mode and cached data - packet for the EFI DHCPv4 Protocol driver. - - @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. - @param[out] Dhcp4ModeData Pointer to storage for the EFI_DHCP4_MODE_DATA structure. - - @retval EFI_SUCCESS The mode data was returned. - @retval EFI_INVALID_PARAMETER This is NULL. - -**/ -EFI_STATUS -EFIAPI -EfiDhcp4GetModeData ( - IN EFI_DHCP4_PROTOCOL *This, - OUT EFI_DHCP4_MODE_DATA *Dhcp4ModeData - ); - -/** - Initializes, changes, or resets the operational settings for the EFI DHCPv4 Protocol driver. - - The Configure() function is used to initialize, change, or reset the operational - settings of the EFI DHCPv4 Protocol driver for the communication device on which - the EFI DHCPv4 Service Binding Protocol is installed. This function can be - successfully called only if both of the following are true: - * This instance of the EFI DHCPv4 Protocol driver is in the Dhcp4Stopped, Dhcp4Init, - Dhcp4InitReboot, or Dhcp4Bound states. - * No other EFI DHCPv4 Protocol driver instance that is controlled by this EFI - DHCPv4 Service Binding Protocol driver instance has configured this EFI DHCPv4 - Protocol driver. - When this driver is in the Dhcp4Stopped state, it can transfer into one of the - following two possible initial states: - * Dhcp4Init - * Dhcp4InitReboot - The driver can transfer into these states by calling Configure() with a non-NULL - Dhcp4CfgData. The driver will transfer into the appropriate state based on the - supplied client network address in the ClientAddress parameter and DHCP options - in the OptionList parameter as described in RFC 2131. - When Configure() is called successfully while Dhcp4CfgData is set to NULL, the - default configuring data will be reset in the EFI DHCPv4 Protocol driver and - the state of the EFI DHCPv4 Protocol driver will not be changed. If one instance - wants to make it possible for another instance to configure the EFI DHCPv4 Protocol - driver, it must call this function with Dhcp4CfgData set to NULL. - - @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. - @param[in] Dhcp4CfgData Pointer to the EFI_DHCP4_CONFIG_DATA. - - @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Init or - Dhcp4InitReboot state, if the original state of this driver - was Dhcp4Stopped and the value of Dhcp4CfgData was - not NULL. Otherwise, the state was left unchanged. - @retval EFI_ACCESS_DENIED This instance of the EFI DHCPv4 Protocol driver was not in the - Dhcp4Stopped, Dhcp4Init, Dhcp4InitReboot, or Dhcp4Bound state; - Or onother instance of this EFI DHCPv4 Protocol driver is already - in a valid configured state. - @retval EFI_INVALID_PARAMETER Some parameter is NULL. - @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. - -**/ -EFI_STATUS -EFIAPI -EfiDhcp4Configure ( - IN EFI_DHCP4_PROTOCOL *This, - IN EFI_DHCP4_CONFIG_DATA *Dhcp4CfgData OPTIONAL - ); - -/** - Starts the DHCP configuration process. - - The Start() function starts the DHCP configuration process. This function can - be called only when the EFI DHCPv4 Protocol driver is in the Dhcp4Init or - Dhcp4InitReboot state. - If the DHCP process completes successfully, the state of the EFI DHCPv4 Protocol - driver will be transferred through Dhcp4Selecting and Dhcp4Requesting to the - Dhcp4Bound state. The CompletionEvent will then be signaled if it is not NULL. - If the process aborts, either by the user or by some unexpected network error, - the state is restored to the Dhcp4Init state. The Start() function can be called - again to restart the process. - Refer to RFC 2131 for precise state transitions during this process. At the - time when each event occurs in this process, the callback function that was set - by EFI_DHCP4_PROTOCOL.Configure() will be called and the user can take this - opportunity to control the process. - - @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. - @param[in] CompletionEvent If not NULL, indicates the event that will be signaled when the - EFI DHCPv4 Protocol driver is transferred into the - Dhcp4Bound state or when the DHCP process is aborted. - EFI_DHCP4_PROTOCOL.GetModeData() can be called to - check the completion status. If NULL, - EFI_DHCP4_PROTOCOL.Start() will wait until the driver - is transferred into the Dhcp4Bound state or the process fails. - - @retval EFI_SUCCESS The DHCP configuration process has started, or it has completed - when CompletionEvent is NULL. - @retval EFI_NOT_STARTED The EFI DHCPv4 Protocol driver is in the Dhcp4Stopped - state. EFI_DHCP4_PROTOCOL. Configure() needs to be called. - @retval EFI_INVALID_PARAMETER This is NULL. - @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. - @retval EFI_TIMEOUT The DHCP configuration process failed because no response was - received from the server within the specified timeout value. - @retval EFI_ABORTED The user aborted the DHCP process. - @retval EFI_ALREADY_STARTED Some other EFI DHCPv4 Protocol instance already started the - DHCP process. - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. - -**/ -EFI_STATUS -EFIAPI -EfiDhcp4Start ( - IN EFI_DHCP4_PROTOCOL *This, - IN EFI_EVENT CompletionEvent OPTIONAL - ); - -/** - Extends the lease time by sending a request packet. - - The RenewRebind() function is used to manually extend the lease time when the - EFI DHCPv4 Protocol driver is in the Dhcp4Bound state and the lease time has - not expired yet. This function will send a request packet to the previously - found server (or to any server when RebindRequest is TRUE) and transfer the - state into the Dhcp4Renewing state (or Dhcp4Rebinding when RebindingRequest is - TRUE). When a response is received, the state is returned to Dhcp4Bound. - If no response is received before the try count is exceeded (the RequestTryCount - field that is specified in EFI_DHCP4_CONFIG_DATA) but before the lease time that - was issued by the previous server expires, the driver will return to the Dhcp4Bound - state and the previous configuration is restored. The outgoing and incoming packets - can be captured by the EFI_DHCP4_CALLBACK function. - - @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. - @param[in] RebindRequest If TRUE, this function broadcasts the request packets and enters - the Dhcp4Rebinding state. Otherwise, it sends a unicast - request packet and enters the Dhcp4Renewing state. - @param[in] CompletionEvent If not NULL, this event is signaled when the renew/rebind phase - completes or some error occurs. - EFI_DHCP4_PROTOCOL.GetModeData() can be called to - check the completion status. If NULL, - EFI_DHCP4_PROTOCOL.RenewRebind() will busy-wait - until the DHCP process finishes. - - @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the - Dhcp4Renewing state or is back to the Dhcp4Bound state. - @retval EFI_NOT_STARTED The EFI DHCPv4 Protocol driver is in the Dhcp4Stopped - state. EFI_DHCP4_PROTOCOL.Configure() needs to - be called. - @retval EFI_INVALID_PARAMETER This is NULL. - @retval EFI_TIMEOUT There was no response from the server when the try count was - exceeded. - @retval EFI_ACCESS_DENIED The driver is not in the Dhcp4Bound state. - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. - -**/ -EFI_STATUS -EFIAPI -EfiDhcp4RenewRebind ( - IN EFI_DHCP4_PROTOCOL *This, - IN BOOLEAN RebindRequest, - IN EFI_EVENT CompletionEvent OPTIONAL - ); - -/** - Releases the current address configuration. - - The Release() function releases the current configured IP address by doing either - of the following: - * Sending a DHCPRELEASE packet when the EFI DHCPv4 Protocol driver is in the - Dhcp4Bound state - * Setting the previously assigned IP address that was provided with the - EFI_DHCP4_PROTOCOL.Configure() function to 0.0.0.0 when the driver is in - Dhcp4InitReboot state - After a successful call to this function, the EFI DHCPv4 Protocol driver returns - to the Dhcp4Init state and any subsequent incoming packets will be discarded silently. - - @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. - - @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Init phase. - @retval EFI_INVALID_PARAMETER This is NULL. - @retval EFI_ACCESS_DENIED The EFI DHCPv4 Protocol driver is not Dhcp4InitReboot state. - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. - -**/ -EFI_STATUS -EFIAPI -EfiDhcp4Release ( - IN EFI_DHCP4_PROTOCOL *This - ); - -/** - Stops the current address configuration. - - The Stop() function is used to stop the DHCP configuration process. After this - function is called successfully, the EFI DHCPv4 Protocol driver is transferred - into the Dhcp4Stopped state. EFI_DHCP4_PROTOCOL.Configure() needs to be called - before DHCP configuration process can be started again. This function can be - called when the EFI DHCPv4 Protocol driver is in any state. - - @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. - - @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Stopped phase. - @retval EFI_INVALID_PARAMETER This is NULL. - -**/ -EFI_STATUS -EFIAPI -EfiDhcp4Stop ( - IN EFI_DHCP4_PROTOCOL *This - ); - -/** - Builds a DHCP packet, given the options to be appended or deleted or replaced. - - The Build() function is used to assemble a new packet from the original packet - by replacing or deleting existing options or appending new options. This function - does not change any state of the EFI DHCPv4 Protocol driver and can be used at - any time. - - @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. - @param[in] SeedPacket Initial packet to be used as a base for building new packet. - @param[in] DeleteCount Number of opcodes in the DeleteList. - @param[in] DeleteList List of opcodes to be deleted from the seed packet. - Ignored if DeleteCount is zero. - @param[in] AppendCount Number of entries in the OptionList. - @param[in] AppendList Pointer to a DHCP option list to be appended to SeedPacket. - If SeedPacket also contains options in this list, they are - replaced by new options (except pad option). Ignored if - AppendCount is zero. Type EFI_DHCP4_PACKET_OPTION - @param[out] NewPacket Pointer to storage for the pointer to the new allocated packet. - Use the EFI Boot Service FreePool() on the resulting pointer - when done with the packet. - - @retval EFI_SUCCESS The new packet was built. - @retval EFI_OUT_OF_RESOURCES Storage for the new packet could not be allocated. - @retval EFI_INVALID_PARAMETER Some parameter is NULL. - -**/ -EFI_STATUS -EFIAPI -EfiDhcp4Build ( - IN EFI_DHCP4_PROTOCOL *This, - IN EFI_DHCP4_PACKET *SeedPacket, - IN UINT32 DeleteCount, - IN UINT8 *DeleteList OPTIONAL, - IN UINT32 AppendCount, - IN EFI_DHCP4_PACKET_OPTION *AppendList[] OPTIONAL, - OUT EFI_DHCP4_PACKET **NewPacket - ); - -/** - Transmits a DHCP formatted packet and optionally waits for responses. - - The TransmitReceive() function is used to transmit a DHCP packet and optionally - wait for the response from servers. This function does not change the state of - the EFI DHCPv4 Protocol driver and thus can be used at any time. - - @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. - @param[in] Token Pointer to the EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN structure. - - @retval EFI_SUCCESS The packet was successfully queued for transmission. - @retval EFI_INVALID_PARAMETER Some parameter is NULL. - @retval EFI_NOT_READY The previous call to this function has not finished yet. Try to call - this function after collection process completes. - @retval EFI_NO_MAPPING The default station address is not available yet. - @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. - @retval Others Some other unexpected error occurred. - -**/ -EFI_STATUS -EFIAPI -EfiDhcp4TransmitReceive ( - IN EFI_DHCP4_PROTOCOL *This, - IN EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN *Token - ); - -/** - Parses the packed DHCP option data. - - The Parse() function is used to retrieve the option list from a DHCP packet. - If *OptionCount isn't zero, and there is enough space for all the DHCP options - in the Packet, each element of PacketOptionList is set to point to somewhere in - the Packet->Dhcp4.Option where a new DHCP option begins. If RFC3396 is supported, - the caller should reassemble the parsed DHCP options to get the finial result. - If *OptionCount is zero or there isn't enough space for all of them, the number - of DHCP options in the Packet is returned in OptionCount. - - @param This Pointer to the EFI_DHCP4_PROTOCOL instance. - @param Packet Pointer to packet to be parsed. - @param OptionCount On input, the number of entries in the PacketOptionList. - On output, the number of entries that were written into the - PacketOptionList. - @param PacketOptionList List of packet option entries to be filled in. End option or pad - options are not included. - - @retval EFI_SUCCESS The packet was successfully parsed. - @retval EFI_INVALID_PARAMETER Some parameter is NULL. - @retval EFI_BUFFER_TOO_SMALL One or more of the following conditions is TRUE: - 1) *OptionCount is smaller than the number of options that - were found in the Packet. - 2) PacketOptionList is NULL. - -**/ -EFI_STATUS -EFIAPI -EfiDhcp4Parse ( - IN EFI_DHCP4_PROTOCOL *This, - IN EFI_DHCP4_PACKET *Packet, - IN OUT UINT32 *OptionCount, - OUT EFI_DHCP4_PACKET_OPTION *PacketOptionList[] OPTIONAL - ); - -EFI_DHCP4_PROTOCOL mDhcp4ProtocolTemplate = { - EfiDhcp4GetModeData, - EfiDhcp4Configure, - EfiDhcp4Start, - EfiDhcp4RenewRebind, - EfiDhcp4Release, - EfiDhcp4Stop, - EfiDhcp4Build, - EfiDhcp4TransmitReceive, - EfiDhcp4Parse -}; - -/** - Returns the current operating mode and cached data packet for the EFI DHCPv4 Protocol driver. - - The GetModeData() function returns the current operating mode and cached data - packet for the EFI DHCPv4 Protocol driver. - - @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. - @param[out] Dhcp4ModeData Pointer to storage for the EFI_DHCP4_MODE_DATA structure. - - @retval EFI_SUCCESS The mode data was returned. - @retval EFI_INVALID_PARAMETER This is NULL. - -**/ -EFI_STATUS -EFIAPI -EfiDhcp4GetModeData ( - IN EFI_DHCP4_PROTOCOL *This, - OUT EFI_DHCP4_MODE_DATA *Dhcp4ModeData - ) -{ - DHCP_PROTOCOL *Instance; - DHCP_SERVICE *DhcpSb; - DHCP_PARAMETER *Para; - EFI_TPL OldTpl; - IP4_ADDR Ip; - - // - // First validate the parameters. - // - if ((This == NULL) || (Dhcp4ModeData == NULL)) { - return EFI_INVALID_PARAMETER; - } - - Instance = DHCP_INSTANCE_FROM_THIS (This); - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - DhcpSb = Instance->Service; - - // - // Caller can use GetModeData to retrieve current DHCP states - // no matter whether it is the active child or not. - // - Dhcp4ModeData->State = (EFI_DHCP4_STATE) DhcpSb->DhcpState; - CopyMem (&Dhcp4ModeData->ConfigData, &DhcpSb->ActiveConfig, sizeof (Dhcp4ModeData->ConfigData)); - CopyMem (&Dhcp4ModeData->ClientMacAddress, &DhcpSb->Mac, sizeof (Dhcp4ModeData->ClientMacAddress)); - - Ip = HTONL (DhcpSb->ClientAddr); - CopyMem (&Dhcp4ModeData->ClientAddress, &Ip, sizeof (EFI_IPv4_ADDRESS)); - - Ip = HTONL (DhcpSb->Netmask); - CopyMem (&Dhcp4ModeData->SubnetMask, &Ip, sizeof (EFI_IPv4_ADDRESS)); - - Ip = HTONL (DhcpSb->ServerAddr); - CopyMem (&Dhcp4ModeData->ServerAddress, &Ip, sizeof (EFI_IPv4_ADDRESS)); - - Para = DhcpSb->Para; - - if (Para != NULL) { - Ip = HTONL (Para->Router); - CopyMem (&Dhcp4ModeData->RouterAddress, &Ip, sizeof (EFI_IPv4_ADDRESS)); - Dhcp4ModeData->LeaseTime = Para->Lease; - } else { - ZeroMem (&Dhcp4ModeData->RouterAddress, sizeof (EFI_IPv4_ADDRESS)); - Dhcp4ModeData->LeaseTime = 0xffffffff; - } - - Dhcp4ModeData->ReplyPacket = DhcpSb->Selected; - - gBS->RestoreTPL (OldTpl); - return EFI_SUCCESS; -} - - -/** - Free the resource related to the configure parameters. - DHCP driver will make a copy of the user's configure - such as the time out value. - - @param Config The DHCP configure data - -**/ -VOID -DhcpCleanConfigure ( - IN OUT EFI_DHCP4_CONFIG_DATA *Config - ) -{ - UINT32 Index; - - if (Config->DiscoverTimeout != NULL) { - FreePool (Config->DiscoverTimeout); - } - - if (Config->RequestTimeout != NULL) { - FreePool (Config->RequestTimeout); - } - - if (Config->OptionList != NULL) { - for (Index = 0; Index < Config->OptionCount; Index++) { - if (Config->OptionList[Index] != NULL) { - FreePool (Config->OptionList[Index]); - } - } - - FreePool (Config->OptionList); - } - - ZeroMem (Config, sizeof (EFI_DHCP4_CONFIG_DATA)); -} - - -/** - Allocate memory for configure parameter such as timeout value for Dst, - then copy the configure parameter from Src to Dst. - - @param[out] Dst The destination DHCP configure data. - @param[in] Src The source DHCP configure data. - - @retval EFI_OUT_OF_RESOURCES Failed to allocate memory. - @retval EFI_SUCCESS The configure is copied. - -**/ -EFI_STATUS -DhcpCopyConfigure ( - OUT EFI_DHCP4_CONFIG_DATA *Dst, - IN EFI_DHCP4_CONFIG_DATA *Src - ) -{ - EFI_DHCP4_PACKET_OPTION **DstOptions; - EFI_DHCP4_PACKET_OPTION **SrcOptions; - UINTN Len; - UINT32 Index; - - CopyMem (Dst, Src, sizeof (*Dst)); - Dst->DiscoverTimeout = NULL; - Dst->RequestTimeout = NULL; - Dst->OptionList = NULL; - - // - // Allocate a memory then copy DiscoverTimeout to it - // - if (Src->DiscoverTimeout != NULL) { - Len = Src->DiscoverTryCount * sizeof (UINT32); - Dst->DiscoverTimeout = AllocatePool (Len); - - if (Dst->DiscoverTimeout == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - for (Index = 0; Index < Src->DiscoverTryCount; Index++) { - Dst->DiscoverTimeout[Index] = MAX (Src->DiscoverTimeout[Index], 1); - } - } - - // - // Allocate a memory then copy RequestTimeout to it - // - if (Src->RequestTimeout != NULL) { - Len = Src->RequestTryCount * sizeof (UINT32); - Dst->RequestTimeout = AllocatePool (Len); - - if (Dst->RequestTimeout == NULL) { - goto ON_ERROR; - } - - for (Index = 0; Index < Src->RequestTryCount; Index++) { - Dst->RequestTimeout[Index] = MAX (Src->RequestTimeout[Index], 1); - } - } - - // - // Allocate an array of dhcp option point, then allocate memory - // for each option and copy the source option to it - // - if (Src->OptionList != NULL) { - Len = Src->OptionCount * sizeof (EFI_DHCP4_PACKET_OPTION *); - Dst->OptionList = AllocateZeroPool (Len); - - if (Dst->OptionList == NULL) { - goto ON_ERROR; - } - - DstOptions = Dst->OptionList; - SrcOptions = Src->OptionList; - - for (Index = 0; Index < Src->OptionCount; Index++) { - Len = sizeof (EFI_DHCP4_PACKET_OPTION) + MAX (SrcOptions[Index]->Length - 1, 0); - - DstOptions[Index] = AllocatePool (Len); - - if (DstOptions[Index] == NULL) { - goto ON_ERROR; - } - - CopyMem (DstOptions[Index], SrcOptions[Index], Len); - } - } - - return EFI_SUCCESS; - -ON_ERROR: - DhcpCleanConfigure (Dst); - return EFI_OUT_OF_RESOURCES; -} - - -/** - Give up the control of the DHCP service to let other child - resume. Don't change the service's DHCP state and the Client - address and option list configure as required by RFC2131. - - @param DhcpSb The DHCP service instance. - -**/ -VOID -DhcpYieldControl ( - IN DHCP_SERVICE *DhcpSb - ) -{ - EFI_DHCP4_CONFIG_DATA *Config; - - Config = &DhcpSb->ActiveConfig; - - DhcpSb->ServiceState = DHCP_UNCONFIGED; - DhcpSb->ActiveChild = NULL; - - if (Config->DiscoverTimeout != NULL) { - FreePool (Config->DiscoverTimeout); - - Config->DiscoverTryCount = 0; - Config->DiscoverTimeout = NULL; - } - - if (Config->RequestTimeout != NULL) { - FreePool (Config->RequestTimeout); - - Config->RequestTryCount = 0; - Config->RequestTimeout = NULL; - } - - Config->Dhcp4Callback = NULL; - Config->CallbackContext = NULL; -} - - -/** - Initializes, changes, or resets the operational settings for the EFI DHCPv4 Protocol driver. - - The Configure() function is used to initialize, change, or reset the operational - settings of the EFI DHCPv4 Protocol driver for the communication device on which - the EFI DHCPv4 Service Binding Protocol is installed. This function can be - successfully called only if both of the following are true: - * This instance of the EFI DHCPv4 Protocol driver is in the Dhcp4Stopped, Dhcp4Init, - Dhcp4InitReboot, or Dhcp4Bound states. - * No other EFI DHCPv4 Protocol driver instance that is controlled by this EFI - DHCPv4 Service Binding Protocol driver instance has configured this EFI DHCPv4 - Protocol driver. - When this driver is in the Dhcp4Stopped state, it can transfer into one of the - following two possible initial states: - * Dhcp4Init - * Dhcp4InitReboot - The driver can transfer into these states by calling Configure() with a non-NULL - Dhcp4CfgData. The driver will transfer into the appropriate state based on the - supplied client network address in the ClientAddress parameter and DHCP options - in the OptionList parameter as described in RFC 2131. - When Configure() is called successfully while Dhcp4CfgData is set to NULL, the - default configuring data will be reset in the EFI DHCPv4 Protocol driver and - the state of the EFI DHCPv4 Protocol driver will not be changed. If one instance - wants to make it possible for another instance to configure the EFI DHCPv4 Protocol - driver, it must call this function with Dhcp4CfgData set to NULL. - - @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. - @param[in] Dhcp4CfgData Pointer to the EFI_DHCP4_CONFIG_DATA. - - @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Init or - Dhcp4InitReboot state, if the original state of this driver - was Dhcp4Stopped and the value of Dhcp4CfgData was - not NULL. Otherwise, the state was left unchanged. - @retval EFI_ACCESS_DENIED This instance of the EFI DHCPv4 Protocol driver was not in the - Dhcp4Stopped, Dhcp4Init, Dhcp4InitReboot, or Dhcp4Bound state; - Or onother instance of this EFI DHCPv4 Protocol driver is already - in a valid configured state. - @retval EFI_INVALID_PARAMETER Some parameter is NULL. - @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. - -**/ -EFI_STATUS -EFIAPI -EfiDhcp4Configure ( - IN EFI_DHCP4_PROTOCOL *This, - IN EFI_DHCP4_CONFIG_DATA *Dhcp4CfgData OPTIONAL - ) -{ - EFI_DHCP4_CONFIG_DATA *Config; - DHCP_PROTOCOL *Instance; - DHCP_SERVICE *DhcpSb; - EFI_STATUS Status; - EFI_TPL OldTpl; - UINT32 Index; - IP4_ADDR Ip; - - // - // First validate the parameters - // - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - if (Dhcp4CfgData != NULL) { - if ((Dhcp4CfgData->DiscoverTryCount != 0) && (Dhcp4CfgData->DiscoverTimeout == NULL)) { - return EFI_INVALID_PARAMETER; - } - - if ((Dhcp4CfgData->RequestTryCount != 0) && (Dhcp4CfgData->RequestTimeout == NULL)) { - return EFI_INVALID_PARAMETER; - } - - if ((Dhcp4CfgData->OptionCount != 0) && (Dhcp4CfgData->OptionList == NULL)) { - return EFI_INVALID_PARAMETER; - } - - CopyMem (&Ip, &Dhcp4CfgData->ClientAddress, sizeof (IP4_ADDR)); - if (IP4_IS_LOCAL_BROADCAST(NTOHL (Ip))) { - return EFI_INVALID_PARAMETER; - } - } - - Instance = DHCP_INSTANCE_FROM_THIS (This); - - if (Instance->Signature != DHCP_PROTOCOL_SIGNATURE) { - return EFI_INVALID_PARAMETER; - } - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - DhcpSb = Instance->Service; - Config = &DhcpSb->ActiveConfig; - - Status = EFI_ACCESS_DENIED; - - if ((DhcpSb->DhcpState != Dhcp4Stopped) && - (DhcpSb->DhcpState != Dhcp4Init) && - (DhcpSb->DhcpState != Dhcp4InitReboot) && - (DhcpSb->DhcpState != Dhcp4Bound)) { - - goto ON_EXIT; - } - - if ((DhcpSb->ActiveChild != NULL) && (DhcpSb->ActiveChild != Instance)) { - goto ON_EXIT; - } - - if (Dhcp4CfgData != NULL) { - Status = EFI_OUT_OF_RESOURCES; - DhcpCleanConfigure (Config); - - if (EFI_ERROR (DhcpCopyConfigure (Config, Dhcp4CfgData))) { - goto ON_EXIT; - } - - DhcpSb->UserOptionLen = 0; - - for (Index = 0; Index < Dhcp4CfgData->OptionCount; Index++) { - DhcpSb->UserOptionLen += Dhcp4CfgData->OptionList[Index]->Length + 2; - } - - DhcpSb->ActiveChild = Instance; - - if (DhcpSb->DhcpState == Dhcp4Stopped) { - DhcpSb->ClientAddr = EFI_NTOHL (Dhcp4CfgData->ClientAddress); - - if (DhcpSb->ClientAddr != 0) { - DhcpSb->DhcpState = Dhcp4InitReboot; - } else { - DhcpSb->DhcpState = Dhcp4Init; - } - } - - DhcpSb->ServiceState = DHCP_CONFIGED; - Status = EFI_SUCCESS; - - } else if (DhcpSb->ActiveChild == Instance) { - Status = EFI_SUCCESS; - DhcpYieldControl (DhcpSb); - } - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - return Status; -} - - -/** - Starts the DHCP configuration process. - - The Start() function starts the DHCP configuration process. This function can - be called only when the EFI DHCPv4 Protocol driver is in the Dhcp4Init or - Dhcp4InitReboot state. - If the DHCP process completes successfully, the state of the EFI DHCPv4 Protocol - driver will be transferred through Dhcp4Selecting and Dhcp4Requesting to the - Dhcp4Bound state. The CompletionEvent will then be signaled if it is not NULL. - If the process aborts, either by the user or by some unexpected network error, - the state is restored to the Dhcp4Init state. The Start() function can be called - again to restart the process. - Refer to RFC 2131 for precise state transitions during this process. At the - time when each event occurs in this process, the callback function that was set - by EFI_DHCP4_PROTOCOL.Configure() will be called and the user can take this - opportunity to control the process. - - @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. - @param[in] CompletionEvent If not NULL, indicates the event that will be signaled when the - EFI DHCPv4 Protocol driver is transferred into the - Dhcp4Bound state or when the DHCP process is aborted. - EFI_DHCP4_PROTOCOL.GetModeData() can be called to - check the completion status. If NULL, - EFI_DHCP4_PROTOCOL.Start() will wait until the driver - is transferred into the Dhcp4Bound state or the process fails. - - @retval EFI_SUCCESS The DHCP configuration process has started, or it has completed - when CompletionEvent is NULL. - @retval EFI_NOT_STARTED The EFI DHCPv4 Protocol driver is in the Dhcp4Stopped - state. EFI_DHCP4_PROTOCOL. Configure() needs to be called. - @retval EFI_INVALID_PARAMETER This is NULL. - @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. - @retval EFI_TIMEOUT The DHCP configuration process failed because no response was - received from the server within the specified timeout value. - @retval EFI_ABORTED The user aborted the DHCP process. - @retval EFI_ALREADY_STARTED Some other EFI DHCPv4 Protocol instance already started the - DHCP process. - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. - @retval EFI_NO_MEDIA There was a media error. - -**/ -EFI_STATUS -EFIAPI -EfiDhcp4Start ( - IN EFI_DHCP4_PROTOCOL *This, - IN EFI_EVENT CompletionEvent OPTIONAL - ) -{ - DHCP_PROTOCOL *Instance; - DHCP_SERVICE *DhcpSb; - EFI_STATUS Status; - EFI_TPL OldTpl; - EFI_STATUS MediaStatus; - - // - // First validate the parameters - // - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - Instance = DHCP_INSTANCE_FROM_THIS (This); - - if (Instance->Signature != DHCP_PROTOCOL_SIGNATURE) { - return EFI_INVALID_PARAMETER; - } - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - DhcpSb = Instance->Service; - - if (DhcpSb->DhcpState == Dhcp4Stopped) { - Status = EFI_NOT_STARTED; - goto ON_ERROR; - } - - if ((DhcpSb->DhcpState != Dhcp4Init) && (DhcpSb->DhcpState != Dhcp4InitReboot)) { - Status = EFI_ALREADY_STARTED; - goto ON_ERROR; - } - - // - // Check Media Satus. - // - MediaStatus = EFI_SUCCESS; - NetLibDetectMediaWaitTimeout (DhcpSb->Controller, DHCP_CHECK_MEDIA_WAITING_TIME, &MediaStatus); - if (MediaStatus != EFI_SUCCESS) { - Status = EFI_NO_MEDIA; - goto ON_ERROR; - } - - DhcpSb->IoStatus = EFI_ALREADY_STARTED; - - if (EFI_ERROR (Status = DhcpInitRequest (DhcpSb))) { - goto ON_ERROR; - } - - - Instance->CompletionEvent = CompletionEvent; - - // - // Restore the TPL now, don't call poll function at TPL_CALLBACK. - // - gBS->RestoreTPL (OldTpl); - - if (CompletionEvent == NULL) { - while (DhcpSb->IoStatus == EFI_ALREADY_STARTED) { - DhcpSb->UdpIo->Protocol.Udp4->Poll (DhcpSb->UdpIo->Protocol.Udp4); - } - - return DhcpSb->IoStatus; - } - - return EFI_SUCCESS; - -ON_ERROR: - gBS->RestoreTPL (OldTpl); - return Status; -} - - -/** - Extends the lease time by sending a request packet. - - The RenewRebind() function is used to manually extend the lease time when the - EFI DHCPv4 Protocol driver is in the Dhcp4Bound state and the lease time has - not expired yet. This function will send a request packet to the previously - found server (or to any server when RebindRequest is TRUE) and transfer the - state into the Dhcp4Renewing state (or Dhcp4Rebinding when RebindingRequest is - TRUE). When a response is received, the state is returned to Dhcp4Bound. - If no response is received before the try count is exceeded (the RequestTryCount - field that is specified in EFI_DHCP4_CONFIG_DATA) but before the lease time that - was issued by the previous server expires, the driver will return to the Dhcp4Bound - state and the previous configuration is restored. The outgoing and incoming packets - can be captured by the EFI_DHCP4_CALLBACK function. - - @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. - @param[in] RebindRequest If TRUE, this function broadcasts the request packets and enters - the Dhcp4Rebinding state. Otherwise, it sends a unicast - request packet and enters the Dhcp4Renewing state. - @param[in] CompletionEvent If not NULL, this event is signaled when the renew/rebind phase - completes or some error occurs. - EFI_DHCP4_PROTOCOL.GetModeData() can be called to - check the completion status. If NULL, - EFI_DHCP4_PROTOCOL.RenewRebind() will busy-wait - until the DHCP process finishes. - - @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the - Dhcp4Renewing state or is back to the Dhcp4Bound state. - @retval EFI_NOT_STARTED The EFI DHCPv4 Protocol driver is in the Dhcp4Stopped - state. EFI_DHCP4_PROTOCOL.Configure() needs to - be called. - @retval EFI_INVALID_PARAMETER This is NULL. - @retval EFI_TIMEOUT There was no response from the server when the try count was - exceeded. - @retval EFI_ACCESS_DENIED The driver is not in the Dhcp4Bound state. - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. - -**/ -EFI_STATUS -EFIAPI -EfiDhcp4RenewRebind ( - IN EFI_DHCP4_PROTOCOL *This, - IN BOOLEAN RebindRequest, - IN EFI_EVENT CompletionEvent OPTIONAL - ) -{ - DHCP_PROTOCOL *Instance; - DHCP_SERVICE *DhcpSb; - EFI_STATUS Status; - EFI_TPL OldTpl; - - // - // First validate the parameters - // - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - Instance = DHCP_INSTANCE_FROM_THIS (This); - - if (Instance->Signature != DHCP_PROTOCOL_SIGNATURE) { - return EFI_INVALID_PARAMETER; - } - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - DhcpSb = Instance->Service; - - if (DhcpSb->DhcpState == Dhcp4Stopped) { - Status = EFI_NOT_STARTED; - goto ON_EXIT; - } - - if (DhcpSb->DhcpState != Dhcp4Bound) { - Status = EFI_ACCESS_DENIED; - goto ON_EXIT; - } - - if (DHCP_IS_BOOTP (DhcpSb->Para)) { - Status = EFI_SUCCESS; - goto ON_EXIT; - } - - // - // Transit the states then send a extra DHCP request - // - if (!RebindRequest) { - DhcpSetState (DhcpSb, Dhcp4Renewing, FALSE); - } else { - DhcpSetState (DhcpSb, Dhcp4Rebinding, FALSE); - } - - // - // Clear initial time to make sure that elapsed-time - // is set to 0 for first REQUEST in renewal process. - // - Instance->ElaspedTime = 0; - - Status = DhcpSendMessage ( - DhcpSb, - DhcpSb->Selected, - DhcpSb->Para, - DHCP_MSG_REQUEST, - (UINT8 *) "Extra renew/rebind by the application" - ); - - if (EFI_ERROR (Status)) { - DhcpSetState (DhcpSb, Dhcp4Bound, FALSE); - goto ON_EXIT; - } - - DhcpSb->ExtraRefresh = TRUE; - DhcpSb->IoStatus = EFI_ALREADY_STARTED; - Instance->RenewRebindEvent = CompletionEvent; - - gBS->RestoreTPL (OldTpl); - - if (CompletionEvent == NULL) { - while (DhcpSb->IoStatus == EFI_ALREADY_STARTED) { - DhcpSb->UdpIo->Protocol.Udp4->Poll (DhcpSb->UdpIo->Protocol.Udp4); - - } - - return DhcpSb->IoStatus; - } - - return EFI_SUCCESS; - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - return Status; -} - - -/** - Releases the current address configuration. - - The Release() function releases the current configured IP address by doing either - of the following: - * Sending a DHCPRELEASE packet when the EFI DHCPv4 Protocol driver is in the - Dhcp4Bound state - * Setting the previously assigned IP address that was provided with the - EFI_DHCP4_PROTOCOL.Configure() function to 0.0.0.0 when the driver is in - Dhcp4InitReboot state - After a successful call to this function, the EFI DHCPv4 Protocol driver returns - to the Dhcp4Init state and any subsequent incoming packets will be discarded silently. - - @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. - - @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Init phase. - @retval EFI_INVALID_PARAMETER This is NULL. - @retval EFI_ACCESS_DENIED The EFI DHCPv4 Protocol driver is not Dhcp4InitReboot state. - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. - -**/ -EFI_STATUS -EFIAPI -EfiDhcp4Release ( - IN EFI_DHCP4_PROTOCOL *This - ) -{ - DHCP_PROTOCOL *Instance; - DHCP_SERVICE *DhcpSb; - EFI_STATUS Status; - EFI_TPL OldTpl; - - // - // First validate the parameters - // - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - Instance = DHCP_INSTANCE_FROM_THIS (This); - - if (Instance->Signature != DHCP_PROTOCOL_SIGNATURE) { - return EFI_INVALID_PARAMETER; - } - - Status = EFI_SUCCESS; - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - DhcpSb = Instance->Service; - - if ((DhcpSb->DhcpState != Dhcp4InitReboot) && (DhcpSb->DhcpState != Dhcp4Bound)) { - Status = EFI_ACCESS_DENIED; - goto ON_EXIT; - } - - if (!DHCP_IS_BOOTP (DhcpSb->Para) && (DhcpSb->DhcpState == Dhcp4Bound)) { - Status = DhcpSendMessage ( - DhcpSb, - DhcpSb->Selected, - DhcpSb->Para, - DHCP_MSG_RELEASE, - NULL - ); - - if (EFI_ERROR (Status)) { - Status = EFI_DEVICE_ERROR; - goto ON_EXIT; - } - } - - DhcpCleanLease (DhcpSb); - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - return Status; -} - - -/** - Stops the current address configuration. - - The Stop() function is used to stop the DHCP configuration process. After this - function is called successfully, the EFI DHCPv4 Protocol driver is transferred - into the Dhcp4Stopped state. EFI_DHCP4_PROTOCOL.Configure() needs to be called - before DHCP configuration process can be started again. This function can be - called when the EFI DHCPv4 Protocol driver is in any state. - - @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. - - @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Stopped phase. - @retval EFI_INVALID_PARAMETER This is NULL. - -**/ -EFI_STATUS -EFIAPI -EfiDhcp4Stop ( - IN EFI_DHCP4_PROTOCOL *This - ) -{ - DHCP_PROTOCOL *Instance; - DHCP_SERVICE *DhcpSb; - EFI_TPL OldTpl; - - // - // First validate the parameters - // - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - Instance = DHCP_INSTANCE_FROM_THIS (This); - - if (Instance->Signature != DHCP_PROTOCOL_SIGNATURE) { - return EFI_INVALID_PARAMETER; - } - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - DhcpSb = Instance->Service; - - DhcpCleanLease (DhcpSb); - - DhcpSb->DhcpState = Dhcp4Stopped; - DhcpSb->ServiceState = DHCP_UNCONFIGED; - - gBS->RestoreTPL (OldTpl); - return EFI_SUCCESS; -} - - -/** - Builds a DHCP packet, given the options to be appended or deleted or replaced. - - The Build() function is used to assemble a new packet from the original packet - by replacing or deleting existing options or appending new options. This function - does not change any state of the EFI DHCPv4 Protocol driver and can be used at - any time. - - @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. - @param[in] SeedPacket Initial packet to be used as a base for building new packet. - @param[in] DeleteCount Number of opcodes in the DeleteList. - @param[in] DeleteList List of opcodes to be deleted from the seed packet. - Ignored if DeleteCount is zero. - @param[in] AppendCount Number of entries in the OptionList. - @param[in] AppendList Pointer to a DHCP option list to be appended to SeedPacket. - If SeedPacket also contains options in this list, they are - replaced by new options (except pad option). Ignored if - AppendCount is zero. Type EFI_DHCP4_PACKET_OPTION - @param[out] NewPacket Pointer to storage for the pointer to the new allocated packet. - Use the EFI Boot Service FreePool() on the resulting pointer - when done with the packet. - - @retval EFI_SUCCESS The new packet was built. - @retval EFI_OUT_OF_RESOURCES Storage for the new packet could not be allocated. - @retval EFI_INVALID_PARAMETER Some parameter is NULL. - -**/ -EFI_STATUS -EFIAPI -EfiDhcp4Build ( - IN EFI_DHCP4_PROTOCOL *This, - IN EFI_DHCP4_PACKET *SeedPacket, - IN UINT32 DeleteCount, - IN UINT8 *DeleteList OPTIONAL, - IN UINT32 AppendCount, - IN EFI_DHCP4_PACKET_OPTION *AppendList[] OPTIONAL, - OUT EFI_DHCP4_PACKET **NewPacket - ) -{ - // - // First validate the parameters - // - if ((This == NULL) || (NewPacket == NULL)) { - return EFI_INVALID_PARAMETER; - } - - if ((SeedPacket == NULL) || (SeedPacket->Dhcp4.Magik != DHCP_OPTION_MAGIC) || - EFI_ERROR (DhcpValidateOptions (SeedPacket, NULL))) { - - return EFI_INVALID_PARAMETER; - } - - if (((DeleteCount == 0) && (AppendCount == 0)) || - ((DeleteCount != 0) && (DeleteList == NULL)) || - ((AppendCount != 0) && (AppendList == NULL))) { - - return EFI_INVALID_PARAMETER; - } - - return DhcpBuild ( - SeedPacket, - DeleteCount, - DeleteList, - AppendCount, - AppendList, - NewPacket - ); -} - -/** - Callback by UdpIoCreatePort() when creating UdpIo for this Dhcp4 instance. - - @param[in] UdpIo The UdpIo being created. - @param[in] Context Dhcp4 instance. - - @retval EFI_SUCCESS UdpIo is configured successfully. - @retval EFI_INVALID_PARAMETER Class E IP address is not supported or other parameters - are not valid. - @retval other Other error occurs. -**/ -EFI_STATUS -EFIAPI -Dhcp4InstanceConfigUdpIo ( - IN UDP_IO *UdpIo, - IN VOID *Context - ) -{ - DHCP_PROTOCOL *Instance; - DHCP_SERVICE *DhcpSb; - EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN *Token; - EFI_UDP4_CONFIG_DATA UdpConfigData; - IP4_ADDR ClientAddr; - IP4_ADDR Ip; - INTN Class; - IP4_ADDR SubnetMask; - - Instance = (DHCP_PROTOCOL *) Context; - DhcpSb = Instance->Service; - Token = Instance->Token; - - ZeroMem (&UdpConfigData, sizeof (EFI_UDP4_CONFIG_DATA)); - - UdpConfigData.AcceptBroadcast = TRUE; - UdpConfigData.AllowDuplicatePort = TRUE; - UdpConfigData.TimeToLive = 64; - UdpConfigData.DoNotFragment = TRUE; - - ClientAddr = EFI_NTOHL (Token->Packet->Dhcp4.Header.ClientAddr); - Ip = HTONL (ClientAddr); - CopyMem (&UdpConfigData.StationAddress, &Ip, sizeof (EFI_IPv4_ADDRESS)); - - if (DhcpSb->Netmask == 0) { - // - // The Dhcp4.TransmitReceive() API should be able to used at any time according to - // UEFI spec, while in classless addressing network, the netmask must be explicitly - // provided together with the station address. - // If the DHCP instance haven't be configured with a valid netmask, we could only - // compute it according to the classful addressing rule. - // - Class = NetGetIpClass (ClientAddr); - // - // Class E IP address is not supported here! - // - ASSERT (Class < IP4_ADDR_CLASSE); - if (Class >= IP4_ADDR_CLASSE) { - return EFI_INVALID_PARAMETER; - } - - SubnetMask = gIp4AllMasks[Class << 3]; - } else { - SubnetMask = DhcpSb->Netmask; - } - - Ip = HTONL (SubnetMask); - CopyMem (&UdpConfigData.SubnetMask, &Ip, sizeof (EFI_IPv4_ADDRESS)); - - if ((Token->ListenPointCount == 0) || (Token->ListenPoints[0].ListenPort == 0)) { - UdpConfigData.StationPort = DHCP_CLIENT_PORT; - } else { - UdpConfigData.StationPort = Token->ListenPoints[0].ListenPort; - } - - return UdpIo->Protocol.Udp4->Configure (UdpIo->Protocol.Udp4, &UdpConfigData); -} - -/** - Create UdpIo for this Dhcp4 instance. - - @param Instance The Dhcp4 instance. - - @retval EFI_SUCCESS UdpIo is created successfully. - @retval EFI_OUT_OF_RESOURCES Fails to create UdpIo because of limited - resources or configuration failure. -**/ -EFI_STATUS -Dhcp4InstanceCreateUdpIo ( - IN OUT DHCP_PROTOCOL *Instance - ) -{ - DHCP_SERVICE *DhcpSb; - EFI_STATUS Status; - VOID *Udp4; - - ASSERT (Instance->Token != NULL); - - DhcpSb = Instance->Service; - Instance->UdpIo = UdpIoCreateIo ( - DhcpSb->Controller, - DhcpSb->Image, - Dhcp4InstanceConfigUdpIo, - UDP_IO_UDP4_VERSION, - Instance - ); - if (Instance->UdpIo == NULL) { - return EFI_OUT_OF_RESOURCES; - } else { - Status = gBS->OpenProtocol ( - Instance->UdpIo->UdpHandle, - &gEfiUdp4ProtocolGuid, - (VOID **) &Udp4, - Instance->Service->Image, - Instance->Handle, - EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER - ); - if (EFI_ERROR (Status)) { - UdpIoFreeIo (Instance->UdpIo); - Instance->UdpIo = NULL; - } - return Status; - } -} - -/** - Callback of Dhcp packet. Does nothing. - - @param Arg The context. - -**/ -VOID -EFIAPI -DhcpDummyExtFree ( - IN VOID *Arg - ) -{ -} - -/** - Callback of UdpIoRecvDatagram() that handles a Dhcp4 packet. - - Only BOOTP responses will be handled that correspond to the Xid of the request - sent out. The packet will be queued to the response queue. - - @param UdpPacket The Dhcp4 packet. - @param EndPoint Udp4 address pair. - @param IoStatus Status of the input. - @param Context Extra info for the input. - -**/ -VOID -EFIAPI -PxeDhcpInput ( - NET_BUF *UdpPacket, - UDP_END_POINT *EndPoint, - EFI_STATUS IoStatus, - VOID *Context - ) -{ - DHCP_PROTOCOL *Instance; - EFI_DHCP4_HEADER *Head; - NET_BUF *Wrap; - EFI_DHCP4_PACKET *Packet; - EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN *Token; - UINT32 Len; - EFI_STATUS Status; - - Wrap = NULL; - Instance = (DHCP_PROTOCOL *) Context; - Token = Instance->Token; - - // - // Don't restart receive if error occurs or DHCP is destroyed. - // - if (EFI_ERROR (IoStatus)) { - return ; - } - - ASSERT (UdpPacket != NULL); - - // - // Validate the packet received - // - if (UdpPacket->TotalSize < sizeof (EFI_DHCP4_HEADER)) { - goto RESTART; - } - - // - // Copy the DHCP message to a continuous memory block, make the buffer size - // of the EFI_DHCP4_PACKET a multiple of 4-byte. - // - Len = NET_ROUNDUP (sizeof (EFI_DHCP4_PACKET) + UdpPacket->TotalSize - sizeof (EFI_DHCP4_HEADER), 4); - Wrap = NetbufAlloc (Len); - if (Wrap == NULL) { - goto RESTART; - } - - Packet = (EFI_DHCP4_PACKET *) NetbufAllocSpace (Wrap, Len, NET_BUF_TAIL); - ASSERT (Packet != NULL); - - Packet->Size = Len; - Head = &Packet->Dhcp4.Header; - Packet->Length = NetbufCopy (UdpPacket, 0, UdpPacket->TotalSize, (UINT8 *) Head); - - if (Packet->Length != UdpPacket->TotalSize) { - goto RESTART; - } - - // - // Is this packet the answer to our packet? - // - if ((Head->OpCode != BOOTP_REPLY) || - (Head->Xid != Token->Packet->Dhcp4.Header.Xid) || - (CompareMem (&Token->Packet->Dhcp4.Header.ClientHwAddr[0], Head->ClientHwAddr, Head->HwAddrLen) != 0)) { - goto RESTART; - } - - // - // Validate the options and retrieve the interested options - // - if ((Packet->Length > sizeof (EFI_DHCP4_HEADER) + sizeof (UINT32)) && - (Packet->Dhcp4.Magik == DHCP_OPTION_MAGIC) && - EFI_ERROR (DhcpValidateOptions (Packet, NULL))) { - - goto RESTART; - } - - // - // Keep this packet in the ResponseQueue. - // - NET_GET_REF (Wrap); - NetbufQueAppend (&Instance->ResponseQueue, Wrap); - -RESTART: - - NetbufFree (UdpPacket); - - if (Wrap != NULL) { - NetbufFree (Wrap); - } - - Status = UdpIoRecvDatagram (Instance->UdpIo, PxeDhcpInput, Instance, 0); - if (EFI_ERROR (Status)) { - PxeDhcpDone (Instance); - } -} - -/** - Complete a Dhcp4 transaction and signal the upper layer. - - @param Instance Dhcp4 instance. - -**/ -VOID -PxeDhcpDone ( - IN DHCP_PROTOCOL *Instance - ) -{ - EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN *Token; - - Token = Instance->Token; - - Token->ResponseCount = Instance->ResponseQueue.BufNum; - if (Token->ResponseCount != 0) { - Token->ResponseList = (EFI_DHCP4_PACKET *) AllocatePool (Instance->ResponseQueue.BufSize); - if (Token->ResponseList == NULL) { - Token->Status = EFI_OUT_OF_RESOURCES; - goto SIGNAL_USER; - } - - // - // Copy the received DHCP responses. - // - NetbufQueCopy (&Instance->ResponseQueue, 0, Instance->ResponseQueue.BufSize, (UINT8 *) Token->ResponseList); - Token->Status = EFI_SUCCESS; - } else { - Token->ResponseList = NULL; - Token->Status = EFI_TIMEOUT; - } - -SIGNAL_USER: - // - // Clean up the resources dedicated for this transmit receive transaction. - // - NetbufQueFlush (&Instance->ResponseQueue); - UdpIoCleanIo (Instance->UdpIo); - gBS->CloseProtocol ( - Instance->UdpIo->UdpHandle, - &gEfiUdp4ProtocolGuid, - Instance->Service->Image, - Instance->Handle - ); - UdpIoFreeIo (Instance->UdpIo); - Instance->UdpIo = NULL; - Instance->Token = NULL; - - if (Token->CompletionEvent != NULL) { - gBS->SignalEvent (Token->CompletionEvent); - } -} - - -/** - Transmits a DHCP formatted packet and optionally waits for responses. - - The TransmitReceive() function is used to transmit a DHCP packet and optionally - wait for the response from servers. This function does not change the state of - the EFI DHCPv4 Protocol driver and thus can be used at any time. - - @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. - @param[in] Token Pointer to the EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN structure. - - @retval EFI_SUCCESS The packet was successfully queued for transmission. - @retval EFI_INVALID_PARAMETER Some parameter is NULL. - @retval EFI_NOT_READY The previous call to this function has not finished yet. Try to call - this function after collection process completes. - @retval EFI_NO_MAPPING The default station address is not available yet. - @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. - @retval Others Some other unexpected error occurred. - -**/ -EFI_STATUS -EFIAPI -EfiDhcp4TransmitReceive ( - IN EFI_DHCP4_PROTOCOL *This, - IN EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN *Token - ) -{ - DHCP_PROTOCOL *Instance; - EFI_TPL OldTpl; - EFI_STATUS Status; - NET_FRAGMENT Frag; - NET_BUF *Wrap; - UDP_END_POINT EndPoint; - IP4_ADDR Ip; - DHCP_SERVICE *DhcpSb; - EFI_IP_ADDRESS Gateway; - IP4_ADDR ClientAddr; - - if ((This == NULL) || (Token == NULL) || (Token->Packet == NULL)) { - return EFI_INVALID_PARAMETER; - } - - Instance = DHCP_INSTANCE_FROM_THIS (This); - DhcpSb = Instance->Service; - - if (Instance->Token != NULL) { - // - // The previous call to TransmitReceive is not finished. - // - return EFI_NOT_READY; - } - - if ((Token->Packet->Dhcp4.Magik != DHCP_OPTION_MAGIC) || - (NTOHL (Token->Packet->Dhcp4.Header.Xid) == Instance->Service->Xid) || - (Token->TimeoutValue == 0) || - ((Token->ListenPointCount != 0) && (Token->ListenPoints == NULL)) || - EFI_ERROR (DhcpValidateOptions (Token->Packet, NULL)) || - EFI_IP4_EQUAL (&Token->RemoteAddress, &mZeroIp4Addr) - ) { - // - // The DHCP packet isn't well-formed, the Transaction ID is already used, - // the timeout value is zero, the ListenPoint is invalid, or the - // RemoteAddress is zero. - // - return EFI_INVALID_PARAMETER; - } - - ClientAddr = EFI_NTOHL (Token->Packet->Dhcp4.Header.ClientAddr); - - if (ClientAddr == 0) { - return EFI_NO_MAPPING; - } - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - // - // Save the token and the timeout value. - // - Instance->Token = Token; - Instance->Timeout = Token->TimeoutValue; - - // - // Create a UDP IO for this transmit receive transaction. - // - Status = Dhcp4InstanceCreateUdpIo (Instance); - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - // - // Save the Client Address is sent out - // - CopyMem ( - &DhcpSb->ClientAddressSendOut[0], - &Token->Packet->Dhcp4.Header.ClientHwAddr[0], - Token->Packet->Dhcp4.Header.HwAddrLen - ); - - // - // Wrap the DHCP packet into a net buffer. - // - Frag.Bulk = (UINT8 *) &Token->Packet->Dhcp4; - Frag.Len = Token->Packet->Length; - Wrap = NetbufFromExt (&Frag, 1, 0, 0, DhcpDummyExtFree, NULL); - if (Wrap == NULL) { - Status = EFI_OUT_OF_RESOURCES; - goto ON_ERROR; - } - - // - // Set the local address and local port to ZERO. - // - ZeroMem (&EndPoint, sizeof (UDP_END_POINT)); - - // - // Set the destination address and destination port. - // - CopyMem (&Ip, &Token->RemoteAddress, sizeof (EFI_IPv4_ADDRESS)); - EndPoint.RemoteAddr.Addr[0] = NTOHL (Ip); - - if (Token->RemotePort == 0) { - EndPoint.RemotePort = DHCP_SERVER_PORT; - } else { - EndPoint.RemotePort = Token->RemotePort; - } - - // - // Get the gateway. - // - ZeroMem (&Gateway, sizeof (Gateway)); - if (!IP4_NET_EQUAL (ClientAddr, EndPoint.RemoteAddr.Addr[0], DhcpSb->Netmask)) { - CopyMem (&Gateway.v4, &Token->GatewayAddress, sizeof (EFI_IPv4_ADDRESS)); - Gateway.Addr[0] = NTOHL (Gateway.Addr[0]); - } - - // - // Transmit the DHCP packet. - // - Status = UdpIoSendDatagram (Instance->UdpIo, Wrap, &EndPoint, &Gateway, DhcpOnPacketSent, NULL); - if (EFI_ERROR (Status)) { - NetbufFree (Wrap); - goto ON_ERROR; - } - - // - // Start to receive the DHCP response. - // - Status = UdpIoRecvDatagram (Instance->UdpIo, PxeDhcpInput, Instance, 0); - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - -ON_ERROR: - - if (EFI_ERROR (Status) && (Instance->UdpIo != NULL)) { - UdpIoCleanIo (Instance->UdpIo); - gBS->CloseProtocol ( - Instance->UdpIo->UdpHandle, - &gEfiUdp4ProtocolGuid, - Instance->Service->Image, - Instance->Handle - ); - UdpIoFreeIo (Instance->UdpIo); - Instance->UdpIo = NULL; - Instance->Token = NULL; - } - - gBS->RestoreTPL (OldTpl); - - if (!EFI_ERROR (Status) && (Token->CompletionEvent == NULL)) { - // - // Keep polling until timeout if no error happens and the CompletionEvent - // is NULL. - // - while (TRUE) { - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - // - // Raise TPL to protect the UDPIO in instance, in case that DhcpOnTimerTick - // free it when timeout. - // - if (Instance->Timeout > 0) { - Instance->UdpIo->Protocol.Udp4->Poll (Instance->UdpIo->Protocol.Udp4); - gBS->RestoreTPL (OldTpl); - } else { - gBS->RestoreTPL (OldTpl); - break; - } - } - } - - return Status; -} - - -/** - Callback function for DhcpIterateOptions. This callback sets the - EFI_DHCP4_PACKET_OPTION array in the DHCP_PARSE_CONTEXT to point - the individual DHCP option in the packet. - - @param[in] Tag The DHCP option type - @param[in] Len Length of the DHCP option data - @param[in] Data The DHCP option data - @param[in] Context The context, to pass several parameters in. - - @retval EFI_SUCCESS It always returns EFI_SUCCESS - -**/ -EFI_STATUS -Dhcp4ParseCheckOption ( - IN UINT8 Tag, - IN UINT8 Len, - IN UINT8 *Data, - IN VOID *Context - ) -{ - DHCP_PARSE_CONTEXT *Parse; - - Parse = (DHCP_PARSE_CONTEXT *) Context; - Parse->Index++; - - if (Parse->Index <= Parse->OptionCount) { - // - // Use BASE_CR to get the memory position of EFI_DHCP4_PACKET_OPTION for - // the EFI_DHCP4_PACKET_OPTION->Data because DhcpIterateOptions only - // pass in the point to option data. - // - Parse->Option[Parse->Index - 1] = BASE_CR (Data, EFI_DHCP4_PACKET_OPTION, Data); - } - - return EFI_SUCCESS; -} - - -/** - Parses the packed DHCP option data. - - The Parse() function is used to retrieve the option list from a DHCP packet. - If *OptionCount isn't zero, and there is enough space for all the DHCP options - in the Packet, each element of PacketOptionList is set to point to somewhere in - the Packet->Dhcp4.Option where a new DHCP option begins. If RFC3396 is supported, - the caller should reassemble the parsed DHCP options to get the finial result. - If *OptionCount is zero or there isn't enough space for all of them, the number - of DHCP options in the Packet is returned in OptionCount. - - @param This Pointer to the EFI_DHCP4_PROTOCOL instance. - @param Packet Pointer to packet to be parsed. - @param OptionCount On input, the number of entries in the PacketOptionList. - On output, the number of entries that were written into the - PacketOptionList. - @param PacketOptionList List of packet option entries to be filled in. End option or pad - options are not included. - - @retval EFI_SUCCESS The packet was successfully parsed. - @retval EFI_INVALID_PARAMETER Some parameter is NULL. - @retval EFI_BUFFER_TOO_SMALL One or more of the following conditions is TRUE: - 1) *OptionCount is smaller than the number of options that - were found in the Packet. - 2) PacketOptionList is NULL. - -**/ -EFI_STATUS -EFIAPI -EfiDhcp4Parse ( - IN EFI_DHCP4_PROTOCOL *This, - IN EFI_DHCP4_PACKET *Packet, - IN OUT UINT32 *OptionCount, - OUT EFI_DHCP4_PACKET_OPTION *PacketOptionList[] OPTIONAL - ) -{ - DHCP_PARSE_CONTEXT Context; - EFI_STATUS Status; - - // - // First validate the parameters - // - if ((This == NULL) || (Packet == NULL) || (OptionCount == NULL)) { - return EFI_INVALID_PARAMETER; - } - - if ((Packet->Size < Packet->Length + 2 * sizeof (UINT32)) || - (Packet->Dhcp4.Magik != DHCP_OPTION_MAGIC) || - EFI_ERROR (DhcpValidateOptions (Packet, NULL))) { - - return EFI_INVALID_PARAMETER; - } - - if ((*OptionCount != 0) && (PacketOptionList == NULL)) { - return EFI_BUFFER_TOO_SMALL; - } - - ZeroMem (PacketOptionList, *OptionCount * sizeof (EFI_DHCP4_PACKET_OPTION *)); - - Context.Option = PacketOptionList; - Context.OptionCount = *OptionCount; - Context.Index = 0; - - Status = DhcpIterateOptions (Packet, Dhcp4ParseCheckOption, &Context); - - if (EFI_ERROR (Status)) { - return Status; - } - - *OptionCount = Context.Index; - - if (Context.Index > Context.OptionCount) { - return EFI_BUFFER_TOO_SMALL; - } - - return EFI_SUCCESS; -} - -/** - Set the elapsed time based on the given instance and the pointer to the - elapsed time option. - - @param[in] Elapsed The pointer to the position to append. - @param[in] Instance The pointer to the Dhcp4 instance. -**/ -VOID -SetElapsedTime ( - IN UINT16 *Elapsed, - IN DHCP_PROTOCOL *Instance - ) -{ - WriteUnaligned16 (Elapsed, HTONS(Instance->ElaspedTime)); -} diff --git a/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Impl.h b/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Impl.h deleted file mode 100644 index 8c2cd3dae1..0000000000 --- a/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Impl.h +++ /dev/null @@ -1,206 +0,0 @@ -/** @file - EFI DHCP protocol implementation. - RFCs supported are: - RFC 2131: Dynamic Host Configuration Protocol - RFC 2132: DHCP Options and BOOTP Vendor Extensions - RFC 1534: Interoperation Between DHCP and BOOTP - RFC 3396: Encoding Long Options in DHCP. - -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef __EFI_DHCP4_IMPL_H__ -#define __EFI_DHCP4_IMPL_H__ - - - -#include - -#include -#include -#include -#include -#include -#include -#include -#include -#include - -typedef struct _DHCP_SERVICE DHCP_SERVICE; -typedef struct _DHCP_PROTOCOL DHCP_PROTOCOL; - -#include "Dhcp4Option.h" -#include "Dhcp4Io.h" - -#define DHCP_SERVICE_SIGNATURE SIGNATURE_32 ('D', 'H', 'C', 'P') -#define DHCP_PROTOCOL_SIGNATURE SIGNATURE_32 ('d', 'h', 'c', 'p') - -#define DHCP_CHECK_MEDIA_WAITING_TIME EFI_TIMER_PERIOD_SECONDS(20) - -// -// The state of the DHCP service. It starts as UNCONFIGED. If -// and active child configures the service successfully, it -// goes to CONFIGED. If the active child configures NULL, it -// goes back to UNCONFIGED. It becomes DESTROY if it is (partly) -// destroyed. -// -#define DHCP_UNCONFIGED 0 -#define DHCP_CONFIGED 1 -#define DHCP_DESTROY 2 - - -struct _DHCP_PROTOCOL { - UINT32 Signature; - EFI_DHCP4_PROTOCOL Dhcp4Protocol; - LIST_ENTRY Link; - EFI_HANDLE Handle; - DHCP_SERVICE *Service; - - BOOLEAN InDestroy; - - EFI_EVENT CompletionEvent; - EFI_EVENT RenewRebindEvent; - - EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN *Token; - UDP_IO *UdpIo; // The UDP IO used for TransmitReceive. - UINT32 Timeout; - UINT16 ElaspedTime; - NET_BUF_QUEUE ResponseQueue; -}; - -// -// DHCP driver is specical in that it is a singleton. Although it -// has a service binding, there can be only one active child. -// -struct _DHCP_SERVICE { - UINT32 Signature; - EFI_SERVICE_BINDING_PROTOCOL ServiceBinding; - - INTN ServiceState; // CONFIGED, UNCONFIGED, and DESTROY - - EFI_HANDLE Controller; - EFI_HANDLE Image; - - LIST_ENTRY Children; - UINTN NumChildren; - - INTN DhcpState; - EFI_STATUS IoStatus; // the result of last user operation - UINT32 Xid; - - IP4_ADDR ClientAddr; // lease IP or configured client address - IP4_ADDR Netmask; - IP4_ADDR ServerAddr; - - EFI_DHCP4_PACKET *LastOffer; // The last received offer - EFI_DHCP4_PACKET *Selected; - DHCP_PARAMETER *Para; - - UINT32 Lease; - UINT32 T1; - UINT32 T2; - INTN ExtraRefresh; // This refresh is reqested by user - - UDP_IO *UdpIo; // Udp child receiving all DHCP message - UDP_IO *LeaseIoPort; // Udp child with lease IP - EFI_DHCP4_PACKET *LastPacket; // The last sent packet for retransmission - EFI_MAC_ADDRESS Mac; - UINT8 HwType; - UINT8 HwLen; - UINT8 ClientAddressSendOut[16]; - - DHCP_PROTOCOL *ActiveChild; - EFI_DHCP4_CONFIG_DATA ActiveConfig; - UINT32 UserOptionLen; - - // - // Timer event and various timer - // - EFI_EVENT Timer; - - UINT32 PacketToLive; // Retransmission timer for our packets - UINT32 LastTimeout; // Record the init value of PacketToLive every time - INTN CurRetry; - INTN MaxRetries; - UINT32 LeaseLife; -}; - -typedef struct { - EFI_DHCP4_PACKET_OPTION **Option; - UINT32 OptionCount; - UINT32 Index; -} DHCP_PARSE_CONTEXT; - -#define DHCP_INSTANCE_FROM_THIS(Proto) \ - CR ((Proto), DHCP_PROTOCOL, Dhcp4Protocol, DHCP_PROTOCOL_SIGNATURE) - -#define DHCP_SERVICE_FROM_THIS(Sb) \ - CR ((Sb), DHCP_SERVICE, ServiceBinding, DHCP_SERVICE_SIGNATURE) - -extern EFI_DHCP4_PROTOCOL mDhcp4ProtocolTemplate; - -/** - Give up the control of the DHCP service to let other child - resume. Don't change the service's DHCP state and the Client - address and option list configure as required by RFC2131. - - @param DhcpSb The DHCP service instance. - -**/ -VOID -DhcpYieldControl ( - IN DHCP_SERVICE *DhcpSb - ); - -/** - Complete a Dhcp4 transaction and signal the upper layer. - - @param Instance Dhcp4 instance. - -**/ -VOID -PxeDhcpDone ( - IN DHCP_PROTOCOL *Instance - ); - -/** - Free the resource related to the configure parameters. - DHCP driver will make a copy of the user's configure - such as the time out value. - - @param Config The DHCP configure data - -**/ -VOID -DhcpCleanConfigure ( - IN OUT EFI_DHCP4_CONFIG_DATA *Config - ); - -/** - Callback of Dhcp packet. Does nothing. - - @param Arg The context. - -**/ -VOID -EFIAPI -DhcpDummyExtFree ( - IN VOID *Arg - ); - -/** - Set the elapsed time based on the given instance and the pointer to the - elapsed time option. - - @param[in] Elapsed The pointer to the position to append. - @param[in] Instance The pointer to the Dhcp4 instance. -**/ -VOID -SetElapsedTime ( - IN UINT16 *Elapsed, - IN DHCP_PROTOCOL *Instance - ); - -#endif diff --git a/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Io.c b/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Io.c deleted file mode 100644 index 4728b94c58..0000000000 --- a/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Io.c +++ /dev/null @@ -1,1657 +0,0 @@ -/** @file - EFI DHCP protocol implementation. - -Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - - -#include "Dhcp4Impl.h" - -UINT32 mDhcp4DefaultTimeout[4] = { 4, 8, 16, 32 }; - - -/** - Send an initial DISCOVER or REQUEST message according to the - DHCP service's current state. - - @param[in] DhcpSb The DHCP service instance - - @retval EFI_SUCCESS The request has been sent - @retval other Some error occurs when sending the request. - -**/ -EFI_STATUS -DhcpInitRequest ( - IN DHCP_SERVICE *DhcpSb - ) -{ - EFI_STATUS Status; - - ASSERT ((DhcpSb->DhcpState == Dhcp4Init) || (DhcpSb->DhcpState == Dhcp4InitReboot)); - - // - // Clear initial time to make sure that elapsed-time is set to 0 for first Discover or REQUEST message. - // - DhcpSb->ActiveChild->ElaspedTime= 0; - - if (DhcpSb->DhcpState == Dhcp4Init) { - DhcpSetState (DhcpSb, Dhcp4Selecting, FALSE); - Status = DhcpSendMessage (DhcpSb, NULL, NULL, DHCP_MSG_DISCOVER, NULL); - - if (EFI_ERROR (Status)) { - DhcpSb->DhcpState = Dhcp4Init; - return Status; - } - } else { - DhcpSetState (DhcpSb, Dhcp4Rebooting, FALSE); - Status = DhcpSendMessage (DhcpSb, NULL, NULL, DHCP_MSG_REQUEST, NULL); - - if (EFI_ERROR (Status)) { - DhcpSb->DhcpState = Dhcp4InitReboot; - return Status; - } - } - - return EFI_SUCCESS; -} - - -/** - Call user provided callback function, and return the value the - function returns. If the user doesn't provide a callback, a - proper return value is selected to let the caller continue the - normal process. - - @param[in] DhcpSb The DHCP service instance - @param[in] Event The event as defined in the spec - @param[in] Packet The current packet trigger the event - @param[out] NewPacket The user's return new packet - - @retval EFI_NOT_READY Direct the caller to continue collecting the offer. - @retval EFI_SUCCESS The user function returns success. - @retval EFI_ABORTED The user function ask it to abort. - -**/ -EFI_STATUS -DhcpCallUser ( - IN DHCP_SERVICE *DhcpSb, - IN EFI_DHCP4_EVENT Event, - IN EFI_DHCP4_PACKET *Packet, OPTIONAL - OUT EFI_DHCP4_PACKET **NewPacket OPTIONAL - ) -{ - EFI_DHCP4_CONFIG_DATA *Config; - EFI_STATUS Status; - - if (NewPacket != NULL) { - *NewPacket = NULL; - } - - // - // If user doesn't provide the call back function, return the value - // that directs the client to continue the normal process. - // In Dhcp4Selecting EFI_SUCCESS tells the client to stop collecting - // the offers and select a offer, EFI_NOT_READY tells the client to - // collect more offers. - // - Config = &DhcpSb->ActiveConfig; - - if (Config->Dhcp4Callback == NULL) { - if (Event == Dhcp4RcvdOffer) { - return EFI_NOT_READY; - } - - return EFI_SUCCESS; - } - - Status = Config->Dhcp4Callback ( - &DhcpSb->ActiveChild->Dhcp4Protocol, - Config->CallbackContext, - (EFI_DHCP4_STATE) DhcpSb->DhcpState, - Event, - Packet, - NewPacket - ); - - // - // User's callback should only return EFI_SUCCESS, EFI_NOT_READY, - // and EFI_ABORTED. If it returns values other than those, assume - // it to be EFI_ABORTED. - // - if ((Status == EFI_SUCCESS) || (Status == EFI_NOT_READY)) { - return Status; - } - - return EFI_ABORTED; -} - - -/** - Notify the user about the operation result. - - @param DhcpSb DHCP service instance - @param Which Which notify function to signal - -**/ -VOID -DhcpNotifyUser ( - IN DHCP_SERVICE *DhcpSb, - IN INTN Which - ) -{ - DHCP_PROTOCOL *Child; - - if ((Child = DhcpSb->ActiveChild) == NULL) { - return ; - } - - if ((Child->CompletionEvent != NULL) && - ((Which == DHCP_NOTIFY_COMPLETION) || (Which == DHCP_NOTIFY_ALL)) - ) { - - gBS->SignalEvent (Child->CompletionEvent); - Child->CompletionEvent = NULL; - } - - if ((Child->RenewRebindEvent != NULL) && - ((Which == DHCP_NOTIFY_RENEWREBIND) || (Which == DHCP_NOTIFY_ALL)) - ) { - - gBS->SignalEvent (Child->RenewRebindEvent); - Child->RenewRebindEvent = NULL; - } -} - - - -/** - Set the DHCP state. If CallUser is true, it will try to notify - the user before change the state by DhcpNotifyUser. It returns - EFI_ABORTED if the user return EFI_ABORTED, otherwise, it returns - EFI_SUCCESS. If CallUser is FALSE, it isn't necessary to test - the return value of this function. - - @param DhcpSb The DHCP service instance - @param State The new DHCP state to change to - @param CallUser Whether we need to call user - - @retval EFI_SUCCESS The state is changed - @retval EFI_ABORTED The user asks to abort the DHCP process. - -**/ -EFI_STATUS -DhcpSetState ( - IN OUT DHCP_SERVICE *DhcpSb, - IN INTN State, - IN BOOLEAN CallUser - ) -{ - EFI_STATUS Status; - - if (CallUser) { - Status = EFI_SUCCESS; - - if (State == Dhcp4Renewing) { - Status = DhcpCallUser (DhcpSb, Dhcp4EnterRenewing, NULL, NULL); - - } else if (State == Dhcp4Rebinding) { - Status = DhcpCallUser (DhcpSb, Dhcp4EnterRebinding, NULL, NULL); - - } else if (State == Dhcp4Bound) { - Status = DhcpCallUser (DhcpSb, Dhcp4BoundCompleted, NULL, NULL); - - } - - if (EFI_ERROR (Status)) { - return Status; - } - } - - // - // Update the retransmission timer during the state transition. - // This will clear the retry count. This is also why the rule - // first transit the state, then send packets. - // - if (State == Dhcp4Selecting) { - DhcpSb->MaxRetries = DhcpSb->ActiveConfig.DiscoverTryCount; - } else { - DhcpSb->MaxRetries = DhcpSb->ActiveConfig.RequestTryCount; - } - - if (DhcpSb->MaxRetries == 0) { - DhcpSb->MaxRetries = 4; - } - - DhcpSb->CurRetry = 0; - DhcpSb->PacketToLive = 0; - DhcpSb->LastTimeout = 0; - DhcpSb->DhcpState = State; - return EFI_SUCCESS; -} - - -/** - Set the retransmit timer for the packet. It will select from either - the discover timeouts/request timeouts or the default timeout values. - - @param DhcpSb The DHCP service instance. - -**/ -VOID -DhcpSetTransmitTimer ( - IN OUT DHCP_SERVICE *DhcpSb - ) -{ - UINT32 *Times; - - ASSERT (DhcpSb->MaxRetries > DhcpSb->CurRetry); - - if (DhcpSb->DhcpState == Dhcp4Selecting) { - Times = DhcpSb->ActiveConfig.DiscoverTimeout; - } else { - Times = DhcpSb->ActiveConfig.RequestTimeout; - } - - if (Times == NULL) { - Times = mDhcp4DefaultTimeout; - } - - DhcpSb->PacketToLive = Times[DhcpSb->CurRetry]; - DhcpSb->LastTimeout = DhcpSb->PacketToLive; - - return; -} - -/** - Compute the lease. If the server grants a permanent lease, just - process it as a normal timeout value since the lease will last - more than 100 years. - - @param DhcpSb The DHCP service instance - @param Para The DHCP parameter extracted from the server's - response. -**/ -VOID -DhcpComputeLease ( - IN OUT DHCP_SERVICE *DhcpSb, - IN DHCP_PARAMETER *Para - ) -{ - ASSERT (Para != NULL); - - DhcpSb->Lease = Para->Lease; - DhcpSb->T2 = Para->T2; - DhcpSb->T1 = Para->T1; - - if (DhcpSb->Lease == 0) { - DhcpSb->Lease = DHCP_DEFAULT_LEASE; - } - - if ((DhcpSb->T2 == 0) || (DhcpSb->T2 >= Para->Lease)) { - DhcpSb->T2 = Para->Lease - (Para->Lease >> 3); - } - - if ((DhcpSb->T1 == 0) || (DhcpSb->T1 >= Para->T2)) { - DhcpSb->T1 = DhcpSb->Lease >> 1; - } -} - - -/** - Configure a UDP IO port to use the acquired lease address. - DHCP driver needs this port to unicast packet to the server - such as DHCP release. - - @param[in] UdpIo The UDP IO to configure - @param[in] Context Dhcp service instance. - - @retval EFI_SUCCESS The UDP IO port is successfully configured. - @retval Others It failed to configure the port. - -**/ -EFI_STATUS -EFIAPI -DhcpConfigLeaseIoPort ( - IN UDP_IO *UdpIo, - IN VOID *Context - ) -{ - EFI_UDP4_CONFIG_DATA UdpConfigData; - EFI_IPv4_ADDRESS Subnet; - EFI_IPv4_ADDRESS Gateway; - DHCP_SERVICE *DhcpSb; - EFI_STATUS Status; - IP4_ADDR Ip; - - DhcpSb = (DHCP_SERVICE *) Context; - - UdpConfigData.AcceptBroadcast = FALSE; - UdpConfigData.AcceptPromiscuous = FALSE; - UdpConfigData.AcceptAnyPort = FALSE; - UdpConfigData.AllowDuplicatePort = TRUE; - UdpConfigData.TypeOfService = 0; - UdpConfigData.TimeToLive = 64; - UdpConfigData.DoNotFragment = FALSE; - UdpConfigData.ReceiveTimeout = 1; - UdpConfigData.TransmitTimeout = 0; - - UdpConfigData.UseDefaultAddress = FALSE; - UdpConfigData.StationPort = DHCP_CLIENT_PORT; - UdpConfigData.RemotePort = DHCP_SERVER_PORT; - - Ip = HTONL (DhcpSb->ClientAddr); - CopyMem (&UdpConfigData.StationAddress, &Ip, sizeof (EFI_IPv4_ADDRESS)); - - Ip = HTONL (DhcpSb->Netmask); - CopyMem (&UdpConfigData.SubnetMask, &Ip, sizeof (EFI_IPv4_ADDRESS)); - - ZeroMem (&UdpConfigData.RemoteAddress, sizeof (EFI_IPv4_ADDRESS)); - - Status = UdpIo->Protocol.Udp4->Configure (UdpIo->Protocol.Udp4, &UdpConfigData); - - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Add a default route if received from the server. - // - if ((DhcpSb->Para != NULL) && (DhcpSb->Para->Router != 0)) { - ZeroMem (&Subnet, sizeof (EFI_IPv4_ADDRESS)); - - Ip = HTONL (DhcpSb->Para->Router); - CopyMem (&Gateway, &Ip, sizeof (EFI_IPv4_ADDRESS)); - - UdpIo->Protocol.Udp4->Routes (UdpIo->Protocol.Udp4, FALSE, &Subnet, &Subnet, &Gateway); - } - - return EFI_SUCCESS; -} - - -/** - Update the lease states when a new lease is acquired. It will not only - save the acquired the address and lease time, it will also create a UDP - child to provide address resolution for the address. - - @param DhcpSb The DHCP service instance - - @retval EFI_OUT_OF_RESOURCES Failed to allocate resources. - @retval EFI_SUCCESS The lease is recorded. - -**/ -EFI_STATUS -DhcpLeaseAcquired ( - IN OUT DHCP_SERVICE *DhcpSb - ) -{ - DhcpSb->ClientAddr = EFI_NTOHL (DhcpSb->Selected->Dhcp4.Header.YourAddr); - - if (DhcpSb->Para != NULL) { - DhcpSb->Netmask = DhcpSb->Para->NetMask; - DhcpSb->ServerAddr = DhcpSb->Para->ServerId; - } - - if (DhcpSb->Netmask == 0) { - return EFI_ABORTED; - } - - if (DhcpSb->LeaseIoPort != NULL) { - UdpIoFreeIo (DhcpSb->LeaseIoPort); - } - - // - // Create a UDP/IP child to provide ARP service for the Leased IP, - // and transmit unicast packet with it as source address. Don't - // start receive on this port, the queued packet will be timeout. - // - DhcpSb->LeaseIoPort = UdpIoCreateIo ( - DhcpSb->Controller, - DhcpSb->Image, - DhcpConfigLeaseIoPort, - UDP_IO_UDP4_VERSION, - DhcpSb - ); - - if (DhcpSb->LeaseIoPort == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - if (!DHCP_IS_BOOTP (DhcpSb->Para)) { - DhcpComputeLease (DhcpSb, DhcpSb->Para); - } - - return DhcpSetState (DhcpSb, Dhcp4Bound, TRUE); -} - - -/** - Clean up the DHCP related states, IoStatus isn't reset. - - @param DhcpSb The DHCP instance service. - -**/ -VOID -DhcpCleanLease ( - IN DHCP_SERVICE *DhcpSb - ) -{ - DhcpSb->DhcpState = Dhcp4Init; - DhcpSb->Xid = DhcpSb->Xid + 1; - DhcpSb->ClientAddr = 0; - DhcpSb->Netmask = 0; - DhcpSb->ServerAddr = 0; - - if (DhcpSb->LastOffer != NULL) { - FreePool (DhcpSb->LastOffer); - DhcpSb->LastOffer = NULL; - } - - if (DhcpSb->Selected != NULL) { - FreePool (DhcpSb->Selected); - DhcpSb->Selected = NULL; - } - - if (DhcpSb->Para != NULL) { - FreePool (DhcpSb->Para); - DhcpSb->Para = NULL; - } - - DhcpSb->Lease = 0; - DhcpSb->T1 = 0; - DhcpSb->T2 = 0; - DhcpSb->ExtraRefresh = FALSE; - - if (DhcpSb->LeaseIoPort != NULL) { - UdpIoFreeIo (DhcpSb->LeaseIoPort); - DhcpSb->LeaseIoPort = NULL; - } - - if (DhcpSb->LastPacket != NULL) { - FreePool (DhcpSb->LastPacket); - DhcpSb->LastPacket = NULL; - } - - DhcpSb->PacketToLive = 0; - DhcpSb->LastTimeout = 0; - DhcpSb->CurRetry = 0; - DhcpSb->MaxRetries = 0; - DhcpSb->LeaseLife = 0; - - // - // Clean active config data. - // - DhcpCleanConfigure (&DhcpSb->ActiveConfig); -} - - -/** - Select a offer among all the offers collected. If the offer selected is - of BOOTP, the lease is recorded and user notified. If the offer is of - DHCP, it will request the offer from the server. - - @param[in] DhcpSb The DHCP service instance. - - @retval EFI_SUCCESS One of the offer is selected. - -**/ -EFI_STATUS -DhcpChooseOffer ( - IN DHCP_SERVICE *DhcpSb - ) -{ - EFI_DHCP4_PACKET *Selected; - EFI_DHCP4_PACKET *NewPacket; - EFI_DHCP4_PACKET *TempPacket; - EFI_STATUS Status; - - ASSERT (DhcpSb->LastOffer != NULL); - - // - // User will cache previous offers if he wants to select - // from multiple offers. If user provides an invalid packet, - // use the last offer, otherwise use the provided packet. - // - NewPacket = NULL; - Status = DhcpCallUser (DhcpSb, Dhcp4SelectOffer, DhcpSb->LastOffer, &NewPacket); - - if (EFI_ERROR (Status)) { - return Status; - } - - Selected = DhcpSb->LastOffer; - - if ((NewPacket != NULL) && !EFI_ERROR (DhcpValidateOptions (NewPacket, NULL))) { - TempPacket = (EFI_DHCP4_PACKET *) AllocatePool (NewPacket->Size); - if (TempPacket != NULL) { - CopyMem (TempPacket, NewPacket, NewPacket->Size); - FreePool (Selected); - Selected = TempPacket; - } - } - - DhcpSb->Selected = Selected; - DhcpSb->LastOffer = NULL; - DhcpSb->Para = NULL; - DhcpValidateOptions (Selected, &DhcpSb->Para); - - // - // A bootp offer has been selected, save the lease status, - // enter bound state then notify the user. - // - if (DHCP_IS_BOOTP (DhcpSb->Para)) { - Status = DhcpLeaseAcquired (DhcpSb); - - if (EFI_ERROR (Status)) { - return Status; - } - - DhcpSb->IoStatus = EFI_SUCCESS; - DhcpNotifyUser (DhcpSb, DHCP_NOTIFY_ALL); - return EFI_SUCCESS; - } - - // - // Send a DHCP requests - // - Status = DhcpSetState (DhcpSb, Dhcp4Requesting, TRUE); - - if (EFI_ERROR (Status)) { - return Status; - } - - return DhcpSendMessage (DhcpSb, Selected, DhcpSb->Para, DHCP_MSG_REQUEST, NULL); -} - - -/** - Terminate the current address acquire. All the allocated resources - are released. Be careful when calling this function. A rule related - to this is: only call DhcpEndSession at the highest level, such as - DhcpInput, DhcpOnTimerTick...At the other level, just return error. - - @param[in] DhcpSb The DHCP service instance - @param[in] Status The result of the DHCP process. - -**/ -VOID -DhcpEndSession ( - IN DHCP_SERVICE *DhcpSb, - IN EFI_STATUS Status - ) -{ - if (DHCP_CONNECTED (DhcpSb->DhcpState)) { - DhcpCallUser (DhcpSb, Dhcp4AddressLost, NULL, NULL); - } else { - DhcpCallUser (DhcpSb, Dhcp4Fail, NULL, NULL); - } - - DhcpCleanLease (DhcpSb); - - DhcpSb->IoStatus = Status; - DhcpNotifyUser (DhcpSb, DHCP_NOTIFY_ALL); -} - - -/** - Handle packets in DHCP select state. - - @param[in] DhcpSb The DHCP service instance - @param[in] Packet The DHCP packet received - @param[in] Para The DHCP parameter extracted from the packet. That - is, all the option value that we care. - - @retval EFI_SUCCESS The packet is successfully processed. - @retval Others Some error occured. - -**/ -EFI_STATUS -DhcpHandleSelect ( - IN DHCP_SERVICE *DhcpSb, - IN EFI_DHCP4_PACKET *Packet, - IN DHCP_PARAMETER *Para - ) -{ - EFI_STATUS Status; - - Status = EFI_SUCCESS; - - // - // First validate the message: - // 1. the offer is a unicast - // 2. if it is a DHCP message, it must contains a server ID. - // Don't return a error for these two case otherwise the session is ended. - // - if (!DHCP_IS_BOOTP (Para) && - ((Para->DhcpType != DHCP_MSG_OFFER) || (Para->ServerId == 0)) - ) { - goto ON_EXIT; - } - - // - // Call the user's callback. The action according to the return is as: - // 1. EFI_SUCESS: stop waiting for more offers, select the offer now - // 2. EFI_NOT_READY: wait for more offers - // 3. EFI_ABORTED: abort the address acquiring. - // - Status = DhcpCallUser (DhcpSb, Dhcp4RcvdOffer, Packet, NULL); - - if (Status == EFI_SUCCESS) { - if (DhcpSb->LastOffer != NULL) { - FreePool (DhcpSb->LastOffer); - } - - DhcpSb->LastOffer = Packet; - - return DhcpChooseOffer (DhcpSb); - - } else if (Status == EFI_NOT_READY) { - if (DhcpSb->LastOffer != NULL) { - FreePool (DhcpSb->LastOffer); - } - - DhcpSb->LastOffer = Packet; - - } else if (Status == EFI_ABORTED) { - // - // DhcpInput will end the session upon error return. Remember - // only to call DhcpEndSession at the top level call. - // - goto ON_EXIT; - } - - return EFI_SUCCESS; - -ON_EXIT: - FreePool (Packet); - return Status; -} - - -/** - Handle packets in DHCP request state. - - @param[in] DhcpSb The DHCP service instance - @param[in] Packet The DHCP packet received - @param[in] Para The DHCP parameter extracted from the packet. That - is, all the option value that we care. - - @retval EFI_SUCCESS The packet is successfully processed. - @retval Others Some error occured. - -**/ -EFI_STATUS -DhcpHandleRequest ( - IN DHCP_SERVICE *DhcpSb, - IN EFI_DHCP4_PACKET *Packet, - IN DHCP_PARAMETER *Para - ) -{ - EFI_DHCP4_HEADER *Head; - EFI_DHCP4_HEADER *Selected; - EFI_STATUS Status; - UINT8 *Message; - - ASSERT (!DHCP_IS_BOOTP (DhcpSb->Para)); - - Head = &Packet->Dhcp4.Header; - Selected = &DhcpSb->Selected->Dhcp4.Header; - - // - // Ignore the BOOTP message and DHCP messages other than DHCP ACK/NACK. - // - if (DHCP_IS_BOOTP (Para) || - (Para->ServerId != DhcpSb->Para->ServerId) || - ((Para->DhcpType != DHCP_MSG_ACK) && (Para->DhcpType != DHCP_MSG_NAK)) - ) { - - Status = EFI_SUCCESS; - goto ON_EXIT; - } - - // - // Received a NAK, end the session no matter what the user returns - // - Status = EFI_DEVICE_ERROR; - - if (Para->DhcpType == DHCP_MSG_NAK) { - DhcpCallUser (DhcpSb, Dhcp4RcvdNak, Packet, NULL); - goto ON_EXIT; - } - - // - // Check whether the ACK matches the selected offer - // - Message = NULL; - - if (!EFI_IP4_EQUAL (&Head->YourAddr, &Selected->YourAddr)) { - Message = (UINT8 *) "Lease confirmed isn't the same as that in the offer"; - goto REJECT; - } - - Status = DhcpCallUser (DhcpSb, Dhcp4RcvdAck, Packet, NULL); - - if (EFI_ERROR (Status)) { - Message = (UINT8 *) "Lease is denied upon received ACK"; - goto REJECT; - } - - // - // Record the lease, transit to BOUND state, then notify the user - // - Status = DhcpLeaseAcquired (DhcpSb); - - if (EFI_ERROR (Status)) { - Message = (UINT8 *) "Lease is denied upon entering bound"; - goto REJECT; - } - - DhcpSb->IoStatus = EFI_SUCCESS; - DhcpNotifyUser (DhcpSb, DHCP_NOTIFY_COMPLETION); - - FreePool (Packet); - return EFI_SUCCESS; - -REJECT: - DhcpSendMessage (DhcpSb, DhcpSb->Selected, DhcpSb->Para, DHCP_MSG_DECLINE, Message); - -ON_EXIT: - FreePool (Packet); - return Status; -} - - -/** - Handle packets in DHCP renew/rebound state. - - @param[in] DhcpSb The DHCP service instance - @param[in] Packet The DHCP packet received - @param[in] Para The DHCP parameter extracted from the packet. That - is, all the option value that we care. - - @retval EFI_SUCCESS The packet is successfully processed. - @retval Others Some error occured. - -**/ -EFI_STATUS -DhcpHandleRenewRebind ( - IN DHCP_SERVICE *DhcpSb, - IN EFI_DHCP4_PACKET *Packet, - IN DHCP_PARAMETER *Para - ) -{ - EFI_DHCP4_HEADER *Head; - EFI_DHCP4_HEADER *Selected; - EFI_STATUS Status; - - ASSERT (!DHCP_IS_BOOTP (DhcpSb->Para)); - - Head = &Packet->Dhcp4.Header; - Selected = &DhcpSb->Selected->Dhcp4.Header; - - // - // Ignore the BOOTP message and DHCP messages other than DHCP ACK/NACK - // - if (DHCP_IS_BOOTP (Para) || - (Para->ServerId != DhcpSb->Para->ServerId) || - ((Para->DhcpType != DHCP_MSG_ACK) && (Para->DhcpType != DHCP_MSG_NAK)) - ) { - - Status = EFI_SUCCESS; - goto ON_EXIT; - } - - // - // Received a NAK, ignore the user's return then terminate the process - // - Status = EFI_DEVICE_ERROR; - - if (Para->DhcpType == DHCP_MSG_NAK) { - DhcpCallUser (DhcpSb, Dhcp4RcvdNak, Packet, NULL); - goto ON_EXIT; - } - - // - // The lease is different from the selected. Don't send a DECLINE - // since it isn't existed in the client's FSM. - // - if (!EFI_IP4_EQUAL (&Head->YourAddr, &Selected->YourAddr)) { - goto ON_EXIT; - } - - Status = DhcpCallUser (DhcpSb, Dhcp4RcvdAck, Packet, NULL); - - if (EFI_ERROR (Status)) { - goto ON_EXIT; - } - - // - // Record the lease, start timer for T1 and T2, - // - DhcpComputeLease (DhcpSb, Para); - DhcpSb->LeaseLife = 0; - DhcpSetState (DhcpSb, Dhcp4Bound, TRUE); - - if (DhcpSb->ExtraRefresh != 0) { - DhcpSb->ExtraRefresh = FALSE; - - DhcpSb->IoStatus = EFI_SUCCESS; - DhcpNotifyUser (DhcpSb, DHCP_NOTIFY_RENEWREBIND); - } - -ON_EXIT: - FreePool (Packet); - return Status; -} - - -/** - Handle packets in DHCP reboot state. - - @param[in] DhcpSb The DHCP service instance - @param[in] Packet The DHCP packet received - @param[in] Para The DHCP parameter extracted from the packet. That - is, all the option value that we care. - - @retval EFI_SUCCESS The packet is successfully processed. - @retval Others Some error occured. - -**/ -EFI_STATUS -DhcpHandleReboot ( - IN DHCP_SERVICE *DhcpSb, - IN EFI_DHCP4_PACKET *Packet, - IN DHCP_PARAMETER *Para - ) -{ - EFI_DHCP4_HEADER *Head; - EFI_STATUS Status; - - Head = &Packet->Dhcp4.Header; - - // - // Ignore the BOOTP message and DHCP messages other than DHCP ACK/NACK - // - if (DHCP_IS_BOOTP (Para) || - ((Para->DhcpType != DHCP_MSG_ACK) && (Para->DhcpType != DHCP_MSG_NAK)) - ) { - - Status = EFI_SUCCESS; - goto ON_EXIT; - } - - // - // If a NAK is received, transit to INIT and try again. - // - if (Para->DhcpType == DHCP_MSG_NAK) { - DhcpCallUser (DhcpSb, Dhcp4RcvdNak, Packet, NULL); - - DhcpSb->ClientAddr = 0; - DhcpSb->DhcpState = Dhcp4Init; - - Status = DhcpInitRequest (DhcpSb); - goto ON_EXIT; - } - - // - // Check whether the ACK matches the selected offer - // - if (EFI_NTOHL (Head->YourAddr) != DhcpSb->ClientAddr) { - Status = EFI_DEVICE_ERROR; - goto ON_EXIT; - } - - Status = DhcpCallUser (DhcpSb, Dhcp4RcvdAck, Packet, NULL); - if (EFI_ERROR (Status)) { - goto ON_EXIT; - } - - // - // OK, get the parameter from server, record the lease - // - DhcpSb->Para = AllocateCopyPool (sizeof (DHCP_PARAMETER), Para); - if (DhcpSb->Para == NULL) { - Status = EFI_OUT_OF_RESOURCES; - goto ON_EXIT; - } - - DhcpSb->Selected = Packet; - Status = DhcpLeaseAcquired (DhcpSb); - if (EFI_ERROR (Status)) { - return Status; - } - - DhcpSb->IoStatus = EFI_SUCCESS; - DhcpNotifyUser (DhcpSb, DHCP_NOTIFY_COMPLETION); - return EFI_SUCCESS; - -ON_EXIT: - FreePool (Packet); - return Status; -} - - -/** - Handle the received DHCP packets. This function drives the DHCP - state machine. - - @param UdpPacket The UDP packets received. - @param EndPoint The local/remote UDP access point - @param IoStatus The status of the UDP receive - @param Context The opaque parameter to the function. - -**/ -VOID -EFIAPI -DhcpInput ( - NET_BUF *UdpPacket, - UDP_END_POINT *EndPoint, - EFI_STATUS IoStatus, - VOID *Context - ) -{ - DHCP_SERVICE *DhcpSb; - EFI_DHCP4_HEADER *Head; - EFI_DHCP4_PACKET *Packet; - DHCP_PARAMETER *Para; - EFI_STATUS Status; - UINT32 Len; - - Packet = NULL; - DhcpSb = (DHCP_SERVICE *) Context; - - // - // Don't restart receive if error occurs or DHCP is destroyed. - // - if (EFI_ERROR (IoStatus)) { - return ; - } else if (DhcpSb->ServiceState == DHCP_DESTROY) { - NetbufFree (UdpPacket); - return ; - } - - ASSERT (UdpPacket != NULL); - - if (DhcpSb->DhcpState == Dhcp4Stopped) { - goto RESTART; - } - - // - // Validate the packet received - // - if (UdpPacket->TotalSize < sizeof (EFI_DHCP4_HEADER)) { - goto RESTART; - } - - // - // Copy the DHCP message to a continuous memory block - // - Len = sizeof (EFI_DHCP4_PACKET) + UdpPacket->TotalSize - sizeof (EFI_DHCP4_HEADER); - Packet = (EFI_DHCP4_PACKET *) AllocatePool (Len); - - if (Packet == NULL) { - goto RESTART; - } - - Packet->Size = Len; - Head = &Packet->Dhcp4.Header; - Packet->Length = NetbufCopy (UdpPacket, 0, UdpPacket->TotalSize, (UINT8 *) Head); - - if (Packet->Length != UdpPacket->TotalSize) { - goto RESTART; - } - - // - // Is this packet the answer to our packet? - // - if ((Head->OpCode != BOOTP_REPLY) || - (NTOHL (Head->Xid) != DhcpSb->Xid) || - (CompareMem (DhcpSb->ClientAddressSendOut, Head->ClientHwAddr, Head->HwAddrLen) != 0)) { - goto RESTART; - } - - // - // Validate the options and retrieve the interested options - // - Para = NULL; - if ((Packet->Length > sizeof (EFI_DHCP4_HEADER) + sizeof (UINT32)) && - (Packet->Dhcp4.Magik == DHCP_OPTION_MAGIC) && - EFI_ERROR (DhcpValidateOptions (Packet, &Para))) { - - goto RESTART; - } - - // - // Call the handler for each state. The handler should return - // EFI_SUCCESS if the process can go on no matter whether the - // packet is ignored or not. If the return is EFI_ERROR, the - // session will be terminated. Packet's ownership is handled - // over to the handlers. If operation succeeds, the handler - // must notify the user. It isn't necessary to do if EFI_ERROR - // is returned because the DhcpEndSession will notify the user. - // - Status = EFI_SUCCESS; - - switch (DhcpSb->DhcpState) { - case Dhcp4Selecting: - Status = DhcpHandleSelect (DhcpSb, Packet, Para); - break; - - case Dhcp4Requesting: - Status = DhcpHandleRequest (DhcpSb, Packet, Para); - break; - - case Dhcp4InitReboot: - case Dhcp4Init: - case Dhcp4Bound: - // - // Ignore the packet in INITREBOOT, INIT and BOUND states - // - FreePool (Packet); - Status = EFI_SUCCESS; - break; - - case Dhcp4Renewing: - case Dhcp4Rebinding: - Status = DhcpHandleRenewRebind (DhcpSb, Packet, Para); - break; - - case Dhcp4Rebooting: - Status = DhcpHandleReboot (DhcpSb, Packet, Para); - break; - } - - if (Para != NULL) { - FreePool (Para); - } - - Packet = NULL; - - if (EFI_ERROR (Status)) { - NetbufFree (UdpPacket); - UdpIoRecvDatagram (DhcpSb->UdpIo, DhcpInput, DhcpSb, 0); - DhcpEndSession (DhcpSb, Status); - return ; - } - -RESTART: - NetbufFree (UdpPacket); - - if (Packet != NULL) { - FreePool (Packet); - } - - Status = UdpIoRecvDatagram (DhcpSb->UdpIo, DhcpInput, DhcpSb, 0); - - if (EFI_ERROR (Status)) { - DhcpEndSession (DhcpSb, EFI_DEVICE_ERROR); - } -} - -/** - Release the net buffer when packet is sent. - - @param UdpPacket The UDP packets received. - @param EndPoint The local/remote UDP access point - @param IoStatus The status of the UDP receive - @param Context The opaque parameter to the function. - -**/ -VOID -EFIAPI -DhcpOnPacketSent ( - NET_BUF *Packet, - UDP_END_POINT *EndPoint, - EFI_STATUS IoStatus, - VOID *Context - ) -{ - NetbufFree (Packet); -} - - - -/** - Build and transmit a DHCP message according to the current states. - This function implement the Table 5. of RFC 2131. Always transits - the state (as defined in Figure 5. of the same RFC) before sending - a DHCP message. The table is adjusted accordingly. - - @param[in] DhcpSb The DHCP service instance - @param[in] Seed The seed packet which the new packet is based on - @param[in] Para The DHCP parameter of the Seed packet - @param[in] Type The message type to send - @param[in] Msg The human readable message to include in the packet - sent. - - @retval EFI_OUT_OF_RESOURCES Failed to allocate resources for the packet - @retval EFI_ACCESS_DENIED Failed to transmit the packet through UDP - @retval EFI_SUCCESS The message is sent - @retval other Other error occurs - -**/ -EFI_STATUS -DhcpSendMessage ( - IN DHCP_SERVICE *DhcpSb, - IN EFI_DHCP4_PACKET *Seed, - IN DHCP_PARAMETER *Para, - IN UINT8 Type, - IN UINT8 *Msg - ) -{ - EFI_DHCP4_CONFIG_DATA *Config; - EFI_DHCP4_PACKET *Packet; - EFI_DHCP4_PACKET *NewPacket; - EFI_DHCP4_HEADER *Head; - EFI_DHCP4_HEADER *SeedHead; - UDP_IO *UdpIo; - UDP_END_POINT EndPoint; - NET_BUF *Wrap; - NET_FRAGMENT Frag; - EFI_STATUS Status; - IP4_ADDR IpAddr; - UINT8 *Buf; - UINT16 MaxMsg; - UINT32 Len; - UINT32 Index; - - // - // Allocate a big enough memory block to hold the DHCP packet - // - Len = sizeof (EFI_DHCP4_PACKET) + 128 + DhcpSb->UserOptionLen; - - if (Msg != NULL) { - Len += (UINT32)AsciiStrLen ((CHAR8 *) Msg); - } - - Packet = AllocatePool (Len); - - if (Packet == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - Packet->Size = Len; - Packet->Length = sizeof (EFI_DHCP4_HEADER) + sizeof (UINT32); - - // - // Fill in the DHCP header fields - // - Config = &DhcpSb->ActiveConfig; - SeedHead = NULL; - - if (Seed != NULL) { - SeedHead = &Seed->Dhcp4.Header; - } - - Head = &Packet->Dhcp4.Header; - ZeroMem (Head, sizeof (EFI_DHCP4_HEADER)); - - Head->OpCode = BOOTP_REQUEST; - Head->HwType = DhcpSb->HwType; - Head->HwAddrLen = DhcpSb->HwLen; - Head->Xid = HTONL (DhcpSb->Xid); - Head->Reserved = HTONS (0x8000); //Server, broadcast the message please. - - EFI_IP4 (Head->ClientAddr) = HTONL (DhcpSb->ClientAddr); - CopyMem (Head->ClientHwAddr, DhcpSb->Mac.Addr, DhcpSb->HwLen); - - if ((Type == DHCP_MSG_DECLINE) || (Type == DHCP_MSG_RELEASE)) { - Head->Seconds = 0; - } else if ((Type == DHCP_MSG_REQUEST) && (DhcpSb->DhcpState == Dhcp4Requesting)) { - // - // Use the same value as the original DHCPDISCOVER message. - // - Head->Seconds = DhcpSb->LastPacket->Dhcp4.Header.Seconds; - } else { - SetElapsedTime(&Head->Seconds, DhcpSb->ActiveChild); - } - - // - // Append the DHCP message type - // - Packet->Dhcp4.Magik = DHCP_OPTION_MAGIC; - Buf = Packet->Dhcp4.Option; - Buf = DhcpAppendOption (Buf, DHCP4_TAG_MSG_TYPE, 1, &Type); - - // - // Append the serverid option if necessary: - // 1. DHCP decline message - // 2. DHCP release message - // 3. DHCP request to confirm one lease. - // - if ((Type == DHCP_MSG_DECLINE) || (Type == DHCP_MSG_RELEASE) || - ((Type == DHCP_MSG_REQUEST) && (DhcpSb->DhcpState == Dhcp4Requesting)) - ) { - - ASSERT ((Para != NULL) && (Para->ServerId != 0)); - - IpAddr = HTONL (Para->ServerId); - Buf = DhcpAppendOption (Buf, DHCP4_TAG_SERVER_ID, 4, (UINT8 *) &IpAddr); - } - - // - // Append the requested IP option if necessary: - // 1. DHCP request to use the previously allocated address - // 2. DHCP request to confirm one lease - // 3. DHCP decline to decline one lease - // - IpAddr = 0; - - if (Type == DHCP_MSG_REQUEST) { - if (DhcpSb->DhcpState == Dhcp4Rebooting) { - IpAddr = EFI_IP4 (Config->ClientAddress); - - } else if (DhcpSb->DhcpState == Dhcp4Requesting) { - ASSERT (SeedHead != NULL); - IpAddr = EFI_IP4 (SeedHead->YourAddr); - } - - } else if (Type == DHCP_MSG_DECLINE) { - ASSERT (SeedHead != NULL); - IpAddr = EFI_IP4 (SeedHead->YourAddr); - } - - if (IpAddr != 0) { - Buf = DhcpAppendOption (Buf, DHCP4_TAG_REQUEST_IP, 4, (UINT8 *) &IpAddr); - } - - // - // Append the Max Message Length option if it isn't a DECLINE - // or RELEASE to direct the server use large messages instead of - // override the BOOTFILE and SERVER fields in the message head. - // - if ((Type != DHCP_MSG_DECLINE) && (Type != DHCP_MSG_RELEASE)) { - MaxMsg = HTONS (0xFF00); - Buf = DhcpAppendOption (Buf, DHCP4_TAG_MAXMSG, 2, (UINT8 *) &MaxMsg); - } - - // - // Append the user's message if it isn't NULL - // - if (Msg != NULL) { - Len = MIN ((UINT32) AsciiStrLen ((CHAR8 *) Msg), 255); - Buf = DhcpAppendOption (Buf, DHCP4_TAG_MESSAGE, (UINT16) Len, Msg); - } - - // - // Append the user configured options - // - if (DhcpSb->UserOptionLen != 0) { - for (Index = 0; Index < Config->OptionCount; Index++) { - // - // We can't use any option other than the client ID from user - // if it is a DHCP decline or DHCP release . - // - if (((Type == DHCP_MSG_DECLINE) || (Type == DHCP_MSG_RELEASE)) && - (Config->OptionList[Index]->OpCode != DHCP4_TAG_CLIENT_ID)) { - continue; - } - - Buf = DhcpAppendOption ( - Buf, - Config->OptionList[Index]->OpCode, - Config->OptionList[Index]->Length, - Config->OptionList[Index]->Data - ); - } - } - - *(Buf++) = DHCP4_TAG_EOP; - Packet->Length += (UINT32) (Buf - Packet->Dhcp4.Option); - - // - // OK, the message is built, call the user to override it. - // - Status = EFI_SUCCESS; - NewPacket = NULL; - - if (Type == DHCP_MSG_DISCOVER) { - Status = DhcpCallUser (DhcpSb, Dhcp4SendDiscover, Packet, &NewPacket); - - } else if (Type == DHCP_MSG_REQUEST) { - Status = DhcpCallUser (DhcpSb, Dhcp4SendRequest, Packet, &NewPacket); - - } else if (Type == DHCP_MSG_DECLINE) { - Status = DhcpCallUser (DhcpSb, Dhcp4SendDecline, Packet, &NewPacket); - } - - if (EFI_ERROR (Status)) { - FreePool (Packet); - return Status; - } - - if (NewPacket != NULL) { - FreePool (Packet); - Packet = NewPacket; - } - - // - // Save the Client Address will be sent out - // - CopyMem ( - &DhcpSb->ClientAddressSendOut[0], - &Packet->Dhcp4.Header.ClientHwAddr[0], - Packet->Dhcp4.Header.HwAddrLen - ); - - // - // Wrap it into a netbuf then send it. - // - Frag.Bulk = (UINT8 *) &Packet->Dhcp4.Header; - Frag.Len = Packet->Length; - Wrap = NetbufFromExt (&Frag, 1, 0, 0, DhcpDummyExtFree, NULL); - - if (Wrap == NULL) { - FreePool (Packet); - return EFI_OUT_OF_RESOURCES; - } - - // - // Save it as the last sent packet for retransmission - // - if (DhcpSb->LastPacket != NULL) { - FreePool (DhcpSb->LastPacket); - } - - DhcpSb->LastPacket = Packet; - DhcpSetTransmitTimer (DhcpSb); - - // - // Broadcast the message, unless we know the server address. - // Use the lease UdpIo port to send the unicast packet. - // - EndPoint.RemoteAddr.Addr[0] = 0xffffffff; - EndPoint.LocalAddr.Addr[0] = 0; - EndPoint.RemotePort = DHCP_SERVER_PORT; - EndPoint.LocalPort = DHCP_CLIENT_PORT; - UdpIo = DhcpSb->UdpIo; - - if ((DhcpSb->DhcpState == Dhcp4Renewing) || (Type == DHCP_MSG_RELEASE)) { - EndPoint.RemoteAddr.Addr[0] = DhcpSb->ServerAddr; - EndPoint.LocalAddr.Addr[0] = DhcpSb->ClientAddr; - UdpIo = DhcpSb->LeaseIoPort; - } - - ASSERT (UdpIo != NULL); - - Status = UdpIoSendDatagram ( - UdpIo, - Wrap, - &EndPoint, - NULL, - DhcpOnPacketSent, - DhcpSb - ); - - if (EFI_ERROR (Status)) { - NetbufFree (Wrap); - return EFI_ACCESS_DENIED; - } - - return EFI_SUCCESS; -} - - -/** - Retransmit a saved packet. Only DISCOVER and REQUEST messages - will be retransmitted. - - @param[in] DhcpSb The DHCP service instance - - @retval EFI_ACCESS_DENIED Failed to transmit packet through UDP port - @retval EFI_SUCCESS The packet is retransmitted. - -**/ -EFI_STATUS -DhcpRetransmit ( - IN DHCP_SERVICE *DhcpSb - ) -{ - UDP_IO *UdpIo; - UDP_END_POINT EndPoint; - NET_BUF *Wrap; - NET_FRAGMENT Frag; - EFI_STATUS Status; - - ASSERT (DhcpSb->LastPacket != NULL); - - // - // For REQUEST message in Dhcp4Requesting state, do not change the secs fields. - // - if (DhcpSb->DhcpState != Dhcp4Requesting) { - SetElapsedTime(&DhcpSb->LastPacket->Dhcp4.Header.Seconds, DhcpSb->ActiveChild); - } - - // - // Wrap it into a netbuf then send it. - // - Frag.Bulk = (UINT8 *) &DhcpSb->LastPacket->Dhcp4.Header; - Frag.Len = DhcpSb->LastPacket->Length; - Wrap = NetbufFromExt (&Frag, 1, 0, 0, DhcpDummyExtFree, NULL); - - if (Wrap == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - // - // Broadcast the message, unless we know the server address. - // - EndPoint.RemotePort = DHCP_SERVER_PORT; - EndPoint.LocalPort = DHCP_CLIENT_PORT; - EndPoint.RemoteAddr.Addr[0] = 0xffffffff; - EndPoint.LocalAddr.Addr[0] = 0; - UdpIo = DhcpSb->UdpIo; - - if (DhcpSb->DhcpState == Dhcp4Renewing) { - EndPoint.RemoteAddr.Addr[0] = DhcpSb->ServerAddr; - EndPoint.LocalAddr.Addr[0] = DhcpSb->ClientAddr; - UdpIo = DhcpSb->LeaseIoPort; - } - - ASSERT (UdpIo != NULL); - - Status = UdpIoSendDatagram ( - UdpIo, - Wrap, - &EndPoint, - NULL, - DhcpOnPacketSent, - DhcpSb - ); - - if (EFI_ERROR (Status)) { - NetbufFree (Wrap); - return EFI_ACCESS_DENIED; - } - - return EFI_SUCCESS; -} - - -/** - Each DHCP service has three timer. Two of them are count down timer. - One for the packet retransmission. The other is to collect the offers. - The third timer increaments the lease life which is compared to T1, T2, - and lease to determine the time to renew and rebind the lease. - DhcpOnTimerTick will be called once every second. - - @param[in] Event The timer event - @param[in] Context The context, which is the DHCP service instance. - -**/ -VOID -EFIAPI -DhcpOnTimerTick ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - LIST_ENTRY *Entry; - LIST_ENTRY *Next; - DHCP_SERVICE *DhcpSb; - DHCP_PROTOCOL *Instance; - EFI_STATUS Status; - - DhcpSb = (DHCP_SERVICE *) Context; - Instance = DhcpSb->ActiveChild; - - // - // 0xffff is the maximum supported value for elapsed time according to RFC. - // - if (Instance != NULL && Instance->ElaspedTime < 0xffff) { - Instance->ElaspedTime++; - } - - // - // Check the retransmit timer - // - if ((DhcpSb->PacketToLive > 0) && (--DhcpSb->PacketToLive == 0)) { - - // - // Select offer at each timeout if any offer received. - // - if (DhcpSb->DhcpState == Dhcp4Selecting && DhcpSb->LastOffer != NULL) { - - Status = DhcpChooseOffer (DhcpSb); - - if (EFI_ERROR(Status)) { - if (DhcpSb->LastOffer != NULL) { - FreePool (DhcpSb->LastOffer); - DhcpSb->LastOffer = NULL; - } - } else { - goto ON_EXIT; - } - } - - if (++DhcpSb->CurRetry < DhcpSb->MaxRetries) { - // - // Still has another try - // - DhcpRetransmit (DhcpSb); - DhcpSetTransmitTimer (DhcpSb); - - } else if (DHCP_CONNECTED (DhcpSb->DhcpState)) { - - // - // Retransmission failed, if the DHCP request is initiated by - // user, adjust the current state according to the lease life. - // Otherwise do nothing to wait the lease to timeout - // - if (DhcpSb->ExtraRefresh != 0) { - Status = EFI_SUCCESS; - - if (DhcpSb->LeaseLife < DhcpSb->T1) { - Status = DhcpSetState (DhcpSb, Dhcp4Bound, FALSE); - - } else if (DhcpSb->LeaseLife < DhcpSb->T2) { - Status = DhcpSetState (DhcpSb, Dhcp4Renewing, FALSE); - - } else if (DhcpSb->LeaseLife < DhcpSb->Lease) { - Status = DhcpSetState (DhcpSb, Dhcp4Rebinding, FALSE); - - } else { - goto END_SESSION; - - } - - DhcpSb->IoStatus = EFI_TIMEOUT; - DhcpNotifyUser (DhcpSb, DHCP_NOTIFY_RENEWREBIND); - } - } else { - goto END_SESSION; - } - } - - // - // If an address has been acquired, check whether need to - // refresh or whether it has expired. - // - if (DHCP_CONNECTED (DhcpSb->DhcpState)) { - DhcpSb->LeaseLife++; - - // - // Don't timeout the lease, only count the life if user is - // requesting extra renew/rebind. Adjust the state after that. - // - if (DhcpSb->ExtraRefresh != 0) { - return ; - } - - if (DhcpSb->LeaseLife == DhcpSb->Lease) { - // - // Lease expires, end the session - // - goto END_SESSION; - - } else if (DhcpSb->LeaseLife == DhcpSb->T2) { - // - // T2 expires, transit to rebinding then send a REQUEST to any server - // - if (EFI_ERROR (DhcpSetState (DhcpSb, Dhcp4Rebinding, TRUE))) { - goto END_SESSION; - } - - if (Instance != NULL) { - Instance->ElaspedTime= 0; - } - - Status = DhcpSendMessage ( - DhcpSb, - DhcpSb->Selected, - DhcpSb->Para, - DHCP_MSG_REQUEST, - NULL - ); - - if (EFI_ERROR (Status)) { - goto END_SESSION; - } - - } else if (DhcpSb->LeaseLife == DhcpSb->T1) { - // - // T1 expires, transit to renewing, then send a REQUEST to the server - // - if (EFI_ERROR (DhcpSetState (DhcpSb, Dhcp4Renewing, TRUE))) { - goto END_SESSION; - } - - if (Instance != NULL) { - Instance->ElaspedTime= 0; - } - - Status = DhcpSendMessage ( - DhcpSb, - DhcpSb->Selected, - DhcpSb->Para, - DHCP_MSG_REQUEST, - NULL - ); - - if (EFI_ERROR (Status)) { - goto END_SESSION; - } - } - } - -ON_EXIT: - // - // Iterate through all the DhcpSb Children. - // - NET_LIST_FOR_EACH_SAFE (Entry, Next, &DhcpSb->Children) { - Instance = NET_LIST_USER_STRUCT (Entry, DHCP_PROTOCOL, Link); - Instance->Timeout--; - if (Instance->Timeout == 0 && Instance->Token != NULL) { - PxeDhcpDone (Instance); - } - } - - return ; - -END_SESSION: - DhcpEndSession (DhcpSb, EFI_TIMEOUT); - - return ; -} diff --git a/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Io.h b/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Io.h deleted file mode 100644 index 01283e5e17..0000000000 --- a/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Io.h +++ /dev/null @@ -1,189 +0,0 @@ -/** @file - The DHCP4 protocol implementation. - -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef __EFI_DHCP4_IO_H__ -#define __EFI_DHCP4_IO_H__ - -#include - -#include - -#include -#include -#include -#include - - - -#define DHCP_WAIT_OFFER 3 // Time to wait the offers -#define DHCP_DEFAULT_LEASE 7 * 24 * 60 * 60 // Seven days as default. -#define DHCP_SERVER_PORT 67 -#define DHCP_CLIENT_PORT 68 - -// -// BOOTP header "op" field -// -#define BOOTP_REQUEST 1 -#define BOOTP_REPLY 2 - -// -// DHCP message types -// -#define DHCP_MSG_DISCOVER 1 -#define DHCP_MSG_OFFER 2 -#define DHCP_MSG_REQUEST 3 -#define DHCP_MSG_DECLINE 4 -#define DHCP_MSG_ACK 5 -#define DHCP_MSG_NAK 6 -#define DHCP_MSG_RELEASE 7 -#define DHCP_MSG_INFORM 8 - -// -// DHCP notify user type -// -#define DHCP_NOTIFY_COMPLETION 1 -#define DHCP_NOTIFY_RENEWREBIND 2 -#define DHCP_NOTIFY_ALL 3 - -#define DHCP_IS_BOOTP(Parameter) (((Parameter) == NULL) || ((Parameter)->DhcpType == 0)) - -#define DHCP_CONNECTED(State) \ - (((State) == Dhcp4Bound) || ((State) == (Dhcp4Renewing)) || ((State) == Dhcp4Rebinding)) - -/** - Set the DHCP state. If CallUser is true, it will try to notify - the user before change the state by DhcpNotifyUser. It returns - EFI_ABORTED if the user return EFI_ABORTED, otherwise, it returns - EFI_SUCCESS. If CallUser is FALSE, it isn't necessary to test - the return value of this function. - - @param DhcpSb The DHCP service instance - @param State The new DHCP state to change to - @param CallUser Whether we need to call user - - @retval EFI_SUCCESS The state is changed - @retval EFI_ABORTED The user asks to abort the DHCP process. - -**/ -EFI_STATUS -DhcpSetState ( - IN OUT DHCP_SERVICE *DhcpSb, - IN INTN State, - IN BOOLEAN CallUser - ); - -/** - Build and transmit a DHCP message according to the current states. - This function implement the Table 5. of RFC 2131. Always transits - the state (as defined in Figure 5. of the same RFC) before sending - a DHCP message. The table is adjusted accordingly. - - @param[in] DhcpSb The DHCP service instance - @param[in] Seed The seed packet which the new packet is based on - @param[in] Para The DHCP parameter of the Seed packet - @param[in] Type The message type to send - @param[in] Msg The human readable message to include in the packet - sent. - - @retval EFI_OUT_OF_RESOURCES Failed to allocate resources for the packet - @retval EFI_ACCESS_DENIED Failed to transmit the packet through UDP - @retval EFI_SUCCESS The message is sent - @retval other Other error occurs - -**/ -EFI_STATUS -DhcpSendMessage ( - IN DHCP_SERVICE *DhcpSb, - IN EFI_DHCP4_PACKET *Seed, - IN DHCP_PARAMETER *Para, - IN UINT8 Type, - IN UINT8 *Msg - ); - -/** - Each DHCP service has three timer. Two of them are count down timer. - One for the packet retransmission. The other is to collect the offers. - The third timer increaments the lease life which is compared to T1, T2, - and lease to determine the time to renew and rebind the lease. - DhcpOnTimerTick will be called once every second. - - @param[in] Event The timer event - @param[in] Context The context, which is the DHCP service instance. - -**/ -VOID -EFIAPI -DhcpOnTimerTick ( - IN EFI_EVENT Event, - IN VOID *Context - ); - -/** - Handle the received DHCP packets. This function drives the DHCP - state machine. - - @param UdpPacket The UDP packets received. - @param EndPoint The local/remote UDP access point - @param IoStatus The status of the UDP receive - @param Context The opaque parameter to the function. - -**/ -VOID -EFIAPI -DhcpInput ( - NET_BUF *UdpPacket, - UDP_END_POINT *EndPoint, - EFI_STATUS IoStatus, - VOID *Context - ); - -/** - Send an initial DISCOVER or REQUEST message according to the - DHCP service's current state. - - @param[in] DhcpSb The DHCP service instance - - @retval EFI_SUCCESS The request has been sent - @retval other Some error occurs when sending the request. - -**/ -EFI_STATUS -DhcpInitRequest ( - IN DHCP_SERVICE *DhcpSb - ); - -/** - Clean up the DHCP related states, IoStatus isn't reset. - - @param DhcpSb The DHCP instance service. - -**/ -VOID -DhcpCleanLease ( - IN DHCP_SERVICE *DhcpSb - ); - -/** - Release the net buffer when packet is sent. - - @param UdpPacket The UDP packets received. - @param EndPoint The local/remote UDP access point - @param IoStatus The status of the UDP receive - @param Context The opaque parameter to the function. - -**/ -VOID -EFIAPI -DhcpOnPacketSent ( - NET_BUF *Packet, - UDP_END_POINT *EndPoint, - EFI_STATUS IoStatus, - VOID *Context - ); - -#endif diff --git a/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Option.c b/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Option.c deleted file mode 100644 index 3adbf55d06..0000000000 --- a/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Option.c +++ /dev/null @@ -1,890 +0,0 @@ -/** @file - Function to validate, parse, process the DHCP options. - -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Dhcp4Impl.h" - -/// -/// A list of the format of DHCP Options sorted by option tag -/// to validate a dhcp message. Refere the comments of the -/// DHCP_OPTION_FORMAT structure. -/// -DHCP_OPTION_FORMAT DhcpOptionFormats[] = { - {DHCP4_TAG_NETMASK, DHCP_OPTION_IP, 1, 1 , TRUE}, - {DHCP4_TAG_TIME_OFFSET, DHCP_OPTION_INT32, 1, 1 , FALSE}, - {DHCP4_TAG_ROUTER, DHCP_OPTION_IP, 1, -1 , TRUE}, - {DHCP4_TAG_TIME_SERVER, DHCP_OPTION_IP, 1, -1 , FALSE}, - {DHCP4_TAG_NAME_SERVER, DHCP_OPTION_IP, 1, -1 , FALSE}, - {DHCP4_TAG_DNS_SERVER, DHCP_OPTION_IP, 1, -1 , FALSE}, - {DHCP4_TAG_LOG_SERVER, DHCP_OPTION_IP, 1, -1 , FALSE}, - {DHCP4_TAG_COOKIE_SERVER, DHCP_OPTION_IP, 1, -1 , FALSE}, - {DHCP4_TAG_LPR_SERVER, DHCP_OPTION_IP, 1, -1 , FALSE}, - {DHCP4_TAG_IMPRESS_SERVER, DHCP_OPTION_IP, 1, -1 , FALSE}, - {DHCP4_TAG_RL_SERVER, DHCP_OPTION_IP, 1, -1 , FALSE}, - {DHCP4_TAG_HOSTNAME, DHCP_OPTION_INT8, 1, -1 , FALSE}, - {DHCP4_TAG_BOOTFILE_LEN, DHCP_OPTION_INT16, 1, 1 , FALSE}, - {DHCP4_TAG_DUMP, DHCP_OPTION_INT8, 1, -1 , FALSE}, - {DHCP4_TAG_DOMAINNAME, DHCP_OPTION_INT8, 1, -1 , FALSE}, - {DHCP4_TAG_SWAP_SERVER, DHCP_OPTION_IP, 1, 1 , FALSE}, - {DHCP4_TAG_ROOTPATH, DHCP_OPTION_INT8, 1, -1 , FALSE}, - {DHCP4_TAG_EXTEND_PATH, DHCP_OPTION_INT8, 1, -1 , FALSE}, - - {DHCP4_TAG_IPFORWARD, DHCP_OPTION_SWITCH, 1, 1 , FALSE}, - {DHCP4_TAG_NONLOCAL_SRR, DHCP_OPTION_SWITCH, 1, 1 , FALSE}, - {DHCP4_TAG_POLICY_SRR, DHCP_OPTION_IPPAIR, 1, -1 , FALSE}, - {DHCP4_TAG_EMTU, DHCP_OPTION_INT16, 1, 1 , FALSE}, - {DHCP4_TAG_TTL, DHCP_OPTION_INT8, 1, 1 , FALSE}, - {DHCP4_TAG_PATHMTU_AGE, DHCP_OPTION_INT32, 1, 1 , FALSE}, - {DHCP4_TAG_PATHMTU_PLATEAU,DHCP_OPTION_INT16, 1, -1 , FALSE}, - - {DHCP4_TAG_IFMTU, DHCP_OPTION_INT16, 1, 1 , FALSE}, - {DHCP4_TAG_SUBNET_LOCAL, DHCP_OPTION_SWITCH, 1, 1 , FALSE}, - {DHCP4_TAG_BROADCAST, DHCP_OPTION_IP, 1, 1 , FALSE}, - {DHCP4_TAG_DISCOVER_MASK, DHCP_OPTION_SWITCH, 1, 1 , FALSE}, - {DHCP4_TAG_SUPPLY_MASK, DHCP_OPTION_SWITCH, 1, 1 , FALSE}, - {DHCP4_TAG_DISCOVER_ROUTE, DHCP_OPTION_SWITCH, 1, 1 , FALSE}, - {DHCP4_TAG_ROUTER_SOLICIT, DHCP_OPTION_IP, 1, 1 , FALSE}, - {DHCP4_TAG_STATIC_ROUTE, DHCP_OPTION_IPPAIR, 1, -1 , FALSE}, - - {DHCP4_TAG_TRAILER, DHCP_OPTION_SWITCH, 1, 1 , FALSE}, - {DHCP4_TAG_ARPAGE, DHCP_OPTION_INT32, 1, 1 , FALSE}, - {DHCP4_TAG_ETHER_ENCAP, DHCP_OPTION_SWITCH, 1, 1 , FALSE}, - - {DHCP4_TAG_TCP_TTL, DHCP_OPTION_INT8, 1, 1 , FALSE}, - {DHCP4_TAG_KEEP_INTERVAL, DHCP_OPTION_INT32, 1, 1 , FALSE}, - {DHCP4_TAG_KEEP_GARBAGE, DHCP_OPTION_SWITCH, 1, 1 , FALSE}, - - {DHCP4_TAG_NIS_DOMAIN, DHCP_OPTION_INT8, 1, -1 , FALSE}, - {DHCP4_TAG_NIS_SERVER, DHCP_OPTION_IP, 1, -1 , FALSE}, - {DHCP4_TAG_NTP_SERVER, DHCP_OPTION_IP, 1, -1 , FALSE}, - {DHCP4_TAG_VENDOR, DHCP_OPTION_INT8, 1, -1 , FALSE}, - {DHCP4_TAG_NBNS, DHCP_OPTION_IP, 1, -1 , FALSE}, - {DHCP4_TAG_NBDD, DHCP_OPTION_IP, 1, -1 , FALSE}, - {DHCP4_TAG_NBTYPE, DHCP_OPTION_INT8, 1, 1 , FALSE}, - {DHCP4_TAG_NBSCOPE, DHCP_OPTION_INT8, 1, -1 , FALSE}, - {DHCP4_TAG_XFONT, DHCP_OPTION_IP, 1, -1 , FALSE}, - {DHCP4_TAG_XDM, DHCP_OPTION_IP, 1, -1 , FALSE}, - - {DHCP4_TAG_REQUEST_IP, DHCP_OPTION_IP, 1, 1 , FALSE}, - {DHCP4_TAG_LEASE, DHCP_OPTION_INT32, 1, 1 , TRUE}, - {DHCP4_TAG_OVERLOAD, DHCP_OPTION_INT8, 1, 1 , TRUE}, - {DHCP4_TAG_MSG_TYPE, DHCP_OPTION_INT8, 1, 1 , TRUE}, - {DHCP4_TAG_SERVER_ID, DHCP_OPTION_IP, 1, 1 , TRUE}, - {DHCP4_TAG_PARA_LIST, DHCP_OPTION_INT8, 1, -1 , FALSE}, - {DHCP4_TAG_MESSAGE, DHCP_OPTION_INT8, 1, -1 , FALSE}, - {DHCP4_TAG_MAXMSG, DHCP_OPTION_INT16, 1, 1 , FALSE}, - {DHCP4_TAG_T1, DHCP_OPTION_INT32, 1, 1 , TRUE}, - {DHCP4_TAG_T2, DHCP_OPTION_INT32, 1, 1 , TRUE}, - {DHCP4_TAG_VENDOR_CLASS_ID,DHCP_OPTION_INT8, 1, -1 , FALSE}, - {DHCP4_TAG_CLIENT_ID, DHCP_OPTION_INT8, 2, -1 , FALSE}, - - {DHCP4_TAG_NISPLUS, DHCP_OPTION_INT8, 1, -1 , FALSE}, - {DHCP4_TAG_NISPLUS_SERVER, DHCP_OPTION_IP, 1, -1 , FALSE}, - - {DHCP4_TAG_TFTP, DHCP_OPTION_INT8, 1, -1 , FALSE}, - {DHCP4_TAG_BOOTFILE, DHCP_OPTION_INT8, 1, -1 , FALSE}, - - {DHCP4_TAG_MOBILEIP, DHCP_OPTION_IP, 0, -1 , FALSE}, - {DHCP4_TAG_SMTP, DHCP_OPTION_IP, 1, -1 , FALSE}, - {DHCP4_TAG_POP3, DHCP_OPTION_IP, 1, -1 , FALSE}, - {DHCP4_TAG_NNTP, DHCP_OPTION_IP, 1, -1 , FALSE}, - {DHCP4_TAG_WWW, DHCP_OPTION_IP, 1, -1 , FALSE}, - {DHCP4_TAG_FINGER, DHCP_OPTION_IP, 1, -1 , FALSE}, - {DHCP4_TAG_IRC, DHCP_OPTION_IP, 1, -1 , FALSE}, - {DHCP4_TAG_STTALK, DHCP_OPTION_IP, 1, -1 , FALSE}, - {DHCP4_TAG_STDA, DHCP_OPTION_IP, 1, -1 , FALSE}, - - {DHCP4_TAG_CLASSLESS_ROUTE,DHCP_OPTION_INT8, 5, -1 , FALSE}, -}; - - -/** - Binary search the DhcpOptionFormats array to find the format - information about a specific option. - - @param[in] Tag The option's tag. - - @return The point to the option's format, NULL if not found. - -**/ -DHCP_OPTION_FORMAT * -DhcpFindOptionFormat ( - IN UINT8 Tag - ) -{ - INTN Left; - INTN Right; - INTN Middle; - - Left = 0; - Right = sizeof (DhcpOptionFormats) / sizeof (DHCP_OPTION_FORMAT) - 1; - - while (Right >= Left) { - Middle = (Left + Right) / 2; - - if (Tag == DhcpOptionFormats[Middle].Tag) { - return &DhcpOptionFormats[Middle]; - } - - if (Tag < DhcpOptionFormats[Middle].Tag) { - Right = Middle - 1; - } else { - Left = Middle + 1; - } - } - - return NULL; -} - - -/** - Validate whether a single DHCP option is valid according to its format. - - @param[in] Format The option's format - @param[in] OptValue The value of the option - @param[in] Len The length of the option value - - @retval TRUE The option is valid. - @retval FALSE Otherwise. - -**/ -BOOLEAN -DhcpOptionIsValid ( - IN DHCP_OPTION_FORMAT *Format, - IN UINT8 *OptValue, - IN INTN Len - ) -{ - INTN Unit; - INTN Occur; - INTN Index; - - Unit = 0; - - switch (Format->Type) { - case DHCP_OPTION_SWITCH: - case DHCP_OPTION_INT8: - Unit = 1; - break; - - case DHCP_OPTION_INT16: - Unit = 2; - break; - - case DHCP_OPTION_INT32: - case DHCP_OPTION_IP: - Unit = 4; - break; - - case DHCP_OPTION_IPPAIR: - Unit = 8; - break; - } - - ASSERT (Unit != 0); - - // - // Validate that the option appears in the full units. - // - if ((Len % Unit) != 0) { - return FALSE; - } - - // - // Validate the occurance of the option unit is with in [MinOccur, MaxOccur] - // - Occur = Len / Unit; - - if (((Format->MinOccur != -1) && (Occur < Format->MinOccur)) || - ((Format->MaxOccur != -1) && (Occur > Format->MaxOccur)) - ) { - return FALSE; - } - - // - // If the option is of type switch, only 0/1 are valid values. - // - if (Format->Type == DHCP_OPTION_SWITCH) { - for (Index = 0; Index < Occur; Index++) { - if ((OptValue[Index] != 0) && (OptValue[Index] != 1)) { - return FALSE; - } - } - } - - return TRUE; -} - - -/** - Extract the client interested options, all the parameters are - converted to host byte order. - - @param[in] Tag The DHCP option tag - @param[in] Len The length of the option - @param[in] Data The value of the DHCP option - @param[out] Para The variable to save the interested parameter - - @retval EFI_SUCCESS The DHCP option is successfully extracted. - @retval EFI_INVALID_PARAMETER The DHCP option is mal-formated - -**/ -EFI_STATUS -DhcpGetParameter ( - IN UINT8 Tag, - IN INTN Len, - IN UINT8 *Data, - OUT DHCP_PARAMETER *Para - ) -{ - switch (Tag) { - case DHCP4_TAG_NETMASK: - Para->NetMask = NetGetUint32 (Data); - break; - - case DHCP4_TAG_ROUTER: - // - // Return the first router to consumer which is the preferred one - // - Para->Router = NetGetUint32 (Data); - break; - - case DHCP4_TAG_LEASE: - Para->Lease = NetGetUint32 (Data); - break; - - case DHCP4_TAG_OVERLOAD: - Para->Overload = *Data; - - if ((Para->Overload < 1) || (Para->Overload > 3)) { - return EFI_INVALID_PARAMETER; - } - break; - - case DHCP4_TAG_MSG_TYPE: - Para->DhcpType = *Data; - - if ((Para->DhcpType < 1) || (Para->DhcpType > 9)) { - return EFI_INVALID_PARAMETER; - } - break; - - case DHCP4_TAG_SERVER_ID: - Para->ServerId = NetGetUint32 (Data); - break; - - case DHCP4_TAG_T1: - Para->T1 = NetGetUint32 (Data); - break; - - case DHCP4_TAG_T2: - Para->T2 = NetGetUint32 (Data); - break; - } - - return EFI_SUCCESS; -} - - -/** - Inspect all the options in a single buffer. DHCP options may be contained - in several buffers, such as the BOOTP options filed, boot file or server - name. Each option buffer is required to end with DHCP4_TAG_EOP. - - @param[in] Buffer The buffer which contains DHCP options - @param[in] BufLen The length of the buffer - @param[in] Check The callback function for each option found - @param[in] Context The opaque parameter for the Check - @param[out] Overload Variable to save the value of DHCP4_TAG_OVERLOAD - option. - - @retval EFI_SUCCESS All the options are valid - @retval EFI_INVALID_PARAMETER The options are mal-formated. - -**/ -EFI_STATUS -DhcpIterateBufferOptions ( - IN UINT8 *Buffer, - IN INTN BufLen, - IN DHCP_CHECK_OPTION Check OPTIONAL, - IN VOID *Context, - OUT UINT8 *Overload OPTIONAL - ) -{ - INTN Cur; - UINT8 Tag; - UINT8 Len; - - Cur = 0; - - while (Cur < BufLen) { - Tag = Buffer[Cur]; - - if (Tag == DHCP4_TAG_PAD) { - Cur++; - continue; - } else if (Tag == DHCP4_TAG_EOP) { - return EFI_SUCCESS; - } - - Cur++; - - if (Cur == BufLen) { - return EFI_INVALID_PARAMETER; - } - - Len = Buffer[Cur++]; - - if (Cur + Len > BufLen) { - return EFI_INVALID_PARAMETER; - } - - if ((Tag == DHCP4_TAG_OVERLOAD) && (Overload != NULL)) { - if (Len != 1) { - return EFI_INVALID_PARAMETER; - } - - *Overload = Buffer[Cur]; - } - - if ((Check != NULL) && EFI_ERROR (Check (Tag, Len, Buffer + Cur, Context))) { - return EFI_INVALID_PARAMETER; - } - - Cur += Len; - } - - // - // Each option buffer is expected to end with an EOP - // - return EFI_INVALID_PARAMETER; -} - - -/** - Iterate through a DHCP message to visit each option. First inspect - all the options in the OPTION field. Then if overloaded, inspect - the options in FILENAME and SERVERNAME fields. One option may be - encoded in several places. See RFC 3396 Encoding Long Options in DHCP - - @param[in] Packet The DHCP packet to check the options for - @param[in] Check The callback function to be called for each option - found - @param[in] Context The opaque parameter for Check - - @retval EFI_SUCCESS The DHCP packet's options are well formated - @retval EFI_INVALID_PARAMETER The DHCP packet's options are not well formated - -**/ -EFI_STATUS -DhcpIterateOptions ( - IN EFI_DHCP4_PACKET *Packet, - IN DHCP_CHECK_OPTION Check OPTIONAL, - IN VOID *Context - ) -{ - EFI_STATUS Status; - UINT8 Overload; - - Overload = 0; - - Status = DhcpIterateBufferOptions ( - Packet->Dhcp4.Option, - Packet->Length - sizeof (EFI_DHCP4_HEADER) - sizeof (UINT32), - Check, - Context, - &Overload - ); - - if (EFI_ERROR (Status)) { - return Status; - } - - if ((Overload == DHCP_OVERLOAD_FILENAME) || (Overload == DHCP_OVERLOAD_BOTH)) { - Status = DhcpIterateBufferOptions ( - (UINT8 *) Packet->Dhcp4.Header.BootFileName, - 128, - Check, - Context, - NULL - ); - - if (EFI_ERROR (Status)) { - return Status; - } - } - - if ((Overload == DHCP_OVERLOAD_SVRNAME) || (Overload == DHCP_OVERLOAD_BOTH)) { - Status = DhcpIterateBufferOptions ( - (UINT8 *) Packet->Dhcp4.Header.ServerName, - 64, - Check, - Context, - NULL - ); - - if (EFI_ERROR (Status)) { - return Status; - } - } - - return EFI_SUCCESS; -} - - -/** - Call back function to DhcpIterateOptions to compute each option's - length. It just adds the data length of all the occurances of this - Tag. Context is an array of 256 DHCP_OPTION_COUNT. - - @param[in] Tag The current option to check - @param[in] Len The length of the option data - @param[in] Data The option data - @param[in] Context The context, which is a array of 256 - DHCP_OPTION_COUNT. - - @retval EFI_SUCCESS It always returns EFI_SUCCESS. - -**/ -EFI_STATUS -DhcpGetOptionLen ( - IN UINT8 Tag, - IN UINT8 Len, - IN UINT8 *Data, - IN VOID *Context - ) -{ - DHCP_OPTION_COUNT *OpCount; - - OpCount = (DHCP_OPTION_COUNT *) Context; - OpCount[Tag].Offset = (UINT16) (OpCount[Tag].Offset + Len); - - return EFI_SUCCESS; -} - - -/** - Call back function to DhcpIterateOptions to consolidate each option's - data. There are maybe several occurrence of the same option. - - @param[in] Tag The option to consolidate its data - @param[in] Len The length of option data - @param[in] Data The data of the option's current occurance - @param[in] Context The context, which is DHCP_OPTION_CONTEXT. This - array is just a wrap to pass THREE parameters. - - @retval EFI_SUCCESS It always returns EFI_SUCCESS - -**/ -EFI_STATUS -DhcpFillOption ( - IN UINT8 Tag, - IN UINT8 Len, - IN UINT8 *Data, - IN VOID *Context - ) -{ - DHCP_OPTION_CONTEXT *OptContext; - DHCP_OPTION_COUNT *OptCount; - DHCP_OPTION *Options; - UINT8 *Buf; - UINT8 Index; - - OptContext = (DHCP_OPTION_CONTEXT *) Context; - - OptCount = OptContext->OpCount; - Index = OptCount[Tag].Index; - Options = OptContext->Options; - Buf = OptContext->Buf; - - if (Options[Index].Data == NULL) { - Options[Index].Tag = Tag; - Options[Index].Data = Buf + OptCount[Tag].Offset; - } - - CopyMem (Buf + OptCount[Tag].Offset, Data, Len); - - OptCount[Tag].Offset = (UINT16) (OptCount[Tag].Offset + Len); - Options[Index].Len = (UINT16) (Options[Index].Len + Len); - return EFI_SUCCESS; -} - - -/** - Parse the options of a DHCP packet. It supports RFC 3396: Encoding - Long Options in DHCP. That is, it will combine all the option value - of all the occurances of each option. - A little bit of implemenation: - It adopts the "Key indexed counting" algorithm. First, it allocates - an array of 256 DHCP_OPTION_COUNTs because DHCP option tag is encoded - as a UINT8. It then iterates the DHCP packet to get data length of - each option by calling DhcpIterOptions with DhcpGetOptionLen. Now, it - knows the number of present options and their length. It allocates a - array of DHCP_OPTION and a continuous buffer after the array to put - all the options' data. Each option's data is pointed to by the Data - field in DHCP_OPTION structure. At last, it call DhcpIterateOptions - with DhcpFillOption to fill each option's data to its position in the - buffer. - - @param[in] Packet The DHCP packet to parse the options - @param[out] Count The number of valid dhcp options present in the - packet - @param[out] OptionPoint The array that contains the DHCP options. Caller - should free it. - - @retval EFI_NOT_FOUND Cannot find any option. - @retval EFI_OUT_OF_RESOURCES Failed to allocate memory to parse the packet. - @retval EFI_INVALID_PARAMETER The options are mal-formated - @retval EFI_SUCCESS The options are parsed into OptionPoint - -**/ -EFI_STATUS -DhcpParseOption ( - IN EFI_DHCP4_PACKET *Packet, - OUT INTN *Count, - OUT DHCP_OPTION **OptionPoint - ) -{ - DHCP_OPTION_CONTEXT Context; - DHCP_OPTION *Options; - DHCP_OPTION_COUNT *OptCount; - EFI_STATUS Status; - UINT16 TotalLen; - INTN OptNum; - INTN Index; - - ASSERT ((Count != NULL) && (OptionPoint != NULL)); - - // - // First compute how many options and how long each option is - // with the "Key indexed counting" algorithms. - // - OptCount = AllocateZeroPool (DHCP_MAX_OPTIONS * sizeof (DHCP_OPTION_COUNT)); - - if (OptCount == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - Status = DhcpIterateOptions (Packet, DhcpGetOptionLen, OptCount); - - if (EFI_ERROR (Status)) { - goto ON_EXIT; - } - - // - // Before the loop, Offset is the length of the option. After loop, - // OptCount[Index].Offset specifies the offset into the continuous - // option value buffer to put the data. - // - TotalLen = 0; - OptNum = 0; - - for (Index = 0; Index < DHCP_MAX_OPTIONS; Index++) { - if (OptCount[Index].Offset != 0) { - OptCount[Index].Index = (UINT8) OptNum; - - TotalLen = (UINT16) (TotalLen + OptCount[Index].Offset); - OptCount[Index].Offset = (UINT16) (TotalLen - OptCount[Index].Offset); - - OptNum++; - } - } - - *Count = OptNum; - *OptionPoint = NULL; - - if (OptNum == 0) { - goto ON_EXIT; - } - - // - // Allocate a buffer to hold the DHCP options, and after that, a - // continuous buffer to put all the options' data. - // - Options = AllocateZeroPool ((UINTN) (OptNum * sizeof (DHCP_OPTION)) + TotalLen); - - if (Options == NULL) { - Status = EFI_OUT_OF_RESOURCES; - goto ON_EXIT; - } - - Context.OpCount = OptCount; - Context.Options = Options; - Context.Buf = (UINT8 *) (Options + OptNum); - - Status = DhcpIterateOptions (Packet, DhcpFillOption, &Context); - - if (EFI_ERROR (Status)) { - FreePool (Options); - goto ON_EXIT; - } - - *OptionPoint = Options; - -ON_EXIT: - FreePool (OptCount); - return Status; -} - - -/** - Validate the packet's options. If necessary, allocate - and fill in the interested parameters. - - @param[in] Packet The packet to validate the options - @param[out] Para The variable to save the DHCP parameters. - - @retval EFI_OUT_OF_RESOURCES Failed to allocate memory to validate the packet. - @retval EFI_INVALID_PARAMETER The options are mal-formated - @retval EFI_SUCCESS The options are parsed into OptionPoint - -**/ -EFI_STATUS -DhcpValidateOptions ( - IN EFI_DHCP4_PACKET *Packet, - OUT DHCP_PARAMETER **Para OPTIONAL - ) -{ - DHCP_PARAMETER Parameter; - DHCP_OPTION_FORMAT *Format; - DHCP_OPTION *AllOption; - DHCP_OPTION *Option; - EFI_STATUS Status; - BOOLEAN Updated; - INTN Count; - INTN Index; - - if (Para != NULL) { - *Para = NULL; - } - - AllOption = NULL; - - Status = DhcpParseOption (Packet, &Count, &AllOption); - if (EFI_ERROR (Status) || (Count == 0)) { - return Status; - } - ASSERT (AllOption != NULL); - - Updated = FALSE; - ZeroMem (&Parameter, sizeof (Parameter)); - - for (Index = 0; Index < Count; Index++) { - Option = &AllOption[Index]; - - // - // Find the format of the option then validate it. - // - Format = DhcpFindOptionFormat (Option->Tag); - - if (Format == NULL) { - continue; - } - - if (!DhcpOptionIsValid (Format, Option->Data, Option->Len)) { - Status = EFI_INVALID_PARAMETER; - goto ON_EXIT; - } - - // - // Get the client interested parameters - // - if (Format->Alert && (Para != NULL)) { - Updated = TRUE; - Status = DhcpGetParameter (Option->Tag, Option->Len, Option->Data, &Parameter); - - if (EFI_ERROR (Status)) { - goto ON_EXIT; - } - } - } - - if (Updated && (Para != NULL)) { - *Para = AllocateCopyPool (sizeof (DHCP_PARAMETER), &Parameter); - if (*Para == NULL) { - Status = EFI_OUT_OF_RESOURCES; - goto ON_EXIT; - } - } - -ON_EXIT: - FreePool (AllOption); - return Status; -} - - - -/** - Append an option to the memory, if the option is longer than - 255 bytes, splits it into several options. - - @param[out] Buf The buffer to append the option to - @param[in] Tag The option's tag - @param[in] DataLen The length of the option's data - @param[in] Data The option's data - - @return The position to append the next option - -**/ -UINT8 * -DhcpAppendOption ( - OUT UINT8 *Buf, - IN UINT8 Tag, - IN UINT16 DataLen, - IN UINT8 *Data - ) -{ - INTN Index; - INTN Len; - - ASSERT (DataLen != 0); - - for (Index = 0; Index < (DataLen + 254) / 255; Index++) { - Len = MIN (255, DataLen - Index * 255); - - *(Buf++) = Tag; - *(Buf++) = (UINT8) Len; - CopyMem (Buf, Data + Index * 255, (UINTN) Len); - - Buf += Len; - } - - return Buf; -} - - -/** - Build a new DHCP packet from a seed packet. Options may be deleted or - appended. The caller should free the NewPacket when finished using it. - - @param[in] SeedPacket The seed packet to start with - @param[in] DeleteCount The number of options to delete - @param[in] DeleteList The options to delete from the packet - @param[in] AppendCount The number of options to append - @param[in] AppendList The options to append to the packet - @param[out] NewPacket The new packet, allocated and built by this - function. - - @retval EFI_OUT_OF_RESOURCES Failed to allocate memory - @retval EFI_INVALID_PARAMETER The options in SeekPacket are mal-formated - @retval EFI_SUCCESS The packet is build. - -**/ -EFI_STATUS -DhcpBuild ( - IN EFI_DHCP4_PACKET *SeedPacket, - IN UINT32 DeleteCount, - IN UINT8 *DeleteList OPTIONAL, - IN UINT32 AppendCount, - IN EFI_DHCP4_PACKET_OPTION *AppendList[] OPTIONAL, - OUT EFI_DHCP4_PACKET **NewPacket - ) -{ - DHCP_OPTION *Mark; - DHCP_OPTION *SeedOptions; - EFI_DHCP4_PACKET *Packet; - EFI_STATUS Status; - INTN Count; - UINT32 Index; - UINT32 Len; - UINT8 *Buf; - - // - // Use an array of DHCP_OPTION to mark the existance - // and position of each valid options. - // - Mark = AllocatePool (sizeof (DHCP_OPTION) * DHCP_MAX_OPTIONS); - - if (Mark == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - for (Index = 0; Index < DHCP_MAX_OPTIONS; Index++) { - Mark[Index].Tag = (UINT8) Index; - Mark[Index].Len = 0; - } - - // - // Get list of the options from the seed packet, then put - // them to the mark array according to their tags. - // - SeedOptions = NULL; - Status = DhcpParseOption (SeedPacket, &Count, &SeedOptions); - - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - if (SeedOptions != NULL) { - for (Index = 0; Index < (UINT32) Count; Index++) { - Mark[SeedOptions[Index].Tag] = SeedOptions[Index]; - } - } - - // - // Mark the option's length is zero if it is in the DeleteList. - // - for (Index = 0; Index < DeleteCount; Index++) { - Mark[DeleteList[Index]].Len = 0; - } - - // - // Add or replace the option if it is in the append list. - // - for (Index = 0; Index < AppendCount; Index++) { - Mark[AppendList[Index]->OpCode].Len = AppendList[Index]->Length; - Mark[AppendList[Index]->OpCode].Data = AppendList[Index]->Data; - } - - // - // compute the new packet length. No need to add 1 byte for - // EOP option since EFI_DHCP4_PACKET includes one extra byte - // for option. It is necessary to split the option if it is - // longer than 255 bytes. - // - Len = sizeof (EFI_DHCP4_PACKET); - - for (Index = 0; Index < DHCP_MAX_OPTIONS; Index++) { - if (Mark[Index].Len != 0) { - Len += ((Mark[Index].Len + 254) / 255) * 2 + Mark[Index].Len; - } - } - - Status = EFI_OUT_OF_RESOURCES; - Packet = (EFI_DHCP4_PACKET *) AllocatePool (Len); - - if (Packet == NULL) { - goto ON_ERROR; - } - - Packet->Size = Len; - Packet->Length = 0; - CopyMem (&Packet->Dhcp4.Header, &SeedPacket->Dhcp4.Header, sizeof (Packet->Dhcp4.Header)); - Packet->Dhcp4.Magik = DHCP_OPTION_MAGIC; - Buf = Packet->Dhcp4.Option; - - for (Index = 0; Index < DHCP_MAX_OPTIONS; Index++) { - if (Mark[Index].Len != 0) { - Buf = DhcpAppendOption (Buf, Mark[Index].Tag, Mark[Index].Len, Mark[Index].Data); - } - } - - *(Buf++) = DHCP4_TAG_EOP; - Packet->Length = sizeof (EFI_DHCP4_HEADER) + sizeof (UINT32) - + (UINT32) (Buf - Packet->Dhcp4.Option); - - *NewPacket = Packet; - Status = EFI_SUCCESS; - -ON_ERROR: - if (SeedOptions != NULL) { - FreePool (SeedOptions); - } - - FreePool (Mark); - return Status; -} diff --git a/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Option.h b/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Option.h deleted file mode 100644 index 9e25386507..0000000000 --- a/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Option.h +++ /dev/null @@ -1,228 +0,0 @@ -/** @file - To validate, parse and process the DHCP options. - -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef __EFI_DHCP4_OPTION_H__ -#define __EFI_DHCP4_OPTION_H__ - -/// -/// DHCP option tags (types) -/// - -#define DHCP_OPTION_MAGIC 0x63538263 // Network byte order -#define DHCP_MAX_OPTIONS 256 - - -// -// DHCP option types, this is used to validate the DHCP options. -// -#define DHCP_OPTION_SWITCH 1 -#define DHCP_OPTION_INT8 2 -#define DHCP_OPTION_INT16 3 -#define DHCP_OPTION_INT32 4 -#define DHCP_OPTION_IP 5 -#define DHCP_OPTION_IPPAIR 6 - -// -// Value of DHCP overload option -// -#define DHCP_OVERLOAD_FILENAME 1 -#define DHCP_OVERLOAD_SVRNAME 2 -#define DHCP_OVERLOAD_BOTH 3 - -/// -/// The DHCP option structure. This structure extends the EFI_DHCP_OPTION -/// structure to support options longer than 255 bytes, such as classless route. -/// -typedef struct { - UINT8 Tag; - UINT16 Len; - UINT8 *Data; -} DHCP_OPTION; - -/// -/// Structures used to parse the DHCP options with RFC3396 support. -/// -typedef struct { - UINT8 Index; - UINT16 Offset; -} DHCP_OPTION_COUNT; - -typedef struct { - DHCP_OPTION_COUNT *OpCount; - DHCP_OPTION *Options; - UINT8 *Buf; -} DHCP_OPTION_CONTEXT; - -/// -/// The options that matters to DHCP driver itself. The user of -/// DHCP clients may be interested in other options, such as -/// classless route, who can parse the DHCP offer to get them. -/// -typedef struct { - IP4_ADDR NetMask; // DHCP4_TAG_NETMASK - IP4_ADDR Router; // DHCP4_TAG_ROUTER, only the first router is used - - // - // DHCP specific options - // - UINT8 DhcpType; // DHCP4_TAG_MSG_TYPE - UINT8 Overload; // DHCP4_TAG_OVERLOAD - IP4_ADDR ServerId; // DHCP4_TAG_SERVER_ID - UINT32 Lease; // DHCP4_TAG_LEASE - UINT32 T1; // DHCP4_TAG_T1 - UINT32 T2; // DHCP4_TAG_T2 -} DHCP_PARAMETER; - -/// -/// Structure used to describe and validate the format of DHCP options. -/// Type is the options' data type, such as DHCP_OPTION_INT8. MinOccur -/// is the minium occurance of this data type. MaxOccur is defined -/// similarly. If MaxOccur is -1, it means that there is no limit on the -/// maximum occurance. Alert tells whether DHCP client should further -/// inspect the option to parse DHCP_PARAMETER. -/// -typedef struct { - UINT8 Tag; - INTN Type; - INTN MinOccur; - INTN MaxOccur; - BOOLEAN Alert; -} DHCP_OPTION_FORMAT; - -typedef -EFI_STATUS -(*DHCP_CHECK_OPTION) ( - IN UINT8 Tag, - IN UINT8 Len, - IN UINT8 *Data, - IN VOID *Context - ); - -/** - Iterate through a DHCP message to visit each option. First inspect - all the options in the OPTION field. Then if overloaded, inspect - the options in FILENAME and SERVERNAME fields. One option may be - encoded in several places. See RFC 3396 Encoding Long Options in DHCP - - @param[in] Packet The DHCP packet to check the options for - @param[in] Check The callback function to be called for each option - found - @param[in] Context The opaque parameter for Check - - @retval EFI_SUCCESS The DHCP packet's options are well formated - @retval EFI_INVALID_PARAMETER The DHCP packet's options are not well formated - -**/ -EFI_STATUS -DhcpIterateOptions ( - IN EFI_DHCP4_PACKET *Packet, - IN DHCP_CHECK_OPTION Check OPTIONAL, - IN VOID *Context - ); - -/** - Validate the packet's options. If necessary, allocate - and fill in the interested parameters. - - @param[in] Packet The packet to validate the options - @param[out] Para The variable to save the DHCP parameters. - - @retval EFI_OUT_OF_RESOURCES Failed to allocate memory to validate the packet. - @retval EFI_INVALID_PARAMETER The options are mal-formated - @retval EFI_SUCCESS The options are parsed into OptionPoint - -**/ -EFI_STATUS -DhcpValidateOptions ( - IN EFI_DHCP4_PACKET *Packet, - OUT DHCP_PARAMETER **Para OPTIONAL - ); - -/** - Parse the options of a DHCP packet. It supports RFC 3396: Encoding - Long Options in DHCP. That is, it will combine all the option value - of all the occurances of each option. - A little bit of implemenation: - It adopts the "Key indexed counting" algorithm. First, it allocates - an array of 256 DHCP_OPTION_COUNTs because DHCP option tag is encoded - as a UINT8. It then iterates the DHCP packet to get data length of - each option by calling DhcpIterOptions with DhcpGetOptionLen. Now, it - knows the number of present options and their length. It allocates a - array of DHCP_OPTION and a continuous buffer after the array to put - all the options' data. Each option's data is pointed to by the Data - field in DHCP_OPTION structure. At last, it call DhcpIterateOptions - with DhcpFillOption to fill each option's data to its position in the - buffer. - - @param[in] Packet The DHCP packet to parse the options - @param[out] Count The number of valid dhcp options present in the - packet - @param[out] OptionPoint The array that contains the DHCP options. Caller - should free it. - - @retval EFI_NOT_FOUND Cannot find any option. - @retval EFI_OUT_OF_RESOURCES Failed to allocate memory to parse the packet. - @retval EFI_INVALID_PARAMETER The options are mal-formated - @retval EFI_SUCCESS The options are parsed into OptionPoint - -**/ -EFI_STATUS -DhcpParseOption ( - IN EFI_DHCP4_PACKET *Packet, - OUT INTN *Count, - OUT DHCP_OPTION **OptionPoint - ); - -/** - Append an option to the memory, if the option is longer than - 255 bytes, splits it into several options. - - @param[out] Buf The buffer to append the option to - @param[in] Tag The option's tag - @param[in] DataLen The length of the option's data - @param[in] Data The option's data - - @return The position to append the next option - -**/ -UINT8 * -DhcpAppendOption ( - OUT UINT8 *Buf, - IN UINT8 Tag, - IN UINT16 DataLen, - IN UINT8 *Data - ); - -/** - Build a new DHCP packet from a seed packet. Options may be deleted or - appended. The caller should free the NewPacket when finished using it. - - @param[in] SeedPacket The seed packet to start with - @param[in] DeleteCount The number of options to delete - @param[in] DeleteList The options to delete from the packet - @param[in] AppendCount The number of options to append - @param[in] AppendList The options to append to the packet - @param[out] NewPacket The new packet, allocated and built by this - function. - - @retval EFI_OUT_OF_RESOURCES Failed to allocate memory - @retval EFI_INVALID_PARAMETER The options in SeekPacket are mal-formated - @retval EFI_SUCCESS The packet is build. - -**/ -EFI_STATUS -DhcpBuild ( - IN EFI_DHCP4_PACKET *SeedPacket, - IN UINT32 DeleteCount, - IN UINT8 *DeleteList OPTIONAL, - IN UINT32 AppendCount, - IN EFI_DHCP4_PACKET_OPTION *AppendList[] OPTIONAL, - OUT EFI_DHCP4_PACKET **NewPacket - ); - -#endif diff --git a/MdeModulePkg/Universal/Network/DpcDxe/Dpc.c b/MdeModulePkg/Universal/Network/DpcDxe/Dpc.c deleted file mode 100644 index 8a490949dc..0000000000 --- a/MdeModulePkg/Universal/Network/DpcDxe/Dpc.c +++ /dev/null @@ -1,341 +0,0 @@ -/** @file - -Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -Module Name: - - Dpc.c - -Abstract: - - -**/ - -#include "Dpc.h" - -// -// Handle for the EFI_DPC_PROTOCOL instance -// -EFI_HANDLE mDpcHandle = NULL; - -// -// The EFI_DPC_PROTOCOL instances that is installed onto mDpcHandle -// -EFI_DPC_PROTOCOL mDpc = { - DpcQueueDpc, - DpcDispatchDpc -}; - -// -// Global variables used to meaasure the DPC Queue Depths -// -UINTN mDpcQueueDepth = 0; -UINTN mMaxDpcQueueDepth = 0; - -// -// Free list of DPC entries. As DPCs are queued, entries are removed from this -// free list. As DPC entries are dispatched, DPC entries are added to the free list. -// If the free list is empty and a DPC is queued, the free list is grown by allocating -// an additional set of DPC entries. -// -LIST_ENTRY mDpcEntryFreeList = INITIALIZE_LIST_HEAD_VARIABLE(mDpcEntryFreeList); - -// -// An array of DPC queues. A DPC queue is allocated for every leval EFI_TPL value. -// As DPCs are queued, they are added to the end of the linked list. -// As DPCs are dispatched, they are removed from the beginning of the linked list. -// -LIST_ENTRY mDpcQueue[TPL_HIGH_LEVEL + 1]; - -/** - Add a Deferred Procedure Call to the end of the DPC queue. - - @param This Protocol instance pointer. - @param DpcTpl The EFI_TPL that the DPC should be invoked. - @param DpcProcedure Pointer to the DPC's function. - @param DpcContext Pointer to the DPC's context. Passed to DpcProcedure - when DpcProcedure is invoked. - - @retval EFI_SUCCESS The DPC was queued. - @retval EFI_INVALID_PARAMETER DpcTpl is not a valid EFI_TPL. - @retval EFI_INVALID_PARAMETER DpcProcedure is NULL. - @retval EFI_OUT_OF_RESOURCES There are not enough resources available to - add the DPC to the queue. - -**/ -EFI_STATUS -EFIAPI -DpcQueueDpc ( - IN EFI_DPC_PROTOCOL *This, - IN EFI_TPL DpcTpl, - IN EFI_DPC_PROCEDURE DpcProcedure, - IN VOID *DpcContext OPTIONAL - ) -{ - EFI_STATUS ReturnStatus; - EFI_TPL OriginalTpl; - DPC_ENTRY *DpcEntry; - UINTN Index; - - // - // Make sure DpcTpl is valid - // - if (DpcTpl < TPL_APPLICATION || DpcTpl > TPL_HIGH_LEVEL) { - return EFI_INVALID_PARAMETER; - } - - // - // Make sure DpcProcedure is valid - // - if (DpcProcedure == NULL) { - return EFI_INVALID_PARAMETER; - } - - // - // Assume this function will succeed - // - ReturnStatus = EFI_SUCCESS; - - // - // Raise the TPL level to TPL_HIGH_LEVEL for DPC list operation and save the - // current TPL value so it can be restored when this function returns. - // - OriginalTpl = gBS->RaiseTPL (TPL_HIGH_LEVEL); - - // - // Check to see if there are any entries in the DPC free list - // - if (IsListEmpty (&mDpcEntryFreeList)) { - // - // If the current TPL is greater than TPL_NOTIFY, then memory allocations - // can not be performed, so the free list can not be expanded. In this case - // return EFI_OUT_OF_RESOURCES. - // - if (OriginalTpl > TPL_NOTIFY) { - ReturnStatus = EFI_OUT_OF_RESOURCES; - goto Done; - } - - // - // Add 64 DPC entries to the free list - // - for (Index = 0; Index < 64; Index++) { - // - // Lower the TPL level to perform a memory allocation - // - gBS->RestoreTPL (OriginalTpl); - - // - // Allocate a new DPC entry - // - DpcEntry = AllocatePool (sizeof (DPC_ENTRY)); - - // - // Raise the TPL level back to TPL_HIGH_LEVEL for DPC list operations - // - gBS->RaiseTPL (TPL_HIGH_LEVEL); - - // - // If the allocation of a DPC entry fails, and the free list is empty, - // then return EFI_OUT_OF_RESOURCES. - // - if (DpcEntry == NULL) { - if (IsListEmpty (&mDpcEntryFreeList)) { - ReturnStatus = EFI_OUT_OF_RESOURCES; - goto Done; - } - } - - // - // Add the newly allocated DPC entry to the DPC free list - // - InsertTailList (&mDpcEntryFreeList, &DpcEntry->ListEntry); - } - } - - // - // Retrieve the first node from the free list of DPCs - // - DpcEntry = (DPC_ENTRY *)(GetFirstNode (&mDpcEntryFreeList)); - - // - // Remove the first node from the free list of DPCs - // - RemoveEntryList (&DpcEntry->ListEntry); - - // - // Fill in the DPC entry with the DpcProcedure and DpcContext - // - DpcEntry->DpcProcedure = DpcProcedure; - DpcEntry->DpcContext = DpcContext; - - // - // Add the DPC entry to the end of the list for the specified DplTpl. - // - InsertTailList (&mDpcQueue[DpcTpl], &DpcEntry->ListEntry); - - // - // Increment the measured DPC queue depth across all TPLs - // - mDpcQueueDepth++; - - // - // Measure the maximum DPC queue depth across all TPLs - // - if (mDpcQueueDepth > mMaxDpcQueueDepth) { - mMaxDpcQueueDepth = mDpcQueueDepth; - } - -Done: - // - // Restore the original TPL level when this function was called - // - gBS->RestoreTPL (OriginalTpl); - - return ReturnStatus; -} - -/** - Dispatch the queue of DPCs. ALL DPCs that have been queued with a DpcTpl - value greater than or equal to the current TPL are invoked in the order that - they were queued. DPCs with higher DpcTpl values are invoked before DPCs with - lower DpcTpl values. - - @param This Protocol instance pointer. - - @retval EFI_SUCCESS One or more DPCs were invoked. - @retval EFI_NOT_FOUND No DPCs were invoked. - -**/ -EFI_STATUS -EFIAPI -DpcDispatchDpc ( - IN EFI_DPC_PROTOCOL *This - ) -{ - EFI_STATUS ReturnStatus; - EFI_TPL OriginalTpl; - EFI_TPL Tpl; - DPC_ENTRY *DpcEntry; - - // - // Assume that no DPCs will be invoked - // - ReturnStatus = EFI_NOT_FOUND; - - // - // Raise the TPL level to TPL_HIGH_LEVEL for DPC list operation and save the - // current TPL value so it can be restored when this function returns. - // - OriginalTpl = gBS->RaiseTPL (TPL_HIGH_LEVEL); - - // - // Check to see if there are 1 or more DPCs currently queued - // - if (mDpcQueueDepth > 0) { - // - // Loop from TPL_HIGH_LEVEL down to the current TPL value - // - for (Tpl = TPL_HIGH_LEVEL; Tpl >= OriginalTpl; Tpl--) { - // - // Check to see if the DPC queue is empty - // - while (!IsListEmpty (&mDpcQueue[Tpl])) { - // - // Retrieve the first DPC entry from the DPC queue specified by Tpl - // - DpcEntry = (DPC_ENTRY *)(GetFirstNode (&mDpcQueue[Tpl])); - - // - // Remove the first DPC entry from the DPC queue specified by Tpl - // - RemoveEntryList (&DpcEntry->ListEntry); - - // - // Decrement the measured DPC Queue Depth across all TPLs - // - mDpcQueueDepth--; - - // - // Lower the TPL to TPL value of the current DPC queue - // - gBS->RestoreTPL (Tpl); - - // - // Invoke the DPC passing in its context - // - (DpcEntry->DpcProcedure) (DpcEntry->DpcContext); - - // - // At least one DPC has been invoked, so set the return status to EFI_SUCCESS - // - ReturnStatus = EFI_SUCCESS; - - // - // Raise the TPL level back to TPL_HIGH_LEVEL for DPC list operations - // - gBS->RaiseTPL (TPL_HIGH_LEVEL); - - // - // Add the invoked DPC entry to the DPC free list - // - InsertTailList (&mDpcEntryFreeList, &DpcEntry->ListEntry); - } - } - } - - // - // Restore the original TPL level when this function was called - // - gBS->RestoreTPL (OriginalTpl); - - return ReturnStatus; -} - -/** - The entry point for DPC driver which installs the EFI_DPC_PROTOCOL onto a new handle. - - @param ImageHandle The image handle of the driver. - @param SystemTable The system table. - - @retval EFI_SUCCES The DPC queues were initialized and the EFI_DPC_PROTOCOL was - installed onto a new handle. - @retval Others Failed to install EFI_DPC_PROTOCOL. - -**/ -EFI_STATUS -EFIAPI -DpcDriverEntryPoint ( - IN EFI_HANDLE ImageHandle, - IN EFI_SYSTEM_TABLE *SystemTable - ) -{ - EFI_STATUS Status; - UINTN Index; - - // - // ASSERT() if the EFI_DPC_PROTOCOL is already present in the handle database - // - ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL, &gEfiDpcProtocolGuid); - - // - // Initialize the DPC queue for all possible TPL values - // - for (Index = 0; Index <= TPL_HIGH_LEVEL; Index++) { - InitializeListHead (&mDpcQueue[Index]); - } - - // - // Install the EFI_DPC_PROTOCOL instance onto a new handle - // - Status = gBS->InstallMultipleProtocolInterfaces ( - &mDpcHandle, - &gEfiDpcProtocolGuid, - &mDpc, - NULL - ); - ASSERT_EFI_ERROR (Status); - - return Status; -} diff --git a/MdeModulePkg/Universal/Network/DpcDxe/Dpc.h b/MdeModulePkg/Universal/Network/DpcDxe/Dpc.h deleted file mode 100644 index 2017a215e3..0000000000 --- a/MdeModulePkg/Universal/Network/DpcDxe/Dpc.h +++ /dev/null @@ -1,80 +0,0 @@ -/** @file - -Copyright (c) 2007, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -Module Name: - - Dpc.h - -Abstract: - - -**/ - -#ifndef _DPC_H_ -#define _DPC_H_ - -#include -#include -#include -#include -#include -#include -#include - -// -// Internal data struture for managing DPCs. A DPC entry is either on the free -// list or on a DPC queue at a specific EFI_TPL. -// -typedef struct { - LIST_ENTRY ListEntry; - EFI_DPC_PROCEDURE DpcProcedure; - VOID *DpcContext; -} DPC_ENTRY; - -/** - Add a Deferred Procedure Call to the end of the DPC queue. - - @param This Protocol instance pointer. - @param DpcTpl The EFI_TPL that the DPC should be invoked. - @param DpcProcedure Pointer to the DPC's function. - @param DpcContext Pointer to the DPC's context. Passed to DpcProcedure - when DpcProcedure is invoked. - - @retval EFI_SUCCESS The DPC was queued. - @retval EFI_INVALID_PARAMETER DpcTpl is not a valid EFI_TPL. - @retval EFI_INVALID_PARAMETER DpcProcedure is NULL. - @retval EFI_OUT_OF_RESOURCES There are not enough resources available to - add the DPC to the queue. - -**/ -EFI_STATUS -EFIAPI -DpcQueueDpc ( - IN EFI_DPC_PROTOCOL *This, - IN EFI_TPL DpcTpl, - IN EFI_DPC_PROCEDURE DpcProcedure, - IN VOID *DpcContext OPTIONAL - ); - -/** - Dispatch the queue of DPCs. ALL DPCs that have been queued with a DpcTpl - value greater than or equal to the current TPL are invoked in the order that - they were queued. DPCs with higher DpcTpl values are invoked before DPCs with - lower DpcTpl values. - - @param This Protocol instance pointer. - - @retval EFI_SUCCESS One or more DPCs were invoked. - @retval EFI_NOT_FOUND No DPCs were invoked. - -**/ -EFI_STATUS -EFIAPI -DpcDispatchDpc ( - IN EFI_DPC_PROTOCOL *This - ); - -#endif - diff --git a/MdeModulePkg/Universal/Network/DpcDxe/DpcDxe.inf b/MdeModulePkg/Universal/Network/DpcDxe/DpcDxe.inf deleted file mode 100644 index 8c241d7f46..0000000000 --- a/MdeModulePkg/Universal/Network/DpcDxe/DpcDxe.inf +++ /dev/null @@ -1,46 +0,0 @@ -## @file -# This module produces Deferred Procedure Call Protocol. -# -# Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
-# SPDX-License-Identifier: BSD-2-Clause-Patent -# -# -## - -[Defines] - INF_VERSION = 0x00010005 - BASE_NAME = DpcDxe - MODULE_UNI_FILE = DpcDxe.uni - FILE_GUID = A210F973-229D-4f4d-AA37-9895E6C9EABA - MODULE_TYPE = DXE_DRIVER - VERSION_STRING = 1.0 - ENTRY_POINT = DpcDriverEntryPoint - -# -# The following information is for reference only and not required by the build tools. -# -# VALID_ARCHITECTURES = IA32 X64 EBC -# - -[Sources] - Dpc.c - Dpc.h - -[Packages] - MdePkg/MdePkg.dec - MdeModulePkg/MdeModulePkg.dec - -[LibraryClasses] - UefiDriverEntryPoint - BaseLib - DebugLib - UefiBootServicesTableLib - MemoryAllocationLib - -[Protocols] - gEfiDpcProtocolGuid ## PRODUCES - -[Depex] - TRUE -[UserExtensions.TianoCore."ExtraFiles"] - DpcDxeExtra.uni diff --git a/MdeModulePkg/Universal/Network/DpcDxe/DpcDxe.uni b/MdeModulePkg/Universal/Network/DpcDxe/DpcDxe.uni deleted file mode 100644 index 34ad24b255..0000000000 --- a/MdeModulePkg/Universal/Network/DpcDxe/DpcDxe.uni +++ /dev/null @@ -1,16 +0,0 @@ -// /** @file -// This module produces Deferred Procedure Call Protocol. -// -// This module produces Deferred Procedure Call Protocol. -// -// Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
-// -// SPDX-License-Identifier: BSD-2-Clause-Patent -// -// **/ - - -#string STR_MODULE_ABSTRACT #language en-US "Produces Deferred Procedure Call Protocol" - -#string STR_MODULE_DESCRIPTION #language en-US "This module produces Deferred Procedure Call Protocol." - diff --git a/MdeModulePkg/Universal/Network/DpcDxe/DpcDxeExtra.uni b/MdeModulePkg/Universal/Network/DpcDxe/DpcDxeExtra.uni deleted file mode 100644 index 82a93190d6..0000000000 --- a/MdeModulePkg/Universal/Network/DpcDxe/DpcDxeExtra.uni +++ /dev/null @@ -1,14 +0,0 @@ -// /** @file -// DpcDxe Localized Strings and Content -// -// Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.
-// -// SPDX-License-Identifier: BSD-2-Clause-Patent -// -// **/ - -#string STR_PROPERTIES_MODULE_NAME -#language en-US -"Deferred Procedure Call DXE Driver" - - diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/ComponentName.c b/MdeModulePkg/Universal/Network/Ip4Dxe/ComponentName.c deleted file mode 100644 index 3461ab2a89..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/ComponentName.c +++ /dev/null @@ -1,428 +0,0 @@ -/** @file - -Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Ip4Impl.h" - -// -// EFI Component Name Functions -// -/** - Retrieves a Unicode string that is the user readable name of the driver. - - This function retrieves the user readable name of a driver in the form of a - Unicode string. If the driver specified by This has a user readable name in - the language specified by Language, then a pointer to the driver name is - returned in DriverName, and EFI_SUCCESS is returned. If the driver specified - by This does not support the language specified by Language, - then EFI_UNSUPPORTED is returned. - - @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param[in] Language A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified - in RFC 4646 or ISO 639-2 language code format. - - @param[out] DriverName A pointer to the Unicode string to return. - This Unicode string is the name of the - driver specified by This in the language - specified by Language. - - @retval EFI_SUCCESS The Unicode string for the Driver specified by - This and the language specified by Language was - returned in DriverName. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER DriverName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -Ip4ComponentNameGetDriverName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN CHAR8 *Language, - OUT CHAR16 **DriverName - ); - - -/** - Retrieves a Unicode string that is the user readable name of the controller - that is being managed by a driver. - - This function retrieves the user readable name of the controller specified by - ControllerHandle and ChildHandle in the form of a Unicode string. If the - driver specified by This has a user readable name in the language specified by - Language, then a pointer to the controller name is returned in ControllerName, - and EFI_SUCCESS is returned. If the driver specified by This is not currently - managing the controller specified by ControllerHandle and ChildHandle, - then EFI_UNSUPPORTED is returned. If the driver specified by This does not - support the language specified by Language, then EFI_UNSUPPORTED is returned. - - @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param[in] ControllerHandle The handle of a controller that the driver - specified by This is managing. This handle - specifies the controller whose name is to be - returned. - - @param[in] ChildHandle The handle of the child controller to retrieve - the name of. This is an optional parameter that - may be NULL. It will be NULL for device - drivers. It will also be NULL for a bus drivers - that wish to retrieve the name of the bus - controller. It will not be NULL for a bus - driver that wishes to retrieve the name of a - child controller. - - @param[in] Language A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified in - RFC 4646 or ISO 639-2 language code format. - - @param[out] ControllerName A pointer to the Unicode string to return. - This Unicode string is the name of the - controller specified by ControllerHandle and - ChildHandle in the language specified by - Language from the point of view of the driver - specified by This. - - @retval EFI_SUCCESS The Unicode string for the user readable name in - the language specified by Language for the - driver specified by This was returned in - DriverName. - - @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. - - @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid - EFI_HANDLE. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER ControllerName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This is not currently - managing the controller specified by - ControllerHandle and ChildHandle. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -Ip4ComponentNameGetControllerName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_HANDLE ChildHandle OPTIONAL, - IN CHAR8 *Language, - OUT CHAR16 **ControllerName - ); - - -// -// EFI Component Name Protocol -// -GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gIp4ComponentName = { - Ip4ComponentNameGetDriverName, - Ip4ComponentNameGetControllerName, - "eng" -}; - -// -// EFI Component Name 2 Protocol -// -GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gIp4ComponentName2 = { - (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) Ip4ComponentNameGetDriverName, - (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) Ip4ComponentNameGetControllerName, - "en" -}; - - -GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mIp4DriverNameTable[] = { - { - "eng;en", - L"IP4 Network Service Driver" - }, - { - NULL, - NULL - } -}; - -GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE *gIp4ControllerNameTable = NULL; - -/** - Retrieves a Unicode string that is the user readable name of the driver. - - This function retrieves the user readable name of a driver in the form of a - Unicode string. If the driver specified by This has a user readable name in - the language specified by Language, then a pointer to the driver name is - returned in DriverName, and EFI_SUCCESS is returned. If the driver specified - by This does not support the language specified by Language, - then EFI_UNSUPPORTED is returned. - - @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param[in] Language A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified - in RFC 4646 or ISO 639-2 language code format. - - @param[out] DriverName A pointer to the Unicode string to return. - This Unicode string is the name of the - driver specified by This in the language - specified by Language. - - @retval EFI_SUCCESS The Unicode string for the Driver specified by - This and the language specified by Language was - returned in DriverName. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER DriverName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -Ip4ComponentNameGetDriverName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN CHAR8 *Language, - OUT CHAR16 **DriverName - ) -{ - return LookupUnicodeString2 ( - Language, - This->SupportedLanguages, - mIp4DriverNameTable, - DriverName, - (BOOLEAN)(This == &gIp4ComponentName) - ); - -} - -/** - Update the component name for the IP4 child handle. - - @param Ip4[in] A pointer to the EFI_IP4_PROTOCOL. - - - @retval EFI_SUCCESS Update the ControllerNameTable of this instance successfully. - @retval EFI_INVALID_PARAMETER The input parameter is invalid. - -**/ -EFI_STATUS -UpdateName ( - IN EFI_IP4_PROTOCOL *Ip4 - ) -{ - EFI_STATUS Status; - CHAR16 HandleName[80]; - EFI_IP4_MODE_DATA Ip4ModeData; - - if (Ip4 == NULL) { - return EFI_INVALID_PARAMETER; - } - - // - // Format the child name into the string buffer as: - // IPv4 (SrcIP=127.0.0.1, DestIP=127.0.0.1) - // - Status = Ip4->GetModeData (Ip4, &Ip4ModeData, NULL, NULL); - if (EFI_ERROR (Status)) { - return Status; - } - - if (!Ip4ModeData.IsStarted || !Ip4ModeData.IsConfigured) { - UnicodeSPrint (HandleName, sizeof (HandleName), L"IPv4 (Not started)"); - } else { - UnicodeSPrint (HandleName, sizeof (HandleName), - L"IPv4 (SrcIP=%d.%d.%d.%d)", - Ip4ModeData.ConfigData.StationAddress.Addr[0], - Ip4ModeData.ConfigData.StationAddress.Addr[1], - Ip4ModeData.ConfigData.StationAddress.Addr[2], - Ip4ModeData.ConfigData.StationAddress.Addr[3] - ); - } - - if (gIp4ControllerNameTable != NULL) { - FreeUnicodeStringTable (gIp4ControllerNameTable); - gIp4ControllerNameTable = NULL; - } - Status = AddUnicodeString2 ( - "eng", - gIp4ComponentName.SupportedLanguages, - &gIp4ControllerNameTable, - HandleName, - TRUE - ); - if (EFI_ERROR (Status)) { - return Status; - } - - return AddUnicodeString2 ( - "en", - gIp4ComponentName2.SupportedLanguages, - &gIp4ControllerNameTable, - HandleName, - FALSE - ); -} - -/** - Retrieves a Unicode string that is the user readable name of the controller - that is being managed by a driver. - - This function retrieves the user readable name of the controller specified by - ControllerHandle and ChildHandle in the form of a Unicode string. If the - driver specified by This has a user readable name in the language specified by - Language, then a pointer to the controller name is returned in ControllerName, - and EFI_SUCCESS is returned. If the driver specified by This is not currently - managing the controller specified by ControllerHandle and ChildHandle, - then EFI_UNSUPPORTED is returned. If the driver specified by This does not - support the language specified by Language, then EFI_UNSUPPORTED is returned. - - @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param[in] ControllerHandle The handle of a controller that the driver - specified by This is managing. This handle - specifies the controller whose name is to be - returned. - - @param[in] ChildHandle The handle of the child controller to retrieve - the name of. This is an optional parameter that - may be NULL. It will be NULL for device - drivers. It will also be NULL for a bus drivers - that wish to retrieve the name of the bus - controller. It will not be NULL for a bus - driver that wishes to retrieve the name of a - child controller. - - @param[in] Language A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified in - RFC 4646 or ISO 639-2 language code format. - - @param[out] ControllerName A pointer to the Unicode string to return. - This Unicode string is the name of the - controller specified by ControllerHandle and - ChildHandle in the language specified by - Language from the point of view of the driver - specified by This. - - @retval EFI_SUCCESS The Unicode string for the user readable name in - the language specified by Language for the - driver specified by This was returned in - DriverName. - - @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. - - @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid - EFI_HANDLE. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER ControllerName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This is not currently - managing the controller specified by - ControllerHandle and ChildHandle. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -Ip4ComponentNameGetControllerName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_HANDLE ChildHandle OPTIONAL, - IN CHAR8 *Language, - OUT CHAR16 **ControllerName - ) -{ - EFI_STATUS Status; - EFI_IP4_PROTOCOL *Ip4; - - // - // Only provide names for child handles. - // - if (ChildHandle == NULL) { - return EFI_UNSUPPORTED; - } - - // - // Make sure this driver produced ChildHandle - // - Status = EfiTestChildHandle ( - ControllerHandle, - ChildHandle, - &gEfiManagedNetworkProtocolGuid - ); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Retrieve an instance of a produced protocol from ChildHandle - // - Status = gBS->OpenProtocol ( - ChildHandle, - &gEfiIp4ProtocolGuid, - (VOID **)&Ip4, - NULL, - NULL, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Update the component name for this child handle. - // - Status = UpdateName (Ip4); - if (EFI_ERROR (Status)) { - return Status; - } - - return LookupUnicodeString2 ( - Language, - This->SupportedLanguages, - gIp4ControllerNameTable, - ControllerName, - (BOOLEAN)(This == &gIp4ComponentName) - ); -} - diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Common.c b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Common.c deleted file mode 100644 index c756a2dbf7..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Common.c +++ /dev/null @@ -1,306 +0,0 @@ -/** @file - -Copyright (c) 2005 - 2017, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Ip4Impl.h" - - -/** - Return the cast type (Unicast/Boradcast) specific to an - interface. All the addresses are host byte ordered. - - @param[in] IpAddr The IP address to classify in host byte order - @param[in] IpIf The interface that IpAddr received from - - @return The cast type of this IP address specific to the interface. - @retval IP4_LOCAL_HOST The IpAddr equals to the interface's address - @retval IP4_SUBNET_BROADCAST The IpAddr is a directed subnet boradcast to the - interface - @retval IP4_NET_BROADCAST The IpAddr is a network broadcast to the interface - @retval 0 Otherwise. - -**/ -INTN -Ip4GetNetCast ( - IN IP4_ADDR IpAddr, - IN IP4_INTERFACE *IpIf - ) -{ - if (IpAddr == IpIf->Ip) { - return IP4_LOCAL_HOST; - - } else if (IpAddr == IpIf->SubnetBrdcast) { - return IP4_SUBNET_BROADCAST; - - } else if (IpAddr == IpIf->NetBrdcast) { - return IP4_NET_BROADCAST; - - } - - return 0; -} - - -/** - Find the cast type of the packet related to the local host. - This isn't the same as link layer cast type. For example, DHCP - server may send local broadcast to the local unicast MAC. - - @param[in] IpSb The IP4 service binding instance that received the - packet - @param[in] Dst The destination address in the packet (host byte - order) - @param[in] Src The source address in the packet (host byte order) - - @return The cast type for the Dst, it will return on the first non-promiscuous - cast type to a configured interface. If the packet doesn't match any of - the interface, multicast address and local broadcast address are checked. - -**/ -INTN -Ip4GetHostCast ( - IN IP4_SERVICE *IpSb, - IN IP4_ADDR Dst, - IN IP4_ADDR Src - ) -{ - LIST_ENTRY *Entry; - IP4_INTERFACE *IpIf; - INTN Type; - INTN Class; - - Type = 0; - - if (IpSb->MnpConfigData.EnablePromiscuousReceive) { - Type = IP4_PROMISCUOUS; - } - - // - // Go through the interface list of the IP service, most likely. - // - NET_LIST_FOR_EACH (Entry, &IpSb->Interfaces) { - IpIf = NET_LIST_USER_STRUCT (Entry, IP4_INTERFACE, Link); - - // - // Skip the unconfigured interface and invalid source address: - // source address can't be broadcast. - // - if (!IpIf->Configured || IP4_IS_BROADCAST (Ip4GetNetCast (Src, IpIf))) { - continue; - } - - if ((Class = Ip4GetNetCast (Dst, IpIf)) > Type) { - return Class; - } - } - - // - // If it is local broadcast address. The source address must - // be a unicast address on one of the direct connected network. - // If it is a multicast address, accept it only if we are in - // the group. - // - if (Dst == IP4_ALLONE_ADDRESS) { - IpIf = Ip4FindNet (IpSb, Src); - - if (IpIf != NULL && !IP4_IS_BROADCAST (Ip4GetNetCast (Src, IpIf))) { - return IP4_LOCAL_BROADCAST; - } - - } else if (IP4_IS_MULTICAST (Dst) && Ip4FindGroup (&IpSb->IgmpCtrl, Dst) != NULL) { - return IP4_MULTICAST; - } - - return Type; -} - - -/** - Find an interface whose configured IP address is Ip. - - @param[in] IpSb The IP4 service binding instance - @param[in] Ip The Ip address (host byte order) to find - - @return The IP4_INTERFACE point if found, otherwise NULL - -**/ -IP4_INTERFACE * -Ip4FindInterface ( - IN IP4_SERVICE *IpSb, - IN IP4_ADDR Ip - ) -{ - LIST_ENTRY *Entry; - IP4_INTERFACE *IpIf; - - NET_LIST_FOR_EACH (Entry, &IpSb->Interfaces) { - IpIf = NET_LIST_USER_STRUCT (Entry, IP4_INTERFACE, Link); - - if (IpIf->Configured && (IpIf->Ip == Ip)) { - return IpIf; - } - } - - return NULL; -} - - -/** - Find an interface that Ip is on that connected network. - - @param[in] IpSb The IP4 service binding instance - @param[in] Ip The Ip address (host byte order) to find - - @return The IP4_INTERFACE point if found, otherwise NULL - -**/ -IP4_INTERFACE * -Ip4FindNet ( - IN IP4_SERVICE *IpSb, - IN IP4_ADDR Ip - ) -{ - LIST_ENTRY *Entry; - IP4_INTERFACE *IpIf; - - NET_LIST_FOR_EACH (Entry, &IpSb->Interfaces) { - IpIf = NET_LIST_USER_STRUCT (Entry, IP4_INTERFACE, Link); - - if (IpIf->Configured && IP4_NET_EQUAL (Ip, IpIf->Ip, IpIf->SubnetMask)) { - return IpIf; - } - } - - return NULL; -} - - -/** - Find an interface of the service with the same Ip/Netmask pair. - - @param[in] IpSb Ip4 service binding instance - @param[in] Ip The Ip adress to find (host byte order) - @param[in] Netmask The network to find (host byte order) - - @return The IP4_INTERFACE point if found, otherwise NULL - -**/ -IP4_INTERFACE * -Ip4FindStationAddress ( - IN IP4_SERVICE *IpSb, - IN IP4_ADDR Ip, - IN IP4_ADDR Netmask - ) -{ - LIST_ENTRY *Entry; - IP4_INTERFACE *IpIf; - - NET_LIST_FOR_EACH (Entry, &IpSb->Interfaces) { - IpIf = NET_LIST_USER_STRUCT (Entry, IP4_INTERFACE, Link); - - if (IpIf->Configured && (IpIf->Ip == Ip) && (IpIf->SubnetMask == Netmask)) { - return IpIf; - } - } - - return NULL; -} - - -/** - Get the MAC address for a multicast IP address. Call - Mnp's McastIpToMac to find the MAC address in stead of - hard code the NIC to be Ethernet. - - @param[in] Mnp The Mnp instance to get the MAC address. - @param[in] Multicast The multicast IP address to translate. - @param[out] Mac The buffer to hold the translated address. - - @retval EFI_SUCCESS if the multicast IP is successfully translated to a - multicast MAC address. - @retval other Otherwise some error. - -**/ -EFI_STATUS -Ip4GetMulticastMac ( - IN EFI_MANAGED_NETWORK_PROTOCOL *Mnp, - IN IP4_ADDR Multicast, - OUT EFI_MAC_ADDRESS *Mac - ) -{ - EFI_IP_ADDRESS EfiIp; - - EFI_IP4 (EfiIp.v4) = HTONL (Multicast); - return Mnp->McastIpToMac (Mnp, FALSE, &EfiIp, Mac); -} - - -/** - Convert the multibyte field in IP header's byter order. - In spite of its name, it can also be used to convert from - host to network byte order. - - @param[in] Head The IP head to convert - - @return Point to the converted IP head - -**/ -IP4_HEAD * -Ip4NtohHead ( - IN IP4_HEAD *Head - ) -{ - Head->TotalLen = NTOHS (Head->TotalLen); - Head->Id = NTOHS (Head->Id); - Head->Fragment = NTOHS (Head->Fragment); - Head->Src = NTOHL (Head->Src); - Head->Dst = NTOHL (Head->Dst); - - return Head; -} - - -/** - Validate that Ip/Netmask pair is OK to be used as station - address. Only continuous netmasks are supported. and check - that StationAddress is a unicast address on the newtwork. - - @param[in] Ip The IP address to validate. - @param[in] Netmask The netmaks of the IP. - - @retval TRUE The Ip/Netmask pair is valid. - @retval FALSE The Ip/Netmask pair is invalid. - -**/ -BOOLEAN -Ip4StationAddressValid ( - IN IP4_ADDR Ip, - IN IP4_ADDR Netmask - ) -{ - // - // Only support the station address with 0.0.0.0/0 to enable DHCP client. - // - if (Netmask == IP4_ALLZERO_ADDRESS) { - return (BOOLEAN) (Ip == IP4_ALLZERO_ADDRESS); - } - - // - // Only support the continuous net masks - // - if (NetGetMaskLength (Netmask) == (IP4_MASK_MAX + 1)) { - return FALSE; - } - - // - // Station address can't be class D or class E address - // - if (NetGetIpClass (Ip) > IP4_ADDR_CLASSC) { - return FALSE; - } - - return NetIp4IsUnicast (Ip, Netmask); -} diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Common.h b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Common.h deleted file mode 100644 index 8fbfd54872..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Common.h +++ /dev/null @@ -1,217 +0,0 @@ -/** @file - Common definition for IP4. - -Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef __EFI_IP4_COMMON_H__ -#define __EFI_IP4_COMMON_H__ - -typedef struct _IP4_INTERFACE IP4_INTERFACE; -typedef struct _IP4_PROTOCOL IP4_PROTOCOL; -typedef struct _IP4_SERVICE IP4_SERVICE; - -#define IP4_ETHER_PROTO 0x0800 - -// -// The packet is received as link level broadcast/multicast/promiscuous. -// -#define IP4_LINK_BROADCAST 0x00000001 -#define IP4_LINK_MULTICAST 0x00000002 -#define IP4_LINK_PROMISC 0x00000004 - -// -// IP4 address cast type classfication. Keep it true that any -// type bigger than or equal to LOCAL_BROADCAST is broadcast. -// -#define IP4_PROMISCUOUS 1 -#define IP4_LOCAL_HOST 2 -#define IP4_MULTICAST 3 -#define IP4_LOCAL_BROADCAST 4 // Destination is 255.255.255.255 -#define IP4_SUBNET_BROADCAST 5 -#define IP4_NET_BROADCAST 6 - -// -// IP4 header flags -// -#define IP4_HEAD_DF_MASK 0x4000 -#define IP4_HEAD_MF_MASK 0x2000 -#define IP4_HEAD_OFFSET_MASK 0x1fff - -#define IP4_ALLZERO_ADDRESS 0x00000000u -#define IP4_ALLONE_ADDRESS 0xFFFFFFFFu -#define IP4_ALLSYSTEM_ADDRESS 0xE0000001u -#define IP4_ALLROUTER_ADDRESS 0xE0000002u - -/// -/// Compose the fragment field to be used in the IP4 header. -/// -#define IP4_HEAD_FRAGMENT_FIELD(Df, Mf, Offset) \ - ((UINT16)(((Df) ? IP4_HEAD_DF_MASK : 0) | ((Mf) ? IP4_HEAD_MF_MASK : 0) | (((Offset) >> 3) & IP4_HEAD_OFFSET_MASK))) - -#define IP4_LAST_FRAGMENT(FragmentField) \ - (((FragmentField) & IP4_HEAD_MF_MASK) == 0) - -#define IP4_FIRST_FRAGMENT(FragmentField) \ - ((BOOLEAN)(((FragmentField) & IP4_HEAD_OFFSET_MASK) == 0)) - -#define IP4_DO_NOT_FRAGMENT(FragmentField) \ - ((BOOLEAN)(((FragmentField) & IP4_HEAD_DF_MASK) == IP4_HEAD_DF_MASK)) - -#define IP4_IS_BROADCAST(CastType) ((CastType) >= IP4_LOCAL_BROADCAST) - -/// -/// Conver the Microsecond to second. IP transmit/receive time is -/// in the unit of microsecond. IP ticks once per second. -/// -#define IP4_US_TO_SEC(Us) (((Us) + 999999) / 1000000) - -/** - Return the cast type (Unicast/Boradcast) specific to an - interface. All the addresses are host byte ordered. - - @param[in] IpAddr The IP address to classify in host byte order - @param[in] IpIf The interface that IpAddr received from - - @return The cast type of this IP address specific to the interface. - @retval IP4_LOCAL_HOST The IpAddr equals to the interface's address - @retval IP4_SUBNET_BROADCAST The IpAddr is a directed subnet boradcast to the - interface - @retval IP4_NET_BROADCAST The IpAddr is a network broadcast to the interface - @retval 0 Otherwise. - -**/ -INTN -Ip4GetNetCast ( - IN IP4_ADDR IpAddr, - IN IP4_INTERFACE *IpIf - ); - -/** - Find the cast type of the packet related to the local host. - This isn't the same as link layer cast type. For example, DHCP - server may send local broadcast to the local unicast MAC. - - @param[in] IpSb The IP4 service binding instance that received the - packet - @param[in] Dst The destination address in the packet (host byte - order) - @param[in] Src The source address in the packet (host byte order) - - @return The cast type for the Dst, it will return on the first non-promiscuous - cast type to a configured interface. If the packet doesn't match any of - the interface, multicast address and local broadcast address are checked. - -**/ -INTN -Ip4GetHostCast ( - IN IP4_SERVICE *IpSb, - IN IP4_ADDR Dst, - IN IP4_ADDR Src - ); - -/** - Find an interface whose configured IP address is Ip. - - @param[in] IpSb The IP4 service binding instance - @param[in] Ip The Ip address (host byte order) to find - - @return The IP4_INTERFACE point if found, otherwise NULL - -**/ -IP4_INTERFACE * -Ip4FindInterface ( - IN IP4_SERVICE *IpSb, - IN IP4_ADDR Ip - ); - -/** - Find an interface that Ip is on that connected network. - - @param[in] IpSb The IP4 service binding instance - @param[in] Ip The Ip address (host byte order) to find - - @return The IP4_INTERFACE point if found, otherwise NULL - -**/ -IP4_INTERFACE * -Ip4FindNet ( - IN IP4_SERVICE *IpSb, - IN IP4_ADDR Ip - ); - -/** - Find an interface of the service with the same Ip/Netmask pair. - - @param[in] IpSb Ip4 service binding instance - @param[in] Ip The Ip adress to find (host byte order) - @param[in] Netmask The network to find (host byte order) - - @return The IP4_INTERFACE point if found, otherwise NULL - -**/ -IP4_INTERFACE * -Ip4FindStationAddress ( - IN IP4_SERVICE *IpSb, - IN IP4_ADDR Ip, - IN IP4_ADDR Netmask - ); - -/** - Get the MAC address for a multicast IP address. Call - Mnp's McastIpToMac to find the MAC address in stead of - hard code the NIC to be Ethernet. - - @param[in] Mnp The Mnp instance to get the MAC address. - @param[in] Multicast The multicast IP address to translate. - @param[out] Mac The buffer to hold the translated address. - - @retval EFI_SUCCESS if the multicast IP is successfully translated to a - multicast MAC address. - @retval other Otherwise some error. - -**/ -EFI_STATUS -Ip4GetMulticastMac ( - IN EFI_MANAGED_NETWORK_PROTOCOL *Mnp, - IN IP4_ADDR Multicast, - OUT EFI_MAC_ADDRESS *Mac - ); - -/** - Convert the multibyte field in IP header's byter order. - In spite of its name, it can also be used to convert from - host to network byte order. - - @param[in] Head The IP head to convert - - @return Point to the converted IP head - -**/ -IP4_HEAD * -Ip4NtohHead ( - IN IP4_HEAD *Head - ); - - -/** - Validate that Ip/Netmask pair is OK to be used as station - address. Only continuous netmasks are supported. and check - that StationAddress is a unicast address on the newtwork. - - @param[in] Ip The IP address to validate. - @param[in] Netmask The netmaks of the IP. - - @retval TRUE The Ip/Netmask pair is valid. - @retval FALSE The Ip/Netmask pair is invalid. - -**/ -BOOLEAN -Ip4StationAddressValid ( - IN IP4_ADDR Ip, - IN IP4_ADDR Netmask - ); - -#endif diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Config2.vfr b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Config2.vfr deleted file mode 100644 index d85a99180e..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Config2.vfr +++ /dev/null @@ -1,94 +0,0 @@ -/** @file - Vfr file for IP4Dxe. - -Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ -#include "Ip4NvData.h" - -#define EFI_NETWORK_DEVICE_CLASS 0x04 - -formset - guid = IP4_CONFIG2_NVDATA_GUID, - title = STRING_TOKEN(STR_IP4_CONFIG2_FORM_TITLE), - help = STRING_TOKEN(STR_IP4_CONFIG2_FORM_HELP), - class = EFI_NETWORK_DEVICE_CLASS, - subclass = 0x03, - - varstore IP4_CONFIG2_IFR_NVDATA, - name = IP4_CONFIG2_IFR_NVDATA, - guid = IP4_CONFIG2_NVDATA_GUID; - - form formid = FORMID_MAIN_FORM, - title = STRING_TOKEN(STR_IP4_DEVICE_FORM_TITLE); - - checkbox varid = IP4_CONFIG2_IFR_NVDATA.Configure, - prompt = STRING_TOKEN(STR_IP4_CONFIGURE), - help = STRING_TOKEN(STR_IP4_CONFIGURE_HELP), - flags = INTERACTIVE, - key = KEY_ENABLE, - endcheckbox; - - suppressif ideqval IP4_CONFIG2_IFR_NVDATA.Configure == 0x00; - - checkbox varid = IP4_CONFIG2_IFR_NVDATA.DhcpEnable, - prompt = STRING_TOKEN(STR_IP4_ENABLE_DHCP), - help = STRING_TOKEN(STR_IP4_ENABLE_DHCP), - flags = INTERACTIVE, - key = KEY_DHCP_ENABLE, - endcheckbox; - endif; - - suppressif ideqval IP4_CONFIG2_IFR_NVDATA.DhcpEnable == 0x01 OR ideqval IP4_CONFIG2_IFR_NVDATA.Configure == 0x00; - - string varid = IP4_CONFIG2_IFR_NVDATA.StationAddress, - prompt = STRING_TOKEN(STR_IP4_LOCAL_IP_ADDRESS), - help = STRING_TOKEN(STR_IP4_IP_ADDRESS_HELP), - flags = INTERACTIVE, - key = KEY_LOCAL_IP, - minsize = IP_MIN_SIZE, - maxsize = IP_MAX_SIZE, - endstring; - - string varid = IP4_CONFIG2_IFR_NVDATA.SubnetMask, - prompt = STRING_TOKEN(STR_IP4_LOCAL_MASK), - help = STRING_TOKEN(STR_IP4_MASK_HELP), - flags = INTERACTIVE, - key = KEY_SUBNET_MASK, - minsize = IP_MIN_SIZE, - maxsize = IP_MAX_SIZE, - endstring; - - string varid = IP4_CONFIG2_IFR_NVDATA.GatewayAddress, - prompt = STRING_TOKEN(STR_IP4_LOCAL_GATEWAY), - help = STRING_TOKEN(STR_IP4_GATEWAY_HELP), - flags = INTERACTIVE, - key = KEY_GATE_WAY, - minsize = IP_MIN_SIZE, - maxsize = IP_MAX_SIZE, - endstring; - - string varid = IP4_CONFIG2_IFR_NVDATA.DnsAddress, - prompt = STRING_TOKEN(STR_IP4_LOCAL_DNS), - help = STRING_TOKEN(STR_IP4_DNS_HELP), - flags = INTERACTIVE, - key = KEY_DNS, - minsize = IP_MIN_SIZE, - maxsize = ADDRESS_STR_MAX_SIZE, - endstring; - - endif; - - subtitle text = STRING_TOKEN(STR_NULL); - - text - help = STRING_TOKEN(STR_SAVE_CHANGES), - text = STRING_TOKEN(STR_SAVE_CHANGES), - flags = INTERACTIVE, - key = KEY_SAVE_CHANGES; - - endform; - -endformset; - diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Config2Impl.c b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Config2Impl.c deleted file mode 100644 index 9dca48ddd6..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Config2Impl.c +++ /dev/null @@ -1,2168 +0,0 @@ -/** @file - The implementation of EFI IPv4 Configuration II Protocol. - - Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.
- (C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP
- - SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Ip4Impl.h" - -LIST_ENTRY mIp4Config2InstanceList = {&mIp4Config2InstanceList, &mIp4Config2InstanceList}; - -/** - The event process routine when the DHCPv4 service binding protocol is installed - in the system. - - @param[in] Event Not used. - @param[in] Context Pointer to the IP4 config2 instance data. - -**/ -VOID -EFIAPI -Ip4Config2OnDhcp4SbInstalled ( - IN EFI_EVENT Event, - IN VOID *Context - ); - -/** - Destroy the Dhcp4 child in IP4_CONFIG2_INSTANCE and release the resources. - - @param[in, out] Instance The buffer of IP4 config2 instance to be freed. - - @retval EFI_SUCCESS The child was successfully destroyed. - @retval Others Failed to destroy the child. - -**/ -EFI_STATUS -Ip4Config2DestroyDhcp4 ( - IN OUT IP4_CONFIG2_INSTANCE *Instance - ) -{ - IP4_SERVICE *IpSb; - EFI_STATUS Status; - EFI_DHCP4_PROTOCOL *Dhcp4; - - Dhcp4 = Instance->Dhcp4; - ASSERT (Dhcp4 != NULL); - - Dhcp4->Stop (Dhcp4); - Dhcp4->Configure (Dhcp4, NULL); - Instance->Dhcp4 = NULL; - - IpSb = IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance); - - // - // Close DHCPv4 protocol and destroy the child. - // - Status = gBS->CloseProtocol ( - Instance->Dhcp4Handle, - &gEfiDhcp4ProtocolGuid, - IpSb->Image, - IpSb->Controller - ); - if (EFI_ERROR (Status)) { - return Status; - } - - Status = NetLibDestroyServiceChild ( - IpSb->Controller, - IpSb->Image, - &gEfiDhcp4ServiceBindingProtocolGuid, - Instance->Dhcp4Handle - ); - - Instance->Dhcp4Handle = NULL; - - return Status; -} - -/** - Update the current policy to NewPolicy. During the transition - period, the default router list - and address list in all interfaces will be released. - - @param[in] IpSb The IP4 service binding instance. - @param[in] NewPolicy The new policy to be updated to. - -**/ -VOID -Ip4Config2OnPolicyChanged ( - IN IP4_SERVICE *IpSb, - IN EFI_IP4_CONFIG2_POLICY NewPolicy - ) -{ - IP4_INTERFACE *IpIf; - IP4_ROUTE_TABLE *RouteTable; - - // - // Currently there are only two policies: static and dhcp. Regardless of - // what transition is going on, i.e., static -> dhcp and dhcp -> - // static, we have to free default router table and all addresses. - // - - if (IpSb->DefaultInterface != NULL) { - if (IpSb->DefaultRouteTable != NULL) { - Ip4FreeRouteTable (IpSb->DefaultRouteTable); - IpSb->DefaultRouteTable = NULL; - } - - Ip4CancelReceive (IpSb->DefaultInterface); - - Ip4FreeInterface (IpSb->DefaultInterface, NULL); - IpSb->DefaultInterface = NULL; - } - - Ip4CleanAssembleTable (&IpSb->Assemble); - - // - // Create new default interface and route table. - // - IpIf = Ip4CreateInterface (IpSb->Mnp, IpSb->Controller, IpSb->Image); - if (IpIf == NULL) { - return ; - } - - RouteTable = Ip4CreateRouteTable (); - if (RouteTable == NULL) { - Ip4FreeInterface (IpIf, NULL); - return ; - } - - IpSb->DefaultInterface = IpIf; - InsertHeadList (&IpSb->Interfaces, &IpIf->Link); - IpSb->DefaultRouteTable = RouteTable; - Ip4ReceiveFrame (IpIf, NULL, Ip4AccpetFrame, IpSb); - - if (IpSb->State == IP4_SERVICE_CONFIGED || IpSb->State == IP4_SERVICE_STARTED) { - IpSb->State = IP4_SERVICE_UNSTARTED; - } - - // - // Start the dhcp configuration. - // - if (NewPolicy == Ip4Config2PolicyDhcp) { - Ip4StartAutoConfig (&IpSb->Ip4Config2Instance); - } - -} - -/** - Signal the registered event. It is the callback routine for NetMapIterate. - - @param[in] Map Points to the list of registered event. - @param[in] Item The registered event. - @param[in] Arg Not used. - - @retval EFI_SUCCESS The event was signaled successfully. -**/ -EFI_STATUS -EFIAPI -Ip4Config2SignalEvent ( - IN NET_MAP *Map, - IN NET_MAP_ITEM *Item, - IN VOID *Arg - ) -{ - gBS->SignalEvent ((EFI_EVENT) Item->Key); - - return EFI_SUCCESS; -} - -/** - Read the configuration data from variable storage according to the VarName and - gEfiIp4Config2ProtocolGuid. It checks the integrity of variable data. If the - data is corrupted, it clears the variable data to ZERO. Othewise, it outputs the - configuration data to IP4_CONFIG2_INSTANCE. - - @param[in] VarName The pointer to the variable name - @param[in, out] Instance The pointer to the IP4 config2 instance data. - - @retval EFI_NOT_FOUND The variable can not be found or already corrupted. - @retval EFI_OUT_OF_RESOURCES Fail to allocate resource to complete the operation. - @retval EFI_SUCCESS The configuration data was retrieved successfully. - -**/ -EFI_STATUS -Ip4Config2ReadConfigData ( - IN CHAR16 *VarName, - IN OUT IP4_CONFIG2_INSTANCE *Instance - ) -{ - EFI_STATUS Status; - UINTN VarSize; - IP4_CONFIG2_VARIABLE *Variable; - IP4_CONFIG2_DATA_ITEM *DataItem; - UINTN Index; - IP4_CONFIG2_DATA_RECORD DataRecord; - CHAR8 *Data; - - // - // Try to read the configuration variable. - // - VarSize = 0; - Status = gRT->GetVariable ( - VarName, - &gEfiIp4Config2ProtocolGuid, - NULL, - &VarSize, - NULL - ); - - if (Status == EFI_BUFFER_TOO_SMALL) { - // - // Allocate buffer and read the config variable. - // - Variable = AllocatePool (VarSize); - if (Variable == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - Status = gRT->GetVariable ( - VarName, - &gEfiIp4Config2ProtocolGuid, - NULL, - &VarSize, - Variable - ); - if (EFI_ERROR (Status) || (UINT16) (~NetblockChecksum ((UINT8 *) Variable, (UINT32) VarSize)) != 0) { - // - // GetVariable still error or the variable is corrupted. - // Fall back to the default value. - // - FreePool (Variable); - - // - // Remove the problematic variable and return EFI_NOT_FOUND, a new - // variable will be set again. - // - gRT->SetVariable ( - VarName, - &gEfiIp4Config2ProtocolGuid, - IP4_CONFIG2_VARIABLE_ATTRIBUTE, - 0, - NULL - ); - - return EFI_NOT_FOUND; - } - - - for (Index = 0; Index < Variable->DataRecordCount; Index++) { - - CopyMem (&DataRecord, &Variable->DataRecord[Index], sizeof (DataRecord)); - - DataItem = &Instance->DataItem[DataRecord.DataType]; - if (DATA_ATTRIB_SET (DataItem->Attribute, DATA_ATTRIB_SIZE_FIXED) && - (DataItem->DataSize != DataRecord.DataSize) - ) { - // - // Perhaps a corrupted data record... - // - continue; - } - - if (!DATA_ATTRIB_SET (DataItem->Attribute, DATA_ATTRIB_SIZE_FIXED)) { - // - // This data item has variable length data. - // - DataItem->Data.Ptr = AllocatePool (DataRecord.DataSize); - if (DataItem->Data.Ptr == NULL) { - // - // no memory resource - // - continue; - } - } - - Data = (CHAR8 *) Variable + DataRecord.Offset; - CopyMem (DataItem->Data.Ptr, Data, DataRecord.DataSize); - - DataItem->DataSize = DataRecord.DataSize; - DataItem->Status = EFI_SUCCESS; - } - - FreePool (Variable); - return EFI_SUCCESS; - } - - return Status; -} - -/** - Write the configuration data from IP4_CONFIG2_INSTANCE to variable storage. - - @param[in] VarName The pointer to the variable name. - @param[in] Instance The pointer to the IP4 config2 instance data. - - @retval EFI_OUT_OF_RESOURCES Fail to allocate resource to complete the operation. - @retval EFI_SUCCESS The configuration data is written successfully. - -**/ -EFI_STATUS -Ip4Config2WriteConfigData ( - IN CHAR16 *VarName, - IN IP4_CONFIG2_INSTANCE *Instance - ) -{ - UINTN Index; - UINTN VarSize; - IP4_CONFIG2_DATA_ITEM *DataItem; - IP4_CONFIG2_VARIABLE *Variable; - IP4_CONFIG2_DATA_RECORD *DataRecord; - CHAR8 *Heap; - EFI_STATUS Status; - - VarSize = sizeof (IP4_CONFIG2_VARIABLE) - sizeof (IP4_CONFIG2_DATA_RECORD); - - for (Index = 0; Index < Ip4Config2DataTypeMaximum; Index++) { - - DataItem = &Instance->DataItem[Index]; - if (!DATA_ATTRIB_SET (DataItem->Attribute, DATA_ATTRIB_VOLATILE) && !EFI_ERROR (DataItem->Status)) { - - VarSize += sizeof (IP4_CONFIG2_DATA_RECORD) + DataItem->DataSize; - } - } - - Variable = AllocatePool (VarSize); - if (Variable == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - Heap = (CHAR8 *) Variable + VarSize; - Variable->DataRecordCount = 0; - - for (Index = 0; Index < Ip4Config2DataTypeMaximum; Index++) { - - DataItem = &Instance->DataItem[Index]; - if (!DATA_ATTRIB_SET (DataItem->Attribute, DATA_ATTRIB_VOLATILE) && !EFI_ERROR (DataItem->Status)) { - - Heap -= DataItem->DataSize; - CopyMem (Heap, DataItem->Data.Ptr, DataItem->DataSize); - - DataRecord = &Variable->DataRecord[Variable->DataRecordCount]; - DataRecord->DataType = (EFI_IP4_CONFIG2_DATA_TYPE) Index; - DataRecord->DataSize = (UINT32) DataItem->DataSize; - DataRecord->Offset = (UINT16) (Heap - (CHAR8 *) Variable); - - Variable->DataRecordCount++; - } - } - - Variable->Checksum = 0; - Variable->Checksum = (UINT16) ~NetblockChecksum ((UINT8 *) Variable, (UINT32) VarSize); - - Status = gRT->SetVariable ( - VarName, - &gEfiIp4Config2ProtocolGuid, - IP4_CONFIG2_VARIABLE_ATTRIBUTE, - VarSize, - Variable - ); - - FreePool (Variable); - - return Status; -} - - -/** - Build a EFI_IP4_ROUTE_TABLE to be returned to the caller of GetModeData. - The EFI_IP4_ROUTE_TABLE is clumsy to use in the internal operation of the - IP4 driver. - - @param[in] IpSb The IP4 service binding instance. - @param[out] Table The built IP4 route table. - - @retval EFI_SUCCESS The route table is successfully build - @retval EFI_NOT_FOUND Failed to allocate the memory for the rotue table. - -**/ -EFI_STATUS -Ip4Config2BuildDefaultRouteTable ( - IN IP4_SERVICE *IpSb, - OUT EFI_IP4_ROUTE_TABLE *Table - ) -{ - LIST_ENTRY *Entry; - IP4_ROUTE_ENTRY *RtEntry; - UINT32 Count; - INT32 Index; - - if (IpSb->DefaultRouteTable == NULL) { - return EFI_NOT_FOUND; - } - - Count = IpSb->DefaultRouteTable->TotalNum; - - if (Count == 0) { - return EFI_NOT_FOUND; - } - - // - // Copy the route entry to EFI route table. Keep the order of - // route entry copied from most specific to default route. That - // is, interlevel the route entry from the instance's route area - // and those from the default route table's route area. - // - Count = 0; - - for (Index = IP4_MASK_MAX; Index >= 0; Index--) { - - NET_LIST_FOR_EACH (Entry, &(IpSb->DefaultRouteTable->RouteArea[Index])) { - RtEntry = NET_LIST_USER_STRUCT (Entry, IP4_ROUTE_ENTRY, Link); - - EFI_IP4 (Table[Count].SubnetAddress) = HTONL (RtEntry->Dest & RtEntry->Netmask); - EFI_IP4 (Table[Count].SubnetMask) = HTONL (RtEntry->Netmask); - EFI_IP4 (Table[Count].GatewayAddress) = HTONL (RtEntry->NextHop); - - Count++; - } - - } - - return EFI_SUCCESS; -} - -/** - The event process routine when the DHCPv4 service binding protocol is installed - in the system. - - @param[in] Event Not used. - @param[in] Context The pointer to the IP4 config2 instance data. - -**/ -VOID -EFIAPI -Ip4Config2OnDhcp4SbInstalled ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - IP4_CONFIG2_INSTANCE *Instance; - - Instance = (IP4_CONFIG2_INSTANCE *) Context; - - if ((Instance->Dhcp4Handle != NULL) || (Instance->Policy != Ip4Config2PolicyDhcp)) { - // - // The DHCP4 child is already created or the policy is no longer DHCP. - // - return ; - } - - Ip4StartAutoConfig (Instance); -} - -/** - Set the station address and subnetmask for the default interface. - - @param[in] IpSb The pointer to the IP4 service binding instance. - @param[in] StationAddress Ip address to be set. - @param[in] SubnetMask Subnet to be set. - - @retval EFI_SUCCESS Set default address successful. - @retval Others Some errors occur in setting. - -**/ -EFI_STATUS -Ip4Config2SetDefaultAddr ( - IN IP4_SERVICE *IpSb, - IN IP4_ADDR StationAddress, - IN IP4_ADDR SubnetMask - ) -{ - EFI_STATUS Status; - IP4_INTERFACE *IpIf; - IP4_PROTOCOL *Ip4Instance; - EFI_ARP_PROTOCOL *Arp; - LIST_ENTRY *Entry; - IP4_ADDR Subnet; - IP4_ROUTE_TABLE *RouteTable; - - IpIf = IpSb->DefaultInterface; - ASSERT (IpIf != NULL); - - if ((IpIf->Ip == StationAddress) && (IpIf->SubnetMask == SubnetMask)) { - IpSb->State = IP4_SERVICE_CONFIGED; - return EFI_SUCCESS; - } - - if (IpSb->Reconfig) { - // - // The default address is changed, free the previous interface first. - // - if (IpSb->DefaultRouteTable != NULL) { - Ip4FreeRouteTable (IpSb->DefaultRouteTable); - IpSb->DefaultRouteTable = NULL; - } - - Ip4CancelReceive (IpSb->DefaultInterface); - Ip4FreeInterface (IpSb->DefaultInterface, NULL); - IpSb->DefaultInterface = NULL; - // - // Create new default interface and route table. - // - IpIf = Ip4CreateInterface (IpSb->Mnp, IpSb->Controller, IpSb->Image); - if (IpIf == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - RouteTable = Ip4CreateRouteTable (); - if (RouteTable == NULL) { - Ip4FreeInterface (IpIf, NULL); - return EFI_OUT_OF_RESOURCES; - } - - IpSb->DefaultInterface = IpIf; - InsertHeadList (&IpSb->Interfaces, &IpIf->Link); - IpSb->DefaultRouteTable = RouteTable; - Ip4ReceiveFrame (IpIf, NULL, Ip4AccpetFrame, IpSb); - } - - if (IpSb->State == IP4_SERVICE_CONFIGED) { - IpSb->State = IP4_SERVICE_UNSTARTED; - } - - Status = Ip4SetAddress (IpIf, StationAddress, SubnetMask); - if (EFI_ERROR (Status)) { - return Status; - } - - if (IpIf->Arp != NULL) { - // - // A non-NULL IpIf->Arp here means a new ARP child is created when setting default address, - // but some IP children may have referenced the default interface before it is configured, - // these IP instances also consume this ARP protocol so they need to open it BY_CHILD_CONTROLLER. - // - Arp = NULL; - NET_LIST_FOR_EACH (Entry, &IpIf->IpInstances) { - Ip4Instance = NET_LIST_USER_STRUCT_S (Entry, IP4_PROTOCOL, AddrLink, IP4_PROTOCOL_SIGNATURE); - Status = gBS->OpenProtocol ( - IpIf->ArpHandle, - &gEfiArpProtocolGuid, - (VOID **) &Arp, - gIp4DriverBinding.DriverBindingHandle, - Ip4Instance->Handle, - EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER - ); - if (EFI_ERROR (Status)) { - return Status; - } - } - } - - // - // Add a route for the connected network. - // - Subnet = StationAddress & SubnetMask; - - Ip4AddRoute ( - IpSb->DefaultRouteTable, - Subnet, - SubnetMask, - IP4_ALLZERO_ADDRESS - ); - - IpSb->State = IP4_SERVICE_CONFIGED; - IpSb->Reconfig = FALSE; - - return EFI_SUCCESS; -} - -/** - Set the station address, subnetmask and gateway address for the default interface. - - @param[in] Instance The pointer to the IP4 config2 instance data. - @param[in] StationAddress Ip address to be set. - @param[in] SubnetMask Subnet to be set. - @param[in] GatewayAddress Gateway to be set. - - @retval EFI_SUCCESS Set default If successful. - @retval Others Errors occur as indicated. - -**/ -EFI_STATUS -Ip4Config2SetDefaultIf ( - IN IP4_CONFIG2_INSTANCE *Instance, - IN IP4_ADDR StationAddress, - IN IP4_ADDR SubnetMask, - IN IP4_ADDR GatewayAddress - ) -{ - EFI_STATUS Status; - IP4_SERVICE *IpSb; - - IpSb = IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance); - - // - // Check whether the StationAddress/SubnetMask pair is valid. - // - if (!Ip4StationAddressValid (StationAddress, SubnetMask)) { - return EFI_INVALID_PARAMETER; - } - - Status = Ip4Config2SetDefaultAddr (IpSb, StationAddress, SubnetMask); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Create a route if there is a default router. - // - if (GatewayAddress != IP4_ALLZERO_ADDRESS) { - Ip4AddRoute ( - IpSb->DefaultRouteTable, - IP4_ALLZERO_ADDRESS, - IP4_ALLZERO_ADDRESS, - GatewayAddress - ); - } - - return EFI_SUCCESS; -} - - -/** - Release all the DHCP related resources. - - @param Instance The IP4 config2 instance. - - @return None - -**/ -VOID -Ip4Config2CleanDhcp4 ( - IN IP4_CONFIG2_INSTANCE *Instance - ) -{ - IP4_SERVICE *IpSb; - - IpSb = IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance); - - if (Instance->Dhcp4 != NULL) { - Instance->Dhcp4->Stop (Instance->Dhcp4); - - gBS->CloseProtocol ( - Instance->Dhcp4Handle, - &gEfiDhcp4ProtocolGuid, - IpSb->Image, - IpSb->Controller - ); - - Instance->Dhcp4 = NULL; - } - - if (Instance->Dhcp4Handle != NULL) { - NetLibDestroyServiceChild ( - IpSb->Controller, - IpSb->Image, - &gEfiDhcp4ServiceBindingProtocolGuid, - Instance->Dhcp4Handle - ); - - Instance->Dhcp4Handle = NULL; - } - - if (Instance->Dhcp4Event != NULL) { - gBS->CloseEvent (Instance->Dhcp4Event); - Instance->Dhcp4Event = NULL; - } -} - -/** - This worker function sets the DNS server list for the EFI IPv4 network - stack running on the communication device that this EFI_IP4_CONFIG2_PROTOCOL - manages. The DNS server addresses must be unicast IPv4 addresses. - - @param[in] Instance The pointer to the IP4 config2 instance data. - @param[in] DataSize The size of the buffer pointed to by Data in bytes. - @param[in] Data The data buffer to set, points to an array of - EFI_IPv4_ADDRESS instances. - - @retval EFI_BAD_BUFFER_SIZE The DataSize does not match the size of the type. - @retval EFI_INVALID_PARAMETER One or more fields in Data is invalid. - @retval EFI_OUT_OF_RESOURCES Failed to allocate resources to complete the operation. - @retval EFI_ABORTED The DNS server addresses to be set equal the current - configuration. - @retval EFI_SUCCESS The specified configuration data for the EFI IPv4 - network stack was set. - -**/ -EFI_STATUS -Ip4Config2SetDnsServerWorker ( - IN IP4_CONFIG2_INSTANCE *Instance, - IN UINTN DataSize, - IN VOID *Data - ) -{ - UINTN OldIndex; - UINTN NewIndex; - EFI_IPv4_ADDRESS *OldDns; - EFI_IPv4_ADDRESS *NewDns; - UINTN OldDnsCount; - UINTN NewDnsCount; - IP4_CONFIG2_DATA_ITEM *Item; - BOOLEAN OneAdded; - VOID *Tmp; - IP4_ADDR DnsAddress; - - if ((DataSize % sizeof (EFI_IPv4_ADDRESS) != 0) || (DataSize == 0)) { - return EFI_BAD_BUFFER_SIZE; - } - - Item = &Instance->DataItem[Ip4Config2DataTypeDnsServer]; - NewDns = (EFI_IPv4_ADDRESS *) Data; - OldDns = Item->Data.DnsServers; - NewDnsCount = DataSize / sizeof (EFI_IPv4_ADDRESS); - OldDnsCount = Item->DataSize / sizeof (EFI_IPv4_ADDRESS); - OneAdded = FALSE; - - if (NewDnsCount != OldDnsCount) { - Tmp = AllocatePool (DataSize); - if (Tmp == NULL) { - return EFI_OUT_OF_RESOURCES; - } - } else { - Tmp = NULL; - } - - for (NewIndex = 0; NewIndex < NewDnsCount; NewIndex++) { - CopyMem (&DnsAddress, NewDns + NewIndex, sizeof (IP4_ADDR)); - if (IP4_IS_UNSPECIFIED (NTOHL (DnsAddress)) || IP4_IS_LOCAL_BROADCAST (NTOHL (DnsAddress))) { - // - // The dns server address must be unicast. - // - if (Tmp != NULL) { - FreePool (Tmp); - } - return EFI_INVALID_PARAMETER; - } - - if (OneAdded) { - // - // If any address in the new setting is not in the old settings, skip the - // comparision below. - // - continue; - } - - for (OldIndex = 0; OldIndex < OldDnsCount; OldIndex++) { - if (EFI_IP4_EQUAL (NewDns + NewIndex, OldDns + OldIndex)) { - // - // If found break out. - // - break; - } - } - - if (OldIndex == OldDnsCount) { - OneAdded = TRUE; - } - } - - if (!OneAdded && (DataSize == Item->DataSize)) { - // - // No new item is added and the size is the same. - // - Item->Status = EFI_SUCCESS; - return EFI_ABORTED; - } else { - if (Tmp != NULL) { - if (Item->Data.Ptr != NULL) { - FreePool (Item->Data.Ptr); - } - Item->Data.Ptr = Tmp; - } - - CopyMem (Item->Data.Ptr, Data, DataSize); - Item->DataSize = DataSize; - Item->Status = EFI_SUCCESS; - return EFI_SUCCESS; - } -} - - - -/** - Callback function when DHCP process finished. It will save the - retrieved IP configure parameter from DHCP to the NVRam. - - @param Event The callback event - @param Context Opaque context to the callback - - @return None - -**/ -VOID -EFIAPI -Ip4Config2OnDhcp4Complete ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - IP4_CONFIG2_INSTANCE *Instance; - EFI_DHCP4_MODE_DATA Dhcp4Mode; - EFI_STATUS Status; - IP4_ADDR StationAddress; - IP4_ADDR SubnetMask; - IP4_ADDR GatewayAddress; - UINT32 Index; - UINT32 OptionCount; - EFI_DHCP4_PACKET_OPTION **OptionList; - - Instance = (IP4_CONFIG2_INSTANCE *) Context; - ASSERT (Instance->Dhcp4 != NULL); - - // - // Get the DHCP retrieved parameters - // - Status = Instance->Dhcp4->GetModeData (Instance->Dhcp4, &Dhcp4Mode); - - if (EFI_ERROR (Status)) { - goto Exit; - } - - if (Dhcp4Mode.State == Dhcp4Bound) { - StationAddress = EFI_NTOHL (Dhcp4Mode.ClientAddress); - SubnetMask = EFI_NTOHL (Dhcp4Mode.SubnetMask); - GatewayAddress = EFI_NTOHL (Dhcp4Mode.RouterAddress); - - Status = Ip4Config2SetDefaultIf (Instance, StationAddress, SubnetMask, GatewayAddress); - if (EFI_ERROR (Status)) { - goto Exit; - } - - // - // Parse the ACK to get required DNS server information. - // - OptionCount = 0; - OptionList = NULL; - - Status = Instance->Dhcp4->Parse (Instance->Dhcp4, Dhcp4Mode.ReplyPacket, &OptionCount, OptionList); - if (Status != EFI_BUFFER_TOO_SMALL) { - goto Exit; - } - - OptionList = AllocateZeroPool (OptionCount * sizeof (EFI_DHCP4_PACKET_OPTION *)); - if (OptionList == NULL) { - goto Exit; - } - - Status = Instance->Dhcp4->Parse (Instance->Dhcp4, Dhcp4Mode.ReplyPacket, &OptionCount, OptionList); - if (EFI_ERROR (Status)) { - FreePool (OptionList); - goto Exit; - } - - for (Index = 0; Index < OptionCount; Index++) { - // - // Look for DNS Server opcode (6). - // - if (OptionList[Index]->OpCode == DHCP4_TAG_DNS_SERVER) { - if (((OptionList[Index]->Length & 0x3) != 0) || (OptionList[Index]->Length == 0)) { - break; - } - - Ip4Config2SetDnsServerWorker (Instance, OptionList[Index]->Length, &OptionList[Index]->Data[0]); - break; - } - } - - FreePool (OptionList); - - Instance->DhcpSuccess = TRUE; - } - -Exit: - Ip4Config2CleanDhcp4 (Instance); - DispatchDpc (); -} - - -/** - Start the DHCP configuration for this IP service instance. - It will locates the EFI_IP4_CONFIG2_PROTOCOL, then start the - DHCP configuration. - - @param[in] Instance The IP4 config2 instance to configure - - @retval EFI_SUCCESS The auto configuration is successfully started - @retval Others Failed to start auto configuration. - -**/ -EFI_STATUS -Ip4StartAutoConfig ( - IN IP4_CONFIG2_INSTANCE *Instance - ) -{ - IP4_SERVICE *IpSb; - EFI_DHCP4_PROTOCOL *Dhcp4; - EFI_DHCP4_MODE_DATA Dhcp4Mode; - EFI_DHCP4_PACKET_OPTION *OptionList[1]; - IP4_CONFIG2_DHCP4_OPTION ParaList; - EFI_STATUS Status; - - IpSb = IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance); - - if (IpSb->State > IP4_SERVICE_UNSTARTED) { - return EFI_SUCCESS; - } - - // - // A host must not invoke DHCP configuration if it is already - // participating in the DHCP configuraiton process. - // - if (Instance->Dhcp4Handle != NULL) { - return EFI_SUCCESS; - } - - Status = NetLibCreateServiceChild ( - IpSb->Controller, - IpSb->Image, - &gEfiDhcp4ServiceBindingProtocolGuid, - &Instance->Dhcp4Handle - ); - - if (Status == EFI_UNSUPPORTED) { - // - // No DHCPv4 Service Binding protocol, register a notify. - // - if (Instance->Dhcp4SbNotifyEvent == NULL) { - Instance->Dhcp4SbNotifyEvent = EfiCreateProtocolNotifyEvent ( - &gEfiDhcp4ServiceBindingProtocolGuid, - TPL_CALLBACK, - Ip4Config2OnDhcp4SbInstalled, - (VOID *) Instance, - &Instance->Registration - ); - } - } - - if (EFI_ERROR (Status)) { - return Status; - } - - if (Instance->Dhcp4SbNotifyEvent != NULL) { - gBS->CloseEvent (Instance->Dhcp4SbNotifyEvent); - } - - Status = gBS->OpenProtocol ( - Instance->Dhcp4Handle, - &gEfiDhcp4ProtocolGuid, - (VOID **) &Instance->Dhcp4, - IpSb->Image, - IpSb->Controller, - EFI_OPEN_PROTOCOL_BY_DRIVER - ); - if (EFI_ERROR (Status)) { - NetLibDestroyServiceChild ( - IpSb->Controller, - IpSb->Image, - &gEfiDhcp4ServiceBindingProtocolGuid, - Instance->Dhcp4Handle - ); - - Instance->Dhcp4Handle = NULL; - - return Status; - } - - // - // Check the current DHCP status, if the DHCP process has - // already finished, return now. - // - Dhcp4 = Instance->Dhcp4; - Status = Dhcp4->GetModeData (Dhcp4, &Dhcp4Mode); - if (Dhcp4Mode.State == Dhcp4Bound) { - Ip4Config2OnDhcp4Complete (NULL, Instance); - - return EFI_SUCCESS; - } - - // - // Try to start the DHCP process. Use most of the current - // DHCP configuration to avoid problems if some DHCP client - // yields the control of this DHCP service to us. - // - ParaList.Head.OpCode = DHCP4_TAG_PARA_LIST; - ParaList.Head.Length = 3; - ParaList.Head.Data[0] = DHCP4_TAG_NETMASK; - ParaList.Route = DHCP4_TAG_ROUTER; - ParaList.Dns = DHCP4_TAG_DNS_SERVER; - OptionList[0] = &ParaList.Head; - Dhcp4Mode.ConfigData.OptionCount = 1; - Dhcp4Mode.ConfigData.OptionList = OptionList; - - Status = Dhcp4->Configure (Dhcp4, &Dhcp4Mode.ConfigData); - if (EFI_ERROR (Status)) { - gBS->CloseProtocol ( - Instance->Dhcp4Handle, - &gEfiDhcp4ProtocolGuid, - IpSb->Image, - IpSb->Controller - ); - - NetLibDestroyServiceChild ( - IpSb->Controller, - IpSb->Image, - &gEfiDhcp4ServiceBindingProtocolGuid, - Instance->Dhcp4Handle - ); - - Instance->Dhcp4 = NULL; - - Instance->Dhcp4Handle = NULL; - - return Status; - } - - // - // Start the DHCP process - // - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL, - TPL_CALLBACK, - Ip4Config2OnDhcp4Complete, - Instance, - &Instance->Dhcp4Event - ); - if (EFI_ERROR (Status)) { - Ip4Config2DestroyDhcp4 (Instance); - return Status; - } - - Status = Dhcp4->Start (Dhcp4, Instance->Dhcp4Event); - if (EFI_ERROR (Status)) { - Ip4Config2DestroyDhcp4 (Instance); - gBS->CloseEvent (Instance->Dhcp4Event); - Instance->Dhcp4Event = NULL; - - return Status; - } - - IpSb->State = IP4_SERVICE_STARTED; - DispatchDpc (); - - return EFI_SUCCESS; -} - - - -/** - The work function is to get the interface information of the communication - device this IP4_CONFIG2_INSTANCE manages. - - @param[in] Instance Pointer to the IP4 config2 instance data. - @param[in, out] DataSize On input, in bytes, the size of Data. On output, in - bytes, the size of buffer required to store the specified - configuration data. - @param[in] Data The data buffer in which the configuration data is returned. - Ignored if DataSize is ZERO. - - @retval EFI_BUFFER_TOO_SMALL The size of Data is too small for the specified - configuration data, and the required size is - returned in DataSize. - @retval EFI_SUCCESS The specified configuration data was obtained. - -**/ -EFI_STATUS -Ip4Config2GetIfInfo ( - IN IP4_CONFIG2_INSTANCE *Instance, - IN OUT UINTN *DataSize, - IN VOID *Data OPTIONAL - ) -{ - IP4_SERVICE *IpSb; - UINTN Length; - IP4_CONFIG2_DATA_ITEM *Item; - EFI_IP4_CONFIG2_INTERFACE_INFO *IfInfo; - IP4_ADDR Address; - - IpSb = IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance); - Length = sizeof (EFI_IP4_CONFIG2_INTERFACE_INFO); - - if (IpSb->DefaultRouteTable != NULL) { - Length += IpSb->DefaultRouteTable->TotalNum * sizeof (EFI_IP4_ROUTE_TABLE); - } - - if (*DataSize < Length) { - *DataSize = Length; - return EFI_BUFFER_TOO_SMALL; - } - - // - // Copy the fixed size part of the interface info. - // - Item = &Instance->DataItem[Ip4Config2DataTypeInterfaceInfo]; - IfInfo = (EFI_IP4_CONFIG2_INTERFACE_INFO *) Data; - CopyMem (IfInfo, Item->Data.Ptr, sizeof (EFI_IP4_CONFIG2_INTERFACE_INFO)); - - // - // Update the address info. - // - if (IpSb->DefaultInterface != NULL) { - Address = HTONL (IpSb->DefaultInterface->Ip); - CopyMem (&IfInfo->StationAddress, &Address, sizeof (EFI_IPv4_ADDRESS)); - Address = HTONL (IpSb->DefaultInterface->SubnetMask); - CopyMem (&IfInfo->SubnetMask, &Address, sizeof (EFI_IPv4_ADDRESS)); - } - - if (IpSb->DefaultRouteTable != NULL) { - IfInfo->RouteTableSize = IpSb->DefaultRouteTable->TotalNum; - IfInfo->RouteTable = (EFI_IP4_ROUTE_TABLE *) ((UINT8 *) Data + sizeof (EFI_IP4_CONFIG2_INTERFACE_INFO)); - - Ip4Config2BuildDefaultRouteTable (IpSb, IfInfo->RouteTable); - } - - return EFI_SUCCESS; -} - -/** - The work function is to set the general configuration policy for the EFI IPv4 network - stack that is running on the communication device managed by this IP4_CONFIG2_INSTANCE. - The policy will affect other configuration settings. - - @param[in] Instance Pointer to the IP4 config2 instance data. - @param[in] DataSize Size of the buffer pointed to by Data in bytes. - @param[in] Data The data buffer to set. - - @retval EFI_INVALID_PARAMETER The to be set policy is invalid. - @retval EFI_BAD_BUFFER_SIZE The DataSize does not match the size of the type. - @retval EFI_ABORTED The new policy equals the current policy. - @retval EFI_SUCCESS The specified configuration data for the EFI IPv6 - network stack was set. - -**/ -EFI_STATUS -Ip4Config2SetPolicy ( - IN IP4_CONFIG2_INSTANCE *Instance, - IN UINTN DataSize, - IN VOID *Data - ) -{ - EFI_IP4_CONFIG2_POLICY NewPolicy; - IP4_CONFIG2_DATA_ITEM *DataItem; - IP4_SERVICE *IpSb; - - if (DataSize != sizeof (EFI_IP4_CONFIG2_POLICY)) { - return EFI_BAD_BUFFER_SIZE; - } - - NewPolicy = *((EFI_IP4_CONFIG2_POLICY *) Data); - - if (NewPolicy >= Ip4Config2PolicyMax) { - return EFI_INVALID_PARAMETER; - } - - if (NewPolicy == Instance->Policy) { - if (NewPolicy != Ip4Config2PolicyDhcp || Instance->DhcpSuccess) { - return EFI_ABORTED; - } - } else { - // - // The policy is changed. Clean the ManualAddress, Gateway and DnsServers, - // shrink the variable data size, and fire up all the related events. - // - DataItem = &Instance->DataItem[Ip4Config2DataTypeManualAddress]; - if (DataItem->Data.Ptr != NULL) { - FreePool (DataItem->Data.Ptr); - } - DataItem->Data.Ptr = NULL; - DataItem->DataSize = 0; - DataItem->Status = EFI_NOT_FOUND; - NetMapIterate (&DataItem->EventMap, Ip4Config2SignalEvent, NULL); - - DataItem = &Instance->DataItem[Ip4Config2DataTypeGateway]; - if (DataItem->Data.Ptr != NULL) { - FreePool (DataItem->Data.Ptr); - } - DataItem->Data.Ptr = NULL; - DataItem->DataSize = 0; - DataItem->Status = EFI_NOT_FOUND; - NetMapIterate (&DataItem->EventMap, Ip4Config2SignalEvent, NULL); - - DataItem = &Instance->DataItem[Ip4Config2DataTypeDnsServer]; - if (DataItem->Data.Ptr != NULL) { - FreePool (DataItem->Data.Ptr); - } - DataItem->Data.Ptr = NULL; - DataItem->DataSize = 0; - DataItem->Status = EFI_NOT_FOUND; - NetMapIterate (&DataItem->EventMap, Ip4Config2SignalEvent, NULL); - - if (NewPolicy == Ip4Config2PolicyDhcp) { - SET_DATA_ATTRIB (DataItem->Attribute, DATA_ATTRIB_VOLATILE); - } else { - // - // The policy is changed from dhcp to static. Stop the DHCPv4 process - // and destroy the DHCPv4 child. - // - if (Instance->Dhcp4Handle != NULL) { - Ip4Config2DestroyDhcp4 (Instance); - } - - // - // Close the event. - // - if (Instance->Dhcp4Event != NULL) { - gBS->CloseEvent (Instance->Dhcp4Event); - Instance->Dhcp4Event = NULL; - } - } - } - - IpSb = IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance); - Ip4Config2OnPolicyChanged (IpSb, NewPolicy); - - Instance->Policy = NewPolicy; - - return EFI_SUCCESS; -} - -/** - The work function is to set the station addresses manually for the EFI IPv4 - network stack. It is only configurable when the policy is Ip4Config2PolicyStatic. - - @param[in] Instance Pointer to the IP4 config2 instance data. - @param[in] DataSize Size of the buffer pointed to by Data in bytes. - @param[in] Data The data buffer to set. - - @retval EFI_BAD_BUFFER_SIZE The DataSize does not match the size of the type. - @retval EFI_WRITE_PROTECTED The specified configuration data cannot be set - under the current policy. - @retval EFI_INVALID_PARAMETER One or more fields in Data is invalid. - @retval EFI_OUT_OF_RESOURCES Fail to allocate resource to complete the operation. - @retval EFI_NOT_READY An asynchrous process is invoked to set the specified - configuration data, and the process is not finished. - @retval EFI_ABORTED The manual addresses to be set equal current - configuration. - @retval EFI_SUCCESS The specified configuration data for the EFI IPv6 - network stack was set. - -**/ -EFI_STATUS -Ip4Config2SetManualAddress ( - IN IP4_CONFIG2_INSTANCE *Instance, - IN UINTN DataSize, - IN VOID *Data - ) -{ - EFI_IP4_CONFIG2_MANUAL_ADDRESS NewAddress; - IP4_CONFIG2_DATA_ITEM *DataItem; - EFI_STATUS Status; - IP4_ADDR StationAddress; - IP4_ADDR SubnetMask; - VOID *Ptr; - IP4_SERVICE *IpSb; - IP4_INTERFACE *IpIf; - IP4_ROUTE_TABLE *RouteTable; - - DataItem = NULL; - Status = EFI_SUCCESS; - Ptr = NULL; - IpIf = NULL; - RouteTable = NULL; - - IpSb = IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance); - - ASSERT (Instance->DataItem[Ip4Config2DataTypeManualAddress].Status != EFI_NOT_READY); - - if ((DataSize != 0) && ((DataSize % sizeof (EFI_IP4_CONFIG2_MANUAL_ADDRESS)) != 0)) { - return EFI_BAD_BUFFER_SIZE; - } - - if (Instance->Policy != Ip4Config2PolicyStatic) { - return EFI_WRITE_PROTECTED; - } - - DataItem = &Instance->DataItem[Ip4Config2DataTypeManualAddress]; - - if (Data != NULL && DataSize != 0) { - NewAddress = *((EFI_IP4_CONFIG2_MANUAL_ADDRESS *) Data); - - StationAddress = EFI_NTOHL (NewAddress.Address); - SubnetMask = EFI_NTOHL (NewAddress.SubnetMask); - - // - // Check whether the StationAddress/SubnetMask pair is valid. - // - if (!Ip4StationAddressValid (StationAddress, SubnetMask)) { - return EFI_INVALID_PARAMETER; - } - - // - // Store the new data, and init the DataItem status to EFI_NOT_READY because - // we may have an asynchronous configuration process. - // - Ptr = AllocateCopyPool (DataSize, Data); - if (Ptr == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - if (DataItem->Data.Ptr != NULL) { - FreePool (DataItem->Data.Ptr); - } - - DataItem->Data.Ptr = Ptr; - DataItem->DataSize = DataSize; - DataItem->Status = EFI_NOT_READY; - - IpSb->Reconfig = TRUE; - Status = Ip4Config2SetDefaultAddr (IpSb, StationAddress, SubnetMask); - - DataItem->Status = Status; - - if (EFI_ERROR (DataItem->Status) && DataItem->Status != EFI_NOT_READY) { - if (Ptr != NULL) { - FreePool (Ptr); - } - DataItem->Data.Ptr = NULL; - } - } else { - // - // DataSize is 0 and Data is NULL, clean up the manual address. - // - if (DataItem->Data.Ptr != NULL) { - FreePool (DataItem->Data.Ptr); - } - DataItem->Data.Ptr = NULL; - DataItem->DataSize = 0; - DataItem->Status = EFI_NOT_FOUND; - - // - // Free the default router table and Interface, clean up the assemble table. - // - if (IpSb->DefaultInterface != NULL) { - if (IpSb->DefaultRouteTable != NULL) { - Ip4FreeRouteTable (IpSb->DefaultRouteTable); - IpSb->DefaultRouteTable = NULL; - } - - Ip4CancelReceive (IpSb->DefaultInterface); - - Ip4FreeInterface (IpSb->DefaultInterface, NULL); - IpSb->DefaultInterface = NULL; - } - - Ip4CleanAssembleTable (&IpSb->Assemble); - - // - // Create new default interface and route table. - // - IpIf = Ip4CreateInterface (IpSb->Mnp, IpSb->Controller, IpSb->Image); - if (IpIf == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - RouteTable = Ip4CreateRouteTable (); - if (RouteTable == NULL) { - Ip4FreeInterface (IpIf, NULL); - return EFI_OUT_OF_RESOURCES; - } - - IpSb->DefaultInterface = IpIf; - InsertHeadList (&IpSb->Interfaces, &IpIf->Link); - IpSb->DefaultRouteTable = RouteTable; - Ip4ReceiveFrame (IpIf, NULL, Ip4AccpetFrame, IpSb); - - // - // Reset the State to unstarted. - // - if (IpSb->State == IP4_SERVICE_CONFIGED || IpSb->State == IP4_SERVICE_STARTED) { - IpSb->State = IP4_SERVICE_UNSTARTED; - } - } - - return Status; -} - -/** - The work function is to set the gateway addresses manually for the EFI IPv4 - network stack that is running on the communication device that this EFI IPv4 - Configuration Protocol manages. It is not configurable when the policy is - Ip4Config2PolicyDhcp. The gateway addresses must be unicast IPv4 addresses. - - @param[in] Instance The pointer to the IP4 config2 instance data. - @param[in] DataSize The size of the buffer pointed to by Data in bytes. - @param[in] Data The data buffer to set. This points to an array of - EFI_IPv6_ADDRESS instances. - - @retval EFI_BAD_BUFFER_SIZE The DataSize does not match the size of the type. - @retval EFI_WRITE_PROTECTED The specified configuration data cannot be set - under the current policy. - @retval EFI_INVALID_PARAMETER One or more fields in Data is invalid. - @retval EFI_OUT_OF_RESOURCES Failed to allocate resource to complete the operation. - @retval EFI_ABORTED The manual gateway addresses to be set equal the - current configuration. - @retval EFI_SUCCESS The specified configuration data for the EFI IPv6 - network stack was set. - -**/ -EFI_STATUS -Ip4Config2SetGateway ( - IN IP4_CONFIG2_INSTANCE *Instance, - IN UINTN DataSize, - IN VOID *Data - ) -{ - IP4_SERVICE *IpSb; - IP4_CONFIG2_DATA_ITEM *DataItem; - IP4_ADDR Gateway; - - UINTN Index1; - UINTN Index2; - EFI_IPv4_ADDRESS *OldGateway; - EFI_IPv4_ADDRESS *NewGateway; - UINTN OldGatewayCount; - UINTN NewGatewayCount; - BOOLEAN OneRemoved; - BOOLEAN OneAdded; - VOID *Tmp; - - OldGateway = NULL; - NewGateway = NULL; - OneRemoved = FALSE; - OneAdded = FALSE; - Tmp = NULL; - - if ((DataSize != 0) && (DataSize % sizeof (EFI_IPv4_ADDRESS) != 0)) { - return EFI_BAD_BUFFER_SIZE; - } - - if (Instance->Policy != Ip4Config2PolicyStatic) { - return EFI_WRITE_PROTECTED; - } - - IpSb = IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance); - - DataItem = &Instance->DataItem[Ip4Config2DataTypeGateway]; - OldGateway = DataItem->Data.Gateway; - OldGatewayCount = DataItem->DataSize / sizeof (EFI_IPv4_ADDRESS); - - for (Index1 = 0; Index1 < OldGatewayCount; Index1++) { - // - // Remove the old route entry. - // - CopyMem (&Gateway, OldGateway + Index1, sizeof (IP4_ADDR)); - Ip4DelRoute ( - IpSb->DefaultRouteTable, - IP4_ALLZERO_ADDRESS, - IP4_ALLZERO_ADDRESS, - NTOHL (Gateway) - ); - OneRemoved = TRUE; - } - - if (Data != NULL && DataSize != 0) { - NewGateway = (EFI_IPv4_ADDRESS *) Data; - NewGatewayCount = DataSize / sizeof (EFI_IPv4_ADDRESS); - for (Index1 = 0; Index1 < NewGatewayCount; Index1++) { - CopyMem (&Gateway, NewGateway + Index1, sizeof (IP4_ADDR)); - - if ((IpSb->DefaultInterface->SubnetMask != 0) && - !NetIp4IsUnicast (NTOHL (Gateway), IpSb->DefaultInterface->SubnetMask)) { - return EFI_INVALID_PARAMETER; - } - - for (Index2 = Index1 + 1; Index2 < NewGatewayCount; Index2++) { - if (EFI_IP4_EQUAL (NewGateway + Index1, NewGateway + Index2)) { - return EFI_INVALID_PARAMETER; - } - } - } - - if (NewGatewayCount != OldGatewayCount) { - Tmp = AllocatePool (DataSize); - if (Tmp == NULL) { - return EFI_OUT_OF_RESOURCES; - } - } else { - Tmp = NULL; - } - - for (Index1 = 0; Index1 < NewGatewayCount; Index1++) { - // - // Add the new route entry. - // - CopyMem (&Gateway, NewGateway + Index1, sizeof (IP4_ADDR)); - Ip4AddRoute ( - IpSb->DefaultRouteTable, - IP4_ALLZERO_ADDRESS, - IP4_ALLZERO_ADDRESS, - NTOHL (Gateway) - ); - - OneAdded = TRUE; - } - - if (!OneRemoved && !OneAdded) { - DataItem->Status = EFI_SUCCESS; - return EFI_ABORTED; - } else { - if (Tmp != NULL) { - if (DataItem->Data.Ptr != NULL) { - FreePool (DataItem->Data.Ptr); - } - DataItem->Data.Ptr = Tmp; - } - - CopyMem (DataItem->Data.Ptr, Data, DataSize); - DataItem->DataSize = DataSize; - DataItem->Status = EFI_SUCCESS; - } - } else { - // - // DataSize is 0 and Data is NULL, clean up the Gateway address. - // - if (DataItem->Data.Ptr != NULL) { - FreePool (DataItem->Data.Ptr); - } - DataItem->Data.Ptr = NULL; - DataItem->DataSize = 0; - DataItem->Status = EFI_NOT_FOUND; - } - - return EFI_SUCCESS; -} - -/** - The work function is to set the DNS server list for the EFI IPv4 network - stack running on the communication device that this EFI_IP4_CONFIG2_PROTOCOL - manages. It is not configurable when the policy is Ip4Config2PolicyDhcp. - The DNS server addresses must be unicast IPv4 addresses. - - @param[in] Instance The pointer to the IP4 config2 instance data. - @param[in] DataSize The size of the buffer pointed to by Data in bytes. - @param[in] Data The data buffer to set, points to an array of - EFI_IPv4_ADDRESS instances. - - @retval EFI_BAD_BUFFER_SIZE The DataSize does not match the size of the type. - @retval EFI_WRITE_PROTECTED The specified configuration data cannot be set - under the current policy. - @retval EFI_INVALID_PARAMETER One or more fields in Data is invalid. - @retval EFI_OUT_OF_RESOURCES Failed to allocate resources to complete the operation. - @retval EFI_ABORTED The DNS server addresses to be set equal the current - configuration. - @retval EFI_SUCCESS The specified configuration data for the EFI IPv4 - network stack was set. - -**/ -EFI_STATUS -Ip4Config2SetDnsServer ( - IN IP4_CONFIG2_INSTANCE *Instance, - IN UINTN DataSize, - IN VOID *Data - ) -{ - EFI_STATUS Status; - IP4_CONFIG2_DATA_ITEM *Item; - - Status = EFI_SUCCESS; - Item = NULL; - - if (Instance->Policy != Ip4Config2PolicyStatic) { - return EFI_WRITE_PROTECTED; - } - - Item = &Instance->DataItem[Ip4Config2DataTypeDnsServer]; - - if (DATA_ATTRIB_SET (Item->Attribute, DATA_ATTRIB_VOLATILE)) { - REMOVE_DATA_ATTRIB (Item->Attribute, DATA_ATTRIB_VOLATILE); - } - - if (Data != NULL && DataSize != 0) { - Status = Ip4Config2SetDnsServerWorker (Instance, DataSize, Data); - } else { - // - // DataSize is 0 and Data is NULL, clean up the DnsServer address. - // - if (Item->Data.Ptr != NULL) { - FreePool (Item->Data.Ptr); - } - Item->Data.Ptr = NULL; - Item->DataSize = 0; - Item->Status = EFI_NOT_FOUND; - } - - return Status; -} - -/** - Generate the operational state of the interface this IP4 config2 instance manages - and output in EFI_IP4_CONFIG2_INTERFACE_INFO. - - @param[in] IpSb The pointer to the IP4 service binding instance. - @param[out] IfInfo The pointer to the IP4 config2 interface information structure. - -**/ -VOID -Ip4Config2InitIfInfo ( - IN IP4_SERVICE *IpSb, - OUT EFI_IP4_CONFIG2_INTERFACE_INFO *IfInfo - ) -{ - UnicodeSPrint ( - IfInfo->Name, - EFI_IP4_CONFIG2_INTERFACE_INFO_NAME_SIZE, - L"eth%d", - IpSb->Ip4Config2Instance.IfIndex - ); - - IfInfo->IfType = IpSb->SnpMode.IfType; - IfInfo->HwAddressSize = IpSb->SnpMode.HwAddressSize; - CopyMem (&IfInfo->HwAddress, &IpSb->SnpMode.CurrentAddress, IfInfo->HwAddressSize); -} - - - -/** - Set the configuration for the EFI IPv4 network stack running on the communication - device this EFI_IP4_CONFIG2_PROTOCOL instance manages. - - This function is used to set the configuration data of type DataType for the EFI - IPv4 network stack that is running on the communication device that this EFI IPv4 - Configuration Protocol instance manages. - - DataSize is used to calculate the count of structure instances in the Data for - a DataType in which multiple structure instances are allowed. - - This function is always non-blocking. When setting some type of configuration data, - an asynchronous process is invoked to check the correctness of the data, such as - performing Duplicate Address Detection on the manually set local IPv4 addresses. - EFI_NOT_READY is returned immediately to indicate that such an asynchronous process - is invoked, and the process is not finished yet. The caller wanting to get the result - of the asynchronous process is required to call RegisterDataNotify() to register an - event on the specified configuration data. Once the event is signaled, the caller - can call GetData() to obtain the configuration data and know the result. - For other types of configuration data that do not require an asynchronous configuration - process, the result of the operation is immediately returned. - - @param[in] This The pointer to the EFI_IP4_CONFIG2_PROTOCOL instance. - @param[in] DataType The type of data to set. - @param[in] DataSize Size of the buffer pointed to by Data in bytes. - @param[in] Data The data buffer to set. The type of the data buffer is - associated with the DataType. - - @retval EFI_SUCCESS The specified configuration data for the EFI IPv6 - network stack was set successfully. - @retval EFI_INVALID_PARAMETER One or more of the following are TRUE: - - This is NULL. - - One or more fields in Data and DataSize do not match the - requirement of the data type indicated by DataType. - @retval EFI_WRITE_PROTECTED The specified configuration data is read-only or the specified - configuration data cannot be set under the current policy. - @retval EFI_ACCESS_DENIED Another set operation on the specified configuration - data is already in process. - @retval EFI_NOT_READY An asynchronous process was invoked to set the specified - configuration data, and the process is not finished yet. - @retval EFI_BAD_BUFFER_SIZE The DataSize does not match the size of the type - indicated by DataType. - @retval EFI_UNSUPPORTED This DataType is not supported. - @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. - @retval EFI_DEVICE_ERROR An unexpected system error or network error occurred. - -**/ -EFI_STATUS -EFIAPI -EfiIp4Config2SetData ( - IN EFI_IP4_CONFIG2_PROTOCOL *This, - IN EFI_IP4_CONFIG2_DATA_TYPE DataType, - IN UINTN DataSize, - IN VOID *Data - ) -{ - EFI_TPL OldTpl; - EFI_STATUS Status; - IP4_CONFIG2_INSTANCE *Instance; - IP4_SERVICE *IpSb; - - if ((This == NULL) || (Data == NULL && DataSize != 0) || (Data != NULL && DataSize == 0)) { - return EFI_INVALID_PARAMETER; - } - - if (DataType >= Ip4Config2DataTypeMaximum) { - return EFI_UNSUPPORTED; - } - - Instance = IP4_CONFIG2_INSTANCE_FROM_PROTOCOL (This); - IpSb = IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance); - NET_CHECK_SIGNATURE (IpSb, IP4_SERVICE_SIGNATURE); - - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - Status = Instance->DataItem[DataType].Status; - if (Status != EFI_NOT_READY) { - - if (Instance->DataItem[DataType].SetData == NULL) { - // - // This type of data is readonly. - // - Status = EFI_WRITE_PROTECTED; - } else { - - Status = Instance->DataItem[DataType].SetData (Instance, DataSize, Data); - if (!EFI_ERROR (Status)) { - // - // Fire up the events registered with this type of data. - // - NetMapIterate (&Instance->DataItem[DataType].EventMap, Ip4Config2SignalEvent, NULL); - Ip4Config2WriteConfigData (IpSb->MacString, Instance); - } else if (Status == EFI_ABORTED) { - // - // The SetData is aborted because the data to set is the same with - // the one maintained. - // - Status = EFI_SUCCESS; - NetMapIterate (&Instance->DataItem[DataType].EventMap, Ip4Config2SignalEvent, NULL); - } - } - } else { - // - // Another asynchornous process is on the way. - // - Status = EFI_ACCESS_DENIED; - } - - gBS->RestoreTPL (OldTpl); - - return Status; -} - -/** - Get the configuration data for the EFI IPv4 network stack running on the communication - device that this EFI_IP4_CONFIG2_PROTOCOL instance manages. - - This function returns the configuration data of type DataType for the EFI IPv4 network - stack running on the communication device that this EFI IPv4 Configuration Protocol instance - manages. - - The caller is responsible for allocating the buffer used to return the specified - configuration data. The required size will be returned to the caller if the size of - the buffer is too small. - - EFI_NOT_READY is returned if the specified configuration data is not ready due to an - asynchronous configuration process already in progress. The caller can call RegisterDataNotify() - to register an event on the specified configuration data. Once the asynchronous configuration - process is finished, the event will be signaled, and a subsequent GetData() call will return - the specified configuration data. - - @param[in] This Pointer to the EFI_IP4_CONFIG2_PROTOCOL instance. - @param[in] DataType The type of data to get. - @param[in, out] DataSize On input, in bytes, the size of Data. On output, in bytes, the - size of buffer required to store the specified configuration data. - @param[in] Data The data buffer in which the configuration data is returned. The - type of the data buffer is associated with the DataType. - This is an optional parameter that may be NULL. - - @retval EFI_SUCCESS The specified configuration data was obtained successfully. - @retval EFI_INVALID_PARAMETER One or more of the followings are TRUE: - - This is NULL. - - DataSize is NULL. - - Data is NULL if *DataSize is not zero. - @retval EFI_BUFFER_TOO_SMALL The size of Data is too small for the specified configuration data, - and the required size is returned in DataSize. - @retval EFI_NOT_READY The specified configuration data is not ready due to an - asynchronous configuration process already in progress. - @retval EFI_NOT_FOUND The specified configuration data is not found. - -**/ -EFI_STATUS -EFIAPI -EfiIp4Config2GetData ( - IN EFI_IP4_CONFIG2_PROTOCOL *This, - IN EFI_IP4_CONFIG2_DATA_TYPE DataType, - IN OUT UINTN *DataSize, - IN VOID *Data OPTIONAL - ) -{ - EFI_TPL OldTpl; - EFI_STATUS Status; - IP4_CONFIG2_INSTANCE *Instance; - IP4_CONFIG2_DATA_ITEM *DataItem; - - if ((This == NULL) || (DataSize == NULL) || ((*DataSize != 0) && (Data == NULL))) { - return EFI_INVALID_PARAMETER; - } - - if (DataType >= Ip4Config2DataTypeMaximum) { - return EFI_NOT_FOUND; - } - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - Instance = IP4_CONFIG2_INSTANCE_FROM_PROTOCOL (This); - DataItem = &Instance->DataItem[DataType]; - - Status = Instance->DataItem[DataType].Status; - if (!EFI_ERROR (Status)) { - - if (DataItem->GetData != NULL) { - - Status = DataItem->GetData (Instance, DataSize, Data); - } else if (*DataSize < Instance->DataItem[DataType].DataSize) { - // - // Update the buffer length. - // - *DataSize = Instance->DataItem[DataType].DataSize; - Status = EFI_BUFFER_TOO_SMALL; - } else { - - *DataSize = Instance->DataItem[DataType].DataSize; - CopyMem (Data, Instance->DataItem[DataType].Data.Ptr, *DataSize); - } - } - - gBS->RestoreTPL (OldTpl); - - return Status; -} - -/** - Register an event that is signaled whenever a configuration process on the specified - configuration data is done. - - This function registers an event that is to be signaled whenever a configuration - process on the specified configuration data is performed. An event can be registered - for a different DataType simultaneously. The caller is responsible for determining - which type of configuration data causes the signaling of the event in such an event. - - @param[in] This Pointer to the EFI_IP4_CONFIG2_PROTOCOL instance. - @param[in] DataType The type of data to unregister the event for. - @param[in] Event The event to register. - - @retval EFI_SUCCESS The notification event for the specified configuration data is - registered. - @retval EFI_INVALID_PARAMETER This is NULL or Event is NULL. - @retval EFI_UNSUPPORTED The configuration data type specified by DataType is not - supported. - @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. - @retval EFI_ACCESS_DENIED The Event is already registered for the DataType. - -**/ -EFI_STATUS -EFIAPI -EfiIp4Config2RegisterDataNotify ( - IN EFI_IP4_CONFIG2_PROTOCOL *This, - IN EFI_IP4_CONFIG2_DATA_TYPE DataType, - IN EFI_EVENT Event - ) -{ - EFI_TPL OldTpl; - EFI_STATUS Status; - IP4_CONFIG2_INSTANCE *Instance; - NET_MAP *EventMap; - NET_MAP_ITEM *Item; - - if ((This == NULL) || (Event == NULL)) { - return EFI_INVALID_PARAMETER; - } - - if (DataType >= Ip4Config2DataTypeMaximum) { - return EFI_UNSUPPORTED; - } - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - Instance = IP4_CONFIG2_INSTANCE_FROM_PROTOCOL (This); - EventMap = &Instance->DataItem[DataType].EventMap; - - // - // Check whether this event is already registered for this DataType. - // - Item = NetMapFindKey (EventMap, Event); - if (Item == NULL) { - - Status = NetMapInsertTail (EventMap, Event, NULL); - - if (EFI_ERROR (Status)) { - - Status = EFI_OUT_OF_RESOURCES; - } - - } else { - - Status = EFI_ACCESS_DENIED; - } - - gBS->RestoreTPL (OldTpl); - - return Status; -} - -/** - Remove a previously registered event for the specified configuration data. - - @param This The pointer to the EFI_IP4_CONFIG2_PROTOCOL instance. - @param DataType The type of data to remove from the previously - registered event. - @param Event The event to be unregistered. - - @retval EFI_SUCCESS The event registered for the specified - configuration data was removed. - @retval EFI_INVALID_PARAMETER This is NULL or Event is NULL. - @retval EFI_NOT_FOUND The Event has not been registered for the - specified DataType. - -**/ -EFI_STATUS -EFIAPI -EfiIp4Config2UnregisterDataNotify ( - IN EFI_IP4_CONFIG2_PROTOCOL *This, - IN EFI_IP4_CONFIG2_DATA_TYPE DataType, - IN EFI_EVENT Event - ) -{ - EFI_TPL OldTpl; - EFI_STATUS Status; - IP4_CONFIG2_INSTANCE *Instance; - NET_MAP_ITEM *Item; - - if ((This == NULL) || (Event == NULL)) { - return EFI_INVALID_PARAMETER; - } - - if (DataType >= Ip4Config2DataTypeMaximum) { - return EFI_NOT_FOUND; - } - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - Instance = IP4_CONFIG2_INSTANCE_FROM_PROTOCOL (This); - - Item = NetMapFindKey (&Instance->DataItem[DataType].EventMap, Event); - if (Item != NULL) { - - NetMapRemoveItem (&Instance->DataItem[DataType].EventMap, Item, NULL); - Status = EFI_SUCCESS; - } else { - - Status = EFI_NOT_FOUND; - } - - gBS->RestoreTPL (OldTpl); - - return Status; -} - -/** - Initialize an IP4_CONFIG2_INSTANCE. - - @param[out] Instance The buffer of IP4_CONFIG2_INSTANCE to be initialized. - - @retval EFI_OUT_OF_RESOURCES Failed to allocate resources to complete the operation. - @retval EFI_SUCCESS The IP4_CONFIG2_INSTANCE initialized successfully. - -**/ -EFI_STATUS -Ip4Config2InitInstance ( - OUT IP4_CONFIG2_INSTANCE *Instance - ) -{ - IP4_SERVICE *IpSb; - IP4_CONFIG2_INSTANCE *TmpInstance; - LIST_ENTRY *Entry; - EFI_STATUS Status; - UINTN Index; - UINT16 IfIndex; - IP4_CONFIG2_DATA_ITEM *DataItem; - - - IpSb = IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance); - - Instance->Signature = IP4_CONFIG2_INSTANCE_SIGNATURE; - - - // - // Determine the index of this interface. - // - IfIndex = 0; - NET_LIST_FOR_EACH (Entry, &mIp4Config2InstanceList) { - TmpInstance = NET_LIST_USER_STRUCT_S (Entry, IP4_CONFIG2_INSTANCE, Link, IP4_CONFIG2_INSTANCE_SIGNATURE); - - if (TmpInstance->IfIndex > IfIndex) { - // - // There is a sequence hole because some interface is down. - // - break; - } - - IfIndex++; - } - - Instance->IfIndex = IfIndex; - NetListInsertBefore (Entry, &Instance->Link); - - for (Index = 0; Index < Ip4Config2DataTypeMaximum; Index++) { - // - // Initialize the event map for each data item. - // - NetMapInit (&Instance->DataItem[Index].EventMap); - } - - - // - // Initialize each data type: associate storage and set data size for the - // fixed size data types, hook the SetData function, set the data attribute. - // - DataItem = &Instance->DataItem[Ip4Config2DataTypeInterfaceInfo]; - DataItem->GetData = Ip4Config2GetIfInfo; - DataItem->Data.Ptr = &Instance->InterfaceInfo; - DataItem->DataSize = sizeof (Instance->InterfaceInfo); - SET_DATA_ATTRIB (DataItem->Attribute, DATA_ATTRIB_SIZE_FIXED | DATA_ATTRIB_VOLATILE); - Ip4Config2InitIfInfo (IpSb, &Instance->InterfaceInfo); - - DataItem = &Instance->DataItem[Ip4Config2DataTypePolicy]; - DataItem->SetData = Ip4Config2SetPolicy; - DataItem->Data.Ptr = &Instance->Policy; - DataItem->DataSize = sizeof (Instance->Policy); - Instance->Policy = Ip4Config2PolicyStatic; - SET_DATA_ATTRIB (DataItem->Attribute, DATA_ATTRIB_SIZE_FIXED); - - DataItem = &Instance->DataItem[Ip4Config2DataTypeManualAddress]; - DataItem->SetData = Ip4Config2SetManualAddress; - DataItem->Status = EFI_NOT_FOUND; - - DataItem = &Instance->DataItem[Ip4Config2DataTypeGateway]; - DataItem->SetData = Ip4Config2SetGateway; - DataItem->Status = EFI_NOT_FOUND; - - DataItem = &Instance->DataItem[Ip4Config2DataTypeDnsServer]; - DataItem->SetData = Ip4Config2SetDnsServer; - DataItem->Status = EFI_NOT_FOUND; - - Instance->Configured = TRUE; - - // - // Try to read the config data from NV variable. - // If not found, write initialized config data into NV variable - // as a default config data. - // - Status = Ip4Config2ReadConfigData (IpSb->MacString, Instance); - if (Status == EFI_NOT_FOUND) { - Status = Ip4Config2WriteConfigData (IpSb->MacString, Instance); - } - - if (EFI_ERROR (Status)) { - return Status; - } - - Instance->Ip4Config2.SetData = EfiIp4Config2SetData; - Instance->Ip4Config2.GetData = EfiIp4Config2GetData; - Instance->Ip4Config2.RegisterDataNotify = EfiIp4Config2RegisterDataNotify; - Instance->Ip4Config2.UnregisterDataNotify = EfiIp4Config2UnregisterDataNotify; - - // - // Publish the IP4 configuration form - // - return Ip4Config2FormInit (Instance); -} - - -/** - Release an IP4_CONFIG2_INSTANCE. - - @param[in, out] Instance The buffer of IP4_CONFIG2_INSTANCE to be freed. - -**/ -VOID -Ip4Config2CleanInstance ( - IN OUT IP4_CONFIG2_INSTANCE *Instance - ) -{ - UINTN Index; - IP4_CONFIG2_DATA_ITEM *DataItem; - - if (Instance->DeclineAddress != NULL) { - FreePool (Instance->DeclineAddress); - } - - if (!Instance->Configured) { - return ; - } - - if (Instance->Dhcp4Handle != NULL) { - - Ip4Config2DestroyDhcp4 (Instance); - } - - // - // Close the event. - // - if (Instance->Dhcp4Event != NULL) { - gBS->CloseEvent (Instance->Dhcp4Event); - Instance->Dhcp4Event = NULL; - } - - for (Index = 0; Index < Ip4Config2DataTypeMaximum; Index++) { - - DataItem = &Instance->DataItem[Index]; - - if (!DATA_ATTRIB_SET (DataItem->Attribute, DATA_ATTRIB_SIZE_FIXED)) { - if (DataItem->Data.Ptr != NULL) { - FreePool (DataItem->Data.Ptr); - } - DataItem->Data.Ptr = NULL; - DataItem->DataSize = 0; - } - - NetMapClean (&Instance->DataItem[Index].EventMap); - } - - Ip4Config2FormUnload (Instance); - - RemoveEntryList (&Instance->Link); -} - -/** - The event handle for IP4 auto reconfiguration. The original default - interface and route table will be removed as the default. - - @param[in] Context The IP4 service binding instance. - -**/ -VOID -EFIAPI -Ip4AutoReconfigCallBackDpc ( - IN VOID *Context - ) -{ - IP4_SERVICE *IpSb; - - IpSb = (IP4_SERVICE *) Context; - NET_CHECK_SIGNATURE (IpSb, IP4_SERVICE_SIGNATURE); - - if (IpSb->State > IP4_SERVICE_UNSTARTED) { - IpSb->State = IP4_SERVICE_UNSTARTED; - } - - IpSb->Reconfig = TRUE; - - Ip4StartAutoConfig (&IpSb->Ip4Config2Instance); - - return ; -} - - -/** - Request Ip4AutoReconfigCallBackDpc as a DPC at TPL_CALLBACK. - - @param Event The event that is signalled. - @param Context The IP4 service binding instance. - -**/ -VOID -EFIAPI -Ip4AutoReconfigCallBack ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - // - // Request Ip4AutoReconfigCallBackDpc as a DPC at TPL_CALLBACK - // - QueueDpc (TPL_CALLBACK, Ip4AutoReconfigCallBackDpc, Context); -} - diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Config2Impl.h b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Config2Impl.h deleted file mode 100644 index 1716dde399..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Config2Impl.h +++ /dev/null @@ -1,294 +0,0 @@ -/** @file - Definitions for EFI IPv4 Configuration II Protocol implementation. - - Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.
- (C) Copyright 2015 Hewlett Packard Enterprise Development LP
- - SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef __IP4_CONFIG2_IMPL_H__ -#define __IP4_CONFIG2_IMPL_H__ - -#define IP4_CONFIG2_INSTANCE_SIGNATURE SIGNATURE_32 ('I', 'P', 'C', '2') -#define IP4_FORM_CALLBACK_INFO_SIGNATURE SIGNATURE_32 ('I', 'F', 'C', 'I') - -#define IP4_CONFIG2_VARIABLE_ATTRIBUTE (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS) - -#define DATA_ATTRIB_SIZE_FIXED 0x1 -#define DATA_ATTRIB_VOLATILE 0x2 - -#define DATA_ATTRIB_SET(Attrib, Bits) (BOOLEAN)((Attrib) & (Bits)) -#define SET_DATA_ATTRIB(Attrib, Bits) ((Attrib) |= (Bits)) -#define REMOVE_DATA_ATTRIB(Attrib, Bits) ((Attrib) &= (~Bits)) - -typedef struct _IP4_CONFIG2_INSTANCE IP4_CONFIG2_INSTANCE; - -#define IP4_CONFIG2_INSTANCE_FROM_PROTOCOL(Proto) \ - CR ((Proto), \ - IP4_CONFIG2_INSTANCE, \ - Ip4Config2, \ - IP4_CONFIG2_INSTANCE_SIGNATURE \ - ) - -#define IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE(Instance) \ - CR ((Instance), \ - IP4_SERVICE, \ - Ip4Config2Instance, \ - IP4_SERVICE_SIGNATURE \ - ) - -#define IP4_CONFIG2_INSTANCE_FROM_FORM_CALLBACK(Callback) \ - CR ((Callback), \ - IP4_CONFIG2_INSTANCE, \ - CallbackInfo, \ - IP4_CONFIG2_INSTANCE_SIGNATURE \ - ) - -#define IP4_FORM_CALLBACK_INFO_FROM_CONFIG_ACCESS(ConfigAccess) \ - CR ((ConfigAccess), \ - IP4_FORM_CALLBACK_INFO, \ - HiiConfigAccessProtocol, \ - IP4_FORM_CALLBACK_INFO_SIGNATURE \ - ) - -/** - The prototype of work function for EfiIp4Config2SetData(). - - @param[in] Instance The pointer to the IP4 config2 instance data. - @param[in] DataSize In bytes, the size of the buffer pointed to by Data. - @param[in] Data The data buffer to set. - - @retval EFI_BAD_BUFFER_SIZE The DataSize does not match the size of the type, - 8 bytes. - @retval EFI_SUCCESS The specified configuration data for the EFI IPv4 - network stack was set successfully. - -**/ -typedef -EFI_STATUS -(*IP4_CONFIG2_SET_DATA) ( - IN IP4_CONFIG2_INSTANCE *Instance, - IN UINTN DataSize, - IN VOID *Data - ); - -/** - The prototype of work function for EfiIp4Config2GetData(). - - @param[in] Instance The pointer to the IP4 config2 instance data. - @param[in, out] DataSize On input, in bytes, the size of Data. On output, in - bytes, the size of buffer required to store the specified - configuration data. - @param[in] Data The data buffer in which the configuration data is returned. - Ignored if DataSize is ZERO. - - @retval EFI_BUFFER_TOO_SMALL The size of Data is too small for the specified - configuration data, and the required size is - returned in DataSize. - @retval EFI_SUCCESS The specified configuration data was obtained successfully. - -**/ -typedef -EFI_STATUS -(*IP4_CONFIG2_GET_DATA) ( - IN IP4_CONFIG2_INSTANCE *Instance, - IN OUT UINTN *DataSize, - IN VOID *Data OPTIONAL - ); - -typedef union { - VOID *Ptr; - EFI_IP4_CONFIG2_INTERFACE_INFO *IfInfo; - EFI_IP4_CONFIG2_POLICY *Policy; - EFI_IP4_CONFIG2_MANUAL_ADDRESS *ManualAddress; - EFI_IPv4_ADDRESS *Gateway; - EFI_IPv4_ADDRESS *DnsServers; -} IP4_CONFIG2_DATA; - -typedef struct { - IP4_CONFIG2_SET_DATA SetData; - IP4_CONFIG2_GET_DATA GetData; - EFI_STATUS Status; - UINT8 Attribute; - NET_MAP EventMap; - IP4_CONFIG2_DATA Data; - UINTN DataSize; -} IP4_CONFIG2_DATA_ITEM; - -typedef struct { - UINT16 Offset; - UINT32 DataSize; - EFI_IP4_CONFIG2_DATA_TYPE DataType; -} IP4_CONFIG2_DATA_RECORD; - -#pragma pack(1) - -// -// heap data that contains the data for each data record. -// -// EFI_IP4_CONFIG2_POLICY Policy; -// UINT32 ManualaddressCount; -// UINT32 GatewayCount; -// UINT32 DnsServersCount; -// EFI_IP4_CONFIG2_MANUAL_ADDRESS ManualAddress[]; -// EFI_IPv4_ADDRESS Gateway[]; -// EFI_IPv4_ADDRESS DnsServers[]; -// -typedef struct { - UINT16 Checksum; - UINT16 DataRecordCount; - IP4_CONFIG2_DATA_RECORD DataRecord[1]; -} IP4_CONFIG2_VARIABLE; - -#pragma pack() - -typedef struct { - EFI_IP4_CONFIG2_POLICY Policy; ///< manual or automatic - EFI_IP4_CONFIG2_MANUAL_ADDRESS *ManualAddress; ///< IP addresses - UINT32 ManualAddressCount; ///< IP addresses count - EFI_IPv4_ADDRESS *GatewayAddress; ///< Gateway address - UINT32 GatewayAddressCount; ///< Gateway address count - EFI_IPv4_ADDRESS *DnsAddress; ///< DNS server address - UINT32 DnsAddressCount; ///< DNS server address count -} IP4_CONFIG2_NVDATA; - -typedef struct _IP4_FORM_CALLBACK_INFO { - UINT32 Signature; - EFI_HANDLE ChildHandle; - EFI_HII_CONFIG_ACCESS_PROTOCOL HiiConfigAccessProtocol; - EFI_DEVICE_PATH_PROTOCOL *HiiVendorDevicePath; - EFI_HII_HANDLE RegisteredHandle; -} IP4_FORM_CALLBACK_INFO; - -struct _IP4_CONFIG2_INSTANCE { - UINT32 Signature; - BOOLEAN Configured; - LIST_ENTRY Link; - UINT16 IfIndex; - - EFI_IP4_CONFIG2_PROTOCOL Ip4Config2; - - EFI_IP4_CONFIG2_INTERFACE_INFO InterfaceInfo; - EFI_IP4_CONFIG2_POLICY Policy; - IP4_CONFIG2_DATA_ITEM DataItem[Ip4Config2DataTypeMaximum]; - - EFI_EVENT Dhcp4SbNotifyEvent; - VOID *Registration; - EFI_HANDLE Dhcp4Handle; - EFI_DHCP4_PROTOCOL *Dhcp4; - BOOLEAN DhcpSuccess; - BOOLEAN OtherInfoOnly; - EFI_EVENT Dhcp4Event; - UINT32 FailedIaAddressCount; - EFI_IPv4_ADDRESS *DeclineAddress; - UINT32 DeclineAddressCount; - - IP4_FORM_CALLBACK_INFO CallbackInfo; - - IP4_CONFIG2_NVDATA Ip4NvData; -}; - -// -// Configure the DHCP to request the routers and netmask -// from server. The DHCP4_TAG_NETMASK is included in Head. -// -#pragma pack(1) -typedef struct { - EFI_DHCP4_PACKET_OPTION Head; - UINT8 Route; - UINT8 Dns; -} IP4_CONFIG2_DHCP4_OPTION; -#pragma pack() - -/** - Read the configuration data from variable storage according to the VarName and - gEfiIp4Config2ProtocolGuid. It checks the integrity of variable data. If the - data is corrupted, it clears the variable data to ZERO. Othewise, it outputs the - configuration data to IP4_CONFIG2_INSTANCE. - - @param[in] VarName The pointer to the variable name - @param[in, out] Instance The pointer to the IP4 config2 instance data. - - @retval EFI_NOT_FOUND The variable can not be found or already corrupted. - @retval EFI_OUT_OF_RESOURCES Fail to allocate resource to complete the operation. - @retval EFI_SUCCESS The configuration data was retrieved successfully. - -**/ -EFI_STATUS -Ip4Config2ReadConfigData ( - IN CHAR16 *VarName, - IN OUT IP4_CONFIG2_INSTANCE *Instance - ); - -/** - Start the DHCP configuration for this IP service instance. - It will locates the EFI_IP4_CONFIG2_PROTOCOL, then start the - DHCP configuration. - - @param[in] Instance The IP4 config2 instance to configure. - - @retval EFI_SUCCESS The auto configuration is successfully started. - @retval Others Failed to start auto configuration. - -**/ -EFI_STATUS -Ip4StartAutoConfig ( - IN IP4_CONFIG2_INSTANCE *Instance - ); - -/** - Initialize an IP4_CONFIG2_INSTANCE. - - @param[out] Instance The buffer of IP4_CONFIG2_INSTANCE to be initialized. - - @retval EFI_OUT_OF_RESOURCES Failed to allocate resources to complete the operation. - @retval EFI_SUCCESS The IP4_CONFIG2_INSTANCE initialized successfully. - -**/ -EFI_STATUS -Ip4Config2InitInstance ( - OUT IP4_CONFIG2_INSTANCE *Instance - ); - -/** - Release an IP4_CONFIG2_INSTANCE. - - @param[in, out] Instance The buffer of IP4_CONFIG2_INSTANCE to be freed. - -**/ -VOID -Ip4Config2CleanInstance ( - IN OUT IP4_CONFIG2_INSTANCE *Instance - ); - -/** - Request Ip4AutoReconfigCallBackDpc as a DPC at TPL_CALLBACK. - - @param Event The event that is signalled. - @param Context The IP4 service binding instance. - -**/ -VOID -EFIAPI -Ip4AutoReconfigCallBack ( - IN EFI_EVENT Event, - IN VOID *Context - ); - -/** - Destroy the Dhcp4 child in IP4_CONFIG2_INSTANCE and release the resources. - - @param[in, out] Instance The buffer of IP4 config2 instance to be freed. - - @retval EFI_SUCCESS The child was successfully destroyed. - @retval Others Failed to destroy the child. - -**/ -EFI_STATUS -Ip4Config2DestroyDhcp4 ( - IN OUT IP4_CONFIG2_INSTANCE *Instance - ); - -#endif diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Config2Nv.c b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Config2Nv.c deleted file mode 100644 index a4d2996a60..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Config2Nv.c +++ /dev/null @@ -1,1444 +0,0 @@ -/** @file - Helper functions for configuring or getting the parameters relating to Ip4. - -Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Ip4Impl.h" - -CHAR16 mIp4Config2StorageName[] = L"IP4_CONFIG2_IFR_NVDATA"; - -/** - Calculate the prefix length of the IPv4 subnet mask. - - @param[in] SubnetMask The IPv4 subnet mask. - - @return The prefix length of the subnet mask. - @retval 0 Other errors as indicated. - -**/ -UINT8 -GetSubnetMaskPrefixLength ( - IN EFI_IPv4_ADDRESS *SubnetMask - ) -{ - UINT8 Len; - UINT32 ReverseMask; - - // - // The SubnetMask is in network byte order. - // - ReverseMask = SwapBytes32 (*(UINT32 *)&SubnetMask[0]); - - // - // Reverse it. - // - ReverseMask = ~ReverseMask; - - if ((ReverseMask & (ReverseMask + 1)) != 0) { - return 0; - } - - Len = 0; - - while (ReverseMask != 0) { - ReverseMask = ReverseMask >> 1; - Len++; - } - - return (UINT8) (32 - Len); -} - -/** - Convert the decimal dotted IPv4 address into the binary IPv4 address. - - @param[in] Str The UNICODE string. - @param[out] Ip The storage to return the IPv4 address. - - @retval EFI_SUCCESS The binary IP address is returned in Ip. - @retval EFI_INVALID_PARAMETER The IP string is malformatted. - -**/ -EFI_STATUS -Ip4Config2StrToIp ( - IN CHAR16 *Str, - OUT EFI_IPv4_ADDRESS *Ip - ) -{ - UINTN Index; - UINTN Number; - - Index = 0; - - while (*Str != L'\0') { - - if (Index > 3) { - return EFI_INVALID_PARAMETER; - } - - Number = 0; - while ((*Str >= L'0') && (*Str <= L'9')) { - Number = Number * 10 + (*Str - L'0'); - Str++; - } - - if (Number > 0xFF) { - return EFI_INVALID_PARAMETER; - } - - Ip->Addr[Index] = (UINT8) Number; - - if ((*Str != L'\0') && (*Str != L'.')) { - // - // The current character should be either the NULL terminator or - // the dot delimiter. - // - return EFI_INVALID_PARAMETER; - } - - if (*Str == L'.') { - // - // Skip the delimiter. - // - Str++; - } - - Index++; - } - - if (Index != 4) { - return EFI_INVALID_PARAMETER; - } - - return EFI_SUCCESS; -} - -/** - Convert the decimal dotted IPv4 addresses separated by space into the binary IPv4 address list. - - @param[in] Str The UNICODE string contains IPv4 addresses. - @param[out] PtrIpList The storage to return the IPv4 address list. - @param[out] IpCount The size of the IPv4 address list. - - @retval EFI_SUCCESS The binary IP address list is returned in PtrIpList. - @retval EFI_OUT_OF_RESOURCES Error occurs in allocating memory. - @retval EFI_INVALID_PARAMETER The IP string is malformatted. - -**/ -EFI_STATUS -Ip4Config2StrToIpList ( - IN CHAR16 *Str, - OUT EFI_IPv4_ADDRESS **PtrIpList, - OUT UINTN *IpCount - ) -{ - UINTN BeginIndex; - UINTN EndIndex; - UINTN Index; - UINTN IpIndex; - CHAR16 *StrTemp; - BOOLEAN SpaceTag; - - BeginIndex = 0; - EndIndex = BeginIndex; - Index = 0; - IpIndex = 0; - StrTemp = NULL; - SpaceTag = TRUE; - - *PtrIpList = NULL; - *IpCount = 0; - - if (Str == NULL) { - return EFI_SUCCESS; - } - - // - // Get the number of Ip. - // - while (*(Str + Index) != L'\0') { - if (*(Str + Index) == L' ') { - SpaceTag = TRUE; - } else { - if (SpaceTag) { - (*IpCount)++; - SpaceTag = FALSE; - } - } - - Index++; - } - - if (*IpCount == 0) { - return EFI_SUCCESS; - } - - // - // Allocate buffer for IpList. - // - *PtrIpList = AllocateZeroPool(*IpCount * sizeof(EFI_IPv4_ADDRESS)); - if (*PtrIpList == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - // - // Get IpList from Str. - // - Index = 0; - while (*(Str + Index) != L'\0') { - if (*(Str + Index) == L' ') { - if(!SpaceTag) { - StrTemp = AllocateZeroPool((EndIndex - BeginIndex + 1) * sizeof(CHAR16)); - if (StrTemp == NULL) { - FreePool(*PtrIpList); - *PtrIpList = NULL; - *IpCount = 0; - return EFI_OUT_OF_RESOURCES; - } - - CopyMem (StrTemp, Str + BeginIndex, (EndIndex - BeginIndex) * sizeof(CHAR16)); - *(StrTemp + (EndIndex - BeginIndex)) = L'\0'; - - if (Ip4Config2StrToIp (StrTemp, &((*PtrIpList)[IpIndex])) != EFI_SUCCESS) { - FreePool(StrTemp); - FreePool(*PtrIpList); - *PtrIpList = NULL; - *IpCount = 0; - return EFI_INVALID_PARAMETER; - } - - BeginIndex = EndIndex; - IpIndex++; - - FreePool(StrTemp); - } - - BeginIndex++; - EndIndex++; - SpaceTag = TRUE; - } else { - EndIndex++; - SpaceTag = FALSE; - } - - Index++; - - if (*(Str + Index) == L'\0') { - if (!SpaceTag) { - StrTemp = AllocateZeroPool((EndIndex - BeginIndex + 1) * sizeof(CHAR16)); - if (StrTemp == NULL) { - FreePool(*PtrIpList); - *PtrIpList = NULL; - *IpCount = 0; - return EFI_OUT_OF_RESOURCES; - } - - CopyMem (StrTemp, Str + BeginIndex, (EndIndex - BeginIndex) * sizeof(CHAR16)); - *(StrTemp + (EndIndex - BeginIndex)) = L'\0'; - - if (Ip4Config2StrToIp (StrTemp, &((*PtrIpList)[IpIndex])) != EFI_SUCCESS) { - FreePool(StrTemp); - FreePool(*PtrIpList); - *PtrIpList = NULL; - *IpCount = 0; - return EFI_INVALID_PARAMETER; - } - - FreePool(StrTemp); - } - } - } - - return EFI_SUCCESS; -} - -/** - Convert the IPv4 address into a dotted string. - - @param[in] Ip The IPv4 address. - @param[out] Str The dotted IP string. - -**/ -VOID -Ip4Config2IpToStr ( - IN EFI_IPv4_ADDRESS *Ip, - OUT CHAR16 *Str - ) -{ - UnicodeSPrint ( - Str, - 2 * IP4_STR_MAX_SIZE, - L"%d.%d.%d.%d", - Ip->Addr[0], - Ip->Addr[1], - Ip->Addr[2], - Ip->Addr[3] - ); -} - - -/** - Convert the IPv4 address list into string consists of several decimal - dotted IPv4 addresses separated by space. - - @param[in] Ip The IPv4 address list. - @param[in] IpCount The size of IPv4 address list. - @param[out] Str The string contains several decimal dotted - IPv4 addresses separated by space. - - @retval EFI_SUCCESS Operation is success. - @retval EFI_OUT_OF_RESOURCES Error occurs in allocating memory. - -**/ -EFI_STATUS -Ip4Config2IpListToStr ( - IN EFI_IPv4_ADDRESS *Ip, - IN UINTN IpCount, - OUT CHAR16 *Str - ) -{ - UINTN Index; - UINTN TemIndex; - UINTN StrIndex; - CHAR16 *TempStr; - EFI_IPv4_ADDRESS *TempIp; - - Index = 0; - TemIndex = 0; - StrIndex = 0; - TempStr = NULL; - TempIp = NULL; - - for (Index = 0; Index < IpCount; Index ++) { - TempIp = Ip + Index; - if (TempStr == NULL) { - TempStr = AllocateZeroPool(2 * IP4_STR_MAX_SIZE); - if (TempStr == NULL) { - return EFI_OUT_OF_RESOURCES; - } - } - - UnicodeSPrint ( - TempStr, - 2 * IP4_STR_MAX_SIZE, - L"%d.%d.%d.%d", - TempIp->Addr[0], - TempIp->Addr[1], - TempIp->Addr[2], - TempIp->Addr[3] - ); - - for (TemIndex = 0; TemIndex < IP4_STR_MAX_SIZE; TemIndex ++) { - if (*(TempStr + TemIndex) == L'\0') { - if (Index == IpCount - 1) { - Str[StrIndex++] = L'\0'; - } else { - Str[StrIndex++] = L' '; - } - break; - } else { - Str[StrIndex++] = *(TempStr + TemIndex); - } - } - } - - if (TempStr != NULL) { - FreePool(TempStr); - } - - return EFI_SUCCESS; -} - -/** - The notify function of create event when performing a manual configuration. - - @param[in] Event The pointer of Event. - @param[in] Context The pointer of Context. - -**/ -VOID -EFIAPI -Ip4Config2ManualAddressNotify ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - *((BOOLEAN *) Context) = TRUE; -} - -/** - Convert the network configuration data into the IFR data. - - @param[in] Instance The IP4 config2 instance. - @param[in, out] IfrNvData The IFR nv data. - - @retval EFI_SUCCESS The configure parameter to IFR data was - set successfully. - @retval EFI_INVALID_PARAMETER Source instance or target IFR data is not available. - @retval Others Other errors as indicated. - -**/ -EFI_STATUS -Ip4Config2ConvertConfigNvDataToIfrNvData ( - IN IP4_CONFIG2_INSTANCE *Instance, - IN OUT IP4_CONFIG2_IFR_NVDATA *IfrNvData - ) -{ - IP4_SERVICE *IpSb; - EFI_IP4_CONFIG2_PROTOCOL *Ip4Config2; - EFI_IP4_CONFIG2_INTERFACE_INFO *Ip4Info; - EFI_IP4_CONFIG2_POLICY Policy; - UINTN DataSize; - UINTN GatewaySize; - EFI_IPv4_ADDRESS GatewayAddress; - EFI_STATUS Status; - UINTN DnsSize; - UINTN DnsCount; - EFI_IPv4_ADDRESS *DnsAddress; - - Status = EFI_SUCCESS; - Ip4Config2 = &Instance->Ip4Config2; - Ip4Info = NULL; - DnsAddress = NULL; - GatewaySize = sizeof (EFI_IPv4_ADDRESS); - - if ((IfrNvData == NULL) || (Instance == NULL)) { - return EFI_INVALID_PARAMETER; - } - - NET_CHECK_SIGNATURE (Instance, IP4_CONFIG2_INSTANCE_SIGNATURE); - - IpSb = IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance); - - if (IpSb->DefaultInterface->Configured) { - IfrNvData->Configure = 1; - } else { - IfrNvData->Configure = 0; - goto Exit; - } - - // - // Get the Policy info. - // - DataSize = sizeof (EFI_IP4_CONFIG2_POLICY); - Status = Ip4Config2->GetData ( - Ip4Config2, - Ip4Config2DataTypePolicy, - &DataSize, - &Policy - ); - if (EFI_ERROR (Status)) { - goto Exit; - } - - if (Policy == Ip4Config2PolicyStatic) { - IfrNvData->DhcpEnable = FALSE; - } else if (Policy == Ip4Config2PolicyDhcp) { - IfrNvData->DhcpEnable = TRUE; - goto Exit; - } - - // - // Get the interface info. - // - DataSize = 0; - Status = Ip4Config2->GetData ( - Ip4Config2, - Ip4Config2DataTypeInterfaceInfo, - &DataSize, - NULL - ); - if (Status != EFI_BUFFER_TOO_SMALL) { - return Status; - } - - Ip4Info = AllocateZeroPool (DataSize); - if (Ip4Info == NULL) { - Status = EFI_OUT_OF_RESOURCES; - return Status; - } - - Status = Ip4Config2->GetData ( - Ip4Config2, - Ip4Config2DataTypeInterfaceInfo, - &DataSize, - Ip4Info - ); - if (EFI_ERROR (Status)) { - goto Exit; - } - - // - // Get the Gateway info. - // - Status = Ip4Config2->GetData ( - Ip4Config2, - Ip4Config2DataTypeGateway, - &GatewaySize, - &GatewayAddress - ); - if (EFI_ERROR (Status)) { - goto Exit; - } - - // - // Get the Dns info. - // - DnsSize = 0; - Status = Ip4Config2->GetData ( - Ip4Config2, - Ip4Config2DataTypeDnsServer, - &DnsSize, - NULL - ); - if ((Status != EFI_BUFFER_TOO_SMALL) && (Status != EFI_NOT_FOUND)) { - goto Exit; - } - - DnsCount = (UINT32) (DnsSize / sizeof (EFI_IPv4_ADDRESS)); - - if (DnsSize > 0) { - DnsAddress = AllocateZeroPool(DnsSize); - if (DnsAddress == NULL) { - Status = EFI_OUT_OF_RESOURCES; - goto Exit; - } - - Status = Ip4Config2->GetData ( - Ip4Config2, - Ip4Config2DataTypeDnsServer, - &DnsSize, - DnsAddress - ); - if (EFI_ERROR (Status)) { - goto Exit; - } - } - - Ip4Config2IpToStr (&Ip4Info->StationAddress, IfrNvData->StationAddress); - Ip4Config2IpToStr (&Ip4Info->SubnetMask, IfrNvData->SubnetMask); - Ip4Config2IpToStr (&GatewayAddress, IfrNvData->GatewayAddress); - Status = Ip4Config2IpListToStr (DnsAddress, DnsCount, IfrNvData->DnsAddress); - -Exit: - - if (DnsAddress != NULL) { - FreePool(DnsAddress); - } - - if (Ip4Info != NULL) { - FreePool(Ip4Info); - } - - return Status; -} - -/** - Convert the IFR data into the network configuration data and set the IP - configure parameters for the NIC. - - @param[in] IfrFormNvData The IFR NV data. - @param[in, out] Instance The IP4 config2 instance. - - @retval EFI_SUCCESS The configure parameter for this NIC was - set successfully. - @retval EFI_INVALID_PARAMETER The address information for setting is invalid. - @retval Others Other errors as indicated. - -**/ -EFI_STATUS -Ip4Config2ConvertIfrNvDataToConfigNvData ( - IN IP4_CONFIG2_IFR_NVDATA *IfrFormNvData, - IN OUT IP4_CONFIG2_INSTANCE *Instance - ) -{ - EFI_STATUS Status; - EFI_IP4_CONFIG2_PROTOCOL *Ip4Cfg2; - IP4_CONFIG2_NVDATA *Ip4NvData; - - EFI_IP_ADDRESS StationAddress; - EFI_IP_ADDRESS SubnetMask; - EFI_IP_ADDRESS Gateway; - IP4_ADDR Ip; - EFI_IPv4_ADDRESS *DnsAddress; - UINTN DnsCount; - UINTN Index; - - EFI_EVENT TimeoutEvent; - EFI_EVENT SetAddressEvent; - BOOLEAN IsAddressOk; - UINTN DataSize; - EFI_INPUT_KEY Key; - - Status = EFI_SUCCESS; - Ip4Cfg2 = &Instance->Ip4Config2; - Ip4NvData = &Instance->Ip4NvData; - - DnsCount = 0; - DnsAddress = NULL; - - TimeoutEvent = NULL; - SetAddressEvent = NULL; - - - - if (Instance == NULL || IfrFormNvData == NULL) { - return EFI_INVALID_PARAMETER; - } - - if (IfrFormNvData->Configure != TRUE) { - return EFI_SUCCESS; - } - - if (IfrFormNvData->DhcpEnable == TRUE) { - Ip4NvData->Policy = Ip4Config2PolicyDhcp; - - Status = Ip4Cfg2->SetData ( - Ip4Cfg2, - Ip4Config2DataTypePolicy, - sizeof (EFI_IP4_CONFIG2_POLICY), - &Ip4NvData->Policy - ); - if (EFI_ERROR(Status)) { - return Status; - } - } else { - // - // Get Ip4NvData from IfrFormNvData if it is valid. - // - Ip4NvData->Policy = Ip4Config2PolicyStatic; - - Status = Ip4Config2StrToIp (IfrFormNvData->SubnetMask, &SubnetMask.v4); - if (EFI_ERROR (Status) || ((SubnetMask.Addr[0] != 0) && (GetSubnetMaskPrefixLength (&SubnetMask.v4) == 0))) { - CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid Subnet Mask!", NULL); - return EFI_INVALID_PARAMETER; - } - - Status = Ip4Config2StrToIp (IfrFormNvData->StationAddress, &StationAddress.v4); - if (EFI_ERROR (Status) || - (SubnetMask.Addr[0] != 0 && !NetIp4IsUnicast (NTOHL (StationAddress.Addr[0]), NTOHL (SubnetMask.Addr[0]))) || - !Ip4StationAddressValid (NTOHL (StationAddress.Addr[0]), NTOHL (SubnetMask.Addr[0]))) { - CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid IP address!", NULL); - return EFI_INVALID_PARAMETER; - } - - Status = Ip4Config2StrToIp (IfrFormNvData->GatewayAddress, &Gateway.v4); - if (EFI_ERROR (Status) || - (Gateway.Addr[0] != 0 && SubnetMask.Addr[0] != 0 && !NetIp4IsUnicast (NTOHL (Gateway.Addr[0]), NTOHL (SubnetMask.Addr[0])))) { - CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid Gateway!", NULL); - return EFI_INVALID_PARAMETER; - } - - Status = Ip4Config2StrToIpList (IfrFormNvData->DnsAddress, &DnsAddress, &DnsCount); - if (!EFI_ERROR (Status) && DnsCount > 0) { - for (Index = 0; Index < DnsCount; Index ++) { - CopyMem (&Ip, &DnsAddress[Index], sizeof (IP4_ADDR)); - if (IP4_IS_UNSPECIFIED (NTOHL (Ip)) || IP4_IS_LOCAL_BROADCAST (NTOHL (Ip))) { - CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid Dns Server!", NULL); - FreePool(DnsAddress); - return EFI_INVALID_PARAMETER; - } - } - } else { - if (EFI_ERROR (Status)) { - CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid Dns Server!", NULL); - } - } - - if (Ip4NvData->ManualAddress != NULL) { - FreePool(Ip4NvData->ManualAddress); - } - Ip4NvData->ManualAddressCount = 1; - Ip4NvData->ManualAddress = AllocateZeroPool(sizeof(EFI_IP4_CONFIG2_MANUAL_ADDRESS)); - if (Ip4NvData->ManualAddress == NULL) { - if (DnsAddress != NULL) { - FreePool(DnsAddress); - } - - return EFI_OUT_OF_RESOURCES; - } - CopyMem(&Ip4NvData->ManualAddress->Address, &StationAddress.v4, sizeof(EFI_IPv4_ADDRESS)); - CopyMem(&Ip4NvData->ManualAddress->SubnetMask, &SubnetMask.v4, sizeof(EFI_IPv4_ADDRESS)); - - if (Ip4NvData->GatewayAddress != NULL) { - FreePool(Ip4NvData->GatewayAddress); - } - Ip4NvData->GatewayAddressCount = 1; - Ip4NvData->GatewayAddress = AllocateZeroPool(sizeof(EFI_IPv4_ADDRESS)); - if (Ip4NvData->GatewayAddress == NULL) { - if (DnsAddress != NULL) { - FreePool(DnsAddress); - } - return EFI_OUT_OF_RESOURCES; - } - CopyMem(Ip4NvData->GatewayAddress, &Gateway.v4, sizeof(EFI_IPv4_ADDRESS)); - - if (Ip4NvData->DnsAddress != NULL) { - FreePool(Ip4NvData->DnsAddress); - } - Ip4NvData->DnsAddressCount = (UINT32) DnsCount; - Ip4NvData->DnsAddress = DnsAddress; - - // - // Setting Ip4NvData. - // - Status = Ip4Cfg2->SetData ( - Ip4Cfg2, - Ip4Config2DataTypePolicy, - sizeof (EFI_IP4_CONFIG2_POLICY), - &Ip4NvData->Policy - ); - if (EFI_ERROR(Status)) { - return Status; - } - - // - // Create events & timers for asynchronous settings. - // - Status = gBS->CreateEvent ( - EVT_TIMER, - TPL_CALLBACK, - NULL, - NULL, - &TimeoutEvent - ); - if (EFI_ERROR (Status)) { - return EFI_OUT_OF_RESOURCES; - } - - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, - Ip4Config2ManualAddressNotify, - &IsAddressOk, - &SetAddressEvent - ); - if (EFI_ERROR (Status)) { - goto Exit; - } - - IsAddressOk = FALSE; - - Status = Ip4Cfg2->RegisterDataNotify ( - Ip4Cfg2, - Ip4Config2DataTypeManualAddress, - SetAddressEvent - ); - if (EFI_ERROR (Status)) { - goto Exit; - } - - // - // Set ManualAddress. - // - DataSize = Ip4NvData->ManualAddressCount * sizeof (EFI_IP4_CONFIG2_MANUAL_ADDRESS); - Status = Ip4Cfg2->SetData ( - Ip4Cfg2, - Ip4Config2DataTypeManualAddress, - DataSize, - (VOID *) Ip4NvData->ManualAddress - ); - - if (Status == EFI_NOT_READY) { - gBS->SetTimer (TimeoutEvent, TimerRelative, 50000000); - while (EFI_ERROR (gBS->CheckEvent (TimeoutEvent))) { - if (IsAddressOk) { - Status = EFI_SUCCESS; - break; - } - } - } - - Ip4Cfg2->UnregisterDataNotify ( - Ip4Cfg2, - Ip4Config2DataTypeManualAddress, - SetAddressEvent - ); - if (EFI_ERROR (Status)) { - goto Exit; - } - - // - // Set gateway. - // - DataSize = Ip4NvData->GatewayAddressCount * sizeof (EFI_IPv4_ADDRESS); - Status = Ip4Cfg2->SetData ( - Ip4Cfg2, - Ip4Config2DataTypeGateway, - DataSize, - Ip4NvData->GatewayAddress - ); - if (EFI_ERROR (Status)) { - goto Exit; - } - - // - // Set DNS addresses. - // - if (Ip4NvData->DnsAddressCount > 0 && Ip4NvData->DnsAddress != NULL) { - DataSize = Ip4NvData->DnsAddressCount * sizeof (EFI_IPv4_ADDRESS); - Status = Ip4Cfg2->SetData ( - Ip4Cfg2, - Ip4Config2DataTypeDnsServer, - DataSize, - Ip4NvData->DnsAddress - ); - - if (EFI_ERROR (Status)) { - goto Exit; - } - } - } - -Exit: - if (SetAddressEvent != NULL) { - gBS->CloseEvent (SetAddressEvent); - } - - if (TimeoutEvent != NULL) { - gBS->CloseEvent (TimeoutEvent); - } - - return Status; -} - -/** - This function allows the caller to request the current - configuration for one or more named elements. The resulting - string is in format. Any and all alternative - configuration strings shall also be appended to the end of the - current configuration string. If they are, they must appear - after the current configuration. They must contain the same - routing (GUID, NAME, PATH) as the current configuration string. - They must have an additional description indicating the type of - alternative configuration the string represents, - "ALTCFG=". That (when - converted from Hex UNICODE to binary) is a reference to a - string in the associated string pack. - - @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL. - @param[in] Request A null-terminated Unicode string in - format. Note that this - includes the routing information as well as - the configurable name / value pairs. It is - invalid for this string to be in - format. - @param[out] Progress On return, points to a character in the - Request string. Points to the string's null - terminator if request was successful. Points - to the most recent "&" before the first - failing name / value pair (or the beginning - of the string if the failure is in the first - name / value pair) if the request was not - successful. - @param[out] Results A null-terminated Unicode string in - format which has all values - filled in for the names in the Request string. - String to be allocated by the called function. - - @retval EFI_SUCCESS The Results string is filled with the - values corresponding to all requested - names. - @retval EFI_OUT_OF_RESOURCES Not enough memory to store the - parts of the results that must be - stored awaiting possible future - protocols. - @retval EFI_NOT_FOUND Routing data doesn't match any - known driver. Progress set to the - first character in the routing header. - Note: There is no requirement that the - driver validate the routing data. It - must skip the in order to - process the names. - @retval EFI_INVALID_PARAMETER Illegal syntax. Progress set - to most recent & before the - error or the beginning of the - string. - @retval EFI_INVALID_PARAMETER Unknown name. Progress points - to the & before the name in - question.Currently not implemented. -**/ -EFI_STATUS -EFIAPI -Ip4FormExtractConfig ( - IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This, - IN CONST EFI_STRING Request, - OUT EFI_STRING *Progress, - OUT EFI_STRING *Results - ) -{ - EFI_STATUS Status; - IP4_CONFIG2_INSTANCE *Ip4Config2Instance; - IP4_FORM_CALLBACK_INFO *Private; - IP4_CONFIG2_IFR_NVDATA *IfrFormNvData; - EFI_STRING ConfigRequestHdr; - EFI_STRING ConfigRequest; - BOOLEAN AllocatedRequest; - EFI_STRING FormResult; - UINTN Size; - UINTN BufferSize; - - if (Progress == NULL || Results == NULL) { - return EFI_INVALID_PARAMETER; - } - - Status = EFI_SUCCESS; - IfrFormNvData = NULL; - ConfigRequest = NULL; - FormResult = NULL; - Size = 0; - AllocatedRequest = FALSE; - ConfigRequest = Request; - Private = IP4_FORM_CALLBACK_INFO_FROM_CONFIG_ACCESS(This); - Ip4Config2Instance = IP4_CONFIG2_INSTANCE_FROM_FORM_CALLBACK(Private); - BufferSize = sizeof (IP4_CONFIG2_IFR_NVDATA); - *Progress = Request; - - // - // Check Request data in . - // - if ((Request == NULL) || HiiIsConfigHdrMatch (Request, &gIp4Config2NvDataGuid, mIp4Config2StorageName)) { - IfrFormNvData = AllocateZeroPool (sizeof (IP4_CONFIG2_IFR_NVDATA)); - if (IfrFormNvData == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - Ip4Config2ConvertConfigNvDataToIfrNvData (Ip4Config2Instance, IfrFormNvData); - - if ((Request == NULL) || (StrStr (Request, L"OFFSET") == NULL)) { - // - // Request has no request element, construct full request string. - // Allocate and fill a buffer large enough to hold the template - // followed by "&OFFSET=0&WIDTH=WWWWWWWWWWWWWWWW" followed by a Null-terminator - // - ConfigRequestHdr = HiiConstructConfigHdr (&gIp4Config2NvDataGuid, mIp4Config2StorageName, Private->ChildHandle); - Size = (StrLen (ConfigRequestHdr) + 32 + 1) * sizeof (CHAR16); - ConfigRequest = AllocateZeroPool (Size); - if (ConfigRequest == NULL) { - Status = EFI_OUT_OF_RESOURCES; - goto Failure; - } - AllocatedRequest = TRUE; - - UnicodeSPrint (ConfigRequest, Size, L"%s&OFFSET=0&WIDTH=%016LX", ConfigRequestHdr, (UINT64)BufferSize); - FreePool (ConfigRequestHdr); - } - - // - // Convert buffer data to by helper function BlockToConfig() - // - Status = gHiiConfigRouting->BlockToConfig ( - gHiiConfigRouting, - ConfigRequest, - (UINT8 *) IfrFormNvData, - BufferSize, - &FormResult, - Progress - ); - - FreePool (IfrFormNvData); - - // - // Free the allocated config request string. - // - if (AllocatedRequest) { - FreePool (ConfigRequest); - ConfigRequest = NULL; - } - - if (EFI_ERROR (Status)) { - goto Failure; - } - } - - if (Request == NULL || HiiIsConfigHdrMatch (Request, &gIp4Config2NvDataGuid, mIp4Config2StorageName)) { - *Results = FormResult; - } else { - return EFI_NOT_FOUND; - } - -Failure: - // - // Set Progress string to the original request string. - // - if (Request == NULL) { - *Progress = NULL; - } else if (StrStr (Request, L"OFFSET") == NULL) { - *Progress = Request + StrLen (Request); - } - - return Status; -} - -/** - This function applies changes in a driver's configuration. - Input is a Configuration, which has the routing data for this - driver followed by name / value configuration pairs. The driver - must apply those pairs to its configurable storage. If the - driver's configuration is stored in a linear block of data - and the driver's name / value pairs are in - format, it may use the ConfigToBlock helper function (above) to - simplify the job. Currently not implemented. - - @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL. - @param[in] Configuration A null-terminated Unicode string in - format. - @param[out] Progress A pointer to a string filled in with the - offset of the most recent '&' before the - first failing name / value pair (or the - beginn ing of the string if the failure - is in the first name / value pair) or - the terminating NULL if all was - successful. - - @retval EFI_SUCCESS The results have been distributed or are - awaiting distribution. - @retval EFI_OUT_OF_MEMORY Not enough memory to store the - parts of the results that must be - stored awaiting possible future - protocols. - @retval EFI_INVALID_PARAMETERS Passing in a NULL for the - Results parameter would result - in this type of error. - @retval EFI_NOT_FOUND Target for the specified routing data - was not found. -**/ -EFI_STATUS -EFIAPI -Ip4FormRouteConfig ( - IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This, - IN CONST EFI_STRING Configuration, - OUT EFI_STRING *Progress - ) -{ - EFI_STATUS Status; - UINTN BufferSize; - IP4_CONFIG2_IFR_NVDATA *IfrFormNvData; - IP4_CONFIG2_INSTANCE *Ip4Config2Instance; - IP4_FORM_CALLBACK_INFO *Private; - - Status = EFI_SUCCESS; - IfrFormNvData = NULL; - - if (Configuration == NULL || Progress == NULL) { - return EFI_INVALID_PARAMETER; - } - - *Progress = Configuration; - - Private = IP4_FORM_CALLBACK_INFO_FROM_CONFIG_ACCESS(This); - Ip4Config2Instance = IP4_CONFIG2_INSTANCE_FROM_FORM_CALLBACK(Private); - - // - // Check Routing data in . - // - if (HiiIsConfigHdrMatch (Configuration, &gIp4Config2NvDataGuid, mIp4Config2StorageName)) { - // - // Convert buffer data to by helper function BlockToConfig() - // - IfrFormNvData = AllocateZeroPool (sizeof (IP4_CONFIG2_IFR_NVDATA)); - if (IfrFormNvData == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - BufferSize = 0; - - Status = gHiiConfigRouting->ConfigToBlock ( - gHiiConfigRouting, - Configuration, - (UINT8 *) IfrFormNvData, - &BufferSize, - Progress - ); - if (Status != EFI_BUFFER_TOO_SMALL) { - return Status; - } - - Status = gHiiConfigRouting->ConfigToBlock ( - gHiiConfigRouting, - Configuration, - (UINT8 *) IfrFormNvData, - &BufferSize, - Progress - ); - if (!EFI_ERROR (Status)) { - Status = Ip4Config2ConvertIfrNvDataToConfigNvData (IfrFormNvData, Ip4Config2Instance); - } - - FreePool (IfrFormNvData); - } else { - return EFI_NOT_FOUND; - } - - return Status; - -} - -/** - This function is called to provide results data to the driver. - This data consists of a unique key that is used to identify - which data is either being passed back or being asked for. - - @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL. - @param[in] Action Specifies the type of action taken by the browser. - @param[in] QuestionId A unique value which is sent to the original - exporting driver so that it can identify the type - of data to expect. The format of the data tends to - vary based on the opcode that enerated the callback. - @param[in] Type The type of value for the question. - @param[in] Value A pointer to the data being sent to the original - exporting driver. - @param[out] ActionRequest On return, points to the action requested by the - callback function. - - @retval EFI_SUCCESS The callback successfully handled the action. - @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the - variable and its data. - @retval EFI_DEVICE_ERROR The variable could not be saved. - @retval EFI_UNSUPPORTED The specified Action is not supported by the - callback.Currently not implemented. - @retval EFI_INVALID_PARAMETERS Passing in wrong parameter. - @retval Others Other errors as indicated. - -**/ -EFI_STATUS -EFIAPI -Ip4FormCallback ( - IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This, - IN EFI_BROWSER_ACTION Action, - IN EFI_QUESTION_ID QuestionId, - IN UINT8 Type, - IN EFI_IFR_TYPE_VALUE *Value, - OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest - ) -{ - EFI_STATUS Status; - IP4_CONFIG2_INSTANCE *Instance; - IP4_CONFIG2_IFR_NVDATA *IfrFormNvData; - IP4_FORM_CALLBACK_INFO *Private; - - EFI_IP_ADDRESS StationAddress; - EFI_IP_ADDRESS SubnetMask; - EFI_IP_ADDRESS Gateway; - IP4_ADDR Ip; - EFI_IPv4_ADDRESS *DnsAddress; - UINTN DnsCount; - UINTN Index; - EFI_INPUT_KEY Key; - - IfrFormNvData = NULL; - DnsCount = 0; - DnsAddress = NULL; - - if (Action == EFI_BROWSER_ACTION_CHANGED) { - Private = IP4_FORM_CALLBACK_INFO_FROM_CONFIG_ACCESS(This); - Instance = IP4_CONFIG2_INSTANCE_FROM_FORM_CALLBACK(Private); - - IfrFormNvData = AllocateZeroPool (sizeof (IP4_CONFIG2_IFR_NVDATA)); - if (IfrFormNvData == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - // - // Retrieve uncommitted data from Browser - // - if (!HiiGetBrowserData (&gIp4Config2NvDataGuid, mIp4Config2StorageName, sizeof (IP4_CONFIG2_IFR_NVDATA), (UINT8 *) IfrFormNvData)) { - FreePool (IfrFormNvData); - return EFI_NOT_FOUND; - } - - Status = EFI_SUCCESS; - - switch (QuestionId) { - case KEY_LOCAL_IP: - Status = Ip4Config2StrToIp (IfrFormNvData->StationAddress, &StationAddress.v4); - if (EFI_ERROR (Status) || IP4_IS_UNSPECIFIED (NTOHL (StationAddress.Addr[0])) || IP4_IS_LOCAL_BROADCAST (NTOHL (StationAddress.Addr[0]))) { - CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid IP address!", NULL); - Status = EFI_INVALID_PARAMETER; - } - break; - - case KEY_SUBNET_MASK: - Status = Ip4Config2StrToIp (IfrFormNvData->SubnetMask, &SubnetMask.v4); - if (EFI_ERROR (Status) || ((SubnetMask.Addr[0] != 0) && (GetSubnetMaskPrefixLength (&SubnetMask.v4) == 0))) { - CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid Subnet Mask!", NULL); - Status = EFI_INVALID_PARAMETER; - } - break; - - case KEY_GATE_WAY: - Status = Ip4Config2StrToIp (IfrFormNvData->GatewayAddress, &Gateway.v4); - if (EFI_ERROR (Status) || IP4_IS_LOCAL_BROADCAST(NTOHL(Gateway.Addr[0]))) { - CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid Gateway!", NULL); - Status = EFI_INVALID_PARAMETER; - } - break; - - case KEY_DNS: - Status = Ip4Config2StrToIpList (IfrFormNvData->DnsAddress, &DnsAddress, &DnsCount); - if (!EFI_ERROR (Status) && DnsCount > 0) { - for (Index = 0; Index < DnsCount; Index ++) { - CopyMem (&Ip, &DnsAddress[Index], sizeof (IP4_ADDR)); - if (IP4_IS_UNSPECIFIED (NTOHL (Ip)) || IP4_IS_LOCAL_BROADCAST (NTOHL (Ip))) { - CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid Dns Server!", NULL); - Status = EFI_INVALID_PARAMETER; - break; - } - } - } else { - if (EFI_ERROR (Status)) { - CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid Dns Server!", NULL); - } - } - - if(DnsAddress != NULL) { - FreePool(DnsAddress); - } - break; - - case KEY_SAVE_CHANGES: - Status = Ip4Config2ConvertIfrNvDataToConfigNvData (IfrFormNvData, Instance); - *ActionRequest = EFI_BROWSER_ACTION_REQUEST_SUBMIT; - break; - - default: - break; - } - - FreePool (IfrFormNvData); - - return Status; - } - - // - // All other action return unsupported. - // - return EFI_UNSUPPORTED; -} - -/** - Install HII Config Access protocol for network device and allocate resource. - - @param[in, out] Instance The IP4 config2 Instance. - - @retval EFI_SUCCESS The HII Config Access protocol is installed. - @retval EFI_OUT_OF_RESOURCES Failed to allocate memory. - @retval Others Other errors as indicated. - -**/ -EFI_STATUS -Ip4Config2FormInit ( - IN OUT IP4_CONFIG2_INSTANCE *Instance - ) -{ - EFI_STATUS Status; - IP4_SERVICE *IpSb; - IP4_FORM_CALLBACK_INFO *CallbackInfo; - EFI_HII_CONFIG_ACCESS_PROTOCOL *ConfigAccess; - VENDOR_DEVICE_PATH VendorDeviceNode; - EFI_SERVICE_BINDING_PROTOCOL *MnpSb; - CHAR16 *MacString; - CHAR16 MenuString[128]; - CHAR16 PortString[128]; - CHAR16 *OldMenuString; - EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath; - - IpSb = IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance); - ASSERT (IpSb != NULL); - - CallbackInfo = &Instance->CallbackInfo; - - CallbackInfo->Signature = IP4_FORM_CALLBACK_INFO_SIGNATURE; - - Status = gBS->HandleProtocol ( - IpSb->Controller, - &gEfiDevicePathProtocolGuid, - (VOID **) &ParentDevicePath - ); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Construct device path node for EFI HII Config Access protocol, - // which consists of controller physical device path and one hardware - // vendor guid node. - // - ZeroMem (&VendorDeviceNode, sizeof (VENDOR_DEVICE_PATH)); - VendorDeviceNode.Header.Type = HARDWARE_DEVICE_PATH; - VendorDeviceNode.Header.SubType = HW_VENDOR_DP; - - CopyGuid (&VendorDeviceNode.Guid, &gEfiCallerIdGuid); - - SetDevicePathNodeLength (&VendorDeviceNode.Header, sizeof (VENDOR_DEVICE_PATH)); - CallbackInfo->HiiVendorDevicePath = AppendDevicePathNode ( - ParentDevicePath, - (EFI_DEVICE_PATH_PROTOCOL *) &VendorDeviceNode - ); - if (CallbackInfo->HiiVendorDevicePath == NULL) { - Status = EFI_OUT_OF_RESOURCES; - goto Error; - } - - ConfigAccess = &CallbackInfo->HiiConfigAccessProtocol; - ConfigAccess->ExtractConfig = Ip4FormExtractConfig; - ConfigAccess->RouteConfig = Ip4FormRouteConfig; - ConfigAccess->Callback = Ip4FormCallback; - - // - // Install Device Path Protocol and Config Access protocol on new handle - // - Status = gBS->InstallMultipleProtocolInterfaces ( - &CallbackInfo->ChildHandle, - &gEfiDevicePathProtocolGuid, - CallbackInfo->HiiVendorDevicePath, - &gEfiHiiConfigAccessProtocolGuid, - ConfigAccess, - NULL - ); - - if (!EFI_ERROR (Status)) { - // - // Open the Parent Handle for the child - // - Status = gBS->OpenProtocol ( - IpSb->Controller, - &gEfiManagedNetworkServiceBindingProtocolGuid, - (VOID **) &MnpSb, - IpSb->Image, - CallbackInfo->ChildHandle, - EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER - ); - } - - if (EFI_ERROR (Status)) { - goto Error; - } - - // - // Publish our HII data - // - CallbackInfo->RegisteredHandle = HiiAddPackages ( - &gIp4Config2NvDataGuid, - CallbackInfo->ChildHandle, - Ip4DxeStrings, - Ip4Config2Bin, - NULL - ); - if (CallbackInfo->RegisteredHandle == NULL) { - Status = EFI_OUT_OF_RESOURCES; - goto Error; - } - - // - // Append MAC string in the menu help string and tile help string - // - Status = NetLibGetMacString (IpSb->Controller, IpSb->Image, &MacString); - if (!EFI_ERROR (Status)) { - OldMenuString = HiiGetString ( - CallbackInfo->RegisteredHandle, - STRING_TOKEN (STR_IP4_CONFIG2_FORM_HELP), - NULL - ); - UnicodeSPrint (MenuString, 128, L"%s (MAC:%s)", OldMenuString, MacString); - HiiSetString ( - CallbackInfo->RegisteredHandle, - STRING_TOKEN (STR_IP4_CONFIG2_FORM_HELP), - MenuString, - NULL - ); - - UnicodeSPrint (PortString, 128, L"MAC:%s", MacString); - HiiSetString ( - CallbackInfo->RegisteredHandle, - STRING_TOKEN (STR_IP4_DEVICE_FORM_HELP), - PortString, - NULL - ); - - FreePool (MacString); - FreePool (OldMenuString); - - return EFI_SUCCESS; - } - -Error: - Ip4Config2FormUnload (Instance); - return Status; -} - -/** - Uninstall the HII Config Access protocol for network devices and free up the resources. - - @param[in, out] Instance The IP4 config2 instance to unload a form. - -**/ -VOID -Ip4Config2FormUnload ( - IN OUT IP4_CONFIG2_INSTANCE *Instance - ) -{ - IP4_SERVICE *IpSb; - IP4_FORM_CALLBACK_INFO *CallbackInfo; - IP4_CONFIG2_NVDATA *Ip4NvData; - - IpSb = IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance); - ASSERT (IpSb != NULL); - - CallbackInfo = &Instance->CallbackInfo; - - if (CallbackInfo->ChildHandle != NULL) { - // - // Close the child handle - // - gBS->CloseProtocol ( - IpSb->Controller, - &gEfiManagedNetworkServiceBindingProtocolGuid, - IpSb->Image, - CallbackInfo->ChildHandle - ); - - // - // Uninstall EFI_HII_CONFIG_ACCESS_PROTOCOL - // - gBS->UninstallMultipleProtocolInterfaces ( - CallbackInfo->ChildHandle, - &gEfiDevicePathProtocolGuid, - CallbackInfo->HiiVendorDevicePath, - &gEfiHiiConfigAccessProtocolGuid, - &CallbackInfo->HiiConfigAccessProtocol, - NULL - ); - } - - if (CallbackInfo->HiiVendorDevicePath != NULL) { - FreePool (CallbackInfo->HiiVendorDevicePath); - } - - if (CallbackInfo->RegisteredHandle != NULL) { - // - // Remove HII package list - // - HiiRemovePackages (CallbackInfo->RegisteredHandle); - } - - Ip4NvData = &Instance->Ip4NvData; - - if(Ip4NvData->ManualAddress != NULL) { - FreePool(Ip4NvData->ManualAddress); - } - - if(Ip4NvData->GatewayAddress != NULL) { - FreePool(Ip4NvData->GatewayAddress); - } - - if(Ip4NvData->DnsAddress != NULL) { - FreePool(Ip4NvData->DnsAddress); - } - - Ip4NvData->ManualAddressCount = 0; - Ip4NvData->GatewayAddressCount = 0; - Ip4NvData->DnsAddressCount = 0; -} diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Config2Nv.h b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Config2Nv.h deleted file mode 100644 index f453e19e9b..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Config2Nv.h +++ /dev/null @@ -1,45 +0,0 @@ -/** @file - The header file of IP4Config2Nv.c - -Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef _IP4_CONFIG2NV_H_ -#define _IP4_CONFIG2NV_H_ - -#include "Ip4Impl.h" - -extern UINT8 Ip4Config2Bin[]; -extern UINT8 Ip4DxeStrings[]; - -#define NIC_ITEM_CONFIG_SIZE (sizeof (IP4_CONFIG2_INSTANCE) + (sizeof (EFI_IPv4_ADDRESS) * MAX_IP4_CONFIG_DNS)) - -/** - Install HII Config Access protocol for network device and allocate resource. - - @param[in, out] Instance The IP4 config2 Instance. - - @retval EFI_SUCCESS The HII Config Access protocol is installed. - @retval EFI_OUT_OF_RESOURCES Failed to allocate memory. - @retval Others Other errors as indicated. - -**/ -EFI_STATUS -Ip4Config2FormInit ( - IN OUT IP4_CONFIG2_INSTANCE *Instance - ); - -/** - Uninstall the HII Config Access protocol for network devices and free up the resources. - - @param[in, out] Instance The IP4 config2 instance to unload a form. - -**/ -VOID -Ip4Config2FormUnload ( - IN OUT IP4_CONFIG2_INSTANCE *Instance - ); - -#endif diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Driver.c b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Driver.c deleted file mode 100644 index ebd4dec1df..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Driver.c +++ /dev/null @@ -1,1069 +0,0 @@ -/** @file - The driver binding and service binding protocol for IP4 driver. - -Copyright (c) 2005 - 2019, Intel Corporation. All rights reserved.
-(C) Copyright 2015 Hewlett-Packard Development Company, L.P.
- -SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Ip4Impl.h" - -EFI_DRIVER_BINDING_PROTOCOL gIp4DriverBinding = { - Ip4DriverBindingSupported, - Ip4DriverBindingStart, - Ip4DriverBindingStop, - 0xa, - NULL, - NULL -}; - -BOOLEAN mIpSec2Installed = FALSE; - -/** - Callback function for IpSec2 Protocol install. - - @param[in] Event Event whose notification function is being invoked - @param[in] Context Pointer to the notification function's context - -**/ -VOID -EFIAPI -IpSec2InstalledCallback ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - EFI_STATUS Status; - // - // Test if protocol was even found. - // Notification function will be called at least once. - // - Status = gBS->LocateProtocol (&gEfiIpSec2ProtocolGuid, NULL, (VOID **)&mIpSec); - if (Status == EFI_SUCCESS && mIpSec != NULL) { - // - // Close the event so it does not get called again. - // - gBS->CloseEvent (Event); - - mIpSec2Installed = TRUE; - } -} - -/** - This is the declaration of an EFI image entry point. This entry point is - the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including - both device drivers and bus drivers. - - The entry point for IP4 driver which install the driver - binding and component name protocol on its image. - - @param[in] ImageHandle The firmware allocated handle for the UEFI image. - @param[in] SystemTable A pointer to the EFI System Table. - - @retval EFI_SUCCESS The operation completed successfully. - @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. - -**/ -EFI_STATUS -EFIAPI -Ip4DriverEntryPoint ( - IN EFI_HANDLE ImageHandle, - IN EFI_SYSTEM_TABLE *SystemTable - ) -{ - VOID *Registration; - - EfiCreateProtocolNotifyEvent ( - &gEfiIpSec2ProtocolGuid, - TPL_CALLBACK, - IpSec2InstalledCallback, - NULL, - &Registration - ); - - return EfiLibInstallDriverBindingComponentName2 ( - ImageHandle, - SystemTable, - &gIp4DriverBinding, - ImageHandle, - &gIp4ComponentName, - &gIp4ComponentName2 - ); -} - -/** - Test to see if this driver supports ControllerHandle. This service - is called by the EFI boot service ConnectController(). In - order to make drivers as small as possible, there are a few calling - restrictions for this service. ConnectController() must - follow these calling restrictions. If any other agent wishes to call - Supported() it must also follow these calling restrictions. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to test - @param[in] RemainingDevicePath Optional parameter use to pick a specific child - device to start. - - @retval EFI_SUCCESS This driver supports this device - @retval EFI_ALREADY_STARTED This driver is already running on this device - @retval other This driver does not support this device - -**/ -EFI_STATUS -EFIAPI -Ip4DriverBindingSupported ( - IN EFI_DRIVER_BINDING_PROTOCOL * This, - IN EFI_HANDLE ControllerHandle, - IN EFI_DEVICE_PATH_PROTOCOL * RemainingDevicePath OPTIONAL - ) -{ - EFI_STATUS Status; - - // - // Test for the MNP service binding Protocol - // - Status = gBS->OpenProtocol ( - ControllerHandle, - &gEfiManagedNetworkServiceBindingProtocolGuid, - NULL, - This->DriverBindingHandle, - ControllerHandle, - EFI_OPEN_PROTOCOL_TEST_PROTOCOL - ); - - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Test for the Arp service binding Protocol - // - Status = gBS->OpenProtocol ( - ControllerHandle, - &gEfiArpServiceBindingProtocolGuid, - NULL, - This->DriverBindingHandle, - ControllerHandle, - EFI_OPEN_PROTOCOL_TEST_PROTOCOL - ); - - return Status; -} - -/** - Clean up a IP4 service binding instance. It will release all - the resource allocated by the instance. The instance may be - partly initialized, or partly destroyed. If a resource is - destroyed, it is marked as that in case the destroy failed and - being called again later. - - @param[in] IpSb The IP4 service binding instance to clean up - - @retval EFI_SUCCESS The resource used by the instance are cleaned up - @retval other Failed to clean up some of the resources. - -**/ -EFI_STATUS -Ip4CleanService ( - IN IP4_SERVICE *IpSb - ); - - -/** - Create a new IP4 driver service binding private instance. - - @param Controller The controller that has MNP service binding - installed - @param ImageHandle The IP4 driver's image handle - @param Service The variable to receive the newly created IP4 - service. - - @retval EFI_OUT_OF_RESOURCES Failed to allocate some resource - @retval EFI_SUCCESS A new IP4 service binding private is created. - @retval other Other error occurs. - -**/ -EFI_STATUS -Ip4CreateService ( - IN EFI_HANDLE Controller, - IN EFI_HANDLE ImageHandle, - OUT IP4_SERVICE **Service - ) -{ - IP4_SERVICE *IpSb; - EFI_STATUS Status; - - ASSERT (Service != NULL); - - *Service = NULL; - - // - // allocate a service private data then initialize all the filed to - // empty resources, so if any thing goes wrong when allocating - // resources, Ip4CleanService can be called to clean it up. - // - IpSb = AllocateZeroPool (sizeof (IP4_SERVICE)); - - if (IpSb == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - IpSb->Signature = IP4_SERVICE_SIGNATURE; - IpSb->ServiceBinding.CreateChild = Ip4ServiceBindingCreateChild; - IpSb->ServiceBinding.DestroyChild = Ip4ServiceBindingDestroyChild; - IpSb->State = IP4_SERVICE_UNSTARTED; - - IpSb->NumChildren = 0; - InitializeListHead (&IpSb->Children); - - InitializeListHead (&IpSb->Interfaces); - IpSb->DefaultInterface = NULL; - IpSb->DefaultRouteTable = NULL; - - Ip4InitAssembleTable (&IpSb->Assemble); - - IpSb->IgmpCtrl.Igmpv1QuerySeen = 0; - InitializeListHead (&IpSb->IgmpCtrl.Groups); - - IpSb->Image = ImageHandle; - IpSb->Controller = Controller; - - IpSb->MnpChildHandle = NULL; - IpSb->Mnp = NULL; - - IpSb->MnpConfigData.ReceivedQueueTimeoutValue = 0; - IpSb->MnpConfigData.TransmitQueueTimeoutValue = 0; - IpSb->MnpConfigData.ProtocolTypeFilter = IP4_ETHER_PROTO; - IpSb->MnpConfigData.EnableUnicastReceive = TRUE; - IpSb->MnpConfigData.EnableMulticastReceive = TRUE; - IpSb->MnpConfigData.EnableBroadcastReceive = TRUE; - IpSb->MnpConfigData.EnablePromiscuousReceive = FALSE; - IpSb->MnpConfigData.FlushQueuesOnReset = TRUE; - IpSb->MnpConfigData.EnableReceiveTimestamps = FALSE; - IpSb->MnpConfigData.DisableBackgroundPolling = FALSE; - - ZeroMem (&IpSb->SnpMode, sizeof (EFI_SIMPLE_NETWORK_MODE)); - - IpSb->Timer = NULL; - IpSb->ReconfigCheckTimer = NULL; - - IpSb->ReconfigEvent = NULL; - - IpSb->Reconfig = FALSE; - - IpSb->MediaPresent = TRUE; - - // - // Create various resources. First create the route table, timer - // event, ReconfigEvent and MNP child. IGMP, interface's initialization depend - // on the MNP child. - // - IpSb->DefaultRouteTable = Ip4CreateRouteTable (); - - if (IpSb->DefaultRouteTable == NULL) { - Status = EFI_OUT_OF_RESOURCES; - goto ON_ERROR; - } - - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL | EVT_TIMER, - TPL_CALLBACK, - Ip4TimerTicking, - IpSb, - &IpSb->Timer - ); - - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL | EVT_TIMER, - TPL_CALLBACK, - Ip4TimerReconfigChecking, - IpSb, - &IpSb->ReconfigCheckTimer - ); - - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, - Ip4AutoReconfigCallBack, - IpSb, - &IpSb->ReconfigEvent - ); - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - Status = NetLibCreateServiceChild ( - Controller, - ImageHandle, - &gEfiManagedNetworkServiceBindingProtocolGuid, - &IpSb->MnpChildHandle - ); - - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - Status = gBS->OpenProtocol ( - IpSb->MnpChildHandle, - &gEfiManagedNetworkProtocolGuid, - (VOID **) &IpSb->Mnp, - ImageHandle, - Controller, - EFI_OPEN_PROTOCOL_BY_DRIVER - ); - - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - Status = Ip4ServiceConfigMnp (IpSb, TRUE); - - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - Status = IpSb->Mnp->GetModeData (IpSb->Mnp, NULL, &IpSb->SnpMode); - - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - Status = Ip4InitIgmp (IpSb); - - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - IpSb->MacString = NULL; - Status = NetLibGetMacString (IpSb->Controller, IpSb->Image, &IpSb->MacString); - - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - IpSb->DefaultInterface = Ip4CreateInterface (IpSb->Mnp, Controller, ImageHandle); - - if (IpSb->DefaultInterface == NULL) { - Status = EFI_OUT_OF_RESOURCES; - goto ON_ERROR; - } - - InsertHeadList (&IpSb->Interfaces, &IpSb->DefaultInterface->Link); - - ZeroMem (&IpSb->Ip4Config2Instance, sizeof (IP4_CONFIG2_INSTANCE)); - - Status = Ip4Config2InitInstance (&IpSb->Ip4Config2Instance); - - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - IpSb->MaxPacketSize = IpSb->SnpMode.MaxPacketSize - sizeof (IP4_HEAD); - if (NetLibGetVlanId (IpSb->Controller) != 0) { - // - // This is a VLAN device, reduce MTU by VLAN tag length - // - IpSb->MaxPacketSize -= NET_VLAN_TAG_LEN; - } - IpSb->OldMaxPacketSize = IpSb->MaxPacketSize; - *Service = IpSb; - - return EFI_SUCCESS; - -ON_ERROR: - Ip4CleanService (IpSb); - FreePool (IpSb); - - return Status; -} - - -/** - Clean up a IP4 service binding instance. It will release all - the resource allocated by the instance. The instance may be - partly initialized, or partly destroyed. If a resource is - destroyed, it is marked as that in case the destroy failed and - being called again later. - - @param[in] IpSb The IP4 service binding instance to clean up - - @retval EFI_SUCCESS The resource used by the instance are cleaned up - @retval other Failed to clean up some of the resources. - -**/ -EFI_STATUS -Ip4CleanService ( - IN IP4_SERVICE *IpSb - ) -{ - EFI_STATUS Status; - - IpSb->State = IP4_SERVICE_DESTROY; - - if (IpSb->Timer != NULL) { - gBS->SetTimer (IpSb->Timer, TimerCancel, 0); - gBS->CloseEvent (IpSb->Timer); - - IpSb->Timer = NULL; - } - - if (IpSb->ReconfigCheckTimer != NULL) { - gBS->SetTimer (IpSb->ReconfigCheckTimer, TimerCancel, 0); - gBS->CloseEvent (IpSb->ReconfigCheckTimer); - - IpSb->ReconfigCheckTimer = NULL; - } - - if (IpSb->DefaultInterface != NULL) { - Status = Ip4FreeInterface (IpSb->DefaultInterface, NULL); - - if (EFI_ERROR (Status)) { - return Status; - } - - IpSb->DefaultInterface = NULL; - } - - if (IpSb->DefaultRouteTable != NULL) { - Ip4FreeRouteTable (IpSb->DefaultRouteTable); - IpSb->DefaultRouteTable = NULL; - } - - Ip4CleanAssembleTable (&IpSb->Assemble); - - if (IpSb->MnpChildHandle != NULL) { - if (IpSb->Mnp != NULL) { - gBS->CloseProtocol ( - IpSb->MnpChildHandle, - &gEfiManagedNetworkProtocolGuid, - IpSb->Image, - IpSb->Controller - ); - - IpSb->Mnp = NULL; - } - - NetLibDestroyServiceChild ( - IpSb->Controller, - IpSb->Image, - &gEfiManagedNetworkServiceBindingProtocolGuid, - IpSb->MnpChildHandle - ); - - IpSb->MnpChildHandle = NULL; - } - - if (IpSb->ReconfigEvent != NULL) { - gBS->CloseEvent (IpSb->ReconfigEvent); - - IpSb->ReconfigEvent = NULL; - } - - IpSb->Reconfig = FALSE; - - if (IpSb->MacString != NULL) { - FreePool (IpSb->MacString); - } - - Ip4Config2CleanInstance (&IpSb->Ip4Config2Instance); - - return EFI_SUCCESS; -} - -/** - Callback function which provided by user to remove one node in NetDestroyLinkList process. - - @param[in] Entry The entry to be removed. - @param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList. - - @retval EFI_SUCCESS The entry has been removed successfully. - @retval Others Fail to remove the entry. - -**/ -EFI_STATUS -EFIAPI -Ip4DestroyChildEntryInHandleBuffer ( - IN LIST_ENTRY *Entry, - IN VOID *Context - ) -{ - IP4_PROTOCOL *IpInstance; - EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; - UINTN NumberOfChildren; - EFI_HANDLE *ChildHandleBuffer; - - if (Entry == NULL || Context == NULL) { - return EFI_INVALID_PARAMETER; - } - - IpInstance = NET_LIST_USER_STRUCT_S (Entry, IP4_PROTOCOL, Link, IP4_PROTOCOL_SIGNATURE); - ServiceBinding = ((IP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *) Context)->ServiceBinding; - NumberOfChildren = ((IP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *) Context)->NumberOfChildren; - ChildHandleBuffer = ((IP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *) Context)->ChildHandleBuffer; - - if (!NetIsInHandleBuffer (IpInstance->Handle, NumberOfChildren, ChildHandleBuffer)) { - return EFI_SUCCESS; - } - - return ServiceBinding->DestroyChild (ServiceBinding, IpInstance->Handle); -} - -/** - Start this driver on ControllerHandle. This service is called by the - EFI boot service ConnectController(). In order to make - drivers as small as possible, there are a few calling restrictions for - this service. ConnectController() must follow these - calling restrictions. If any other agent wishes to call Start() it - must also follow these calling restrictions. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to bind driver to - @param[in] RemainingDevicePath Optional parameter use to pick a specific child - device to start. - - @retval EFI_SUCCESS This driver is added to ControllerHandle - @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle - @retval other This driver does not support this device - -**/ -EFI_STATUS -EFIAPI -Ip4DriverBindingStart ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL - ) -{ - EFI_STATUS Status; - IP4_SERVICE *IpSb; - EFI_IP4_CONFIG2_PROTOCOL *Ip4Cfg2; - UINTN Index; - IP4_CONFIG2_DATA_ITEM *DataItem; - - IpSb = NULL; - Ip4Cfg2 = NULL; - DataItem = NULL; - - // - // Test for the Ip4 service binding protocol - // - Status = gBS->OpenProtocol ( - ControllerHandle, - &gEfiIp4ServiceBindingProtocolGuid, - NULL, - This->DriverBindingHandle, - ControllerHandle, - EFI_OPEN_PROTOCOL_TEST_PROTOCOL - ); - - if (Status == EFI_SUCCESS) { - return EFI_ALREADY_STARTED; - } - - Status = Ip4CreateService (ControllerHandle, This->DriverBindingHandle, &IpSb); - - if (EFI_ERROR (Status)) { - return Status; - } - - ASSERT (IpSb != NULL); - - Ip4Cfg2 = &IpSb->Ip4Config2Instance.Ip4Config2; - - // - // Install the Ip4ServiceBinding Protocol onto ControlerHandle - // - Status = gBS->InstallMultipleProtocolInterfaces ( - &ControllerHandle, - &gEfiIp4ServiceBindingProtocolGuid, - &IpSb->ServiceBinding, - &gEfiIp4Config2ProtocolGuid, - Ip4Cfg2, - NULL - ); - - if (EFI_ERROR (Status)) { - goto FREE_SERVICE; - } - - // - // Read the config data from NV variable again. - // The default data can be changed by other drivers. - // - Status = Ip4Config2ReadConfigData (IpSb->MacString, &IpSb->Ip4Config2Instance); - if (EFI_ERROR (Status)) { - goto UNINSTALL_PROTOCOL; - } - - // - // Consume the installed EFI_IP4_CONFIG2_PROTOCOL to set the default data items. - // - for (Index = Ip4Config2DataTypePolicy; Index < Ip4Config2DataTypeMaximum; Index++) { - DataItem = &IpSb->Ip4Config2Instance.DataItem[Index]; - if (DataItem->Data.Ptr != NULL) { - Status = Ip4Cfg2->SetData ( - Ip4Cfg2, - Index, - DataItem->DataSize, - DataItem->Data.Ptr - ); - if (EFI_ERROR(Status)) { - goto UNINSTALL_PROTOCOL; - } - - if (Index == Ip4Config2DataTypePolicy && (*(DataItem->Data.Policy) == Ip4Config2PolicyDhcp)) { - break; - } - } - } - - // - // Ready to go: start the receiving and timer. - // Ip4Config2SetPolicy maybe call Ip4ReceiveFrame() to set the default interface's RecvRequest first after - // Ip4Config2 instance is initialized. So, EFI_ALREADY_STARTED is the allowed return status. - // - Status = Ip4ReceiveFrame (IpSb->DefaultInterface, NULL, Ip4AccpetFrame, IpSb); - - if (EFI_ERROR (Status) && Status != EFI_ALREADY_STARTED) { - goto UNINSTALL_PROTOCOL; - } - - Status = gBS->SetTimer (IpSb->Timer, TimerPeriodic, TICKS_PER_SECOND); - - if (EFI_ERROR (Status)) { - goto UNINSTALL_PROTOCOL; - } - - Status = gBS->SetTimer (IpSb->ReconfigCheckTimer, TimerPeriodic, 500 * TICKS_PER_MS); - - if (EFI_ERROR (Status)) { - goto UNINSTALL_PROTOCOL; - } - - // - // Initialize the IP4 ID - // - mIp4Id = (UINT16)NET_RANDOM (NetRandomInitSeed ()); - - return Status; - -UNINSTALL_PROTOCOL: - gBS->UninstallMultipleProtocolInterfaces ( - ControllerHandle, - &gEfiIp4ServiceBindingProtocolGuid, - &IpSb->ServiceBinding, - &gEfiIp4Config2ProtocolGuid, - Ip4Cfg2, - NULL - ); - -FREE_SERVICE: - Ip4CleanService (IpSb); - FreePool (IpSb); - return Status; -} - - -/** - Stop this driver on ControllerHandle. This service is called by the - EFI boot service DisconnectController(). In order to - make drivers as small as possible, there are a few calling - restrictions for this service. DisconnectController() - must follow these calling restrictions. If any other agent wishes - to call Stop() it must also follow these calling restrictions. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to stop driver on - @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number - of children is zero stop the entire bus driver. - @param[in] ChildHandleBuffer List of Child Handles to Stop. - - @retval EFI_SUCCESS This driver is removed ControllerHandle - @retval other This driver was not removed from this device - -**/ -EFI_STATUS -EFIAPI -Ip4DriverBindingStop ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN UINTN NumberOfChildren, - IN EFI_HANDLE *ChildHandleBuffer - ) -{ - EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; - IP4_SERVICE *IpSb; - EFI_HANDLE NicHandle; - EFI_STATUS Status; - INTN State; - LIST_ENTRY *List; - IP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT Context; - IP4_INTERFACE *IpIf; - IP4_ROUTE_TABLE *RouteTable; - - BOOLEAN IsDhcp4; - - IsDhcp4 = FALSE; - - NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiManagedNetworkProtocolGuid); - if (NicHandle == NULL) { - NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiArpProtocolGuid); - if (NicHandle == NULL) { - NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiDhcp4ProtocolGuid); - if (NicHandle != NULL) { - IsDhcp4 = TRUE; - } else { - return EFI_SUCCESS; - } - } - } - - Status = gBS->OpenProtocol ( - NicHandle, - &gEfiIp4ServiceBindingProtocolGuid, - (VOID **) &ServiceBinding, - This->DriverBindingHandle, - NicHandle, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - if (EFI_ERROR (Status)) { - return EFI_DEVICE_ERROR; - } - - IpSb = IP4_SERVICE_FROM_PROTOCOL (ServiceBinding); - - if (IsDhcp4) { - Status = Ip4Config2DestroyDhcp4 (&IpSb->Ip4Config2Instance); - gBS->CloseEvent (IpSb->Ip4Config2Instance.Dhcp4Event); - IpSb->Ip4Config2Instance.Dhcp4Event = NULL; - } else if (NumberOfChildren != 0) { - List = &IpSb->Children; - Context.ServiceBinding = ServiceBinding; - Context.NumberOfChildren = NumberOfChildren; - Context.ChildHandleBuffer = ChildHandleBuffer; - Status = NetDestroyLinkList ( - List, - Ip4DestroyChildEntryInHandleBuffer, - &Context, - NULL - ); - } else if (IpSb->DefaultInterface->ArpHandle == ControllerHandle) { - - // - // The ARP protocol for the default interface is being uninstalled and all - // its IP child handles should have been destroyed before. So, release the - // default interface and route table, create a new one and mark it as not started. - // - Ip4CancelReceive (IpSb->DefaultInterface); - Ip4FreeInterface (IpSb->DefaultInterface, NULL); - Ip4FreeRouteTable (IpSb->DefaultRouteTable); - - IpIf = Ip4CreateInterface (IpSb->Mnp, IpSb->Controller, IpSb->Image); - if (IpIf == NULL) { - goto ON_ERROR; - } - RouteTable = Ip4CreateRouteTable (); - if (RouteTable == NULL) { - Ip4FreeInterface (IpIf, NULL); - goto ON_ERROR;; - } - - IpSb->DefaultInterface = IpIf; - InsertHeadList (&IpSb->Interfaces, &IpIf->Link); - IpSb->DefaultRouteTable = RouteTable; - Ip4ReceiveFrame (IpIf, NULL, Ip4AccpetFrame, IpSb); - - IpSb->State = IP4_SERVICE_UNSTARTED; - - } else if (IsListEmpty (&IpSb->Children)) { - State = IpSb->State; - // - // OK, clean other resources then uninstall the service binding protocol. - // - Status = Ip4CleanService (IpSb); - if (EFI_ERROR (Status)) { - IpSb->State = State; - goto ON_ERROR; - } - - gBS->UninstallMultipleProtocolInterfaces ( - NicHandle, - &gEfiIp4ServiceBindingProtocolGuid, - ServiceBinding, - &gEfiIp4Config2ProtocolGuid, - &IpSb->Ip4Config2Instance.Ip4Config2, - NULL - ); - - if (gIp4ControllerNameTable != NULL) { - FreeUnicodeStringTable (gIp4ControllerNameTable); - gIp4ControllerNameTable = NULL; - } - FreePool (IpSb); - } - -ON_ERROR: - return Status; -} - - -/** - Creates a child handle and installs a protocol. - - The CreateChild() function installs a protocol on ChildHandle. - If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. - If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle. - - @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. - @param ChildHandle Pointer to the handle of the child to create. If it is NULL, - then a new handle is created. If it is a pointer to an existing UEFI handle, - then the protocol is added to the existing UEFI handle. - - @retval EFI_SUCCES The protocol was added to ChildHandle. - @retval EFI_INVALID_PARAMETER ChildHandle is NULL. - @retval EFI_OUT_OF_RESOURCES There are not enough resources available to create - the child - @retval other The child handle was not created - -**/ -EFI_STATUS -EFIAPI -Ip4ServiceBindingCreateChild ( - IN EFI_SERVICE_BINDING_PROTOCOL *This, - IN OUT EFI_HANDLE *ChildHandle - ) -{ - IP4_SERVICE *IpSb; - IP4_PROTOCOL *IpInstance; - EFI_TPL OldTpl; - EFI_STATUS Status; - VOID *Mnp; - - if ((This == NULL) || (ChildHandle == NULL)) { - return EFI_INVALID_PARAMETER; - } - - IpSb = IP4_SERVICE_FROM_PROTOCOL (This); - IpInstance = AllocatePool (sizeof (IP4_PROTOCOL)); - - if (IpInstance == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - Ip4InitProtocol (IpSb, IpInstance); - - // - // Install Ip4 onto ChildHandle - // - Status = gBS->InstallMultipleProtocolInterfaces ( - ChildHandle, - &gEfiIp4ProtocolGuid, - &IpInstance->Ip4Proto, - NULL - ); - - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - IpInstance->Handle = *ChildHandle; - - // - // Open the Managed Network protocol BY_CHILD. - // - Status = gBS->OpenProtocol ( - IpSb->MnpChildHandle, - &gEfiManagedNetworkProtocolGuid, - (VOID **) &Mnp, - gIp4DriverBinding.DriverBindingHandle, - IpInstance->Handle, - EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER - ); - if (EFI_ERROR (Status)) { - gBS->UninstallMultipleProtocolInterfaces ( - ChildHandle, - &gEfiIp4ProtocolGuid, - &IpInstance->Ip4Proto, - NULL - ); - - goto ON_ERROR; - } - - // - // Insert it into the service binding instance. - // - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - InsertTailList (&IpSb->Children, &IpInstance->Link); - IpSb->NumChildren++; - - gBS->RestoreTPL (OldTpl); - -ON_ERROR: - - if (EFI_ERROR (Status)) { - - Ip4CleanProtocol (IpInstance); - - FreePool (IpInstance); - } - - return Status; -} - - -/** - Destroys a child handle with a protocol installed on it. - - The DestroyChild() function does the opposite of CreateChild(). It removes a protocol - that was installed by CreateChild() from ChildHandle. If the removed protocol is the - last protocol on ChildHandle, then ChildHandle is destroyed. - - @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. - @param ChildHandle Handle of the child to destroy - - @retval EFI_SUCCES The protocol was removed from ChildHandle. - @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed. - @retval EFI_INVALID_PARAMETER Child handle is NULL. - @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle - because its services are being used. - @retval other The child handle was not destroyed - -**/ -EFI_STATUS -EFIAPI -Ip4ServiceBindingDestroyChild ( - IN EFI_SERVICE_BINDING_PROTOCOL *This, - IN EFI_HANDLE ChildHandle - ) -{ - EFI_STATUS Status; - IP4_SERVICE *IpSb; - IP4_PROTOCOL *IpInstance; - EFI_IP4_PROTOCOL *Ip4; - EFI_TPL OldTpl; - - if ((This == NULL) || (ChildHandle == NULL)) { - return EFI_INVALID_PARAMETER; - } - - // - // Retrieve the private context data structures - // - IpSb = IP4_SERVICE_FROM_PROTOCOL (This); - - Status = gBS->OpenProtocol ( - ChildHandle, - &gEfiIp4ProtocolGuid, - (VOID **) &Ip4, - gIp4DriverBinding.DriverBindingHandle, - ChildHandle, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - - if (EFI_ERROR (Status)) { - return EFI_UNSUPPORTED; - } - - IpInstance = IP4_INSTANCE_FROM_PROTOCOL (Ip4); - - if (IpInstance->Service != IpSb) { - return EFI_INVALID_PARAMETER; - } - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - // - // A child can be destroyed more than once. For example, - // Ip4DriverBindingStop will destroy all of its children. - // when UDP driver is being stopped, it will destroy all - // the IP child it opens. - // - if (IpInstance->InDestroy) { - gBS->RestoreTPL (OldTpl); - return EFI_SUCCESS; - } - - IpInstance->InDestroy = TRUE; - - // - // Close the Managed Network protocol. - // - gBS->CloseProtocol ( - IpSb->MnpChildHandle, - &gEfiManagedNetworkProtocolGuid, - gIp4DriverBinding.DriverBindingHandle, - ChildHandle - ); - - if (IpInstance->Interface != NULL && IpInstance->Interface->Arp != NULL) { - gBS->CloseProtocol ( - IpInstance->Interface->ArpHandle, - &gEfiArpProtocolGuid, - gIp4DriverBinding.DriverBindingHandle, - ChildHandle - ); - } - - // - // Uninstall the IP4 protocol first. Many thing happens during - // this: - // 1. The consumer of the IP4 protocol will be stopped if it - // opens the protocol BY_DRIVER. For eaxmple, if MNP driver is - // stopped, IP driver's stop function will be called, and uninstall - // EFI_IP4_PROTOCOL will trigger the UDP's stop function. This - // makes it possible to create the network stack bottom up, and - // stop it top down. - // 2. the upper layer will recycle the received packet. The recycle - // event's TPL is higher than this function. The recycle events - // will be called back before preceeding. If any packets not recycled, - // that means there is a resource leak. - // - gBS->RestoreTPL (OldTpl); - Status = gBS->UninstallProtocolInterface ( - ChildHandle, - &gEfiIp4ProtocolGuid, - &IpInstance->Ip4Proto - ); - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - if (EFI_ERROR (Status)) { - IpInstance->InDestroy = FALSE; - goto ON_ERROR; - } - - Status = Ip4CleanProtocol (IpInstance); - if (EFI_ERROR (Status)) { - gBS->InstallMultipleProtocolInterfaces ( - &ChildHandle, - &gEfiIp4ProtocolGuid, - Ip4, - NULL - ); - - goto ON_ERROR; - } - - RemoveEntryList (&IpInstance->Link); - IpSb->NumChildren--; - - gBS->RestoreTPL (OldTpl); - - FreePool (IpInstance); - return EFI_SUCCESS; - -ON_ERROR: - gBS->RestoreTPL (OldTpl); - - return Status; -} diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Driver.h b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Driver.h deleted file mode 100644 index be37471570..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Driver.h +++ /dev/null @@ -1,184 +0,0 @@ -/** @file - -Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef __EFI_IP4_DRIVER_H__ -#define __EFI_IP4_DRIVER_H__ - -#include - -extern EFI_DRIVER_BINDING_PROTOCOL gIp4DriverBinding; -extern EFI_COMPONENT_NAME_PROTOCOL gIp4ComponentName; -extern EFI_COMPONENT_NAME2_PROTOCOL gIp4ComponentName2; -extern EFI_UNICODE_STRING_TABLE *gIp4ControllerNameTable; - -typedef struct { - EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; - UINTN NumberOfChildren; - EFI_HANDLE *ChildHandleBuffer; -} IP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT; - -// -// Function prototype for the driver's entry point -// -/** - This is the declaration of an EFI image entry point. This entry point is - the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including - both device drivers and bus drivers. - - The entry point for IP4 driver which install the driver - binding and component name protocol on its image. - - @param[in] ImageHandle The firmware allocated handle for the UEFI image. - @param[in] SystemTable A pointer to the EFI System Table. - - @retval EFI_SUCCESS The operation completed successfully. - @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. - -**/ -EFI_STATUS -EFIAPI -Ip4DriverEntryPoint ( - IN EFI_HANDLE ImageHandle, - IN EFI_SYSTEM_TABLE *SystemTable - ); - -// -// Function prototypes for the Drivr Binding Protocol -// -/** - Test to see if this driver supports ControllerHandle. This service - is called by the EFI boot service ConnectController(). In - order to make drivers as small as possible, there are a few calling - restrictions for this service. ConnectController() must - follow these calling restrictions. If any other agent wishes to call - Supported() it must also follow these calling restrictions. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to test - @param[in] RemainingDevicePath Optional parameter use to pick a specific child - device to start. - - @retval EFI_SUCCESS This driver supports this device - @retval EFI_ALREADY_STARTED This driver is already running on this device - @retval other This driver does not support this device - -**/ -EFI_STATUS -EFIAPI -Ip4DriverBindingSupported ( - IN EFI_DRIVER_BINDING_PROTOCOL * This, - IN EFI_HANDLE ControllerHandle, - IN EFI_DEVICE_PATH_PROTOCOL * RemainingDevicePath OPTIONAL - ); - -/** - Start this driver on ControllerHandle. This service is called by the - EFI boot service ConnectController(). In order to make - drivers as small as possible, there are a few calling restrictions for - this service. ConnectController() must follow these - calling restrictions. If any other agent wishes to call Start() it - must also follow these calling restrictions. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to bind driver to - @param[in] RemainingDevicePath Optional parameter use to pick a specific child - device to start. - - @retval EFI_SUCCESS This driver is added to ControllerHandle - @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle - @retval other This driver does not support this device - -**/ -EFI_STATUS -EFIAPI -Ip4DriverBindingStart ( - IN EFI_DRIVER_BINDING_PROTOCOL * This, - IN EFI_HANDLE ControllerHandle, - IN EFI_DEVICE_PATH_PROTOCOL * RemainingDevicePath OPTIONAL - ); - -/** - Stop this driver on ControllerHandle. This service is called by the - EFI boot service DisconnectController(). In order to - make drivers as small as possible, there are a few calling - restrictions for this service. DisconnectController() - must follow these calling restrictions. If any other agent wishes - to call Stop() it must also follow these calling restrictions. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to stop driver on - @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number - of children is zero stop the entire bus driver. - @param[in] ChildHandleBuffer List of Child Handles to Stop. - - @retval EFI_SUCCESS This driver is removed ControllerHandle - @retval other This driver was not removed from this device - -**/ -EFI_STATUS -EFIAPI -Ip4DriverBindingStop ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN UINTN NumberOfChildren, - IN EFI_HANDLE *ChildHandleBuffer - ); - -// -// Function prototypes for the ServiceBinding Protocol -// -/** - Creates a child handle and installs a protocol. - - The CreateChild() function installs a protocol on ChildHandle. - If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. - If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle. - - @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. - @param ChildHandle Pointer to the handle of the child to create. If it is NULL, - then a new handle is created. If it is a pointer to an existing UEFI handle, - then the protocol is added to the existing UEFI handle. - - @retval EFI_SUCCES The protocol was added to ChildHandle. - @retval EFI_INVALID_PARAMETER ChildHandle is NULL. - @retval EFI_OUT_OF_RESOURCES There are not enough resources available to create - the child - @retval other The child handle was not created - -**/ -EFI_STATUS -EFIAPI -Ip4ServiceBindingCreateChild ( - IN EFI_SERVICE_BINDING_PROTOCOL *This, - IN OUT EFI_HANDLE *ChildHandle - ); - -/** - Destroys a child handle with a protocol installed on it. - - The DestroyChild() function does the opposite of CreateChild(). It removes a protocol - that was installed by CreateChild() from ChildHandle. If the removed protocol is the - last protocol on ChildHandle, then ChildHandle is destroyed. - - @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. - @param ChildHandle Handle of the child to destroy - - @retval EFI_SUCCES The protocol was removed from ChildHandle. - @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed. - @retval EFI_INVALID_PARAMETER Child handle is NULL. - @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle - because its services are being used. - @retval other The child handle was not destroyed - -**/ -EFI_STATUS -EFIAPI -Ip4ServiceBindingDestroyChild ( - IN EFI_SERVICE_BINDING_PROTOCOL *This, - IN EFI_HANDLE ChildHandle - ); -#endif diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Dxe.inf b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Dxe.inf deleted file mode 100644 index ff9f32174e..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Dxe.inf +++ /dev/null @@ -1,109 +0,0 @@ -## @file -# This module produces EFI IPv4 Protocol and EFI IPv4 Service Binding Protocol. -# -# This module produces EFI IPv4 Protocol upon EFI MNP Protocol and EFI ARP Protocol, -# to provide basic network IPv4 packet I/O services, which includes support for a -# subset of the Internet Control Message Protocol (ICMP) and may include support for -# the Internet Group Management Protocol (IGMP). -# -# Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
-# SPDX-License-Identifier: BSD-2-Clause-Patent -# -# -## - -[Defines] - INF_VERSION = 0x00010005 - BASE_NAME = Ip4Dxe - MODULE_UNI_FILE = Ip4Dxe.uni - FILE_GUID = 9FB1A1F3-3B71-4324-B39A-745CBB015FFF - MODULE_TYPE = UEFI_DRIVER - VERSION_STRING = 1.0 - ENTRY_POINT = Ip4DriverEntryPoint - UNLOAD_IMAGE = NetLibDefaultUnload - -# -# The following information is for reference only and not required by the build tools. -# -# VALID_ARCHITECTURES = IA32 X64 EBC -# -# DRIVER_BINDING = gIp4DriverBinding -# COMPONENT_NAME = gIp4ComponentName -# COMPONENT_NAME2 = gIp4ComponentName2 -# - -[Sources] - Ip4Driver.c - Ip4Option.h - Ip4Route.h - Ip4If.c - Ip4Igmp.h - Ip4Output.c - Ip4Icmp.c - Ip4Igmp.c - Ip4Impl.c - Ip4Common.h - Ip4Impl.h - Ip4Driver.h - Ip4Common.c - Ip4If.h - Ip4Option.c - Ip4Output.h - ComponentName.c - Ip4Input.h - Ip4Route.c - Ip4Icmp.h - Ip4Input.c - Ip4Config2Impl.c - Ip4Config2Impl.h - Ip4Config2.vfr - Ip4DxeStrings.uni - Ip4NvData.h - Ip4Config2Nv.h - Ip4Config2Nv.c - - -[Packages] - MdePkg/MdePkg.dec - MdeModulePkg/MdeModulePkg.dec - -[LibraryClasses] - UefiLib - BaseLib - UefiBootServicesTableLib - UefiDriverEntryPoint - UefiRuntimeServicesTableLib - DebugLib - NetLib - DpcLib - HiiLib - PrintLib - DevicePathLib - UefiHiiServicesLib - -[Protocols] - ## BY_START - ## UNDEFINED # variable - gEfiIp4ServiceBindingProtocolGuid - gEfiIp4ProtocolGuid ## BY_START - gEfiManagedNetworkServiceBindingProtocolGuid ## TO_START - gEfiManagedNetworkProtocolGuid ## TO_START - gEfiArpServiceBindingProtocolGuid ## TO_START - gEfiIp4Config2ProtocolGuid ## BY_START - gEfiArpProtocolGuid ## TO_START - gEfiDhcp4ServiceBindingProtocolGuid ## TO_START - gEfiDhcp4ProtocolGuid ## TO_START - gEfiIpSec2ProtocolGuid ## SOMETIMES_CONSUMES - gEfiHiiConfigAccessProtocolGuid ## BY_START - gEfiDevicePathProtocolGuid ## TO_START - -[Guids] - ## SOMETIMES_CONSUMES ## GUID # HiiIsConfigHdrMatch EFI_NIC_IP4_CONFIG_VARIABLE - ## SOMETIMES_PRODUCES ## GUID # HiiConstructConfigHdr EFI_NIC_IP4_CONFIG_VARIABLE - ## SOMETIMES_PRODUCES ## GUID # HiiGetBrowserData EFI_NIC_IP4_CONFIG_VARIABLE - ## SOMETIMES_CONSUMES ## HII - gIp4Config2NvDataGuid - -[UserExtensions.TianoCore."ExtraFiles"] - Ip4DxeExtra.uni - diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Dxe.uni b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Dxe.uni deleted file mode 100644 index 380d07da0f..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Dxe.uni +++ /dev/null @@ -1,19 +0,0 @@ -// /** @file -// This module produces EFI IPv4 Protocol and EFI IPv4 Service Binding Protocol. -// -// This module produces EFI IPv4 Protocol upon EFI MNP Protocol and EFI ARP Protocol, -// to provide basic network IPv4 packet I/O services, which includes support for a -// subset of the Internet Control Message Protocol (ICMP) and may include support for -// the Internet Group Management Protocol (IGMP). -// -// Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
-// -// SPDX-License-Identifier: BSD-2-Clause-Patent -// -// **/ - - -#string STR_MODULE_ABSTRACT #language en-US "Produces EFI IPv4 Protocol and EFI IPv4 Service Binding Protocol" - -#string STR_MODULE_DESCRIPTION #language en-US "This module produces EFI IPv4 Protocol upon EFI MNP Protocol and EFI ARP Protocol to provide basic network IPv4 packet I/O services, which includes support for a subset of the Internet Control Message Protocol (ICMP), and may include support for the Internet Group Management Protocol (IGMP)." - diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4DxeExtra.uni b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4DxeExtra.uni deleted file mode 100644 index dbbf9d5f90..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4DxeExtra.uni +++ /dev/null @@ -1,14 +0,0 @@ -// /** @file -// Ip4Dxe Localized Strings and Content -// -// Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.
-// -// SPDX-License-Identifier: BSD-2-Clause-Patent -// -// **/ - -#string STR_PROPERTIES_MODULE_NAME -#language en-US -"IP v4 DXE Driver" - - diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4DxeStrings.uni b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4DxeStrings.uni deleted file mode 100644 index c262298f00..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4DxeStrings.uni +++ /dev/null @@ -1,30 +0,0 @@ -// /** @file -// String definitions for Ip4Config2 formset - -// Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.
-// SPDX-License-Identifier: BSD-2-Clause-Patent -// -//**/ - - -/=# - -#langdef en-US "English" - -#string STR_IP4_CONFIG2_FORM_TITLE #language en-US "IPv4 Network Configuration" -#string STR_IP4_CONFIG2_FORM_HELP #language en-US "Configure network parameters." -#string STR_IP4_DEVICE_FORM_TITLE #language en-US "" -#string STR_IP4_DEVICE_FORM_HELP #language en-US "" -#string STR_IP4_CONFIGURE #language en-US "Configured" -#string STR_IP4_CONFIGURE_HELP #language en-US "Indicate whether network address configured successfully or not." -#string STR_IP4_ENABLE_DHCP #language en-US "Enable DHCP" -#string STR_IP4_LOCAL_IP_ADDRESS #language en-US "Local IP Address" -#string STR_IP4_IP_ADDRESS_HELP #language en-US "Enter IP address in dotted-decimal notation. Example: 192.168.10.12\r\n" -#string STR_IP4_LOCAL_MASK #language en-US "Local NetMask" -#string STR_IP4_MASK_HELP #language en-US "Enter NetMask in dotted-decimal notation. Example: 255.255.255.0\r\n" -#string STR_IP4_LOCAL_GATEWAY #language en-US "Local Gateway" -#string STR_IP4_GATEWAY_HELP #language en-US "Enter Gateway in dotted-decimal notation. Example: 192.168.10.1\r\n" -#string STR_IP4_LOCAL_DNS #language en-US "Local DNS Servers" -#string STR_IP4_DNS_HELP #language en-US "Enter DNS Servers in dotted-decimal notation. Example: 192.168.10.8 192.168.10.9\r\n" -#string STR_SAVE_CHANGES #language en-US "Save Changes and Exit" -#string STR_NULL #language en-US "" diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Icmp.c b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Icmp.c deleted file mode 100644 index 052d6b77f7..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Icmp.c +++ /dev/null @@ -1,363 +0,0 @@ -/** @file - -Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Ip4Impl.h" - -IP4_ICMP_CLASS -mIcmpClass[] = { - {ICMP_ECHO_REPLY, ICMP_QUERY_MESSAGE }, - {1, ICMP_INVALID_MESSAGE}, - {2, ICMP_INVALID_MESSAGE}, - {ICMP_DEST_UNREACHABLE, ICMP_ERROR_MESSAGE }, - {ICMP_SOURCE_QUENCH, ICMP_ERROR_MESSAGE }, - {ICMP_REDIRECT, ICMP_ERROR_MESSAGE }, - {6, ICMP_INVALID_MESSAGE}, - {7, ICMP_INVALID_MESSAGE}, - {ICMP_ECHO_REQUEST, ICMP_QUERY_MESSAGE }, - {9, ICMP_INVALID_MESSAGE}, - {10, ICMP_INVALID_MESSAGE}, - {ICMP_TIME_EXCEEDED, ICMP_ERROR_MESSAGE }, - {ICMP_PARAMETER_PROBLEM, ICMP_ERROR_MESSAGE }, - {ICMP_TIMESTAMP , ICMP_QUERY_MESSAGE }, - {14, ICMP_INVALID_MESSAGE}, - {ICMP_INFO_REQUEST , ICMP_QUERY_MESSAGE }, - {ICMP_INFO_REPLY , ICMP_QUERY_MESSAGE }, -}; - -EFI_IP4_ICMP_TYPE -mIp4SupportedIcmp[23] = { - {ICMP_ECHO_REPLY, ICMP_DEFAULT_CODE }, - - {ICMP_DEST_UNREACHABLE, ICMP_NET_UNREACHABLE }, - {ICMP_DEST_UNREACHABLE, ICMP_HOST_UNREACHABLE }, - {ICMP_DEST_UNREACHABLE, ICMP_PROTO_UNREACHABLE }, - {ICMP_DEST_UNREACHABLE, ICMP_PORT_UNREACHABLE }, - {ICMP_DEST_UNREACHABLE, ICMP_FRAGMENT_FAILED }, - {ICMP_DEST_UNREACHABLE, ICMP_SOURCEROUTE_FAILED }, - {ICMP_DEST_UNREACHABLE, ICMP_NET_UNKNOWN }, - {ICMP_DEST_UNREACHABLE, ICMP_HOST_UNKNOWN }, - {ICMP_DEST_UNREACHABLE, ICMP_SOURCE_ISOLATED }, - {ICMP_DEST_UNREACHABLE, ICMP_NET_PROHIBITED }, - {ICMP_DEST_UNREACHABLE, ICMP_HOST_PROHIBITED }, - {ICMP_DEST_UNREACHABLE, ICMP_NET_UNREACHABLE_TOS }, - {ICMP_DEST_UNREACHABLE, ICMP_HOST_UNREACHABLE_TOS}, - - {ICMP_SOURCE_QUENCH, ICMP_DEFAULT_CODE }, - - {ICMP_REDIRECT, ICMP_NET_REDIRECT }, - {ICMP_REDIRECT, ICMP_HOST_REDIRECT }, - {ICMP_REDIRECT, ICMP_NET_TOS_REDIRECT }, - {ICMP_REDIRECT, ICMP_HOST_TOS_REDIRECT }, - - {ICMP_ECHO_REQUEST, ICMP_DEFAULT_CODE }, - - {ICMP_TIME_EXCEEDED, ICMP_TIMEOUT_IN_TRANSIT }, - {ICMP_TIME_EXCEEDED, ICMP_TIMEOUT_REASSEMBLE }, - - {ICMP_PARAMETER_PROBLEM, ICMP_DEFAULT_CODE }, -}; - - - -/** - Process the ICMP redirect. Find the instance then update - its route cache. - - All kinds of redirect is treated as host redirect as - specified by RFC1122 3.3.1.2: - "Since the subnet mask appropriate to the destination - address is generally not known, a Network Redirect - message SHOULD be treated identically to a Host Redirect - message;" - - @param[in] IpSb The IP4 service binding instance that received - the packet. - @param[in] Head The IP head of the received ICMPpacket. - @param[in] Packet The content of the ICMP redirect packet with IP - head removed. - @param[in] Icmp The buffer to store the ICMP error message if - something is wrong. - - @retval EFI_INVALID_PARAMETER The parameter is invalid - @retval EFI_SUCCESS Successfully updated the route caches - -**/ -EFI_STATUS -Ip4ProcessIcmpRedirect ( - IN IP4_SERVICE *IpSb, - IN IP4_HEAD *Head, - IN NET_BUF *Packet, - IN IP4_ICMP_ERROR_HEAD *Icmp - ) -{ - LIST_ENTRY *Entry; - IP4_PROTOCOL *Ip4Instance; - IP4_ROUTE_CACHE_ENTRY *CacheEntry; - IP4_INTERFACE *IpIf; - IP4_ADDR Gateway; - IP4_ADDR Src; - IP4_ADDR Dst; - - // - // Find the interface whose IP address is the source of the - // orgianl IP packet. - // - IpIf = Ip4FindInterface (IpSb, NTOHL (Icmp->IpHead.Src)); - Gateway = NTOHL (Icmp->Fourth); - - // - // discard the packet if the new gateway address it specifies - // is not on the same connected net through which the Redirect - // arrived. (RFC1122 3.2.2.2). - // - if ((IpIf == NULL) || !IP4_NET_EQUAL (Gateway, IpIf->Ip, IpIf->SubnetMask)) { - NetbufFree (Packet); - return EFI_INVALID_PARAMETER; - } - - // - // Update each IP child's route cache on the interface. - // - NET_LIST_FOR_EACH (Entry, &IpIf->IpInstances) { - Ip4Instance = NET_LIST_USER_STRUCT (Entry, IP4_PROTOCOL, AddrLink); - - if (Ip4Instance->RouteTable == NULL) { - continue; - } - - Dst = NTOHL (Icmp->IpHead.Dst); - Src = NTOHL (Icmp->IpHead.Src); - CacheEntry = Ip4FindRouteCache (Ip4Instance->RouteTable, Dst, Src); - - // - // Only update the route cache's gateway if the source of the - // Redirect is the current first-hop gateway - // - if ((CacheEntry != NULL) && (NTOHL (Head->Src) == CacheEntry->NextHop)) { - CacheEntry->NextHop = Gateway; - } - } - - NetbufFree (Packet); - return EFI_SUCCESS; -} - - -/** - Process the ICMP error packet. If it is an ICMP redirect packet, - update call Ip4ProcessIcmpRedirect to update the IP instance's - route cache, otherwise, deliver the packet to upper layer. - - @param[in] IpSb The IP4 service that received the packet. - @param[in] Head The IP4 head of the ICMP error packet - @param[in] Packet The content of the ICMP error with IP4 head - removed. - - @retval EFI_SUCCESS The ICMP error is processed successfully. - @retval EFI_INVALID_PARAMETER The packet is invalid - @retval Others Failed to process the packet. - -**/ -EFI_STATUS -Ip4ProcessIcmpError ( - IN IP4_SERVICE *IpSb, - IN IP4_HEAD *Head, - IN NET_BUF *Packet - ) -{ - IP4_ICMP_ERROR_HEAD Icmp; - - if (Packet->TotalSize < sizeof (Icmp)) { - NetbufFree (Packet); - return EFI_INVALID_PARAMETER; - } - - NetbufCopy (Packet, 0, sizeof (Icmp), (UINT8 *) &Icmp); - - // - // If it is an ICMP redirect error, update the route cache - // as RFC1122. Otherwise, demultiplex it to IP instances. - // - if (Icmp.Head.Type == ICMP_REDIRECT) { - return Ip4ProcessIcmpRedirect (IpSb, Head, Packet, &Icmp); - } - - IP4_GET_CLIP_INFO (Packet)->Status = EFI_ICMP_ERROR; - return Ip4Demultiplex (IpSb, Head, Packet, NULL, 0); -} - - -/** - Replay an ICMP echo request. - - @param[in] IpSb The IP4 service that receivd the packet - @param[in] Head The IP4 head of the ICMP error packet - @param[in] Packet The content of the ICMP error with IP4 head - removed. - - @retval EFI_OUT_OF_RESOURCES Failed to allocate resource. - @retval EFI_SUCCESS The ICMP Echo request is successfully answered. - @retval Others Failed to answer the ICMP echo request. - -**/ -EFI_STATUS -Ip4IcmpReplyEcho ( - IN IP4_SERVICE *IpSb, - IN IP4_HEAD *Head, - IN NET_BUF *Packet - ) -{ - IP4_ICMP_QUERY_HEAD *Icmp; - NET_BUF *Data; - EFI_STATUS Status; - IP4_HEAD ReplyHead; - - // - // make a copy the packet, it is really a bad idea to - // send the MNP's buffer back to MNP. - // - Data = NetbufDuplicate (Packet, NULL, IP4_MAX_HEADLEN); - - if (Data == NULL) { - Status = EFI_OUT_OF_RESOURCES; - goto ON_EXIT; - } - - // - // Change the ICMP type to echo reply, exchange the source - // and destination, then send it. The source is updated to - // use specific destination. See RFC1122. SRR/RR option - // update is omitted. - // - Icmp = (IP4_ICMP_QUERY_HEAD *) NetbufGetByte (Data, 0, NULL); - ASSERT (Icmp != NULL); - Icmp->Head.Type = ICMP_ECHO_REPLY; - Icmp->Head.Checksum = 0; - Icmp->Head.Checksum = (UINT16) (~NetblockChecksum ((UINT8 *) Icmp, Data->TotalSize)); - - ReplyHead.Tos = 0; - ReplyHead.Fragment = 0; - ReplyHead.Ttl = 64; - ReplyHead.Protocol = EFI_IP_PROTO_ICMP; - ReplyHead.Src = 0; - - // - // Ip4Output will select a source for us - // - ReplyHead.Dst = Head->Src; - - Status = Ip4Output ( - IpSb, - NULL, - Data, - &ReplyHead, - NULL, - 0, - IP4_ALLZERO_ADDRESS, - Ip4SysPacketSent, - NULL - ); - if (EFI_ERROR (Status)) { - NetbufFree (Data); - } - -ON_EXIT: - NetbufFree (Packet); - return Status; -} - - -/** - Process the ICMP query message. If it is an ICMP echo - request, answer it. Otherwise deliver it to upper layer. - - @param[in] IpSb The IP4 service that receivd the packet - @param[in] Head The IP4 head of the ICMP query packet - @param[in] Packet The content of the ICMP query with IP4 head - removed. - - @retval EFI_INVALID_PARAMETER The packet is invalid - @retval EFI_SUCCESS The ICMP query message is processed - @retval Others Failed to process ICMP query. - -**/ -EFI_STATUS -Ip4ProcessIcmpQuery ( - IN IP4_SERVICE *IpSb, - IN IP4_HEAD *Head, - IN NET_BUF *Packet - ) -{ - IP4_ICMP_QUERY_HEAD Icmp; - - if (Packet->TotalSize < sizeof (Icmp)) { - NetbufFree (Packet); - return EFI_INVALID_PARAMETER; - } - - NetbufCopy (Packet, 0, sizeof (Icmp), (UINT8 *) &Icmp); - - if (Icmp.Head.Type == ICMP_ECHO_REQUEST) { - return Ip4IcmpReplyEcho (IpSb, Head, Packet); - } - - return Ip4Demultiplex (IpSb, Head, Packet, NULL, 0); -} - - -/** - Handle the ICMP packet. First validate the message format, - then according to the message types, process it as query or - error packet. - - @param[in] IpSb The IP4 service that receivd the packet. - @param[in] Head The IP4 head of the ICMP query packet. - @param[in] Packet The content of the ICMP query with IP4 head - removed. - - @retval EFI_INVALID_PARAMETER The packet is malformated. - @retval EFI_SUCCESS The ICMP message is successfully processed. - @retval Others Failed to handle ICMP packet. - -**/ -EFI_STATUS -Ip4IcmpHandle ( - IN IP4_SERVICE *IpSb, - IN IP4_HEAD *Head, - IN NET_BUF *Packet - ) -{ - IP4_ICMP_HEAD Icmp; - UINT16 Checksum; - - if (Packet->TotalSize < sizeof (Icmp)) { - goto DROP; - } - - NetbufCopy (Packet, 0, sizeof (Icmp), (UINT8 *) &Icmp); - - if (Icmp.Type > ICMP_TYPE_MAX) { - goto DROP; - } - - Checksum = (UINT16) (~NetbufChecksum (Packet)); - if ((Icmp.Checksum != 0) && (Checksum != 0)) { - goto DROP; - } - - if (mIcmpClass[Icmp.Type].IcmpClass == ICMP_ERROR_MESSAGE) { - return Ip4ProcessIcmpError (IpSb, Head, Packet); - - } else if (mIcmpClass[Icmp.Type].IcmpClass == ICMP_QUERY_MESSAGE) { - return Ip4ProcessIcmpQuery (IpSb, Head, Packet); - - } - -DROP: - NetbufFree (Packet); - return EFI_INVALID_PARAMETER; -} diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Icmp.h b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Icmp.h deleted file mode 100644 index 922886a96e..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Icmp.h +++ /dev/null @@ -1,97 +0,0 @@ -/** @file - Header file for ICMP protocol. - -Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef __EFI_IP4_ICMP_H__ -#define __EFI_IP4_ICMP_H__ - - // - // ICMP type definations - // -#define ICMP_ECHO_REPLY 0 -#define ICMP_DEST_UNREACHABLE 3 -#define ICMP_SOURCE_QUENCH 4 -#define ICMP_REDIRECT 5 -#define ICMP_ECHO_REQUEST 8 -#define ICMP_TIME_EXCEEDED 11 -#define ICMP_PARAMETER_PROBLEM 12 -#define ICMP_TIMESTAMP 13 -#define ICMP_INFO_REQUEST 15 -#define ICMP_INFO_REPLY 16 -#define ICMP_TYPE_MAX ICMP_INFO_REPLY - -#define ICMP_DEFAULT_CODE 0 - - // - // ICMP code definations for ICMP_DEST_UNREACHABLE - // -#define ICMP_NET_UNREACHABLE 0 -#define ICMP_HOST_UNREACHABLE 1 -#define ICMP_PROTO_UNREACHABLE 2 // Host may generate -#define ICMP_PORT_UNREACHABLE 3 // Host may generate -#define ICMP_FRAGMENT_FAILED 4 -#define ICMP_SOURCEROUTE_FAILED 5 // Host may generate -#define ICMP_NET_UNKNOWN 6 -#define ICMP_HOST_UNKNOWN 7 -#define ICMP_SOURCE_ISOLATED 8 -#define ICMP_NET_PROHIBITED 9 -#define ICMP_HOST_PROHIBITED 10 -#define ICMP_NET_UNREACHABLE_TOS 11 -#define ICMP_HOST_UNREACHABLE_TOS 12 - - // - // ICMP code definations for ICMP_TIME_EXCEEDED - // -#define ICMP_TIMEOUT_IN_TRANSIT 0 -#define ICMP_TIMEOUT_REASSEMBLE 1 // Host may generate - - // - // ICMP code definations for ICMP_TIME_EXCEEDED - // -#define ICMP_NET_REDIRECT 0 -#define ICMP_HOST_REDIRECT 1 -#define ICMP_NET_TOS_REDIRECT 2 -#define ICMP_HOST_TOS_REDIRECT 3 - - // - // ICMP message classes, each class of ICMP message shares - // a common message format. INVALID_MESSAGE is only a flag. - // -#define ICMP_INVALID_MESSAGE 0 -#define ICMP_ERROR_MESSAGE 1 -#define ICMP_QUERY_MESSAGE 2 - -typedef struct { - UINT8 IcmpType; - UINT8 IcmpClass; -} IP4_ICMP_CLASS; - -extern IP4_ICMP_CLASS mIcmpClass[]; -extern EFI_IP4_ICMP_TYPE mIp4SupportedIcmp[]; - -/** - Handle the ICMP packet. First validate the message format, - then according to the message types, process it as query or - error packet. - - @param[in] IpSb The IP4 service that receivd the packet. - @param[in] Head The IP4 head of the ICMP query packet. - @param[in] Packet The content of the ICMP query with IP4 head - removed. - - @retval EFI_INVALID_PARAMETER The packet is malformated. - @retval EFI_SUCCESS The ICMP message is successfully processed. - @retval Others Failed to handle ICMP packet. - -**/ -EFI_STATUS -Ip4IcmpHandle ( - IN IP4_SERVICE *IpSb, - IN IP4_HEAD *Head, - IN NET_BUF *Packet - ); -#endif diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4If.c b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4If.c deleted file mode 100644 index 44b8d9fc8f..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4If.c +++ /dev/null @@ -1,1345 +0,0 @@ -/** @file - Implement IP4 pesudo interface. - -Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Ip4Impl.h" - -// -// Mac address with all zero, used to determine whethter the ARP -// resolve succeeded. Failed ARP requests zero the MAC address buffer. -// -EFI_MAC_ADDRESS mZeroMacAddress; - -/** - Callback funtion when frame transmission is finished. It will - call the frame owner's callback function to tell it the result. - - @param[in] Context Context which is point to the token. - -**/ -VOID -EFIAPI -Ip4OnFrameSentDpc ( - IN VOID *Context - ); - -/** - Request Ip4OnFrameSentDpc as a DPC at TPL_CALLBACK. - - @param[in] Event The transmit token's event. - @param[in] Context Context which is point to the token. - -**/ -VOID -EFIAPI -Ip4OnFrameSent ( - IN EFI_EVENT Event, - IN VOID *Context - ); - -/** - Callback function when ARP request are finished. It will cancelled - all the queued frame if the ARP requests failed. Or transmit them - if the request succeed. - - @param[in] Context The context of the callback, a point to the ARP - queue - -**/ -VOID -EFIAPI -Ip4OnArpResolvedDpc ( - IN VOID *Context - ); - -/** - Request Ip4OnArpResolvedDpc as a DPC at TPL_CALLBACK. - - @param Event The Arp request event. - @param Context The context of the callback, a point to the ARP - queue. - -**/ -VOID -EFIAPI -Ip4OnArpResolved ( - IN EFI_EVENT Event, - IN VOID *Context - ); - -/** - Received a frame from MNP, wrap it in net buffer then deliver - it to IP's input function. The ownship of the packet also - transferred to IP. When Ip is finished with this packet, it - will call NetbufFree to release the packet, NetbufFree will - again call the Ip4RecycleFrame to signal MNP's event and free - the token used. - - @param Context Context for the callback. - -**/ -VOID -EFIAPI -Ip4OnFrameReceivedDpc ( - IN VOID *Context - ); - -/** - Request Ip4OnFrameReceivedDpc as a DPC at TPL_CALLBACK. - - @param Event The receive event delivered to MNP for receive. - @param Context Context for the callback. - -**/ -VOID -EFIAPI -Ip4OnFrameReceived ( - IN EFI_EVENT Event, - IN VOID *Context - ); - -/** - Remove all the frames on the ARP queue that pass the FrameToCancel, - that is, either FrameToCancel is NULL or it returns true for the frame. - - @param[in] ArpQue ARP frame to remove the frames from. - @param[in] IoStatus The status returned to the cancelled frames' - callback function. - @param[in] FrameToCancel Function to select which frame to cancel. - @param[in] Context Opaque parameter to the FrameToCancel. - -**/ -VOID -Ip4CancelFrameArp ( - IN IP4_ARP_QUE *ArpQue, - IN EFI_STATUS IoStatus, - IN IP4_FRAME_TO_CANCEL FrameToCancel OPTIONAL, - IN VOID *Context - ); - - -/** - Wrap a transmit request into a newly allocated IP4_LINK_TX_TOKEN. - - @param[in] Interface The interface to send out to. - @param[in] IpInstance The IpInstance that transmit the packet. NULL if - the packet is sent by the IP4 driver itself. - @param[in] Packet The packet to transmit - @param[in] CallBack Call back function to execute if transmission - finished. - @param[in] Context Opaque parameter to the call back. - @param[in] IpSb The pointer to the IP4 service binding instance. - - @retval Token The wrapped token if succeed - @retval NULL The wrapped token if NULL - -**/ -IP4_LINK_TX_TOKEN * -Ip4WrapLinkTxToken ( - IN IP4_INTERFACE *Interface, - IN IP4_PROTOCOL *IpInstance OPTIONAL, - IN NET_BUF *Packet, - IN IP4_FRAME_CALLBACK CallBack, - IN VOID *Context, - IN IP4_SERVICE *IpSb - ) -{ - EFI_MANAGED_NETWORK_COMPLETION_TOKEN *MnpToken; - EFI_MANAGED_NETWORK_TRANSMIT_DATA *MnpTxData; - IP4_LINK_TX_TOKEN *Token; - EFI_STATUS Status; - UINT32 Count; - - Token = AllocatePool (sizeof (IP4_LINK_TX_TOKEN) + \ - (Packet->BlockOpNum - 1) * sizeof (EFI_MANAGED_NETWORK_FRAGMENT_DATA)); - - if (Token == NULL) { - return NULL; - } - - Token->Signature = IP4_FRAME_TX_SIGNATURE; - InitializeListHead (&Token->Link); - - Token->Interface = Interface; - Token->IpInstance = IpInstance; - Token->IpSb = IpSb; - Token->CallBack = CallBack; - Token->Packet = Packet; - Token->Context = Context; - CopyMem (&Token->DstMac, &mZeroMacAddress, sizeof (Token->DstMac)); - CopyMem (&Token->SrcMac, &Interface->Mac, sizeof (Token->SrcMac)); - - MnpToken = &(Token->MnpToken); - MnpToken->Status = EFI_NOT_READY; - - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, - Ip4OnFrameSent, - Token, - &MnpToken->Event - ); - - if (EFI_ERROR (Status)) { - FreePool (Token); - return NULL; - } - - MnpTxData = &Token->MnpTxData; - MnpToken->Packet.TxData = MnpTxData; - - MnpTxData->DestinationAddress = &Token->DstMac; - MnpTxData->SourceAddress = &Token->SrcMac; - MnpTxData->ProtocolType = IP4_ETHER_PROTO; - MnpTxData->DataLength = Packet->TotalSize; - MnpTxData->HeaderLength = 0; - - Count = Packet->BlockOpNum; - - NetbufBuildExt (Packet, (NET_FRAGMENT *) MnpTxData->FragmentTable, &Count); - MnpTxData->FragmentCount = (UINT16)Count; - - return Token; -} - - -/** - Free the link layer transmit token. It will close the event - then free the memory used. - - @param[in] Token Token to free - -**/ -VOID -Ip4FreeLinkTxToken ( - IN IP4_LINK_TX_TOKEN *Token - ) -{ - NET_CHECK_SIGNATURE (Token, IP4_FRAME_TX_SIGNATURE); - - gBS->CloseEvent (Token->MnpToken.Event); - FreePool (Token); -} - - -/** - Create an IP_ARP_QUE structure to request ARP service. - - @param[in] Interface The interface to send ARP from. - @param[in] DestIp The destination IP (host byte order) to request MAC - for - - @return Point to newly created IP4_ARP_QUE if succeed, otherwise NULL. - -**/ -IP4_ARP_QUE * -Ip4CreateArpQue ( - IN IP4_INTERFACE *Interface, - IN IP4_ADDR DestIp - ) -{ - IP4_ARP_QUE *ArpQue; - EFI_STATUS Status; - - ArpQue = AllocatePool (sizeof (IP4_ARP_QUE)); - - if (ArpQue == NULL) { - return NULL; - } - - ArpQue->Signature = IP4_FRAME_ARP_SIGNATURE; - InitializeListHead (&ArpQue->Link); - - InitializeListHead (&ArpQue->Frames); - ArpQue->Interface = Interface; - - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, - Ip4OnArpResolved, - ArpQue, - &ArpQue->OnResolved - ); - - if (EFI_ERROR (Status)) { - FreePool (ArpQue); - return NULL; - } - - ArpQue->Ip = DestIp; - CopyMem (&ArpQue->Mac, &mZeroMacAddress, sizeof (ArpQue->Mac)); - - return ArpQue; -} - - -/** - Remove all the transmit requests queued on the ARP queue, then free it. - - @param[in] ArpQue Arp queue to free - @param[in] IoStatus The transmit status returned to transmit requests' - callback. - -**/ -VOID -Ip4FreeArpQue ( - IN IP4_ARP_QUE *ArpQue, - IN EFI_STATUS IoStatus - ) -{ - NET_CHECK_SIGNATURE (ArpQue, IP4_FRAME_ARP_SIGNATURE); - - // - // Remove all the frame waiting the ARP response - // - Ip4CancelFrameArp (ArpQue, IoStatus, NULL, NULL); - - gBS->CloseEvent (ArpQue->OnResolved); - FreePool (ArpQue); -} - - -/** - Create a link layer receive token to wrap the receive request - - @param[in] Interface The interface to receive from - @param[in] IpInstance The instance that request the receive (NULL for IP4 - driver itself) - @param[in] CallBack Call back function to execute when finished. - @param[in] Context Opaque parameters to the callback - - @return Point to created IP4_LINK_RX_TOKEN if succeed, otherwise NULL. - -**/ -IP4_LINK_RX_TOKEN * -Ip4CreateLinkRxToken ( - IN IP4_INTERFACE *Interface, - IN IP4_PROTOCOL *IpInstance, - IN IP4_FRAME_CALLBACK CallBack, - IN VOID *Context - ) -{ - EFI_MANAGED_NETWORK_COMPLETION_TOKEN *MnpToken; - IP4_LINK_RX_TOKEN *Token; - EFI_STATUS Status; - - Token = AllocatePool (sizeof (IP4_LINK_RX_TOKEN)); - if (Token == NULL) { - return NULL; - } - - Token->Signature = IP4_FRAME_RX_SIGNATURE; - Token->Interface = Interface; - Token->IpInstance = IpInstance; - Token->CallBack = CallBack; - Token->Context = Context; - - MnpToken = &Token->MnpToken; - MnpToken->Status = EFI_NOT_READY; - - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, - Ip4OnFrameReceived, - Token, - &MnpToken->Event - ); - - if (EFI_ERROR (Status)) { - FreePool (Token); - return NULL; - } - - MnpToken->Packet.RxData = NULL; - return Token; -} - - -/** - Free the link layer request token. It will close the event - then free the memory used. - - @param[in] Token Request token to free. - -**/ -VOID -Ip4FreeFrameRxToken ( - IN IP4_LINK_RX_TOKEN *Token - ) -{ - - NET_CHECK_SIGNATURE (Token, IP4_FRAME_RX_SIGNATURE); - - gBS->CloseEvent (Token->MnpToken.Event); - FreePool (Token); -} - - -/** - Remove all the frames on the ARP queue that pass the FrameToCancel, - that is, either FrameToCancel is NULL or it returns true for the frame. - - @param[in] ArpQue ARP frame to remove the frames from. - @param[in] IoStatus The status returned to the cancelled frames' - callback function. - @param[in] FrameToCancel Function to select which frame to cancel. - @param[in] Context Opaque parameter to the FrameToCancel. - -**/ -VOID -Ip4CancelFrameArp ( - IN IP4_ARP_QUE *ArpQue, - IN EFI_STATUS IoStatus, - IN IP4_FRAME_TO_CANCEL FrameToCancel OPTIONAL, - IN VOID *Context - ) -{ - LIST_ENTRY *Entry; - LIST_ENTRY *Next; - IP4_LINK_TX_TOKEN *Token; - - NET_LIST_FOR_EACH_SAFE (Entry, Next, &ArpQue->Frames) { - Token = NET_LIST_USER_STRUCT (Entry, IP4_LINK_TX_TOKEN, Link); - - if ((FrameToCancel == NULL) || FrameToCancel (Token, Context)) { - RemoveEntryList (Entry); - - Token->CallBack (Token->IpInstance, Token->Packet, IoStatus, 0, Token->Context); - Ip4FreeLinkTxToken (Token); - } - } -} - - -/** - Remove all the frames on the interface that pass the FrameToCancel, - either queued on ARP queues or that have already been delivered to - MNP and not yet recycled. - - @param[in] Interface Interface to remove the frames from. - @param[in] IoStatus The transmit status returned to the frames' - callback. - @param[in] FrameToCancel Function to select the frame to cancel, NULL to - select all. - @param[in] Context Opaque parameters passed to FrameToCancel. - -**/ -VOID -Ip4CancelFrames ( - IN IP4_INTERFACE *Interface, - IN EFI_STATUS IoStatus, - IN IP4_FRAME_TO_CANCEL FrameToCancel OPTIONAL, - IN VOID *Context - ) -{ - LIST_ENTRY *Entry; - LIST_ENTRY *Next; - IP4_ARP_QUE *ArpQue; - IP4_LINK_TX_TOKEN *Token; - - // - // Cancel all the pending frames on ARP requests - // - NET_LIST_FOR_EACH_SAFE (Entry, Next, &Interface->ArpQues) { - ArpQue = NET_LIST_USER_STRUCT (Entry, IP4_ARP_QUE, Link); - - Ip4CancelFrameArp (ArpQue, IoStatus, FrameToCancel, Context); - - if (IsListEmpty (&ArpQue->Frames)) { - Interface->Arp->Cancel (Interface->Arp, &ArpQue->Ip, ArpQue->OnResolved); - } - } - - // - // Cancel all the frames that have been delivered to MNP - // but not yet recycled. - // - NET_LIST_FOR_EACH_SAFE (Entry, Next, &Interface->SentFrames) { - Token = NET_LIST_USER_STRUCT (Entry, IP4_LINK_TX_TOKEN, Link); - - if ((FrameToCancel == NULL) || FrameToCancel (Token, Context)) { - Interface->Mnp->Cancel (Interface->Mnp, &Token->MnpToken); - } - } -} - - -/** - Create an IP4_INTERFACE. Delay the creation of ARP instance until - the interface is configured. - - @param[in] Mnp The shared MNP child of this IP4 service binding - instance. - @param[in] Controller The controller this IP4 service binding instance - is installed. Most like the UNDI handle. - @param[in] ImageHandle This driver's image handle. - - @return Point to the created IP4_INTERFACE, otherwise NULL. - -**/ -IP4_INTERFACE * -Ip4CreateInterface ( - IN EFI_MANAGED_NETWORK_PROTOCOL *Mnp, - IN EFI_HANDLE Controller, - IN EFI_HANDLE ImageHandle - ) -{ - IP4_INTERFACE *Interface; - EFI_SIMPLE_NETWORK_MODE SnpMode; - - Interface = AllocatePool (sizeof (IP4_INTERFACE)); - - if ((Interface == NULL) || (Mnp == NULL)) { - return NULL; - } - - Interface->Signature = IP4_INTERFACE_SIGNATURE; - InitializeListHead (&Interface->Link); - Interface->RefCnt = 1; - - Interface->Ip = IP4_ALLZERO_ADDRESS; - Interface->SubnetMask = IP4_ALLZERO_ADDRESS; - Interface->Configured = FALSE; - - Interface->Controller = Controller; - Interface->Image = ImageHandle; - Interface->Mnp = Mnp; - Interface->Arp = NULL; - Interface->ArpHandle = NULL; - - InitializeListHead (&Interface->ArpQues); - InitializeListHead (&Interface->SentFrames); - - Interface->RecvRequest = NULL; - - // - // Get the interface's Mac address and broadcast mac address from SNP - // - if (EFI_ERROR (Mnp->GetModeData (Mnp, NULL, &SnpMode))) { - FreePool (Interface); - return NULL; - } - - CopyMem (&Interface->Mac, &SnpMode.CurrentAddress, sizeof (Interface->Mac)); - CopyMem (&Interface->BroadcastMac, &SnpMode.BroadcastAddress, sizeof (Interface->BroadcastMac)); - Interface->HwaddrLen = SnpMode.HwAddressSize; - - InitializeListHead (&Interface->IpInstances); - Interface->PromiscRecv = FALSE; - - return Interface; -} - - -/** - Set the interface's address, create and configure - the ARP child if necessary. - - @param Interface The interface to set the address. - @param IpAddr The interface's IP address. - @param SubnetMask The interface's netmask. - - @retval EFI_SUCCESS The interface is configured with Ip/netmask pair, - and a ARP is created for it. - @retval Others Failed to set the interface's address. - -**/ -EFI_STATUS -Ip4SetAddress ( - IN OUT IP4_INTERFACE *Interface, - IN IP4_ADDR IpAddr, - IN IP4_ADDR SubnetMask - ) -{ - EFI_ARP_CONFIG_DATA ArpConfig; - EFI_STATUS Status; - - NET_CHECK_SIGNATURE (Interface, IP4_INTERFACE_SIGNATURE); - - // - // Set the ip/netmask, then compute the subnet broadcast - // and network broadcast for easy access. When computing - // nework broadcast, the subnet mask is most like longer - // than the default netmask (not subneted) as defined in - // RFC793. If that isn't the case, we are aggregating the - // networks, use the subnet's mask instead. - // - Interface->Ip = IpAddr; - Interface->SubnetMask = SubnetMask; - Interface->SubnetBrdcast = (IpAddr | ~SubnetMask); - Interface->NetBrdcast = (IpAddr | ~SubnetMask); - - // - // Do clean up for Arp child - // - if (Interface->ArpHandle != NULL) { - if (Interface->Arp != NULL) { - gBS->CloseProtocol ( - Interface->ArpHandle, - &gEfiArpProtocolGuid, - Interface->Image, - Interface->Controller - ); - - Interface->Arp = NULL; - } - - NetLibDestroyServiceChild ( - Interface->Controller, - Interface->Image, - &gEfiArpServiceBindingProtocolGuid, - &Interface->ArpHandle - ); - - Interface->ArpHandle = NULL; - } - - // - // If the address is NOT all zero, create then configure an ARP child. - // Pay attention: DHCP configures its station address as 0.0.0.0/0 - // - if (IpAddr != IP4_ALLZERO_ADDRESS) { - Status = NetLibCreateServiceChild ( - Interface->Controller, - Interface->Image, - &gEfiArpServiceBindingProtocolGuid, - &Interface->ArpHandle - ); - - if (EFI_ERROR (Status)) { - return Status; - } - - Status = gBS->OpenProtocol ( - Interface->ArpHandle, - &gEfiArpProtocolGuid, - (VOID **) &Interface->Arp, - Interface->Image, - Interface->Controller, - EFI_OPEN_PROTOCOL_BY_DRIVER - ); - - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - IpAddr = HTONL (IpAddr); - ArpConfig.SwAddressType = IP4_ETHER_PROTO; - ArpConfig.SwAddressLength = 4; - ArpConfig.StationAddress = &IpAddr; - ArpConfig.EntryTimeOut = 0; - ArpConfig.RetryCount = 0; - ArpConfig.RetryTimeOut = 0; - - Status = Interface->Arp->Configure (Interface->Arp, &ArpConfig); - - if (EFI_ERROR (Status)) { - gBS->CloseProtocol ( - Interface->ArpHandle, - &gEfiArpProtocolGuid, - Interface->Image, - Interface->Controller - ); - - goto ON_ERROR; - } - } - - Interface->Configured = TRUE; - return EFI_SUCCESS; - -ON_ERROR: - NetLibDestroyServiceChild ( - Interface->Controller, - Interface->Image, - &gEfiArpServiceBindingProtocolGuid, - &Interface->ArpHandle - ); - - return Status; -} - - -/** - Filter function to cancel all the frame related to an IP instance. - - @param[in] Frame The transmit request to test whether to cancel - @param[in] Context The context which is the Ip instance that issued - the transmit. - - @retval TRUE The frame belongs to this instance and is to be - removed - @retval FALSE The frame doesn't belong to this instance. - -**/ -BOOLEAN -Ip4CancelInstanceFrame ( - IN IP4_LINK_TX_TOKEN *Frame, - IN VOID *Context - ) -{ - if (Frame->IpInstance == (IP4_PROTOCOL *) Context) { - return TRUE; - } - - return FALSE; -} - - - -/** - If there is a pending receive request, cancel it. Don't call - the receive request's callback because this function can be only - called if the instance or driver is tearing itself down. It - doesn't make sense to call it back. But it is necessary to call - the transmit token's callback to give it a chance to free the - packet and update the upper layer's transmit request status, say - that from the UDP. - - @param[in] Interface The interface used by the IpInstance - -**/ -VOID -Ip4CancelReceive ( - IN IP4_INTERFACE *Interface - ) -{ - EFI_TPL OldTpl; - IP4_LINK_RX_TOKEN *Token; - - if ((Token = Interface->RecvRequest) != NULL) { - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - Interface->RecvRequest = NULL; - Interface->Mnp->Cancel (Interface->Mnp, &Token->MnpToken); - - gBS->RestoreTPL (OldTpl); - } -} - - -/** - Free the interface used by IpInstance. All the IP instance with - the same Ip/Netmask pair share the same interface. It is reference - counted. All the frames haven't been sent will be cancelled. - Because the IpInstance is optional, the caller must remove - IpInstance from the interface's instance list itself. - - @param[in] Interface The interface used by the IpInstance. - @param[in] IpInstance The Ip instance that free the interface. NULL if - the Ip driver is releasing the default interface. - - @retval EFI_SUCCESS The interface use IpInstance is freed. - -**/ -EFI_STATUS -Ip4FreeInterface ( - IN IP4_INTERFACE *Interface, - IN IP4_PROTOCOL *IpInstance OPTIONAL - ) -{ - NET_CHECK_SIGNATURE (Interface, IP4_INTERFACE_SIGNATURE); - ASSERT (Interface->RefCnt > 0); - - // - // Remove all the pending transmit token related to this IP instance. - // - Ip4CancelFrames (Interface, EFI_ABORTED, Ip4CancelInstanceFrame, IpInstance); - - if (--Interface->RefCnt > 0) { - return EFI_SUCCESS; - } - - // - // Destroy the interface if this is the last IP instance that - // has the address. Remove all the system transmitted packets - // from this interface, cancel the receive request if there is - // one, and destroy the ARP requests. - // - Ip4CancelFrames (Interface, EFI_ABORTED, Ip4CancelInstanceFrame, NULL); - Ip4CancelReceive (Interface); - - ASSERT (IsListEmpty (&Interface->IpInstances)); - ASSERT (IsListEmpty (&Interface->ArpQues)); - ASSERT (IsListEmpty (&Interface->SentFrames)); - - if (Interface->Arp != NULL) { - gBS->CloseProtocol ( - Interface->ArpHandle, - &gEfiArpProtocolGuid, - Interface->Image, - Interface->Controller - ); - - NetLibDestroyServiceChild ( - Interface->Controller, - Interface->Image, - &gEfiArpServiceBindingProtocolGuid, - Interface->ArpHandle - ); - } - - RemoveEntryList (&Interface->Link); - FreePool (Interface); - - return EFI_SUCCESS; -} - -/** - This function tries to send all the queued frames in ArpQue to the default gateway if - the ARP resolve for direct destination address is failed when using /32 subnet mask. - - @param[in] ArpQue The ARP queue of a failed request. - - @retval EFI_SUCCESS All the queued frames have been send to the default route. - @retval Others Failed to send the queued frames. - -**/ -EFI_STATUS -Ip4SendFrameToDefaultRoute ( - IN IP4_ARP_QUE *ArpQue - ) -{ - LIST_ENTRY *Entry; - LIST_ENTRY *Next; - IP4_ROUTE_CACHE_ENTRY *RtCacheEntry; - IP4_LINK_TX_TOKEN *Token; - IP4_ADDR Gateway; - EFI_STATUS Status; - IP4_ROUTE_ENTRY *DefaultRoute; - - // - // ARP resolve failed when using /32 subnet mask. - // - NET_LIST_FOR_EACH_SAFE (Entry, Next, &ArpQue->Frames) { - RemoveEntryList (Entry); - Token = NET_LIST_USER_STRUCT (Entry, IP4_LINK_TX_TOKEN, Link); - ASSERT (Token->Interface->SubnetMask == IP4_ALLONE_ADDRESS); - // - // Find the default gateway IP address. The default route was saved to the RtCacheEntry->Tag in Ip4Route(). - // - RtCacheEntry = NULL; - if (Token->IpInstance != NULL) { - RtCacheEntry = Ip4FindRouteCache (Token->IpInstance->RouteTable, NTOHL (ArpQue->Ip), Token->Interface->Ip); - } - if (RtCacheEntry == NULL) { - RtCacheEntry = Ip4FindRouteCache (Token->IpSb->DefaultRouteTable, NTOHL (ArpQue->Ip), Token->Interface->Ip); - } - if (RtCacheEntry == NULL) { - Status= EFI_NO_MAPPING; - goto ON_ERROR; - } - DefaultRoute = (IP4_ROUTE_ENTRY*)RtCacheEntry->Tag; - if (DefaultRoute == NULL) { - Status= EFI_NO_MAPPING; - goto ON_ERROR; - } - // - // Try to send the frame to the default route. - // - Gateway = DefaultRoute->NextHop; - if (ArpQue->Ip == Gateway) { - // - // ARP resolve for the default route is failed, return error to caller. - // - Status= EFI_NO_MAPPING; - goto ON_ERROR; - } - RtCacheEntry->NextHop = Gateway; - Status = Ip4SendFrame (Token->Interface,Token->IpInstance,Token->Packet,Gateway,Token->CallBack,Token->Context,Token->IpSb); - if (EFI_ERROR (Status)) { - Status= EFI_NO_MAPPING; - goto ON_ERROR; - } - Ip4FreeRouteCacheEntry (RtCacheEntry); - } - - return EFI_SUCCESS; - -ON_ERROR: - if (RtCacheEntry != NULL) { - Ip4FreeRouteCacheEntry (RtCacheEntry); - } - Token->CallBack (Token->IpInstance, Token->Packet, Status, 0, Token->Context); - Ip4FreeLinkTxToken (Token); - return Status; -} - - -/** - Callback function when ARP request are finished. It will cancel - all the queued frame if the ARP requests failed. Or transmit them - if the request succeed. - - @param[in] Context The context of the callback, a point to the ARP - queue - -**/ -VOID -EFIAPI -Ip4OnArpResolvedDpc ( - IN VOID *Context - ) -{ - LIST_ENTRY *Entry; - LIST_ENTRY *Next; - IP4_ARP_QUE *ArpQue; - IP4_INTERFACE *Interface; - IP4_LINK_TX_TOKEN *Token; - EFI_STATUS Status; - EFI_STATUS IoStatus; - - ArpQue = (IP4_ARP_QUE *) Context; - NET_CHECK_SIGNATURE (ArpQue, IP4_FRAME_ARP_SIGNATURE); - - RemoveEntryList (&ArpQue->Link); - - // - // ARP resolve failed for some reason. - // - if (NET_MAC_EQUAL (&ArpQue->Mac, &mZeroMacAddress, ArpQue->Interface->HwaddrLen)) { - if (ArpQue->Interface->SubnetMask != IP4_ALLONE_ADDRESS) { - // - // Release all the frame and ARP queue itself. Ip4FreeArpQue will call the frame's - // owner back. - // - IoStatus = EFI_NO_MAPPING; - } else { - // - // ARP resolve failed when using 32bit subnet mask, try to send the packets to the - // default route. - // - IoStatus = Ip4SendFrameToDefaultRoute (ArpQue); - } - goto ON_EXIT; - } - - // - // ARP resolve succeeded, Transmit all the frame. Release the ARP - // queue. It isn't necessary for us to cache the ARP binding because - // we always check the ARP cache first before transmit. - // - IoStatus = EFI_SUCCESS; - Interface = ArpQue->Interface; - - NET_LIST_FOR_EACH_SAFE (Entry, Next, &ArpQue->Frames) { - RemoveEntryList (Entry); - - Token = NET_LIST_USER_STRUCT (Entry, IP4_LINK_TX_TOKEN, Link); - CopyMem (&Token->DstMac, &ArpQue->Mac, sizeof (Token->DstMac)); - - // - // Insert the tx token before transmitting it via MNP as the FrameSentDpc - // may be called before Mnp->Transmit returns which will remove this tx - // token from the SentFrames list. Remove it from the list if the returned - // Status of Mnp->Transmit is not EFI_SUCCESS as in this case the - // FrameSentDpc won't be queued. - // - InsertTailList (&Interface->SentFrames, &Token->Link); - - Status = Interface->Mnp->Transmit (Interface->Mnp, &Token->MnpToken); - if (EFI_ERROR (Status)) { - RemoveEntryList (&Token->Link); - Token->CallBack (Token->IpInstance, Token->Packet, Status, 0, Token->Context); - - Ip4FreeLinkTxToken (Token); - continue; - } - } - -ON_EXIT: - Ip4FreeArpQue (ArpQue, IoStatus); -} - -/** - Request Ip4OnArpResolvedDpc as a DPC at TPL_CALLBACK. - - @param Event The Arp request event. - @param Context The context of the callback, a point to the ARP - queue. - -**/ -VOID -EFIAPI -Ip4OnArpResolved ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - // - // Request Ip4OnArpResolvedDpc as a DPC at TPL_CALLBACK - // - QueueDpc (TPL_CALLBACK, Ip4OnArpResolvedDpc, Context); -} - - - -/** - Callback funtion when frame transmission is finished. It will - call the frame owner's callback function to tell it the result. - - @param[in] Context Context which is point to the token. - -**/ -VOID -EFIAPI -Ip4OnFrameSentDpc ( - IN VOID *Context - ) -{ - IP4_LINK_TX_TOKEN *Token; - - Token = (IP4_LINK_TX_TOKEN *) Context; - NET_CHECK_SIGNATURE (Token, IP4_FRAME_TX_SIGNATURE); - - RemoveEntryList (&Token->Link); - - Token->CallBack ( - Token->IpInstance, - Token->Packet, - Token->MnpToken.Status, - 0, - Token->Context - ); - - Ip4FreeLinkTxToken (Token); -} - -/** - Request Ip4OnFrameSentDpc as a DPC at TPL_CALLBACK. - - @param[in] Event The transmit token's event. - @param[in] Context Context which is point to the token. - -**/ -VOID -EFIAPI -Ip4OnFrameSent ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - // - // Request Ip4OnFrameSentDpc as a DPC at TPL_CALLBACK - // - QueueDpc (TPL_CALLBACK, Ip4OnFrameSentDpc, Context); -} - - - -/** - Send a frame from the interface. If the next hop is broadcast or - multicast address, it is transmitted immediately. If the next hop - is a unicast, it will consult ARP to resolve the NextHop's MAC. - If some error happened, the CallBack won't be called. So, the caller - must test the return value, and take action when there is an error. - - @param[in] Interface The interface to send the frame from - @param[in] IpInstance The IP child that request the transmission. NULL - if it is the IP4 driver itself. - @param[in] Packet The packet to transmit. - @param[in] NextHop The immediate destination to transmit the packet - to. - @param[in] CallBack Function to call back when transmit finished. - @param[in] Context Opaque parameter to the call back. - @param[in] IpSb The pointer to the IP4 service binding instance. - - @retval EFI_OUT_OF_RESOURCES Failed to allocate resource to send the frame - @retval EFI_NO_MAPPING Can't resolve the MAC for the nexthop - @retval EFI_SUCCESS The packet is successfully transmitted. - @retval other Other error occurs. - -**/ -EFI_STATUS -Ip4SendFrame ( - IN IP4_INTERFACE *Interface, - IN IP4_PROTOCOL *IpInstance OPTIONAL, - IN NET_BUF *Packet, - IN IP4_ADDR NextHop, - IN IP4_FRAME_CALLBACK CallBack, - IN VOID *Context, - IN IP4_SERVICE *IpSb - ) -{ - IP4_LINK_TX_TOKEN *Token; - LIST_ENTRY *Entry; - IP4_ARP_QUE *ArpQue; - EFI_ARP_PROTOCOL *Arp; - EFI_STATUS Status; - - ASSERT (Interface->Configured); - - Token = Ip4WrapLinkTxToken (Interface, IpInstance, Packet, CallBack, Context, IpSb); - - if (Token == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - // - // Get the destination MAC address for multicast and broadcasts. - // Don't depend on ARP to solve the address since there maybe no - // ARP at all. Ip4Output has set NextHop to 255.255.255.255 for - // all the broadcasts. - // - if (NextHop == IP4_ALLONE_ADDRESS) { - CopyMem (&Token->DstMac, &Interface->BroadcastMac, sizeof (Token->DstMac)); - goto SEND_NOW; - - } else if (IP4_IS_MULTICAST (NextHop)) { - - Status = Ip4GetMulticastMac (Interface->Mnp, NextHop, &Token->DstMac); - - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - goto SEND_NOW; - } - - // - // Can only send out multicast/broadcast if the IP address is zero - // - if ((Arp = Interface->Arp) == NULL) { - Status = EFI_NO_MAPPING; - goto ON_ERROR; - } - - // - // First check whether this binding is in the ARP cache. - // - NextHop = HTONL (NextHop); - Status = Arp->Request (Arp, &NextHop, NULL, &Token->DstMac); - - if (Status == EFI_SUCCESS) { - goto SEND_NOW; - - } else if (Status != EFI_NOT_READY) { - goto ON_ERROR; - } - - // - // Have to do asynchronous ARP resolution. First check - // whether there is already a pending request. - // - ArpQue = NULL; - - NET_LIST_FOR_EACH (Entry, &Interface->ArpQues) { - ArpQue = NET_LIST_USER_STRUCT (Entry, IP4_ARP_QUE, Link); - - if (ArpQue->Ip == NextHop) { - break; - } - } - - // - // Found a pending ARP request, enqueue the frame then return - // - if (Entry != &Interface->ArpQues) { - InsertTailList (&ArpQue->Frames, &Token->Link); - return EFI_SUCCESS; - } - - // - // First frame to NextHop, issue an asynchronous ARP requests - // - ArpQue = Ip4CreateArpQue (Interface, NextHop); - - if (ArpQue == NULL) { - Status = EFI_OUT_OF_RESOURCES; - goto ON_ERROR; - } - - Status = Arp->Request (Arp, &ArpQue->Ip, ArpQue->OnResolved, ArpQue->Mac.Addr); - - if (EFI_ERROR (Status) && (Status != EFI_NOT_READY)) { - Ip4FreeArpQue (ArpQue, EFI_NO_MAPPING); - goto ON_ERROR; - } - - InsertHeadList (&ArpQue->Frames, &Token->Link); - InsertHeadList (&Interface->ArpQues, &ArpQue->Link); - return EFI_SUCCESS; - -SEND_NOW: - // - // Insert the tx token into the SentFrames list before calling Mnp->Transmit. - // Remove it if the returned status is not EFI_SUCCESS. - // - InsertTailList (&Interface->SentFrames, &Token->Link); - Status = Interface->Mnp->Transmit (Interface->Mnp, &Token->MnpToken); - if (EFI_ERROR (Status)) { - RemoveEntryList (&Token->Link); - goto ON_ERROR; - } - - return EFI_SUCCESS; - -ON_ERROR: - Ip4FreeLinkTxToken (Token); - return Status; -} - - -/** - Call back function when the received packet is freed. - Check Ip4OnFrameReceived for information. - - @param Context Context, which is the IP4_LINK_RX_TOKEN. - -**/ -VOID -EFIAPI -Ip4RecycleFrame ( - IN VOID *Context - ) -{ - IP4_LINK_RX_TOKEN *Frame; - - Frame = (IP4_LINK_RX_TOKEN *) Context; - NET_CHECK_SIGNATURE (Frame, IP4_FRAME_RX_SIGNATURE); - - gBS->SignalEvent (Frame->MnpToken.Packet.RxData->RecycleEvent); - Ip4FreeFrameRxToken (Frame); -} - - -/** - Received a frame from MNP, wrap it in net buffer then deliver - it to IP's input function. The ownship of the packet also - transferred to IP. When Ip is finished with this packet, it - will call NetbufFree to release the packet, NetbufFree will - again call the Ip4RecycleFrame to signal MNP's event and free - the token used. - - @param Context Context for the callback. - -**/ -VOID -EFIAPI -Ip4OnFrameReceivedDpc ( - IN VOID *Context - ) -{ - EFI_MANAGED_NETWORK_COMPLETION_TOKEN *MnpToken; - EFI_MANAGED_NETWORK_RECEIVE_DATA *MnpRxData; - IP4_LINK_RX_TOKEN *Token; - NET_FRAGMENT Netfrag; - NET_BUF *Packet; - UINT32 Flag; - - Token = (IP4_LINK_RX_TOKEN *) Context; - NET_CHECK_SIGNATURE (Token, IP4_FRAME_RX_SIGNATURE); - - // - // First clear the interface's receive request in case the - // caller wants to call Ip4ReceiveFrame in the callback. - // - Token->Interface->RecvRequest = NULL; - - MnpToken = &Token->MnpToken; - MnpRxData = MnpToken->Packet.RxData; - - if (EFI_ERROR (MnpToken->Status) || (MnpRxData == NULL)) { - Token->CallBack (Token->IpInstance, NULL, MnpToken->Status, 0, Token->Context); - Ip4FreeFrameRxToken (Token); - - return ; - } - - // - // Wrap the frame in a net buffer then deliever it to IP input. - // IP will reassemble the packet, and deliver it to upper layer - // - Netfrag.Len = MnpRxData->DataLength; - Netfrag.Bulk = MnpRxData->PacketData; - - Packet = NetbufFromExt (&Netfrag, 1, 0, IP4_MAX_HEADLEN, Ip4RecycleFrame, Token); - - if (Packet == NULL) { - gBS->SignalEvent (MnpRxData->RecycleEvent); - - Token->CallBack (Token->IpInstance, NULL, EFI_OUT_OF_RESOURCES, 0, Token->Context); - Ip4FreeFrameRxToken (Token); - - return ; - } - - Flag = (MnpRxData->BroadcastFlag ? IP4_LINK_BROADCAST : 0); - Flag |= (MnpRxData->MulticastFlag ? IP4_LINK_MULTICAST : 0); - Flag |= (MnpRxData->PromiscuousFlag ? IP4_LINK_PROMISC : 0); - - Token->CallBack (Token->IpInstance, Packet, EFI_SUCCESS, Flag, Token->Context); -} - -/** - Request Ip4OnFrameReceivedDpc as a DPC at TPL_CALLBACK. - - @param Event The receive event delivered to MNP for receive. - @param Context Context for the callback. - -**/ -VOID -EFIAPI -Ip4OnFrameReceived ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - // - // Request Ip4OnFrameReceivedDpc as a DPC at TPL_CALLBACK - // - QueueDpc (TPL_CALLBACK, Ip4OnFrameReceivedDpc, Context); -} - - -/** - Request to receive the packet from the interface. - - @param[in] Interface The interface to receive the frames from. - @param[in] IpInstance The instance that requests the receive. NULL for - the driver itself. - @param[in] CallBack Function to call when receive finished. - @param[in] Context Opaque parameter to the callback. - - @retval EFI_ALREADY_STARTED There is already a pending receive request. - @retval EFI_OUT_OF_RESOURCES Failed to allocate resource to receive. - @retval EFI_SUCCESS The recieve request has been started. - @retval other Other error occurs. - -**/ -EFI_STATUS -Ip4ReceiveFrame ( - IN IP4_INTERFACE *Interface, - IN IP4_PROTOCOL *IpInstance OPTIONAL, - IN IP4_FRAME_CALLBACK CallBack, - IN VOID *Context - ) -{ - IP4_LINK_RX_TOKEN *Token; - EFI_STATUS Status; - - NET_CHECK_SIGNATURE (Interface, IP4_INTERFACE_SIGNATURE); - - if (Interface->RecvRequest != NULL) { - return EFI_ALREADY_STARTED; - } - - Token = Ip4CreateLinkRxToken (Interface, IpInstance, CallBack, Context); - - if (Token == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - Interface->RecvRequest = Token; - Status = Interface->Mnp->Receive (Interface->Mnp, &Token->MnpToken); - if (EFI_ERROR (Status)) { - Interface->RecvRequest = NULL; - Ip4FreeFrameRxToken (Token); - return Status; - } - return EFI_SUCCESS; -} diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4If.h b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4If.h deleted file mode 100644 index d73bb5285f..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4If.h +++ /dev/null @@ -1,340 +0,0 @@ -/** @file - Definition for IP4 pesudo interface structure. - -Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef __EFI_IP4_IF_H__ -#define __EFI_IP4_IF_H__ - -#define IP4_FRAME_RX_SIGNATURE SIGNATURE_32 ('I', 'P', 'F', 'R') -#define IP4_FRAME_TX_SIGNATURE SIGNATURE_32 ('I', 'P', 'F', 'T') -#define IP4_FRAME_ARP_SIGNATURE SIGNATURE_32 ('I', 'P', 'F', 'A') -#define IP4_INTERFACE_SIGNATURE SIGNATURE_32 ('I', 'P', 'I', 'F') - -/** - This prototype is used by both receive and transmission. - When receiving Netbuf is allocated by IP4_INTERFACE, and - released by IP4. Flag shows whether the frame is received - as link broadcast/multicast... - - When transmitting, the Netbuf is from IP4, and provided - to the callback as a reference. Flag isn't used. - - @param[in] IpInstance The instance that sent or received the packet. - IpInstance can be NULL which means that it is the IP4 driver - itself sending the packets. IP4 driver may send packets that - don't belong to any instance, such as ICMP errors, ICMP echo - responses, or IGMP packets. IpInstance is used as a tag in - this module. - @param[in] Packet The sent or received packet. - @param[in] IoStatus Status of sending or receiving. - @param[in] LinkFlag Indicate if the frame is received as link broadcast/multicast. - When transmitting, it is not used. - @param[in] Context Additional data for callback. - - @retval None. -**/ -typedef -VOID -(*IP4_FRAME_CALLBACK)( - IN IP4_PROTOCOL *IpInstance OPTIONAL, - IN NET_BUF *Packet, - IN EFI_STATUS IoStatus, - IN UINT32 LinkFlag, - IN VOID *Context - ); - -/// -/// Each receive request is wrapped in an IP4_LINK_RX_TOKEN. -/// Upon completion, the Callback will be called. Only one -/// receive request is send to MNP. IpInstance is always NULL. -/// Reference MNP's spec for information. -/// -typedef struct { - UINT32 Signature; - IP4_INTERFACE *Interface; - - IP4_PROTOCOL *IpInstance; - IP4_FRAME_CALLBACK CallBack; - VOID *Context; - - EFI_MANAGED_NETWORK_COMPLETION_TOKEN MnpToken; -} IP4_LINK_RX_TOKEN; - -/// -/// Each transmit request is wrapped in an IP4_LINK_TX_TOKEN. -/// Upon completion, the Callback will be called. -/// -typedef struct { - UINT32 Signature; - LIST_ENTRY Link; - - IP4_INTERFACE *Interface; - IP4_SERVICE *IpSb; - - IP4_PROTOCOL *IpInstance; - IP4_FRAME_CALLBACK CallBack; - NET_BUF *Packet; - VOID *Context; - - EFI_MAC_ADDRESS DstMac; - EFI_MAC_ADDRESS SrcMac; - - EFI_MANAGED_NETWORK_COMPLETION_TOKEN MnpToken; - EFI_MANAGED_NETWORK_TRANSMIT_DATA MnpTxData; -} IP4_LINK_TX_TOKEN; - -/// -/// Only one ARP request is requested for all the frames in -/// a time. It is started for the first frames to the Ip. Any -/// subsequent transmission frame will be linked to Frames, and -/// be sent all at once the ARP requests succeed. -/// -typedef struct { - UINT32 Signature; - LIST_ENTRY Link; - - LIST_ENTRY Frames; - IP4_INTERFACE *Interface; - - // - // ARP requesting staffs - // - EFI_EVENT OnResolved; - IP4_ADDR Ip; - EFI_MAC_ADDRESS Mac; -} IP4_ARP_QUE; - -/** - Callback to select which frame to cancel. Caller can cancel a - single frame, or all the frame from an IP instance. - - @param Frame The sending frame to check for cancellation. - @param Context Additional data for callback. - - @retval TRUE The sending of the frame should be cancelled. - @retval FALSE Do not cancel the frame sending. -**/ -typedef -BOOLEAN -(*IP4_FRAME_TO_CANCEL)( - IP4_LINK_TX_TOKEN *Frame, - VOID *Context - ); - -// -// Each IP4 instance has its own station address. All the instances -// with the same station address share a single interface structure. -// Each interface has its own ARP child, and shares one MNP child. -// Notice the special cases that DHCP can configure the interface -// with 0.0.0.0/0.0.0.0. -// -struct _IP4_INTERFACE { - UINT32 Signature; - LIST_ENTRY Link; - INTN RefCnt; - - // - // IP address and subnet mask of the interface. It also contains - // the subnet/net broadcast address for quick access. The fields - // are invalid if (Configured == FALSE) - // - IP4_ADDR Ip; - IP4_ADDR SubnetMask; - IP4_ADDR SubnetBrdcast; - IP4_ADDR NetBrdcast; - BOOLEAN Configured; - - // - // Handle used to create/destroy ARP child. All the IP children - // share one MNP which is owned by IP service binding. - // - EFI_HANDLE Controller; - EFI_HANDLE Image; - - EFI_MANAGED_NETWORK_PROTOCOL *Mnp; - EFI_ARP_PROTOCOL *Arp; - EFI_HANDLE ArpHandle; - - // - // Queues to keep the frames sent and waiting ARP request. - // - LIST_ENTRY ArpQues; - LIST_ENTRY SentFrames; - IP4_LINK_RX_TOKEN *RecvRequest; - - // - // The interface's MAC and broadcast MAC address. - // - EFI_MAC_ADDRESS Mac; - EFI_MAC_ADDRESS BroadcastMac; - UINT32 HwaddrLen; - - // - // All the IP instances that have the same IP/SubnetMask are linked - // together through IpInstances. If any of the instance enables - // promiscuous receive, PromiscRecv is true. - // - LIST_ENTRY IpInstances; - BOOLEAN PromiscRecv; -}; - -/** - Create an IP4_INTERFACE. Delay the creation of ARP instance until - the interface is configured. - - @param[in] Mnp The shared MNP child of this IP4 service binding - instance. - @param[in] Controller The controller this IP4 service binding instance - is installed. Most like the UNDI handle. - @param[in] ImageHandle This driver's image handle. - - @return Point to the created IP4_INTERFACE, otherwise NULL. - -**/ -IP4_INTERFACE * -Ip4CreateInterface ( - IN EFI_MANAGED_NETWORK_PROTOCOL *Mnp, - IN EFI_HANDLE Controller, - IN EFI_HANDLE ImageHandle - ); - -/** - Set the interface's address, create and configure - the ARP child if necessary. - - @param Interface The interface to set the address. - @param IpAddr The interface's IP address. - @param SubnetMask The interface's netmask. - - @retval EFI_SUCCESS The interface is configured with Ip/netmask pair, - and a ARP is created for it. - @retval Others Failed to set the interface's address. - -**/ -EFI_STATUS -Ip4SetAddress ( - IN OUT IP4_INTERFACE *Interface, - IN IP4_ADDR IpAddr, - IN IP4_ADDR SubnetMask - ); - -/** - Free the interface used by IpInstance. All the IP instance with - the same Ip/Netmask pair share the same interface. It is reference - counted. All the frames haven't been sent will be cancelled. - Because the IpInstance is optional, the caller must remove - IpInstance from the interface's instance list itself. - - @param[in] Interface The interface used by the IpInstance. - @param[in] IpInstance The Ip instance that free the interface. NULL if - the Ip driver is releasing the default interface. - - @retval EFI_SUCCESS The interface use IpInstance is freed. - -**/ -EFI_STATUS -Ip4FreeInterface ( - IN IP4_INTERFACE *Interface, - IN IP4_PROTOCOL *IpInstance OPTIONAL - ); - -/** - Send a frame from the interface. If the next hop is broadcast or - multicast address, it is transmitted immediately. If the next hop - is a unicast, it will consult ARP to resolve the NextHop's MAC. - If some error happened, the CallBack won't be called. So, the caller - must test the return value, and take action when there is an error. - - @param[in] Interface The interface to send the frame from - @param[in] IpInstance The IP child that request the transmission. NULL - if it is the IP4 driver itself. - @param[in] Packet The packet to transmit. - @param[in] NextHop The immediate destination to transmit the packet - to. - @param[in] CallBack Function to call back when transmit finished. - @param[in] Context Opaque parameter to the call back. - @param[in] IpSb The pointer to the IP4 service binding instance. - - @retval EFI_OUT_OF_RESOURCES Failed to allocate resource to send the frame - @retval EFI_NO_MAPPING Can't resolve the MAC for the nexthop - @retval EFI_SUCCESS The packet is successfully transmitted. - @retval other Other error occurs. - -**/ -EFI_STATUS -Ip4SendFrame ( - IN IP4_INTERFACE *Interface, - IN IP4_PROTOCOL *IpInstance OPTIONAL, - IN NET_BUF *Packet, - IN IP4_ADDR NextHop, - IN IP4_FRAME_CALLBACK CallBack, - IN VOID *Context, - IN IP4_SERVICE *IpSb - ); - -/** - Remove all the frames on the interface that pass the FrameToCancel, - either queued on ARP queues or that have already been delivered to - MNP and not yet recycled. - - @param[in] Interface Interface to remove the frames from. - @param[in] IoStatus The transmit status returned to the frames' - callback. - @param[in] FrameToCancel Function to select the frame to cancel, NULL to - select all. - @param[in] Context Opaque parameters passed to FrameToCancel. - -**/ -VOID -Ip4CancelFrames ( - IN IP4_INTERFACE *Interface, - IN EFI_STATUS IoStatus, - IN IP4_FRAME_TO_CANCEL FrameToCancel OPTIONAL, - IN VOID *Context - ); - -/** - If there is a pending receive request, cancel it. Don't call - the receive request's callback because this function can be only - called if the instance or driver is tearing itself down. It - doesn't make sense to call it back. But it is necessary to call - the transmit token's callback to give it a chance to free the - packet and update the upper layer's transmit request status, say - that from the UDP. - - @param[in] Interface The interface used by the IpInstance - -**/ -VOID -Ip4CancelReceive ( - IN IP4_INTERFACE *Interface - ); - -/** - Request to receive the packet from the interface. - - @param[in] Interface The interface to receive the frames from. - @param[in] IpInstance The instance that requests the receive. NULL for - the driver itself. - @param[in] CallBack Function to call when receive finished. - @param[in] Context Opaque parameter to the callback. - - @retval EFI_ALREADY_STARTED There is already a pending receive request. - @retval EFI_OUT_OF_RESOURCES Failed to allocate resource to receive. - @retval EFI_SUCCESS The recieve request has been started. - @retval other Other error occurs. - -**/ -EFI_STATUS -Ip4ReceiveFrame ( - IN IP4_INTERFACE *Interface, - IN IP4_PROTOCOL *IpInstance OPTIONAL, - IN IP4_FRAME_CALLBACK CallBack, - IN VOID *Context - ); - -#endif diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Igmp.c b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Igmp.c deleted file mode 100644 index 41d9bce971..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Igmp.c +++ /dev/null @@ -1,615 +0,0 @@ -/** @file - This file implements the RFC2236: IGMP v2. - -Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Ip4Impl.h" - -// -// Route Alert option in IGMP report to direct routers to -// examine the packet more closely. -// -UINT32 mRouteAlertOption = 0x00000494; - - -/** - Init the IGMP control data of the IP4 service instance, configure - MNP to receive ALL SYSTEM multicast. - - @param[in, out] IpSb The IP4 service whose IGMP is to be initialized. - - @retval EFI_SUCCESS IGMP of the IpSb is successfully initialized. - @retval EFI_OUT_OF_RESOURCES Failed to allocate resource to initialize IGMP. - @retval Others Failed to initialize the IGMP of IpSb. - -**/ -EFI_STATUS -Ip4InitIgmp ( - IN OUT IP4_SERVICE *IpSb - ) -{ - IGMP_SERVICE_DATA *IgmpCtrl; - EFI_MANAGED_NETWORK_PROTOCOL *Mnp; - IGMP_GROUP *Group; - EFI_STATUS Status; - - IgmpCtrl = &IpSb->IgmpCtrl; - - // - // Configure MNP to receive ALL_SYSTEM multicast - // - Group = AllocatePool (sizeof (IGMP_GROUP)); - - if (Group == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - Mnp = IpSb->Mnp; - - Group->Address = IP4_ALLSYSTEM_ADDRESS; - Group->RefCnt = 1; - Group->DelayTime = 0; - Group->ReportByUs = FALSE; - - Status = Ip4GetMulticastMac (Mnp, IP4_ALLSYSTEM_ADDRESS, &Group->Mac); - - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - Status = Mnp->Groups (Mnp, TRUE, &Group->Mac); - - if (EFI_ERROR (Status) && (Status != EFI_ALREADY_STARTED)) { - goto ON_ERROR; - } - - InsertHeadList (&IgmpCtrl->Groups, &Group->Link); - return EFI_SUCCESS; - -ON_ERROR: - FreePool (Group); - return Status; -} - - -/** - Find the IGMP_GROUP structure which contains the status of multicast - group Address in this IGMP control block - - @param[in] IgmpCtrl The IGMP control block to search from. - @param[in] Address The multicast address to search. - - @return NULL if the multicast address isn't in the IGMP control block. Otherwise - the point to the IGMP_GROUP which contains the status of multicast group - for Address. - -**/ -IGMP_GROUP * -Ip4FindGroup ( - IN IGMP_SERVICE_DATA *IgmpCtrl, - IN IP4_ADDR Address - ) -{ - LIST_ENTRY *Entry; - IGMP_GROUP *Group; - - NET_LIST_FOR_EACH (Entry, &IgmpCtrl->Groups) { - Group = NET_LIST_USER_STRUCT (Entry, IGMP_GROUP, Link); - - if (Group->Address == Address) { - return Group; - } - } - - return NULL; -} - - -/** - Count the number of IP4 multicast groups that are mapped to the - same MAC address. Several IP4 multicast address may be mapped to - the same MAC address. - - @param[in] IgmpCtrl The IGMP control block to search in. - @param[in] Mac The MAC address to search. - - @return The number of the IP4 multicast group that mapped to the same - multicast group Mac. - -**/ -INTN -Ip4FindMac ( - IN IGMP_SERVICE_DATA *IgmpCtrl, - IN EFI_MAC_ADDRESS *Mac - ) -{ - LIST_ENTRY *Entry; - IGMP_GROUP *Group; - INTN Count; - - Count = 0; - - NET_LIST_FOR_EACH (Entry, &IgmpCtrl->Groups) { - Group = NET_LIST_USER_STRUCT (Entry, IGMP_GROUP, Link); - - if (NET_MAC_EQUAL (&Group->Mac, Mac, sizeof (EFI_MAC_ADDRESS))) { - Count++; - } - } - - return Count; -} - - -/** - Send an IGMP protocol message to the Dst, such as IGMP v1 membership report. - - @param[in] IpSb The IP4 service instance that requests the - transmission. - @param[in] Dst The destinaton to send to. - @param[in] Type The IGMP message type, such as IGMP v1 membership - report. - @param[in] Group The group address in the IGMP message head. - - @retval EFI_OUT_OF_RESOURCES Failed to allocate memory to build the message. - @retval EFI_SUCCESS The IGMP message is successfully send. - @retval Others Failed to send the IGMP message. - -**/ -EFI_STATUS -Ip4SendIgmpMessage ( - IN IP4_SERVICE *IpSb, - IN IP4_ADDR Dst, - IN UINT8 Type, - IN IP4_ADDR Group - ) -{ - IP4_HEAD Head; - NET_BUF *Packet; - IGMP_HEAD *Igmp; - - // - // Allocate a net buffer to hold the message - // - Packet = NetbufAlloc (IP4_MAX_HEADLEN + sizeof (IGMP_HEAD)); - - if (Packet == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - // - // Fill in the IGMP and IP header, then transmit the message - // - NetbufReserve (Packet, IP4_MAX_HEADLEN); - - Igmp = (IGMP_HEAD *) NetbufAllocSpace (Packet, sizeof (IGMP_HEAD), FALSE); - if (Igmp == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - Igmp->Type = Type; - Igmp->MaxRespTime = 0; - Igmp->Checksum = 0; - Igmp->Group = HTONL (Group); - Igmp->Checksum = (UINT16) (~NetblockChecksum ((UINT8 *) Igmp, sizeof (IGMP_HEAD))); - - Head.Tos = 0; - Head.Protocol = IP4_PROTO_IGMP; - Head.Ttl = 1; - Head.Fragment = 0; - Head.Dst = Dst; - Head.Src = IP4_ALLZERO_ADDRESS; - - return Ip4Output ( - IpSb, - NULL, - Packet, - &Head, - (UINT8 *) &mRouteAlertOption, - sizeof (UINT32), - IP4_ALLZERO_ADDRESS, - Ip4SysPacketSent, - NULL - ); -} - - -/** - Send an IGMP membership report. Depends on whether the server is - v1 or v2, it will send either a V1 or V2 membership report. - - @param[in] IpSb The IP4 service instance that requests the - transmission. - @param[in] Group The group address to report. - - @retval EFI_OUT_OF_RESOURCES Failed to allocate memory to build the message. - @retval EFI_SUCCESS The IGMP report message is successfully send. - @retval Others Failed to send the report. - -**/ -EFI_STATUS -Ip4SendIgmpReport ( - IN IP4_SERVICE *IpSb, - IN IP4_ADDR Group - ) -{ - if (IpSb->IgmpCtrl.Igmpv1QuerySeen != 0) { - return Ip4SendIgmpMessage (IpSb, Group, IGMP_V1_MEMBERSHIP_REPORT, Group); - } else { - return Ip4SendIgmpMessage (IpSb, Group, IGMP_V2_MEMBERSHIP_REPORT, Group); - } -} - - -/** - Join the multicast group on behalf of this IP4 child - - @param[in] IpInstance The IP4 child that wants to join the group. - @param[in] Address The group to join. - - @retval EFI_SUCCESS Successfully join the multicast group. - @retval EFI_OUT_OF_RESOURCES Failed to allocate resources. - @retval Others Failed to join the multicast group. - -**/ -EFI_STATUS -Ip4JoinGroup ( - IN IP4_PROTOCOL *IpInstance, - IN IP4_ADDR Address - ) -{ - EFI_MANAGED_NETWORK_PROTOCOL *Mnp; - IP4_SERVICE *IpSb; - IGMP_SERVICE_DATA *IgmpCtrl; - IGMP_GROUP *Group; - EFI_STATUS Status; - - IpSb = IpInstance->Service; - IgmpCtrl = &IpSb->IgmpCtrl; - Mnp = IpSb->Mnp; - - // - // If the IP service already is a member in the group, just - // increase the refernce count and return. - // - Group = Ip4FindGroup (IgmpCtrl, Address); - - if (Group != NULL) { - Group->RefCnt++; - return EFI_SUCCESS; - } - - // - // Otherwise, create a new IGMP_GROUP, Get the multicast's MAC address, - // send a report, then direct MNP to receive the multicast. - // - Group = AllocatePool (sizeof (IGMP_GROUP)); - - if (Group == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - Group->Address = Address; - Group->RefCnt = 1; - Group->DelayTime = IGMP_UNSOLICIATED_REPORT; - Group->ReportByUs = TRUE; - - Status = Ip4GetMulticastMac (Mnp, Address, &Group->Mac); - - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - Status = Ip4SendIgmpReport (IpSb, Address); - - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - Status = Mnp->Groups (Mnp, TRUE, &Group->Mac); - - if (EFI_ERROR (Status) && (Status != EFI_ALREADY_STARTED)) { - goto ON_ERROR; - } - - InsertHeadList (&IgmpCtrl->Groups, &Group->Link); - return EFI_SUCCESS; - -ON_ERROR: - FreePool (Group); - return Status; -} - - -/** - Leave the IP4 multicast group on behalf of IpInstance. - - @param[in] IpInstance The IP4 child that wants to leave the group - address. - @param[in] Address The group address to leave. - - @retval EFI_NOT_FOUND The IP4 service instance isn't in the group. - @retval EFI_SUCCESS Successfully leave the multicast group. - @retval Others Failed to leave the multicast group. - -**/ -EFI_STATUS -Ip4LeaveGroup ( - IN IP4_PROTOCOL *IpInstance, - IN IP4_ADDR Address - ) -{ - EFI_MANAGED_NETWORK_PROTOCOL *Mnp; - IP4_SERVICE *IpSb; - IGMP_SERVICE_DATA *IgmpCtrl; - IGMP_GROUP *Group; - EFI_STATUS Status; - - IpSb = IpInstance->Service; - IgmpCtrl = &IpSb->IgmpCtrl; - Mnp = IpSb->Mnp; - - Group = Ip4FindGroup (IgmpCtrl, Address); - - if (Group == NULL) { - return EFI_NOT_FOUND; - } - - // - // If more than one instance is in the group, decrease - // the RefCnt then return. - // - if (--Group->RefCnt > 0) { - return EFI_SUCCESS; - } - - // - // If multiple IP4 group addresses are mapped to the same - // multicast MAC address, don't configure the MNP to leave - // the MAC. - // - if (Ip4FindMac (IgmpCtrl, &Group->Mac) == 1) { - Status = Mnp->Groups (Mnp, FALSE, &Group->Mac); - - if (EFI_ERROR (Status) && (Status != EFI_NOT_FOUND)) { - return Status; - } - } - - // - // Send a leave report if the membership is reported by us - // and we are talking IGMPv2. - // - if (Group->ReportByUs && IgmpCtrl->Igmpv1QuerySeen == 0) { - Ip4SendIgmpMessage (IpSb, IP4_ALLROUTER_ADDRESS, IGMP_LEAVE_GROUP, Group->Address); - } - - RemoveEntryList (&Group->Link); - FreePool (Group); - - return EFI_SUCCESS; -} - - -/** - Handle the received IGMP message for the IP4 service instance. - - @param[in] IpSb The IP4 service instance that received the message. - @param[in] Head The IP4 header of the received message. - @param[in] Packet The IGMP message, without IP4 header. - - @retval EFI_INVALID_PARAMETER The IGMP message is malformated. - @retval EFI_SUCCESS The IGMP message is successfully processed. - -**/ -EFI_STATUS -Ip4IgmpHandle ( - IN IP4_SERVICE *IpSb, - IN IP4_HEAD *Head, - IN NET_BUF *Packet - ) -{ - IGMP_SERVICE_DATA *IgmpCtrl; - IGMP_HEAD Igmp; - IGMP_GROUP *Group; - IP4_ADDR Address; - LIST_ENTRY *Entry; - - IgmpCtrl = &IpSb->IgmpCtrl; - - // - // Must checksum over the whole packet, later IGMP version - // may employ message longer than 8 bytes. IP's header has - // already been trimmed off. - // - if ((Packet->TotalSize < sizeof (Igmp)) || (NetbufChecksum (Packet) != 0)) { - NetbufFree (Packet); - return EFI_INVALID_PARAMETER; - } - - // - // Copy the packet in case it is fragmented - // - NetbufCopy (Packet, 0, sizeof (IGMP_HEAD), (UINT8 *)&Igmp); - - switch (Igmp.Type) { - case IGMP_MEMBERSHIP_QUERY: - // - // If MaxRespTime is zero, it is most likely that we are - // talking to a V1 router - // - if (Igmp.MaxRespTime == 0) { - IgmpCtrl->Igmpv1QuerySeen = IGMP_V1ROUTER_PRESENT; - Igmp.MaxRespTime = 100; - } - - // - // Igmp is ticking once per second but MaxRespTime is in - // the unit of 100ms. - // - Igmp.MaxRespTime /= 10; - Address = NTOHL (Igmp.Group); - - if (Address == IP4_ALLSYSTEM_ADDRESS) { - break; - } - - NET_LIST_FOR_EACH (Entry, &IgmpCtrl->Groups) { - Group = NET_LIST_USER_STRUCT (Entry, IGMP_GROUP, Link); - - // - // If address is all zero, all the memberships will be reported. - // otherwise only one is reported. - // - if ((Address == IP4_ALLZERO_ADDRESS) || (Address == Group->Address)) { - // - // If the timer is pending, only update it if the time left - // is longer than the MaxRespTime. TODO: randomize the DelayTime. - // - if ((Group->DelayTime == 0) || (Group->DelayTime > Igmp.MaxRespTime)) { - Group->DelayTime = MAX (1, Igmp.MaxRespTime); - } - } - } - - break; - - case IGMP_V1_MEMBERSHIP_REPORT: - case IGMP_V2_MEMBERSHIP_REPORT: - Address = NTOHL (Igmp.Group); - Group = Ip4FindGroup (IgmpCtrl, Address); - - if ((Group != NULL) && (Group->DelayTime > 0)) { - Group->DelayTime = 0; - Group->ReportByUs = FALSE; - } - - break; - } - - NetbufFree (Packet); - return EFI_SUCCESS; -} - - -/** - The periodical timer function for IGMP. It does the following - things: - 1. Decrease the Igmpv1QuerySeen to make it possible to refresh - the IGMP server type. - 2. Decrease the report timer for each IGMP group in "delaying - member" state. - - @param[in] IpSb The IP4 service instance that is ticking. - -**/ -VOID -Ip4IgmpTicking ( - IN IP4_SERVICE *IpSb - ) -{ - IGMP_SERVICE_DATA *IgmpCtrl; - LIST_ENTRY *Entry; - IGMP_GROUP *Group; - - IgmpCtrl = &IpSb->IgmpCtrl; - - if (IgmpCtrl->Igmpv1QuerySeen > 0) { - IgmpCtrl->Igmpv1QuerySeen--; - } - - // - // Decrease the report timer for each IGMP group in "delaying member" - // - NET_LIST_FOR_EACH (Entry, &IgmpCtrl->Groups) { - Group = NET_LIST_USER_STRUCT (Entry, IGMP_GROUP, Link); - ASSERT (Group->DelayTime >= 0); - - if (Group->DelayTime > 0) { - Group->DelayTime--; - - if (Group->DelayTime == 0) { - Ip4SendIgmpReport (IpSb, Group->Address); - Group->ReportByUs = TRUE; - } - } - } -} - - -/** - Add a group address to the array of group addresses. - The caller should make sure that no duplicated address - existed in the array. Although the function doesn't - assume the byte order of the both Source and Addr, the - network byte order is used by the caller. - - @param[in] Source The array of group addresses to add to. - @param[in] Count The number of group addresses in the Source. - @param[in] Addr The IP4 multicast address to add. - - @return NULL if failed to allocate memory for the new groups, - otherwise the new combined group addresses. - -**/ -IP4_ADDR * -Ip4CombineGroups ( - IN IP4_ADDR *Source, - IN UINT32 Count, - IN IP4_ADDR Addr - ) -{ - IP4_ADDR *Groups; - - Groups = AllocatePool (sizeof (IP4_ADDR) * (Count + 1)); - - if (Groups == NULL) { - return NULL; - } - - CopyMem (Groups, Source, Count * sizeof (IP4_ADDR)); - Groups[Count] = Addr; - - return Groups; -} - - -/** - Remove a group address from the array of group addresses. - Although the function doesn't assume the byte order of the - both Groups and Addr, the network byte order is used by - the caller. - - @param Groups The array of group addresses to remove from. - @param Count The number of group addresses in the Groups. - @param Addr The IP4 multicast address to remove. - - @return The nubmer of group addresses in the Groups after remove. - It is Count if the Addr isn't in the Groups. - -**/ -INTN -Ip4RemoveGroupAddr ( - IN OUT IP4_ADDR *Groups, - IN UINT32 Count, - IN IP4_ADDR Addr - ) -{ - UINT32 Index; - - for (Index = 0; Index < Count; Index++) { - if (Groups[Index] == Addr) { - break; - } - } - - while (Index < Count - 1) { - Groups[Index] = Groups[Index + 1]; - Index++; - } - - return Index; -} diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Igmp.h b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Igmp.h deleted file mode 100644 index 0cc9445944..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Igmp.h +++ /dev/null @@ -1,201 +0,0 @@ -/** @file - -Copyright (c) 2005 - 2015, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef __EFI_IP4_IGMP_H__ -#define __EFI_IP4_IGMP_H__ - -// -// IGMP message type -// -#define IGMP_MEMBERSHIP_QUERY 0x11 -#define IGMP_V1_MEMBERSHIP_REPORT 0x12 -#define IGMP_V2_MEMBERSHIP_REPORT 0x16 -#define IGMP_LEAVE_GROUP 0x17 - -#define IGMP_V1ROUTER_PRESENT 400 -#define IGMP_UNSOLICIATED_REPORT 10 - -#pragma pack(1) -typedef struct { - UINT8 Type; - UINT8 MaxRespTime; - UINT16 Checksum; - IP4_ADDR Group; -} IGMP_HEAD; -#pragma pack() - -/// -/// The status of multicast group. It isn't necessary to maintain -/// explicit state of host state diagram. A group with non-zero -/// DelayTime is in "delaying member" state. otherwise, it is in -/// "idle member" state. -/// -typedef struct { - LIST_ENTRY Link; - INTN RefCnt; - IP4_ADDR Address; - INTN DelayTime; - BOOLEAN ReportByUs; - EFI_MAC_ADDRESS Mac; -} IGMP_GROUP; - -/// -/// The IGMP status. Each IP4 service instance has a IGMP_SERVICE_DATA -/// attached. The Igmpv1QuerySeen remember whether the server on this -/// connected network is v1 or v2. -/// -typedef struct { - INTN Igmpv1QuerySeen; - LIST_ENTRY Groups; -} IGMP_SERVICE_DATA; - -/** - Init the IGMP control data of the IP4 service instance, configure - MNP to receive ALL SYSTEM multicast. - - @param[in, out] IpSb The IP4 service whose IGMP is to be initialized. - - @retval EFI_SUCCESS IGMP of the IpSb is successfully initialized. - @retval EFI_OUT_OF_RESOURCES Failed to allocate resource to initialize IGMP. - @retval Others Failed to initialize the IGMP of IpSb. - -**/ -EFI_STATUS -Ip4InitIgmp ( - IN OUT IP4_SERVICE *IpSb - ); - -/** - Join the multicast group on behalf of this IP4 child - - @param[in] IpInstance The IP4 child that wants to join the group. - @param[in] Address The group to join. - - @retval EFI_SUCCESS Successfully join the multicast group. - @retval EFI_OUT_OF_RESOURCES Failed to allocate resources. - @retval Others Failed to join the multicast group. - -**/ -EFI_STATUS -Ip4JoinGroup ( - IN IP4_PROTOCOL *IpInstance, - IN IP4_ADDR Address - ); - -/** - Leave the IP4 multicast group on behalf of IpInstance. - - @param[in] IpInstance The IP4 child that wants to leave the group - address. - @param[in] Address The group address to leave. - - @retval EFI_NOT_FOUND The IP4 service instance isn't in the group. - @retval EFI_SUCCESS Successfully leave the multicast group. - @retval Others Failed to leave the multicast group. - -**/ -EFI_STATUS -Ip4LeaveGroup ( - IN IP4_PROTOCOL *IpInstance, - IN IP4_ADDR Address - ); - -/** - Handle the received IGMP message for the IP4 service instance. - - @param[in] IpSb The IP4 service instance that received the message. - @param[in] Head The IP4 header of the received message. - @param[in] Packet The IGMP message, without IP4 header. - - @retval EFI_INVALID_PARAMETER The IGMP message is malformated. - @retval EFI_SUCCESS The IGMP message is successfully processed. - -**/ -EFI_STATUS -Ip4IgmpHandle ( - IN IP4_SERVICE *IpSb, - IN IP4_HEAD *Head, - IN NET_BUF *Packet - ); - -/** - The periodical timer function for IGMP. It does the following - things: - 1. Decrease the Igmpv1QuerySeen to make it possible to refresh - the IGMP server type. - 2. Decrease the report timer for each IGMP group in "delaying - member" state. - - @param[in] IpSb The IP4 service instance that is ticking. - -**/ -VOID -Ip4IgmpTicking ( - IN IP4_SERVICE *IpSb - ); - -/** - Add a group address to the array of group addresses. - The caller should make sure that no duplicated address - existed in the array. Although the function doesn't - assume the byte order of the both Source and Addr, the - network byte order is used by the caller. - - @param[in] Source The array of group addresses to add to. - @param[in] Count The number of group addresses in the Source. - @param[in] Addr The IP4 multicast address to add. - - @return NULL if failed to allocate memory for the new groups, - otherwise the new combined group addresses. - -**/ -IP4_ADDR * -Ip4CombineGroups ( - IN IP4_ADDR *Source, - IN UINT32 Count, - IN IP4_ADDR Addr - ); - -/** - Remove a group address from the array of group addresses. - Although the function doesn't assume the byte order of the - both Groups and Addr, the network byte order is used by - the caller. - - @param Groups The array of group addresses to remove from. - @param Count The number of group addresses in the Groups. - @param Addr The IP4 multicast address to remove. - - @return The nubmer of group addresses in the Groups after remove. - It is Count if the Addr isn't in the Groups. - -**/ -INTN -Ip4RemoveGroupAddr ( - IN OUT IP4_ADDR *Groups, - IN UINT32 Count, - IN IP4_ADDR Addr - ); - -/** - Find the IGMP_GROUP structure which contains the status of multicast - group Address in this IGMP control block - - @param[in] IgmpCtrl The IGMP control block to search from. - @param[in] Address The multicast address to search. - - @return NULL if the multicast address isn't in the IGMP control block. Otherwise - the point to the IGMP_GROUP which contains the status of multicast group - for Address. - -**/ -IGMP_GROUP * -Ip4FindGroup ( - IN IGMP_SERVICE_DATA *IgmpCtrl, - IN IP4_ADDR Address - ); -#endif diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Impl.c b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Impl.c deleted file mode 100644 index ec6f037077..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Impl.c +++ /dev/null @@ -1,2330 +0,0 @@ -/** @file - -Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Ip4Impl.h" - -EFI_IPSEC2_PROTOCOL *mIpSec = NULL; - -/** - Gets the current operational settings for this instance of the EFI IPv4 Protocol driver. - - The GetModeData() function returns the current operational mode data for this - driver instance. The data fields in EFI_IP4_MODE_DATA are read only. This - function is used optionally to retrieve the operational mode data of underlying - networks or drivers. - - @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. - @param[out] Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure. - @param[out] MnpConfigData Pointer to the managed network configuration data structure. - @param[out] SnpModeData Pointer to the simple network mode data structure. - - @retval EFI_SUCCESS The operation completed successfully. - @retval EFI_INVALID_PARAMETER This is NULL. - @retval EFI_OUT_OF_RESOURCES The required mode data could not be allocated. - -**/ -EFI_STATUS -EFIAPI -EfiIp4GetModeData ( - IN CONST EFI_IP4_PROTOCOL *This, - OUT EFI_IP4_MODE_DATA *Ip4ModeData OPTIONAL, - OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL, - OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL - ); - -/** - Assigns an IPv4 address and subnet mask to this EFI IPv4 Protocol driver instance. - - The Configure() function is used to set, change, or reset the operational - parameters and filter settings for this EFI IPv4 Protocol instance. Until these - parameters have been set, no network traffic can be sent or received by this - instance. Once the parameters have been reset (by calling this function with - IpConfigData set to NULL), no more traffic can be sent or received until these - parameters have been set again. Each EFI IPv4 Protocol instance can be started - and stopped independently of each other by enabling or disabling their receive - filter settings with the Configure() function. - - When IpConfigData.UseDefaultAddress is set to FALSE, the new station address will - be appended as an alias address into the addresses list in the EFI IPv4 Protocol - driver. While set to TRUE, Configure() will trigger the EFI_IP4_CONFIG_PROTOCOL - to retrieve the default IPv4 address if it is not available yet. Clients could - frequently call GetModeData() to check the status to ensure that the default IPv4 - address is ready. - - If operational parameters are reset or changed, any pending transmit and receive - requests will be cancelled. Their completion token status will be set to EFI_ABORTED - and their events will be signaled. - - @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. - @param[in] IpConfigData Pointer to the EFI IPv4 Protocol configuration data structure. - - @retval EFI_SUCCESS The driver instance was successfully opened. - @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, - RARP, etc.) is not finished yet. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - @retval EFI_UNSUPPORTED One or more of the following conditions is TRUE: - A configuration protocol (DHCP, BOOTP, RARP, etc.) could - not be located when clients choose to use the default IPv4 - address. This EFI IPv4 Protocol implementation does not - support this requested filter or timeout setting. - @retval EFI_OUT_OF_RESOURCES The EFI IPv4 Protocol driver instance data could not be allocated. - @retval EFI_ALREADY_STARTED The interface is already open and must be stopped before the - IPv4 address or subnet mask can be changed. The interface must - also be stopped when switching to/from raw packet mode. - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI IPv4 - Protocol driver instance is not opened. - -**/ -EFI_STATUS -EFIAPI -EfiIp4Configure ( - IN EFI_IP4_PROTOCOL *This, - IN EFI_IP4_CONFIG_DATA *IpConfigData OPTIONAL - ); - -/** - Joins and leaves multicast groups. - - The Groups() function is used to join and leave multicast group sessions. Joining - a group will enable reception of matching multicast packets. Leaving a group will - disable the multicast packet reception. - - If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left. - - @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. - @param[in] JoinFlag Set to TRUE to join the multicast group session and FALSE to leave. - @param[in] GroupAddress Pointer to the IPv4 multicast address. - - @retval EFI_SUCCESS The operation completed successfully. - @retval EFI_INVALID_PARAMETER One or more of the following is TRUE: - - This is NULL. - - JoinFlag is TRUE and GroupAddress is NULL. - - GroupAddress is not NULL and *GroupAddress is - not a multicast IPv4 address. - @retval EFI_NOT_STARTED This instance has not been started. - @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, - RARP, etc.) is not finished yet. - @retval EFI_OUT_OF_RESOURCES System resources could not be allocated. - @retval EFI_UNSUPPORTED This EFI IPv4 Protocol implementation does not support multicast groups. - @retval EFI_ALREADY_STARTED The group address is already in the group table (when - JoinFlag is TRUE). - @retval EFI_NOT_FOUND The group address is not in the group table (when JoinFlag is FALSE). - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. - -**/ -EFI_STATUS -EFIAPI -EfiIp4Groups ( - IN EFI_IP4_PROTOCOL *This, - IN BOOLEAN JoinFlag, - IN EFI_IPv4_ADDRESS *GroupAddress OPTIONAL - ); - -/** - Adds and deletes routing table entries. - - The Routes() function adds a route to or deletes a route from the routing table. - - Routes are determined by comparing the SubnetAddress with the destination IPv4 - address arithmetically AND-ed with the SubnetMask. The gateway address must be - on the same subnet as the configured station address. - - The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0. - The default route matches all destination IPv4 addresses that do not match any - other routes. - - A GatewayAddress that is zero is a nonroute. Packets are sent to the destination - IP address if it can be found in the ARP cache or on the local subnet. One automatic - nonroute entry will be inserted into the routing table for outgoing packets that - are addressed to a local subnet (gateway address of 0.0.0.0). - - Each EFI IPv4 Protocol instance has its own independent routing table. Those EFI - IPv4 Protocol instances that use the default IPv4 address will also have copies - of the routing table that was provided by the EFI_IP4_CONFIG_PROTOCOL, and these - copies will be updated whenever the EIF IPv4 Protocol driver reconfigures its - instances. As a result, client modification to the routing table will be lost. - - @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. - @param[in] DeleteRoute Set to TRUE to delete this route from the routing table. Set to - FALSE to add this route to the routing table. SubnetAddress - and SubnetMask are used as the key to each route entry. - @param[in] SubnetAddress The address of the subnet that needs to be routed. - @param[in] SubnetMask The subnet mask of SubnetAddress. - @param[in] GatewayAddress The unicast gateway IPv4 address for this route. - - @retval EFI_SUCCESS The operation completed successfully. - @retval EFI_NOT_STARTED The driver instance has not been started. - @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, - RARP, etc.) is not finished yet. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - - This is NULL. - - SubnetAddress is NULL. - - SubnetMask is NULL. - - GatewayAddress is NULL. - - *SubnetAddress is not a valid subnet address. - - *SubnetMask is not a valid subnet mask. - - *GatewayAddress is not a valid unicast IPv4 address. - @retval EFI_OUT_OF_RESOURCES Could not add the entry to the routing table. - @retval EFI_NOT_FOUND This route is not in the routing table (when DeleteRoute is TRUE). - @retval EFI_ACCESS_DENIED The route is already defined in the routing table (when - DeleteRoute is FALSE). - -**/ -EFI_STATUS -EFIAPI -EfiIp4Routes ( - IN EFI_IP4_PROTOCOL *This, - IN BOOLEAN DeleteRoute, - IN EFI_IPv4_ADDRESS *SubnetAddress, - IN EFI_IPv4_ADDRESS *SubnetMask, - IN EFI_IPv4_ADDRESS *GatewayAddress - ); - -/** - Places outgoing data packets into the transmit queue. - - The Transmit() function places a sending request in the transmit queue of this - EFI IPv4 Protocol instance. Whenever the packet in the token is sent out or some - errors occur, the event in the token will be signaled and the status is updated. - - @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. - @param[in] Token Pointer to the transmit token. - - @retval EFI_SUCCESS The data has been queued for transmission. - @retval EFI_NOT_STARTED This instance has not been started. - @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, - RARP, etc.) is not finished yet. - @retval EFI_INVALID_PARAMETER One or more pameters are invalid. - @retval EFI_ACCESS_DENIED The transmit completion token with the same Token.Event - was already in the transmit queue. - @retval EFI_NOT_READY The completion token could not be queued because the transmit - queue is full. - @retval EFI_NOT_FOUND Not route is found to destination address. - @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data. - @retval EFI_BUFFER_TOO_SMALL Token.Packet.TxData.TotalDataLength is too - short to transmit. - @retval EFI_BAD_BUFFER_SIZE The length of the IPv4 header + option length + total data length is - greater than MTU (or greater than the maximum packet size if - Token.Packet.TxData.OverrideData. - DoNotFragment is TRUE.) - -**/ -EFI_STATUS -EFIAPI -EfiIp4Transmit ( - IN EFI_IP4_PROTOCOL *This, - IN EFI_IP4_COMPLETION_TOKEN *Token - ); - -/** - Places a receiving request into the receiving queue. - - The Receive() function places a completion token into the receive packet queue. - This function is always asynchronous. - - The Token.Event field in the completion token must be filled in by the caller - and cannot be NULL. When the receive operation completes, the EFI IPv4 Protocol - driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event - is signaled. - - @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. - @param[in] Token Pointer to a token that is associated with the receive data descriptor. - - @retval EFI_SUCCESS The receive completion token was cached. - @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started. - @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, RARP, etc.) - is not finished yet. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - - This is NULL. - - Token is NULL. - - Token.Event is NULL. - @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system - resources (usually memory). - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. - The EFI IPv4 Protocol instance has been reset to startup defaults. - EFI_ACCESS_DENIED The receive completion token with the same Token.Event was already - in the receive queue. - @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full. - @retval EFI_ICMP_ERROR An ICMP error packet was received. - -**/ -EFI_STATUS -EFIAPI -EfiIp4Receive ( - IN EFI_IP4_PROTOCOL *This, - IN EFI_IP4_COMPLETION_TOKEN *Token - ); - -/** - Abort an asynchronous transmit or receive request. - - The Cancel() function is used to abort a pending transmit or receive request. - If the token is in the transmit or receive request queues, after calling this - function, Token->Status will be set to EFI_ABORTED and then Token->Event will - be signaled. If the token is not in one of the queues, which usually means the - asynchronous operation has completed, this function will not signal the token - and EFI_NOT_FOUND is returned. - - @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. - @param[in] Token Pointer to a token that has been issued by - EFI_IP4_PROTOCOL.Transmit() or - EFI_IP4_PROTOCOL.Receive(). If NULL, all pending - tokens are aborted. Type EFI_IP4_COMPLETION_TOKEN is - defined in EFI_IP4_PROTOCOL.Transmit(). - - @retval EFI_SUCCESS The asynchronous I/O request was aborted and - Token.->Event was signaled. When Token is NULL, all - pending requests were aborted and their events were signaled. - @retval EFI_INVALID_PARAMETER This is NULL. - @retval EFI_NOT_STARTED This instance has not been started. - @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, - RARP, etc.) is not finished yet. - @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O request was - not found in the transmit or receive queue. It has either completed - or was not issued by Transmit() and Receive(). - -**/ -EFI_STATUS -EFIAPI -EfiIp4Cancel ( - IN EFI_IP4_PROTOCOL *This, - IN EFI_IP4_COMPLETION_TOKEN *Token OPTIONAL - ); - -/** - Polls for incoming data packets and processes outgoing data packets. - - The Poll() function polls for incoming data packets and processes outgoing data - packets. Network drivers and applications can call the EFI_IP4_PROTOCOL.Poll() - function to increase the rate that data packets are moved between the communications - device and the transmit and receive queues. - - In some systems the periodic timer event may not poll the underlying communications - device fast enough to transmit and/or receive all data packets without missing - incoming packets or dropping outgoing packets. Drivers and applications that are - experiencing packet loss should try calling the EFI_IP4_PROTOCOL.Poll() function - more often. - - @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. - - @retval EFI_SUCCESS Incoming or outgoing data was processed. - @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started. - @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, - RARP, etc.) is not finished yet. - @retval EFI_INVALID_PARAMETER This is NULL. - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. - @retval EFI_NOT_READY No incoming or outgoing data is processed. - @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue. - Consider increasing the polling rate. - -**/ -EFI_STATUS -EFIAPI -EfiIp4Poll ( - IN EFI_IP4_PROTOCOL *This - ); - -EFI_IP4_PROTOCOL -mEfiIp4ProtocolTemplete = { - EfiIp4GetModeData, - EfiIp4Configure, - EfiIp4Groups, - EfiIp4Routes, - EfiIp4Transmit, - EfiIp4Receive, - EfiIp4Cancel, - EfiIp4Poll -}; - -/** - Gets the current operational settings for this instance of the EFI IPv4 Protocol driver. - - The GetModeData() function returns the current operational mode data for this - driver instance. The data fields in EFI_IP4_MODE_DATA are read only. This - function is used optionally to retrieve the operational mode data of underlying - networks or drivers. - - @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. - @param[out] Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure. - @param[out] MnpConfigData Pointer to the managed network configuration data structure. - @param[out] SnpModeData Pointer to the simple network mode data structure. - - @retval EFI_SUCCESS The operation completed successfully. - @retval EFI_INVALID_PARAMETER This is NULL. - @retval EFI_OUT_OF_RESOURCES The required mode data could not be allocated. - -**/ -EFI_STATUS -EFIAPI -EfiIp4GetModeData ( - IN CONST EFI_IP4_PROTOCOL *This, - OUT EFI_IP4_MODE_DATA *Ip4ModeData OPTIONAL, - OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL, - OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL - ) -{ - IP4_PROTOCOL *IpInstance; - IP4_SERVICE *IpSb; - EFI_IP4_CONFIG_DATA *Config; - EFI_STATUS Status; - EFI_TPL OldTpl; - IP4_ADDR Ip; - - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This); - IpSb = IpInstance->Service; - - if (Ip4ModeData != NULL) { - // - // IsStarted is "whether the EfiIp4Configure has been called". - // IsConfigured is "whether the station address has been configured" - // - Ip4ModeData->IsStarted = (BOOLEAN)(IpInstance->State == IP4_STATE_CONFIGED); - CopyMem (&Ip4ModeData->ConfigData, &IpInstance->ConfigData, sizeof (Ip4ModeData->ConfigData)); - Ip4ModeData->IsConfigured = FALSE; - - Ip4ModeData->GroupCount = IpInstance->GroupCount; - Ip4ModeData->GroupTable = (EFI_IPv4_ADDRESS *) IpInstance->Groups; - - Ip4ModeData->IcmpTypeCount = 23; - Ip4ModeData->IcmpTypeList = mIp4SupportedIcmp; - - Ip4ModeData->RouteTable = NULL; - Ip4ModeData->RouteCount = 0; - - Ip4ModeData->MaxPacketSize = IpSb->MaxPacketSize; - - // - // return the current station address for this IP child. So, - // the user can get the default address through this. Some - // application wants to know it station address even it is - // using the default one, such as a ftp server. - // - if (Ip4ModeData->IsStarted) { - Config = &Ip4ModeData->ConfigData; - - Ip = HTONL (IpInstance->Interface->Ip); - CopyMem (&Config->StationAddress, &Ip, sizeof (EFI_IPv4_ADDRESS)); - - Ip = HTONL (IpInstance->Interface->SubnetMask); - CopyMem (&Config->SubnetMask, &Ip, sizeof (EFI_IPv4_ADDRESS)); - - Ip4ModeData->IsConfigured = IpInstance->Interface->Configured; - - // - // Build a EFI route table for user from the internal route table. - // - Status = Ip4BuildEfiRouteTable (IpInstance); - - if (EFI_ERROR (Status)) { - gBS->RestoreTPL (OldTpl); - return Status; - } - - Ip4ModeData->RouteTable = IpInstance->EfiRouteTable; - Ip4ModeData->RouteCount = IpInstance->EfiRouteCount; - } - } - - // - // Get fresh mode data from MNP, since underlying media status may change - // - Status = IpSb->Mnp->GetModeData (IpSb->Mnp, MnpConfigData, SnpModeData); - - gBS->RestoreTPL (OldTpl); - return Status; -} - - -/** - Config the MNP parameter used by IP. The IP driver use one MNP - child to transmit/receive frames. By default, it configures MNP - to receive unicast/multicast/broadcast. And it will enable/disable - the promiscous receive according to whether there is IP child - enable that or not. If Force is FALSE, it will iterate through - all the IP children to check whether the promiscuous receive - setting has been changed. If it hasn't been changed, it won't - reconfigure the MNP. If Force is TRUE, the MNP is configured no - matter whether that is changed or not. - - @param[in] IpSb The IP4 service instance that is to be changed. - @param[in] Force Force the configuration or not. - - @retval EFI_SUCCESS The MNP is successfully configured/reconfigured. - @retval Others Configuration failed. - -**/ -EFI_STATUS -Ip4ServiceConfigMnp ( - IN IP4_SERVICE *IpSb, - IN BOOLEAN Force - ) -{ - LIST_ENTRY *Entry; - LIST_ENTRY *ProtoEntry; - IP4_INTERFACE *IpIf; - IP4_PROTOCOL *IpInstance; - BOOLEAN Reconfig; - BOOLEAN PromiscReceive; - EFI_STATUS Status; - - Reconfig = FALSE; - PromiscReceive = FALSE; - - if (!Force) { - // - // Iterate through the IP children to check whether promiscuous - // receive setting has been changed. Update the interface's receive - // filter also. - // - NET_LIST_FOR_EACH (Entry, &IpSb->Interfaces) { - - IpIf = NET_LIST_USER_STRUCT (Entry, IP4_INTERFACE, Link); - IpIf->PromiscRecv = FALSE; - - NET_LIST_FOR_EACH (ProtoEntry, &IpIf->IpInstances) { - IpInstance = NET_LIST_USER_STRUCT (ProtoEntry, IP4_PROTOCOL, AddrLink); - - if (IpInstance->ConfigData.AcceptPromiscuous) { - IpIf->PromiscRecv = TRUE; - PromiscReceive = TRUE; - } - } - } - - // - // If promiscuous receive isn't changed, it isn't necessary to reconfigure. - // - if (PromiscReceive == IpSb->MnpConfigData.EnablePromiscuousReceive) { - return EFI_SUCCESS; - } - - Reconfig = TRUE; - IpSb->MnpConfigData.EnablePromiscuousReceive = PromiscReceive; - } - - Status = IpSb->Mnp->Configure (IpSb->Mnp, &IpSb->MnpConfigData); - - // - // recover the original configuration if failed to set the configure. - // - if (EFI_ERROR (Status) && Reconfig) { - IpSb->MnpConfigData.EnablePromiscuousReceive = (BOOLEAN) !PromiscReceive; - } - - return Status; -} - - -/** - Intiialize the IP4_PROTOCOL structure to the unconfigured states. - - @param IpSb The IP4 service instance. - @param IpInstance The IP4 child instance. - -**/ -VOID -Ip4InitProtocol ( - IN IP4_SERVICE *IpSb, - IN OUT IP4_PROTOCOL *IpInstance - ) -{ - ASSERT ((IpSb != NULL) && (IpInstance != NULL)); - - ZeroMem (IpInstance, sizeof (IP4_PROTOCOL)); - - IpInstance->Signature = IP4_PROTOCOL_SIGNATURE; - CopyMem (&IpInstance->Ip4Proto, &mEfiIp4ProtocolTemplete, sizeof (IpInstance->Ip4Proto)); - IpInstance->State = IP4_STATE_UNCONFIGED; - IpInstance->InDestroy = FALSE; - IpInstance->Service = IpSb; - - InitializeListHead (&IpInstance->Link); - NetMapInit (&IpInstance->RxTokens); - NetMapInit (&IpInstance->TxTokens); - InitializeListHead (&IpInstance->Received); - InitializeListHead (&IpInstance->Delivered); - InitializeListHead (&IpInstance->AddrLink); - - EfiInitializeLock (&IpInstance->RecycleLock, TPL_NOTIFY); -} - - -/** - Configure the IP4 child. If the child is already configured, - change the configuration parameter. Otherwise configure it - for the first time. The caller should validate the configuration - before deliver them to it. It also don't do configure NULL. - - @param[in, out] IpInstance The IP4 child to configure. - @param[in] Config The configure data. - - @retval EFI_SUCCESS The IP4 child is successfully configured. - @retval EFI_DEVICE_ERROR Failed to free the pending transive or to - configure underlying MNP or other errors. - @retval EFI_NO_MAPPING The IP4 child is configured to use default - address, but the default address hasn't been - configured. The IP4 child doesn't need to be - reconfigured when default address is configured. - @retval EFI_OUT_OF_RESOURCES No more memory space is available. - @retval other Other error occurs. - -**/ -EFI_STATUS -Ip4ConfigProtocol ( - IN OUT IP4_PROTOCOL *IpInstance, - IN EFI_IP4_CONFIG_DATA *Config - ) -{ - IP4_SERVICE *IpSb; - IP4_INTERFACE *IpIf; - EFI_STATUS Status; - IP4_ADDR Ip; - IP4_ADDR Netmask; - EFI_ARP_PROTOCOL *Arp; - EFI_IP4_CONFIG2_PROTOCOL *Ip4Config2; - EFI_IP4_CONFIG2_POLICY Policy; - - IpSb = IpInstance->Service; - - Ip4Config2 = NULL; - - // - // User is changing packet filters. It must be stopped - // before the station address can be changed. - // - if (IpInstance->State == IP4_STATE_CONFIGED) { - // - // Cancel all the pending transmit/receive from upper layer - // - Status = Ip4Cancel (IpInstance, NULL); - - if (EFI_ERROR (Status)) { - return EFI_DEVICE_ERROR; - } - - CopyMem (&IpInstance->ConfigData, Config, sizeof (IpInstance->ConfigData)); - return EFI_SUCCESS; - } - - // - // Configure a fresh IP4 protocol instance. Create a route table. - // Each IP child has its own route table, which may point to the - // default table if it is using default address. - // - Status = EFI_OUT_OF_RESOURCES; - IpInstance->RouteTable = Ip4CreateRouteTable (); - - if (IpInstance->RouteTable == NULL) { - return Status; - } - - // - // Set up the interface. - // - CopyMem (&Ip, &Config->StationAddress, sizeof (IP4_ADDR)); - CopyMem (&Netmask, &Config->SubnetMask, sizeof (IP4_ADDR)); - - Ip = NTOHL (Ip); - Netmask = NTOHL (Netmask); - - if (!Config->UseDefaultAddress) { - // - // Find whether there is already an interface with the same - // station address. All the instances with the same station - // address shares one interface. - // - IpIf = Ip4FindStationAddress (IpSb, Ip, Netmask); - - if (IpIf != NULL) { - NET_GET_REF (IpIf); - - } else { - IpIf = Ip4CreateInterface (IpSb->Mnp, IpSb->Controller, IpSb->Image); - - if (IpIf == NULL) { - goto ON_ERROR; - } - - Status = Ip4SetAddress (IpIf, Ip, Netmask); - - if (EFI_ERROR (Status)) { - Status = EFI_DEVICE_ERROR; - Ip4FreeInterface (IpIf, IpInstance); - goto ON_ERROR; - } - - InsertTailList (&IpSb->Interfaces, &IpIf->Link); - } - - // - // Add a route to this connected network in the instance route table. - // - Ip4AddRoute ( - IpInstance->RouteTable, - Ip & Netmask, - Netmask, - IP4_ALLZERO_ADDRESS - ); - } else { - // - // Use the default address. Check the state. - // - if (IpSb->State == IP4_SERVICE_UNSTARTED) { - // - // Trigger the EFI_IP4_CONFIG2_PROTOCOL to retrieve the - // default IPv4 address if it is not available yet. - // - Policy = IpSb->Ip4Config2Instance.Policy; - if (Policy != Ip4Config2PolicyDhcp) { - Ip4Config2 = &IpSb->Ip4Config2Instance.Ip4Config2; - Policy = Ip4Config2PolicyDhcp; - Status= Ip4Config2->SetData ( - Ip4Config2, - Ip4Config2DataTypePolicy, - sizeof (EFI_IP4_CONFIG2_POLICY), - &Policy - ); - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - } - } - - IpIf = IpSb->DefaultInterface; - NET_GET_REF (IpSb->DefaultInterface); - - // - // If default address is used, so is the default route table. - // Any route set by the instance has the precedence over the - // routes in the default route table. Link the default table - // after the instance's table. Routing will search the local - // table first. - // - NET_GET_REF (IpSb->DefaultRouteTable); - IpInstance->RouteTable->Next = IpSb->DefaultRouteTable; - } - - IpInstance->Interface = IpIf; - if (IpIf->Arp != NULL) { - Arp = NULL; - Status = gBS->OpenProtocol ( - IpIf->ArpHandle, - &gEfiArpProtocolGuid, - (VOID **) &Arp, - gIp4DriverBinding.DriverBindingHandle, - IpInstance->Handle, - EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER - ); - if (EFI_ERROR (Status)) { - Ip4FreeInterface (IpIf, IpInstance); - goto ON_ERROR; - } - } - InsertTailList (&IpIf->IpInstances, &IpInstance->AddrLink); - - CopyMem (&IpInstance->ConfigData, Config, sizeof (IpInstance->ConfigData)); - IpInstance->State = IP4_STATE_CONFIGED; - - // - // Although EFI_NO_MAPPING is an error code, the IP child has been - // successfully configured and doesn't need reconfiguration when - // default address is acquired. - // - if (Config->UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) { - return EFI_NO_MAPPING; - } - - return EFI_SUCCESS; - -ON_ERROR: - Ip4FreeRouteTable (IpInstance->RouteTable); - IpInstance->RouteTable = NULL; - return Status; -} - - -/** - Clean up the IP4 child, release all the resources used by it. - - @param[in] IpInstance The IP4 child to clean up. - - @retval EFI_SUCCESS The IP4 child is cleaned up. - @retval EFI_DEVICE_ERROR Some resources failed to be released. - -**/ -EFI_STATUS -Ip4CleanProtocol ( - IN IP4_PROTOCOL *IpInstance - ) -{ - if (EFI_ERROR (Ip4Cancel (IpInstance, NULL))) { - return EFI_DEVICE_ERROR; - } - - if (EFI_ERROR (Ip4Groups (IpInstance, FALSE, NULL))) { - return EFI_DEVICE_ERROR; - } - - // - // Some packets haven't been recycled. It is because either the - // user forgets to recycle the packets, or because the callback - // hasn't been called. Just leave it alone. - // - if (!IsListEmpty (&IpInstance->Delivered)) { - ; - } - - if (IpInstance->Interface != NULL) { - RemoveEntryList (&IpInstance->AddrLink); - if (IpInstance->Interface->Arp != NULL) { - gBS->CloseProtocol ( - IpInstance->Interface->ArpHandle, - &gEfiArpProtocolGuid, - gIp4DriverBinding.DriverBindingHandle, - IpInstance->Handle - ); - } - Ip4FreeInterface (IpInstance->Interface, IpInstance); - IpInstance->Interface = NULL; - } - - if (IpInstance->RouteTable != NULL) { - if (IpInstance->RouteTable->Next != NULL) { - Ip4FreeRouteTable (IpInstance->RouteTable->Next); - } - - Ip4FreeRouteTable (IpInstance->RouteTable); - IpInstance->RouteTable = NULL; - } - - if (IpInstance->EfiRouteTable != NULL) { - FreePool (IpInstance->EfiRouteTable); - IpInstance->EfiRouteTable = NULL; - IpInstance->EfiRouteCount = 0; - } - - if (IpInstance->Groups != NULL) { - FreePool (IpInstance->Groups); - IpInstance->Groups = NULL; - IpInstance->GroupCount = 0; - } - - NetMapClean (&IpInstance->TxTokens); - - NetMapClean (&IpInstance->RxTokens); - - return EFI_SUCCESS; -} - - -/** - Assigns an IPv4 address and subnet mask to this EFI IPv4 Protocol driver instance. - - The Configure() function is used to set, change, or reset the operational - parameters and filter settings for this EFI IPv4 Protocol instance. Until these - parameters have been set, no network traffic can be sent or received by this - instance. Once the parameters have been reset (by calling this function with - IpConfigData set to NULL), no more traffic can be sent or received until these - parameters have been set again. Each EFI IPv4 Protocol instance can be started - and stopped independently of each other by enabling or disabling their receive - filter settings with the Configure() function. - - When IpConfigData.UseDefaultAddress is set to FALSE, the new station address will - be appended as an alias address into the addresses list in the EFI IPv4 Protocol - driver. While set to TRUE, Configure() will trigger the EFI_IP4_CONFIG_PROTOCOL - to retrieve the default IPv4 address if it is not available yet. Clients could - frequently call GetModeData() to check the status to ensure that the default IPv4 - address is ready. - - If operational parameters are reset or changed, any pending transmit and receive - requests will be cancelled. Their completion token status will be set to EFI_ABORTED - and their events will be signaled. - - @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. - @param[in] IpConfigData Pointer to the EFI IPv4 Protocol configuration data structure. - - @retval EFI_SUCCESS The driver instance was successfully opened. - @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, - RARP, etc.) is not finished yet. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - @retval EFI_UNSUPPORTED One or more of the following conditions is TRUE: - A configuration protocol (DHCP, BOOTP, RARP, etc.) could - not be located when clients choose to use the default IPv4 - address. This EFI IPv4 Protocol implementation does not - support this requested filter or timeout setting. - @retval EFI_OUT_OF_RESOURCES The EFI IPv4 Protocol driver instance data could not be allocated. - @retval EFI_ALREADY_STARTED The interface is already open and must be stopped before the - IPv4 address or subnet mask can be changed. The interface must - also be stopped when switching to/from raw packet mode. - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI IPv4 - Protocol driver instance is not opened. - -**/ -EFI_STATUS -EFIAPI -EfiIp4Configure ( - IN EFI_IP4_PROTOCOL *This, - IN EFI_IP4_CONFIG_DATA *IpConfigData OPTIONAL - ) -{ - IP4_PROTOCOL *IpInstance; - EFI_IP4_CONFIG_DATA *Current; - EFI_TPL OldTpl; - EFI_STATUS Status; - BOOLEAN AddrOk; - IP4_ADDR IpAddress; - IP4_ADDR SubnetMask; - - // - // First, validate the parameters - // - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This); - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - // - // Validate the configuration first. - // - if (IpConfigData != NULL) { - - CopyMem (&IpAddress, &IpConfigData->StationAddress, sizeof (IP4_ADDR)); - CopyMem (&SubnetMask, &IpConfigData->SubnetMask, sizeof (IP4_ADDR)); - - IpAddress = NTOHL (IpAddress); - SubnetMask = NTOHL (SubnetMask); - - // - // Check whether the station address is a valid unicast address - // - if (!IpConfigData->UseDefaultAddress) { - AddrOk = Ip4StationAddressValid (IpAddress, SubnetMask); - - if (!AddrOk) { - Status = EFI_INVALID_PARAMETER; - goto ON_EXIT; - } - } - - // - // User can only update packet filters when already configured. - // If it wants to change the station address, it must configure(NULL) - // the instance first. - // - if (IpInstance->State == IP4_STATE_CONFIGED) { - Current = &IpInstance->ConfigData; - - if (Current->UseDefaultAddress != IpConfigData->UseDefaultAddress) { - Status = EFI_ALREADY_STARTED; - goto ON_EXIT; - } - - if (!Current->UseDefaultAddress && - (!EFI_IP4_EQUAL (&Current->StationAddress, &IpConfigData->StationAddress) || - !EFI_IP4_EQUAL (&Current->SubnetMask, &IpConfigData->SubnetMask))) { - Status = EFI_ALREADY_STARTED; - goto ON_EXIT; - } - - if (Current->UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) { - Status = EFI_NO_MAPPING; - goto ON_EXIT; - } - } - } - - // - // Configure the instance or clean it up. - // - if (IpConfigData != NULL) { - Status = Ip4ConfigProtocol (IpInstance, IpConfigData); - } else { - Status = Ip4CleanProtocol (IpInstance); - - // - // Consider the following valid sequence: Mnp is unloaded-->Ip Stopped-->Udp Stopped, - // Configure (ThisIp, NULL). If the state is changed to UNCONFIGED, - // the unload fails miserably. - // - if (IpInstance->State == IP4_STATE_CONFIGED) { - IpInstance->State = IP4_STATE_UNCONFIGED; - } - } - - // - // Update the MNP's configure data. Ip4ServiceConfigMnp will check - // whether it is necessary to reconfigure the MNP. - // - Ip4ServiceConfigMnp (IpInstance->Service, FALSE); - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - return Status; - -} - - -/** - Change the IP4 child's multicast setting. The caller - should make sure that the parameters is valid. - - @param[in] IpInstance The IP4 child to change the setting. - @param[in] JoinFlag TRUE to join the group, otherwise leave it. - @param[in] GroupAddress The target group address. - - @retval EFI_ALREADY_STARTED Want to join the group, but already a member of it. - @retval EFI_OUT_OF_RESOURCES Failed to allocate some resources. - @retval EFI_DEVICE_ERROR Failed to set the group configuraton. - @retval EFI_SUCCESS Successfully updated the group setting. - @retval EFI_NOT_FOUND Try to leave the group which it isn't a member. - -**/ -EFI_STATUS -Ip4Groups ( - IN IP4_PROTOCOL *IpInstance, - IN BOOLEAN JoinFlag, - IN EFI_IPv4_ADDRESS *GroupAddress OPTIONAL - ) -{ - IP4_ADDR *Members; - IP4_ADDR Group; - UINT32 Index; - - // - // Add it to the instance's Groups, and join the group by IGMP. - // IpInstance->Groups is in network byte order. IGMP operates in - // host byte order - // - if (JoinFlag) { - // - // When JoinFlag is TRUE, GroupAddress shouldn't be NULL. - // - ASSERT (GroupAddress != NULL); - CopyMem (&Group, GroupAddress, sizeof (IP4_ADDR)); - - for (Index = 0; Index < IpInstance->GroupCount; Index++) { - if (IpInstance->Groups[Index] == Group) { - return EFI_ALREADY_STARTED; - } - } - - Members = Ip4CombineGroups (IpInstance->Groups, IpInstance->GroupCount, Group); - - if (Members == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - if (EFI_ERROR (Ip4JoinGroup (IpInstance, NTOHL (Group)))) { - FreePool (Members); - return EFI_DEVICE_ERROR; - } - - if (IpInstance->Groups != NULL) { - FreePool (IpInstance->Groups); - } - - IpInstance->Groups = Members; - IpInstance->GroupCount++; - - return EFI_SUCCESS; - } - - // - // Leave the group. Leave all the groups if GroupAddress is NULL. - // Must iterate from the end to the beginning because the GroupCount - // is decreamented each time an address is removed.. - // - for (Index = IpInstance->GroupCount; Index > 0 ; Index--) { - ASSERT (IpInstance->Groups != NULL); - Group = IpInstance->Groups[Index - 1]; - if ((GroupAddress == NULL) || EFI_IP4_EQUAL (&Group, GroupAddress)) { - if (EFI_ERROR (Ip4LeaveGroup (IpInstance, NTOHL (Group)))) { - return EFI_DEVICE_ERROR; - } - - Ip4RemoveGroupAddr (IpInstance->Groups, IpInstance->GroupCount, Group); - IpInstance->GroupCount--; - - if (IpInstance->GroupCount == 0) { - ASSERT (Index == 1); - - FreePool (IpInstance->Groups); - IpInstance->Groups = NULL; - } - - if (GroupAddress != NULL) { - return EFI_SUCCESS; - } - } - } - - return ((GroupAddress != NULL) ? EFI_NOT_FOUND : EFI_SUCCESS); -} - - -/** - Joins and leaves multicast groups. - - The Groups() function is used to join and leave multicast group sessions. Joining - a group will enable reception of matching multicast packets. Leaving a group will - disable the multicast packet reception. - - If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left. - - @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. - @param[in] JoinFlag Set to TRUE to join the multicast group session and FALSE to leave. - @param[in] GroupAddress Pointer to the IPv4 multicast address. - - @retval EFI_SUCCESS The operation completed successfully. - @retval EFI_INVALID_PARAMETER One or more of the following is TRUE: - - This is NULL. - - JoinFlag is TRUE and GroupAddress is NULL. - - GroupAddress is not NULL and *GroupAddress is - not a multicast IPv4 address. - @retval EFI_NOT_STARTED This instance has not been started. - @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, - RARP, etc.) is not finished yet. - @retval EFI_OUT_OF_RESOURCES System resources could not be allocated. - @retval EFI_UNSUPPORTED This EFI IPv4 Protocol implementation does not support multicast groups. - @retval EFI_ALREADY_STARTED The group address is already in the group table (when - JoinFlag is TRUE). - @retval EFI_NOT_FOUND The group address is not in the group table (when JoinFlag is FALSE). - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. - -**/ -EFI_STATUS -EFIAPI -EfiIp4Groups ( - IN EFI_IP4_PROTOCOL *This, - IN BOOLEAN JoinFlag, - IN EFI_IPv4_ADDRESS *GroupAddress OPTIONAL - ) -{ - IP4_PROTOCOL *IpInstance; - EFI_STATUS Status; - EFI_TPL OldTpl; - IP4_ADDR McastIp; - - if ((This == NULL) || (JoinFlag && (GroupAddress == NULL))) { - return EFI_INVALID_PARAMETER; - } - - if (GroupAddress != NULL) { - CopyMem (&McastIp, GroupAddress, sizeof (IP4_ADDR)); - - if (!IP4_IS_MULTICAST (NTOHL (McastIp))) { - return EFI_INVALID_PARAMETER; - } - } - - IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This); - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - if (IpInstance->State != IP4_STATE_CONFIGED) { - Status = EFI_NOT_STARTED; - goto ON_EXIT; - } - - if (IpInstance->ConfigData.UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) { - Status = EFI_NO_MAPPING; - goto ON_EXIT; - } - - Status = Ip4Groups (IpInstance, JoinFlag, GroupAddress); - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - return Status; -} - - -/** - Adds and deletes routing table entries. - - The Routes() function adds a route to or deletes a route from the routing table. - - Routes are determined by comparing the SubnetAddress with the destination IPv4 - address arithmetically AND-ed with the SubnetMask. The gateway address must be - on the same subnet as the configured station address. - - The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0. - The default route matches all destination IPv4 addresses that do not match any - other routes. - - A GatewayAddress that is zero is a nonroute. Packets are sent to the destination - IP address if it can be found in the ARP cache or on the local subnet. One automatic - nonroute entry will be inserted into the routing table for outgoing packets that - are addressed to a local subnet (gateway address of 0.0.0.0). - - Each EFI IPv4 Protocol instance has its own independent routing table. Those EFI - IPv4 Protocol instances that use the default IPv4 address will also have copies - of the routing table that was provided by the EFI_IP4_CONFIG_PROTOCOL, and these - copies will be updated whenever the EIF IPv4 Protocol driver reconfigures its - instances. As a result, client modification to the routing table will be lost. - - @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. - @param[in] DeleteRoute Set to TRUE to delete this route from the routing table. Set to - FALSE to add this route to the routing table. SubnetAddress - and SubnetMask are used as the key to each route entry. - @param[in] SubnetAddress The address of the subnet that needs to be routed. - @param[in] SubnetMask The subnet mask of SubnetAddress. - @param[in] GatewayAddress The unicast gateway IPv4 address for this route. - - @retval EFI_SUCCESS The operation completed successfully. - @retval EFI_NOT_STARTED The driver instance has not been started. - @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, - RARP, etc.) is not finished yet. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - - This is NULL. - - SubnetAddress is NULL. - - SubnetMask is NULL. - - GatewayAddress is NULL. - - *SubnetAddress is not a valid subnet address. - - *SubnetMask is not a valid subnet mask. - - *GatewayAddress is not a valid unicast IPv4 address. - @retval EFI_OUT_OF_RESOURCES Could not add the entry to the routing table. - @retval EFI_NOT_FOUND This route is not in the routing table (when DeleteRoute is TRUE). - @retval EFI_ACCESS_DENIED The route is already defined in the routing table (when - DeleteRoute is FALSE). - -**/ -EFI_STATUS -EFIAPI -EfiIp4Routes ( - IN EFI_IP4_PROTOCOL *This, - IN BOOLEAN DeleteRoute, - IN EFI_IPv4_ADDRESS *SubnetAddress, - IN EFI_IPv4_ADDRESS *SubnetMask, - IN EFI_IPv4_ADDRESS *GatewayAddress - ) -{ - IP4_PROTOCOL *IpInstance; - IP4_INTERFACE *IpIf; - IP4_ADDR Dest; - IP4_ADDR Netmask; - IP4_ADDR Nexthop; - EFI_STATUS Status; - EFI_TPL OldTpl; - - // - // First, validate the parameters - // - if ((This == NULL) || (SubnetAddress == NULL) || - (SubnetMask == NULL) || (GatewayAddress == NULL)) { - return EFI_INVALID_PARAMETER; - } - - IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This); - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - if (IpInstance->State != IP4_STATE_CONFIGED) { - Status = EFI_NOT_STARTED; - goto ON_EXIT; - } - - if (IpInstance->ConfigData.UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) { - Status = EFI_NO_MAPPING; - goto ON_EXIT; - } - - CopyMem (&Dest, SubnetAddress, sizeof (IP4_ADDR)); - CopyMem (&Netmask, SubnetMask, sizeof (IP4_ADDR)); - CopyMem (&Nexthop, GatewayAddress, sizeof (IP4_ADDR)); - - Dest = NTOHL (Dest); - Netmask = NTOHL (Netmask); - Nexthop = NTOHL (Nexthop); - - IpIf = IpInstance->Interface; - - if (!IP4_IS_VALID_NETMASK (Netmask)) { - Status = EFI_INVALID_PARAMETER; - goto ON_EXIT; - } - - // - // the gateway address must be a unicast on the connected network if not zero. - // - if ((Nexthop != IP4_ALLZERO_ADDRESS) && - ((IpIf->SubnetMask != IP4_ALLONE_ADDRESS && !IP4_NET_EQUAL (Nexthop, IpIf->Ip, IpIf->SubnetMask)) || - IP4_IS_BROADCAST (Ip4GetNetCast (Nexthop, IpIf)))) { - - Status = EFI_INVALID_PARAMETER; - goto ON_EXIT; - } - - if (DeleteRoute) { - Status = Ip4DelRoute (IpInstance->RouteTable, Dest, Netmask, Nexthop); - } else { - Status = Ip4AddRoute (IpInstance->RouteTable, Dest, Netmask, Nexthop); - } - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - return Status; -} - - -/** - Check whether the user's token or event has already - been enqueued on IP4's list. - - @param[in] Map The container of either user's transmit or receive - token. - @param[in] Item Current item to check against. - @param[in] Context The Token to check againist. - - @retval EFI_ACCESS_DENIED The token or event has already been enqueued in IP. - @retval EFI_SUCCESS The current item isn't the same token/event as the - context. - -**/ -EFI_STATUS -EFIAPI -Ip4TokenExist ( - IN NET_MAP *Map, - IN NET_MAP_ITEM *Item, - IN VOID *Context - ) -{ - EFI_IP4_COMPLETION_TOKEN *Token; - EFI_IP4_COMPLETION_TOKEN *TokenInItem; - - Token = (EFI_IP4_COMPLETION_TOKEN *) Context; - TokenInItem = (EFI_IP4_COMPLETION_TOKEN *) Item->Key; - - if ((Token == TokenInItem) || (Token->Event == TokenInItem->Event)) { - return EFI_ACCESS_DENIED; - } - - return EFI_SUCCESS; -} - -/** - Validate the user's token against current station address. - - @param[in] Token User's token to validate. - @param[in] IpIf The IP4 child's interface. - @param[in] RawData Set to TRUE to send unformatted packets. - - @retval EFI_INVALID_PARAMETER Some parameters are invalid. - @retval EFI_BAD_BUFFER_SIZE The user's option/data is too long. - @retval EFI_SUCCESS The token is valid. - -**/ -EFI_STATUS -Ip4TxTokenValid ( - IN EFI_IP4_COMPLETION_TOKEN *Token, - IN IP4_INTERFACE *IpIf, - IN BOOLEAN RawData - ) -{ - EFI_IP4_TRANSMIT_DATA *TxData; - EFI_IP4_OVERRIDE_DATA *Override; - IP4_ADDR Src; - IP4_ADDR Gateway; - UINT32 Offset; - UINT32 Index; - UINT32 HeadLen; - - if ((Token == NULL) || (Token->Event == NULL) || (Token->Packet.TxData == NULL)) { - return EFI_INVALID_PARAMETER; - } - - TxData = Token->Packet.TxData; - - // - // Check the fragment table: no empty fragment, and length isn't bogus. - // - if ((TxData->TotalDataLength == 0) || (TxData->FragmentCount == 0)) { - return EFI_INVALID_PARAMETER; - } - - Offset = TxData->TotalDataLength; - - if (Offset > IP4_MAX_PACKET_SIZE) { - return EFI_BAD_BUFFER_SIZE; - } - - for (Index = 0; Index < TxData->FragmentCount; Index++) { - if ((TxData->FragmentTable[Index].FragmentBuffer == NULL) || - (TxData->FragmentTable[Index].FragmentLength == 0)) { - - return EFI_INVALID_PARAMETER; - } - - Offset -= TxData->FragmentTable[Index].FragmentLength; - } - - if (Offset != 0) { - return EFI_INVALID_PARAMETER; - } - - // - // NOTE that OptionsLength/OptionsBuffer/OverrideData are ignored if RawData - // is TRUE. - // - if (RawData) { - return EFI_SUCCESS; - } - - // - // Check the IP options: no more than 40 bytes and format is OK - // - if (TxData->OptionsLength != 0) { - if ((TxData->OptionsLength > 40) || (TxData->OptionsBuffer == NULL)) { - return EFI_INVALID_PARAMETER; - } - - if (!Ip4OptionIsValid (TxData->OptionsBuffer, TxData->OptionsLength, FALSE)) { - return EFI_INVALID_PARAMETER; - } - } - - // - // Check the source and gateway: they must be a valid unicast. - // Gateway must also be on the connected network. - // - if (TxData->OverrideData != NULL) { - Override = TxData->OverrideData; - - CopyMem (&Src, &Override->SourceAddress, sizeof (IP4_ADDR)); - CopyMem (&Gateway, &Override->GatewayAddress, sizeof (IP4_ADDR)); - - Src = NTOHL (Src); - Gateway = NTOHL (Gateway); - - if ((NetGetIpClass (Src) > IP4_ADDR_CLASSC) || - (Src == IP4_ALLONE_ADDRESS) || - IP4_IS_BROADCAST (Ip4GetNetCast (Src, IpIf))) { - - return EFI_INVALID_PARAMETER; - } - - // - // If gateway isn't zero, it must be a unicast address, and - // on the connected network. - // - if ((Gateway != IP4_ALLZERO_ADDRESS) && - ((NetGetIpClass (Gateway) > IP4_ADDR_CLASSC) || - !IP4_NET_EQUAL (Gateway, IpIf->Ip, IpIf->SubnetMask) || - IP4_IS_BROADCAST (Ip4GetNetCast (Gateway, IpIf)))) { - - return EFI_INVALID_PARAMETER; - } - } - - // - // Check the packet length: Head length and packet length all has a limit - // - HeadLen = sizeof (IP4_HEAD) + ((TxData->OptionsLength + 3) &~0x03); - - if ((HeadLen > IP4_MAX_HEADLEN) || - (TxData->TotalDataLength + HeadLen > IP4_MAX_PACKET_SIZE)) { - - return EFI_BAD_BUFFER_SIZE; - } - - return EFI_SUCCESS; -} - - -/** - The callback function for the net buffer which wraps the user's - transmit token. Although it seems this function is pretty simple, - there are some subtle things. - When user requests the IP to transmit a packet by passing it a - token, the token is wrapped in an IP4_TXTOKEN_WRAP and the data - is wrapped in an net buffer. the net buffer's Free function is - set to Ip4FreeTxToken. The Token and token wrap are added to the - IP child's TxToken map. Then the buffer is passed to Ip4Output for - transmission. If something error happened before that, the buffer - is freed, which in turn will free the token wrap. The wrap may - have been added to the TxToken map or not, and the user's event - shouldn't be fired because we are still in the EfiIp4Transmit. If - the buffer has been sent by Ip4Output, it should be removed from - the TxToken map and user's event signaled. The token wrap and buffer - are bound together. Check the comments in Ip4Output for information - about IP fragmentation. - - @param[in] Context The token's wrap. - -**/ -VOID -EFIAPI -Ip4FreeTxToken ( - IN VOID *Context - ) -{ - IP4_TXTOKEN_WRAP *Wrap; - NET_MAP_ITEM *Item; - - Wrap = (IP4_TXTOKEN_WRAP *) Context; - - // - // Signal IpSecRecycleEvent to inform IPsec free the memory - // - if (Wrap->IpSecRecycleSignal != NULL) { - gBS->SignalEvent (Wrap->IpSecRecycleSignal); - } - - // - // Find the token in the instance's map. EfiIp4Transmit put the - // token to the map. If that failed, NetMapFindKey will return NULL. - // - Item = NetMapFindKey (&Wrap->IpInstance->TxTokens, Wrap->Token); - - if (Item != NULL) { - NetMapRemoveItem (&Wrap->IpInstance->TxTokens, Item, NULL); - } - - if (Wrap->Sent) { - gBS->SignalEvent (Wrap->Token->Event); - - // - // Dispatch the DPC queued by the NotifyFunction of Token->Event. - // - DispatchDpc (); - } - - FreePool (Wrap); -} - - -/** - The callback function to Ip4Output to update the transmit status. - - @param Ip4Instance The Ip4Instance that request the transmit. - @param Packet The user's transmit request. - @param IoStatus The result of the transmission. - @param Flag Not used during transmission. - @param Context The token's wrap. - -**/ -VOID -Ip4OnPacketSent ( - IP4_PROTOCOL *Ip4Instance, - NET_BUF *Packet, - EFI_STATUS IoStatus, - UINT32 Flag, - VOID *Context - ) -{ - IP4_TXTOKEN_WRAP *Wrap; - - // - // This is the transmission request from upper layer, - // not the IP4 driver itself. - // - ASSERT (Ip4Instance != NULL); - - // - // The first fragment of the packet has been sent. Update - // the token's status. That is, if fragmented, the transmit's - // status is the first fragment's status. The Wrap will be - // release when all the fragments are release. Check the comments - // in Ip4FreeTxToken and Ip4Output for information. - // - Wrap = (IP4_TXTOKEN_WRAP *) Context; - Wrap->Token->Status = IoStatus; - - NetbufFree (Wrap->Packet); -} - - -/** - Places outgoing data packets into the transmit queue. - - The Transmit() function places a sending request in the transmit queue of this - EFI IPv4 Protocol instance. Whenever the packet in the token is sent out or some - errors occur, the event in the token will be signaled and the status is updated. - - @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. - @param[in] Token Pointer to the transmit token. - - @retval EFI_SUCCESS The data has been queued for transmission. - @retval EFI_NOT_STARTED This instance has not been started. - @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, - RARP, etc.) is not finished yet. - @retval EFI_INVALID_PARAMETER One or more pameters are invalid. - @retval EFI_ACCESS_DENIED The transmit completion token with the same Token.Event - was already in the transmit queue. - @retval EFI_NOT_READY The completion token could not be queued because the transmit - queue is full. - @retval EFI_NOT_FOUND Not route is found to destination address. - @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data. - @retval EFI_BUFFER_TOO_SMALL Token.Packet.TxData.TotalDataLength is too - short to transmit. - @retval EFI_BAD_BUFFER_SIZE The length of the IPv4 header + option length + total data length is - greater than MTU (or greater than the maximum packet size if - Token.Packet.TxData.OverrideData. - DoNotFragment is TRUE). - -**/ -EFI_STATUS -EFIAPI -EfiIp4Transmit ( - IN EFI_IP4_PROTOCOL *This, - IN EFI_IP4_COMPLETION_TOKEN *Token - ) -{ - IP4_SERVICE *IpSb; - IP4_PROTOCOL *IpInstance; - IP4_INTERFACE *IpIf; - IP4_TXTOKEN_WRAP *Wrap; - EFI_IP4_TRANSMIT_DATA *TxData; - EFI_IP4_CONFIG_DATA *Config; - EFI_IP4_OVERRIDE_DATA *Override; - IP4_HEAD Head; - IP4_ADDR GateWay; - EFI_STATUS Status; - EFI_TPL OldTpl; - BOOLEAN DontFragment; - UINT32 HeadLen; - UINT8 RawHdrLen; - UINT32 OptionsLength; - UINT8 *OptionsBuffer; - VOID *FirstFragment; - - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This); - - if (IpInstance->State != IP4_STATE_CONFIGED) { - return EFI_NOT_STARTED; - } - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - IpSb = IpInstance->Service; - IpIf = IpInstance->Interface; - Config = &IpInstance->ConfigData; - - if (Config->UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) { - Status = EFI_NO_MAPPING; - goto ON_EXIT; - } - - // - // make sure that token is properly formated - // - Status = Ip4TxTokenValid (Token, IpIf, Config->RawData); - - if (EFI_ERROR (Status)) { - goto ON_EXIT; - } - - // - // Check whether the token or signal already existed. - // - if (EFI_ERROR (NetMapIterate (&IpInstance->TxTokens, Ip4TokenExist, Token))) { - Status = EFI_ACCESS_DENIED; - goto ON_EXIT; - } - - // - // Build the IP header, need to fill in the Tos, TotalLen, Id, - // fragment, Ttl, protocol, Src, and Dst. - // - TxData = Token->Packet.TxData; - - FirstFragment = NULL; - - if (Config->RawData) { - // - // When RawData is TRUE, first buffer in FragmentTable points to a raw - // IPv4 fragment including IPv4 header and options. - // - FirstFragment = TxData->FragmentTable[0].FragmentBuffer; - CopyMem (&RawHdrLen, FirstFragment, sizeof (UINT8)); - - RawHdrLen = (UINT8) (RawHdrLen & 0x0f); - if (RawHdrLen < 5) { - Status = EFI_INVALID_PARAMETER; - goto ON_EXIT; - } - - RawHdrLen = (UINT8) (RawHdrLen << 2); - - CopyMem (&Head, FirstFragment, IP4_MIN_HEADLEN); - - Ip4NtohHead (&Head); - HeadLen = 0; - DontFragment = IP4_DO_NOT_FRAGMENT (Head.Fragment); - - if (!DontFragment) { - Status = EFI_INVALID_PARAMETER; - goto ON_EXIT; - } - - GateWay = IP4_ALLZERO_ADDRESS; - - // - // Get IPv4 options from first fragment. - // - if (RawHdrLen == IP4_MIN_HEADLEN) { - OptionsLength = 0; - OptionsBuffer = NULL; - } else { - OptionsLength = RawHdrLen - IP4_MIN_HEADLEN; - OptionsBuffer = (UINT8 *) FirstFragment + IP4_MIN_HEADLEN; - } - - // - // Trim off IPv4 header and options from first fragment. - // - TxData->FragmentTable[0].FragmentBuffer = (UINT8 *) FirstFragment + RawHdrLen; - TxData->FragmentTable[0].FragmentLength = TxData->FragmentTable[0].FragmentLength - RawHdrLen; - } else { - CopyMem (&Head.Dst, &TxData->DestinationAddress, sizeof (IP4_ADDR)); - Head.Dst = NTOHL (Head.Dst); - - if (TxData->OverrideData != NULL) { - Override = TxData->OverrideData; - Head.Protocol = Override->Protocol; - Head.Tos = Override->TypeOfService; - Head.Ttl = Override->TimeToLive; - DontFragment = Override->DoNotFragment; - - CopyMem (&Head.Src, &Override->SourceAddress, sizeof (IP4_ADDR)); - CopyMem (&GateWay, &Override->GatewayAddress, sizeof (IP4_ADDR)); - - Head.Src = NTOHL (Head.Src); - GateWay = NTOHL (GateWay); - } else { - Head.Src = IpIf->Ip; - GateWay = IP4_ALLZERO_ADDRESS; - Head.Protocol = Config->DefaultProtocol; - Head.Tos = Config->TypeOfService; - Head.Ttl = Config->TimeToLive; - DontFragment = Config->DoNotFragment; - } - - Head.Fragment = IP4_HEAD_FRAGMENT_FIELD (DontFragment, FALSE, 0); - HeadLen = (TxData->OptionsLength + 3) & (~0x03); - - OptionsLength = TxData->OptionsLength; - OptionsBuffer = (UINT8 *) (TxData->OptionsBuffer); - } - - // - // If don't fragment and fragment needed, return error - // - if (DontFragment && (TxData->TotalDataLength + HeadLen > IpSb->MaxPacketSize)) { - Status = EFI_BAD_BUFFER_SIZE; - goto ON_EXIT; - } - - // - // OK, it survives all the validation check. Wrap the token in - // a IP4_TXTOKEN_WRAP and the data in a netbuf - // - Status = EFI_OUT_OF_RESOURCES; - Wrap = AllocateZeroPool (sizeof (IP4_TXTOKEN_WRAP)); - if (Wrap == NULL) { - goto ON_EXIT; - } - - Wrap->IpInstance = IpInstance; - Wrap->Token = Token; - Wrap->Sent = FALSE; - Wrap->Life = IP4_US_TO_SEC (Config->TransmitTimeout); - Wrap->Packet = NetbufFromExt ( - (NET_FRAGMENT *) TxData->FragmentTable, - TxData->FragmentCount, - IP4_MAX_HEADLEN, - 0, - Ip4FreeTxToken, - Wrap - ); - - if (Wrap->Packet == NULL) { - FreePool (Wrap); - goto ON_EXIT; - } - - Token->Status = EFI_NOT_READY; - - if (EFI_ERROR (NetMapInsertTail (&IpInstance->TxTokens, Token, Wrap))) { - // - // NetbufFree will call Ip4FreeTxToken, which in turn will - // free the IP4_TXTOKEN_WRAP. Now, the token wrap hasn't been - // enqueued. - // - if (Config->RawData) { - // - // Restore pointer of first fragment in RawData mode. - // - TxData->FragmentTable[0].FragmentBuffer = (UINT8 *) FirstFragment; - } - - NetbufFree (Wrap->Packet); - goto ON_EXIT; - } - - // - // Mark the packet sent before output it. Mark it not sent again if the - // returned status is not EFI_SUCCESS; - // - Wrap->Sent = TRUE; - - Status = Ip4Output ( - IpSb, - IpInstance, - Wrap->Packet, - &Head, - OptionsBuffer, - OptionsLength, - GateWay, - Ip4OnPacketSent, - Wrap - ); - - if (EFI_ERROR (Status)) { - Wrap->Sent = FALSE; - - if (Config->RawData) { - // - // Restore pointer of first fragment in RawData mode. - // - TxData->FragmentTable[0].FragmentBuffer = (UINT8 *) FirstFragment; - } - - NetbufFree (Wrap->Packet); - } - - if (Config->RawData) { - // - // Restore pointer of first fragment in RawData mode. - // - TxData->FragmentTable[0].FragmentBuffer = (UINT8 *) FirstFragment; - } - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - return Status; -} - - -/** - Places a receiving request into the receiving queue. - - The Receive() function places a completion token into the receive packet queue. - This function is always asynchronous. - - The Token.Event field in the completion token must be filled in by the caller - and cannot be NULL. When the receive operation completes, the EFI IPv4 Protocol - driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event - is signaled. - - @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. - @param[in] Token Pointer to a token that is associated with the receive data descriptor. - - @retval EFI_SUCCESS The receive completion token was cached. - @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started. - @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, RARP, etc.) - is not finished yet. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - - This is NULL. - - Token is NULL. - - Token.Event is NULL. - @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system - resources (usually memory). - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. - The EFI IPv4 Protocol instance has been reset to startup defaults. - EFI_ACCESS_DENIED The receive completion token with the same Token.Event was already - in the receive queue. - @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full. - @retval EFI_ICMP_ERROR An ICMP error packet was received. - -**/ -EFI_STATUS -EFIAPI -EfiIp4Receive ( - IN EFI_IP4_PROTOCOL *This, - IN EFI_IP4_COMPLETION_TOKEN *Token - ) -{ - IP4_PROTOCOL *IpInstance; - EFI_STATUS Status; - EFI_TPL OldTpl; - - // - // First validate the parameters - // - if ((This == NULL) || (Token == NULL) || (Token->Event == NULL)) { - return EFI_INVALID_PARAMETER; - } - - IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This); - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - if (IpInstance->State != IP4_STATE_CONFIGED) { - Status = EFI_NOT_STARTED; - goto ON_EXIT; - } - - // - // Check whether the toke is already on the receive queue. - // - Status = NetMapIterate (&IpInstance->RxTokens, Ip4TokenExist, Token); - - if (EFI_ERROR (Status)) { - Status = EFI_ACCESS_DENIED; - goto ON_EXIT; - } - - // - // Queue the token then check whether there is pending received packet. - // - Status = NetMapInsertTail (&IpInstance->RxTokens, Token, NULL); - - if (EFI_ERROR (Status)) { - goto ON_EXIT; - } - - Status = Ip4InstanceDeliverPacket (IpInstance); - - // - // Dispatch the DPC queued by the NotifyFunction of this instane's receive - // event. - // - DispatchDpc (); - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - return Status; -} - - -/** - Cancel the transmitted but not recycled packet. If a matching - token is found, it will call Ip4CancelPacket to cancel the - packet. Ip4CancelPacket will cancel all the fragments of the - packet. When all the fragments are freed, the IP4_TXTOKEN_WRAP - will be deleted from the Map, and user's event signalled. - Because Ip4CancelPacket and other functions are all called in - line, so, after Ip4CancelPacket returns, the Item has been freed. - - @param[in] Map The IP4 child's transmit queue. - @param[in] Item The current transmitted packet to test. - @param[in] Context The user's token to cancel. - - @retval EFI_SUCCESS Continue to check the next Item. - @retval EFI_ABORTED The user's Token (Token != NULL) is cancelled. - -**/ -EFI_STATUS -EFIAPI -Ip4CancelTxTokens ( - IN NET_MAP *Map, - IN NET_MAP_ITEM *Item, - IN VOID *Context - ) -{ - EFI_IP4_COMPLETION_TOKEN *Token; - IP4_TXTOKEN_WRAP *Wrap; - - Token = (EFI_IP4_COMPLETION_TOKEN *) Context; - - // - // Return EFI_SUCCESS to check the next item in the map if - // this one doesn't match. - // - if ((Token != NULL) && (Token != Item->Key)) { - return EFI_SUCCESS; - } - - Wrap = (IP4_TXTOKEN_WRAP *) Item->Value; - ASSERT (Wrap != NULL); - - // - // Don't access the Item, Wrap and Token's members after this point. - // Item and wrap has been freed. And we no longer own the Token. - // - Ip4CancelPacket (Wrap->IpInstance->Interface, Wrap->Packet, EFI_ABORTED); - - // - // If only one item is to be cancel, return EFI_ABORTED to stop - // iterating the map any more. - // - if (Token != NULL) { - return EFI_ABORTED; - } - - return EFI_SUCCESS; -} - - -/** - Cancel the receive request. This is quiet simple, because - it is only enqueued in our local receive map. - - @param[in] Map The IP4 child's receive queue. - @param[in] Item Current receive request to cancel. - @param[in] Context The user's token to cancel. - - @retval EFI_SUCCESS Continue to check the next receive request on the - queue. - @retval EFI_ABORTED The user's token (token != NULL) has been - cancelled. - -**/ -EFI_STATUS -EFIAPI -Ip4CancelRxTokens ( - IN NET_MAP *Map, - IN NET_MAP_ITEM *Item, - IN VOID *Context - ) -{ - EFI_IP4_COMPLETION_TOKEN *Token; - EFI_IP4_COMPLETION_TOKEN *This; - - Token = (EFI_IP4_COMPLETION_TOKEN *) Context; - This = Item->Key; - - if ((Token != NULL) && (Token != This)) { - return EFI_SUCCESS; - } - - NetMapRemoveItem (Map, Item, NULL); - - This->Status = EFI_ABORTED; - This->Packet.RxData = NULL; - gBS->SignalEvent (This->Event); - - if (Token != NULL) { - return EFI_ABORTED; - } - - return EFI_SUCCESS; -} - - -/** - Cancel the user's receive/transmit request. - - @param[in] IpInstance The IP4 child. - @param[in] Token The token to cancel. If NULL, all token will be - cancelled. - - @retval EFI_SUCCESS The token is cancelled. - @retval EFI_NOT_FOUND The token isn't found on either the - transmit/receive queue. - @retval EFI_DEVICE_ERROR Not all token is cancelled when Token is NULL. - -**/ -EFI_STATUS -Ip4Cancel ( - IN IP4_PROTOCOL *IpInstance, - IN EFI_IP4_COMPLETION_TOKEN *Token OPTIONAL - ) -{ - EFI_STATUS Status; - - // - // First check the transmitted packet. Ip4CancelTxTokens returns - // EFI_ABORTED to mean that the token has been cancelled when - // token != NULL. So, return EFI_SUCCESS for this condition. - // - Status = NetMapIterate (&IpInstance->TxTokens, Ip4CancelTxTokens, Token); - - if (EFI_ERROR (Status)) { - if ((Token != NULL) && (Status == EFI_ABORTED)) { - return EFI_SUCCESS; - } - - return Status; - } - - // - // Check the receive queue. Ip4CancelRxTokens also returns EFI_ABORT - // for Token!=NULL and it is cancelled. - // - Status = NetMapIterate (&IpInstance->RxTokens, Ip4CancelRxTokens, Token); - // - // Dispatch the DPCs queued by the NotifyFunction of the canceled rx token's - // events. - // - DispatchDpc (); - if (EFI_ERROR (Status)) { - if ((Token != NULL) && (Status == EFI_ABORTED)) { - return EFI_SUCCESS; - } - - return Status; - } - - // - // OK, if the Token is found when Token != NULL, the NetMapIterate - // will return EFI_ABORTED, which has been interrupted as EFI_SUCCESS. - // - if (Token != NULL) { - return EFI_NOT_FOUND; - } - - // - // If Token == NULL, cancel all the tokens. return error if no - // all of them are cancelled. - // - if (!NetMapIsEmpty (&IpInstance->TxTokens) || - !NetMapIsEmpty (&IpInstance->RxTokens)) { - - return EFI_DEVICE_ERROR; - } - - return EFI_SUCCESS; -} - - -/** - Abort an asynchronous transmit or receive request. - - The Cancel() function is used to abort a pending transmit or receive request. - If the token is in the transmit or receive request queues, after calling this - function, Token->Status will be set to EFI_ABORTED and then Token->Event will - be signaled. If the token is not in one of the queues, which usually means the - asynchronous operation has completed, this function will not signal the token - and EFI_NOT_FOUND is returned. - - @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. - @param[in] Token Pointer to a token that has been issued by - EFI_IP4_PROTOCOL.Transmit() or - EFI_IP4_PROTOCOL.Receive(). If NULL, all pending - tokens are aborted. Type EFI_IP4_COMPLETION_TOKEN is - defined in EFI_IP4_PROTOCOL.Transmit(). - - @retval EFI_SUCCESS The asynchronous I/O request was aborted and - Token.->Event was signaled. When Token is NULL, all - pending requests were aborted and their events were signaled. - @retval EFI_INVALID_PARAMETER This is NULL. - @retval EFI_NOT_STARTED This instance has not been started. - @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, - RARP, etc.) is not finished yet. - @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O request was - not found in the transmit or receive queue. It has either completed - or was not issued by Transmit() and Receive(). - -**/ -EFI_STATUS -EFIAPI -EfiIp4Cancel ( - IN EFI_IP4_PROTOCOL *This, - IN EFI_IP4_COMPLETION_TOKEN *Token OPTIONAL - ) -{ - IP4_PROTOCOL *IpInstance; - EFI_STATUS Status; - EFI_TPL OldTpl; - - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This); - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - if (IpInstance->State != IP4_STATE_CONFIGED) { - Status = EFI_NOT_STARTED; - goto ON_EXIT; - } - - if (IpInstance->ConfigData.UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) { - Status = EFI_NO_MAPPING; - goto ON_EXIT; - } - - Status = Ip4Cancel (IpInstance, Token); - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - return Status; -} - - -/** - Polls for incoming data packets and processes outgoing data packets. - - The Poll() function polls for incoming data packets and processes outgoing data - packets. Network drivers and applications can call the EFI_IP4_PROTOCOL.Poll() - function to increase the rate that data packets are moved between the communications - device and the transmit and receive queues. - - In some systems the periodic timer event may not poll the underlying communications - device fast enough to transmit and/or receive all data packets without missing - incoming packets or dropping outgoing packets. Drivers and applications that are - experiencing packet loss should try calling the EFI_IP4_PROTOCOL.Poll() function - more often. - - @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. - - @retval EFI_SUCCESS Incoming or outgoing data was processed. - @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started. - @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, - RARP, etc.) is not finished yet. - @retval EFI_INVALID_PARAMETER This is NULL. - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. - @retval EFI_NOT_READY No incoming or outgoing data is processed. - @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue. - Consider increasing the polling rate. - -**/ -EFI_STATUS -EFIAPI -EfiIp4Poll ( - IN EFI_IP4_PROTOCOL *This - ) -{ - IP4_PROTOCOL *IpInstance; - EFI_MANAGED_NETWORK_PROTOCOL *Mnp; - - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This); - - if (IpInstance->State == IP4_STATE_UNCONFIGED) { - return EFI_NOT_STARTED; - } - - Mnp = IpInstance->Service->Mnp; - - // - // Don't lock the Poll function to enable the deliver of - // the packet polled up. - // - return Mnp->Poll (Mnp); -} - -/** - Decrease the life of the transmitted packets. If it is - decreased to zero, cancel the packet. This function is - called by Ip4PacketTimerTicking which time out both the - received-but-not-delivered and transmitted-but-not-recycle - packets. - - @param[in] Map The IP4 child's transmit map. - @param[in] Item Current transmitted packet. - @param[in] Context Not used. - - @retval EFI_SUCCESS Always returns EFI_SUCCESS. - -**/ -EFI_STATUS -EFIAPI -Ip4SentPacketTicking ( - IN NET_MAP *Map, - IN NET_MAP_ITEM *Item, - IN VOID *Context - ) -{ - IP4_TXTOKEN_WRAP *Wrap; - - Wrap = (IP4_TXTOKEN_WRAP *) Item->Value; - ASSERT (Wrap != NULL); - - if ((Wrap->Life > 0) && (--Wrap->Life == 0)) { - Ip4CancelPacket (Wrap->IpInstance->Interface, Wrap->Packet, EFI_ABORTED); - } - - return EFI_SUCCESS; -} - -/** - This heart beat timer of IP4 service instance times out all of its IP4 children's - received-but-not-delivered and transmitted-but-not-recycle packets, and provides - time input for its IGMP protocol. - - @param[in] Event The IP4 service instance's heart beat timer. - @param[in] Context The IP4 service instance. - -**/ -VOID -EFIAPI -Ip4TimerTicking ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - IP4_SERVICE *IpSb; - - IpSb = (IP4_SERVICE *) Context; - NET_CHECK_SIGNATURE (IpSb, IP4_SERVICE_SIGNATURE); - - Ip4PacketTimerTicking (IpSb); - Ip4IgmpTicking (IpSb); -} - -/** - This dedicated timer is used to poll underlying network media status. In case - of cable swap or wireless network switch, a new round auto configuration will - be initiated. The timer will signal the IP4 to run DHCP configuration again. - IP4 driver will free old IP address related resource, such as route table and - Interface, then initiate a DHCP process to acquire new IP, eventually create - route table for new IP address. - - @param[in] Event The IP4 service instance's heart beat timer. - @param[in] Context The IP4 service instance. - -**/ -VOID -EFIAPI -Ip4TimerReconfigChecking ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - IP4_SERVICE *IpSb; - BOOLEAN OldMediaPresent; - EFI_STATUS Status; - EFI_SIMPLE_NETWORK_MODE SnpModeData; - - IpSb = (IP4_SERVICE *) Context; - NET_CHECK_SIGNATURE (IpSb, IP4_SERVICE_SIGNATURE); - - OldMediaPresent = IpSb->MediaPresent; - - // - // Get fresh mode data from MNP, since underlying media status may change. - // Here, it needs to mention that the MediaPresent can also be checked even if - // EFI_NOT_STARTED returned while this MNP child driver instance isn't configured. - // - Status = IpSb->Mnp->GetModeData (IpSb->Mnp, NULL, &SnpModeData); - if (EFI_ERROR (Status) && (Status != EFI_NOT_STARTED)) { - return; - } - - IpSb->MediaPresent = SnpModeData.MediaPresent; - // - // Media transimit Unpresent to Present means new link movement is detected. - // - if (!OldMediaPresent && IpSb->MediaPresent && (IpSb->Ip4Config2Instance.Policy == Ip4Config2PolicyDhcp)) { - // - // Signal the IP4 to run the dhcp configuration again. IP4 driver will free - // old IP address related resource, such as route table and Interface, then - // initiate a DHCP round to acquire new IP, eventually - // create route table for new IP address. - // - if (IpSb->ReconfigEvent != NULL) { - Status = gBS->SignalEvent (IpSb->ReconfigEvent); - DispatchDpc (); - } - } -} diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Impl.h b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Impl.h deleted file mode 100644 index a322a85981..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Impl.h +++ /dev/null @@ -1,417 +0,0 @@ -/** @file - Ip4 internal functions and type defintions. - -Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
-(C) Copyright 2015 Hewlett-Packard Development Company, L.P.
- -SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef __EFI_IP4_IMPL_H__ -#define __EFI_IP4_IMPL_H__ - -#include - -#include -#include -#include -#include -#include -#include -#include -#include - -#include - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - -#include "Ip4Common.h" -#include "Ip4Driver.h" -#include "Ip4If.h" -#include "Ip4Icmp.h" -#include "Ip4Option.h" -#include "Ip4Igmp.h" -#include "Ip4Route.h" -#include "Ip4Input.h" -#include "Ip4Output.h" -#include "Ip4Config2Impl.h" -#include "Ip4Config2Nv.h" -#include "Ip4NvData.h" - -#define IP4_PROTOCOL_SIGNATURE SIGNATURE_32 ('I', 'P', '4', 'P') -#define IP4_SERVICE_SIGNATURE SIGNATURE_32 ('I', 'P', '4', 'S') - -// -// The state of IP4 protocol. It starts from UNCONFIGED. if it is -// successfully configured, it goes to CONFIGED. if configure NULL -// is called, it becomes UNCONFIGED again. -// -#define IP4_STATE_UNCONFIGED 0 -#define IP4_STATE_CONFIGED 1 - -// -// The state of IP4 service. It starts from UNSTARTED. It transits -// to STARTED if autoconfigure is started. If default address is -// configured, it becomes CONFIGED. and if partly destroyed, it goes -// to DESTROY. -// -#define IP4_SERVICE_UNSTARTED 0 -#define IP4_SERVICE_STARTED 1 -#define IP4_SERVICE_CONFIGED 2 -#define IP4_SERVICE_DESTROY 3 - - -/// -/// IP4_TXTOKEN_WRAP wraps the upper layer's transmit token. -/// The user's data is kept in the Packet. When fragment is -/// needed, each fragment of the Packet has a reference to the -/// Packet, no data is actually copied. The Packet will be -/// released when all the fragments of it have been recycled by -/// MNP. Upon then, the IP4_TXTOKEN_WRAP will be released, and -/// user's event signalled. -/// -typedef struct { - IP4_PROTOCOL *IpInstance; - EFI_IP4_COMPLETION_TOKEN *Token; - EFI_EVENT IpSecRecycleSignal; - NET_BUF *Packet; - BOOLEAN Sent; - INTN Life; -} IP4_TXTOKEN_WRAP; - -/// -/// IP4_IPSEC_WRAP wraps the packet received from MNP layer. The packet -/// will be released after it has been processed by the receiver. Upon then, -/// the IP4_IPSEC_WRAP will be released, and the IpSecRecycleSignal will be signaled -/// to notice IPsec to free the resources. -/// -typedef struct { - EFI_EVENT IpSecRecycleSignal; - NET_BUF *Packet; -} IP4_IPSEC_WRAP; - -/// -/// IP4_RXDATA_WRAP wraps the data IP4 child delivers to the -/// upper layers. The received packet is kept in the Packet. -/// The Packet itself may be constructured from some fragments. -/// All the fragments of the Packet is organized by a -/// IP4_ASSEMBLE_ENTRY structure. If the Packet is recycled by -/// the upper layer, the assemble entry and its associated -/// fragments will be freed at last. -/// -typedef struct { - LIST_ENTRY Link; - IP4_PROTOCOL *IpInstance; - NET_BUF *Packet; - EFI_IP4_RECEIVE_DATA RxData; -} IP4_RXDATA_WRAP; - - -struct _IP4_PROTOCOL { - UINT32 Signature; - - EFI_IP4_PROTOCOL Ip4Proto; - EFI_HANDLE Handle; - INTN State; - - BOOLEAN InDestroy; - - IP4_SERVICE *Service; - LIST_ENTRY Link; // Link to all the IP protocol from the service - - // - // User's transmit/receive tokens, and received/deliverd packets - // - NET_MAP RxTokens; - NET_MAP TxTokens; // map between (User's Token, IP4_TXTOKE_WRAP) - LIST_ENTRY Received; // Received but not delivered packet - LIST_ENTRY Delivered; // Delivered and to be recycled packets - EFI_LOCK RecycleLock; - - // - // Instance's address and route tables. There are two route tables. - // RouteTable is used by the IP4 driver to route packet. EfiRouteTable - // is used to communicate the current route info to the upper layer. - // - IP4_INTERFACE *Interface; - LIST_ENTRY AddrLink; // Ip instances with the same IP address. - IP4_ROUTE_TABLE *RouteTable; - - EFI_IP4_ROUTE_TABLE *EfiRouteTable; - UINT32 EfiRouteCount; - - // - // IGMP data for this instance - // - IP4_ADDR *Groups; // stored in network byte order - UINT32 GroupCount; - - EFI_IP4_CONFIG_DATA ConfigData; - -}; - -struct _IP4_SERVICE { - UINT32 Signature; - EFI_SERVICE_BINDING_PROTOCOL ServiceBinding; - INTN State; - - // - // List of all the IP instances and interfaces, and default - // interface and route table and caches. - // - UINTN NumChildren; - LIST_ENTRY Children; - - LIST_ENTRY Interfaces; - - IP4_INTERFACE *DefaultInterface; - IP4_ROUTE_TABLE *DefaultRouteTable; - - // - // Ip reassemble utilities, and IGMP data - // - IP4_ASSEMBLE_TABLE Assemble; - IGMP_SERVICE_DATA IgmpCtrl; - - // - // Low level protocol used by this service instance - // - EFI_HANDLE Image; - EFI_HANDLE Controller; - - EFI_HANDLE MnpChildHandle; - EFI_MANAGED_NETWORK_PROTOCOL *Mnp; - - EFI_MANAGED_NETWORK_CONFIG_DATA MnpConfigData; - EFI_SIMPLE_NETWORK_MODE SnpMode; - - EFI_EVENT Timer; - EFI_EVENT ReconfigCheckTimer; - EFI_EVENT ReconfigEvent; - - BOOLEAN Reconfig; - - // - // Underlying media present status. - // - BOOLEAN MediaPresent; - - // - // IPv4 Configuration II Protocol instance - // - IP4_CONFIG2_INSTANCE Ip4Config2Instance; - - CHAR16 *MacString; - - UINT32 MaxPacketSize; - UINT32 OldMaxPacketSize; ///< The MTU before IPsec enable. -}; - -#define IP4_INSTANCE_FROM_PROTOCOL(Ip4) \ - CR ((Ip4), IP4_PROTOCOL, Ip4Proto, IP4_PROTOCOL_SIGNATURE) - -#define IP4_SERVICE_FROM_PROTOCOL(Sb) \ - CR ((Sb), IP4_SERVICE, ServiceBinding, IP4_SERVICE_SIGNATURE) - -#define IP4_SERVICE_FROM_CONFIG2_INSTANCE(This) \ - CR (This, IP4_SERVICE, Ip4Config2Instance, IP4_SERVICE_SIGNATURE) - - -#define IP4_NO_MAPPING(IpInstance) (!(IpInstance)->Interface->Configured) - -extern EFI_IP4_PROTOCOL mEfiIp4ProtocolTemplete; - -/** - Config the MNP parameter used by IP. The IP driver use one MNP - child to transmit/receive frames. By default, it configures MNP - to receive unicast/multicast/broadcast. And it will enable/disable - the promiscous receive according to whether there is IP child - enable that or not. If Force is FALSE, it will iterate through - all the IP children to check whether the promiscuous receive - setting has been changed. If it hasn't been changed, it won't - reconfigure the MNP. If Force is TRUE, the MNP is configured no - matter whether that is changed or not. - - @param[in] IpSb The IP4 service instance that is to be changed. - @param[in] Force Force the configuration or not. - - @retval EFI_SUCCESS The MNP is successfully configured/reconfigured. - @retval Others Configuration failed. - -**/ -EFI_STATUS -Ip4ServiceConfigMnp ( - IN IP4_SERVICE *IpSb, - IN BOOLEAN Force - ); - -/** - Intiialize the IP4_PROTOCOL structure to the unconfigured states. - - @param IpSb The IP4 service instance. - @param IpInstance The IP4 child instance. - -**/ -VOID -Ip4InitProtocol ( - IN IP4_SERVICE *IpSb, - IN OUT IP4_PROTOCOL *IpInstance - ); - -/** - Clean up the IP4 child, release all the resources used by it. - - @param[in] IpInstance The IP4 child to clean up. - - @retval EFI_SUCCESS The IP4 child is cleaned up. - @retval EFI_DEVICE_ERROR Some resources failed to be released. - -**/ -EFI_STATUS -Ip4CleanProtocol ( - IN IP4_PROTOCOL *IpInstance - ); - -/** - Cancel the user's receive/transmit request. - - @param[in] IpInstance The IP4 child. - @param[in] Token The token to cancel. If NULL, all token will be - cancelled. - - @retval EFI_SUCCESS The token is cancelled. - @retval EFI_NOT_FOUND The token isn't found on either the - transmit/receive queue. - @retval EFI_DEVICE_ERROR Not all token is cancelled when Token is NULL. - -**/ -EFI_STATUS -Ip4Cancel ( - IN IP4_PROTOCOL *IpInstance, - IN EFI_IP4_COMPLETION_TOKEN *Token OPTIONAL - ); - -/** - Change the IP4 child's multicast setting. The caller - should make sure that the parameters is valid. - - @param[in] IpInstance The IP4 child to change the setting. - @param[in] JoinFlag TRUE to join the group, otherwise leave it - @param[in] GroupAddress The target group address - - @retval EFI_ALREADY_STARTED Want to join the group, but already a member of it - @retval EFI_OUT_OF_RESOURCES Failed to allocate some resources. - @retval EFI_DEVICE_ERROR Failed to set the group configuraton - @retval EFI_SUCCESS Successfully updated the group setting. - @retval EFI_NOT_FOUND Try to leave the group which it isn't a member. - -**/ -EFI_STATUS -Ip4Groups ( - IN IP4_PROTOCOL *IpInstance, - IN BOOLEAN JoinFlag, - IN EFI_IPv4_ADDRESS *GroupAddress OPTIONAL - ); - -/** - This heart beat timer of IP4 service instance times out all of its IP4 children's - received-but-not-delivered and transmitted-but-not-recycle packets, and provides - time input for its IGMP protocol. - - @param[in] Event The IP4 service instance's heart beat timer. - @param[in] Context The IP4 service instance. - -**/ -VOID -EFIAPI -Ip4TimerTicking ( - IN EFI_EVENT Event, - IN VOID *Context - ); - -/** - This dedicated timer is used to poll underlying network media status. In case - of cable swap or wireless network switch, a new round auto configuration will - be initiated. The timer will signal the IP4 to run DHCP configuration again. - IP4 driver will free old IP address related resource, such as route table and - Interface, then initiate a DHCP process to acquire new IP, eventually create - route table for new IP address. - - @param[in] Event The IP4 service instance's heart beat timer. - @param[in] Context The IP4 service instance. - -**/ -VOID -EFIAPI -Ip4TimerReconfigChecking ( - IN EFI_EVENT Event, - IN VOID *Context - ); - -/** - Decrease the life of the transmitted packets. If it is - decreased to zero, cancel the packet. This function is - called by Ip4PacketTimerTicking which time out both the - received-but-not-delivered and transmitted-but-not-recycle - packets. - - @param[in] Map The IP4 child's transmit map. - @param[in] Item Current transmitted packet. - @param[in] Context Not used. - - @retval EFI_SUCCESS Always returns EFI_SUCCESS. - -**/ -EFI_STATUS -EFIAPI -Ip4SentPacketTicking ( - IN NET_MAP *Map, - IN NET_MAP_ITEM *Item, - IN VOID *Context - ); - -/** - The callback function for the net buffer which wraps the user's - transmit token. Although it seems this function is pretty simple, - there are some subtle things. - When user requests the IP to transmit a packet by passing it a - token, the token is wrapped in an IP4_TXTOKEN_WRAP and the data - is wrapped in an net buffer. the net buffer's Free function is - set to Ip4FreeTxToken. The Token and token wrap are added to the - IP child's TxToken map. Then the buffer is passed to Ip4Output for - transmission. If something error happened before that, the buffer - is freed, which in turn will free the token wrap. The wrap may - have been added to the TxToken map or not, and the user's event - shouldn't be fired because we are still in the EfiIp4Transmit. If - the buffer has been sent by Ip4Output, it should be removed from - the TxToken map and user's event signaled. The token wrap and buffer - are bound together. Check the comments in Ip4Output for information - about IP fragmentation. - - @param[in] Context The token's wrap. - -**/ -VOID -EFIAPI -Ip4FreeTxToken ( - IN VOID *Context - ); - -extern EFI_IPSEC2_PROTOCOL *mIpSec; -extern BOOLEAN mIpSec2Installed; - -#endif diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Input.c b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Input.c deleted file mode 100644 index 24c5846588..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Input.c +++ /dev/null @@ -1,1597 +0,0 @@ -/** @file - IP4 input process. - -Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
-(C) Copyright 2015 Hewlett-Packard Development Company, L.P.
- -SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Ip4Impl.h" - - -/** - Create an empty assemble entry for the packet identified by - (Dst, Src, Id, Protocol). The default life for the packet is - 120 seconds. - - @param[in] Dst The destination address - @param[in] Src The source address - @param[in] Id The ID field in IP header - @param[in] Protocol The protocol field in IP header - - @return NULL if failed to allocate memory for the entry, otherwise - the point to just created reassemble entry. - -**/ -IP4_ASSEMBLE_ENTRY * -Ip4CreateAssembleEntry ( - IN IP4_ADDR Dst, - IN IP4_ADDR Src, - IN UINT16 Id, - IN UINT8 Protocol - ) -{ - - IP4_ASSEMBLE_ENTRY *Assemble; - - Assemble = AllocatePool (sizeof (IP4_ASSEMBLE_ENTRY)); - - if (Assemble == NULL) { - return NULL; - } - - InitializeListHead (&Assemble->Link); - InitializeListHead (&Assemble->Fragments); - - Assemble->Dst = Dst; - Assemble->Src = Src; - Assemble->Id = Id; - Assemble->Protocol = Protocol; - Assemble->TotalLen = 0; - Assemble->CurLen = 0; - Assemble->Head = NULL; - Assemble->Info = NULL; - Assemble->Life = IP4_FRAGMENT_LIFE; - - return Assemble; -} - - -/** - Release all the fragments of a packet, then free the assemble entry. - - @param[in] Assemble The assemble entry to free - -**/ -VOID -Ip4FreeAssembleEntry ( - IN IP4_ASSEMBLE_ENTRY *Assemble - ) -{ - LIST_ENTRY *Entry; - LIST_ENTRY *Next; - NET_BUF *Fragment; - - NET_LIST_FOR_EACH_SAFE (Entry, Next, &Assemble->Fragments) { - Fragment = NET_LIST_USER_STRUCT (Entry, NET_BUF, List); - - RemoveEntryList (Entry); - NetbufFree (Fragment); - } - - FreePool (Assemble); -} - - -/** - Initialize an already allocated assemble table. This is generally - the assemble table embedded in the IP4 service instance. - - @param[in, out] Table The assemble table to initialize. - -**/ -VOID -Ip4InitAssembleTable ( - IN OUT IP4_ASSEMBLE_TABLE *Table - ) -{ - UINT32 Index; - - for (Index = 0; Index < IP4_ASSEMLE_HASH_SIZE; Index++) { - InitializeListHead (&Table->Bucket[Index]); - } -} - - -/** - Clean up the assemble table: remove all the fragments - and assemble entries. - - @param[in] Table The assemble table to clean up - -**/ -VOID -Ip4CleanAssembleTable ( - IN IP4_ASSEMBLE_TABLE *Table - ) -{ - LIST_ENTRY *Entry; - LIST_ENTRY *Next; - IP4_ASSEMBLE_ENTRY *Assemble; - UINT32 Index; - - for (Index = 0; Index < IP4_ASSEMLE_HASH_SIZE; Index++) { - NET_LIST_FOR_EACH_SAFE (Entry, Next, &Table->Bucket[Index]) { - Assemble = NET_LIST_USER_STRUCT (Entry, IP4_ASSEMBLE_ENTRY, Link); - - RemoveEntryList (Entry); - Ip4FreeAssembleEntry (Assemble); - } - } -} - - -/** - Trim the packet to fit in [Start, End), and update the per - packet information. - - @param Packet Packet to trim - @param Start The sequence of the first byte to fit in - @param End One beyond the sequence of last byte to fit in. - -**/ -VOID -Ip4TrimPacket ( - IN OUT NET_BUF *Packet, - IN INTN Start, - IN INTN End - ) -{ - IP4_CLIP_INFO *Info; - INTN Len; - - Info = IP4_GET_CLIP_INFO (Packet); - - ASSERT (Info->Start + Info->Length == Info->End); - ASSERT ((Info->Start < End) && (Start < Info->End)); - - if (Info->Start < Start) { - Len = Start - Info->Start; - - NetbufTrim (Packet, (UINT32) Len, NET_BUF_HEAD); - Info->Start = Start; - Info->Length -= Len; - } - - if (End < Info->End) { - Len = End - Info->End; - - NetbufTrim (Packet, (UINT32) Len, NET_BUF_TAIL); - Info->End = End; - Info->Length -= Len; - } -} - - -/** - Release all the fragments of the packet. This is the callback for - the assembled packet's OnFree. It will free the assemble entry, - which in turn will free all the fragments of the packet. - - @param[in] Arg The assemble entry to free - -**/ -VOID -EFIAPI -Ip4OnFreeFragments ( - IN VOID *Arg - ) -{ - Ip4FreeAssembleEntry ((IP4_ASSEMBLE_ENTRY *) Arg); -} - - -/** - Reassemble the IP fragments. If all the fragments of the packet - have been received, it will wrap the packet in a net buffer then - return it to caller. If the packet can't be assembled, NULL is - return. - - @param Table The assemble table used. New assemble entry will be created - if the Packet is from a new chain of fragments. - @param Packet The fragment to assemble. It might be freed if the fragment - can't be re-assembled. - - @return NULL if the packet can't be reassemble. The point to just assembled - packet if all the fragments of the packet have arrived. - -**/ -NET_BUF * -Ip4Reassemble ( - IN OUT IP4_ASSEMBLE_TABLE *Table, - IN OUT NET_BUF *Packet - ) -{ - IP4_HEAD *IpHead; - IP4_CLIP_INFO *This; - IP4_CLIP_INFO *Node; - IP4_ASSEMBLE_ENTRY *Assemble; - LIST_ENTRY *Head; - LIST_ENTRY *Prev; - LIST_ENTRY *Cur; - NET_BUF *Fragment; - NET_BUF *NewPacket; - INTN Index; - - IpHead = Packet->Ip.Ip4; - This = IP4_GET_CLIP_INFO (Packet); - - ASSERT (IpHead != NULL); - - // - // First: find the related assemble entry - // - Assemble = NULL; - Index = IP4_ASSEMBLE_HASH (IpHead->Dst, IpHead->Src, IpHead->Id, IpHead->Protocol); - - NET_LIST_FOR_EACH (Cur, &Table->Bucket[Index]) { - Assemble = NET_LIST_USER_STRUCT (Cur, IP4_ASSEMBLE_ENTRY, Link); - - if ((Assemble->Dst == IpHead->Dst) && (Assemble->Src == IpHead->Src) && - (Assemble->Id == IpHead->Id) && (Assemble->Protocol == IpHead->Protocol)) { - break; - } - } - - // - // Create a new assemble entry if no assemble entry is related to this packet - // - if (Cur == &Table->Bucket[Index]) { - Assemble = Ip4CreateAssembleEntry ( - IpHead->Dst, - IpHead->Src, - IpHead->Id, - IpHead->Protocol - ); - - if (Assemble == NULL) { - goto DROP; - } - - InsertHeadList (&Table->Bucket[Index], &Assemble->Link); - } - // - // Assemble shouldn't be NULL here - // - ASSERT (Assemble != NULL); - - // - // Find the point to insert the packet: before the first - // fragment with THIS.Start < CUR.Start. the previous one - // has PREV.Start <= THIS.Start < CUR.Start. - // - Head = &Assemble->Fragments; - - NET_LIST_FOR_EACH (Cur, Head) { - Fragment = NET_LIST_USER_STRUCT (Cur, NET_BUF, List); - - if (This->Start < IP4_GET_CLIP_INFO (Fragment)->Start) { - break; - } - } - - // - // Check whether the current fragment overlaps with the previous one. - // It holds that: PREV.Start <= THIS.Start < THIS.End. Only need to - // check whether THIS.Start < PREV.End for overlap. If two fragments - // overlaps, trim the overlapped part off THIS fragment. - // - if ((Prev = Cur->BackLink) != Head) { - Fragment = NET_LIST_USER_STRUCT (Prev, NET_BUF, List); - Node = IP4_GET_CLIP_INFO (Fragment); - - if (This->Start < Node->End) { - if (This->End <= Node->End) { - NetbufFree (Packet); - return NULL; - } - - Ip4TrimPacket (Packet, Node->End, This->End); - } - } - - // - // Insert the fragment into the packet. The fragment may be removed - // from the list by the following checks. - // - NetListInsertBefore (Cur, &Packet->List); - - // - // Check the packets after the insert point. It holds that: - // THIS.Start <= NODE.Start < NODE.End. The equality holds - // if PREV and NEXT are continuous. THIS fragment may fill - // several holes. Remove the completely overlapped fragments - // - while (Cur != Head) { - Fragment = NET_LIST_USER_STRUCT (Cur, NET_BUF, List); - Node = IP4_GET_CLIP_INFO (Fragment); - - // - // Remove fragments completely overlapped by this fragment - // - if (Node->End <= This->End) { - Cur = Cur->ForwardLink; - - RemoveEntryList (&Fragment->List); - Assemble->CurLen -= Node->Length; - - NetbufFree (Fragment); - continue; - } - - // - // The conditions are: THIS.Start <= NODE.Start, and THIS.End < - // NODE.End. Two fragments overlaps if NODE.Start < THIS.End. - // If two fragments start at the same offset, remove THIS fragment - // because ((THIS.Start == NODE.Start) && (THIS.End < NODE.End)). - // - if (Node->Start < This->End) { - if (This->Start == Node->Start) { - RemoveEntryList (&Packet->List); - goto DROP; - } - - Ip4TrimPacket (Packet, This->Start, Node->Start); - } - - break; - } - - // - // Update the assemble info: increase the current length. If it is - // the frist fragment, update the packet's IP head and per packet - // info. If it is the last fragment, update the total length. - // - Assemble->CurLen += This->Length; - - if (This->Start == 0) { - // - // Once the first fragment is enqueued, it can't be removed - // from the fragment list. So, Assemble->Head always point - // to valid memory area. - // - ASSERT (Assemble->Head == NULL); - - Assemble->Head = IpHead; - Assemble->Info = IP4_GET_CLIP_INFO (Packet); - } - - // - // Don't update the length more than once. - // - if (IP4_LAST_FRAGMENT (IpHead->Fragment) && (Assemble->TotalLen == 0)) { - Assemble->TotalLen = This->End; - } - - // - // Deliver the whole packet if all the fragments received. - // All fragments received if: - // 1. received the last one, so, the total length is know - // 2. received all the data. If the last fragment on the - // queue ends at the total length, all data is received. - // - if ((Assemble->TotalLen != 0) && (Assemble->CurLen >= Assemble->TotalLen)) { - - RemoveEntryList (&Assemble->Link); - - // - // If the packet is properly formated, the last fragment's End - // equals to the packet's total length. Otherwise, the packet - // is a fake, drop it now. - // - Fragment = NET_LIST_USER_STRUCT (Head->BackLink, NET_BUF, List); - - if (IP4_GET_CLIP_INFO (Fragment)->End != Assemble->TotalLen) { - Ip4FreeAssembleEntry (Assemble); - return NULL; - } - - // - // Wrap the packet in a net buffer then deliver it up - // - NewPacket = NetbufFromBufList ( - &Assemble->Fragments, - 0, - 0, - Ip4OnFreeFragments, - Assemble - ); - - if (NewPacket == NULL) { - Ip4FreeAssembleEntry (Assemble); - return NULL; - } - - NewPacket->Ip.Ip4 = Assemble->Head; - - ASSERT (Assemble->Info != NULL); - - CopyMem ( - IP4_GET_CLIP_INFO (NewPacket), - Assemble->Info, - sizeof (*IP4_GET_CLIP_INFO (NewPacket)) - ); - - return NewPacket; - } - - return NULL; - -DROP: - NetbufFree (Packet); - return NULL; -} - -/** - The callback function for the net buffer which wraps the packet processed by - IPsec. It releases the wrap packet and also signals IPsec to free the resources. - - @param[in] Arg The wrap context - -**/ -VOID -EFIAPI -Ip4IpSecFree ( - IN VOID *Arg - ) -{ - IP4_IPSEC_WRAP *Wrap; - - Wrap = (IP4_IPSEC_WRAP *) Arg; - - if (Wrap->IpSecRecycleSignal != NULL) { - gBS->SignalEvent (Wrap->IpSecRecycleSignal); - } - - NetbufFree (Wrap->Packet); - - FreePool (Wrap); - - return; -} - -/** - The work function to locate IPsec protocol to process the inbound or - outbound IP packets. The process routine handls the packet with following - actions: bypass the packet, discard the packet, or protect the packet. - - @param[in] IpSb The IP4 service instance. - @param[in, out] Head The The caller supplied IP4 header. - @param[in, out] Netbuf The IP4 packet to be processed by IPsec. - @param[in, out] Options The caller supplied options. - @param[in, out] OptionsLen The length of the option. - @param[in] Direction The directionality in an SPD entry, - EfiIPsecInBound or EfiIPsecOutBound. - @param[in] Context The token's wrap. - - @retval EFI_SUCCESS The IPsec protocol is not available or disabled. - @retval EFI_SUCCESS The packet was bypassed and all buffers remain the same. - @retval EFI_SUCCESS The packet was protected. - @retval EFI_ACCESS_DENIED The packet was discarded. - @retval EFI_OUT_OF_RESOURCES There is no suffcient resource to complete the operation. - @retval EFI_BUFFER_TOO_SMALL The number of non-empty block is bigger than the - number of input data blocks when build a fragment table. - -**/ -EFI_STATUS -Ip4IpSecProcessPacket ( - IN IP4_SERVICE *IpSb, - IN OUT IP4_HEAD **Head, - IN OUT NET_BUF **Netbuf, - IN OUT UINT8 **Options, - IN OUT UINT32 *OptionsLen, - IN EFI_IPSEC_TRAFFIC_DIR Direction, - IN VOID *Context - ) -{ - NET_FRAGMENT *FragmentTable; - NET_FRAGMENT *OriginalFragmentTable; - UINT32 FragmentCount; - UINT32 OriginalFragmentCount; - EFI_EVENT RecycleEvent; - NET_BUF *Packet; - IP4_TXTOKEN_WRAP *TxWrap; - IP4_IPSEC_WRAP *IpSecWrap; - EFI_STATUS Status; - IP4_HEAD ZeroHead; - - Status = EFI_SUCCESS; - - if (!mIpSec2Installed) { - goto ON_EXIT; - } - ASSERT (mIpSec != NULL); - - Packet = *Netbuf; - RecycleEvent = NULL; - IpSecWrap = NULL; - FragmentTable = NULL; - TxWrap = (IP4_TXTOKEN_WRAP *) Context; - FragmentCount = Packet->BlockOpNum; - - ZeroMem (&ZeroHead, sizeof (IP4_HEAD)); - - // - // Check whether the IPsec enable variable is set. - // - if (mIpSec->DisabledFlag) { - // - // If IPsec is disabled, restore the original MTU - // - IpSb->MaxPacketSize = IpSb->OldMaxPacketSize; - goto ON_EXIT; - } else { - // - // If IPsec is enabled, use the MTU which reduce the IPsec header length. - // - IpSb->MaxPacketSize = IpSb->OldMaxPacketSize - IP4_MAX_IPSEC_HEADLEN; - } - - // - // Rebuild fragment table from netbuf to ease IPsec process. - // - FragmentTable = AllocateZeroPool (FragmentCount * sizeof (NET_FRAGMENT)); - - if (FragmentTable == NULL) { - Status = EFI_OUT_OF_RESOURCES; - goto ON_EXIT; - } - - Status = NetbufBuildExt (Packet, FragmentTable, &FragmentCount); - - // - // Record the original FragmentTable and count. - // - OriginalFragmentTable = FragmentTable; - OriginalFragmentCount = FragmentCount; - - if (EFI_ERROR (Status)) { - FreePool (FragmentTable); - goto ON_EXIT; - } - - // - // Convert host byte order to network byte order - // - Ip4NtohHead (*Head); - - Status = mIpSec->ProcessExt ( - mIpSec, - IpSb->Controller, - IP_VERSION_4, - (VOID *) (*Head), - &(*Head)->Protocol, - (VOID **) Options, - OptionsLen, - (EFI_IPSEC_FRAGMENT_DATA **) (&FragmentTable), - &FragmentCount, - Direction, - &RecycleEvent - ); - // - // Convert back to host byte order - // - Ip4NtohHead (*Head); - - if (EFI_ERROR (Status)) { - FreePool (OriginalFragmentTable); - goto ON_EXIT; - } - - if (OriginalFragmentTable == FragmentTable && OriginalFragmentCount == FragmentCount) { - // - // For ByPass Packet - // - FreePool (FragmentTable); - goto ON_EXIT; - } else { - // - // Free the FragmentTable which allocated before calling the IPsec. - // - FreePool (OriginalFragmentTable); - } - - if (Direction == EfiIPsecOutBound && TxWrap != NULL) { - - TxWrap->IpSecRecycleSignal = RecycleEvent; - TxWrap->Packet = NetbufFromExt ( - FragmentTable, - FragmentCount, - IP4_MAX_HEADLEN, - 0, - Ip4FreeTxToken, - TxWrap - ); - if (TxWrap->Packet == NULL) { - // - // Recover the TxWrap->Packet, if meet a error, and the caller will free - // the TxWrap. - // - TxWrap->Packet = *Netbuf; - Status = EFI_OUT_OF_RESOURCES; - goto ON_EXIT; - } - - // - // Free orginal Netbuf. - // - NetIpSecNetbufFree (*Netbuf); - *Netbuf = TxWrap->Packet; - - } else { - - IpSecWrap = AllocateZeroPool (sizeof (IP4_IPSEC_WRAP)); - - if (IpSecWrap == NULL) { - Status = EFI_OUT_OF_RESOURCES; - gBS->SignalEvent (RecycleEvent); - goto ON_EXIT; - } - - IpSecWrap->IpSecRecycleSignal = RecycleEvent; - IpSecWrap->Packet = Packet; - Packet = NetbufFromExt ( - FragmentTable, - FragmentCount, - IP4_MAX_HEADLEN, - 0, - Ip4IpSecFree, - IpSecWrap - ); - - if (Packet == NULL) { - Packet = IpSecWrap->Packet; - gBS->SignalEvent (RecycleEvent); - FreePool (IpSecWrap); - Status = EFI_OUT_OF_RESOURCES; - goto ON_EXIT; - } - - if (Direction == EfiIPsecInBound && 0 != CompareMem (*Head, &ZeroHead, sizeof (IP4_HEAD))) { - Ip4PrependHead (Packet, *Head, *Options, *OptionsLen); - Ip4NtohHead (Packet->Ip.Ip4); - NetbufTrim (Packet, ((*Head)->HeadLen << 2), TRUE); - - CopyMem ( - IP4_GET_CLIP_INFO (Packet), - IP4_GET_CLIP_INFO (IpSecWrap->Packet), - sizeof (IP4_CLIP_INFO) - ); - } - *Netbuf = Packet; - } - -ON_EXIT: - return Status; -} - -/** - Pre-process the IPv4 packet. First validates the IPv4 packet, and - then reassembles packet if it is necessary. - - @param[in] IpSb Pointer to IP4_SERVICE. - @param[in, out] Packet Pointer to the Packet to be processed. - @param[in] Head Pointer to the IP4_HEAD. - @param[in] Option Pointer to a buffer which contains the IPv4 option. - @param[in] OptionLen The length of Option in bytes. - @param[in] Flag The link layer flag for the packet received, such - as multicast. - - @retval EFI_SEUCCESS The recieved packet is in well form. - @retval EFI_INVAILD_PARAMETER The recieved packet is malformed. - -**/ -EFI_STATUS -Ip4PreProcessPacket ( - IN IP4_SERVICE *IpSb, - IN OUT NET_BUF **Packet, - IN IP4_HEAD *Head, - IN UINT8 *Option, - IN UINT32 OptionLen, - IN UINT32 Flag - ) -{ - IP4_CLIP_INFO *Info; - UINT32 HeadLen; - UINT32 TotalLen; - UINT16 Checksum; - - // - // Check if the IP4 header is correctly formatted. - // - if ((*Packet)->TotalSize < IP4_MIN_HEADLEN) { - return EFI_INVALID_PARAMETER; - } - - HeadLen = (Head->HeadLen << 2); - TotalLen = NTOHS (Head->TotalLen); - - // - // Mnp may deliver frame trailer sequence up, trim it off. - // - if (TotalLen < (*Packet)->TotalSize) { - NetbufTrim (*Packet, (*Packet)->TotalSize - TotalLen, FALSE); - } - - if ((Head->Ver != 4) || (HeadLen < IP4_MIN_HEADLEN) || - (TotalLen < HeadLen) || (TotalLen != (*Packet)->TotalSize)) { - return EFI_INVALID_PARAMETER; - } - - // - // Some OS may send IP packets without checksum. - // - Checksum = (UINT16) (~NetblockChecksum ((UINT8 *) Head, HeadLen)); - - if ((Head->Checksum != 0) && (Checksum != 0)) { - return EFI_INVALID_PARAMETER; - } - - // - // Convert the IP header to host byte order, then get the per packet info. - // - (*Packet)->Ip.Ip4 = Ip4NtohHead (Head); - - Info = IP4_GET_CLIP_INFO (*Packet); - Info->LinkFlag = Flag; - Info->CastType = Ip4GetHostCast (IpSb, Head->Dst, Head->Src); - Info->Start = (Head->Fragment & IP4_HEAD_OFFSET_MASK) << 3; - Info->Length = Head->TotalLen - HeadLen; - Info->End = Info->Start + Info->Length; - Info->Status = EFI_SUCCESS; - - // - // The packet is destinated to us if the CastType is non-zero. - // - if ((Info->CastType == 0) || (Info->End > IP4_MAX_PACKET_SIZE)) { - return EFI_INVALID_PARAMETER; - } - - // - // Validate the options. Don't call the Ip4OptionIsValid if - // there is no option to save some CPU process. - // - - if ((OptionLen > 0) && !Ip4OptionIsValid (Option, OptionLen, TRUE)) { - return EFI_INVALID_PARAMETER; - } - - // - // Trim the head off, after this point, the packet is headless, - // and Packet->TotalLen == Info->Length. - // - NetbufTrim (*Packet, HeadLen, TRUE); - - // - // Reassemble the packet if this is a fragment. The packet is a - // fragment if its head has MF (more fragment) set, or it starts - // at non-zero byte. - // - if (((Head->Fragment & IP4_HEAD_MF_MASK) != 0) || (Info->Start != 0)) { - // - // Drop the fragment if DF is set but it is fragmented. Gateway - // need to send a type 4 destination unreache ICMP message here. - // - if ((Head->Fragment & IP4_HEAD_DF_MASK) != 0) { - return EFI_INVALID_PARAMETER; - } - - // - // The length of all but the last fragments is in the unit of 8 bytes. - // - if (((Head->Fragment & IP4_HEAD_MF_MASK) != 0) && (Info->Length % 8 != 0)) { - return EFI_INVALID_PARAMETER; - } - - *Packet = Ip4Reassemble (&IpSb->Assemble, *Packet); - - // - // Packet assembly isn't complete, start receive more packet. - // - if (*Packet == NULL) { - return EFI_INVALID_PARAMETER; - } - } - - return EFI_SUCCESS; -} - -/** - The IP4 input routine. It is called by the IP4_INTERFACE when a - IP4 fragment is received from MNP. - - @param[in] Ip4Instance The IP4 child that request the receive, most like - it is NULL. - @param[in] Packet The IP4 packet received. - @param[in] IoStatus The return status of receive request. - @param[in] Flag The link layer flag for the packet received, such - as multicast. - @param[in] Context The IP4 service instance that own the MNP. - -**/ -VOID -Ip4AccpetFrame ( - IN IP4_PROTOCOL *Ip4Instance, - IN NET_BUF *Packet, - IN EFI_STATUS IoStatus, - IN UINT32 Flag, - IN VOID *Context - ) -{ - IP4_SERVICE *IpSb; - IP4_HEAD *Head; - EFI_STATUS Status; - IP4_HEAD ZeroHead; - UINT8 *Option; - UINT32 OptionLen; - - IpSb = (IP4_SERVICE *) Context; - Option = NULL; - - if (EFI_ERROR (IoStatus) || (IpSb->State == IP4_SERVICE_DESTROY)) { - goto DROP; - } - - Head = (IP4_HEAD *) NetbufGetByte (Packet, 0, NULL); - ASSERT (Head != NULL); - OptionLen = (Head->HeadLen << 2) - IP4_MIN_HEADLEN; - if (OptionLen > 0) { - Option = (UINT8 *) (Head + 1); - } - - // - // Validate packet format and reassemble packet if it is necessary. - // - Status = Ip4PreProcessPacket ( - IpSb, - &Packet, - Head, - Option, - OptionLen, - Flag - ); - - if (EFI_ERROR (Status)) { - goto RESTART; - } - - // - // After trim off, the packet is a esp/ah/udp/tcp/icmp6 net buffer, - // and no need consider any other ahead ext headers. - // - Status = Ip4IpSecProcessPacket ( - IpSb, - &Head, - &Packet, - &Option, - &OptionLen, - EfiIPsecInBound, - NULL - ); - - if (EFI_ERROR (Status)) { - goto RESTART; - } - - // - // If the packet is protected by tunnel mode, parse the inner Ip Packet. - // - ZeroMem (&ZeroHead, sizeof (IP4_HEAD)); - if (0 == CompareMem (Head, &ZeroHead, sizeof (IP4_HEAD))) { - // Packet may have been changed. Head, HeadLen, TotalLen, and - // info must be reloaded bofore use. The ownership of the packet - // is transfered to the packet process logic. - // - Head = (IP4_HEAD *) NetbufGetByte (Packet, 0, NULL); - ASSERT (Head != NULL); - Status = Ip4PreProcessPacket ( - IpSb, - &Packet, - Head, - Option, - OptionLen, - Flag - ); - if (EFI_ERROR (Status)) { - goto RESTART; - } - } - - ASSERT (Packet != NULL); - Head = Packet->Ip.Ip4; - IP4_GET_CLIP_INFO (Packet)->Status = EFI_SUCCESS; - - switch (Head->Protocol) { - case EFI_IP_PROTO_ICMP: - Ip4IcmpHandle (IpSb, Head, Packet); - break; - - case IP4_PROTO_IGMP: - Ip4IgmpHandle (IpSb, Head, Packet); - break; - - default: - Ip4Demultiplex (IpSb, Head, Packet, Option, OptionLen); - } - - Packet = NULL; - - // - // Dispatch the DPCs queued by the NotifyFunction of the rx token's events - // which are signaled with received data. - // - DispatchDpc (); - -RESTART: - Ip4ReceiveFrame (IpSb->DefaultInterface, NULL, Ip4AccpetFrame, IpSb); - -DROP: - if (Packet != NULL) { - NetbufFree (Packet); - } - - return ; -} - - -/** - Check whether this IP child accepts the packet. - - @param[in] IpInstance The IP child to check - @param[in] Head The IP header of the packet - @param[in] Packet The data of the packet - - @retval TRUE If the child wants to receive the packet. - @retval FALSE Otherwise. - -**/ -BOOLEAN -Ip4InstanceFrameAcceptable ( - IN IP4_PROTOCOL *IpInstance, - IN IP4_HEAD *Head, - IN NET_BUF *Packet - ) -{ - IP4_ICMP_ERROR_HEAD Icmp; - EFI_IP4_CONFIG_DATA *Config; - IP4_CLIP_INFO *Info; - UINT16 Proto; - UINT32 Index; - - Config = &IpInstance->ConfigData; - - // - // Dirty trick for the Tiano UEFI network stack implmentation. If - // ReceiveTimeout == -1, the receive of the packet for this instance - // is disabled. The UEFI spec don't have such capability. We add - // this to improve the performance because IP will make a copy of - // the received packet for each accepting instance. Some IP instances - // used by UDP/TCP only send packets, they don't wants to receive. - // - if (Config->ReceiveTimeout == (UINT32)(-1)) { - return FALSE; - } - - if (Config->AcceptPromiscuous) { - return TRUE; - } - - // - // Use protocol from the IP header embedded in the ICMP error - // message to filter, instead of ICMP itself. ICMP handle will - // call Ip4Demultiplex to deliver ICMP errors. - // - Proto = Head->Protocol; - - if ((Proto == EFI_IP_PROTO_ICMP) && (!Config->AcceptAnyProtocol) && (Proto != Config->DefaultProtocol)) { - NetbufCopy (Packet, 0, sizeof (Icmp.Head), (UINT8 *) &Icmp.Head); - - if (mIcmpClass[Icmp.Head.Type].IcmpClass == ICMP_ERROR_MESSAGE) { - if (!Config->AcceptIcmpErrors) { - return FALSE; - } - - NetbufCopy (Packet, 0, sizeof (Icmp), (UINT8 *) &Icmp); - Proto = Icmp.IpHead.Protocol; - } - } - - // - // Match the protocol - // - if (!Config->AcceptAnyProtocol && (Proto != Config->DefaultProtocol)) { - return FALSE; - } - - // - // Check for broadcast, the caller has computed the packet's - // cast type for this child's interface. - // - Info = IP4_GET_CLIP_INFO (Packet); - - if (IP4_IS_BROADCAST (Info->CastType)) { - return Config->AcceptBroadcast; - } - - // - // If it is a multicast packet, check whether we are in the group. - // - if (Info->CastType == IP4_MULTICAST) { - // - // Receive the multicast if the instance wants to receive all packets. - // - if (!IpInstance->ConfigData.UseDefaultAddress && (IpInstance->Interface->Ip == 0)) { - return TRUE; - } - - for (Index = 0; Index < IpInstance->GroupCount; Index++) { - if (IpInstance->Groups[Index] == HTONL (Head->Dst)) { - break; - } - } - - return (BOOLEAN)(Index < IpInstance->GroupCount); - } - - return TRUE; -} - - -/** - Enqueue a shared copy of the packet to the IP4 child if the - packet is acceptable to it. Here the data of the packet is - shared, but the net buffer isn't. - - @param[in] IpInstance The IP4 child to enqueue the packet to - @param[in] Head The IP header of the received packet - @param[in] Packet The data of the received packet - - @retval EFI_NOT_STARTED The IP child hasn't been configured. - @retval EFI_INVALID_PARAMETER The child doesn't want to receive the packet - @retval EFI_OUT_OF_RESOURCES Failed to allocate some resource - @retval EFI_SUCCESS A shared copy the packet is enqueued to the child. - -**/ -EFI_STATUS -Ip4InstanceEnquePacket ( - IN IP4_PROTOCOL *IpInstance, - IN IP4_HEAD *Head, - IN NET_BUF *Packet - ) -{ - IP4_CLIP_INFO *Info; - NET_BUF *Clone; - - // - // Check whether the packet is acceptable to this instance. - // - if (IpInstance->State != IP4_STATE_CONFIGED) { - return EFI_NOT_STARTED; - } - - if (!Ip4InstanceFrameAcceptable (IpInstance, Head, Packet)) { - return EFI_INVALID_PARAMETER; - } - - // - // Enque a shared copy of the packet. - // - Clone = NetbufClone (Packet); - - if (Clone == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - // - // Set the receive time out for the assembled packet. If it expires, - // packet will be removed from the queue. - // - Info = IP4_GET_CLIP_INFO (Clone); - Info->Life = IP4_US_TO_SEC (IpInstance->ConfigData.ReceiveTimeout); - - InsertTailList (&IpInstance->Received, &Clone->List); - return EFI_SUCCESS; -} - - -/** - The signal handle of IP4's recycle event. It is called back - when the upper layer release the packet. - - @param Event The IP4's recycle event. - @param Context The context of the handle, which is a - IP4_RXDATA_WRAP - -**/ -VOID -EFIAPI -Ip4OnRecyclePacket ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - IP4_RXDATA_WRAP *Wrap; - - Wrap = (IP4_RXDATA_WRAP *) Context; - - EfiAcquireLockOrFail (&Wrap->IpInstance->RecycleLock); - RemoveEntryList (&Wrap->Link); - EfiReleaseLock (&Wrap->IpInstance->RecycleLock); - - ASSERT (!NET_BUF_SHARED (Wrap->Packet)); - NetbufFree (Wrap->Packet); - - gBS->CloseEvent (Wrap->RxData.RecycleSignal); - FreePool (Wrap); -} - - -/** - Wrap the received packet to a IP4_RXDATA_WRAP, which will be - delivered to the upper layer. Each IP4 child that accepts the - packet will get a not-shared copy of the packet which is wrapped - in the IP4_RXDATA_WRAP. The IP4_RXDATA_WRAP->RxData is passed - to the upper layer. Upper layer will signal the recycle event in - it when it is done with the packet. - - @param[in] IpInstance The IP4 child to receive the packet. - @param[in] Packet The packet to deliver up. - - @retval Wrap if warp the packet succeed. - @retval NULL failed to wrap the packet . - -**/ -IP4_RXDATA_WRAP * -Ip4WrapRxData ( - IN IP4_PROTOCOL *IpInstance, - IN NET_BUF *Packet - ) -{ - IP4_RXDATA_WRAP *Wrap; - EFI_IP4_RECEIVE_DATA *RxData; - EFI_STATUS Status; - BOOLEAN RawData; - - Wrap = AllocatePool (IP4_RXDATA_WRAP_SIZE (Packet->BlockOpNum)); - - if (Wrap == NULL) { - return NULL; - } - - InitializeListHead (&Wrap->Link); - - Wrap->IpInstance = IpInstance; - Wrap->Packet = Packet; - RxData = &Wrap->RxData; - - ZeroMem (RxData, sizeof (EFI_IP4_RECEIVE_DATA)); - - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, - Ip4OnRecyclePacket, - Wrap, - &RxData->RecycleSignal - ); - - if (EFI_ERROR (Status)) { - FreePool (Wrap); - return NULL; - } - - ASSERT (Packet->Ip.Ip4 != NULL); - - ASSERT (IpInstance != NULL); - RawData = IpInstance->ConfigData.RawData; - - // - // The application expects a network byte order header. - // - if (!RawData) { - RxData->HeaderLength = (Packet->Ip.Ip4->HeadLen << 2); - RxData->Header = (EFI_IP4_HEADER *) Ip4NtohHead (Packet->Ip.Ip4); - RxData->OptionsLength = RxData->HeaderLength - IP4_MIN_HEADLEN; - RxData->Options = NULL; - - if (RxData->OptionsLength != 0) { - RxData->Options = (VOID *) (RxData->Header + 1); - } - } - - RxData->DataLength = Packet->TotalSize; - - // - // Build the fragment table to be delivered up. - // - RxData->FragmentCount = Packet->BlockOpNum; - NetbufBuildExt (Packet, (NET_FRAGMENT *) RxData->FragmentTable, &RxData->FragmentCount); - - return Wrap; -} - - -/** - Deliver the received packets to upper layer if there are both received - requests and enqueued packets. If the enqueued packet is shared, it will - duplicate it to a non-shared packet, release the shared packet, then - deliver the non-shared packet up. - - @param[in] IpInstance The IP child to deliver the packet up. - - @retval EFI_OUT_OF_RESOURCES Failed to allocate resources to deliver the - packets. - @retval EFI_SUCCESS All the enqueued packets that can be delivered - are delivered up. - -**/ -EFI_STATUS -Ip4InstanceDeliverPacket ( - IN IP4_PROTOCOL *IpInstance - ) -{ - EFI_IP4_COMPLETION_TOKEN *Token; - IP4_RXDATA_WRAP *Wrap; - NET_BUF *Packet; - NET_BUF *Dup; - UINT8 *Head; - UINT32 HeadLen; - - // - // Deliver a packet if there are both a packet and a receive token. - // - while (!IsListEmpty (&IpInstance->Received) && - !NetMapIsEmpty (&IpInstance->RxTokens)) { - - Packet = NET_LIST_HEAD (&IpInstance->Received, NET_BUF, List); - - if (!NET_BUF_SHARED (Packet)) { - // - // If this is the only instance that wants the packet, wrap it up. - // - Wrap = Ip4WrapRxData (IpInstance, Packet); - - if (Wrap == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - RemoveEntryList (&Packet->List); - - } else { - // - // Create a duplicated packet if this packet is shared - // - if (IpInstance->ConfigData.RawData) { - HeadLen = 0; - } else { - HeadLen = IP4_MAX_HEADLEN; - } - - Dup = NetbufDuplicate (Packet, NULL, HeadLen); - - if (Dup == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - if (!IpInstance->ConfigData.RawData) { - // - // Copy the IP head over. The packet to deliver up is - // headless. Trim the head off after copy. The IP head - // may be not continuous before the data. - // - Head = NetbufAllocSpace (Dup, IP4_MAX_HEADLEN, NET_BUF_HEAD); - ASSERT (Head != NULL); - - Dup->Ip.Ip4 = (IP4_HEAD *) Head; - - CopyMem (Head, Packet->Ip.Ip4, Packet->Ip.Ip4->HeadLen << 2); - NetbufTrim (Dup, IP4_MAX_HEADLEN, TRUE); - } - - Wrap = Ip4WrapRxData (IpInstance, Dup); - - if (Wrap == NULL) { - NetbufFree (Dup); - return EFI_OUT_OF_RESOURCES; - } - - RemoveEntryList (&Packet->List); - NetbufFree (Packet); - - Packet = Dup; - } - - // - // Insert it into the delivered packet, then get a user's - // receive token, pass the wrapped packet up. - // - EfiAcquireLockOrFail (&IpInstance->RecycleLock); - InsertHeadList (&IpInstance->Delivered, &Wrap->Link); - EfiReleaseLock (&IpInstance->RecycleLock); - - Token = NetMapRemoveHead (&IpInstance->RxTokens, NULL); - Token->Status = IP4_GET_CLIP_INFO (Packet)->Status; - Token->Packet.RxData = &Wrap->RxData; - - gBS->SignalEvent (Token->Event); - } - - return EFI_SUCCESS; -} - - -/** - Enqueue a received packet to all the IP children that share - the same interface. - - @param[in] IpSb The IP4 service instance that receive the packet. - @param[in] Head The header of the received packet. - @param[in] Packet The data of the received packet. - @param[in] Option Point to the IP4 packet header options. - @param[in] OptionLen Length of the IP4 packet header options. - @param[in] IpIf The interface to enqueue the packet to. - - @return The number of the IP4 children that accepts the packet - -**/ -INTN -Ip4InterfaceEnquePacket ( - IN IP4_SERVICE *IpSb, - IN IP4_HEAD *Head, - IN NET_BUF *Packet, - IN UINT8 *Option, - IN UINT32 OptionLen, - IN IP4_INTERFACE *IpIf - ) -{ - IP4_PROTOCOL *IpInstance; - IP4_CLIP_INFO *Info; - LIST_ENTRY *Entry; - INTN Enqueued; - INTN LocalType; - INTN SavedType; - - // - // First, check that the packet is acceptable to this interface - // and find the local cast type for the interface. A packet sent - // to say 192.168.1.1 should NOT be delliever to 10.0.0.1 unless - // promiscuous receiving. - // - LocalType = 0; - Info = IP4_GET_CLIP_INFO (Packet); - - if ((Info->CastType == IP4_MULTICAST) || (Info->CastType == IP4_LOCAL_BROADCAST)) { - // - // If the CastType is multicast, don't need to filter against - // the group address here, Ip4InstanceFrameAcceptable will do - // that later. - // - LocalType = Info->CastType; - - } else { - // - // Check the destination againist local IP. If the station - // address is 0.0.0.0, it means receiving all the IP destined - // to local non-zero IP. Otherwise, it is necessary to compare - // the destination to the interface's IP address. - // - if (IpIf->Ip == IP4_ALLZERO_ADDRESS) { - LocalType = IP4_LOCAL_HOST; - - } else { - LocalType = Ip4GetNetCast (Head->Dst, IpIf); - - if ((LocalType == 0) && IpIf->PromiscRecv) { - LocalType = IP4_PROMISCUOUS; - } - } - } - - if (LocalType == 0) { - return 0; - } - - // - // Iterate through the ip instances on the interface, enqueue - // the packet if filter passed. Save the original cast type, - // and pass the local cast type to the IP children on the - // interface. The global cast type will be restored later. - // - SavedType = Info->CastType; - Info->CastType = LocalType; - - Enqueued = 0; - - NET_LIST_FOR_EACH (Entry, &IpIf->IpInstances) { - IpInstance = NET_LIST_USER_STRUCT (Entry, IP4_PROTOCOL, AddrLink); - NET_CHECK_SIGNATURE (IpInstance, IP4_PROTOCOL_SIGNATURE); - - // - // In RawData mode, add IPv4 headers and options back to packet. - // - if ((IpInstance->ConfigData.RawData) && (Option != NULL) && (OptionLen != 0)){ - Ip4PrependHead (Packet, Head, Option, OptionLen); - } - - if (Ip4InstanceEnquePacket (IpInstance, Head, Packet) == EFI_SUCCESS) { - Enqueued++; - } - } - - Info->CastType = SavedType; - return Enqueued; -} - - -/** - Deliver the packet for each IP4 child on the interface. - - @param[in] IpSb The IP4 service instance that received the packet - @param[in] IpIf The IP4 interface to deliver the packet. - - @retval EFI_SUCCESS It always returns EFI_SUCCESS now - -**/ -EFI_STATUS -Ip4InterfaceDeliverPacket ( - IN IP4_SERVICE *IpSb, - IN IP4_INTERFACE *IpIf - ) -{ - IP4_PROTOCOL *Ip4Instance; - LIST_ENTRY *Entry; - - NET_LIST_FOR_EACH (Entry, &IpIf->IpInstances) { - Ip4Instance = NET_LIST_USER_STRUCT (Entry, IP4_PROTOCOL, AddrLink); - Ip4InstanceDeliverPacket (Ip4Instance); - } - - return EFI_SUCCESS; -} - - -/** - Demultiple the packet. the packet delivery is processed in two - passes. The first pass will enque a shared copy of the packet - to each IP4 child that accepts the packet. The second pass will - deliver a non-shared copy of the packet to each IP4 child that - has pending receive requests. Data is copied if more than one - child wants to consume the packet because each IP child needs - its own copy of the packet to make changes. - - @param[in] IpSb The IP4 service instance that received the packet. - @param[in] Head The header of the received packet. - @param[in] Packet The data of the received packet. - @param[in] Option Point to the IP4 packet header options. - @param[in] OptionLen Length of the IP4 packet header options. - - @retval EFI_NOT_FOUND No IP child accepts the packet. - @retval EFI_SUCCESS The packet is enqueued or delivered to some IP - children. - -**/ -EFI_STATUS -Ip4Demultiplex ( - IN IP4_SERVICE *IpSb, - IN IP4_HEAD *Head, - IN NET_BUF *Packet, - IN UINT8 *Option, - IN UINT32 OptionLen - ) -{ - LIST_ENTRY *Entry; - IP4_INTERFACE *IpIf; - INTN Enqueued; - - // - // Two pass delivery: first, enque a shared copy of the packet - // to each instance that accept the packet. - // - Enqueued = 0; - - NET_LIST_FOR_EACH (Entry, &IpSb->Interfaces) { - IpIf = NET_LIST_USER_STRUCT (Entry, IP4_INTERFACE, Link); - - if (IpIf->Configured) { - Enqueued += Ip4InterfaceEnquePacket ( - IpSb, - Head, - Packet, - Option, - OptionLen, - IpIf - ); - } - } - - // - // Second: deliver a duplicate of the packet to each instance. - // Release the local reference first, so that the last instance - // getting the packet will not copy the data. - // - NetbufFree (Packet); - - if (Enqueued == 0) { - return EFI_NOT_FOUND; - } - - NET_LIST_FOR_EACH (Entry, &IpSb->Interfaces) { - IpIf = NET_LIST_USER_STRUCT (Entry, IP4_INTERFACE, Link); - - if (IpIf->Configured) { - Ip4InterfaceDeliverPacket (IpSb, IpIf); - } - } - - return EFI_SUCCESS; -} - - -/** - Timeout the fragment and enqueued packets. - - @param[in] IpSb The IP4 service instance to timeout - -**/ -VOID -Ip4PacketTimerTicking ( - IN IP4_SERVICE *IpSb - ) -{ - LIST_ENTRY *InstanceEntry; - LIST_ENTRY *Entry; - LIST_ENTRY *Next; - IP4_PROTOCOL *IpInstance; - IP4_ASSEMBLE_ENTRY *Assemble; - NET_BUF *Packet; - IP4_CLIP_INFO *Info; - UINT32 Index; - - // - // First, time out the fragments. The packet's life is counting down - // once the first-arrived fragment was received. - // - for (Index = 0; Index < IP4_ASSEMLE_HASH_SIZE; Index++) { - NET_LIST_FOR_EACH_SAFE (Entry, Next, &IpSb->Assemble.Bucket[Index]) { - Assemble = NET_LIST_USER_STRUCT (Entry, IP4_ASSEMBLE_ENTRY, Link); - - if ((Assemble->Life > 0) && (--Assemble->Life == 0)) { - RemoveEntryList (Entry); - Ip4FreeAssembleEntry (Assemble); - } - } - } - - NET_LIST_FOR_EACH (InstanceEntry, &IpSb->Children) { - IpInstance = NET_LIST_USER_STRUCT (InstanceEntry, IP4_PROTOCOL, Link); - - // - // Second, time out the assembled packets enqueued on each IP child. - // - NET_LIST_FOR_EACH_SAFE (Entry, Next, &IpInstance->Received) { - Packet = NET_LIST_USER_STRUCT (Entry, NET_BUF, List); - Info = IP4_GET_CLIP_INFO (Packet); - - if ((Info->Life > 0) && (--Info->Life == 0)) { - RemoveEntryList (Entry); - NetbufFree (Packet); - } - } - - // - // Third: time out the transmitted packets. - // - NetMapIterate (&IpInstance->TxTokens, Ip4SentPacketTicking, NULL); - } -} diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Input.h b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Input.h deleted file mode 100644 index f4d45d1613..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Input.h +++ /dev/null @@ -1,246 +0,0 @@ -/** @file - -Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef __EFI_IP4_INPUT_H__ -#define __EFI_IP4_INPUT_H__ - -#define IP4_MIN_HEADLEN 20 -#define IP4_MAX_HEADLEN 60 -/// -/// 8(ESP header) + 16(max IV) + 16(max padding) + 2(ESP tail) + 12(max ICV) = 54 -/// -#define IP4_MAX_IPSEC_HEADLEN 54 - -#define IP4_ASSEMLE_HASH_SIZE 31 -#define IP4_FRAGMENT_LIFE 120 -#define IP4_MAX_PACKET_SIZE 65535 - -/// -/// Per packet information for input process. LinkFlag specifies whether -/// the packet is received as Link layer unicast, multicast or broadcast. -/// The CastType is the IP layer cast type, such as IP multicast or unicast. -/// Start, End and Length are staffs used to assemble the packets. Start -/// is the sequence number of the first byte of data in the packet. Length -/// is the number of bytes of data. End = Start + Length, that is, the -/// sequence number of last byte + 1. Each assembled packet has a count down -/// life. If it isn't consumed before Life reaches zero, the packet is released. -/// -typedef struct { - UINTN LinkFlag; - INTN CastType; - INTN Start; - INTN End; - INTN Length; - UINT32 Life; - EFI_STATUS Status; -} IP4_CLIP_INFO; - -/// -/// Structure used to assemble IP packets. -/// -typedef struct { - LIST_ENTRY Link; - - // - // Identity of one IP4 packet. Each fragment of a packet has - // the same (Dst, Src, Id, Protocol). - // - IP4_ADDR Dst; - IP4_ADDR Src; - UINT16 Id; - UINT8 Protocol; - - INTN TotalLen; - INTN CurLen; - LIST_ENTRY Fragments; // List of all the fragments of this packet - - IP4_HEAD *Head; // IP head of the first fragment - IP4_CLIP_INFO *Info; // Per packet info of the first fragment - INTN Life; // Count down life for the packet. -} IP4_ASSEMBLE_ENTRY; - -/// -/// Each Ip service instance has an assemble table to reassemble -/// the packets before delivery to its children. It is organized -/// as hash table. -/// -typedef struct { - LIST_ENTRY Bucket[IP4_ASSEMLE_HASH_SIZE]; -} IP4_ASSEMBLE_TABLE; - -#define IP4_GET_CLIP_INFO(Packet) ((IP4_CLIP_INFO *) ((Packet)->ProtoData)) - -#define IP4_ASSEMBLE_HASH(Dst, Src, Id, Proto) \ - (((Dst) + (Src) + ((Id) << 16) + (Proto)) % IP4_ASSEMLE_HASH_SIZE) - -#define IP4_RXDATA_WRAP_SIZE(NumFrag) \ - (sizeof (IP4_RXDATA_WRAP) + sizeof (EFI_IP4_FRAGMENT_DATA) * ((NumFrag) - 1)) - -/** - Initialize an already allocated assemble table. This is generally - the assemble table embedded in the IP4 service instance. - - @param[in, out] Table The assemble table to initialize. - -**/ -VOID -Ip4InitAssembleTable ( - IN OUT IP4_ASSEMBLE_TABLE *Table - ); - -/** - Clean up the assemble table: remove all the fragments - and assemble entries. - - @param[in] Table The assemble table to clean up - -**/ -VOID -Ip4CleanAssembleTable ( - IN IP4_ASSEMBLE_TABLE *Table - ); - -/** - The IP4 input routine. It is called by the IP4_INTERFACE when a - IP4 fragment is received from MNP. - - @param[in] Ip4Instance The IP4 child that request the receive, most like - it is NULL. - @param[in] Packet The IP4 packet received. - @param[in] IoStatus The return status of receive request. - @param[in] Flag The link layer flag for the packet received, such - as multicast. - @param[in] Context The IP4 service instance that own the MNP. - -**/ -VOID -Ip4AccpetFrame ( - IN IP4_PROTOCOL *Ip4Instance, - IN NET_BUF *Packet, - IN EFI_STATUS IoStatus, - IN UINT32 Flag, - IN VOID *Context - ); - -/** - Demultiple the packet. the packet delivery is processed in two - passes. The first pass will enque a shared copy of the packet - to each IP4 child that accepts the packet. The second pass will - deliver a non-shared copy of the packet to each IP4 child that - has pending receive requests. Data is copied if more than one - child wants to consume the packet because each IP child needs - its own copy of the packet to make changes. - - @param[in] IpSb The IP4 service instance that received the packet. - @param[in] Head The header of the received packet. - @param[in] Packet The data of the received packet. - @param[in] Option Point to the IP4 packet header options. - @param[in] OptionLen Length of the IP4 packet header options. - - @retval EFI_NOT_FOUND No IP child accepts the packet. - @retval EFI_SUCCESS The packet is enqueued or delivered to some IP - children. - -**/ -EFI_STATUS -Ip4Demultiplex ( - IN IP4_SERVICE *IpSb, - IN IP4_HEAD *Head, - IN NET_BUF *Packet, - IN UINT8 *Option, - IN UINT32 OptionLen - ); - -/** - Enqueue a received packet to all the IP children that share - the same interface. - - @param[in] IpSb The IP4 service instance that receive the packet. - @param[in] Head The header of the received packet. - @param[in] Packet The data of the received packet. - @param[in] Option Point to the IP4 packet header options. - @param[in] OptionLen Length of the IP4 packet header options. - @param[in] IpIf The interface to enqueue the packet to. - - @return The number of the IP4 children that accepts the packet - -**/ -INTN -Ip4InterfaceEnquePacket ( - IN IP4_SERVICE *IpSb, - IN IP4_HEAD *Head, - IN NET_BUF *Packet, - IN UINT8 *Option, - IN UINT32 OptionLen, - IN IP4_INTERFACE *IpIf - ); - -/** - Deliver the received packets to upper layer if there are both received - requests and enqueued packets. If the enqueued packet is shared, it will - duplicate it to a non-shared packet, release the shared packet, then - deliver the non-shared packet up. - - @param[in] IpInstance The IP child to deliver the packet up. - - @retval EFI_OUT_OF_RESOURCES Failed to allocate resources to deliver the - packets. - @retval EFI_SUCCESS All the enqueued packets that can be delivered - are delivered up. - -**/ -EFI_STATUS -Ip4InstanceDeliverPacket ( - IN IP4_PROTOCOL *IpInstance - ); - -/** - Timeout the fragment and enqueued packets. - - @param[in] IpSb The IP4 service instance to timeout - -**/ -VOID -Ip4PacketTimerTicking ( - IN IP4_SERVICE *IpSb - ); - -/** - The work function to locate IPsec protocol to process the inbound or - outbound IP packets. The process routine handls the packet with following - actions: bypass the packet, discard the packet, or protect the packet. - - @param[in] IpSb The IP4 service instance. - @param[in, out] Head The The caller supplied IP4 header. - @param[in, out] Netbuf The IP4 packet to be processed by IPsec. - @param[in, out] Options The caller supplied options. - @param[in, out] OptionsLen The length of the option. - @param[in] Direction The directionality in an SPD entry, - EfiIPsecInBound or EfiIPsecOutBound. - @param[in] Context The token's wrap. - - @retval EFI_SUCCESS The IPsec protocol is not available or disabled. - @retval EFI_SUCCESS The packet was bypassed and all buffers remain the same. - @retval EFI_SUCCESS The packet was protected. - @retval EFI_ACCESS_DENIED The packet was discarded. - @retval EFI_OUT_OF_RESOURCES There is no suffcient resource to complete the operation. - @retval EFI_BUFFER_TOO_SMALL The number of non-empty block is bigger than the - number of input data blocks when build a fragment table. - -**/ -EFI_STATUS -Ip4IpSecProcessPacket ( - IN IP4_SERVICE *IpSb, - IN OUT IP4_HEAD **Head, - IN OUT NET_BUF **Netbuf, - IN OUT UINT8 **Options, - IN OUT UINT32 *OptionsLen, - IN EFI_IPSEC_TRAFFIC_DIR Direction, - IN VOID *Context - ); - -#endif diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4NvData.h b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4NvData.h deleted file mode 100644 index d161c1c8c5..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4NvData.h +++ /dev/null @@ -1,45 +0,0 @@ -/** @file - Routines used to operate the Ip4Dxe. - -Copyright (c) 2015, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef _IP4_NV_DATA_H_ -#define _IP4_NV_DATA_H_ - -#include - -#define FORMID_MAIN_FORM 1 -#define FORMID_DEVICE_FORM 2 - -#define KEY_ENABLE 0x100 -#define KEY_DHCP_ENABLE 0x101 -#define KEY_LOCAL_IP 0x102 -#define KEY_SUBNET_MASK 0x103 -#define KEY_GATE_WAY 0x104 -#define KEY_DNS 0x105 -#define KEY_SAVE_CHANGES 0x106 - -#define IP_MIN_SIZE 7 -#define IP_MAX_SIZE 15 -#define IP4_STR_MAX_SIZE 16 -#define ADDRESS_STR_MAX_SIZE 255 -#define MAX_IP4_CONFIG_DNS 16 - -/// -/// IP4_CONFIG2_IFR_NVDATA contains the IP4 configure -/// parameters for that NIC. -/// -typedef struct { - UINT8 Configure; ///< NIC configure status - UINT8 DhcpEnable; ///< Static or DHCP - CHAR16 StationAddress[IP4_STR_MAX_SIZE]; ///< IP addresses - CHAR16 SubnetMask[IP4_STR_MAX_SIZE]; ///< Subnet address - CHAR16 GatewayAddress[IP4_STR_MAX_SIZE]; ///< Gateway address - CHAR16 DnsAddress[ADDRESS_STR_MAX_SIZE]; ///< DNS server address -} IP4_CONFIG2_IFR_NVDATA; - -#endif - diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Option.c b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Option.c deleted file mode 100644 index f1c10014e8..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Option.c +++ /dev/null @@ -1,204 +0,0 @@ -/** @file - IP4 option support functions. - -Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Ip4Impl.h" - - -/** - Validate the IP4 option format for both the packets we received - and will transmit. - - @param[in] Option The first byte of the option - @param[in] OptionLen The length of the whole option - @param[in] Rcvd The option is from the packet we received if TRUE, - otherwise the option we wants to transmit. - - @retval TRUE The option is properly formatted - @retval FALSE The option is mal-formated - -**/ -BOOLEAN -Ip4OptionIsValid ( - IN UINT8 *Option, - IN UINT32 OptionLen, - IN BOOLEAN Rcvd - ) -{ - UINT32 Cur; - UINT32 Len; - UINT32 Point; - - Cur = 0; - - while (Cur < OptionLen) { - switch (Option[Cur]) { - case IP4_OPTION_NOP: - Cur++; - break; - - case IP4_OPTION_EOP: - Cur = OptionLen; - break; - - case IP4_OPTION_LSRR: - case IP4_OPTION_SSRR: - case IP4_OPTION_RR: - Len = Option[Cur + 1]; - Point = Option[Cur + 2]; - - // - // SRR/RR options are formatted as |Type|Len|Point|Ip1|Ip2|... - // - if ((OptionLen - Cur < Len) || (Len < 3) || ((Len - 3) % 4 != 0)) { - return FALSE; - } - - if ((Point > Len + 1) || (Point % 4 != 0)) { - return FALSE; - } - - // - // The Point must point pass the last entry if the packet is received - // by us. It must point to 4 if the packet is to be sent by us for - // source route option. - // - if ((Option[Cur] != IP4_OPTION_RR) && - ((Rcvd && (Point != Len + 1)) || (!Rcvd && (Point != 4)))) { - - return FALSE; - } - - Cur += Len; - break; - - default: - Len = Option[Cur + 1]; - - if ((OptionLen - Cur < Len) || (Len < 2)) { - return FALSE; - } - - Cur = Cur + Len; - break; - } - - } - - return TRUE; -} - - -/** - Copy the option from the original option to buffer. It - handles the details such as: - 1. whether copy the single IP4 option to the first/non-first - fragments. - 2. Pad the options copied over to aligned to 4 bytes. - - @param[in] Option The original option to copy from - @param[in] OptionLen The length of the original option - @param[in] FirstFragment Whether it is the first fragment - @param[in, out] Buf The buffer to copy options to. NULL - @param[in, out] BufLen The length of the buffer - - @retval EFI_SUCCESS The options are copied over - @retval EFI_BUFFER_TOO_SMALL Buf is NULL or BufLen provided is too small. - -**/ -EFI_STATUS -Ip4CopyOption ( - IN UINT8 *Option, - IN UINT32 OptionLen, - IN BOOLEAN FirstFragment, - IN OUT UINT8 *Buf, OPTIONAL - IN OUT UINT32 *BufLen - ) -{ - UINT8 OptBuf[40]; - UINT32 Cur; - UINT32 Next; - UINT8 Type; - UINT32 Len; - - ASSERT ((BufLen != NULL) && (OptionLen <= 40)); - - Cur = 0; - Next = 0; - - while (Cur < OptionLen) { - Type = Option[Cur]; - Len = Option[Cur + 1]; - - if (Type == IP4_OPTION_NOP) { - // - // Keep the padding, in case that the sender wants to align - // the option, say, to 4 bytes - // - OptBuf[Next] = IP4_OPTION_NOP; - Next++; - Cur++; - - } else if (Type == IP4_OPTION_EOP) { - // - // Don't append the EOP to avoid including only a EOP option - // - break; - - } else { - // - // don't copy options that is only valid for the first fragment - // - if (FirstFragment || (Type & IP4_OPTION_COPY_MASK) != 0) { - CopyMem (OptBuf + Next, Option + Cur, Len); - Next += Len; - } - - Cur += Len; - } - } - - // - // Don't append an EOP only option. - // - if (Next == 0) { - *BufLen = 0; - return EFI_SUCCESS; - } - - // - // Append an EOP if the end of option doesn't coincide with the - // end of the IP header, that is, isn't aligned to 4 bytes.. - // - if ((Next % 4) != 0) { - OptBuf[Next] = IP4_OPTION_EOP; - Next++; - } - - // - // Head length is in the unit of 4 bytes. Now, Len is the - // acutal option length to appear in the IP header. - // - Len = ((Next + 3) &~0x03); - - // - // If the buffer is too small, set the BufLen then return - // - if ((Buf == NULL) || (*BufLen < Len)) { - *BufLen = Len; - return EFI_BUFFER_TOO_SMALL; - } - - // - // Copy the option to the Buf, zero the buffer first to pad - // the options with NOP to align to 4 bytes. - // - ZeroMem (Buf, Len); - CopyMem (Buf, OptBuf, Next); - *BufLen = Len; - return EFI_SUCCESS; -} diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Option.h b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Option.h deleted file mode 100644 index 57a5a58725..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Option.h +++ /dev/null @@ -1,66 +0,0 @@ -/** @file - IP4 option support routines. - -Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef __EFI_IP4_OPTION_H__ -#define __EFI_IP4_OPTION_H__ - -#define IP4_OPTION_EOP 0 -#define IP4_OPTION_NOP 1 -#define IP4_OPTION_LSRR 131 // Loss source and record routing, 10000011 -#define IP4_OPTION_SSRR 137 // Strict source and record routing, 10001001 -#define IP4_OPTION_RR 7 // Record routing, 00000111 - -#define IP4_OPTION_COPY_MASK 0x80 - -/** - Validate the IP4 option format for both the packets we received - and will transmit. It will compute the ICMP error message fields - if the option is mal-formated. But this information isn't used. - - @param[in] Option The first byte of the option - @param[in] OptionLen The length of the whole option - @param[in] Rcvd The option is from the packet we received if TRUE, - otherwise the option we wants to transmit. - - @retval TRUE The option is properly formatted - @retval FALSE The option is mal-formated - -**/ -BOOLEAN -Ip4OptionIsValid ( - IN UINT8 *Option, - IN UINT32 OptionLen, - IN BOOLEAN Rcvd - ); - -/** - Copy the option from the original option to buffer. It - handles the details such as: - 1. whether copy the single IP4 option to the first/non-first - fragments. - 2. Pad the options copied over to aligned to 4 bytes. - - @param[in] Option The original option to copy from - @param[in] OptionLen The length of the original option - @param[in] FirstFragment Whether it is the first fragment - @param[in, out] Buf The buffer to copy options to. NULL - @param[in, out] BufLen The length of the buffer - - @retval EFI_SUCCESS The options are copied over - @retval EFI_BUFFER_TOO_SMALL Buf is NULL or BufLen provided is too small. - -**/ -EFI_STATUS -Ip4CopyOption ( - IN UINT8 *Option, - IN UINT32 OptionLen, - IN BOOLEAN FirstFragment, - IN OUT UINT8 *Buf, OPTIONAL - IN OUT UINT32 *BufLen - ); -#endif diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Output.c b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Output.c deleted file mode 100644 index 5eb3814089..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Output.c +++ /dev/null @@ -1,482 +0,0 @@ -/** @file - Transmit the IP4 packet. - -Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Ip4Impl.h" - -UINT16 mIp4Id; - - -/** - Prepend an IP4 head to the Packet. It will copy the options and - build the IP4 header fields. Used for IP4 fragmentation. - - @param Packet The packet to prepend IP4 header to - @param Head The caller supplied header. The caller should set - the following header fields: Tos, TotalLen, Id, - Fragment, Ttl, Protocol, Src and Dst. All the fields - are in host byte order. This function will fill in - the Ver, HeadLen, and checksum. - @param Option The orginal IP4 option to copy from - @param OptLen The length of the IP4 option - - @retval EFI_BAD_BUFFER_SIZE There is no enought room in the head space of - Packet. - @retval EFI_SUCCESS The IP4 header is successfully added to the packet. - -**/ -EFI_STATUS -Ip4PrependHead ( - IN OUT NET_BUF *Packet, - IN IP4_HEAD *Head, - IN UINT8 *Option, - IN UINT32 OptLen - ) -{ - UINT32 HeadLen; - UINT32 Len; - IP4_HEAD *PacketHead; - BOOLEAN FirstFragment; - - // - // Prepend the options: first get the option length, then copy it over. - // - HeadLen = 0; - FirstFragment = IP4_FIRST_FRAGMENT (Head->Fragment); - - Ip4CopyOption (Option, OptLen, FirstFragment, NULL, &Len); - - HeadLen = IP4_MIN_HEADLEN + Len; - ASSERT (((Len % 4) == 0) && (HeadLen <= IP4_MAX_HEADLEN)); - - PacketHead = (IP4_HEAD *) NetbufAllocSpace (Packet, HeadLen, NET_BUF_HEAD); - - if (PacketHead == NULL) { - return EFI_BAD_BUFFER_SIZE; - } - - Ip4CopyOption (Option, OptLen, FirstFragment, (UINT8 *) (PacketHead + 1), &Len); - - // - // Set the head up, convert the host byte order to network byte order - // - PacketHead->Ver = 4; - PacketHead->HeadLen = (UINT8) (HeadLen >> 2); - PacketHead->Tos = Head->Tos; - PacketHead->TotalLen = HTONS ((UINT16) Packet->TotalSize); - PacketHead->Id = HTONS (Head->Id); - PacketHead->Fragment = HTONS (Head->Fragment); - PacketHead->Checksum = 0; - PacketHead->Ttl = Head->Ttl; - PacketHead->Protocol = Head->Protocol; - PacketHead->Src = HTONL (Head->Src); - PacketHead->Dst = HTONL (Head->Dst); - PacketHead->Checksum = (UINT16) (~NetblockChecksum ((UINT8 *) PacketHead, HeadLen)); - - Packet->Ip.Ip4 = PacketHead; - return EFI_SUCCESS; -} - - -/** - Select an interface to send the packet generated in the IP4 driver - itself, that is, not by the requests of IP4 child's consumer. Such - packets include the ICMP echo replies, and other ICMP error packets. - - @param[in] IpSb The IP4 service that wants to send the packets. - @param[in] Dst The destination of the packet - @param[in] Src The source of the packet - - @return NULL if no proper interface is found, otherwise the interface that - can be used to send the system packet from. - -**/ -IP4_INTERFACE * -Ip4SelectInterface ( - IN IP4_SERVICE *IpSb, - IN IP4_ADDR Dst, - IN IP4_ADDR Src - ) -{ - IP4_INTERFACE *IpIf; - IP4_INTERFACE *Selected; - LIST_ENTRY *Entry; - - // - // Select the interface the Dst is on if one of the connected - // network. Some IP instance may be configured with 0.0.0.0/0, - // don't select that interface now. - // - IpIf = Ip4FindNet (IpSb, Dst); - - if ((IpIf != NULL) && (IpIf->Ip != IP4_ALLZERO_ADDRESS)) { - return IpIf; - } - - // - // If source is one of the interface address, select it. - // - IpIf = Ip4FindInterface (IpSb, Src); - - if ((IpIf != NULL) && (IpIf->Ip != IP4_ALLZERO_ADDRESS)) { - return IpIf; - } - - // - // Select a configured interface as the fall back. Always prefer - // an interface with non-zero address. - // - Selected = NULL; - - NET_LIST_FOR_EACH (Entry, &IpSb->Interfaces) { - IpIf = NET_LIST_USER_STRUCT (Entry, IP4_INTERFACE, Link); - - if (IpIf->Configured && ((Selected == NULL) || (Selected->Ip == 0))) { - Selected = IpIf; - } - } - - return Selected; -} - - -/** - The default callback function for system generated packet. - It will free the packet. - - @param Ip4Instance The IP4 child that issued the transmission. It most - like is NULL. - @param Packet The packet that transmitted. - @param IoStatus The result of the transmission, succeeded or failed. - @param LinkFlag Not used when transmission. check IP4_FRAME_CALLBACK - for reference. - @param Context The context provided by us - -**/ -VOID -Ip4SysPacketSent ( - IP4_PROTOCOL *Ip4Instance, - NET_BUF *Packet, - EFI_STATUS IoStatus, - UINT32 LinkFlag, - VOID *Context - ) -{ - NetbufFree (Packet); -} - - -/** - Transmit an IP4 packet. The packet comes either from the IP4 - child's consumer (IpInstance != NULL) or the IP4 driver itself - (IpInstance == NULL). It will route the packet, fragment it, - then transmit all the fragments through some interface. - - @param[in] IpSb The IP4 service instance to transmit the packet - @param[in] IpInstance The IP4 child that issues the transmission. It is - NULL if the packet is from the system. - @param[in] Packet The user data to send, excluding the IP header. - @param[in] Head The caller supplied header. The caller should set - the following header fields: Tos, TotalLen, Id, tl, - Fragment, Protocol, Src and Dst. All the fields are - in host byte order. This function will fill in the - Ver, HeadLen, Fragment, and checksum. The Fragment - only need to include the DF flag. Ip4Output will - compute the MF and offset for you. - @param[in] Option The original option to append to the IP headers - @param[in] OptLen The length of the option - @param[in] GateWay The next hop address to transmit packet to. - 255.255.255.255 means broadcast. - @param[in] Callback The callback function to issue when transmission - completed. - @param[in] Context The opaque context for the callback - - @retval EFI_NO_MAPPING There is no interface to the destination. - @retval EFI_NOT_FOUND There is no route to the destination - @retval EFI_SUCCESS The packet is successfully transmitted. - @retval EFI_BAD_BUFFER_SIZE The length of the IPv4 header + option length + - total data length is greater than MTU (or greater - than the maximum packet size if Token.Packet.TxData. - OverrideData.DoNotFragment is TRUE.) - @retval Others Failed to transmit the packet. - -**/ -EFI_STATUS -Ip4Output ( - IN IP4_SERVICE *IpSb, - IN IP4_PROTOCOL *IpInstance OPTIONAL, - IN NET_BUF *Packet, - IN IP4_HEAD *Head, - IN UINT8 *Option, - IN UINT32 OptLen, - IN IP4_ADDR GateWay, - IN IP4_FRAME_CALLBACK Callback, - IN VOID *Context - ) -{ - IP4_INTERFACE *IpIf; - IP4_ROUTE_CACHE_ENTRY *CacheEntry; - IP4_ADDR Dest; - EFI_STATUS Status; - NET_BUF *Fragment; - UINT32 Index; - UINT32 HeadLen; - UINT32 PacketLen; - UINT32 Offset; - UINT32 Mtu; - UINT32 Num; - BOOLEAN RawData; - - // - // Select an interface/source for system packet, application - // should select them itself. - // - if (IpInstance == NULL) { - IpIf = Ip4SelectInterface (IpSb, Head->Dst, Head->Src); - } else { - IpIf = IpInstance->Interface; - } - - if (IpIf == NULL) { - return EFI_NO_MAPPING; - } - - if ((Head->Src == IP4_ALLZERO_ADDRESS) && (IpInstance == NULL)) { - Head->Src = IpIf->Ip; - } - - // - // Before IPsec process, prepared the IP head. - // If Ip4Output is transmitting RawData, don't update IPv4 header. - // - HeadLen = sizeof (IP4_HEAD) + ((OptLen + 3) & (~0x03)); - - if ((IpInstance != NULL) && IpInstance->ConfigData.RawData) { - RawData = TRUE; - } else { - Head->HeadLen = (UINT8) (HeadLen >> 2); - Head->Id = mIp4Id++; - Head->Ver = 4; - RawData = FALSE; - } - - // - // Call IPsec process. - // - Status = Ip4IpSecProcessPacket ( - IpSb, - &Head, - &Packet, - &Option, - &OptLen, - EfiIPsecOutBound, - Context - ); - - if (EFI_ERROR(Status)) { - return Status; - } - - Dest = Head->Dst; - if (IP4_IS_BROADCAST (Ip4GetNetCast (Dest, IpIf)) || (Dest == IP4_ALLONE_ADDRESS)) { - // - // Set the gateway to local broadcast if the Dest is - // the broadcast address for the connected network or - // it is local broadcast. - // - GateWay = IP4_ALLONE_ADDRESS; - - } else if (IP4_IS_MULTICAST (Dest)) { - // - // Set the gateway to the destination if it is an multicast - // address. The IP4_INTERFACE won't consult ARP to send local - // broadcast and multicast. - // - GateWay = Head->Dst; - - } else if (GateWay == IP4_ALLZERO_ADDRESS) { - // - // Route the packet unless overrided, that is, GateWay isn't zero. - // - if (IpInstance == NULL) { - CacheEntry = Ip4Route (IpSb->DefaultRouteTable, Head->Dst, Head->Src, IpIf->SubnetMask, TRUE); - } else { - CacheEntry = Ip4Route (IpInstance->RouteTable, Head->Dst, Head->Src, IpIf->SubnetMask, FALSE); - // - // If failed to route the packet by using the instance's route table, - // try to use the default route table. - // - if (CacheEntry == NULL) { - CacheEntry = Ip4Route (IpSb->DefaultRouteTable, Head->Dst, Head->Src, IpIf->SubnetMask, TRUE); - } - } - - if (CacheEntry == NULL) { - return EFI_NOT_FOUND; - } - - GateWay = CacheEntry->NextHop; - Ip4FreeRouteCacheEntry (CacheEntry); - } - - // - // OK, selected the source and route, fragment the packet then send - // them. Tag each fragment other than the first one as spawn from it. - // - Mtu = IpSb->MaxPacketSize + sizeof (IP4_HEAD); - - if (Packet->TotalSize + HeadLen > Mtu) { - // - // Fragmentation is diabled for RawData mode. - // - if (RawData) { - return EFI_BAD_BUFFER_SIZE; - } - - // - // Packet is fragmented from the tail to the head, that is, the - // first frame sent is the last fragment of the packet. The first - // fragment is NOT sent in this loop. First compute how many - // fragments there are. - // - Mtu = (Mtu - HeadLen) & (~0x07); - Num = (Packet->TotalSize + Mtu - 1) / Mtu; - - // - // Initialize the packet length and Offset. Other than the last - // fragment, the packet length equals to MTU. The offset is always - // aligned to MTU. - // - PacketLen = Packet->TotalSize - (Num - 1) * Mtu; - Offset = Mtu * (Num - 1); - - for (Index = 0; Index < Num - 1; Index++, Offset -= Mtu) { - Fragment = NetbufGetFragment (Packet, Offset, PacketLen, IP4_MAX_HEADLEN); - - if (Fragment == NULL) { - Status = EFI_OUT_OF_RESOURCES; - goto ON_ERROR; - } - - // - // Update the header's fragment. The caller fills the IP4 header - // fields that are required by Ip4PrependHead except the fragment. - // - Head->Fragment = IP4_HEAD_FRAGMENT_FIELD (FALSE, (Index != 0), Offset); - Ip4PrependHead (Fragment, Head, Option, OptLen); - - // - // Transmit the fragments, pass the Packet address as the context. - // So, we can find all the fragments spawned from the Packet by - // compare the NetBuf and Context to the Packet. - // - Status = Ip4SendFrame ( - IpIf, - IpInstance, - Fragment, - GateWay, - Ip4SysPacketSent, - Packet, - IpSb - ); - - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - PacketLen = Mtu; - } - - // - // Trim the already sent data, then adjust the head's fragment field. - // - NetbufTrim (Packet, Packet->TotalSize - Mtu, FALSE); - Head->Fragment = IP4_HEAD_FRAGMENT_FIELD (FALSE, TRUE, 0); - } - - // - // Send the first fragment, it is either the orginal packet, or the - // first fragment of a fragmented packet. It seems that there is a subtle - // bug here: what if the caller free the packet in Callback and IpIf (or - // MNP child used by that interface) still holds the fragments and try - // to access the data? The caller can free the packet if it recycles the - // consumer's (such as UDP) data in the Callback. But this can't happen. - // The detailed sequence is: - // 1. for the packets generated by IP4 driver itself: - // The Callback is Ip4SysPacketSent, which is the same as the - // fragments' callback. Ip4SysPacketSent simply calls NetbufFree - // to release its reference to the packet. So, no problem for - // system packets. - // - // 2. for the upper layer's packets (use UDP as an example): - // UDP requests the IP layer to transmit some data which is - // wrapped in an asynchronous token, the token is wrapped - // in IP4_TXTOKEN_WRAP by IP4. IP4 also wrap the user's data - // in a net buffer, which is Packet we get here. IP4_TXTOKEN_WRAP - // is bound with the Packet. It will only be freed when all - // the references to Packet have been released. Upon then, the - // Packet's OnFree callback will release the IP4_TXTOKEN_WRAP, - // and singal the user's recycle event. So, also no problem for - // upper layer's packets. - // - Ip4PrependHead (Packet, Head, Option, OptLen); - Status = Ip4SendFrame (IpIf, IpInstance, Packet, GateWay, Callback, Context, IpSb); - - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - return EFI_SUCCESS; - -ON_ERROR: - Ip4CancelPacket (IpIf, Packet, Status); - return Status; -} - - -/** - The filter function to find a packet and all its fragments. - The packet's fragments have their Context set to the packet. - - @param[in] Frame The frames hold by the low level interface - @param[in] Context Context to the function, which is the packet. - - @retval TRUE This is the packet to cancel or its fragments. - @retval FALSE This is unrelated packet. - -**/ -BOOLEAN -Ip4CancelPacketFragments ( - IN IP4_LINK_TX_TOKEN *Frame, - IN VOID *Context - ) -{ - if ((Frame->Packet == (NET_BUF *) Context) || (Frame->Context == Context)) { - return TRUE; - } - - return FALSE; -} - - -/** - Cancel the Packet and all its fragments. - - @param IpIf The interface from which the Packet is sent - @param Packet The Packet to cancel - @param IoStatus The status returns to the sender. - -**/ -VOID -Ip4CancelPacket ( - IN IP4_INTERFACE *IpIf, - IN NET_BUF *Packet, - IN EFI_STATUS IoStatus - ) -{ - Ip4CancelFrames (IpIf, IoStatus, Ip4CancelPacketFragments, Packet); -} diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Output.h b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Output.h deleted file mode 100644 index ae54f8b485..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Output.h +++ /dev/null @@ -1,120 +0,0 @@ -/** @file - -Copyright (c) 2005 - 2006, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef __EFI_IP4_OUTPUT_H__ -#define __EFI_IP4_OUTPUT_H__ - -/** - The default callback function for system generated packet. - It will free the packet. - - @param Ip4Instance The IP4 child that issued the transmission. It most - like is NULL. - @param Packet The packet that transmitted. - @param IoStatus The result of the transmission, succeeded or failed. - @param LinkFlag Not used when transmission. check IP4_FRAME_CALLBACK - for reference. - @param Context The context provided by us - -**/ -VOID -Ip4SysPacketSent ( - IP4_PROTOCOL *Ip4Instance, - NET_BUF *Packet, - EFI_STATUS IoStatus, - UINT32 LinkFlag, - VOID *Context - ); - -/** - Transmit an IP4 packet. The packet comes either from the IP4 - child's consumer (IpInstance != NULL) or the IP4 driver itself - (IpInstance == NULL). It will route the packet, fragment it, - then transmit all the fragments through some interface. - - @param[in] IpSb The IP4 service instance to transmit the packet - @param[in] IpInstance The IP4 child that issues the transmission. It is - NULL if the packet is from the system. - @param[in] Packet The user data to send, excluding the IP header. - @param[in] Head The caller supplied header. The caller should set - the following header fields: Tos, TotalLen, Id, tl, - Fragment, Protocol, Src and Dst. All the fields are - in host byte order. This function will fill in the - Ver, HeadLen, Fragment, and checksum. The Fragment - only need to include the DF flag. Ip4Output will - compute the MF and offset for you. - @param[in] Option The original option to append to the IP headers - @param[in] OptLen The length of the option - @param[in] GateWay The next hop address to transmit packet to. - 255.255.255.255 means broadcast. - @param[in] Callback The callback function to issue when transmission - completed. - @param[in] Context The opaque context for the callback - - @retval EFI_NO_MAPPING There is no interface to the destination. - @retval EFI_NOT_FOUND There is no route to the destination - @retval EFI_SUCCESS The packet is successfully transmitted. - @retval Others Failed to transmit the packet. - -**/ -EFI_STATUS -Ip4Output ( - IN IP4_SERVICE *IpSb, - IN IP4_PROTOCOL *IpInstance OPTIONAL, - IN NET_BUF *Packet, - IN IP4_HEAD *Head, - IN UINT8 *Option, - IN UINT32 OptLen, - IN IP4_ADDR GateWay, - IN IP4_FRAME_CALLBACK Callback, - IN VOID *Context - ); - -/** - Cancel the Packet and all its fragments. - - @param IpIf The interface from which the Packet is sent - @param Packet The Packet to cancel - @param IoStatus The status returns to the sender. - -**/ -VOID -Ip4CancelPacket ( - IN IP4_INTERFACE *IpIf, - IN NET_BUF *Packet, - IN EFI_STATUS IoStatus - ); - -/** - Prepend an IP4 head to the Packet. It will copy the options and - build the IP4 header fields. Used for IP4 fragmentation. - - @param Packet The packet to prepend IP4 header to - @param Head The caller supplied header. The caller should set - the following header fields: Tos, TotalLen, Id, - Fragment, Ttl, Protocol, Src and Dst. All the fields - are in host byte order. This function will fill in - the Ver, HeadLen, and checksum. - @param Option The orginal IP4 option to copy from - @param OptLen The length of the IP4 option - - @retval EFI_BAD_BUFFER_SIZE There is no enought room in the head space of - Packet. - @retval EFI_SUCCESS The IP4 header is successfully added to the packet. - -**/ -EFI_STATUS -Ip4PrependHead ( - IN OUT NET_BUF *Packet, - IN IP4_HEAD *Head, - IN UINT8 *Option, - IN UINT32 OptLen - ); - -extern UINT16 mIp4Id; - -#endif diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Route.c b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Route.c deleted file mode 100644 index 124c0730ad..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Route.c +++ /dev/null @@ -1,673 +0,0 @@ -/** @file - -Copyright (c) 2005 - 2016, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Ip4Impl.h" - - -/** - Allocate a route entry then initialize it with the Dest/Netmaks - and Gateway. - - @param[in] Dest The destination network - @param[in] Netmask The destination network mask - @param[in] GateWay The nexthop address - - @return NULL if failed to allocate memeory, otherwise the newly created - route entry. - -**/ -IP4_ROUTE_ENTRY * -Ip4CreateRouteEntry ( - IN IP4_ADDR Dest, - IN IP4_ADDR Netmask, - IN IP4_ADDR GateWay - ) -{ - IP4_ROUTE_ENTRY *RtEntry; - - RtEntry = AllocatePool (sizeof (IP4_ROUTE_ENTRY)); - - if (RtEntry == NULL) { - return NULL; - } - - InitializeListHead (&RtEntry->Link); - - RtEntry->RefCnt = 1; - RtEntry->Dest = Dest; - RtEntry->Netmask = Netmask; - RtEntry->NextHop = GateWay; - RtEntry->Flag = 0; - - return RtEntry; -} - - -/** - Free the route table entry. It is reference counted. - - @param RtEntry The route entry to free. - -**/ -VOID -Ip4FreeRouteEntry ( - IN IP4_ROUTE_ENTRY *RtEntry - ) -{ - ASSERT (RtEntry->RefCnt > 0); - - if (--RtEntry->RefCnt == 0) { - FreePool (RtEntry); - } -} - - -/** - Allocate and initialize an IP4 route cache entry. - - @param[in] Dst The destination address - @param[in] Src The source address - @param[in] GateWay The next hop address - @param[in] Tag The tag from the caller. This marks all the cache - entries spawned from one route table entry. - - @return NULL if failed to allocate memory for the cache, other point - to the created route cache entry. - -**/ -IP4_ROUTE_CACHE_ENTRY * -Ip4CreateRouteCacheEntry ( - IN IP4_ADDR Dst, - IN IP4_ADDR Src, - IN IP4_ADDR GateWay, - IN UINTN Tag - ) -{ - IP4_ROUTE_CACHE_ENTRY *RtCacheEntry; - - RtCacheEntry = AllocatePool (sizeof (IP4_ROUTE_CACHE_ENTRY)); - - if (RtCacheEntry == NULL) { - return NULL; - } - - InitializeListHead (&RtCacheEntry->Link); - - RtCacheEntry->RefCnt = 1; - RtCacheEntry->Dest = Dst; - RtCacheEntry->Src = Src; - RtCacheEntry->NextHop = GateWay; - RtCacheEntry->Tag = Tag; - - return RtCacheEntry; -} - - -/** - Free the route cache entry. It is reference counted. - - @param RtCacheEntry The route cache entry to free. - -**/ -VOID -Ip4FreeRouteCacheEntry ( - IN IP4_ROUTE_CACHE_ENTRY *RtCacheEntry - ) -{ - ASSERT (RtCacheEntry->RefCnt > 0); - - if (--RtCacheEntry->RefCnt == 0) { - FreePool (RtCacheEntry); - } -} - - -/** - Initialize an empty route cache table. - - @param[in, out] RtCache The rotue cache table to initialize. - -**/ -VOID -Ip4InitRouteCache ( - IN OUT IP4_ROUTE_CACHE *RtCache - ) -{ - UINT32 Index; - - for (Index = 0; Index < IP4_ROUTE_CACHE_HASH_VALUE; Index++) { - InitializeListHead (&(RtCache->CacheBucket[Index])); - } -} - - -/** - Clean up a route cache, that is free all the route cache - entries enqueued in the cache. - - @param[in] RtCache The route cache table to clean up - -**/ -VOID -Ip4CleanRouteCache ( - IN IP4_ROUTE_CACHE *RtCache - ) -{ - LIST_ENTRY *Entry; - LIST_ENTRY *Next; - IP4_ROUTE_CACHE_ENTRY *RtCacheEntry; - UINT32 Index; - - for (Index = 0; Index < IP4_ROUTE_CACHE_HASH_VALUE; Index++) { - NET_LIST_FOR_EACH_SAFE (Entry, Next, &(RtCache->CacheBucket[Index])) { - RtCacheEntry = NET_LIST_USER_STRUCT (Entry, IP4_ROUTE_CACHE_ENTRY, Link); - - RemoveEntryList (Entry); - Ip4FreeRouteCacheEntry (RtCacheEntry); - } - } -} - - - -/** - Create an empty route table, includes its internal route cache - - @return NULL if failed to allocate memory for the route table, otherwise - the point to newly created route table. - -**/ -IP4_ROUTE_TABLE * -Ip4CreateRouteTable ( - VOID - ) -{ - IP4_ROUTE_TABLE *RtTable; - UINT32 Index; - - RtTable = AllocatePool (sizeof (IP4_ROUTE_TABLE)); - - if (RtTable == NULL) { - return NULL; - } - - RtTable->RefCnt = 1; - RtTable->TotalNum = 0; - - for (Index = 0; Index <= IP4_MASK_MAX; Index++) { - InitializeListHead (&(RtTable->RouteArea[Index])); - } - - RtTable->Next = NULL; - - Ip4InitRouteCache (&RtTable->Cache); - return RtTable; -} - - -/** - Free the route table and its associated route cache. Route - table is reference counted. - - @param[in] RtTable The route table to free. - -**/ -VOID -Ip4FreeRouteTable ( - IN IP4_ROUTE_TABLE *RtTable - ) -{ - LIST_ENTRY *Entry; - LIST_ENTRY *Next; - IP4_ROUTE_ENTRY *RtEntry; - UINT32 Index; - - ASSERT (RtTable->RefCnt > 0); - - if (--RtTable->RefCnt > 0) { - return ; - } - - // - // Free all the route table entry and its route cache. - // - for (Index = 0; Index <= IP4_MASK_MAX; Index++) { - NET_LIST_FOR_EACH_SAFE (Entry, Next, &(RtTable->RouteArea[Index])) { - RtEntry = NET_LIST_USER_STRUCT (Entry, IP4_ROUTE_ENTRY, Link); - - RemoveEntryList (Entry); - Ip4FreeRouteEntry (RtEntry); - } - } - - Ip4CleanRouteCache (&RtTable->Cache); - - FreePool (RtTable); -} - - - -/** - Remove all the cache entries bearing the Tag. When a route cache - entry is created, it is tagged with the address of route entry - from which it is spawned. When a route entry is deleted, the cache - entries spawned from it are also deleted. - - @param RtCache Route cache to remove the entries from - @param Tag The Tag of the entries to remove - -**/ -VOID -Ip4PurgeRouteCache ( - IN OUT IP4_ROUTE_CACHE *RtCache, - IN UINTN Tag - ) -{ - LIST_ENTRY *Entry; - LIST_ENTRY *Next; - IP4_ROUTE_CACHE_ENTRY *RtCacheEntry; - UINT32 Index; - - for (Index = 0; Index < IP4_ROUTE_CACHE_HASH_VALUE; Index++) { - NET_LIST_FOR_EACH_SAFE (Entry, Next, &RtCache->CacheBucket[Index]) { - - RtCacheEntry = NET_LIST_USER_STRUCT (Entry, IP4_ROUTE_CACHE_ENTRY, Link); - - if (RtCacheEntry->Tag == Tag) { - RemoveEntryList (Entry); - Ip4FreeRouteCacheEntry (RtCacheEntry); - } - } - } -} - - -/** - Add a route entry to the route table. All the IP4_ADDRs are in - host byte order. - - @param[in, out] RtTable Route table to add route to - @param[in] Dest The destination of the network - @param[in] Netmask The netmask of the destination - @param[in] Gateway The next hop address - - @retval EFI_ACCESS_DENIED The same route already exists - @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the entry - @retval EFI_SUCCESS The route is added successfully. - -**/ -EFI_STATUS -Ip4AddRoute ( - IN OUT IP4_ROUTE_TABLE *RtTable, - IN IP4_ADDR Dest, - IN IP4_ADDR Netmask, - IN IP4_ADDR Gateway - ) -{ - LIST_ENTRY *Head; - LIST_ENTRY *Entry; - IP4_ROUTE_ENTRY *RtEntry; - - // - // All the route entries with the same netmask length are - // linke to the same route area - // - Head = &(RtTable->RouteArea[NetGetMaskLength (Netmask)]); - - // - // First check whether the route exists - // - NET_LIST_FOR_EACH (Entry, Head) { - RtEntry = NET_LIST_USER_STRUCT (Entry, IP4_ROUTE_ENTRY, Link); - - if (IP4_NET_EQUAL (RtEntry->Dest, Dest, Netmask) && (RtEntry->NextHop == Gateway)) { - return EFI_ACCESS_DENIED; - } - } - - // - // Create a route entry and insert it to the route area. - // - RtEntry = Ip4CreateRouteEntry (Dest, Netmask, Gateway); - - if (RtEntry == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - if (Gateway == IP4_ALLZERO_ADDRESS) { - RtEntry->Flag = IP4_DIRECT_ROUTE; - } - - InsertHeadList (Head, &RtEntry->Link); - RtTable->TotalNum++; - - return EFI_SUCCESS; -} - - -/** - Remove a route entry and all the route caches spawn from it. - - @param RtTable The route table to remove the route from - @param Dest The destination network - @param Netmask The netmask of the Dest - @param Gateway The next hop address - - @retval EFI_SUCCESS The route entry is successfully removed - @retval EFI_NOT_FOUND There is no route entry in the table with that - properity. - -**/ -EFI_STATUS -Ip4DelRoute ( - IN OUT IP4_ROUTE_TABLE *RtTable, - IN IP4_ADDR Dest, - IN IP4_ADDR Netmask, - IN IP4_ADDR Gateway - ) -{ - LIST_ENTRY *Head; - LIST_ENTRY *Entry; - LIST_ENTRY *Next; - IP4_ROUTE_ENTRY *RtEntry; - - Head = &(RtTable->RouteArea[NetGetMaskLength (Netmask)]); - - NET_LIST_FOR_EACH_SAFE (Entry, Next, Head) { - RtEntry = NET_LIST_USER_STRUCT (Entry, IP4_ROUTE_ENTRY, Link); - - if (IP4_NET_EQUAL (RtEntry->Dest, Dest, Netmask) && (RtEntry->NextHop == Gateway)) { - Ip4PurgeRouteCache (&RtTable->Cache, (UINTN) RtEntry); - RemoveEntryList (Entry); - Ip4FreeRouteEntry (RtEntry); - - RtTable->TotalNum--; - return EFI_SUCCESS; - } - } - - return EFI_NOT_FOUND; -} - - -/** - Find a route cache with the dst and src. This is used by ICMP - redirect messasge process. All kinds of redirect is treated as - host redirect according to RFC1122. So, only route cache entries - are modified according to the ICMP redirect message. - - @param[in] RtTable The route table to search the cache for - @param[in] Dest The destination address - @param[in] Src The source address - - @return NULL if no route entry to the (Dest, Src). Otherwise the point - to the correct route cache entry. - -**/ -IP4_ROUTE_CACHE_ENTRY * -Ip4FindRouteCache ( - IN IP4_ROUTE_TABLE *RtTable, - IN IP4_ADDR Dest, - IN IP4_ADDR Src - ) -{ - LIST_ENTRY *Entry; - IP4_ROUTE_CACHE_ENTRY *RtCacheEntry; - UINT32 Index; - - Index = IP4_ROUTE_CACHE_HASH (Dest, Src); - - NET_LIST_FOR_EACH (Entry, &RtTable->Cache.CacheBucket[Index]) { - RtCacheEntry = NET_LIST_USER_STRUCT (Entry, IP4_ROUTE_CACHE_ENTRY, Link); - - if ((RtCacheEntry->Dest == Dest) && (RtCacheEntry->Src == Src)) { - NET_GET_REF (RtCacheEntry); - return RtCacheEntry; - } - } - - return NULL; -} - - -/** - Search the route table for a most specific match to the Dst. It searches - from the longest route area (mask length == 32) to the shortest route area - (default routes). In each route area, it will first search the instance's - route table, then the default route table. This is required by the following - requirements: - 1. IP search the route table for a most specific match - 2. The local route entries have precedence over the default route entry. - - @param[in] RtTable The route table to search from - @param[in] Dst The destionation address to search - - @return NULL if no route matches the Dst, otherwise the point to the - most specific route to the Dst. - -**/ -IP4_ROUTE_ENTRY * -Ip4FindRouteEntry ( - IN IP4_ROUTE_TABLE *RtTable, - IN IP4_ADDR Dst - ) -{ - LIST_ENTRY *Entry; - IP4_ROUTE_ENTRY *RtEntry; - IP4_ROUTE_TABLE *Table; - INTN Index; - - RtEntry = NULL; - - for (Index = IP4_MASK_MAX; Index >= 0; Index--) { - for (Table = RtTable; Table != NULL; Table = Table->Next) { - NET_LIST_FOR_EACH (Entry, &Table->RouteArea[Index]) { - RtEntry = NET_LIST_USER_STRUCT (Entry, IP4_ROUTE_ENTRY, Link); - - if (IP4_NET_EQUAL (RtEntry->Dest, Dst, RtEntry->Netmask)) { - NET_GET_REF (RtEntry); - return RtEntry; - } - } - } - } - - - return NULL; -} - - -/** - Search the route table to route the packet. Return/create a route - cache if there is a route to the destination. - - @param[in] RtTable The route table to search from - @param[in] Dest The destination address to search for - @param[in] Src The source address to search for - @param[in] SubnetMask The subnet mask of the Src address, this field is - used to check if the station is using /32 subnet. - @param[in] AlwaysTryDestAddr Always try to use the dest address as next hop even - though we can't find a matching route entry. This - field is only valid when using /32 subnet. - - @return NULL if failed to route packet, otherwise a route cache - entry that can be used to route packet. - -**/ -IP4_ROUTE_CACHE_ENTRY * -Ip4Route ( - IN IP4_ROUTE_TABLE *RtTable, - IN IP4_ADDR Dest, - IN IP4_ADDR Src, - IN IP4_ADDR SubnetMask, - IN BOOLEAN AlwaysTryDestAddr - ) -{ - LIST_ENTRY *Head; - LIST_ENTRY *Entry; - LIST_ENTRY *Next; - IP4_ROUTE_CACHE_ENTRY *RtCacheEntry; - IP4_ROUTE_CACHE_ENTRY *Cache; - IP4_ROUTE_ENTRY *RtEntry; - IP4_ADDR NextHop; - UINT32 Count; - - ASSERT (RtTable != NULL); - - Head = &RtTable->Cache.CacheBucket[IP4_ROUTE_CACHE_HASH (Dest, Src)]; - RtCacheEntry = Ip4FindRouteCache (RtTable, Dest, Src); - - // - // If found, promote the cache entry to the head of the hash bucket. LRU - // - if (RtCacheEntry != NULL) { - RemoveEntryList (&RtCacheEntry->Link); - InsertHeadList (Head, &RtCacheEntry->Link); - return RtCacheEntry; - } - - // - // Search the route table for the most specific route - // - RtEntry = Ip4FindRouteEntry (RtTable, Dest); - - if (RtEntry == NULL) { - if (SubnetMask != IP4_ALLONE_ADDRESS) { - return NULL; - } else if (!AlwaysTryDestAddr) { - return NULL; - } - } - - // - // Found a route to the Dest, if it is a direct route, the packet - // will be sent directly to the destination, such as for connected - // network. Otherwise, it is an indirect route, the packet will be - // sent to the next hop router. - // - // When using /32 subnet mask, the packet will always be sent to the direct - // destination first, if we can't find a matching route cache. - // - if (SubnetMask == IP4_ALLONE_ADDRESS || ((RtEntry->Flag & IP4_DIRECT_ROUTE) != 0)) { - NextHop = Dest; - } else { - NextHop = RtEntry->NextHop; - } - - if (RtEntry != NULL) { - Ip4FreeRouteEntry (RtEntry); - } - - // - // Create a route cache entry, and tag it as spawned from this route entry - // For /32 subnet mask, the default route in RtEntry will be used if failed - // to send the packet to driect destination address. - // - RtCacheEntry = Ip4CreateRouteCacheEntry (Dest, Src, NextHop, (UINTN) RtEntry); - - if (RtCacheEntry == NULL) { - return NULL; - } - - InsertHeadList (Head, &RtCacheEntry->Link); - NET_GET_REF (RtCacheEntry); - - // - // Each bucket of route cache can contain at most 64 entries. - // Remove the entries at the tail of the bucket. These entries - // are likely to be used least. - // - Count = 0; - NET_LIST_FOR_EACH_SAFE (Entry, Next, Head) { - if (++Count < IP4_ROUTE_CACHE_MAX) { - continue; - } - - Cache = NET_LIST_USER_STRUCT (Entry, IP4_ROUTE_CACHE_ENTRY, Link); - - RemoveEntryList (Entry); - Ip4FreeRouteCacheEntry (Cache); - } - - return RtCacheEntry; -} - - -/** - Build a EFI_IP4_ROUTE_TABLE to be returned to the caller of - GetModeData. The EFI_IP4_ROUTE_TABLE is clumsy to use in the - internal operation of the IP4 driver. - - @param[in] IpInstance The IP4 child that requests the route table. - - @retval EFI_SUCCESS The route table is successfully build - @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the rotue table. - -**/ -EFI_STATUS -Ip4BuildEfiRouteTable ( - IN IP4_PROTOCOL *IpInstance - ) -{ - LIST_ENTRY *Entry; - IP4_ROUTE_TABLE *RtTable; - IP4_ROUTE_ENTRY *RtEntry; - EFI_IP4_ROUTE_TABLE *Table; - UINT32 Count; - INT32 Index; - - RtTable = IpInstance->RouteTable; - - if (IpInstance->EfiRouteTable != NULL) { - FreePool (IpInstance->EfiRouteTable); - - IpInstance->EfiRouteTable = NULL; - IpInstance->EfiRouteCount = 0; - } - - Count = RtTable->TotalNum; - - if (RtTable->Next != NULL) { - Count += RtTable->Next->TotalNum; - } - - if (Count == 0) { - return EFI_SUCCESS; - } - - Table = AllocatePool (sizeof (EFI_IP4_ROUTE_TABLE) * Count); - - if (Table == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - // - // Copy the route entry to EFI route table. Keep the order of - // route entry copied from most specific to default route. That - // is, interlevel the route entry from the instance's route area - // and those from the default route table's route area. - // - Count = 0; - - for (Index = IP4_MASK_MAX; Index >= 0; Index--) { - for (RtTable = IpInstance->RouteTable; RtTable != NULL; RtTable = RtTable->Next) { - NET_LIST_FOR_EACH (Entry, &(RtTable->RouteArea[Index])) { - RtEntry = NET_LIST_USER_STRUCT (Entry, IP4_ROUTE_ENTRY, Link); - - EFI_IP4 (Table[Count].SubnetAddress) = HTONL (RtEntry->Dest & RtEntry->Netmask); - EFI_IP4 (Table[Count].SubnetMask) = HTONL (RtEntry->Netmask); - EFI_IP4 (Table[Count].GatewayAddress) = HTONL (RtEntry->NextHop); - - Count++; - } - } - } - - IpInstance->EfiRouteTable = Table; - IpInstance->EfiRouteCount = Count; - return EFI_SUCCESS; -} diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Route.h b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Route.h deleted file mode 100644 index 4b0b5282ab..0000000000 --- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Route.h +++ /dev/null @@ -1,225 +0,0 @@ -/** @file - EFI IP4 route table and route cache table defintions. - -Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef __EFI_IP4_ROUTE_H__ -#define __EFI_IP4_ROUTE_H__ - -#include "Ip4Common.h" - -#define IP4_DIRECT_ROUTE 0x00000001 - -#define IP4_ROUTE_CACHE_HASH_VALUE 31 -#define IP4_ROUTE_CACHE_MAX 64 // Max NO. of cache entry per hash bucket - -#define IP4_ROUTE_CACHE_HASH(Dst, Src) (((Dst) ^ (Src)) % IP4_ROUTE_CACHE_HASH_VALUE) - -/// -/// The route entry in the route table. Dest/Netmask is the destion -/// network. The nexthop is the gateway to send the packet to in -/// order to reach the Dest/Netmask. If the Flag has IP4_DIRECT_ROUTE -/// on, the gateway is the destination of the IP packet itself. Route -/// enties of the connected network have the flag on. -/// -typedef struct { - LIST_ENTRY Link; - INTN RefCnt; - IP4_ADDR Dest; - IP4_ADDR Netmask; - IP4_ADDR NextHop; - UINT32 Flag; -} IP4_ROUTE_ENTRY; - -/// -/// The route cache entry. The route cache entry is optional. -/// But it is necessary to support the ICMP redirect message. -/// Check Ip4ProcessIcmpRedirect for information. -/// -/// The cache entry field Tag is used to tag all the route -/// cache entry spawned from a route table entry. This makes -/// it simple to delete all the route cache entries from a -/// to-be-deleted route entry. -/// -typedef struct { - LIST_ENTRY Link; - INTN RefCnt; - IP4_ADDR Dest; - IP4_ADDR Src; - IP4_ADDR NextHop; - UINTN Tag; -} IP4_ROUTE_CACHE_ENTRY; - -/// -/// The route cache table is organized as a hash table. Each -/// IP4 route table has a embedded route cache. For now the -/// route cache and route table are binded togehter. But keep -/// the route cache a seperated structure in case we want to -/// detach them later. -/// -typedef struct { - LIST_ENTRY CacheBucket[IP4_ROUTE_CACHE_HASH_VALUE]; -} IP4_ROUTE_CACHE; - -/// -/// Each IP4 instance has its own route table. Each ServiceBinding -/// instance has a default route table and default address. -/// -/// All the route table entries with the same mask are linked -/// together in one route area. For example, RouteArea[0] contains -/// the default routes. A route table also contains a route cache. -/// -typedef struct _IP4_ROUTE_TABLE IP4_ROUTE_TABLE; - -struct _IP4_ROUTE_TABLE { - INTN RefCnt; - UINT32 TotalNum; - LIST_ENTRY RouteArea[IP4_MASK_NUM]; - IP4_ROUTE_TABLE *Next; - IP4_ROUTE_CACHE Cache; -}; - -/** - Create an empty route table, includes its internal route cache - - @return NULL if failed to allocate memory for the route table, otherwise - the point to newly created route table. - -**/ -IP4_ROUTE_TABLE * -Ip4CreateRouteTable ( - VOID - ); - -/** - Free the route table and its associated route cache. Route - table is reference counted. - - @param[in] RtTable The route table to free. - -**/ -VOID -Ip4FreeRouteTable ( - IN IP4_ROUTE_TABLE *RtTable - ); - -/** - Add a route entry to the route table. All the IP4_ADDRs are in - host byte order. - - @param[in, out] RtTable Route table to add route to - @param[in] Dest The destination of the network - @param[in] Netmask The netmask of the destination - @param[in] Gateway The next hop address - - @retval EFI_ACCESS_DENIED The same route already exists - @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the entry - @retval EFI_SUCCESS The route is added successfully. - -**/ -EFI_STATUS -Ip4AddRoute ( - IN OUT IP4_ROUTE_TABLE *RtTable, - IN IP4_ADDR Dest, - IN IP4_ADDR Netmask, - IN IP4_ADDR Gateway - ); - -/** - Remove a route entry and all the route caches spawn from it. - - @param RtTable The route table to remove the route from - @param Dest The destination network - @param Netmask The netmask of the Dest - @param Gateway The next hop address - - @retval EFI_SUCCESS The route entry is successfully removed - @retval EFI_NOT_FOUND There is no route entry in the table with that - properity. - -**/ -EFI_STATUS -Ip4DelRoute ( - IN OUT IP4_ROUTE_TABLE *RtTable, - IN IP4_ADDR Dest, - IN IP4_ADDR Netmask, - IN IP4_ADDR Gateway - ); - -/** - Find a route cache with the dst and src. This is used by ICMP - redirect messasge process. All kinds of redirect is treated as - host redirect according to RFC1122. So, only route cache entries - are modified according to the ICMP redirect message. - - @param[in] RtTable The route table to search the cache for - @param[in] Dest The destination address - @param[in] Src The source address - - @return NULL if no route entry to the (Dest, Src). Otherwise the point - to the correct route cache entry. - -**/ -IP4_ROUTE_CACHE_ENTRY * -Ip4FindRouteCache ( - IN IP4_ROUTE_TABLE *RtTable, - IN IP4_ADDR Dest, - IN IP4_ADDR Src - ); - -/** - Free the route cache entry. It is reference counted. - - @param RtCacheEntry The route cache entry to free. - -**/ -VOID -Ip4FreeRouteCacheEntry ( - IN IP4_ROUTE_CACHE_ENTRY *RtCacheEntry - ); - -/** - Search the route table to route the packet. Return/create a route - cache if there is a route to the destination. - - @param[in] RtTable The route table to search from - @param[in] Dest The destination address to search for - @param[in] Src The source address to search for - @param[in] SubnetMask The subnet mask of the Src address, this field is - used to check if the station is using /32 subnet. - @param[in] AlwaysTryDestAddr Always try to use the dest address as next hop even - though we can't find a matching route entry. This - field is only valid when using /32 subnet. - - @return NULL if failed to route packet, otherwise a route cache - entry that can be used to route packet. - -**/ -IP4_ROUTE_CACHE_ENTRY * -Ip4Route ( - IN IP4_ROUTE_TABLE *RtTable, - IN IP4_ADDR Dest, - IN IP4_ADDR Src, - IN IP4_ADDR SubnetMask, - IN BOOLEAN AlwaysTryDestAddr - ); - -/** - Build a EFI_IP4_ROUTE_TABLE to be returned to the caller of - GetModeData. The EFI_IP4_ROUTE_TABLE is clumsy to use in the - internal operation of the IP4 driver. - - @param[in] IpInstance The IP4 child that requests the route table. - - @retval EFI_SUCCESS The route table is successfully build - @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the rotue table. - -**/ -EFI_STATUS -Ip4BuildEfiRouteTable ( - IN IP4_PROTOCOL *IpInstance - ); -#endif diff --git a/MdeModulePkg/Universal/Network/MnpDxe/ComponentName.c b/MdeModulePkg/Universal/Network/MnpDxe/ComponentName.c deleted file mode 100644 index fe85c3bc23..0000000000 --- a/MdeModulePkg/Universal/Network/MnpDxe/ComponentName.c +++ /dev/null @@ -1,341 +0,0 @@ -/** @file - UEFI Component Name(2) protocol implementation for MnpDxe driver. - -Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "MnpImpl.h" - -// -// EFI Component Name Protocol -// -GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gMnpComponentName = { - MnpComponentNameGetDriverName, - MnpComponentNameGetControllerName, - "eng" -}; - -// -// EFI Component Name 2 Protocol -// -GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gMnpComponentName2 = { - (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) MnpComponentNameGetDriverName, - (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) MnpComponentNameGetControllerName, - "en" -}; - -GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mMnpDriverNameTable[] = { - { - "eng;en", - L"MNP Network Service Driver" - }, - { - NULL, - NULL - } -}; - -GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE *gMnpControllerNameTable = NULL; - -/** - Retrieves a Unicode string that is the user readable name of the driver. - - This function retrieves the user readable name of a driver in the form of a - Unicode string. If the driver specified by This has a user readable name in - the language specified by Language, then a pointer to the driver name is - returned in DriverName, and EFI_SUCCESS is returned. If the driver specified - by This does not support the language specified by Language, - then EFI_UNSUPPORTED is returned. - - @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param[in] Language A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified - in RFC 4646 or ISO 639-2 language code format. - - @param[out] DriverName A pointer to the Unicode string to return. - This Unicode string is the name of the - driver specified by This in the language - specified by Language. - - @retval EFI_SUCCESS The Unicode string for the Driver specified by - This and the language specified by Language was - returned in DriverName. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER DriverName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -MnpComponentNameGetDriverName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN CHAR8 *Language, - OUT CHAR16 **DriverName - ) -{ - return LookupUnicodeString2 ( - Language, - This->SupportedLanguages, - mMnpDriverNameTable, - DriverName, - (BOOLEAN) (This == &gMnpComponentName) - ); -} - -/** - Update the component name for the MNP child handle. - - @param Mnp[in] A pointer to the EFI_MANAGED_NETWORK_PROTOCOL. - - - @retval EFI_SUCCESS Update the ControllerNameTable of this instance successfully. - @retval EFI_INVALID_PARAMETER The input parameter is invalid. - -**/ -EFI_STATUS -UpdateName ( - IN EFI_MANAGED_NETWORK_PROTOCOL *Mnp - ) -{ - EFI_STATUS Status; - MNP_INSTANCE_DATA *Instance; - CHAR16 HandleName[80]; - EFI_MANAGED_NETWORK_CONFIG_DATA MnpConfigData; - EFI_SIMPLE_NETWORK_MODE SnpModeData; - UINTN OffSet; - UINTN Index; - - if (Mnp == NULL) { - return EFI_INVALID_PARAMETER; - } - - Instance = MNP_INSTANCE_DATA_FROM_THIS (Mnp); - // - // Format the child name into the string buffer as: - // MNP (MAC=FF-FF-FF-FF-FF-FF, ProtocolType=0x0800, VlanId=0) - // - Status = Mnp->GetModeData (Mnp, &MnpConfigData, &SnpModeData); - if (!EFI_ERROR (Status)) { - OffSet = 0; - // - // Print the MAC address. - // - OffSet += UnicodeSPrint ( - HandleName, - sizeof (HandleName), - L"MNP (MAC=" - ); - for (Index = 0; Index < SnpModeData.HwAddressSize; Index++) { - OffSet += UnicodeSPrint ( - HandleName + OffSet, - sizeof (HandleName) - OffSet * sizeof (CHAR16), - L"%02X-", - SnpModeData.CurrentAddress.Addr[Index] - ); - } - ASSERT (OffSet > 0); - // - // Remove the last '-' - // - OffSet--; - // - // Print the ProtocolType and VLAN ID for this instance. - // - OffSet += UnicodeSPrint ( - HandleName + OffSet, - sizeof (HandleName) - OffSet * sizeof (CHAR16), - L", ProtocolType=0x%X, VlanId=%d)", - MnpConfigData.ProtocolTypeFilter, - Instance->MnpServiceData->VlanId - ); - } else if (Status == EFI_NOT_STARTED) { - UnicodeSPrint ( - HandleName, - sizeof (HandleName), - L"MNP (Not started)" - ); - } else { - return Status; - } - - if (gMnpControllerNameTable != NULL) { - FreeUnicodeStringTable (gMnpControllerNameTable); - gMnpControllerNameTable = NULL; - } - - Status = AddUnicodeString2 ( - "eng", - gMnpComponentName.SupportedLanguages, - &gMnpControllerNameTable, - HandleName, - TRUE - ); - if (EFI_ERROR (Status)) { - return Status; - } - - return AddUnicodeString2 ( - "en", - gMnpComponentName2.SupportedLanguages, - &gMnpControllerNameTable, - HandleName, - FALSE - ); -} - -/** - Retrieves a Unicode string that is the user readable name of the controller - that is being managed by a driver. - - This function retrieves the user readable name of the controller specified by - ControllerHandle and ChildHandle in the form of a Unicode string. If the - driver specified by This has a user readable name in the language specified by - Language, then a pointer to the controller name is returned in ControllerName, - and EFI_SUCCESS is returned. If the driver specified by This is not currently - managing the controller specified by ControllerHandle and ChildHandle, - then EFI_UNSUPPORTED is returned. If the driver specified by This does not - support the language specified by Language, then EFI_UNSUPPORTED is returned. - Currently not implemented. - - @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param[in] ControllerHandle The handle of a controller that the driver - specified by This is managing. This handle - specifies the controller whose name is to be - returned. - - @param[in] ChildHandle The handle of the child controller to retrieve - the name of. This is an optional parameter that - may be NULL. It will be NULL for device - drivers. It will also be NULL for a bus drivers - that wish to retrieve the name of the bus - controller. It will not be NULL for a bus - driver that wishes to retrieve the name of a - child controller. - - @param[in] Language A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified in - RFC 4646 or ISO 639-2 language code format. - - @param[out] ControllerName A pointer to the Unicode string to return. - This Unicode string is the name of the - controller specified by ControllerHandle and - ChildHandle in the language specified by - Language from the point of view of the driver - specified by This. - - @retval EFI_SUCCESS The Unicode string for the user readable name - specified by This, ControllerHandle, ChildHandle, - and Language was returned in ControllerName. - - @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. - - @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid - EFI_HANDLE. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER ControllerName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This is not currently - managing the controller specified by - ControllerHandle and ChildHandle. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -MnpComponentNameGetControllerName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_HANDLE ChildHandle OPTIONAL, - IN CHAR8 *Language, - OUT CHAR16 **ControllerName - ) -{ - EFI_STATUS Status; - EFI_MANAGED_NETWORK_PROTOCOL *Mnp; - - // - // Only provide names for MNP child handles. - // - if (ChildHandle == NULL) { - return EFI_UNSUPPORTED; - } - - // - // Make sure this driver is currently managing ControllerHandle - // - Status = EfiTestManagedDevice ( - ControllerHandle, - gMnpDriverBinding.DriverBindingHandle, - &gEfiSimpleNetworkProtocolGuid - ); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Make sure this driver produced ChildHandle - // - Status = EfiTestChildHandle ( - ControllerHandle, - ChildHandle, - &gEfiManagedNetworkServiceBindingProtocolGuid - ); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Retrieve an instance of a produced protocol from ChildHandle - // - Status = gBS->OpenProtocol ( - ChildHandle, - &gEfiManagedNetworkProtocolGuid, - (VOID **)&Mnp, - NULL, - NULL, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Update the component name for this child handle. - // - Status = UpdateName (Mnp); - if (EFI_ERROR (Status)) { - return Status; - } - - return LookupUnicodeString2 ( - Language, - This->SupportedLanguages, - gMnpControllerNameTable, - ControllerName, - (BOOLEAN)(This == &gMnpComponentName) - ); -} diff --git a/MdeModulePkg/Universal/Network/MnpDxe/ComponentName.h b/MdeModulePkg/Universal/Network/MnpDxe/ComponentName.h deleted file mode 100644 index 201c6da11a..0000000000 --- a/MdeModulePkg/Universal/Network/MnpDxe/ComponentName.h +++ /dev/null @@ -1,144 +0,0 @@ -/** @file - The header file of UEFI Component Name(2) protocol. - -Copyright (c) 2004 - 2012, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef _COMPONENT_NAME_H_ -#define _COMPONENT_NAME_H_ - -#include -#include - -extern EFI_COMPONENT_NAME2_PROTOCOL gMnpComponentName2; -extern EFI_COMPONENT_NAME_PROTOCOL gMnpComponentName; -extern EFI_UNICODE_STRING_TABLE *gMnpControllerNameTable; - -/** - Retrieves a Unicode string that is the user readable name of the driver. - - This function retrieves the user readable name of a driver in the form of a - Unicode string. If the driver specified by This has a user readable name in - the language specified by Language, then a pointer to the driver name is - returned in DriverName, and EFI_SUCCESS is returned. If the driver specified - by This does not support the language specified by Language, - then EFI_UNSUPPORTED is returned. - - @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param[in] Language A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified - in RFC 4646 or ISO 639-2 language code format. - - @param[out] DriverName A pointer to the Unicode string to return. - This Unicode string is the name of the - driver specified by This in the language - specified by Language. - - @retval EFI_SUCCESS The Unicode string for the Driver specified by - This and the language specified by Language was - returned in DriverName. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER DriverName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -MnpComponentNameGetDriverName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN CHAR8 *Language, - OUT CHAR16 **DriverName - ); - -/** - Retrieves a Unicode string that is the user readable name of the controller - that is being managed by a driver. - - This function retrieves the user readable name of the controller specified by - ControllerHandle and ChildHandle in the form of a Unicode string. If the - driver specified by This has a user readable name in the language specified by - Language, then a pointer to the controller name is returned in ControllerName, - and EFI_SUCCESS is returned. If the driver specified by This is not currently - managing the controller specified by ControllerHandle and ChildHandle, - then EFI_UNSUPPORTED is returned. If the driver specified by This does not - support the language specified by Language, then EFI_UNSUPPORTED is returned. - Currently not implemented. - - @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param[in] ControllerHandle The handle of a controller that the driver - specified by This is managing. This handle - specifies the controller whose name is to be - returned. - - @param[in] ChildHandle The handle of the child controller to retrieve - the name of. This is an optional parameter that - may be NULL. It will be NULL for device - drivers. It will also be NULL for a bus drivers - that wish to retrieve the name of the bus - controller. It will not be NULL for a bus - driver that wishes to retrieve the name of a - child controller. - - @param[in] Language A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified in - RFC 4646 or ISO 639-2 language code format. - - @param[out] ControllerName A pointer to the Unicode string to return. - This Unicode string is the name of the - controller specified by ControllerHandle and - ChildHandle in the language specified by - Language from the point of view of the driver - specified by This. - - @retval EFI_SUCCESS The Unicode string for the user readable name - specified by This, ControllerHandle, ChildHandle, - and Language was returned in ControllerName. - - @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. - - @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid - EFI_HANDLE. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER ControllerName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This is not currently - managing the controller specified by - ControllerHandle and ChildHandle. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -MnpComponentNameGetControllerName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_HANDLE ChildHandle OPTIONAL, - IN CHAR8 *Language, - OUT CHAR16 **ControllerName - ); - -#endif diff --git a/MdeModulePkg/Universal/Network/MnpDxe/MnpConfig.c b/MdeModulePkg/Universal/Network/MnpDxe/MnpConfig.c deleted file mode 100644 index 5906ad546f..0000000000 --- a/MdeModulePkg/Universal/Network/MnpDxe/MnpConfig.c +++ /dev/null @@ -1,1939 +0,0 @@ -/** @file - Implementation of Managed Network Protocol private services. - -Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "MnpImpl.h" -#include "MnpVlan.h" - -EFI_SERVICE_BINDING_PROTOCOL mMnpServiceBindingProtocol = { - MnpServiceBindingCreateChild, - MnpServiceBindingDestroyChild -}; - -EFI_MANAGED_NETWORK_PROTOCOL mMnpProtocolTemplate = { - MnpGetModeData, - MnpConfigure, - MnpMcastIpToMac, - MnpGroups, - MnpTransmit, - MnpReceive, - MnpCancel, - MnpPoll -}; - -EFI_MANAGED_NETWORK_CONFIG_DATA mMnpDefaultConfigData = { - 10000000, - 10000000, - 0, - FALSE, - FALSE, - FALSE, - FALSE, - FALSE, - FALSE, - FALSE -}; - -/** - Add Count of net buffers to MnpDeviceData->FreeNbufQue. The length of the net - buffer is specified by MnpDeviceData->BufferLength. - - @param[in, out] MnpDeviceData Pointer to the MNP_DEVICE_DATA. - @param[in] Count Number of NET_BUFFERs to add. - - @retval EFI_SUCCESS The specified amount of NET_BUFs are allocated - and added to MnpDeviceData->FreeNbufQue. - @retval EFI_OUT_OF_RESOURCES Failed to allocate a NET_BUF structure. - -**/ -EFI_STATUS -MnpAddFreeNbuf ( - IN OUT MNP_DEVICE_DATA *MnpDeviceData, - IN UINTN Count - ) -{ - EFI_STATUS Status; - UINTN Index; - NET_BUF *Nbuf; - - NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); - ASSERT ((Count > 0) && (MnpDeviceData->BufferLength > 0)); - - Status = EFI_SUCCESS; - for (Index = 0; Index < Count; Index++) { - Nbuf = NetbufAlloc (MnpDeviceData->BufferLength + MnpDeviceData->PaddingSize); - if (Nbuf == NULL) { - DEBUG ((EFI_D_ERROR, "MnpAddFreeNbuf: NetBufAlloc failed.\n")); - - Status = EFI_OUT_OF_RESOURCES; - break; - } - - if (MnpDeviceData->PaddingSize > 0) { - // - // Pad padding bytes before the media header - // - NetbufAllocSpace (Nbuf, MnpDeviceData->PaddingSize, NET_BUF_TAIL); - NetbufTrim (Nbuf, MnpDeviceData->PaddingSize, NET_BUF_HEAD); - } - - NetbufQueAppend (&MnpDeviceData->FreeNbufQue, Nbuf); - } - - MnpDeviceData->NbufCnt += Index; - return Status; -} - - -/** - Allocate a free NET_BUF from MnpDeviceData->FreeNbufQue. If there is none - in the queue, first try to allocate some and add them into the queue, then - fetch the NET_BUF from the updated FreeNbufQue. - - @param[in, out] MnpDeviceData Pointer to the MNP_DEVICE_DATA. - - @return Pointer to the allocated free NET_BUF structure, if NULL the - operation is failed. - -**/ -NET_BUF * -MnpAllocNbuf ( - IN OUT MNP_DEVICE_DATA *MnpDeviceData - ) -{ - EFI_STATUS Status; - NET_BUF_QUEUE *FreeNbufQue; - NET_BUF *Nbuf; - EFI_TPL OldTpl; - - NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); - - FreeNbufQue = &MnpDeviceData->FreeNbufQue; - OldTpl = gBS->RaiseTPL (TPL_NOTIFY); - - // - // Check whether there are available buffers, or else try to add some. - // - if (FreeNbufQue->BufNum == 0) { - if ((MnpDeviceData->NbufCnt + MNP_NET_BUFFER_INCREASEMENT) > MNP_MAX_NET_BUFFER_NUM) { - DEBUG ( - (EFI_D_ERROR, - "MnpAllocNbuf: The maximum NET_BUF size is reached for MNP driver instance %p.\n", - MnpDeviceData) - ); - - Nbuf = NULL; - goto ON_EXIT; - } - - Status = MnpAddFreeNbuf (MnpDeviceData, MNP_NET_BUFFER_INCREASEMENT); - if (EFI_ERROR (Status)) { - DEBUG ( - (EFI_D_ERROR, - "MnpAllocNbuf: Failed to add NET_BUFs into the FreeNbufQue, %r.\n", - Status) - ); - - // - // Don't return NULL, perhaps MnpAddFreeNbuf does add some NET_BUFs but - // the amount is less than MNP_NET_BUFFER_INCREASEMENT. - // - } - } - - Nbuf = NetbufQueRemove (FreeNbufQue); - - // - // Increase the RefCnt. - // - if (Nbuf != NULL) { - NET_GET_REF (Nbuf); - } - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - - return Nbuf; -} - - -/** - Try to reclaim the Nbuf into the buffer pool. - - @param[in, out] MnpDeviceData Pointer to the mnp device context data. - @param[in, out] Nbuf Pointer to the NET_BUF to free. - -**/ -VOID -MnpFreeNbuf ( - IN OUT MNP_DEVICE_DATA *MnpDeviceData, - IN OUT NET_BUF *Nbuf - ) -{ - EFI_TPL OldTpl; - - NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); - ASSERT (Nbuf->RefCnt > 1); - - OldTpl = gBS->RaiseTPL (TPL_NOTIFY); - - NET_PUT_REF (Nbuf); - - if (Nbuf->RefCnt == 1) { - // - // Trim all buffer contained in the Nbuf, then append it to the NbufQue. - // - NetbufTrim (Nbuf, Nbuf->TotalSize, NET_BUF_TAIL); - - if (NetbufAllocSpace (Nbuf, NET_VLAN_TAG_LEN, NET_BUF_HEAD) != NULL) { - // - // There is space reserved for vlan tag in the head, reclaim it - // - NetbufTrim (Nbuf, NET_VLAN_TAG_LEN, NET_BUF_TAIL); - } - - NetbufQueAppend (&MnpDeviceData->FreeNbufQue, Nbuf); - } - - gBS->RestoreTPL (OldTpl); -} - -/** - Add Count of TX buffers to MnpDeviceData->AllTxBufList and MnpDeviceData->FreeTxBufList. - The length of the buffer is specified by MnpDeviceData->BufferLength. - - @param[in, out] MnpDeviceData Pointer to the MNP_DEVICE_DATA. - @param[in] Count Number of TX buffers to add. - - @retval EFI_SUCCESS The specified amount of TX buffers are allocated. - @retval EFI_OUT_OF_RESOURCES Failed to allocate a TX buffer. - -**/ -EFI_STATUS -MnpAddFreeTxBuf ( - IN OUT MNP_DEVICE_DATA *MnpDeviceData, - IN UINTN Count - ) -{ - EFI_STATUS Status; - UINT32 Index; - MNP_TX_BUF_WRAP *TxBufWrap; - - NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); - ASSERT ((Count > 0) && (MnpDeviceData->BufferLength > 0)); - - Status = EFI_SUCCESS; - for (Index = 0; Index < Count; Index++) { - TxBufWrap = (MNP_TX_BUF_WRAP*) AllocatePool (OFFSET_OF (MNP_TX_BUF_WRAP, TxBuf) + MnpDeviceData->BufferLength ); - if (TxBufWrap == NULL) { - DEBUG ((EFI_D_ERROR, "MnpAddFreeTxBuf: TxBuf Alloc failed.\n")); - - Status = EFI_OUT_OF_RESOURCES; - break; - } - DEBUG ((EFI_D_INFO, "MnpAddFreeTxBuf: Add TxBufWrap %p, TxBuf %p\n", TxBufWrap, TxBufWrap->TxBuf)); - TxBufWrap->Signature = MNP_TX_BUF_WRAP_SIGNATURE; - TxBufWrap->InUse = FALSE; - InsertTailList (&MnpDeviceData->FreeTxBufList, &TxBufWrap->WrapEntry); - InsertTailList (&MnpDeviceData->AllTxBufList, &TxBufWrap->AllEntry); - } - - MnpDeviceData->TxBufCount += Index; - return Status; -} - -/** - Allocate a free TX buffer from MnpDeviceData->FreeTxBufList. If there is none - in the queue, first try to recycle some from SNP, then try to allocate some and add - them into the queue, then fetch the NET_BUF from the updated FreeTxBufList. - - @param[in, out] MnpDeviceData Pointer to the MNP_DEVICE_DATA. - - @return Pointer to the allocated free NET_BUF structure, if NULL the - operation is failed. - -**/ -UINT8 * -MnpAllocTxBuf ( - IN OUT MNP_DEVICE_DATA *MnpDeviceData - ) -{ - EFI_TPL OldTpl; - UINT8 *TxBuf; - EFI_STATUS Status; - LIST_ENTRY *Entry; - MNP_TX_BUF_WRAP *TxBufWrap; - - NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - if (IsListEmpty (&MnpDeviceData->FreeTxBufList)) { - // - // First try to recycle some TX buffer from SNP - // - Status = MnpRecycleTxBuf (MnpDeviceData); - if (EFI_ERROR (Status)) { - TxBuf = NULL; - goto ON_EXIT; - } - - // - // If still no free TX buffer, allocate more. - // - if (IsListEmpty (&MnpDeviceData->FreeTxBufList)) { - if ((MnpDeviceData->TxBufCount + MNP_TX_BUFFER_INCREASEMENT) > MNP_MAX_TX_BUFFER_NUM) { - DEBUG ( - (EFI_D_ERROR, - "MnpAllocTxBuf: The maximum TxBuf size is reached for MNP driver instance %p.\n", - MnpDeviceData) - ); - - TxBuf = NULL; - goto ON_EXIT; - } - - Status = MnpAddFreeTxBuf (MnpDeviceData, MNP_TX_BUFFER_INCREASEMENT); - if (IsListEmpty (&MnpDeviceData->FreeTxBufList)) { - DEBUG ( - (EFI_D_ERROR, - "MnpAllocNbuf: Failed to add TxBuf into the FreeTxBufList, %r.\n", - Status) - ); - - TxBuf = NULL; - goto ON_EXIT; - } - } - } - - ASSERT (!IsListEmpty (&MnpDeviceData->FreeTxBufList)); - Entry = MnpDeviceData->FreeTxBufList.ForwardLink; - RemoveEntryList (MnpDeviceData->FreeTxBufList.ForwardLink); - TxBufWrap = NET_LIST_USER_STRUCT_S (Entry, MNP_TX_BUF_WRAP, WrapEntry, MNP_TX_BUF_WRAP_SIGNATURE); - TxBufWrap->InUse = TRUE; - TxBuf = TxBufWrap->TxBuf; - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - - return TxBuf; -} - -/** - Try to reclaim the TX buffer into the buffer pool. - - @param[in, out] MnpDeviceData Pointer to the mnp device context data. - @param[in, out] TxBuf Pointer to the TX buffer to free. - -**/ -VOID -MnpFreeTxBuf ( - IN OUT MNP_DEVICE_DATA *MnpDeviceData, - IN OUT UINT8 *TxBuf - ) -{ - MNP_TX_BUF_WRAP *TxBufWrap; - EFI_TPL OldTpl; - - NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); - - if (TxBuf == NULL) { - return; - } - - TxBufWrap = NET_LIST_USER_STRUCT (TxBuf, MNP_TX_BUF_WRAP, TxBuf); - if (TxBufWrap->Signature != MNP_TX_BUF_WRAP_SIGNATURE) { - DEBUG ( - (EFI_D_ERROR, - "MnpFreeTxBuf: Signature check failed in MnpFreeTxBuf.\n") - ); - return; - } - - if (!TxBufWrap->InUse) { - DEBUG ( - (EFI_D_WARN, - "MnpFreeTxBuf: Duplicated recycle report from SNP.\n") - ); - return; - } - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - InsertTailList (&MnpDeviceData->FreeTxBufList, &TxBufWrap->WrapEntry); - TxBufWrap->InUse = FALSE; - gBS->RestoreTPL (OldTpl); -} - -/** - Try to recycle all the transmitted buffer address from SNP. - - @param[in, out] MnpDeviceData Pointer to the mnp device context data. - - @retval EFI_SUCCESS Successed to recyclethe transmitted buffer address. - @retval Others Failed to recyclethe transmitted buffer address. - -**/ -EFI_STATUS -MnpRecycleTxBuf ( - IN OUT MNP_DEVICE_DATA *MnpDeviceData - ) -{ - UINT8 *TxBuf; - EFI_SIMPLE_NETWORK_PROTOCOL *Snp; - EFI_STATUS Status; - - Snp = MnpDeviceData->Snp; - ASSERT (Snp != NULL); - - do { - TxBuf = NULL; - Status = Snp->GetStatus (Snp, NULL, (VOID **) &TxBuf); - if (EFI_ERROR (Status)) { - return Status; - } - - if (TxBuf != NULL) { - MnpFreeTxBuf (MnpDeviceData, TxBuf); - } - } while (TxBuf != NULL); - - return EFI_SUCCESS; -} - -/** - Initialize the mnp device context data. - - @param[in, out] MnpDeviceData Pointer to the mnp device context data. - @param[in] ImageHandle The driver image handle. - @param[in] ControllerHandle Handle of device to bind driver to. - - @retval EFI_SUCCESS The mnp service context is initialized. - @retval EFI_UNSUPPORTED ControllerHandle does not support Simple Network Protocol. - @retval Others Other errors as indicated. - -**/ -EFI_STATUS -MnpInitializeDeviceData ( - IN OUT MNP_DEVICE_DATA *MnpDeviceData, - IN EFI_HANDLE ImageHandle, - IN EFI_HANDLE ControllerHandle - ) -{ - EFI_STATUS Status; - EFI_SIMPLE_NETWORK_PROTOCOL *Snp; - EFI_SIMPLE_NETWORK_MODE *SnpMode; - - MnpDeviceData->Signature = MNP_DEVICE_DATA_SIGNATURE; - MnpDeviceData->ImageHandle = ImageHandle; - MnpDeviceData->ControllerHandle = ControllerHandle; - - // - // Copy the MNP Protocol interfaces from the template. - // - CopyMem (&MnpDeviceData->VlanConfig, &mVlanConfigProtocolTemplate, sizeof (EFI_VLAN_CONFIG_PROTOCOL)); - - // - // Open the Simple Network protocol. - // - Status = gBS->OpenProtocol ( - ControllerHandle, - &gEfiSimpleNetworkProtocolGuid, - (VOID **) &Snp, - ImageHandle, - ControllerHandle, - EFI_OPEN_PROTOCOL_BY_DRIVER - ); - if (EFI_ERROR (Status)) { - return EFI_UNSUPPORTED; - } - - // - // Get MTU from Snp. - // - SnpMode = Snp->Mode; - MnpDeviceData->Snp = Snp; - - // - // Initialize the lists. - // - InitializeListHead (&MnpDeviceData->ServiceList); - InitializeListHead (&MnpDeviceData->GroupAddressList); - - // - // Get the buffer length used to allocate NET_BUF to hold data received - // from SNP. Do this before fill the FreeNetBufQue. - // - // - MnpDeviceData->BufferLength = SnpMode->MediaHeaderSize + NET_VLAN_TAG_LEN + SnpMode->MaxPacketSize + NET_ETHER_FCS_SIZE; - - // - // Make sure the protocol headers immediately following the media header - // 4-byte aligned, and also preserve additional space for VLAN tag - // - MnpDeviceData->PaddingSize = ((4 - SnpMode->MediaHeaderSize) & 0x3) + NET_VLAN_TAG_LEN; - - // - // Initialize MAC string which will be used as VLAN configuration variable name - // - Status = NetLibGetMacString (ControllerHandle, ImageHandle, &MnpDeviceData->MacString); - if (EFI_ERROR (Status)) { - goto ERROR; - } - - // - // Initialize the FreeNetBufQue and pre-allocate some NET_BUFs. - // - NetbufQueInit (&MnpDeviceData->FreeNbufQue); - Status = MnpAddFreeNbuf (MnpDeviceData, MNP_INIT_NET_BUFFER_NUM); - if (EFI_ERROR (Status)) { - DEBUG ((EFI_D_ERROR, "MnpInitializeDeviceData: MnpAddFreeNbuf failed, %r.\n", Status)); - - goto ERROR; - } - - // - // Get one NET_BUF from the FreeNbufQue for rx cache. - // - MnpDeviceData->RxNbufCache = MnpAllocNbuf (MnpDeviceData); - NetbufAllocSpace ( - MnpDeviceData->RxNbufCache, - MnpDeviceData->BufferLength, - NET_BUF_TAIL - ); - - // - // Allocate buffer pool for tx. - // - InitializeListHead (&MnpDeviceData->FreeTxBufList); - InitializeListHead (&MnpDeviceData->AllTxBufList); - MnpDeviceData->TxBufCount = 0; - - // - // Create the system poll timer. - // - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL | EVT_TIMER, - TPL_CALLBACK, - MnpSystemPoll, - MnpDeviceData, - &MnpDeviceData->PollTimer - ); - if (EFI_ERROR (Status)) { - DEBUG ((EFI_D_ERROR, "MnpInitializeDeviceData: CreateEvent for poll timer failed.\n")); - - goto ERROR; - } - - // - // Create the timer for packet timeout check. - // - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL | EVT_TIMER, - TPL_CALLBACK, - MnpCheckPacketTimeout, - MnpDeviceData, - &MnpDeviceData->TimeoutCheckTimer - ); - if (EFI_ERROR (Status)) { - DEBUG ((EFI_D_ERROR, "MnpInitializeDeviceData: CreateEvent for packet timeout check failed.\n")); - - goto ERROR; - } - - // - // Create the timer for media detection. - // - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL | EVT_TIMER, - TPL_CALLBACK, - MnpCheckMediaStatus, - MnpDeviceData, - &MnpDeviceData->MediaDetectTimer - ); - if (EFI_ERROR (Status)) { - DEBUG ((EFI_D_ERROR, "MnpInitializeDeviceData: CreateEvent for media detection failed.\n")); - - goto ERROR; - } - -ERROR: - if (EFI_ERROR (Status)) { - // - // Free the dynamic allocated resources if necessary. - // - if (MnpDeviceData->MacString != NULL) { - FreePool (MnpDeviceData->MacString); - } - - if (MnpDeviceData->TimeoutCheckTimer != NULL) { - gBS->CloseEvent (MnpDeviceData->TimeoutCheckTimer); - } - - if (MnpDeviceData->MediaDetectTimer != NULL) { - gBS->CloseEvent (MnpDeviceData->MediaDetectTimer); - } - - if (MnpDeviceData->PollTimer != NULL) { - gBS->CloseEvent (MnpDeviceData->PollTimer); - } - - if (MnpDeviceData->RxNbufCache != NULL) { - MnpFreeNbuf (MnpDeviceData, MnpDeviceData->RxNbufCache); - } - - if (MnpDeviceData->FreeNbufQue.BufNum != 0) { - NetbufQueFlush (&MnpDeviceData->FreeNbufQue); - } - - // - // Close the Simple Network Protocol. - // - gBS->CloseProtocol ( - ControllerHandle, - &gEfiSimpleNetworkProtocolGuid, - ImageHandle, - ControllerHandle - ); - } - - return Status; -} - - -/** - Destroy the MNP device context data. - - @param[in, out] MnpDeviceData Pointer to the mnp device context data. - @param[in] ImageHandle The driver image handle. - -**/ -VOID -MnpDestroyDeviceData ( - IN OUT MNP_DEVICE_DATA *MnpDeviceData, - IN EFI_HANDLE ImageHandle - ) -{ - LIST_ENTRY *Entry; - LIST_ENTRY *NextEntry; - MNP_TX_BUF_WRAP *TxBufWrap; - - NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); - - // - // Free Vlan Config variable name string - // - if (MnpDeviceData->MacString != NULL) { - FreePool (MnpDeviceData->MacString); - } - - // - // The GroupAddressList must be empty. - // - ASSERT (IsListEmpty (&MnpDeviceData->GroupAddressList)); - - // - // Close the event. - // - gBS->CloseEvent (MnpDeviceData->TimeoutCheckTimer); - gBS->CloseEvent (MnpDeviceData->MediaDetectTimer); - gBS->CloseEvent (MnpDeviceData->PollTimer); - - // - // Free the Tx buffer pool. - // - NET_LIST_FOR_EACH_SAFE(Entry, NextEntry, &MnpDeviceData->AllTxBufList) { - TxBufWrap = NET_LIST_USER_STRUCT (Entry, MNP_TX_BUF_WRAP, AllEntry); - RemoveEntryList (Entry); - FreePool (TxBufWrap); - MnpDeviceData->TxBufCount--; - } - ASSERT (IsListEmpty (&MnpDeviceData->AllTxBufList)); - ASSERT (MnpDeviceData->TxBufCount == 0); - - // - // Free the RxNbufCache. - // - MnpFreeNbuf (MnpDeviceData, MnpDeviceData->RxNbufCache); - - // - // Flush the FreeNbufQue. - // - MnpDeviceData->NbufCnt -= MnpDeviceData->FreeNbufQue.BufNum; - NetbufQueFlush (&MnpDeviceData->FreeNbufQue); - - // - // Close the Simple Network Protocol. - // - gBS->CloseProtocol ( - MnpDeviceData->ControllerHandle, - &gEfiSimpleNetworkProtocolGuid, - ImageHandle, - MnpDeviceData->ControllerHandle - ); -} - - -/** - Create mnp service context data. - - @param[in] MnpDeviceData Pointer to the mnp device context data. - @param[in] VlanId The VLAN ID. - @param[in] Priority The VLAN priority. If VlanId is 0, - Priority is ignored. - - @return A pointer to MNP_SERVICE_DATA or NULL if failed to create MNP service context. - -**/ -MNP_SERVICE_DATA * -MnpCreateServiceData ( - IN MNP_DEVICE_DATA *MnpDeviceData, - IN UINT16 VlanId, - IN UINT8 Priority OPTIONAL - ) -{ - EFI_HANDLE MnpServiceHandle; - MNP_SERVICE_DATA *MnpServiceData; - EFI_STATUS Status; - EFI_SIMPLE_NETWORK_MODE *SnpMode; - EFI_VLAN_CONFIG_PROTOCOL *VlanConfig; - - // - // Initialize the Mnp Service Data. - // - MnpServiceData = AllocateZeroPool (sizeof (MNP_SERVICE_DATA)); - if (MnpServiceData == NULL) { - DEBUG ((EFI_D_ERROR, "MnpCreateServiceData: Faild to allocate memory for the new Mnp Service Data.\n")); - - return NULL; - } - - // - // Add to MNP service list - // - InsertTailList (&MnpDeviceData->ServiceList, &MnpServiceData->Link); - - MnpServiceData->Signature = MNP_SERVICE_DATA_SIGNATURE; - MnpServiceData->MnpDeviceData = MnpDeviceData; - - // - // Copy the ServiceBinding structure. - // - CopyMem (&MnpServiceData->ServiceBinding, &mMnpServiceBindingProtocol, sizeof (EFI_SERVICE_BINDING_PROTOCOL)); - - // - // Initialize the lists. - // - InitializeListHead (&MnpServiceData->ChildrenList); - - SnpMode = MnpDeviceData->Snp->Mode; - if (VlanId != 0) { - // - // Create VLAN child handle - // - MnpServiceHandle = MnpCreateVlanChild ( - MnpDeviceData->ImageHandle, - MnpDeviceData->ControllerHandle, - VlanId, - &MnpServiceData->DevicePath - ); - if (MnpServiceHandle == NULL) { - DEBUG ((EFI_D_ERROR, "MnpCreateServiceData: Faild to create child handle.\n")); - - return NULL; - } - - // - // Open VLAN Config Protocol by child - // - Status = gBS->OpenProtocol ( - MnpDeviceData->ControllerHandle, - &gEfiVlanConfigProtocolGuid, - (VOID **) &VlanConfig, - MnpDeviceData->ImageHandle, - MnpServiceHandle, - EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER - ); - if (EFI_ERROR (Status)) { - goto Exit; - } - - // - // Reduce MTU for VLAN device - // - MnpServiceData->Mtu = SnpMode->MaxPacketSize - NET_VLAN_TAG_LEN; - } else { - // - // VlanId set to 0 means rx/tx untagged frame - // - MnpServiceHandle = MnpDeviceData->ControllerHandle; - MnpServiceData->Mtu = SnpMode->MaxPacketSize; - } - - MnpServiceData->ServiceHandle = MnpServiceHandle; - MnpServiceData->VlanId = VlanId; - MnpServiceData->Priority = Priority; - - // - // Install the MNP Service Binding Protocol - // - Status = gBS->InstallMultipleProtocolInterfaces ( - &MnpServiceHandle, - &gEfiManagedNetworkServiceBindingProtocolGuid, - &MnpServiceData->ServiceBinding, - NULL - ); - -Exit: - if (EFI_ERROR (Status)) { - MnpDestroyServiceData (MnpServiceData); - MnpServiceData = NULL; - } - - return MnpServiceData; -} - -/** - Destroy the MNP service context data. - - @param[in, out] MnpServiceData Pointer to the mnp service context data. - - @retval EFI_SUCCESS The mnp service context is destroyed. - @retval Others Errors as indicated. - -**/ -EFI_STATUS -MnpDestroyServiceData ( - IN OUT MNP_SERVICE_DATA *MnpServiceData - ) -{ - EFI_STATUS Status; - - // - // Uninstall the MNP Service Binding Protocol - // - Status = gBS->UninstallMultipleProtocolInterfaces ( - MnpServiceData->ServiceHandle, - &gEfiManagedNetworkServiceBindingProtocolGuid, - &MnpServiceData->ServiceBinding, - NULL - ); - if (EFI_ERROR (Status)) { - return Status; - } - - if (MnpServiceData->VlanId != 0) { - // - // Close VlanConfig Protocol opened by VLAN child handle - // - Status = gBS->CloseProtocol ( - MnpServiceData->MnpDeviceData->ControllerHandle, - &gEfiVlanConfigProtocolGuid, - MnpServiceData->MnpDeviceData->ImageHandle, - MnpServiceData->ServiceHandle - ); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Uninstall Device Path Protocol to destroy the VLAN child handle - // - Status = gBS->UninstallMultipleProtocolInterfaces ( - MnpServiceData->ServiceHandle, - &gEfiDevicePathProtocolGuid, - MnpServiceData->DevicePath, - NULL - ); - if (EFI_ERROR (Status)) { - return Status; - } - - if (MnpServiceData->DevicePath != NULL) { - FreePool (MnpServiceData->DevicePath); - } - } - - // - // Remove from MnpDeviceData service list - // - RemoveEntryList (&MnpServiceData->Link); - - FreePool (MnpServiceData); - - return Status; -} - -/** - Callback function which provided by user to remove one node in NetDestroyLinkList process. - - @param[in] Entry The entry to be removed. - @param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList. - - @retval EFI_SUCCESS The entry has been removed successfully. - @retval Others Fail to remove the entry. - -**/ -EFI_STATUS -EFIAPI -MnpDestoryChildEntry ( - IN LIST_ENTRY *Entry, - IN VOID *Context - ) -{ - MNP_INSTANCE_DATA *Instance; - EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; - - ServiceBinding = (EFI_SERVICE_BINDING_PROTOCOL *) Context; - Instance = CR (Entry, MNP_INSTANCE_DATA, InstEntry, MNP_INSTANCE_DATA_SIGNATURE); - return ServiceBinding->DestroyChild (ServiceBinding, Instance->Handle); -} - -/** - Destroy all child of the MNP service data. - - @param[in, out] MnpServiceData Pointer to the mnp service context data. - - @retval EFI_SUCCESS All child are destroyed. - @retval Others Failed to destroy all child. - -**/ -EFI_STATUS -MnpDestroyServiceChild ( - IN OUT MNP_SERVICE_DATA *MnpServiceData - ) -{ - LIST_ENTRY *List; - EFI_STATUS Status; - UINTN ListLength; - - List = &MnpServiceData->ChildrenList; - - Status = NetDestroyLinkList ( - List, - MnpDestoryChildEntry, - &MnpServiceData->ServiceBinding, - &ListLength - ); - if (EFI_ERROR (Status) || ListLength != 0) { - return EFI_DEVICE_ERROR; - } - - return EFI_SUCCESS; -} - -/** - Find the MNP Service Data for given VLAN ID. - - @param[in] MnpDeviceData Pointer to the mnp device context data. - @param[in] VlanId The VLAN ID. - - @return A pointer to MNP_SERVICE_DATA or NULL if not found. - -**/ -MNP_SERVICE_DATA * -MnpFindServiceData ( - IN MNP_DEVICE_DATA *MnpDeviceData, - IN UINT16 VlanId - ) -{ - LIST_ENTRY *Entry; - MNP_SERVICE_DATA *MnpServiceData; - - NET_LIST_FOR_EACH (Entry, &MnpDeviceData->ServiceList) { - // - // Check VLAN ID of each Mnp Service Data - // - MnpServiceData = MNP_SERVICE_DATA_FROM_LINK (Entry); - if (MnpServiceData->VlanId == VlanId) { - return MnpServiceData; - } - } - - return NULL; -} - -/** - Initialize the mnp instance context data. - - @param[in] MnpServiceData Pointer to the mnp service context data. - @param[in, out] Instance Pointer to the mnp instance context data - to initialize. - -**/ -VOID -MnpInitializeInstanceData ( - IN MNP_SERVICE_DATA *MnpServiceData, - IN OUT MNP_INSTANCE_DATA *Instance - ) -{ - NET_CHECK_SIGNATURE (MnpServiceData, MNP_SERVICE_DATA_SIGNATURE); - ASSERT (Instance != NULL); - - // - // Set the signature. - // - Instance->Signature = MNP_INSTANCE_DATA_SIGNATURE; - - // - // Copy the MNP Protocol interfaces from the template. - // - CopyMem (&Instance->ManagedNetwork, &mMnpProtocolTemplate, sizeof (Instance->ManagedNetwork)); - - // - // Copy the default config data. - // - CopyMem (&Instance->ConfigData, &mMnpDefaultConfigData, sizeof (Instance->ConfigData)); - - // - // Initialize the lists. - // - InitializeListHead (&Instance->GroupCtrlBlkList); - InitializeListHead (&Instance->RcvdPacketQueue); - InitializeListHead (&Instance->RxDeliveredPacketQueue); - - // - // Initialize the RxToken Map. - // - NetMapInit (&Instance->RxTokenMap); - - // - // Save the MnpServiceData info. - // - Instance->MnpServiceData = MnpServiceData; -} - - -/** - Check whether the token specified by Arg matches the token in Item. - - @param[in] Map Pointer to the NET_MAP. - @param[in] Item Pointer to the NET_MAP_ITEM. - @param[in] Arg Pointer to the Arg, it's a pointer to the token to - check. - - @retval EFI_SUCCESS The token specified by Arg is different from the - token in Item. - @retval EFI_ACCESS_DENIED The token specified by Arg is the same as that in - Item. - -**/ -EFI_STATUS -EFIAPI -MnpTokenExist ( - IN NET_MAP *Map, - IN NET_MAP_ITEM *Item, - IN VOID *Arg - ) -{ - EFI_MANAGED_NETWORK_COMPLETION_TOKEN *Token; - EFI_MANAGED_NETWORK_COMPLETION_TOKEN *TokenInItem; - - Token = (EFI_MANAGED_NETWORK_COMPLETION_TOKEN *) Arg; - TokenInItem = (EFI_MANAGED_NETWORK_COMPLETION_TOKEN *) Item->Key; - - if ((Token == TokenInItem) || (Token->Event == TokenInItem->Event)) { - // - // The token is the same either the two tokens equals or the Events in - // the two tokens are the same. - // - return EFI_ACCESS_DENIED; - } - - return EFI_SUCCESS; -} - -/** - Cancel the token specified by Arg if it matches the token in Item. - - @param[in, out] Map Pointer to the NET_MAP. - @param[in, out] Item Pointer to the NET_MAP_ITEM. - @param[in] Arg Pointer to the Arg, it's a pointer to the - token to cancel. - - @retval EFI_SUCCESS The Arg is NULL, and the token in Item is cancelled, - or the Arg isn't NULL, and the token in Item is - different from the Arg. - @retval EFI_ABORTED The Arg isn't NULL, the token in Item mathces the - Arg, and the token is cancelled. - -**/ -EFI_STATUS -EFIAPI -MnpCancelTokens ( - IN OUT NET_MAP *Map, - IN OUT NET_MAP_ITEM *Item, - IN VOID *Arg - ) -{ - EFI_MANAGED_NETWORK_COMPLETION_TOKEN *TokenToCancel; - - if ((Arg != NULL) && (Item->Key != Arg)) { - // - // The token in Item is not the token specified by Arg. - // - return EFI_SUCCESS; - } - - TokenToCancel = (EFI_MANAGED_NETWORK_COMPLETION_TOKEN *) Item->Key; - - // - // Remove the item from the map. - // - NetMapRemoveItem (Map, Item, NULL); - - // - // Cancel this token with status set to EFI_ABORTED. - // - TokenToCancel->Status = EFI_ABORTED; - gBS->SignalEvent (TokenToCancel->Event); - - if (Arg != NULL) { - // - // Only abort the token specified by Arg if Arg isn't NULL. - // - return EFI_ABORTED; - } - - return EFI_SUCCESS; -} - - -/** - Start and initialize the simple network. - - @param[in] Snp Pointer to the simple network protocol. - - @retval EFI_SUCCESS The simple network protocol is started. - @retval Others Other errors as indicated. - -**/ -EFI_STATUS -MnpStartSnp ( - IN EFI_SIMPLE_NETWORK_PROTOCOL *Snp - ) -{ - EFI_STATUS Status; - - ASSERT (Snp != NULL); - - // - // Start the simple network. - // - Status = Snp->Start (Snp); - - if (!EFI_ERROR (Status)) { - // - // Initialize the simple network. - // - Status = Snp->Initialize (Snp, 0, 0); - } - - return Status; -} - - -/** - Stop the simple network. - - @param[in] MnpDeviceData Pointer to the MNP_DEVICE_DATA. - - @retval EFI_SUCCESS The simple network is stopped. - @retval Others Other errors as indicated. - -**/ -EFI_STATUS -MnpStopSnp ( - IN MNP_DEVICE_DATA *MnpDeviceData - ) -{ - EFI_STATUS Status; - EFI_SIMPLE_NETWORK_PROTOCOL *Snp; - - Snp = MnpDeviceData->Snp; - ASSERT (Snp != NULL); - - // - // Recycle all the transmit buffer from SNP. - // - Status = MnpRecycleTxBuf (MnpDeviceData); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Shut down the simple network. - // - Status = Snp->Shutdown (Snp); - if (!EFI_ERROR (Status)) { - // - // Stop the simple network. - // - Status = Snp->Stop (Snp); - } - - return Status; -} - - -/** - Start the managed network, this function is called when one instance is configured - or reconfigured. - - @param[in, out] MnpServiceData Pointer to the mnp service context data. - @param[in] IsConfigUpdate The instance is reconfigured or it's the first - time the instanced is configured. - @param[in] EnableSystemPoll Enable the system polling or not. - - @retval EFI_SUCCESS The managed network is started and some - configuration is updated. - @retval Others Other errors as indicated. - -**/ -EFI_STATUS -MnpStart ( - IN OUT MNP_SERVICE_DATA *MnpServiceData, - IN BOOLEAN IsConfigUpdate, - IN BOOLEAN EnableSystemPoll - ) -{ - EFI_STATUS Status; - EFI_TIMER_DELAY TimerOpType; - MNP_DEVICE_DATA *MnpDeviceData; - - NET_CHECK_SIGNATURE (MnpServiceData, MNP_SERVICE_DATA_SIGNATURE); - - Status = EFI_SUCCESS; - MnpDeviceData = MnpServiceData->MnpDeviceData; - - if (!IsConfigUpdate) { - // - // If it's not a configuration update, increase the configured children number. - // - MnpDeviceData->ConfiguredChildrenNumber++; - - if (MnpDeviceData->ConfiguredChildrenNumber == 1) { - // - // It's the first configured child, start the simple network. - // - Status = MnpStartSnp (MnpDeviceData->Snp); - if (EFI_ERROR (Status)) { - DEBUG ((EFI_D_ERROR, "MnpStart: MnpStartSnp failed, %r.\n", Status)); - - goto ErrorExit; - } - - // - // Start the timeout timer. - // - Status = gBS->SetTimer ( - MnpDeviceData->TimeoutCheckTimer, - TimerPeriodic, - MNP_TIMEOUT_CHECK_INTERVAL - ); - if (EFI_ERROR (Status)) { - DEBUG ( - (EFI_D_ERROR, - "MnpStart, gBS->SetTimer for TimeoutCheckTimer %r.\n", - Status) - ); - - goto ErrorExit; - } - - // - // Start the media detection timer. - // - Status = gBS->SetTimer ( - MnpDeviceData->MediaDetectTimer, - TimerPeriodic, - MNP_MEDIA_DETECT_INTERVAL - ); - if (EFI_ERROR (Status)) { - DEBUG ( - (EFI_D_ERROR, - "MnpStart, gBS->SetTimer for MediaDetectTimer %r.\n", - Status) - ); - - goto ErrorExit; - } - } - } - - if (MnpDeviceData->EnableSystemPoll ^ EnableSystemPoll) { - // - // The EnableSystemPoll differs with the current state, disable or enable - // the system poll. - // - TimerOpType = EnableSystemPoll ? TimerPeriodic : TimerCancel; - - Status = gBS->SetTimer (MnpDeviceData->PollTimer, TimerOpType, MNP_SYS_POLL_INTERVAL); - if (EFI_ERROR (Status)) { - DEBUG ((EFI_D_ERROR, "MnpStart: gBS->SetTimer for PollTimer failed, %r.\n", Status)); - - goto ErrorExit; - } - - MnpDeviceData->EnableSystemPoll = EnableSystemPoll; - } - - // - // Change the receive filters if need. - // - Status = MnpConfigReceiveFilters (MnpDeviceData); - -ErrorExit: - return Status; -} - - -/** - Stop the managed network. - - @param[in, out] MnpServiceData Pointer to the mnp service context data. - - @retval EFI_SUCCESS The managed network is stopped. - @retval Others Other errors as indicated. - -**/ -EFI_STATUS -MnpStop ( - IN OUT MNP_SERVICE_DATA *MnpServiceData - ) -{ - EFI_STATUS Status; - MNP_DEVICE_DATA *MnpDeviceData; - - NET_CHECK_SIGNATURE (MnpServiceData, MNP_SERVICE_DATA_SIGNATURE); - MnpDeviceData = MnpServiceData->MnpDeviceData; - ASSERT (MnpDeviceData->ConfiguredChildrenNumber > 0); - - // - // Configure the receive filters. - // - MnpConfigReceiveFilters (MnpDeviceData); - - // - // Decrease the children number. - // - MnpDeviceData->ConfiguredChildrenNumber--; - - if (MnpDeviceData->ConfiguredChildrenNumber > 0) { - // - // If there are other configured chilren, return and keep the timers and - // simple network unchanged. - // - return EFI_SUCCESS; - } - - // - // No configured children now. - // - if (MnpDeviceData->EnableSystemPoll) { - // - // The system poll in on, cancel the poll timer. - // - Status = gBS->SetTimer (MnpDeviceData->PollTimer, TimerCancel, 0); - MnpDeviceData->EnableSystemPoll = FALSE; - } - - // - // Cancel the timeout timer. - // - Status = gBS->SetTimer (MnpDeviceData->TimeoutCheckTimer, TimerCancel, 0); - - // - // Cancel the media detect timer. - // - Status = gBS->SetTimer (MnpDeviceData->MediaDetectTimer, TimerCancel, 0); - - // - // Stop the simple network. - // - Status = MnpStopSnp (MnpDeviceData); - return Status; -} - - -/** - Flush the instance's received data. - - @param[in, out] Instance Pointer to the mnp instance context data. - -**/ -VOID -MnpFlushRcvdDataQueue ( - IN OUT MNP_INSTANCE_DATA *Instance - ) -{ - EFI_TPL OldTpl; - MNP_RXDATA_WRAP *RxDataWrap; - - NET_CHECK_SIGNATURE (Instance, MNP_INSTANCE_DATA_SIGNATURE); - - OldTpl = gBS->RaiseTPL (TPL_NOTIFY); - - while (!IsListEmpty (&Instance->RcvdPacketQueue)) { - // - // Remove all the Wraps. - // - RxDataWrap = NET_LIST_HEAD (&Instance->RcvdPacketQueue, MNP_RXDATA_WRAP, WrapEntry); - - // - // Recycle the RxDataWrap. - // - MnpRecycleRxData (NULL, (VOID *) RxDataWrap); - Instance->RcvdPacketQueueSize--; - } - - ASSERT (Instance->RcvdPacketQueueSize == 0); - - gBS->RestoreTPL (OldTpl); -} - - -/** - Configure the Instance using ConfigData. - - @param[in, out] Instance Pointer to the mnp instance context data. - @param[in] ConfigData Pointer to the configuration data used to configure - the isntance. - - @retval EFI_SUCCESS The Instance is configured. - @retval EFI_UNSUPPORTED EnableReceiveTimestamps is on and the - implementation doesn't support it. - @retval Others Other errors as indicated. - -**/ -EFI_STATUS -MnpConfigureInstance ( - IN OUT MNP_INSTANCE_DATA *Instance, - IN EFI_MANAGED_NETWORK_CONFIG_DATA *ConfigData OPTIONAL - ) -{ - EFI_STATUS Status; - MNP_SERVICE_DATA *MnpServiceData; - MNP_DEVICE_DATA *MnpDeviceData; - EFI_MANAGED_NETWORK_CONFIG_DATA *OldConfigData; - EFI_MANAGED_NETWORK_CONFIG_DATA *NewConfigData; - BOOLEAN IsConfigUpdate; - - NET_CHECK_SIGNATURE (Instance, MNP_INSTANCE_DATA_SIGNATURE); - - if ((ConfigData != NULL) && ConfigData->EnableReceiveTimestamps) { - // - // Don't support timestamp. - // - return EFI_UNSUPPORTED; - } - - Status = EFI_SUCCESS; - - MnpServiceData = Instance->MnpServiceData; - MnpDeviceData = MnpServiceData->MnpDeviceData; - NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); - - IsConfigUpdate = (BOOLEAN) ((Instance->Configured) && (ConfigData != NULL)); - - OldConfigData = &Instance->ConfigData; - NewConfigData = ConfigData; - if (NewConfigData == NULL) { - // - // Restore back the default config data if a reset of this instance - // is required. - // - NewConfigData = &mMnpDefaultConfigData; - } - - // - // Reset the instance's receive filter. - // - Instance->ReceiveFilter = 0; - - // - // Clear the receive counters according to the old ConfigData. - // - if (OldConfigData->EnableUnicastReceive) { - MnpDeviceData->UnicastCount--; - } - - if (OldConfigData->EnableMulticastReceive) { - MnpDeviceData->MulticastCount--; - } - - if (OldConfigData->EnableBroadcastReceive) { - MnpDeviceData->BroadcastCount--; - } - - if (OldConfigData->EnablePromiscuousReceive) { - MnpDeviceData->PromiscuousCount--; - } - - // - // Set the receive filter counters and the receive filter of the - // instance according to the new ConfigData. - // - if (NewConfigData->EnableUnicastReceive) { - MnpDeviceData->UnicastCount++; - Instance->ReceiveFilter |= MNP_RECEIVE_UNICAST; - } - - if (NewConfigData->EnableMulticastReceive) { - MnpDeviceData->MulticastCount++; - } - - if (NewConfigData->EnableBroadcastReceive) { - MnpDeviceData->BroadcastCount++; - Instance->ReceiveFilter |= MNP_RECEIVE_BROADCAST; - } - - if (NewConfigData->EnablePromiscuousReceive) { - MnpDeviceData->PromiscuousCount++; - } - - if (OldConfigData->FlushQueuesOnReset) { - MnpFlushRcvdDataQueue (Instance); - } - - if (ConfigData == NULL) { - Instance->ManagedNetwork.Cancel (&Instance->ManagedNetwork, NULL); - } - - if (!NewConfigData->EnableMulticastReceive) { - MnpGroupOp (Instance, FALSE, NULL, NULL); - } - - // - // Save the new configuration data. - // - CopyMem (OldConfigData, NewConfigData, sizeof (*OldConfigData)); - - Instance->Configured = (BOOLEAN) (ConfigData != NULL); - if (Instance->Configured) { - // - // The instance is configured, start the Mnp. - // - Status = MnpStart ( - MnpServiceData, - IsConfigUpdate, - (BOOLEAN) !NewConfigData->DisableBackgroundPolling - ); - } else { - // - // The instance is changed to the unconfigured state, stop the Mnp. - // - Status = MnpStop (MnpServiceData); - } - - return Status; -} - -/** - Configure the Snp receive filters according to the instances' receive filter - settings. - - @param[in] MnpDeviceData Pointer to the mnp device context data. - - @retval EFI_SUCCESS The receive filters is configured. - @retval EFI_OUT_OF_RESOURCES The receive filters can't be configured due - to lack of memory resource. - -**/ -EFI_STATUS -MnpConfigReceiveFilters ( - IN MNP_DEVICE_DATA *MnpDeviceData - ) -{ - EFI_STATUS Status; - EFI_SIMPLE_NETWORK_PROTOCOL *Snp; - EFI_MAC_ADDRESS *MCastFilter; - UINT32 MCastFilterCnt; - UINT32 EnableFilterBits; - UINT32 DisableFilterBits; - BOOLEAN ResetMCastFilters; - LIST_ENTRY *Entry; - UINT32 Index; - MNP_GROUP_ADDRESS *GroupAddress; - - NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); - - Snp = MnpDeviceData->Snp; - - // - // Initialize the enable filter and disable filter. - // - EnableFilterBits = 0; - DisableFilterBits = Snp->Mode->ReceiveFilterMask; - - if (MnpDeviceData->UnicastCount != 0) { - // - // Enable unicast if any instance wants to receive unicast. - // - EnableFilterBits |= EFI_SIMPLE_NETWORK_RECEIVE_UNICAST; - } - - if (MnpDeviceData->BroadcastCount != 0) { - // - // Enable broadcast if any instance wants to receive broadcast. - // - EnableFilterBits |= EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST; - } - - MCastFilter = NULL; - MCastFilterCnt = 0; - ResetMCastFilters = TRUE; - - if ((MnpDeviceData->MulticastCount != 0) && (MnpDeviceData->GroupAddressCount != 0)) { - // - // There are instances configured to receive multicast and already some group - // addresses are joined. - // - - ResetMCastFilters = FALSE; - - if (MnpDeviceData->GroupAddressCount <= Snp->Mode->MaxMCastFilterCount) { - // - // The joind group address is less than simple network's maximum count. - // Just configure the snp to do the multicast filtering. - // - - EnableFilterBits |= EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST; - - // - // Allocate pool for the mulicast addresses. - // - MCastFilterCnt = MnpDeviceData->GroupAddressCount; - MCastFilter = AllocatePool (sizeof (EFI_MAC_ADDRESS) * MCastFilterCnt); - if (MCastFilter == NULL) { - DEBUG ((EFI_D_ERROR, "MnpConfigReceiveFilters: Failed to allocate memory resource for MCastFilter.\n")); - - return EFI_OUT_OF_RESOURCES; - } - - // - // Fill the multicast HW address buffer. - // - Index = 0; - NET_LIST_FOR_EACH (Entry, &MnpDeviceData->GroupAddressList) { - - GroupAddress = NET_LIST_USER_STRUCT (Entry, MNP_GROUP_ADDRESS, AddrEntry); - CopyMem (MCastFilter + Index, &GroupAddress->Address, sizeof (*(MCastFilter + Index))); - Index++; - - ASSERT (Index <= MCastFilterCnt); - } - } else { - // - // The maximum multicast is reached, set the filter to be promiscuous - // multicast. - // - - if ((Snp->Mode->ReceiveFilterMask & EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST) != 0) { - EnableFilterBits |= EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST; - } else { - // - // Either MULTICAST or PROMISCUOUS_MULTICAST is not supported by Snp, - // set the NIC to be promiscuous although this will tremendously degrade - // the performance. - // - EnableFilterBits |= EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS; - } - } - } - - if (MnpDeviceData->PromiscuousCount != 0) { - // - // Enable promiscuous if any instance wants to receive promiscuous. - // - EnableFilterBits |= EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS; - } - - // - // Set the disable filter. - // - DisableFilterBits ^= EnableFilterBits; - - // - // Configure the receive filters of SNP. - // - Status = Snp->ReceiveFilters ( - Snp, - EnableFilterBits, - DisableFilterBits, - ResetMCastFilters, - MCastFilterCnt, - MCastFilter - ); - DEBUG_CODE ( - if (EFI_ERROR (Status)) { - DEBUG ( - (EFI_D_ERROR, - "MnpConfigReceiveFilters: Snp->ReceiveFilters failed, %r.\n", - Status) - ); - } - ); - - if (MCastFilter != NULL) { - // - // Free the buffer used to hold the group addresses. - // - FreePool (MCastFilter); - } - - return Status; -} - - -/** - Add a group address control block which controls the MacAddress for - this instance. - - @param[in, out] Instance Pointer to the mnp instance context data. - @param[in, out] CtrlBlk Pointer to the group address control block. - @param[in, out] GroupAddress Pointer to the group adress. - @param[in] MacAddress Pointer to the mac address. - @param[in] HwAddressSize The hardware address size. - - @retval EFI_SUCCESS The group address control block is added. - @retval EFI_OUT_OF_RESOURCES Failed due to lack of memory resources. - -**/ -EFI_STATUS -MnpGroupOpAddCtrlBlk ( - IN OUT MNP_INSTANCE_DATA *Instance, - IN OUT MNP_GROUP_CONTROL_BLOCK *CtrlBlk, - IN OUT MNP_GROUP_ADDRESS *GroupAddress OPTIONAL, - IN EFI_MAC_ADDRESS *MacAddress, - IN UINT32 HwAddressSize - ) -{ - MNP_DEVICE_DATA *MnpDeviceData; - - NET_CHECK_SIGNATURE (Instance, MNP_INSTANCE_DATA_SIGNATURE); - - MnpDeviceData = Instance->MnpServiceData->MnpDeviceData; - NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); - - if (GroupAddress == NULL) { - ASSERT (MacAddress != NULL); - - // - // Allocate a new GroupAddress to be added into MNP's GroupAddressList. - // - GroupAddress = AllocatePool (sizeof (MNP_GROUP_ADDRESS)); - if (GroupAddress == NULL) { - - DEBUG ((EFI_D_ERROR, "MnpGroupOpFormCtrlBlk: Failed to allocate memory resource.\n")); - - return EFI_OUT_OF_RESOURCES; - } - - CopyMem (&GroupAddress->Address, MacAddress, sizeof (GroupAddress->Address)); - GroupAddress->RefCnt = 0; - InsertTailList ( - &MnpDeviceData->GroupAddressList, - &GroupAddress->AddrEntry - ); - MnpDeviceData->GroupAddressCount++; - } - - // - // Increase the RefCnt. - // - GroupAddress->RefCnt++; - - // - // Add the CtrlBlk into the instance's GroupCtrlBlkList. - // - CtrlBlk->GroupAddress = GroupAddress; - InsertTailList (&Instance->GroupCtrlBlkList, &CtrlBlk->CtrlBlkEntry); - - return EFI_SUCCESS; -} - - -/** - Delete a group control block from the instance. If the controlled group address's - reference count reaches zero, the group address is removed too. - - @param[in] Instance Pointer to the instance context data. - @param[in] CtrlBlk Pointer to the group control block to delete. - - @return The group address controlled by the control block is no longer used or not. - -**/ -BOOLEAN -MnpGroupOpDelCtrlBlk ( - IN MNP_INSTANCE_DATA *Instance, - IN MNP_GROUP_CONTROL_BLOCK *CtrlBlk - ) -{ - MNP_DEVICE_DATA *MnpDeviceData; - MNP_GROUP_ADDRESS *GroupAddress; - - NET_CHECK_SIGNATURE (Instance, MNP_INSTANCE_DATA_SIGNATURE); - - MnpDeviceData = Instance->MnpServiceData->MnpDeviceData; - NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); - - // - // Remove and free the CtrlBlk. - // - GroupAddress = CtrlBlk->GroupAddress; - RemoveEntryList (&CtrlBlk->CtrlBlkEntry); - FreePool (CtrlBlk); - - ASSERT (GroupAddress->RefCnt > 0); - - // - // Count down the RefCnt. - // - GroupAddress->RefCnt--; - - if (GroupAddress->RefCnt == 0) { - // - // Free this GroupAddress entry if no instance uses it. - // - MnpDeviceData->GroupAddressCount--; - RemoveEntryList (&GroupAddress->AddrEntry); - FreePool (GroupAddress); - - return TRUE; - } - - return FALSE; -} - - -/** - Do the group operations for this instance. - - @param[in, out] Instance Pointer to the instance context data. - @param[in] JoinFlag Set to TRUE to join a group. Set to TRUE to - leave a group/groups. - @param[in] MacAddress Pointer to the group address to join or leave. - @param[in] CtrlBlk Pointer to the group control block if JoinFlag - is FALSE. - - @retval EFI_SUCCESS The group operation finished. - @retval EFI_OUT_OF_RESOURCES Failed due to lack of memory resources. - @retval Others Other errors as indicated. - -**/ -EFI_STATUS -MnpGroupOp ( - IN OUT MNP_INSTANCE_DATA *Instance, - IN BOOLEAN JoinFlag, - IN EFI_MAC_ADDRESS *MacAddress OPTIONAL, - IN MNP_GROUP_CONTROL_BLOCK *CtrlBlk OPTIONAL - ) -{ - MNP_DEVICE_DATA *MnpDeviceData; - LIST_ENTRY *Entry; - LIST_ENTRY *NextEntry; - MNP_GROUP_ADDRESS *GroupAddress; - EFI_SIMPLE_NETWORK_MODE *SnpMode; - MNP_GROUP_CONTROL_BLOCK *NewCtrlBlk; - EFI_STATUS Status; - BOOLEAN AddressExist; - BOOLEAN NeedUpdate; - - NET_CHECK_SIGNATURE (Instance, MNP_INSTANCE_DATA_SIGNATURE); - - MnpDeviceData = Instance->MnpServiceData->MnpDeviceData; - SnpMode = MnpDeviceData->Snp->Mode; - - if (JoinFlag) { - // - // A new gropu address is to be added. - // - GroupAddress = NULL; - AddressExist = FALSE; - - // - // Allocate memory for the control block. - // - NewCtrlBlk = AllocatePool (sizeof (MNP_GROUP_CONTROL_BLOCK)); - if (NewCtrlBlk == NULL) { - DEBUG ((EFI_D_ERROR, "MnpGroupOp: Failed to allocate memory resource.\n")); - - return EFI_OUT_OF_RESOURCES; - } - - NET_LIST_FOR_EACH (Entry, &MnpDeviceData->GroupAddressList) { - // - // Check whether the MacAddress is already joined by other instances. - // - GroupAddress = NET_LIST_USER_STRUCT (Entry, MNP_GROUP_ADDRESS, AddrEntry); - if (CompareMem (MacAddress, &GroupAddress->Address, SnpMode->HwAddressSize) == 0) { - AddressExist = TRUE; - break; - } - } - - if (!AddressExist) { - GroupAddress = NULL; - } - - // - // Add the GroupAddress for this instance. - // - Status = MnpGroupOpAddCtrlBlk ( - Instance, - NewCtrlBlk, - GroupAddress, - MacAddress, - SnpMode->HwAddressSize - ); - if (EFI_ERROR (Status)) { - return Status; - } - - NeedUpdate = TRUE; - } else { - if (MacAddress != NULL) { - ASSERT (CtrlBlk != NULL); - - // - // Leave the specific multicast mac address. - // - NeedUpdate = MnpGroupOpDelCtrlBlk (Instance, CtrlBlk); - } else { - // - // Leave all multicast mac addresses. - // - NeedUpdate = FALSE; - - NET_LIST_FOR_EACH_SAFE (Entry, NextEntry, &Instance->GroupCtrlBlkList) { - - NewCtrlBlk = NET_LIST_USER_STRUCT ( - Entry, - MNP_GROUP_CONTROL_BLOCK, - CtrlBlkEntry - ); - // - // Update is required if the group address left is no longer used - // by other instances. - // - NeedUpdate = MnpGroupOpDelCtrlBlk (Instance, NewCtrlBlk); - } - } - } - - Status = EFI_SUCCESS; - - if (NeedUpdate) { - // - // Reconfigure the receive filters if necessary. - // - Status = MnpConfigReceiveFilters (MnpDeviceData); - } - - return Status; -} diff --git a/MdeModulePkg/Universal/Network/MnpDxe/MnpDriver.c b/MdeModulePkg/Universal/Network/MnpDxe/MnpDriver.c deleted file mode 100644 index e99e7c5a61..0000000000 --- a/MdeModulePkg/Universal/Network/MnpDxe/MnpDriver.c +++ /dev/null @@ -1,683 +0,0 @@ -/** @file - Implementation of driver entry point and driver binding protocol. - -Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "MnpDriver.h" -#include "MnpImpl.h" -#include "MnpVlan.h" - -EFI_DRIVER_BINDING_PROTOCOL gMnpDriverBinding = { - MnpDriverBindingSupported, - MnpDriverBindingStart, - MnpDriverBindingStop, - 0xa, - NULL, - NULL -}; - -/** - Callback function which provided by user to remove one node in NetDestroyLinkList process. - - @param[in] Entry The entry to be removed. - @param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList. - - @retval EFI_SUCCESS The entry has been removed successfully. - @retval Others Fail to remove the entry. - -**/ -EFI_STATUS -EFIAPI -MnpDestroyServiceDataEntry ( - IN LIST_ENTRY *Entry, - IN VOID *Context - ) -{ - MNP_SERVICE_DATA *MnpServiceData; - - MnpServiceData = MNP_SERVICE_DATA_FROM_LINK (Entry); - return MnpDestroyServiceData (MnpServiceData); -} - -/** - Callback function which provided by user to remove one node in NetDestroyLinkList process. - - @param[in] Entry The entry to be removed. - @param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList. - - @retval EFI_SUCCESS The entry has been removed successfully. - @retval Others Fail to remove the entry. - -**/ -EFI_STATUS -EFIAPI -MnpDestroyServiceChildEntry ( - IN LIST_ENTRY *Entry, - IN VOID *Context - ) -{ - MNP_SERVICE_DATA *MnpServiceData; - - MnpServiceData = MNP_SERVICE_DATA_FROM_LINK (Entry); - return MnpDestroyServiceChild (MnpServiceData); -} - -/** - Test to see if this driver supports ControllerHandle. This service - is called by the EFI boot service ConnectController(). In - order to make drivers as small as possible, there are a few calling - restrictions for this service. ConnectController() must - follow these calling restrictions. If any other agent wishes to call - Supported() it must also follow these calling restrictions. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to test. - @param[in] RemainingDevicePath Optional parameter use to pick a specific - child device to start. - - @retval EFI_SUCCESS This driver supports this device. - @retval EFI_ALREADY_STARTED This driver is already running on this device. - @retval Others This driver does not support this device. - -**/ -EFI_STATUS -EFIAPI -MnpDriverBindingSupported ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL - ) -{ - EFI_STATUS Status; - EFI_SIMPLE_NETWORK_PROTOCOL *Snp; - - // - // Test to open the Simple Network protocol BY_DRIVER. - // - Status = gBS->OpenProtocol ( - ControllerHandle, - &gEfiSimpleNetworkProtocolGuid, - (VOID **) &Snp, - This->DriverBindingHandle, - ControllerHandle, - EFI_OPEN_PROTOCOL_BY_DRIVER - ); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Close the openned SNP protocol. - // - gBS->CloseProtocol ( - ControllerHandle, - &gEfiSimpleNetworkProtocolGuid, - This->DriverBindingHandle, - ControllerHandle - ); - - return EFI_SUCCESS; -} - - -/** - Start this driver on ControllerHandle. This service is called by the - EFI boot service ConnectController(). In order to make drivers as small - as possible, there are a few calling restrictions for this service. - ConnectController() must follow these calling restrictions. If any other - agent wishes to call Start() it must also follow these calling restrictions. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to bind driver to. - @param[in] RemainingDevicePath Optional parameter use to pick a specific - child device to start. - - @retval EFI_SUCCESS This driver is added to ControllerHandle. - @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle. - @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for Mnp Service Data. - @retval Others This driver does not support this device. - -**/ -EFI_STATUS -EFIAPI -MnpDriverBindingStart ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL - ) -{ - EFI_STATUS Status; - MNP_SERVICE_DATA *MnpServiceData; - MNP_DEVICE_DATA *MnpDeviceData; - LIST_ENTRY *Entry; - VLAN_TCI *VlanVariable; - UINTN NumberOfVlan; - UINTN Index; - - VlanVariable = NULL; - - // - // Initialize the Mnp Device Data - // - MnpDeviceData = AllocateZeroPool (sizeof (MNP_DEVICE_DATA)); - if (MnpDeviceData == NULL) { - DEBUG ((EFI_D_ERROR, "MnpDriverBindingStart(): Failed to allocate the Mnp Device Data.\n")); - - return EFI_OUT_OF_RESOURCES; - } - - Status = MnpInitializeDeviceData (MnpDeviceData, This->DriverBindingHandle, ControllerHandle); - if (EFI_ERROR (Status)) { - DEBUG ((EFI_D_ERROR, "MnpDriverBindingStart: MnpInitializeDeviceData failed, %r.\n", Status)); - - FreePool (MnpDeviceData); - return Status; - } - - // - // Check whether NIC driver has already produced VlanConfig protocol - // - Status = gBS->OpenProtocol ( - ControllerHandle, - &gEfiVlanConfigProtocolGuid, - NULL, - This->DriverBindingHandle, - ControllerHandle, - EFI_OPEN_PROTOCOL_TEST_PROTOCOL - ); - if (!EFI_ERROR (Status)) { - // - // NIC hardware already implement VLAN, - // no need to provide software VLAN implementation in MNP driver - // - MnpDeviceData->NumberOfVlan = 0; - ZeroMem (&MnpDeviceData->VlanConfig, sizeof (EFI_VLAN_CONFIG_PROTOCOL)); - MnpServiceData = MnpCreateServiceData (MnpDeviceData, 0, 0); - Status = (MnpServiceData != NULL) ? EFI_SUCCESS : EFI_OUT_OF_RESOURCES; - goto Exit; - } - - // - // Install VLAN Config Protocol - // - Status = gBS->InstallMultipleProtocolInterfaces ( - &ControllerHandle, - &gEfiVlanConfigProtocolGuid, - &MnpDeviceData->VlanConfig, - NULL - ); - if (EFI_ERROR (Status)) { - goto Exit; - } - - // - // Get current VLAN configuration from EFI Variable - // - NumberOfVlan = 0; - Status = MnpGetVlanVariable (MnpDeviceData, &NumberOfVlan, &VlanVariable); - if (EFI_ERROR (Status)) { - // - // No VLAN is set, create a default MNP service data for untagged frame - // - MnpDeviceData->NumberOfVlan = 0; - MnpServiceData = MnpCreateServiceData (MnpDeviceData, 0, 0); - Status = (MnpServiceData != NULL) ? EFI_SUCCESS : EFI_OUT_OF_RESOURCES; - goto Exit; - } - - // - // Create MNP service data for each VLAN - // - MnpDeviceData->NumberOfVlan = NumberOfVlan; - for (Index = 0; Index < NumberOfVlan; Index++) { - MnpServiceData = MnpCreateServiceData ( - MnpDeviceData, - VlanVariable[Index].Bits.Vid, - (UINT8) VlanVariable[Index].Bits.Priority - ); - - if (MnpServiceData == NULL) { - Status = EFI_OUT_OF_RESOURCES; - - goto Exit; - } - } - -Exit: - if (VlanVariable != NULL) { - FreePool (VlanVariable); - } - - if (EFI_ERROR (Status)) { - // - // Destroy all MNP service data - // - while (!IsListEmpty (&MnpDeviceData->ServiceList)) { - Entry = GetFirstNode (&MnpDeviceData->ServiceList); - MnpServiceData = MNP_SERVICE_DATA_FROM_LINK (Entry); - MnpDestroyServiceData (MnpServiceData); - } - - // - // Uninstall the VLAN Config Protocol if any - // - if (MnpDeviceData->VlanConfig.Set != NULL) { - gBS->UninstallMultipleProtocolInterfaces ( - MnpDeviceData->ControllerHandle, - &gEfiVlanConfigProtocolGuid, - &MnpDeviceData->VlanConfig, - NULL - ); - } - - // - // Destroy Mnp Device Data - // - MnpDestroyDeviceData (MnpDeviceData, This->DriverBindingHandle); - FreePool (MnpDeviceData); - } - - return Status; -} - -/** - Stop this driver on ControllerHandle. This service is called by the - EFI boot service DisconnectController(). In order to make drivers as - small as possible, there are a few calling restrictions for this service. - DisconnectController() must follow these calling restrictions. If any other - agent wishes to call Stop() it must also follow these calling restrictions. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to stop driver on. - @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If - number of children is zero stop the entire - bus driver. - @param[in] ChildHandleBuffer List of Child Handles to Stop. - - @retval EFI_SUCCESS This driver is removed ControllerHandle. - @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error. - -**/ -EFI_STATUS -EFIAPI -MnpDriverBindingStop ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN UINTN NumberOfChildren, - IN EFI_HANDLE *ChildHandleBuffer OPTIONAL - ) -{ - EFI_STATUS Status; - EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; - EFI_VLAN_CONFIG_PROTOCOL *VlanConfig; - MNP_DEVICE_DATA *MnpDeviceData; - MNP_SERVICE_DATA *MnpServiceData; - LIST_ENTRY *List; - UINTN ListLength; - - // - // Try to retrieve MNP service binding protocol from the ControllerHandle - // - Status = gBS->OpenProtocol ( - ControllerHandle, - &gEfiManagedNetworkServiceBindingProtocolGuid, - (VOID **) &ServiceBinding, - This->DriverBindingHandle, - ControllerHandle, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - if (EFI_ERROR (Status)) { - // - // Retrieve VLAN Config Protocol from the ControllerHandle - // - Status = gBS->OpenProtocol ( - ControllerHandle, - &gEfiVlanConfigProtocolGuid, - (VOID **) &VlanConfig, - This->DriverBindingHandle, - ControllerHandle, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - if (EFI_ERROR (Status)) { - DEBUG ((EFI_D_ERROR, "MnpDriverBindingStop: try to stop unknown Controller.\n")); - return EFI_DEVICE_ERROR; - } - - MnpDeviceData = MNP_DEVICE_DATA_FROM_THIS (VlanConfig); - } else { - MnpServiceData = MNP_SERVICE_DATA_FROM_THIS (ServiceBinding); - MnpDeviceData = MnpServiceData->MnpDeviceData; - } - - if (NumberOfChildren == 0) { - // - // Destroy all MNP service data - // - List = &MnpDeviceData->ServiceList; - Status = NetDestroyLinkList ( - List, - MnpDestroyServiceDataEntry, - NULL, - &ListLength - ); - if (EFI_ERROR (Status) || ListLength !=0) { - return EFI_DEVICE_ERROR; - } - - // - // Uninstall the VLAN Config Protocol if any - // - if (MnpDeviceData->VlanConfig.Set != NULL) { - gBS->UninstallMultipleProtocolInterfaces ( - MnpDeviceData->ControllerHandle, - &gEfiVlanConfigProtocolGuid, - &MnpDeviceData->VlanConfig, - NULL - ); - } - - // - // Destroy Mnp Device Data - // - MnpDestroyDeviceData (MnpDeviceData, This->DriverBindingHandle); - FreePool (MnpDeviceData); - - if (gMnpControllerNameTable != NULL) { - FreeUnicodeStringTable (gMnpControllerNameTable); - gMnpControllerNameTable = NULL; - } - return EFI_SUCCESS; - } - - // - // Stop all MNP child - // - List = &MnpDeviceData->ServiceList; - Status = NetDestroyLinkList ( - List, - MnpDestroyServiceChildEntry, - NULL, - &ListLength - ); - if (EFI_ERROR (Status)) { - return EFI_DEVICE_ERROR; - } - - return EFI_SUCCESS; -} - - -/** - Creates a child handle with a set of I/O services. - - @param[in] This Protocol instance pointer. - @param[in, out] ChildHandle Pointer to the handle of the child to create. If - it is NULL, then a new handle is created. If - it is not NULL, then the I/O services are added - to the existing child handle. - - @retval EFI_SUCCES The protocol was added to ChildHandle. - @retval EFI_INVALID_PARAMETER ChildHandle is NULL. - @retval EFI_OUT_OF_RESOURCES There are not enough resources available to - create the child. - @retval Others The child handle was not created. - -**/ -EFI_STATUS -EFIAPI -MnpServiceBindingCreateChild ( - IN EFI_SERVICE_BINDING_PROTOCOL *This, - IN OUT EFI_HANDLE *ChildHandle - ) -{ - EFI_STATUS Status; - MNP_SERVICE_DATA *MnpServiceData; - MNP_INSTANCE_DATA *Instance; - VOID *MnpSb; - EFI_TPL OldTpl; - - if ((This == NULL) || (ChildHandle == NULL)) { - return EFI_INVALID_PARAMETER; - } - - MnpServiceData = MNP_SERVICE_DATA_FROM_THIS (This); - - // - // Allocate buffer for the new instance. - // - Instance = AllocateZeroPool (sizeof (MNP_INSTANCE_DATA)); - if (Instance == NULL) { - DEBUG ((EFI_D_ERROR, "MnpServiceBindingCreateChild: Faild to allocate memory for the new instance.\n")); - - return EFI_OUT_OF_RESOURCES; - } - - // - // Init the instance data. - // - MnpInitializeInstanceData (MnpServiceData, Instance); - - Status = gBS->InstallMultipleProtocolInterfaces ( - ChildHandle, - &gEfiManagedNetworkProtocolGuid, - &Instance->ManagedNetwork, - NULL - ); - if (EFI_ERROR (Status)) { - DEBUG ( - (EFI_D_ERROR, - "MnpServiceBindingCreateChild: Failed to install the MNP protocol, %r.\n", - Status) - ); - - goto ErrorExit; - } - - // - // Save the instance's childhandle. - // - Instance->Handle = *ChildHandle; - - Status = gBS->OpenProtocol ( - MnpServiceData->ServiceHandle, - &gEfiManagedNetworkServiceBindingProtocolGuid, - (VOID **) &MnpSb, - gMnpDriverBinding.DriverBindingHandle, - Instance->Handle, - EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER - ); - if (EFI_ERROR (Status)) { - goto ErrorExit; - } - - // - // Add the child instance into ChildrenList. - // - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - InsertTailList (&MnpServiceData->ChildrenList, &Instance->InstEntry); - MnpServiceData->ChildrenNumber++; - - gBS->RestoreTPL (OldTpl); - -ErrorExit: - - if (EFI_ERROR (Status)) { - - if (Instance->Handle != NULL) { - - gBS->UninstallMultipleProtocolInterfaces ( - Instance->Handle, - &gEfiManagedNetworkProtocolGuid, - &Instance->ManagedNetwork, - NULL - ); - } - - FreePool (Instance); - } - - return Status; -} - - -/** - Destroys a child handle with a set of I/O services. - - The DestroyChild() function does the opposite of CreateChild(). It removes a - protocol that was installed by CreateChild() from ChildHandle. If the removed - protocol is the last protocol on ChildHandle, then ChildHandle is destroyed. - - @param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL - instance. - @param[in] ChildHandle Handle of the child to destroy. - - @retval EFI_SUCCES The protocol was removed from ChildHandle. - @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that - is being removed. - @retval EFI_INVALID_PARAMETER ChildHandle is NULL. - @retval EFI_ACCESS_DENIED The protocol could not be removed from the - ChildHandle because its services are being - used. - @retval Others The child handle was not destroyed. - -**/ -EFI_STATUS -EFIAPI -MnpServiceBindingDestroyChild ( - IN EFI_SERVICE_BINDING_PROTOCOL *This, - IN EFI_HANDLE ChildHandle - ) -{ - EFI_STATUS Status; - MNP_SERVICE_DATA *MnpServiceData; - EFI_MANAGED_NETWORK_PROTOCOL *ManagedNetwork; - MNP_INSTANCE_DATA *Instance; - EFI_TPL OldTpl; - - if ((This == NULL) || (ChildHandle == NULL)) { - return EFI_INVALID_PARAMETER; - } - - MnpServiceData = MNP_SERVICE_DATA_FROM_THIS (This); - - // - // Try to retrieve ManagedNetwork Protocol from ChildHandle. - // - Status = gBS->OpenProtocol ( - ChildHandle, - &gEfiManagedNetworkProtocolGuid, - (VOID **) &ManagedNetwork, - gMnpDriverBinding.DriverBindingHandle, - ChildHandle, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - if (EFI_ERROR (Status)) { - return EFI_UNSUPPORTED; - } - - Instance = MNP_INSTANCE_DATA_FROM_THIS (ManagedNetwork); - - // - // MnpServiceBindingDestroyChild may be called twice: first called by - // MnpServiceBindingStop, second called by uninstalling the MNP protocol - // in this ChildHandle. Use destroyed to make sure the resource clean code - // will only excecute once. - // - if (Instance->Destroyed) { - return EFI_SUCCESS; - } - - Instance->Destroyed = TRUE; - - // - // Close the Simple Network protocol. - // - gBS->CloseProtocol ( - MnpServiceData->ServiceHandle, - &gEfiManagedNetworkServiceBindingProtocolGuid, - MnpServiceData->MnpDeviceData->ImageHandle, - ChildHandle - ); - - // - // Uninstall the ManagedNetwork protocol. - // - Status = gBS->UninstallMultipleProtocolInterfaces ( - ChildHandle, - &gEfiManagedNetworkProtocolGuid, - &Instance->ManagedNetwork, - NULL - ); - if (EFI_ERROR (Status)) { - DEBUG ( - (EFI_D_ERROR, - "MnpServiceBindingDestroyChild: Failed to uninstall the ManagedNetwork protocol, %r.\n", - Status) - ); - - Instance->Destroyed = FALSE; - return Status; - } - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - // - // Reset the configuration. - // - ManagedNetwork->Configure (ManagedNetwork, NULL); - - // - // Try to flush the RcvdPacketQueue. - // - MnpFlushRcvdDataQueue (Instance); - - // - // Clean the RxTokenMap. - // - NetMapClean (&Instance->RxTokenMap); - - // - // Remove this instance from the ChildrenList. - // - RemoveEntryList (&Instance->InstEntry); - MnpServiceData->ChildrenNumber--; - - gBS->RestoreTPL (OldTpl); - - FreePool (Instance); - - return Status; -} - -/** - The entry point for Mnp driver which installs the driver binding and component - name protocol on its ImageHandle. - - @param[in] ImageHandle The image handle of the driver. - @param[in] SystemTable The system table. - - @retval EFI_SUCCES The driver binding and component name protocols are - successfully installed. - @retval Others Other errors as indicated. - -**/ -EFI_STATUS -EFIAPI -MnpDriverEntryPoint ( - IN EFI_HANDLE ImageHandle, - IN EFI_SYSTEM_TABLE *SystemTable - ) -{ - return EfiLibInstallDriverBindingComponentName2 ( - ImageHandle, - SystemTable, - &gMnpDriverBinding, - ImageHandle, - &gMnpComponentName, - &gMnpComponentName2 - ); -} diff --git a/MdeModulePkg/Universal/Network/MnpDxe/MnpDriver.h b/MdeModulePkg/Universal/Network/MnpDxe/MnpDriver.h deleted file mode 100644 index 150d21e9ec..0000000000 --- a/MdeModulePkg/Universal/Network/MnpDxe/MnpDriver.h +++ /dev/null @@ -1,268 +0,0 @@ -/** @file - Declaration of strctures and functions for MnpDxe driver. - -Copyright (c) 2005 - 2016, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef _MNP_DRIVER_H_ -#define _MNP_DRIVER_H_ - -#include - -#include -#include -#include -#include - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - -#include "ComponentName.h" - -#define MNP_DEVICE_DATA_SIGNATURE SIGNATURE_32 ('M', 'n', 'p', 'D') - -// -// Global Variables -// -extern EFI_DRIVER_BINDING_PROTOCOL gMnpDriverBinding; - -typedef struct { - UINT32 Signature; - - EFI_HANDLE ControllerHandle; - EFI_HANDLE ImageHandle; - - EFI_VLAN_CONFIG_PROTOCOL VlanConfig; - UINTN NumberOfVlan; - CHAR16 *MacString; - EFI_SIMPLE_NETWORK_PROTOCOL *Snp; - - // - // List of MNP_SERVICE_DATA - // - LIST_ENTRY ServiceList; - // - // Number of configured MNP Service Binding child - // - UINTN ConfiguredChildrenNumber; - - LIST_ENTRY GroupAddressList; - UINT32 GroupAddressCount; - - LIST_ENTRY FreeTxBufList; - LIST_ENTRY AllTxBufList; - UINT32 TxBufCount; - - NET_BUF_QUEUE FreeNbufQue; - INTN NbufCnt; - - EFI_EVENT PollTimer; - BOOLEAN EnableSystemPoll; - - EFI_EVENT TimeoutCheckTimer; - EFI_EVENT MediaDetectTimer; - - UINT32 UnicastCount; - UINT32 BroadcastCount; - UINT32 MulticastCount; - UINT32 PromiscuousCount; - - // - // The size of the data buffer in the MNP_PACKET_BUFFER used to - // store a packet. - // - UINT32 BufferLength; - UINT32 PaddingSize; - NET_BUF *RxNbufCache; -} MNP_DEVICE_DATA; - -#define MNP_DEVICE_DATA_FROM_THIS(a) \ - CR ( \ - (a), \ - MNP_DEVICE_DATA, \ - VlanConfig, \ - MNP_DEVICE_DATA_SIGNATURE \ - ) - -#define MNP_SERVICE_DATA_SIGNATURE SIGNATURE_32 ('M', 'n', 'p', 'S') - -typedef struct { - UINT32 Signature; - - LIST_ENTRY Link; - - MNP_DEVICE_DATA *MnpDeviceData; - EFI_HANDLE ServiceHandle; - EFI_SERVICE_BINDING_PROTOCOL ServiceBinding; - EFI_DEVICE_PATH_PROTOCOL *DevicePath; - - LIST_ENTRY ChildrenList; - UINTN ChildrenNumber; - - UINT32 Mtu; - - UINT16 VlanId; - UINT8 Priority; -} MNP_SERVICE_DATA; - - -#define MNP_SERVICE_DATA_FROM_THIS(a) \ - CR ( \ - (a), \ - MNP_SERVICE_DATA, \ - ServiceBinding, \ - MNP_SERVICE_DATA_SIGNATURE \ - ) - -#define MNP_SERVICE_DATA_FROM_LINK(a) \ - CR ( \ - (a), \ - MNP_SERVICE_DATA, \ - Link, \ - MNP_SERVICE_DATA_SIGNATURE \ - ) - - -/** - Test to see if this driver supports ControllerHandle. This service - is called by the EFI boot service ConnectController(). In - order to make drivers as small as possible, there are a few calling - restrictions for this service. ConnectController() must - follow these calling restrictions. If any other agent wishes to call - Supported() it must also follow these calling restrictions. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to test. - @param[in] RemainingDevicePath Optional parameter use to pick a specific - child device to start. - - @retval EFI_SUCCESS This driver supports this device. - @retval EFI_ALREADY_STARTED This driver is already running on this device. - @retval Others This driver does not support this device. - -**/ -EFI_STATUS -EFIAPI -MnpDriverBindingSupported ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL - ); - -/** - Start this driver on ControllerHandle. This service is called by the - EFI boot service ConnectController(). In order to make drivers as small - as possible, there are a few calling restrictions for this service. - ConnectController() must follow these calling restrictions. If any other - agent wishes to call Start() it must also follow these calling restrictions. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to bind driver to. - @param[in] RemainingDevicePath Optional parameter use to pick a specific - child device to start. - - @retval EFI_SUCCESS This driver is added to ControllerHandle. - @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle. - @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for Mnp Service Data. - @retval Others This driver does not support this device. - -**/ -EFI_STATUS -EFIAPI -MnpDriverBindingStart ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL - ); - - -/** - Stop this driver on ControllerHandle. This service is called by the - EFI boot service DisconnectController(). In order to make drivers as - small as possible, there are a few calling restrictions for this service. - DisconnectController() must follow these calling restrictions. If any other - agent wishes to call Stop() it must also follow these calling restrictions. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to stop driver on. - @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If - number of children is zero stop the entire - bus driver. - @param[in] ChildHandleBuffer List of Child Handles to Stop. - - @retval EFI_SUCCESS This driver is removed ControllerHandle. - @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error. - -**/ -EFI_STATUS -EFIAPI -MnpDriverBindingStop ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN UINTN NumberOfChildren, - IN EFI_HANDLE *ChildHandleBuffer OPTIONAL - ); - -/** - Creates a child handle with a set of I/O services. - - @param[in] This Protocol instance pointer. - @param[in, out] ChildHandle Pointer to the handle of the child to create. If - it is NULL, then a new handle is created. If - it is not NULL, then the I/O services are added - to the existing child handle. - - @retval EFI_SUCCES The protocol was added to ChildHandle. - @retval EFI_INVALID_PARAMETER ChildHandle is NULL. - @retval EFI_OUT_OF_RESOURCES There are not enough resources available to - create the child. - @retval Others The child handle was not created. - -**/ -EFI_STATUS -EFIAPI -MnpServiceBindingCreateChild ( - IN EFI_SERVICE_BINDING_PROTOCOL *This, - IN OUT EFI_HANDLE *ChildHandle - ); - -/** - Destroys a child handle with a set of I/O services. - - The DestroyChild() function does the opposite of CreateChild(). It removes a - protocol that was installed by CreateChild() from ChildHandle. If the removed - protocol is the last protocol on ChildHandle, then ChildHandle is destroyed. - - @param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL - instance. - @param[in] ChildHandle Handle of the child to destroy. - - @retval EFI_SUCCES The protocol was removed from ChildHandle. - @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that - is being removed. - @retval EFI_INVALID_PARAMETER ChildHandle is NULL. - @retval EFI_ACCESS_DENIED The protocol could not be removed from the - ChildHandle because its services are being - used. - @retval Others The child handle was not destroyed. - -**/ -EFI_STATUS -EFIAPI -MnpServiceBindingDestroyChild ( - IN EFI_SERVICE_BINDING_PROTOCOL *This, - IN EFI_HANDLE ChildHandle - ); - -#endif diff --git a/MdeModulePkg/Universal/Network/MnpDxe/MnpDxe.inf b/MdeModulePkg/Universal/Network/MnpDxe/MnpDxe.inf deleted file mode 100644 index d4685b3e6a..0000000000 --- a/MdeModulePkg/Universal/Network/MnpDxe/MnpDxe.inf +++ /dev/null @@ -1,68 +0,0 @@ -## @file -# This module produces EFI MNP Protocol, EFI MNP Servie Binding Protocol and EFI VLAN Protocol. -# -# This module produces EFI Managed Network Protocol upon EFI Simple Network Protocol, -# to provide raw asynchronous network I/O services. It also produces EFI VLAN Protocol -# to provide manageability interface for VLAN configuration. -# -# Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-# SPDX-License-Identifier: BSD-2-Clause-Patent -# -## - -[Defines] - INF_VERSION = 0x00010005 - BASE_NAME = MnpDxe - MODULE_UNI_FILE = MnpDxe.uni - FILE_GUID = 025BBFC7-E6A9-4b8b-82AD-6815A1AEAF4A - MODULE_TYPE = UEFI_DRIVER - VERSION_STRING = 1.0 - ENTRY_POINT = MnpDriverEntryPoint - UNLOAD_IMAGE = NetLibDefaultUnload -# -# The following information is for reference only and not required by the build tools. -# -# VALID_ARCHITECTURES = IA32 X64 EBC -# -# DRIVER_BINDING = gMnpDriverBinding -# COMPONENT_NAME = gMnpComponentName -# COMPONENT_NAME2 = gMnpComponentName2 -# - -[Sources] - MnpMain.c - MnpIo.c - ComponentName.h - MnpDriver.h - ComponentName.c - MnpDriver.c - MnpConfig.c - MnpImpl.h - MnpVlan.h - MnpVlan.c - -[Packages] - MdePkg/MdePkg.dec - MdeModulePkg/MdeModulePkg.dec - -[LibraryClasses] - BaseLib - BaseMemoryLib - MemoryAllocationLib - UefiLib - UefiBootServicesTableLib - UefiDriverEntryPoint - DebugLib - NetLib - DpcLib - -[Protocols] - gEfiManagedNetworkServiceBindingProtocolGuid ## BY_START - gEfiSimpleNetworkProtocolGuid ## TO_START - gEfiManagedNetworkProtocolGuid ## BY_START - ## BY_START - ## UNDEFINED # variable - gEfiVlanConfigProtocolGuid - -[UserExtensions.TianoCore."ExtraFiles"] - MnpDxeExtra.uni diff --git a/MdeModulePkg/Universal/Network/MnpDxe/MnpDxe.uni b/MdeModulePkg/Universal/Network/MnpDxe/MnpDxe.uni deleted file mode 100644 index 04be3cd7fe..0000000000 --- a/MdeModulePkg/Universal/Network/MnpDxe/MnpDxe.uni +++ /dev/null @@ -1,18 +0,0 @@ -// /** @file -// This module produces EFI MNP Protocol, EFI MNP Servie Binding Protocol and EFI VLAN Protocol. -// -// This module produces EFI Managed Network Protocol upon EFI Simple Network Protocol, -// to provide raw asynchronous network I/O services. It also produces EFI VLAN Protocol -// to provide manageability interface for VLAN configuration. -// -// Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-// -// SPDX-License-Identifier: BSD-2-Clause-Patent -// -// **/ - - -#string STR_MODULE_ABSTRACT #language en-US "Produces EFI MNP Protocol, EFI MNP Servie Binding Protocol and EFI VLAN Protocol" - -#string STR_MODULE_DESCRIPTION #language en-US "This module produces EFI Managed Network Protocol upon EFI Simple Network Protocol to provide raw asynchronous network I/O services. It also produces EFI VLAN Protocol to provide manageability interface for VLAN configuration." - diff --git a/MdeModulePkg/Universal/Network/MnpDxe/MnpDxeExtra.uni b/MdeModulePkg/Universal/Network/MnpDxe/MnpDxeExtra.uni deleted file mode 100644 index 504ad2d8ad..0000000000 --- a/MdeModulePkg/Universal/Network/MnpDxe/MnpDxeExtra.uni +++ /dev/null @@ -1,14 +0,0 @@ -// /** @file -// MnpDxe Localized Strings and Content -// -// Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.
-// -// SPDX-License-Identifier: BSD-2-Clause-Patent -// -// **/ - -#string STR_PROPERTIES_MODULE_NAME -#language en-US -"MNP DXE Driver" - - diff --git a/MdeModulePkg/Universal/Network/MnpDxe/MnpImpl.h b/MdeModulePkg/Universal/Network/MnpDxe/MnpImpl.h deleted file mode 100644 index 7d54240346..0000000000 --- a/MdeModulePkg/Universal/Network/MnpDxe/MnpImpl.h +++ /dev/null @@ -1,898 +0,0 @@ -/** @file - Declaration of structures and functions of MnpDxe driver. - -Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef _MNP_IMPL_H_ -#define _MNP_IMPL_H_ - -#include "MnpDriver.h" - -#define NET_ETHER_FCS_SIZE 4 - -#define MNP_SYS_POLL_INTERVAL (10 * TICKS_PER_MS) // 10 milliseconds -#define MNP_TIMEOUT_CHECK_INTERVAL (50 * TICKS_PER_MS) // 50 milliseconds -#define MNP_MEDIA_DETECT_INTERVAL (500 * TICKS_PER_MS) // 500 milliseconds -#define MNP_TX_TIMEOUT_TIME (500 * TICKS_PER_MS) // 500 milliseconds -#define MNP_INIT_NET_BUFFER_NUM 512 -#define MNP_NET_BUFFER_INCREASEMENT 64 -#define MNP_MAX_NET_BUFFER_NUM 65536 -#define MNP_TX_BUFFER_INCREASEMENT 32 // Same as the recycling Q length for xmit_done in UNDI command. -#define MNP_MAX_TX_BUFFER_NUM 65536 - -#define MNP_MAX_RCVD_PACKET_QUE_SIZE 256 - -#define MNP_RECEIVE_UNICAST 0x01 -#define MNP_RECEIVE_BROADCAST 0x02 - -#define UNICAST_PACKET MNP_RECEIVE_UNICAST -#define BROADCAST_PACKET MNP_RECEIVE_BROADCAST - -#define MNP_INSTANCE_DATA_SIGNATURE SIGNATURE_32 ('M', 'n', 'p', 'I') - -#define MNP_INSTANCE_DATA_FROM_THIS(a) \ - CR ( \ - (a), \ - MNP_INSTANCE_DATA, \ - ManagedNetwork, \ - MNP_INSTANCE_DATA_SIGNATURE \ - ) - -typedef struct { - UINT32 Signature; - - MNP_SERVICE_DATA *MnpServiceData; - - EFI_HANDLE Handle; - - LIST_ENTRY InstEntry; - - EFI_MANAGED_NETWORK_PROTOCOL ManagedNetwork; - - BOOLEAN Configured; - BOOLEAN Destroyed; - - LIST_ENTRY GroupCtrlBlkList; - - NET_MAP RxTokenMap; - - LIST_ENTRY RxDeliveredPacketQueue; - LIST_ENTRY RcvdPacketQueue; - UINTN RcvdPacketQueueSize; - - EFI_MANAGED_NETWORK_CONFIG_DATA ConfigData; - - UINT8 ReceiveFilter; -} MNP_INSTANCE_DATA; - -typedef struct { - LIST_ENTRY AddrEntry; - EFI_MAC_ADDRESS Address; - INTN RefCnt; -} MNP_GROUP_ADDRESS; - -typedef struct { - LIST_ENTRY CtrlBlkEntry; - MNP_GROUP_ADDRESS *GroupAddress; -} MNP_GROUP_CONTROL_BLOCK; - -typedef struct { - LIST_ENTRY WrapEntry; - MNP_INSTANCE_DATA *Instance; - EFI_MANAGED_NETWORK_RECEIVE_DATA RxData; - NET_BUF *Nbuf; - UINT64 TimeoutTick; -} MNP_RXDATA_WRAP; - -#define MNP_TX_BUF_WRAP_SIGNATURE SIGNATURE_32 ('M', 'T', 'B', 'W') - -typedef struct { - UINT32 Signature; - LIST_ENTRY WrapEntry; // Link to FreeTxBufList - LIST_ENTRY AllEntry; // Link to AllTxBufList - BOOLEAN InUse; - UINT8 TxBuf[1]; -} MNP_TX_BUF_WRAP; - -/** - Initialize the mnp device context data. - - @param[in, out] MnpDeviceData Pointer to the mnp device context data. - @param[in] ImageHandle The driver image handle. - @param[in] ControllerHandle Handle of device to bind driver to. - - @retval EFI_SUCCESS The mnp service context is initialized. - @retval EFI_UNSUPPORTED ControllerHandle does not support Simple Network Protocol. - @retval Others Other errors as indicated. - -**/ -EFI_STATUS -MnpInitializeDeviceData ( - IN OUT MNP_DEVICE_DATA *MnpDeviceData, - IN EFI_HANDLE ImageHandle, - IN EFI_HANDLE ControllerHandle - ); - -/** - Destroy the MNP device context data. - - @param[in, out] MnpDeviceData Pointer to the mnp device context data. - @param[in] ImageHandle The driver image handle. - -**/ -VOID -MnpDestroyDeviceData ( - IN OUT MNP_DEVICE_DATA *MnpDeviceData, - IN EFI_HANDLE ImageHandle - ); - -/** - Create mnp service context data. - - @param[in] MnpDeviceData Pointer to the mnp device context data. - @param[in] VlanId The VLAN ID. - @param[in] Priority The VLAN priority. If VlanId is 0, - Priority is ignored. - - @return A pointer to MNP_SERVICE_DATA or NULL if failed to create MNP service context. - -**/ -MNP_SERVICE_DATA * -MnpCreateServiceData ( - IN MNP_DEVICE_DATA *MnpDeviceData, - IN UINT16 VlanId, - IN UINT8 Priority OPTIONAL - ); - -/** - Initialize the mnp service context data. - - @param[in, out] MnpServiceData Pointer to the mnp service context data. - @param[in] ImageHandle The driver image handle. - @param[in] ControllerHandle Handle of device to bind driver to. - - @retval EFI_SUCCESS The mnp service context is initialized. - @retval EFI_UNSUPPORTED ControllerHandle does not support Simple Network Protocol. - @retval Others Other errors as indicated. - -**/ -EFI_STATUS -MnpInitializeServiceData ( - IN OUT MNP_SERVICE_DATA *MnpServiceData, - IN EFI_HANDLE ImageHandle, - IN EFI_HANDLE ControllerHandle - ); - -/** - Destroy the MNP service context data. - - @param[in, out] MnpServiceData Pointer to the mnp service context data. - - @retval EFI_SUCCESS The mnp service context is destroyed. - @retval Others Errors as indicated. - -**/ -EFI_STATUS -MnpDestroyServiceData ( - IN OUT MNP_SERVICE_DATA *MnpServiceData - ); - -/** - Destroy all child of the MNP service data. - - @param[in, out] MnpServiceData Pointer to the mnp service context data. - - @retval EFI_SUCCESS All child are destroyed. - @retval Others Failed to destroy all child. - -**/ -EFI_STATUS -MnpDestroyServiceChild ( - IN OUT MNP_SERVICE_DATA *MnpServiceData - ); - -/** - Find the MNP Service Data for given VLAN ID. - - @param[in] MnpDeviceData Pointer to the mnp device context data. - @param[in] VlanId The VLAN ID. - - @return A pointer to MNP_SERVICE_DATA or NULL if not found. - -**/ -MNP_SERVICE_DATA * -MnpFindServiceData ( - IN MNP_DEVICE_DATA *MnpDeviceData, - IN UINT16 VlanId - ); - -/** - Initialize the mnp instance context data. - - @param[in] MnpServiceData Pointer to the mnp service context data. - @param[in, out] Instance Pointer to the mnp instance context data - to initialize. - -**/ -VOID -MnpInitializeInstanceData ( - IN MNP_SERVICE_DATA *MnpServiceData, - IN OUT MNP_INSTANCE_DATA *Instance - ); - -/** - Check whether the token specified by Arg matches the token in Item. - - @param[in] Map Pointer to the NET_MAP. - @param[in] Item Pointer to the NET_MAP_ITEM. - @param[in] Arg Pointer to the Arg, it's a pointer to the token to - check. - - @retval EFI_SUCCESS The token specified by Arg is different from the - token in Item. - @retval EFI_ACCESS_DENIED The token specified by Arg is the same as that in - Item. - -**/ -EFI_STATUS -EFIAPI -MnpTokenExist ( - IN NET_MAP *Map, - IN NET_MAP_ITEM *Item, - IN VOID *Arg - ); - -/** - Cancel the token specified by Arg if it matches the token in Item. - - @param[in, out] Map Pointer to the NET_MAP. - @param[in, out] Item Pointer to the NET_MAP_ITEM. - @param[in] Arg Pointer to the Arg, it's a pointer to the - token to cancel. - - @retval EFI_SUCCESS The Arg is NULL, and the token in Item is cancelled, - or the Arg isn't NULL, and the token in Item is - different from the Arg. - @retval EFI_ABORTED The Arg isn't NULL, the token in Item mathces the - Arg, and the token is cancelled. - -**/ -EFI_STATUS -EFIAPI -MnpCancelTokens ( - IN OUT NET_MAP *Map, - IN OUT NET_MAP_ITEM *Item, - IN VOID *Arg - ); - -/** - Flush the instance's received data. - - @param[in, out] Instance Pointer to the mnp instance context data. - -**/ -VOID -MnpFlushRcvdDataQueue ( - IN OUT MNP_INSTANCE_DATA *Instance - ); - -/** - Configure the Instance using ConfigData. - - @param[in, out] Instance Pointer to the mnp instance context data. - @param[in] ConfigData Pointer to the configuration data used to configure - the isntance. - - @retval EFI_SUCCESS The Instance is configured. - @retval EFI_UNSUPPORTED EnableReceiveTimestamps is on and the - implementation doesn't support it. - @retval Others Other errors as indicated. - -**/ -EFI_STATUS -MnpConfigureInstance ( - IN OUT MNP_INSTANCE_DATA *Instance, - IN EFI_MANAGED_NETWORK_CONFIG_DATA *ConfigData OPTIONAL - ); - -/** - Do the group operations for this instance. - - @param[in, out] Instance Pointer to the instance context data. - @param[in] JoinFlag Set to TRUE to join a group. Set to TRUE to - leave a group/groups. - @param[in] MacAddress Pointer to the group address to join or leave. - @param[in] CtrlBlk Pointer to the group control block if JoinFlag - is FALSE. - - @retval EFI_SUCCESS The group operation finished. - @retval EFI_OUT_OF_RESOURCES Failed due to lack of memory resources. - @retval Others Other errors as indicated. - -**/ -EFI_STATUS -MnpGroupOp ( - IN OUT MNP_INSTANCE_DATA *Instance, - IN BOOLEAN JoinFlag, - IN EFI_MAC_ADDRESS *MacAddress OPTIONAL, - IN MNP_GROUP_CONTROL_BLOCK *CtrlBlk OPTIONAL - ); - -/** - Validates the Mnp transmit token. - - @param[in] Instance Pointer to the Mnp instance context data. - @param[in] Token Pointer to the transmit token to check. - - @return The Token is valid or not. - -**/ -BOOLEAN -MnpIsValidTxToken ( - IN MNP_INSTANCE_DATA *Instance, - IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN *Token - ); - -/** - Build the packet to transmit from the TxData passed in. - - @param[in] MnpServiceData Pointer to the mnp service context data. - @param[in] TxData Pointer to the transmit data containing the information - to build the packet. - @param[out] PktBuf Pointer to record the address of the packet. - @param[out] PktLen Pointer to a UINT32 variable used to record the packet's - length. - - @retval EFI_SUCCESS TxPackage is built. - @retval EFI_OUT_OF_RESOURCES The deliver fails due to lack of memory resource. - -**/ -EFI_STATUS -MnpBuildTxPacket ( - IN MNP_SERVICE_DATA *MnpServiceData, - IN EFI_MANAGED_NETWORK_TRANSMIT_DATA *TxData, - OUT UINT8 **PktBuf, - OUT UINT32 *PktLen - ); - -/** - Synchronously send out the packet. - - This functon places the packet buffer to SNP driver's tansmit queue. The packet - can be considered successfully sent out once SNP acccetp the packet, while the - packet buffer recycle is deferred for better performance. - - @param[in] MnpServiceData Pointer to the mnp service context data. - @param[in] Packet Pointer to the pakcet buffer. - @param[in] Length The length of the packet. - @param[in, out] Token Pointer to the token the packet generated from. - - @retval EFI_SUCCESS The packet is sent out. - @retval EFI_TIMEOUT Time out occurs, the packet isn't sent. - @retval EFI_DEVICE_ERROR An unexpected network error occurs. - -**/ -EFI_STATUS -MnpSyncSendPacket ( - IN MNP_SERVICE_DATA *MnpServiceData, - IN UINT8 *Packet, - IN UINT32 Length, - IN OUT EFI_MANAGED_NETWORK_COMPLETION_TOKEN *Token - ); - -/** - Try to deliver the received packet to the instance. - - @param[in, out] Instance Pointer to the mnp instance context data. - - @retval EFI_SUCCESS The received packet is delivered, or there is no - packet to deliver, or there is no available receive - token. - @retval EFI_OUT_OF_RESOURCES The deliver fails due to lack of memory resource. - -**/ -EFI_STATUS -MnpInstanceDeliverPacket ( - IN OUT MNP_INSTANCE_DATA *Instance - ); - -/** - Recycle the RxData and other resources used to hold and deliver the received - packet. - - @param[in] Event The event this notify function registered to. - @param[in] Context Pointer to the context data registerd to the Event. - -**/ -VOID -EFIAPI -MnpRecycleRxData ( - IN EFI_EVENT Event, - IN VOID *Context - ); - -/** - Try to receive a packet and deliver it. - - @param[in, out] MnpDeviceData Pointer to the mnp device context data. - - @retval EFI_SUCCESS add return value to function comment - @retval EFI_NOT_STARTED The simple network protocol is not started. - @retval EFI_NOT_READY No packet received. - @retval EFI_DEVICE_ERROR An unexpected error occurs. - -**/ -EFI_STATUS -MnpReceivePacket ( - IN OUT MNP_DEVICE_DATA *MnpDeviceData - ); - -/** - Allocate a free NET_BUF from MnpDeviceData->FreeNbufQue. If there is none - in the queue, first try to allocate some and add them into the queue, then - fetch the NET_BUF from the updated FreeNbufQue. - - @param[in, out] MnpDeviceData Pointer to the MNP_DEVICE_DATA. - - @return Pointer to the allocated free NET_BUF structure, if NULL the - operation is failed. - -**/ -NET_BUF * -MnpAllocNbuf ( - IN OUT MNP_DEVICE_DATA *MnpDeviceData - ); - -/** - Try to reclaim the Nbuf into the buffer pool. - - @param[in, out] MnpDeviceData Pointer to the mnp device context data. - @param[in, out] Nbuf Pointer to the NET_BUF to free. - -**/ -VOID -MnpFreeNbuf ( - IN OUT MNP_DEVICE_DATA *MnpDeviceData, - IN OUT NET_BUF *Nbuf - ); - -/** - Allocate a free TX buffer from MnpDeviceData->FreeTxBufList. If there is none - in the queue, first try to recycle some from SNP, then try to allocate some and add - them into the queue, then fetch the NET_BUF from the updated FreeTxBufList. - - @param[in, out] MnpDeviceData Pointer to the MNP_DEVICE_DATA. - - @return Pointer to the allocated free NET_BUF structure, if NULL the - operation is failed. - -**/ -UINT8 * -MnpAllocTxBuf ( - IN OUT MNP_DEVICE_DATA *MnpDeviceData - ); - -/** - Try to recycle all the transmitted buffer address from SNP. - - @param[in, out] MnpDeviceData Pointer to the mnp device context data. - - @retval EFI_SUCCESS Successed to recyclethe transmitted buffer address. - @retval Others Failed to recyclethe transmitted buffer address. - -**/ -EFI_STATUS -MnpRecycleTxBuf ( - IN OUT MNP_DEVICE_DATA *MnpDeviceData - ); - -/** - Remove the received packets if timeout occurs. - - @param[in] Event The event this notify function registered to. - @param[in] Context Pointer to the context data registered to the event. - -**/ -VOID -EFIAPI -MnpCheckPacketTimeout ( - IN EFI_EVENT Event, - IN VOID *Context - ); - -/** - Poll to update MediaPresent field in SNP ModeData by Snp.GetStatus(). - - @param[in] Event The event this notify function registered to. - @param[in] Context Pointer to the context data registered to the event. - -**/ -VOID -EFIAPI -MnpCheckMediaStatus ( - IN EFI_EVENT Event, - IN VOID *Context - ); - -/** - Poll to receive the packets from Snp. This function is either called by upperlayer - protocols/applications or the system poll timer notify mechanism. - - @param[in] Event The event this notify function registered to. - @param[in] Context Pointer to the context data registered to the event. - -**/ -VOID -EFIAPI -MnpSystemPoll ( - IN EFI_EVENT Event, - IN VOID *Context - ); - -/** - Returns the operational parameters for the current MNP child driver. May also - support returning the underlying SNP driver mode data. - - The GetModeData() function is used to read the current mode data (operational - parameters) from the MNP or the underlying SNP. - - @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. - @param[out] MnpConfigData Pointer to storage for MNP operational parameters. Type - EFI_MANAGED_NETWORK_CONFIG_DATA is defined in "Related - Definitions" below. - @param[out] SnpModeData Pointer to storage for SNP operational parameters. This - feature may be unsupported. Type EFI_SIMPLE_NETWORK_MODE - is defined in the EFI_SIMPLE_NETWORK_PROTOCOL. - - @retval EFI_SUCCESS The operation completed successfully. - @retval EFI_INVALID_PARAMETER This is NULL. - @retval EFI_UNSUPPORTED The requested feature is unsupported in this - MNP implementation. - @retval EFI_NOT_STARTED This MNP child driver instance has not been - configured. The default values are returned in - MnpConfigData if it is not NULL. - @retval Others The mode data could not be read. - -**/ -EFI_STATUS -EFIAPI -MnpGetModeData ( - IN EFI_MANAGED_NETWORK_PROTOCOL *This, - OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL, - OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL - ); - -/** - Sets or clears the operational parameters for the MNP child driver. - - The Configure() function is used to set, change, or reset the operational - parameters for the MNP child driver instance. Until the operational parameters - have been set, no network traffic can be sent or received by this MNP child - driver instance. Once the operational parameters have been reset, no more - traffic can be sent or received until the operational parameters have been set - again. - Each MNP child driver instance can be started and stopped independently of - each other by setting or resetting their receive filter settings with the - Configure() function. - After any successful call to Configure(), the MNP child driver instance is - started. The internal periodic timer (if supported) is enabled. Data can be - transmitted and may be received if the receive filters have also been enabled. - Note: If multiple MNP child driver instances will receive the same packet - because of overlapping receive filter settings, then the first MNP child - driver instance will receive the original packet and additional instances will - receive copies of the original packet. - Note: Warning: Receive filter settings that overlap will consume extra - processor and/or DMA resources and degrade system and network performance. - - @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. - @param[in] MnpConfigData Pointer to configuration data that will be assigned - to the MNP child driver instance. If NULL, the MNP - child driver instance is reset to startup defaults - and all pending transmit and receive requests are - flushed. Type EFI_MANAGED_NETWORK_CONFIG_DATA is - defined in EFI_MANAGED_NETWORK_PROTOCOL.GetModeData(). - - @retval EFI_SUCCESS The operation completed successfully. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is - TRUE: - * This is NULL. - * MnpConfigData.ProtocolTypeFilter is not - valid. - The operational data for the MNP child driver - instance is unchanged. - @retval EFI_OUT_OF_RESOURCES Required system resources (usually memory) - could not be allocated. - The MNP child driver instance has been reset to - startup defaults. - @retval EFI_UNSUPPORTED The requested feature is unsupported in - this [MNP] implementation. The operational data - for the MNP child driver instance is unchanged. - @retval EFI_DEVICE_ERROR An unexpected network or system error - occurred. The MNP child driver instance has - been reset to startup defaults. - @retval Others The MNP child driver instance has been reset to - startup defaults. - -**/ -EFI_STATUS -EFIAPI -MnpConfigure ( - IN EFI_MANAGED_NETWORK_PROTOCOL *This, - IN EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL - ); - -/** - Translates an IP multicast address to a hardware (MAC) multicast address. This - function may be unsupported in some MNP implementations. - - The McastIpToMac() function translates an IP multicast address to a hardware - (MAC) multicast address. This function may be implemented by calling the - underlying EFI_SIMPLE_NETWORK. MCastIpToMac() function, which may also be - unsupported in some MNP implementations. - - @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. - @param[in] Ipv6Flag Set to TRUE to if IpAddress is an IPv6 multicast address. - Set to FALSE if IpAddress is an IPv4 multicast address. - @param[in] IpAddress Pointer to the multicast IP address (in network byte - order) to convert. - @param[out] MacAddress Pointer to the resulting multicast MAC address. - - @retval EFI_SUCCESS The operation completed successfully. - @retval EFI_INVALID_PARAMETER One of the following conditions is TRUE: - * This is NULL. - * IpAddress is NULL. - * IpAddress is not a valid multicast IP - address. - * MacAddress is NULL. - @retval EFI_NOT_STARTED This MNP child driver instance has not been - configured. - @retval EFI_UNSUPPORTED The requested feature is unsupported in this - MNP implementation. - @retval EFI_DEVICE_ERROR An unexpected network or system error occurred. - @retval Others The address could not be converted. -**/ -EFI_STATUS -EFIAPI -MnpMcastIpToMac ( - IN EFI_MANAGED_NETWORK_PROTOCOL *This, - IN BOOLEAN Ipv6Flag, - IN EFI_IP_ADDRESS *IpAddress, - OUT EFI_MAC_ADDRESS *MacAddress - ); - -/** - Enables and disables receive filters for multicast address. This function may - be unsupported in some MNP implementations. - - The Groups() function only adds and removes multicast MAC addresses from the - filter list. The MNP driver does not transmit or process Internet Group - Management Protocol (IGMP) packets. If JoinFlag is FALSE and MacAddress is - NULL, then all joined groups are left. - - @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. - @param[in] JoinFlag Set to TRUE to join this multicast group. - Set to FALSE to leave this multicast group. - @param[in] MacAddress Pointer to the multicast MAC group (address) to join or - leave. - - @retval EFI_SUCCESS The requested operation completed successfully. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - * This is NULL. - * JoinFlag is TRUE and MacAddress is NULL. - * MacAddress is not a valid multicast MAC - address. - * The MNP multicast group settings are - unchanged. - @retval EFI_NOT_STARTED This MNP child driver instance has not been - configured. - @retval EFI_ALREADY_STARTED The supplied multicast group is already joined. - @retval EFI_NOT_FOUND The supplied multicast group is not joined. - @retval EFI_DEVICE_ERROR An unexpected network or system error occurred. - The MNP child driver instance has been reset to - startup defaults. - @retval EFI_UNSUPPORTED The requested feature is unsupported in this MNP - implementation. - @retval Others The requested operation could not be completed. - The MNP multicast group settings are unchanged. - -**/ -EFI_STATUS -EFIAPI -MnpGroups ( - IN EFI_MANAGED_NETWORK_PROTOCOL *This, - IN BOOLEAN JoinFlag, - IN EFI_MAC_ADDRESS *MacAddress OPTIONAL - ); - -/** - Places asynchronous outgoing data packets into the transmit queue. - - The Transmit() function places a completion token into the transmit packet - queue. This function is always asynchronous. - The caller must fill in the Token.Event and Token.TxData fields in the - completion token, and these fields cannot be NULL. When the transmit operation - completes, the MNP updates the Token.Status field and the Token.Event is - signaled. - Note: There may be a performance penalty if the packet needs to be - defragmented before it can be transmitted by the network device. Systems in - which performance is critical should review the requirements and features of - the underlying communications device and drivers. - - - @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. - @param[in] Token Pointer to a token associated with the transmit data - descriptor. Type EFI_MANAGED_NETWORK_COMPLETION_TOKEN - is defined in "Related Definitions" below. - - @retval EFI_SUCCESS The transmit completion token was cached. - @retval EFI_NOT_STARTED This MNP child driver instance has not been - configured. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is - TRUE: - * This is NULL. - * Token is NULL. - * Token.Event is NULL. - * Token.TxData is NULL. - * Token.TxData.DestinationAddress is not - NULL and Token.TxData.HeaderLength is zero. - * Token.TxData.FragmentCount is zero. - * (Token.TxData.HeaderLength + - Token.TxData.DataLength) is not equal to the - sum of the - Token.TxData.FragmentTable[].FragmentLength - fields. - * One or more of the - Token.TxData.FragmentTable[].FragmentLength - fields is zero. - * One or more of the - Token.TxData.FragmentTable[].FragmentBufferfields - is NULL. - * Token.TxData.DataLength is greater than MTU. - @retval EFI_ACCESS_DENIED The transmit completion token is already in the - transmit queue. - @retval EFI_OUT_OF_RESOURCES The transmit data could not be queued due to a - lack of system resources (usually memory). - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. - The MNP child driver instance has been reset to - startup defaults. - @retval EFI_NOT_READY The transmit request could not be queued because - the transmit queue is full. - -**/ -EFI_STATUS -EFIAPI -MnpTransmit ( - IN EFI_MANAGED_NETWORK_PROTOCOL *This, - IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN *Token - ); - -/** - Aborts an asynchronous transmit or receive request. - - The Cancel() function is used to abort a pending transmit or receive request. - If the token is in the transmit or receive request queues, after calling this - function, Token.Status will be set to EFI_ABORTED and then Token.Event will be - signaled. If the token is not in one of the queues, which usually means that - the asynchronous operation has completed, this function will not signal the - token and EFI_NOT_FOUND is returned. - - @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. - @param[in] Token Pointer to a token that has been issued by - EFI_MANAGED_NETWORK_PROTOCOL.Transmit() or - EFI_MANAGED_NETWORK_PROTOCOL.Receive(). If NULL, all - pending tokens are aborted. - - @retval EFI_SUCCESS The asynchronous I/O request was aborted and - Token.Event was signaled. When Token is NULL, - all pending requests were aborted and their - events were signaled. - @retval EFI_NOT_STARTED This MNP child driver instance has not been - configured. - @retval EFI_INVALID_PARAMETER This is NULL. - @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O - request was not found in the transmit or - receive queue. It has either completed or was - not issued by Transmit() and Receive(). - -**/ -EFI_STATUS -EFIAPI -MnpCancel ( - IN EFI_MANAGED_NETWORK_PROTOCOL *This, - IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN *Token OPTIONAL - ); - -/** - Places an asynchronous receiving request into the receiving queue. - - The Receive() function places a completion token into the receive packet - queue. This function is always asynchronous. - The caller must fill in the Token.Event field in the completion token, and - this field cannot be NULL. When the receive operation completes, the MNP - updates the Token.Status and Token.RxData fields and the Token.Event is - signaled. - - @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. - @param[in] Token Pointer to a token associated with the receive - data descriptor. Type - EFI_MANAGED_NETWORK_COMPLETION_TOKEN is defined in - EFI_MANAGED_NETWORK_PROTOCOL.Transmit(). - - @retval EFI_SUCCESS The receive completion token was cached. - @retval EFI_NOT_STARTED This MNP child driver instance has not been - configured. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is - TRUE: - * This is NULL. - * Token is NULL. - * Token.Event is NULL - @retval EFI_OUT_OF_RESOURCES The transmit data could not be queued due to a - lack of system resources (usually memory). - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. - The MNP child driver instance has been reset to - startup defaults. - @retval EFI_ACCESS_DENIED The receive completion token was already in the - receive queue. - @retval EFI_NOT_READY The receive request could not be queued because - the receive queue is full. - -**/ -EFI_STATUS -EFIAPI -MnpReceive ( - IN EFI_MANAGED_NETWORK_PROTOCOL *This, - IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN *Token - ); - -/** - Polls for incoming data packets and processes outgoing data packets. - - The Poll() function can be used by network drivers and applications to - increase the rate that data packets are moved between the communications - device and the transmit and receive queues. - Normally, a periodic timer event internally calls the Poll() function. But, in - some systems, the periodic timer event may not call Poll() fast enough to - transmit and/or receive all data packets without missing packets. Drivers and - applications that are experiencing packet loss should try calling the Poll() - function more often. - - @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. - - @retval EFI_SUCCESS Incoming or outgoing data was processed. - @retval EFI_NOT_STARTED This MNP child driver instance has not been - configured. - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The - MNP child driver instance has been reset to startup - defaults. - @retval EFI_NOT_READY No incoming or outgoing data was processed. Consider - increasing the polling rate. - @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive - queue. Consider increasing the polling rate. - -**/ -EFI_STATUS -EFIAPI -MnpPoll ( - IN EFI_MANAGED_NETWORK_PROTOCOL *This - ); - -/** - Configure the Snp receive filters according to the instances' receive filter - settings. - - @param[in] MnpDeviceData Pointer to the mnp device context data. - - @retval EFI_SUCCESS The receive filters is configured. - @retval EFI_OUT_OF_RESOURCES The receive filters can't be configured due - to lack of memory resource. - -**/ -EFI_STATUS -MnpConfigReceiveFilters ( - IN MNP_DEVICE_DATA *MnpDeviceData - ); - -#endif diff --git a/MdeModulePkg/Universal/Network/MnpDxe/MnpIo.c b/MdeModulePkg/Universal/Network/MnpDxe/MnpIo.c deleted file mode 100644 index 56405d62b5..0000000000 --- a/MdeModulePkg/Universal/Network/MnpDxe/MnpIo.c +++ /dev/null @@ -1,1133 +0,0 @@ -/** @file - Implementation of Managed Network Protocol I/O functions. - -Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "MnpImpl.h" -#include "MnpVlan.h" - -/** - Validates the Mnp transmit token. - - @param[in] Instance Pointer to the Mnp instance context data. - @param[in] Token Pointer to the transmit token to check. - - @return The Token is valid or not. - -**/ -BOOLEAN -MnpIsValidTxToken ( - IN MNP_INSTANCE_DATA *Instance, - IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN *Token - ) -{ - MNP_SERVICE_DATA *MnpServiceData; - EFI_MANAGED_NETWORK_TRANSMIT_DATA *TxData; - UINT32 Index; - UINT32 TotalLength; - EFI_MANAGED_NETWORK_FRAGMENT_DATA *FragmentTable; - - MnpServiceData = Instance->MnpServiceData; - NET_CHECK_SIGNATURE (MnpServiceData, MNP_SERVICE_DATA_SIGNATURE); - - TxData = Token->Packet.TxData; - - if ((Token->Event == NULL) || (TxData == NULL) || (TxData->FragmentCount == 0)) { - // - // The token is invalid if the Event is NULL, or the TxData is NULL, or - // the fragment count is zero. - // - DEBUG ((EFI_D_WARN, "MnpIsValidTxToken: Invalid Token.\n")); - return FALSE; - } - - if ((TxData->DestinationAddress != NULL) && (TxData->HeaderLength != 0)) { - // - // The token is invalid if the HeaderLength isn't zero while the DestinationAddress - // is NULL (The destination address is already put into the packet). - // - DEBUG ((EFI_D_WARN, "MnpIsValidTxToken: DestinationAddress isn't NULL, HeaderLength must be 0.\n")); - return FALSE; - } - - TotalLength = 0; - FragmentTable = TxData->FragmentTable; - for (Index = 0; Index < TxData->FragmentCount; Index++) { - - if ((FragmentTable[Index].FragmentLength == 0) || (FragmentTable[Index].FragmentBuffer == NULL)) { - // - // The token is invalid if any FragmentLength is zero or any FragmentBuffer is NULL. - // - DEBUG ((EFI_D_WARN, "MnpIsValidTxToken: Invalid FragmentLength or FragmentBuffer.\n")); - return FALSE; - } - - TotalLength += FragmentTable[Index].FragmentLength; - } - - if ((TxData->DestinationAddress == NULL) && (FragmentTable[0].FragmentLength < TxData->HeaderLength)) { - // - // Media header is split between fragments. - // - return FALSE; - } - - if (TotalLength != (TxData->DataLength + TxData->HeaderLength)) { - // - // The length calculated from the fragment information doesn't equal to the - // sum of the DataLength and the HeaderLength. - // - DEBUG ((EFI_D_WARN, "MnpIsValidTxData: Invalid Datalength compared with the sum of fragment length.\n")); - return FALSE; - } - - if (TxData->DataLength > MnpServiceData->Mtu) { - // - // The total length is larger than the MTU. - // - DEBUG ((EFI_D_WARN, "MnpIsValidTxData: TxData->DataLength exceeds Mtu.\n")); - return FALSE; - } - - return TRUE; -} - -/** - Build the packet to transmit from the TxData passed in. - - @param[in] MnpServiceData Pointer to the mnp service context data. - @param[in] TxData Pointer to the transmit data containing the information - to build the packet. - @param[out] PktBuf Pointer to record the address of the packet. - @param[out] PktLen Pointer to a UINT32 variable used to record the packet's - length. - - @retval EFI_SUCCESS TxPackage is built. - @retval EFI_OUT_OF_RESOURCES The deliver fails due to lack of memory resource. - -**/ -EFI_STATUS -MnpBuildTxPacket ( - IN MNP_SERVICE_DATA *MnpServiceData, - IN EFI_MANAGED_NETWORK_TRANSMIT_DATA *TxData, - OUT UINT8 **PktBuf, - OUT UINT32 *PktLen - ) -{ - EFI_SIMPLE_NETWORK_MODE *SnpMode; - UINT8 *DstPos; - UINT16 Index; - MNP_DEVICE_DATA *MnpDeviceData; - UINT8 *TxBuf; - - MnpDeviceData = MnpServiceData->MnpDeviceData; - - TxBuf = MnpAllocTxBuf (MnpDeviceData); - if (TxBuf == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - // - // Reserve space for vlan tag if needed. - // - if (MnpServiceData->VlanId != 0) { - *PktBuf = TxBuf + NET_VLAN_TAG_LEN; - } else { - *PktBuf = TxBuf; - } - - if ((TxData->DestinationAddress == NULL) && (TxData->FragmentCount == 1)) { - CopyMem ( - *PktBuf, - TxData->FragmentTable[0].FragmentBuffer, - TxData->FragmentTable[0].FragmentLength - ); - - *PktLen = TxData->FragmentTable[0].FragmentLength; - } else { - // - // Either media header isn't in FragmentTable or there is more than - // one fragment, copy the data into the packet buffer. Reserve the - // media header space if necessary. - // - SnpMode = MnpDeviceData->Snp->Mode; - DstPos = *PktBuf; - *PktLen = 0; - if (TxData->DestinationAddress != NULL) { - // - // If dest address is not NULL, move DstPos to reserve space for the - // media header. Add the media header length to buflen. - // - DstPos += SnpMode->MediaHeaderSize; - *PktLen += SnpMode->MediaHeaderSize; - } - - for (Index = 0; Index < TxData->FragmentCount; Index++) { - // - // Copy the data. - // - CopyMem ( - DstPos, - TxData->FragmentTable[Index].FragmentBuffer, - TxData->FragmentTable[Index].FragmentLength - ); - DstPos += TxData->FragmentTable[Index].FragmentLength; - } - - // - // Set the buffer length. - // - *PktLen += TxData->DataLength + TxData->HeaderLength; - } - - return EFI_SUCCESS; -} - - -/** - Synchronously send out the packet. - - This functon places the packet buffer to SNP driver's tansmit queue. The packet - can be considered successfully sent out once SNP acccetp the packet, while the - packet buffer recycle is deferred for better performance. - - @param[in] MnpServiceData Pointer to the mnp service context data. - @param[in] Packet Pointer to the pakcet buffer. - @param[in] Length The length of the packet. - @param[in, out] Token Pointer to the token the packet generated from. - - @retval EFI_SUCCESS The packet is sent out. - @retval EFI_TIMEOUT Time out occurs, the packet isn't sent. - @retval EFI_DEVICE_ERROR An unexpected network error occurs. - -**/ -EFI_STATUS -MnpSyncSendPacket ( - IN MNP_SERVICE_DATA *MnpServiceData, - IN UINT8 *Packet, - IN UINT32 Length, - IN OUT EFI_MANAGED_NETWORK_COMPLETION_TOKEN *Token - ) -{ - EFI_STATUS Status; - EFI_SIMPLE_NETWORK_PROTOCOL *Snp; - EFI_MANAGED_NETWORK_TRANSMIT_DATA *TxData; - UINT32 HeaderSize; - MNP_DEVICE_DATA *MnpDeviceData; - UINT16 ProtocolType; - - MnpDeviceData = MnpServiceData->MnpDeviceData; - Snp = MnpDeviceData->Snp; - TxData = Token->Packet.TxData; - Token->Status = EFI_SUCCESS; - HeaderSize = Snp->Mode->MediaHeaderSize - TxData->HeaderLength; - - // - // Check media status before transmit packet. - // Note: media status will be updated by periodic timer MediaDetectTimer. - // - if (Snp->Mode->MediaPresentSupported && !Snp->Mode->MediaPresent) { - // - // Media not present, skip packet transmit and report EFI_NO_MEDIA - // - DEBUG ((EFI_D_WARN, "MnpSyncSendPacket: No network cable detected.\n")); - Token->Status = EFI_NO_MEDIA; - goto SIGNAL_TOKEN; - } - - - if (MnpServiceData->VlanId != 0) { - // - // Insert VLAN tag - // - MnpInsertVlanTag (MnpServiceData, TxData, &ProtocolType, &Packet, &Length); - } else { - ProtocolType = TxData->ProtocolType; - } - - // - // Transmit the packet through SNP. - // - Status = Snp->Transmit ( - Snp, - HeaderSize, - Length, - Packet, - TxData->SourceAddress, - TxData->DestinationAddress, - &ProtocolType - ); - if (Status == EFI_NOT_READY) { - Status = MnpRecycleTxBuf (MnpDeviceData); - if (EFI_ERROR (Status)) { - Token->Status = EFI_DEVICE_ERROR; - goto SIGNAL_TOKEN; - } - - Status = Snp->Transmit ( - Snp, - HeaderSize, - Length, - Packet, - TxData->SourceAddress, - TxData->DestinationAddress, - &ProtocolType - ); - } - - if (EFI_ERROR (Status)) { - Token->Status = EFI_DEVICE_ERROR; - } - -SIGNAL_TOKEN: - - gBS->SignalEvent (Token->Event); - - // - // Dispatch the DPC queued by the NotifyFunction of Token->Event. - // - DispatchDpc (); - - return EFI_SUCCESS; -} - - -/** - Try to deliver the received packet to the instance. - - @param[in, out] Instance Pointer to the mnp instance context data. - - @retval EFI_SUCCESS The received packet is delivered, or there is no - packet to deliver, or there is no available receive - token. - @retval EFI_OUT_OF_RESOURCES The deliver fails due to lack of memory resource. - -**/ -EFI_STATUS -MnpInstanceDeliverPacket ( - IN OUT MNP_INSTANCE_DATA *Instance - ) -{ - MNP_DEVICE_DATA *MnpDeviceData; - MNP_RXDATA_WRAP *RxDataWrap; - NET_BUF *DupNbuf; - EFI_MANAGED_NETWORK_RECEIVE_DATA *RxData; - EFI_SIMPLE_NETWORK_MODE *SnpMode; - EFI_MANAGED_NETWORK_COMPLETION_TOKEN *RxToken; - - MnpDeviceData = Instance->MnpServiceData->MnpDeviceData; - NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); - - if (NetMapIsEmpty (&Instance->RxTokenMap) || IsListEmpty (&Instance->RcvdPacketQueue)) { - // - // No pending received data or no available receive token, return. - // - return EFI_SUCCESS; - } - - ASSERT (Instance->RcvdPacketQueueSize != 0); - - RxDataWrap = NET_LIST_HEAD (&Instance->RcvdPacketQueue, MNP_RXDATA_WRAP, WrapEntry); - if (RxDataWrap->Nbuf->RefCnt > 2) { - // - // There are other instances share this Nbuf, duplicate to get a - // copy to allow the instance to do R/W operations. - // - DupNbuf = MnpAllocNbuf (MnpDeviceData); - if (DupNbuf == NULL) { - DEBUG ((EFI_D_WARN, "MnpDeliverPacket: Failed to allocate a free Nbuf.\n")); - - return EFI_OUT_OF_RESOURCES; - } - - // - // Duplicate the net buffer. - // - NetbufDuplicate (RxDataWrap->Nbuf, DupNbuf, 0); - MnpFreeNbuf (MnpDeviceData, RxDataWrap->Nbuf); - RxDataWrap->Nbuf = DupNbuf; - } - - // - // All resources are OK, remove the packet from the queue. - // - NetListRemoveHead (&Instance->RcvdPacketQueue); - Instance->RcvdPacketQueueSize--; - - RxData = &RxDataWrap->RxData; - SnpMode = MnpDeviceData->Snp->Mode; - - // - // Set all the buffer pointers. - // - RxData->MediaHeader = NetbufGetByte (RxDataWrap->Nbuf, 0, NULL); - RxData->DestinationAddress = RxData->MediaHeader; - RxData->SourceAddress = (UINT8 *) RxData->MediaHeader + SnpMode->HwAddressSize; - RxData->PacketData = (UINT8 *) RxData->MediaHeader + SnpMode->MediaHeaderSize; - - // - // Insert this RxDataWrap into the delivered queue. - // - InsertTailList (&Instance->RxDeliveredPacketQueue, &RxDataWrap->WrapEntry); - - // - // Get the receive token from the RxTokenMap. - // - RxToken = NetMapRemoveHead (&Instance->RxTokenMap, NULL); - - // - // Signal this token's event. - // - RxToken->Packet.RxData = &RxDataWrap->RxData; - RxToken->Status = EFI_SUCCESS; - gBS->SignalEvent (RxToken->Event); - - return EFI_SUCCESS; -} - - -/** - Deliver the received packet for the instances belonging to the MnpServiceData. - - @param[in] MnpServiceData Pointer to the mnp service context data. - -**/ -VOID -MnpDeliverPacket ( - IN MNP_SERVICE_DATA *MnpServiceData - ) -{ - LIST_ENTRY *Entry; - MNP_INSTANCE_DATA *Instance; - - NET_CHECK_SIGNATURE (MnpServiceData, MNP_SERVICE_DATA_SIGNATURE); - - NET_LIST_FOR_EACH (Entry, &MnpServiceData->ChildrenList) { - Instance = NET_LIST_USER_STRUCT (Entry, MNP_INSTANCE_DATA, InstEntry); - NET_CHECK_SIGNATURE (Instance, MNP_INSTANCE_DATA_SIGNATURE); - - // - // Try to deliver packet for this instance. - // - MnpInstanceDeliverPacket (Instance); - } -} - - -/** - Recycle the RxData and other resources used to hold and deliver the received - packet. - - @param[in] Event The event this notify function registered to. - @param[in] Context Pointer to the context data registerd to the Event. - -**/ -VOID -EFIAPI -MnpRecycleRxData ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - MNP_RXDATA_WRAP *RxDataWrap; - MNP_DEVICE_DATA *MnpDeviceData; - - ASSERT (Context != NULL); - - RxDataWrap = (MNP_RXDATA_WRAP *) Context; - NET_CHECK_SIGNATURE (RxDataWrap->Instance, MNP_INSTANCE_DATA_SIGNATURE); - - ASSERT (RxDataWrap->Nbuf != NULL); - - MnpDeviceData = RxDataWrap->Instance->MnpServiceData->MnpDeviceData; - NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); - - // - // Free this Nbuf. - // - MnpFreeNbuf (MnpDeviceData, RxDataWrap->Nbuf); - RxDataWrap->Nbuf = NULL; - - // - // Close the recycle event. - // - gBS->CloseEvent (RxDataWrap->RxData.RecycleEvent); - - // - // Remove this Wrap entry from the list. - // - RemoveEntryList (&RxDataWrap->WrapEntry); - - FreePool (RxDataWrap); -} - - -/** - Queue the received packet into instance's receive queue. - - @param[in, out] Instance Pointer to the mnp instance context data. - @param[in, out] RxDataWrap Pointer to the Wrap structure containing the - received data and other information. -**/ -VOID -MnpQueueRcvdPacket ( - IN OUT MNP_INSTANCE_DATA *Instance, - IN OUT MNP_RXDATA_WRAP *RxDataWrap - ) -{ - MNP_RXDATA_WRAP *OldRxDataWrap; - - NET_CHECK_SIGNATURE (Instance, MNP_INSTANCE_DATA_SIGNATURE); - - // - // Check the queue size. If it exceeds the limit, drop one packet - // from the head. - // - if (Instance->RcvdPacketQueueSize == MNP_MAX_RCVD_PACKET_QUE_SIZE) { - - DEBUG ((EFI_D_WARN, "MnpQueueRcvdPacket: Drop one packet bcz queue size limit reached.\n")); - - // - // Get the oldest packet. - // - OldRxDataWrap = NET_LIST_HEAD ( - &Instance->RcvdPacketQueue, - MNP_RXDATA_WRAP, - WrapEntry - ); - - // - // Recycle this OldRxDataWrap, this entry will be removed by the callee. - // - MnpRecycleRxData (NULL, (VOID *) OldRxDataWrap); - Instance->RcvdPacketQueueSize--; - } - - // - // Update the timeout tick using the configured parameter. - // - RxDataWrap->TimeoutTick = Instance->ConfigData.ReceivedQueueTimeoutValue; - - // - // Insert this Wrap into the instance queue. - // - InsertTailList (&Instance->RcvdPacketQueue, &RxDataWrap->WrapEntry); - Instance->RcvdPacketQueueSize++; -} - - -/** - Match the received packet with the instance receive filters. - - @param[in] Instance Pointer to the mnp instance context data. - @param[in] RxData Pointer to the EFI_MANAGED_NETWORK_RECEIVE_DATA. - @param[in] GroupAddress Pointer to the GroupAddress, the GroupAddress is - non-NULL and it contains the destination multicast - mac address of the received packet if the packet - destinated to a multicast mac address. - @param[in] PktAttr The received packets attribute. - - @return The received packet matches the instance's receive filters or not. - -**/ -BOOLEAN -MnpMatchPacket ( - IN MNP_INSTANCE_DATA *Instance, - IN EFI_MANAGED_NETWORK_RECEIVE_DATA *RxData, - IN MNP_GROUP_ADDRESS *GroupAddress OPTIONAL, - IN UINT8 PktAttr - ) -{ - EFI_MANAGED_NETWORK_CONFIG_DATA *ConfigData; - LIST_ENTRY *Entry; - MNP_GROUP_CONTROL_BLOCK *GroupCtrlBlk; - - NET_CHECK_SIGNATURE (Instance, MNP_INSTANCE_DATA_SIGNATURE); - - ConfigData = &Instance->ConfigData; - - // - // Check the protocol type. - // - if ((ConfigData->ProtocolTypeFilter != 0) && (ConfigData->ProtocolTypeFilter != RxData->ProtocolType)) { - return FALSE; - } - - if (ConfigData->EnablePromiscuousReceive) { - // - // Always match if this instance is configured to be promiscuous. - // - return TRUE; - } - - // - // The protocol type is matched, check receive filter, include unicast and broadcast. - // - if ((Instance->ReceiveFilter & PktAttr) != 0) { - return TRUE; - } - - // - // Check multicast addresses. - // - if (ConfigData->EnableMulticastReceive && RxData->MulticastFlag) { - - ASSERT (GroupAddress != NULL); - - NET_LIST_FOR_EACH (Entry, &Instance->GroupCtrlBlkList) { - - GroupCtrlBlk = NET_LIST_USER_STRUCT (Entry, MNP_GROUP_CONTROL_BLOCK, CtrlBlkEntry); - if (GroupCtrlBlk->GroupAddress == GroupAddress) { - // - // The instance is configured to receiveing packets destinated to this - // multicast address. - // - return TRUE; - } - } - } - - // - // No match. - // - return FALSE; -} - - -/** - Analyse the received packets. - - @param[in] MnpServiceData Pointer to the mnp service context data. - @param[in] Nbuf Pointer to the net buffer holding the received - packet. - @param[in, out] RxData Pointer to the buffer used to save the analysed - result in EFI_MANAGED_NETWORK_RECEIVE_DATA. - @param[out] GroupAddress Pointer to pointer to a MNP_GROUP_ADDRESS used to - pass out the address of the multicast address the - received packet destinated to. - @param[out] PktAttr Pointer to the buffer used to save the analysed - packet attribute. - -**/ -VOID -MnpAnalysePacket ( - IN MNP_SERVICE_DATA *MnpServiceData, - IN NET_BUF *Nbuf, - IN OUT EFI_MANAGED_NETWORK_RECEIVE_DATA *RxData, - OUT MNP_GROUP_ADDRESS **GroupAddress, - OUT UINT8 *PktAttr - ) -{ - EFI_SIMPLE_NETWORK_MODE *SnpMode; - MNP_DEVICE_DATA *MnpDeviceData; - UINT8 *BufPtr; - LIST_ENTRY *Entry; - - MnpDeviceData = MnpServiceData->MnpDeviceData; - SnpMode = MnpDeviceData->Snp->Mode; - - // - // Get the packet buffer. - // - BufPtr = NetbufGetByte (Nbuf, 0, NULL); - ASSERT (BufPtr != NULL); - - // - // Set the initial values. - // - RxData->BroadcastFlag = FALSE; - RxData->MulticastFlag = FALSE; - RxData->PromiscuousFlag = FALSE; - *PktAttr = UNICAST_PACKET; - - if (!NET_MAC_EQUAL (&SnpMode->CurrentAddress, BufPtr, SnpMode->HwAddressSize)) { - // - // This packet isn't destinated to our current mac address, it't not unicast. - // - *PktAttr = 0; - - if (NET_MAC_EQUAL (&SnpMode->BroadcastAddress, BufPtr, SnpMode->HwAddressSize)) { - // - // It's broadcast. - // - RxData->BroadcastFlag = TRUE; - *PktAttr = BROADCAST_PACKET; - } else if ((*BufPtr & 0x01) == 0x1) { - // - // It's multicast, try to match the multicast filters. - // - NET_LIST_FOR_EACH (Entry, &MnpDeviceData->GroupAddressList) { - - *GroupAddress = NET_LIST_USER_STRUCT (Entry, MNP_GROUP_ADDRESS, AddrEntry); - if (NET_MAC_EQUAL (BufPtr, &((*GroupAddress)->Address), SnpMode->HwAddressSize)) { - RxData->MulticastFlag = TRUE; - break; - } - } - - if (!RxData->MulticastFlag) { - // - // No match, set GroupAddress to NULL. This multicast packet must - // be the result of PROMISUCOUS or PROMISUCOUS_MULTICAST flag is on. - // - *GroupAddress = NULL; - RxData->PromiscuousFlag = TRUE; - - if (MnpDeviceData->PromiscuousCount == 0) { - // - // Skip the below code, there is no receiver of this packet. - // - return ; - } - } - } else { - RxData->PromiscuousFlag = TRUE; - } - } - - ZeroMem (&RxData->Timestamp, sizeof (EFI_TIME)); - - // - // Fill the common parts of RxData. - // - RxData->PacketLength = Nbuf->TotalSize; - RxData->HeaderLength = SnpMode->MediaHeaderSize; - RxData->AddressLength = SnpMode->HwAddressSize; - RxData->DataLength = RxData->PacketLength - RxData->HeaderLength; - RxData->ProtocolType = NTOHS (*(UINT16 *) (BufPtr + 2 * SnpMode->HwAddressSize)); -} - - -/** - Wrap the RxData. - - @param[in] Instance Pointer to the mnp instance context data. - @param[in] RxData Pointer to the receive data to wrap. - - @return Pointer to a MNP_RXDATA_WRAP which wraps the RxData. - -**/ -MNP_RXDATA_WRAP * -MnpWrapRxData ( - IN MNP_INSTANCE_DATA *Instance, - IN EFI_MANAGED_NETWORK_RECEIVE_DATA *RxData - ) -{ - EFI_STATUS Status; - MNP_RXDATA_WRAP *RxDataWrap; - - // - // Allocate memory. - // - RxDataWrap = AllocatePool (sizeof (MNP_RXDATA_WRAP)); - if (RxDataWrap == NULL) { - DEBUG ((EFI_D_ERROR, "MnpDispatchPacket: Failed to allocate a MNP_RXDATA_WRAP.\n")); - return NULL; - } - - RxDataWrap->Instance = Instance; - - // - // Fill the RxData in RxDataWrap, - // - CopyMem (&RxDataWrap->RxData, RxData, sizeof (RxDataWrap->RxData)); - - // - // Create the recycle event. - // - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, - MnpRecycleRxData, - RxDataWrap, - &RxDataWrap->RxData.RecycleEvent - ); - if (EFI_ERROR (Status)) { - DEBUG ((EFI_D_ERROR, "MnpDispatchPacket: gBS->CreateEvent failed, %r.\n", Status)); - - FreePool (RxDataWrap); - return NULL; - } - - return RxDataWrap; -} - - -/** - Enqueue the received the packets to the instances belonging to the - MnpServiceData. - - @param[in] MnpServiceData Pointer to the mnp service context data. - @param[in] Nbuf Pointer to the net buffer representing the received - packet. - -**/ -VOID -MnpEnqueuePacket ( - IN MNP_SERVICE_DATA *MnpServiceData, - IN NET_BUF *Nbuf - ) -{ - LIST_ENTRY *Entry; - MNP_INSTANCE_DATA *Instance; - EFI_MANAGED_NETWORK_RECEIVE_DATA RxData; - UINT8 PktAttr; - MNP_GROUP_ADDRESS *GroupAddress; - MNP_RXDATA_WRAP *RxDataWrap; - - - GroupAddress = NULL; - // - // First, analyse the packet header. - // - MnpAnalysePacket (MnpServiceData, Nbuf, &RxData, &GroupAddress, &PktAttr); - - if (RxData.PromiscuousFlag && (MnpServiceData->MnpDeviceData->PromiscuousCount == 0)) { - // - // No receivers, no more action need. - // - return ; - } - - // - // Iterate the children to find match. - // - NET_LIST_FOR_EACH (Entry, &MnpServiceData->ChildrenList) { - - Instance = NET_LIST_USER_STRUCT (Entry, MNP_INSTANCE_DATA, InstEntry); - NET_CHECK_SIGNATURE (Instance, MNP_INSTANCE_DATA_SIGNATURE); - - if (!Instance->Configured) { - continue; - } - - // - // Check the packet against the instance receive filters. - // - if (MnpMatchPacket (Instance, &RxData, GroupAddress, PktAttr)) { - // - // Wrap the RxData. - // - RxDataWrap = MnpWrapRxData (Instance, &RxData); - if (RxDataWrap == NULL) { - continue; - } - - // - // Associate RxDataWrap with Nbuf and increase the RefCnt. - // - RxDataWrap->Nbuf = Nbuf; - NET_GET_REF (RxDataWrap->Nbuf); - - // - // Queue the packet into the instance queue. - // - MnpQueueRcvdPacket (Instance, RxDataWrap); - } - } -} - - -/** - Try to receive a packet and deliver it. - - @param[in, out] MnpDeviceData Pointer to the mnp device context data. - - @retval EFI_SUCCESS add return value to function comment - @retval EFI_NOT_STARTED The simple network protocol is not started. - @retval EFI_NOT_READY No packet received. - @retval EFI_DEVICE_ERROR An unexpected error occurs. - -**/ -EFI_STATUS -MnpReceivePacket ( - IN OUT MNP_DEVICE_DATA *MnpDeviceData - ) -{ - EFI_STATUS Status; - EFI_SIMPLE_NETWORK_PROTOCOL *Snp; - NET_BUF *Nbuf; - UINT8 *BufPtr; - UINTN BufLen; - UINTN HeaderSize; - UINT32 Trimmed; - MNP_SERVICE_DATA *MnpServiceData; - UINT16 VlanId; - BOOLEAN IsVlanPacket; - - NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); - - Snp = MnpDeviceData->Snp; - if (Snp->Mode->State != EfiSimpleNetworkInitialized) { - // - // The simple network protocol is not started. - // - return EFI_NOT_STARTED; - } - - if (MnpDeviceData->RxNbufCache == NULL) { - // - // Try to get a new buffer as there may be buffers recycled. - // - MnpDeviceData->RxNbufCache = MnpAllocNbuf (MnpDeviceData); - - if (MnpDeviceData->RxNbufCache == NULL) { - // - // No available buffer in the buffer pool. - // - return EFI_DEVICE_ERROR; - } - - NetbufAllocSpace ( - MnpDeviceData->RxNbufCache, - MnpDeviceData->BufferLength, - NET_BUF_TAIL - ); - } - - Nbuf = MnpDeviceData->RxNbufCache; - BufLen = Nbuf->TotalSize; - BufPtr = NetbufGetByte (Nbuf, 0, NULL); - ASSERT (BufPtr != NULL); - - // - // Receive packet through Snp. - // - Status = Snp->Receive (Snp, &HeaderSize, &BufLen, BufPtr, NULL, NULL, NULL); - if (EFI_ERROR (Status)) { - DEBUG_CODE ( - if (Status != EFI_NOT_READY) { - DEBUG ((EFI_D_WARN, "MnpReceivePacket: Snp->Receive() = %r.\n", Status)); - } - ); - - return Status; - } - - // - // Sanity check. - // - if ((HeaderSize != Snp->Mode->MediaHeaderSize) || (BufLen < HeaderSize)) { - DEBUG ( - (EFI_D_WARN, - "MnpReceivePacket: Size error, HL:TL = %d:%d.\n", - HeaderSize, - BufLen) - ); - return EFI_DEVICE_ERROR; - } - - Trimmed = 0; - if (Nbuf->TotalSize != BufLen) { - // - // Trim the packet from tail. - // - Trimmed = NetbufTrim (Nbuf, Nbuf->TotalSize - (UINT32) BufLen, NET_BUF_TAIL); - ASSERT (Nbuf->TotalSize == BufLen); - } - - VlanId = 0; - if (MnpDeviceData->NumberOfVlan != 0) { - // - // VLAN is configured, remove the VLAN tag if any - // - IsVlanPacket = MnpRemoveVlanTag (MnpDeviceData, Nbuf, &VlanId); - } else { - IsVlanPacket = FALSE; - } - - MnpServiceData = MnpFindServiceData (MnpDeviceData, VlanId); - if (MnpServiceData == NULL) { - // - // VLAN is not set for this tagged frame, ignore this packet - // - if (Trimmed > 0) { - NetbufAllocSpace (Nbuf, Trimmed, NET_BUF_TAIL); - } - - if (IsVlanPacket) { - NetbufAllocSpace (Nbuf, NET_VLAN_TAG_LEN, NET_BUF_HEAD); - } - - goto EXIT; - } - - // - // Enqueue the packet to the matched instances. - // - MnpEnqueuePacket (MnpServiceData, Nbuf); - - if (Nbuf->RefCnt > 2) { - // - // RefCnt > 2 indicates there is at least one receiver of this packet. - // Free the current RxNbufCache and allocate a new one. - // - MnpFreeNbuf (MnpDeviceData, Nbuf); - - Nbuf = MnpAllocNbuf (MnpDeviceData); - MnpDeviceData->RxNbufCache = Nbuf; - if (Nbuf == NULL) { - DEBUG ((EFI_D_ERROR, "MnpReceivePacket: Alloc packet for receiving cache failed.\n")); - return EFI_DEVICE_ERROR; - } - - NetbufAllocSpace (Nbuf, MnpDeviceData->BufferLength, NET_BUF_TAIL); - } else { - // - // No receiver for this packet. - // - if (Trimmed > 0) { - NetbufAllocSpace (Nbuf, Trimmed, NET_BUF_TAIL); - } - if (IsVlanPacket) { - NetbufAllocSpace (Nbuf, NET_VLAN_TAG_LEN, NET_BUF_HEAD); - } - - goto EXIT; - } - // - // Deliver the queued packets. - // - MnpDeliverPacket (MnpServiceData); - -EXIT: - - ASSERT (Nbuf->TotalSize == MnpDeviceData->BufferLength); - - return Status; -} - - -/** - Remove the received packets if timeout occurs. - - @param[in] Event The event this notify function registered to. - @param[in] Context Pointer to the context data registered to the event. - -**/ -VOID -EFIAPI -MnpCheckPacketTimeout ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - MNP_DEVICE_DATA *MnpDeviceData; - MNP_SERVICE_DATA *MnpServiceData; - LIST_ENTRY *Entry; - LIST_ENTRY *ServiceEntry; - LIST_ENTRY *RxEntry; - LIST_ENTRY *NextEntry; - MNP_INSTANCE_DATA *Instance; - MNP_RXDATA_WRAP *RxDataWrap; - EFI_TPL OldTpl; - - MnpDeviceData = (MNP_DEVICE_DATA *) Context; - NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); - - NET_LIST_FOR_EACH (ServiceEntry, &MnpDeviceData->ServiceList) { - MnpServiceData = MNP_SERVICE_DATA_FROM_LINK (ServiceEntry); - - NET_LIST_FOR_EACH (Entry, &MnpServiceData->ChildrenList) { - - Instance = NET_LIST_USER_STRUCT (Entry, MNP_INSTANCE_DATA, InstEntry); - NET_CHECK_SIGNATURE (Instance, MNP_INSTANCE_DATA_SIGNATURE); - - if (!Instance->Configured || (Instance->ConfigData.ReceivedQueueTimeoutValue == 0)) { - // - // This instance is not configured or there is no receive time out, - // just skip to the next instance. - // - continue; - } - - OldTpl = gBS->RaiseTPL (TPL_NOTIFY); - - NET_LIST_FOR_EACH_SAFE (RxEntry, NextEntry, &Instance->RcvdPacketQueue) { - - RxDataWrap = NET_LIST_USER_STRUCT (RxEntry, MNP_RXDATA_WRAP, WrapEntry); - - // - // TimeoutTick unit is microsecond, MNP_TIMEOUT_CHECK_INTERVAL unit is 100ns. - // - if (RxDataWrap->TimeoutTick >= (MNP_TIMEOUT_CHECK_INTERVAL / 10)) { - RxDataWrap->TimeoutTick -= (MNP_TIMEOUT_CHECK_INTERVAL / 10); - } else { - // - // Drop the timeout packet. - // - DEBUG ((EFI_D_WARN, "MnpCheckPacketTimeout: Received packet timeout.\n")); - MnpRecycleRxData (NULL, RxDataWrap); - Instance->RcvdPacketQueueSize--; - } - } - - gBS->RestoreTPL (OldTpl); - } - } -} - -/** - Poll to update MediaPresent field in SNP ModeData by Snp->GetStatus(). - - @param[in] Event The event this notify function registered to. - @param[in] Context Pointer to the context data registered to the event. - -**/ -VOID -EFIAPI -MnpCheckMediaStatus ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - MNP_DEVICE_DATA *MnpDeviceData; - EFI_SIMPLE_NETWORK_PROTOCOL *Snp; - UINT32 InterruptStatus; - - MnpDeviceData = (MNP_DEVICE_DATA *) Context; - NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); - - Snp = MnpDeviceData->Snp; - if (Snp->Mode->MediaPresentSupported) { - // - // Upon successful return of GetStatus(), the MediaPresent field of - // EFI_SIMPLE_NETWORK_MODE will be updated to reflect any change of media status - // - Snp->GetStatus (Snp, &InterruptStatus, NULL); - } -} - -/** - Poll to receive the packets from Snp. This function is either called by upperlayer - protocols/applications or the system poll timer notify mechanism. - - @param[in] Event The event this notify function registered to. - @param[in] Context Pointer to the context data registered to the event. - -**/ -VOID -EFIAPI -MnpSystemPoll ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - MNP_DEVICE_DATA *MnpDeviceData; - - MnpDeviceData = (MNP_DEVICE_DATA *) Context; - NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); - - // - // Try to receive packets from Snp. - // - MnpReceivePacket (MnpDeviceData); - - // - // Dispatch the DPC queued by the NotifyFunction of rx token's events. - // - DispatchDpc (); -} diff --git a/MdeModulePkg/Universal/Network/MnpDxe/MnpMain.c b/MdeModulePkg/Universal/Network/MnpDxe/MnpMain.c deleted file mode 100644 index d96178a1d9..0000000000 --- a/MdeModulePkg/Universal/Network/MnpDxe/MnpMain.c +++ /dev/null @@ -1,789 +0,0 @@ -/** @file - Implementation of Managed Network Protocol public services. - -Copyright (c) 2005 - 2016, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "MnpImpl.h" - -/** - Returns the operational parameters for the current MNP child driver. May also - support returning the underlying SNP driver mode data. - - The GetModeData() function is used to read the current mode data (operational - parameters) from the MNP or the underlying SNP. - - @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. - @param[out] MnpConfigData Pointer to storage for MNP operational parameters. Type - EFI_MANAGED_NETWORK_CONFIG_DATA is defined in "Related - Definitions" below. - @param[out] SnpModeData Pointer to storage for SNP operational parameters. This - feature may be unsupported. Type EFI_SIMPLE_NETWORK_MODE - is defined in the EFI_SIMPLE_NETWORK_PROTOCOL. - - @retval EFI_SUCCESS The operation completed successfully. - @retval EFI_INVALID_PARAMETER This is NULL. - @retval EFI_UNSUPPORTED The requested feature is unsupported in this - MNP implementation. - @retval EFI_NOT_STARTED This MNP child driver instance has not been - configured. The default values are returned in - MnpConfigData if it is not NULL. - @retval Others The mode data could not be read. - -**/ -EFI_STATUS -EFIAPI -MnpGetModeData ( - IN EFI_MANAGED_NETWORK_PROTOCOL *This, - OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL, - OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL - ) -{ - MNP_INSTANCE_DATA *Instance; - EFI_SIMPLE_NETWORK_PROTOCOL *Snp; - EFI_TPL OldTpl; - EFI_STATUS Status; - UINT32 InterruptStatus; - - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - Instance = MNP_INSTANCE_DATA_FROM_THIS (This); - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - if (MnpConfigData != NULL) { - // - // Copy the instance configuration data. - // - CopyMem (MnpConfigData, &Instance->ConfigData, sizeof (*MnpConfigData)); - } - - if (SnpModeData != NULL) { - // - // Copy the underlayer Snp mode data. - // - Snp = Instance->MnpServiceData->MnpDeviceData->Snp; - - // - // Upon successful return of GetStatus(), the Snp->Mode->MediaPresent - // will be updated to reflect any change of media status - // - Snp->GetStatus (Snp, &InterruptStatus, NULL); - CopyMem (SnpModeData, Snp->Mode, sizeof (*SnpModeData)); - } - - if (!Instance->Configured) { - Status = EFI_NOT_STARTED; - } else { - Status = EFI_SUCCESS; - } - - gBS->RestoreTPL (OldTpl); - - return Status; -} - - -/** - Sets or clears the operational parameters for the MNP child driver. - - The Configure() function is used to set, change, or reset the operational - parameters for the MNP child driver instance. Until the operational parameters - have been set, no network traffic can be sent or received by this MNP child - driver instance. Once the operational parameters have been reset, no more - traffic can be sent or received until the operational parameters have been set - again. - Each MNP child driver instance can be started and stopped independently of - each other by setting or resetting their receive filter settings with the - Configure() function. - After any successful call to Configure(), the MNP child driver instance is - started. The internal periodic timer (if supported) is enabled. Data can be - transmitted and may be received if the receive filters have also been enabled. - Note: If multiple MNP child driver instances will receive the same packet - because of overlapping receive filter settings, then the first MNP child - driver instance will receive the original packet and additional instances will - receive copies of the original packet. - Note: Warning: Receive filter settings that overlap will consume extra - processor and/or DMA resources and degrade system and network performance. - - @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. - @param[in] MnpConfigData Pointer to configuration data that will be assigned - to the MNP child driver instance. If NULL, the MNP - child driver instance is reset to startup defaults - and all pending transmit and receive requests are - flushed. Type EFI_MANAGED_NETWORK_CONFIG_DATA is - defined in EFI_MANAGED_NETWORK_PROTOCOL.GetModeData(). - - @retval EFI_SUCCESS The operation completed successfully. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is - TRUE: - * This is NULL. - * MnpConfigData.ProtocolTypeFilter is not - valid. - The operational data for the MNP child driver - instance is unchanged. - @retval EFI_OUT_OF_RESOURCES Required system resources (usually memory) - could not be allocated. - The MNP child driver instance has been reset to - startup defaults. - @retval EFI_UNSUPPORTED The requested feature is unsupported in - this [MNP] implementation. The operational data - for the MNP child driver instance is unchanged. - @retval EFI_DEVICE_ERROR An unexpected network or system error - occurred. The MNP child driver instance has - been reset to startup defaults. - @retval Others The MNP child driver instance has been reset to - startup defaults. - -**/ -EFI_STATUS -EFIAPI -MnpConfigure ( - IN EFI_MANAGED_NETWORK_PROTOCOL *This, - IN EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL - ) -{ - MNP_INSTANCE_DATA *Instance; - EFI_TPL OldTpl; - EFI_STATUS Status; - - if ((This == NULL) || - ((MnpConfigData != NULL) && - (MnpConfigData->ProtocolTypeFilter > 0) && - (MnpConfigData->ProtocolTypeFilter <= 1500)) - ) { - return EFI_INVALID_PARAMETER; - } - - Instance = MNP_INSTANCE_DATA_FROM_THIS (This); - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - if ((MnpConfigData == NULL) && (!Instance->Configured)) { - // - // If the instance is not configured and a reset is requested, just return. - // - Status = EFI_SUCCESS; - goto ON_EXIT; - } - - // - // Configure the instance. - // - Status = MnpConfigureInstance (Instance, MnpConfigData); - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - - return Status; -} - - -/** - Translates an IP multicast address to a hardware (MAC) multicast address. This - function may be unsupported in some MNP implementations. - - The McastIpToMac() function translates an IP multicast address to a hardware - (MAC) multicast address. This function may be implemented by calling the - underlying EFI_SIMPLE_NETWORK. MCastIpToMac() function, which may also be - unsupported in some MNP implementations. - - @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. - @param[in] Ipv6Flag Set to TRUE to if IpAddress is an IPv6 multicast address. - Set to FALSE if IpAddress is an IPv4 multicast address. - @param[in] IpAddress Pointer to the multicast IP address (in network byte - order) to convert. - @param[out] MacAddress Pointer to the resulting multicast MAC address. - - @retval EFI_SUCCESS The operation completed successfully. - @retval EFI_INVALID_PARAMETER One of the following conditions is TRUE: - * This is NULL. - * IpAddress is NULL. - * IpAddress is not a valid multicast IP - address. - * MacAddress is NULL. - @retval EFI_NOT_STARTED This MNP child driver instance has not been - configured. - @retval EFI_UNSUPPORTED The requested feature is unsupported in this - MNP implementation. - @retval EFI_DEVICE_ERROR An unexpected network or system error occurred. - @retval Others The address could not be converted. -**/ -EFI_STATUS -EFIAPI -MnpMcastIpToMac ( - IN EFI_MANAGED_NETWORK_PROTOCOL *This, - IN BOOLEAN Ipv6Flag, - IN EFI_IP_ADDRESS *IpAddress, - OUT EFI_MAC_ADDRESS *MacAddress - ) -{ - EFI_STATUS Status; - MNP_INSTANCE_DATA *Instance; - EFI_SIMPLE_NETWORK_PROTOCOL *Snp; - EFI_TPL OldTpl; - EFI_IPv6_ADDRESS *Ip6Address; - - if ((This == NULL) || (IpAddress == NULL) || (MacAddress == NULL)) { - return EFI_INVALID_PARAMETER; - } - - Ip6Address = &IpAddress->v6; - - if ((Ipv6Flag && !IP6_IS_MULTICAST (Ip6Address)) || - (!Ipv6Flag && !IP4_IS_MULTICAST (EFI_NTOHL (*IpAddress))) - ) { - // - // The IP address passed in is not a multicast address. - // - return EFI_INVALID_PARAMETER; - } - - Instance = MNP_INSTANCE_DATA_FROM_THIS (This); - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - if (!Instance->Configured) { - - Status = EFI_NOT_STARTED; - goto ON_EXIT; - } - - Snp = Instance->MnpServiceData->MnpDeviceData->Snp; - ASSERT (Snp != NULL); - - ZeroMem (MacAddress, sizeof (EFI_MAC_ADDRESS)); - - if (Snp->Mode->IfType == NET_IFTYPE_ETHERNET) { - if (!Ipv6Flag) { - // - // Translate the IPv4 address into a multicast MAC address if the NIC is an - // ethernet NIC according to RFC1112.. - // - MacAddress->Addr[0] = 0x01; - MacAddress->Addr[1] = 0x00; - MacAddress->Addr[2] = 0x5E; - MacAddress->Addr[3] = (UINT8) (IpAddress->v4.Addr[1] & 0x7F); - MacAddress->Addr[4] = IpAddress->v4.Addr[2]; - MacAddress->Addr[5] = IpAddress->v4.Addr[3]; - } else { - // - // Translate the IPv6 address into a multicast MAC address if the NIC is an - // ethernet NIC according to RFC2464. - // - - MacAddress->Addr[0] = 0x33; - MacAddress->Addr[1] = 0x33; - MacAddress->Addr[2] = Ip6Address->Addr[12]; - MacAddress->Addr[3] = Ip6Address->Addr[13]; - MacAddress->Addr[4] = Ip6Address->Addr[14]; - MacAddress->Addr[5] = Ip6Address->Addr[15]; - } - - Status = EFI_SUCCESS; - } else { - // - // Invoke Snp to translate the multicast IP address. - // - Status = Snp->MCastIpToMac ( - Snp, - Ipv6Flag, - IpAddress, - MacAddress - ); - } - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - - return Status; -} - -/** - Enables and disables receive filters for multicast address. This function may - be unsupported in some MNP implementations. - - The Groups() function only adds and removes multicast MAC addresses from the - filter list. The MNP driver does not transmit or process Internet Group - Management Protocol (IGMP) packets. If JoinFlag is FALSE and MacAddress is - NULL, then all joined groups are left. - - @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. - @param[in] JoinFlag Set to TRUE to join this multicast group. - Set to FALSE to leave this multicast group. - @param[in] MacAddress Pointer to the multicast MAC group (address) to join or - leave. - - @retval EFI_SUCCESS The requested operation completed successfully. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - * This is NULL. - * JoinFlag is TRUE and MacAddress is NULL. - * MacAddress is not a valid multicast MAC - address. - * The MNP multicast group settings are - unchanged. - @retval EFI_NOT_STARTED This MNP child driver instance has not been - configured. - @retval EFI_ALREADY_STARTED The supplied multicast group is already joined. - @retval EFI_NOT_FOUND The supplied multicast group is not joined. - @retval EFI_DEVICE_ERROR An unexpected network or system error occurred. - The MNP child driver instance has been reset to - startup defaults. - @retval EFI_UNSUPPORTED The requested feature is unsupported in this MNP - implementation. - @retval Others The requested operation could not be completed. - The MNP multicast group settings are unchanged. - -**/ -EFI_STATUS -EFIAPI -MnpGroups ( - IN EFI_MANAGED_NETWORK_PROTOCOL *This, - IN BOOLEAN JoinFlag, - IN EFI_MAC_ADDRESS *MacAddress OPTIONAL - ) -{ - MNP_INSTANCE_DATA *Instance; - EFI_SIMPLE_NETWORK_MODE *SnpMode; - MNP_GROUP_CONTROL_BLOCK *GroupCtrlBlk; - MNP_GROUP_ADDRESS *GroupAddress; - LIST_ENTRY *ListEntry; - BOOLEAN AddressExist; - EFI_TPL OldTpl; - EFI_STATUS Status; - - if (This == NULL || (JoinFlag && (MacAddress == NULL))) { - // - // This is NULL, or it's a join operation but MacAddress is NULL. - // - return EFI_INVALID_PARAMETER; - } - - Instance = MNP_INSTANCE_DATA_FROM_THIS (This); - SnpMode = Instance->MnpServiceData->MnpDeviceData->Snp->Mode; - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - if (!Instance->Configured) { - Status = EFI_NOT_STARTED; - goto ON_EXIT; - } - - if ((!Instance->ConfigData.EnableMulticastReceive) || - ((MacAddress != NULL) && !NET_MAC_IS_MULTICAST (MacAddress, &SnpMode->BroadcastAddress, SnpMode->HwAddressSize))) { - // - // The instance isn't configured to do mulitcast receive. OR - // the passed in MacAddress is not a mutlticast mac address. - // - Status = EFI_INVALID_PARAMETER; - goto ON_EXIT; - } - - Status = EFI_SUCCESS; - AddressExist = FALSE; - GroupCtrlBlk = NULL; - - if (MacAddress != NULL) { - // - // Search the instance's GroupCtrlBlkList to find the specific address. - // - NET_LIST_FOR_EACH (ListEntry, &Instance->GroupCtrlBlkList) { - - GroupCtrlBlk = NET_LIST_USER_STRUCT ( - ListEntry, - MNP_GROUP_CONTROL_BLOCK, - CtrlBlkEntry - ); - GroupAddress = GroupCtrlBlk->GroupAddress; - if (0 == CompareMem ( - MacAddress, - &GroupAddress->Address, - SnpMode->HwAddressSize - )) { - // - // There is already the same multicast mac address configured. - // - AddressExist = TRUE; - break; - } - } - - if (JoinFlag && AddressExist) { - // - // The multicast mac address to join already exists. - // - Status = EFI_ALREADY_STARTED; - } - - if (!JoinFlag && !AddressExist) { - // - // The multicast mac address to leave doesn't exist in this instance. - // - Status = EFI_NOT_FOUND; - } - - if (EFI_ERROR (Status)) { - goto ON_EXIT; - } - } else if (IsListEmpty (&Instance->GroupCtrlBlkList)) { - // - // The MacAddress is NULL and there is no configured multicast mac address, - // just return. - // - goto ON_EXIT; - } - - // - // OK, it is time to take action. - // - Status = MnpGroupOp (Instance, JoinFlag, MacAddress, GroupCtrlBlk); - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - - return Status; -} - -/** - Places asynchronous outgoing data packets into the transmit queue. - - The Transmit() function places a completion token into the transmit packet - queue. This function is always asynchronous. - The caller must fill in the Token.Event and Token.TxData fields in the - completion token, and these fields cannot be NULL. When the transmit operation - completes, the MNP updates the Token.Status field and the Token.Event is - signaled. - Note: There may be a performance penalty if the packet needs to be - defragmented before it can be transmitted by the network device. Systems in - which performance is critical should review the requirements and features of - the underlying communications device and drivers. - - - @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. - @param[in] Token Pointer to a token associated with the transmit data - descriptor. Type EFI_MANAGED_NETWORK_COMPLETION_TOKEN - is defined in "Related Definitions" below. - - @retval EFI_SUCCESS The transmit completion token was cached. - @retval EFI_NOT_STARTED This MNP child driver instance has not been - configured. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is - TRUE: - * This is NULL. - * Token is NULL. - * Token.Event is NULL. - * Token.TxData is NULL. - * Token.TxData.DestinationAddress is not - NULL and Token.TxData.HeaderLength is zero. - * Token.TxData.FragmentCount is zero. - * (Token.TxData.HeaderLength + - Token.TxData.DataLength) is not equal to the - sum of the - Token.TxData.FragmentTable[].FragmentLength - fields. - * One or more of the - Token.TxData.FragmentTable[].FragmentLength - fields is zero. - * One or more of the - Token.TxData.FragmentTable[].FragmentBufferfields - is NULL. - * Token.TxData.DataLength is greater than MTU. - @retval EFI_ACCESS_DENIED The transmit completion token is already in the - transmit queue. - @retval EFI_OUT_OF_RESOURCES The transmit data could not be queued due to a - lack of system resources (usually memory). - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. - The MNP child driver instance has been reset to - startup defaults. - @retval EFI_NOT_READY The transmit request could not be queued because - the transmit queue is full. - -**/ -EFI_STATUS -EFIAPI -MnpTransmit ( - IN EFI_MANAGED_NETWORK_PROTOCOL *This, - IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN *Token - ) -{ - EFI_STATUS Status; - MNP_INSTANCE_DATA *Instance; - MNP_SERVICE_DATA *MnpServiceData; - UINT8 *PktBuf; - UINT32 PktLen; - EFI_TPL OldTpl; - - if ((This == NULL) || (Token == NULL)) { - return EFI_INVALID_PARAMETER; - } - - Instance = MNP_INSTANCE_DATA_FROM_THIS (This); - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - if (!Instance->Configured) { - - Status = EFI_NOT_STARTED; - goto ON_EXIT; - } - - if (!MnpIsValidTxToken (Instance, Token)) { - // - // The Token is invalid. - // - Status = EFI_INVALID_PARAMETER; - goto ON_EXIT; - } - - MnpServiceData = Instance->MnpServiceData; - NET_CHECK_SIGNATURE (MnpServiceData, MNP_SERVICE_DATA_SIGNATURE); - - // - // Build the tx packet - // - Status = MnpBuildTxPacket (MnpServiceData, Token->Packet.TxData, &PktBuf, &PktLen); - if (EFI_ERROR (Status)) { - goto ON_EXIT; - } - - // - // OK, send the packet synchronously. - // - Status = MnpSyncSendPacket (MnpServiceData, PktBuf, PktLen, Token); - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - - return Status; -} - - -/** - Places an asynchronous receiving request into the receiving queue. - - The Receive() function places a completion token into the receive packet - queue. This function is always asynchronous. - The caller must fill in the Token.Event field in the completion token, and - this field cannot be NULL. When the receive operation completes, the MNP - updates the Token.Status and Token.RxData fields and the Token.Event is - signaled. - - @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. - @param[in] Token Pointer to a token associated with the receive - data descriptor. Type - EFI_MANAGED_NETWORK_COMPLETION_TOKEN is defined in - EFI_MANAGED_NETWORK_PROTOCOL.Transmit(). - - @retval EFI_SUCCESS The receive completion token was cached. - @retval EFI_NOT_STARTED This MNP child driver instance has not been - configured. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is - TRUE: - * This is NULL. - * Token is NULL. - * Token.Event is NULL - @retval EFI_OUT_OF_RESOURCES The transmit data could not be queued due to a - lack of system resources (usually memory). - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. - The MNP child driver instance has been reset to - startup defaults. - @retval EFI_ACCESS_DENIED The receive completion token was already in the - receive queue. - @retval EFI_NOT_READY The receive request could not be queued because - the receive queue is full. - -**/ -EFI_STATUS -EFIAPI -MnpReceive ( - IN EFI_MANAGED_NETWORK_PROTOCOL *This, - IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN *Token - ) -{ - EFI_STATUS Status; - MNP_INSTANCE_DATA *Instance; - EFI_TPL OldTpl; - - if ((This == NULL) || (Token == NULL) || (Token->Event == NULL)) { - return EFI_INVALID_PARAMETER; - } - - Instance = MNP_INSTANCE_DATA_FROM_THIS (This); - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - if (!Instance->Configured) { - Status = EFI_NOT_STARTED; - goto ON_EXIT; - } - - // - // Check whether this token(event) is already in the rx token queue. - // - Status = NetMapIterate (&Instance->RxTokenMap, MnpTokenExist, (VOID *) Token); - if (EFI_ERROR (Status)) { - goto ON_EXIT; - } - - // - // Insert the Token into the RxTokenMap. - // - Status = NetMapInsertTail (&Instance->RxTokenMap, (VOID *) Token, NULL); - if (!EFI_ERROR (Status)) { - // - // Try to deliver any buffered packets. - // - Status = MnpInstanceDeliverPacket (Instance); - - // - // Dispatch the DPC queued by the NotifyFunction of Token->Event. - // - DispatchDpc (); - } - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - - return Status; -} - -/** - Aborts an asynchronous transmit or receive request. - - The Cancel() function is used to abort a pending transmit or receive request. - If the token is in the transmit or receive request queues, after calling this - function, Token.Status will be set to EFI_ABORTED and then Token.Event will be - signaled. If the token is not in one of the queues, which usually means that - the asynchronous operation has completed, this function will not signal the - token and EFI_NOT_FOUND is returned. - - @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. - @param[in] Token Pointer to a token that has been issued by - EFI_MANAGED_NETWORK_PROTOCOL.Transmit() or - EFI_MANAGED_NETWORK_PROTOCOL.Receive(). If NULL, all - pending tokens are aborted. - - @retval EFI_SUCCESS The asynchronous I/O request was aborted and - Token.Event was signaled. When Token is NULL, - all pending requests were aborted and their - events were signaled. - @retval EFI_NOT_STARTED This MNP child driver instance has not been - configured. - @retval EFI_INVALID_PARAMETER This is NULL. - @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O - request was not found in the transmit or - receive queue. It has either completed or was - not issued by Transmit() and Receive(). - -**/ -EFI_STATUS -EFIAPI -MnpCancel ( - IN EFI_MANAGED_NETWORK_PROTOCOL *This, - IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN *Token OPTIONAL - ) -{ - EFI_STATUS Status; - MNP_INSTANCE_DATA *Instance; - EFI_TPL OldTpl; - - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - Instance = MNP_INSTANCE_DATA_FROM_THIS (This); - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - if (!Instance->Configured) { - Status = EFI_NOT_STARTED; - goto ON_EXIT; - } - - // - // Iterate the RxTokenMap to cancel the specified Token. - // - Status = NetMapIterate (&Instance->RxTokenMap, MnpCancelTokens, (VOID *) Token); - if (Token != NULL) { - Status = (Status == EFI_ABORTED) ? EFI_SUCCESS : EFI_NOT_FOUND; - } - - // - // Dispatch the DPC queued by the NotifyFunction of the cancled token's events. - // - DispatchDpc (); - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - - return Status; -} - -/** - Polls for incoming data packets and processes outgoing data packets. - - The Poll() function can be used by network drivers and applications to - increase the rate that data packets are moved between the communications - device and the transmit and receive queues. - Normally, a periodic timer event internally calls the Poll() function. But, in - some systems, the periodic timer event may not call Poll() fast enough to - transmit and/or receive all data packets without missing packets. Drivers and - applications that are experiencing packet loss should try calling the Poll() - function more often. - - @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. - - @retval EFI_SUCCESS Incoming or outgoing data was processed. - @retval EFI_NOT_STARTED This MNP child driver instance has not been - configured. - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The - MNP child driver instance has been reset to startup - defaults. - @retval EFI_NOT_READY No incoming or outgoing data was processed. Consider - increasing the polling rate. - @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive - queue. Consider increasing the polling rate. - -**/ -EFI_STATUS -EFIAPI -MnpPoll ( - IN EFI_MANAGED_NETWORK_PROTOCOL *This - ) -{ - EFI_STATUS Status; - MNP_INSTANCE_DATA *Instance; - EFI_TPL OldTpl; - - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - Instance = MNP_INSTANCE_DATA_FROM_THIS (This); - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - if (!Instance->Configured) { - Status = EFI_NOT_STARTED; - goto ON_EXIT; - } - - // - // Try to receive packets. - // - Status = MnpReceivePacket (Instance->MnpServiceData->MnpDeviceData); - - // - // Dispatch the DPC queued by the NotifyFunction of rx token's events. - // - DispatchDpc (); - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - - return Status; -} diff --git a/MdeModulePkg/Universal/Network/MnpDxe/MnpVlan.c b/MdeModulePkg/Universal/Network/MnpDxe/MnpVlan.c deleted file mode 100644 index 54fb189502..0000000000 --- a/MdeModulePkg/Universal/Network/MnpDxe/MnpVlan.c +++ /dev/null @@ -1,732 +0,0 @@ -/** @file - VLAN Config Protocol implementation and VLAN packet process routine. - -Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "MnpImpl.h" -#include "MnpVlan.h" - -VLAN_DEVICE_PATH mVlanDevicePathTemplate = { - { - MESSAGING_DEVICE_PATH, - MSG_VLAN_DP, - { - (UINT8) (sizeof (VLAN_DEVICE_PATH)), - (UINT8) ((sizeof (VLAN_DEVICE_PATH)) >> 8) - } - }, - 0 -}; - -EFI_VLAN_CONFIG_PROTOCOL mVlanConfigProtocolTemplate = { - VlanConfigSet, - VlanConfigFind, - VlanConfigRemove -}; - - -/** - Create a child handle for the VLAN ID. - - @param[in] ImageHandle The driver image handle. - @param[in] ControllerHandle Handle of device to bind driver to. - @param[in] VlanId The VLAN ID. - @param[out] Devicepath Pointer to returned device path for child handle. - - @return The handle of VLAN child or NULL if failed to create VLAN child. - -**/ -EFI_HANDLE -MnpCreateVlanChild ( - IN EFI_HANDLE ImageHandle, - IN EFI_HANDLE ControllerHandle, - IN UINT16 VlanId, - OUT EFI_DEVICE_PATH_PROTOCOL **Devicepath OPTIONAL - ) -{ - EFI_HANDLE ChildHandle; - VLAN_DEVICE_PATH VlanNode; - EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath; - EFI_DEVICE_PATH_PROTOCOL *VlanDevicePath; - EFI_STATUS Status; - - // - // Try to get parent device path - // - Status = gBS->OpenProtocol ( - ControllerHandle, - &gEfiDevicePathProtocolGuid, - (VOID **) &ParentDevicePath, - ImageHandle, - ControllerHandle, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - if (EFI_ERROR (Status)) { - return NULL; - } - - // - // Construct device path for child handle: MAC + VLAN - // - CopyMem (&VlanNode, &mVlanDevicePathTemplate, sizeof (VLAN_DEVICE_PATH)); - VlanNode.VlanId = VlanId; - VlanDevicePath = AppendDevicePathNode ( - ParentDevicePath, - (EFI_DEVICE_PATH_PROTOCOL *) &VlanNode - ); - if (VlanDevicePath == NULL) { - return NULL; - } - - // - // Create child VLAN handle by installing DevicePath protocol - // - ChildHandle = NULL; - Status = gBS->InstallMultipleProtocolInterfaces ( - &ChildHandle, - &gEfiDevicePathProtocolGuid, - VlanDevicePath, - NULL - ); - if (EFI_ERROR (Status)) { - FreePool (VlanDevicePath); - return NULL; - } - - if (Devicepath != NULL) { - *Devicepath = VlanDevicePath; - } - - return ChildHandle; -} - -/** - Remove VLAN tag from a packet. - - @param[in, out] MnpDeviceData Pointer to the mnp device context data. - @param[in, out] Nbuf Pointer to the NET_BUF to remove VLAN tag. - @param[out] VlanId Pointer to the returned VLAN ID. - - @retval TRUE VLAN tag is removed from this packet. - @retval FALSE There is no VLAN tag in this packet. - -**/ -BOOLEAN -MnpRemoveVlanTag ( - IN OUT MNP_DEVICE_DATA *MnpDeviceData, - IN OUT NET_BUF *Nbuf, - OUT UINT16 *VlanId - ) -{ - UINT8 *Packet; - UINTN ProtocolOffset; - UINT16 ProtocolType; - VLAN_TCI VlanTag; - - ProtocolOffset = MnpDeviceData->Snp->Mode->HwAddressSize * 2; - - // - // Get the packet buffer. - // - Packet = NetbufGetByte (Nbuf, 0, NULL); - ASSERT (Packet != NULL); - - // - // Check whether this is VLAN tagged frame by Ether Type - // - *VlanId = 0; - ProtocolType = NTOHS (*(UINT16 *) (Packet + ProtocolOffset)); - if (ProtocolType != ETHER_TYPE_VLAN) { - // - // Not a VLAN tagged frame - // - return FALSE; - } - - VlanTag.Uint16 = NTOHS (*(UINT16 *) (Packet + ProtocolOffset + sizeof (ProtocolType))); - *VlanId = VlanTag.Bits.Vid; - - // - // Move hardware address (DA + SA) 4 bytes right to override VLAN tag - // - CopyMem (Packet + NET_VLAN_TAG_LEN, Packet, ProtocolOffset); - - // - // Remove VLAN tag from the Nbuf - // - NetbufTrim (Nbuf, NET_VLAN_TAG_LEN, NET_BUF_HEAD); - - return TRUE; -} - - -/** - Build the vlan packet to transmit from the TxData passed in. - - @param MnpServiceData Pointer to the mnp service context data. - @param TxData Pointer to the transmit data containing the - information to build the packet. - @param ProtocolType Pointer to the Ethernet protocol type. - @param Packet Pointer to record the address of the packet. - @param Length Pointer to a UINT32 variable used to record the - packet's length. - -**/ -VOID -MnpInsertVlanTag ( - IN MNP_SERVICE_DATA *MnpServiceData, - IN EFI_MANAGED_NETWORK_TRANSMIT_DATA *TxData, - OUT UINT16 *ProtocolType, - IN OUT UINT8 **Packet, - IN OUT UINT32 *Length - ) -{ - VLAN_TCI *VlanTci; - UINT16 *Tpid; - UINT16 *EtherType; - MNP_DEVICE_DATA *MnpDeviceData; - EFI_SIMPLE_NETWORK_MODE *SnpMode; - - MnpDeviceData = MnpServiceData->MnpDeviceData; - SnpMode = MnpDeviceData->Snp->Mode; - - *ProtocolType = ETHER_TYPE_VLAN; - *Length = *Length + NET_VLAN_TAG_LEN; - *Packet = *Packet - NET_VLAN_TAG_LEN; - - Tpid = (UINT16 *) (*Packet + SnpMode->MediaHeaderSize - sizeof (*ProtocolType)); - VlanTci = (VLAN_TCI *) (UINTN) (Tpid + 1); - if (TxData->HeaderLength != 0) { - // - // Media header is in packet, move DA+SA 4 bytes left - // - CopyMem ( - *Packet, - *Packet + NET_VLAN_TAG_LEN, - SnpMode->MediaHeaderSize - sizeof (*ProtocolType) - ); - *Tpid = HTONS (ETHER_TYPE_VLAN); - } else { - // - // Media header not in packet, VLAN TCI and original protocol type becomes payload - // - EtherType = (UINT16 *) (UINTN) (VlanTci + 1); - *EtherType = HTONS (TxData->ProtocolType); - } - - VlanTci->Bits.Vid = MnpServiceData->VlanId; - VlanTci->Bits.Cfi = VLAN_TCI_CFI_CANONICAL_MAC; - VlanTci->Bits.Priority = MnpServiceData->Priority; - VlanTci->Uint16 = HTONS (VlanTci->Uint16); -} - -/** - Check VLAN configuration variable and delete the duplicative content if has identical Vlan ID. - - @param[in] MnpDeviceData Pointer to the MNP device context data. - @param[in] Buffer Pointer to the buffer contains the array of VLAN_TCI. - @param[in] NumberOfVlan Pointer to number of VLAN. - @param[out] NewNumberOfVlan Pointer to number of unique VLAN. - - @retval EFI_SUCCESS The VLAN variable is successfully checked. - @retval EFI_OUT_OF_RESOURCES There is not enough resource to set the configuration. - -**/ -EFI_STATUS -MnpCheckVlanVariable ( - IN MNP_DEVICE_DATA *MnpDeviceData, - IN VLAN_TCI *Buffer, - IN UINTN NumberOfVlan, - OUT UINTN *NewNumberOfVlan - ) -{ - UINTN Index; - UINTN Index2; - UINTN Count; - BOOLEAN FoundDuplicateItem; - EFI_STATUS Status; - - Count = 0; - FoundDuplicateItem = FALSE; - Status = EFI_SUCCESS; - - for (Index = 0; Index < NumberOfVlan; Index++) { - for (Index2 = Index + 1; Index2 < NumberOfVlan; Index2++) { - if (Buffer[Index].Bits.Vid == Buffer[Index2].Bits.Vid) { - FoundDuplicateItem = TRUE; - Count++; - break; - } - } - if (FoundDuplicateItem) { - for (Index2 = Index +1; Index2 < NumberOfVlan; Index++, Index2++) { - CopyMem (Buffer + Index, Buffer + Index2, sizeof (VLAN_TCI)); - } - } - FoundDuplicateItem = FALSE; - } - - *NewNumberOfVlan = NumberOfVlan - Count; - if (Count != 0) { - Status = MnpSetVlanVariable (MnpDeviceData, *NewNumberOfVlan, Buffer); - } - - return Status; -} - -/** - Get VLAN configuration variable. - - @param[in] MnpDeviceData Pointer to the MNP device context data. - @param[out] NumberOfVlan Pointer to number of VLAN to be returned. - @param[out] VlanVariable Pointer to the buffer to return requested - array of VLAN_TCI. - - @retval EFI_SUCCESS The array of VLAN_TCI was returned in VlanVariable - and number of VLAN was returned in NumberOfVlan. - @retval EFI_NOT_FOUND VLAN configuration variable not found. - @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the configuration. - -**/ -EFI_STATUS -MnpGetVlanVariable ( - IN MNP_DEVICE_DATA *MnpDeviceData, - OUT UINTN *NumberOfVlan, - OUT VLAN_TCI **VlanVariable - ) -{ - UINTN BufferSize; - EFI_STATUS Status; - VLAN_TCI *Buffer; - UINTN NewNumberOfVlan; - - // - // Get VLAN configuration from EFI Variable - // - Buffer = NULL; - BufferSize = 0; - Status = gRT->GetVariable ( - MnpDeviceData->MacString, - &gEfiVlanConfigProtocolGuid, - NULL, - &BufferSize, - NULL - ); - if (Status != EFI_BUFFER_TOO_SMALL) { - return EFI_NOT_FOUND; - } - - // - // Allocate buffer to read the variable - // - Buffer = AllocateZeroPool (BufferSize); - if (Buffer == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - Status = gRT->GetVariable ( - MnpDeviceData->MacString, - &gEfiVlanConfigProtocolGuid, - NULL, - &BufferSize, - Buffer - ); - if (EFI_ERROR (Status)) { - FreePool (Buffer); - return Status; - } - - Status = MnpCheckVlanVariable (MnpDeviceData, Buffer, BufferSize / sizeof (VLAN_TCI), &NewNumberOfVlan); - if (!EFI_ERROR (Status)) { - *NumberOfVlan = NewNumberOfVlan; - *VlanVariable = Buffer; - } - - return Status; -} - -/** - Set VLAN configuration variable. - - @param[in] MnpDeviceData Pointer to the MNP device context data. - @param[in] NumberOfVlan Number of VLAN in array VlanVariable. - @param[in] VlanVariable Pointer to array of VLAN_TCI. - - @retval EFI_SUCCESS The VLAN variable is successfully set. - @retval EFI_OUT_OF_RESOURCES There is not enough resource to set the configuration. - -**/ -EFI_STATUS -MnpSetVlanVariable ( - IN MNP_DEVICE_DATA *MnpDeviceData, - IN UINTN NumberOfVlan, - IN VLAN_TCI *VlanVariable - ) -{ - return gRT->SetVariable ( - MnpDeviceData->MacString, - &gEfiVlanConfigProtocolGuid, - EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS, - NumberOfVlan * sizeof (VLAN_TCI), - VlanVariable - ); -} - - -/** - Create a VLAN device or modify the configuration parameter of an - already-configured VLAN. - - The Set() function is used to create a new VLAN device or change the VLAN - configuration parameters. If the VlanId hasn't been configured in the - physical Ethernet device, a new VLAN device will be created. If a VLAN with - this VlanId is already configured, then related configuration will be updated - as the input parameters. - - If VlanId is zero, the VLAN device will send and receive untagged frames. - Otherwise, the VLAN device will send and receive VLAN-tagged frames containing the VlanId. - If VlanId is out of scope of (0-4094), EFI_INVALID_PARAMETER is returned. - If Priority is out of the scope of (0-7), then EFI_INVALID_PARAMETER is returned. - If there is not enough system memory to perform the registration, then - EFI_OUT_OF_RESOURCES is returned. - - @param[in] This Points to the EFI_VLAN_CONFIG_PROTOCOL. - @param[in] VlanId A unique identifier (1-4094) of the VLAN which is being created - or modified, or zero (0). - @param[in] Priority 3 bit priority in VLAN header. Priority 0 is default value. If - VlanId is zero (0), Priority is ignored. - - @retval EFI_SUCCESS The VLAN is successfully configured. - @retval EFI_INVALID_PARAMETER One or more of following conditions is TRUE: - - This is NULL. - - VlanId is an invalid VLAN Identifier. - - Priority is invalid. - @retval EFI_OUT_OF_RESOURCES There is not enough system memory to perform the registration. - -**/ -EFI_STATUS -EFIAPI -VlanConfigSet ( - IN EFI_VLAN_CONFIG_PROTOCOL *This, - IN UINT16 VlanId, - IN UINT8 Priority - ) -{ - EFI_STATUS Status; - MNP_DEVICE_DATA *MnpDeviceData; - MNP_SERVICE_DATA *MnpServiceData; - VLAN_TCI *OldVariable; - VLAN_TCI *NewVariable; - UINTN NumberOfVlan; - UINTN Index; - BOOLEAN IsAdd; - LIST_ENTRY *Entry; - - if ((This == NULL) || (VlanId > 4094) || (Priority > 7)) { - return EFI_INVALID_PARAMETER; - } - - IsAdd = FALSE; - MnpDeviceData = MNP_DEVICE_DATA_FROM_THIS (This); - if (MnpDeviceData->NumberOfVlan == 0) { - // - // No existing VLAN, this is the first VLAN to add - // - IsAdd = TRUE; - Entry = GetFirstNode (&MnpDeviceData->ServiceList); - MnpServiceData = MNP_SERVICE_DATA_FROM_LINK (Entry); - - if (VlanId != 0) { - // - // VlanId is not 0, need destroy the default MNP service data - // - Status = MnpDestroyServiceChild (MnpServiceData); - if (EFI_ERROR (Status)) { - return Status; - } - - Status = MnpDestroyServiceData (MnpServiceData); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Create a new MNP service data for this VLAN - // - MnpServiceData = MnpCreateServiceData (MnpDeviceData, VlanId, Priority); - if (MnpServiceData == NULL) { - return EFI_OUT_OF_RESOURCES; - } - } - } else { - // - // Try to find VlanId in existing VLAN list - // - MnpServiceData = MnpFindServiceData (MnpDeviceData, VlanId); - if (MnpServiceData == NULL) { - // - // VlanId not found, create a new MNP service data - // - IsAdd = TRUE; - MnpServiceData = MnpCreateServiceData (MnpDeviceData, VlanId, Priority); - if (MnpServiceData == NULL) { - return EFI_OUT_OF_RESOURCES; - } - } - } - - MnpServiceData->VlanId = VlanId; - MnpServiceData->Priority = Priority; - if (IsAdd) { - MnpDeviceData->NumberOfVlan++; - } - - // - // Update VLAN configuration variable - // - OldVariable = NULL; - NewVariable = NULL; - NumberOfVlan = 0; - MnpGetVlanVariable (MnpDeviceData, &NumberOfVlan, &OldVariable); - - if (IsAdd) { - // - // VLAN not exist - add - // - NewVariable = AllocateZeroPool ((NumberOfVlan + 1) * sizeof (VLAN_TCI)); - if (NewVariable == NULL) { - Status = EFI_OUT_OF_RESOURCES; - goto Exit; - } - - if (OldVariable != NULL) { - CopyMem (NewVariable, OldVariable, NumberOfVlan * sizeof (VLAN_TCI)); - } - - Index = NumberOfVlan++; - } else { - // - // VLAN already exist - update - // - for (Index = 0; Index < NumberOfVlan; Index++) { - if (OldVariable[Index].Bits.Vid == VlanId) { - break; - } - } - ASSERT (Index < NumberOfVlan); - - NewVariable = OldVariable; - OldVariable = NULL; - } - - NewVariable[Index].Bits.Vid = VlanId; - NewVariable[Index].Bits.Priority = Priority; - - Status = MnpSetVlanVariable (MnpDeviceData, NumberOfVlan, NewVariable); - FreePool (NewVariable); - -Exit: - if (OldVariable != NULL) { - FreePool (OldVariable); - } - - return Status; -} - - -/** - Find configuration information for specified VLAN or all configured VLANs. - - The Find() function is used to find the configuration information for matching - VLAN and allocate a buffer into which those entries are copied. - - @param[in] This Points to the EFI_VLAN_CONFIG_PROTOCOL. - @param[in] VlanId Pointer to VLAN identifier. Set to NULL to find all - configured VLANs. - @param[out] NumberOfVlan The number of VLANs which is found by the specified criteria. - @param[out] Entries The buffer which receive the VLAN configuration. - - @retval EFI_SUCCESS The VLAN is successfully found. - @retval EFI_INVALID_PARAMETER One or more of following conditions is TRUE: - - This is NULL. - - Specified VlanId is invalid. - @retval EFI_NOT_FOUND No matching VLAN is found. - -**/ -EFI_STATUS -EFIAPI -VlanConfigFind ( - IN EFI_VLAN_CONFIG_PROTOCOL *This, - IN UINT16 *VlanId OPTIONAL, - OUT UINT16 *NumberOfVlan, - OUT EFI_VLAN_FIND_DATA **Entries - ) -{ - MNP_DEVICE_DATA *MnpDeviceData; - MNP_SERVICE_DATA *MnpServiceData; - LIST_ENTRY *Entry; - EFI_VLAN_FIND_DATA *VlanData; - - if ((This == NULL) || (VlanId != NULL && *VlanId > 4094) || (NumberOfVlan == NULL) || (Entries == NULL)) { - return EFI_INVALID_PARAMETER; - } - - *NumberOfVlan = 0; - *Entries = NULL; - - MnpDeviceData = MNP_DEVICE_DATA_FROM_THIS (This); - if (MnpDeviceData->NumberOfVlan == 0) { - return EFI_NOT_FOUND; - } - - if (VlanId == NULL) { - // - // Return all current VLAN configuration - // - *NumberOfVlan = (UINT16) MnpDeviceData->NumberOfVlan; - VlanData = AllocateZeroPool (*NumberOfVlan * sizeof (EFI_VLAN_FIND_DATA)); - if (VlanData == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - *Entries = VlanData; - NET_LIST_FOR_EACH (Entry, &MnpDeviceData->ServiceList) { - MnpServiceData = MNP_SERVICE_DATA_FROM_LINK (Entry); - - VlanData->VlanId = MnpServiceData->VlanId; - VlanData->Priority = MnpServiceData->Priority; - VlanData++; - } - - return EFI_SUCCESS; - } - - // - // VlanId is specified, try to find it in current VLAN list - // - MnpServiceData = MnpFindServiceData (MnpDeviceData, *VlanId); - if (MnpServiceData == NULL) { - return EFI_NOT_FOUND; - } - - VlanData = AllocateZeroPool (sizeof (EFI_VLAN_FIND_DATA)); - if (VlanData == NULL) { - return EFI_OUT_OF_RESOURCES; - } - VlanData->VlanId = MnpServiceData->VlanId; - VlanData->Priority = MnpServiceData->Priority; - - *NumberOfVlan = 1; - *Entries = VlanData; - - return EFI_SUCCESS; -} - - -/** - Remove the configured VLAN device. - - The Remove() function is used to remove the specified VLAN device. - If the VlanId is out of the scope of (0-4094), EFI_INVALID_PARAMETER is returned. - If specified VLAN hasn't been previously configured, EFI_NOT_FOUND is returned. - - @param[in] This Points to the EFI_VLAN_CONFIG_PROTOCOL. - @param[in] VlanId Identifier (0-4094) of the VLAN to be removed. - - @retval EFI_SUCCESS The VLAN is successfully removed. - @retval EFI_INVALID_PARAMETER One or more of following conditions is TRUE: - - This is NULL. - - VlanId is an invalid parameter. - @retval EFI_NOT_FOUND The to-be-removed VLAN does not exist. - -**/ -EFI_STATUS -EFIAPI -VlanConfigRemove ( - IN EFI_VLAN_CONFIG_PROTOCOL *This, - IN UINT16 VlanId - ) -{ - EFI_STATUS Status; - MNP_DEVICE_DATA *MnpDeviceData; - MNP_SERVICE_DATA *MnpServiceData; - LIST_ENTRY *Entry; - VLAN_TCI *VlanVariable; - VLAN_TCI *VlanData; - - if ((This == NULL) || (VlanId > 4094)) { - return EFI_INVALID_PARAMETER; - } - - MnpDeviceData = MNP_DEVICE_DATA_FROM_THIS (This); - if (MnpDeviceData->NumberOfVlan == 0) { - return EFI_NOT_FOUND; - } - - // - // Try to find the VlanId - // - MnpServiceData = MnpFindServiceData (MnpDeviceData, VlanId); - if (MnpServiceData == NULL) { - return EFI_NOT_FOUND; - } - - MnpDeviceData->NumberOfVlan--; - - if ((VlanId != 0) || (MnpDeviceData->NumberOfVlan != 0)) { - // - // If VlanId is not 0 or VlanId is 0 and it is not the last VLAN to remove, - // destroy its MNP service data - // - Status = MnpDestroyServiceChild (MnpServiceData); - if (EFI_ERROR (Status)) { - return Status; - } - - Status = MnpDestroyServiceData (MnpServiceData); - if (EFI_ERROR (Status)) { - return Status; - } - } - - if ((VlanId != 0) && (MnpDeviceData->NumberOfVlan == 0)) { - // - // This is the last VLAN to be removed, restore the default MNP service data - // - MnpServiceData = MnpCreateServiceData (MnpDeviceData, 0, 0); - if (MnpServiceData == NULL) { - return EFI_OUT_OF_RESOURCES; - } - } - - // - // Update VLAN configuration variable - // - VlanVariable = NULL; - if (MnpDeviceData->NumberOfVlan != 0) { - VlanVariable = AllocatePool (MnpDeviceData->NumberOfVlan * sizeof (VLAN_TCI)); - if (VlanVariable == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - VlanData = VlanVariable; - NET_LIST_FOR_EACH (Entry, &MnpDeviceData->ServiceList) { - MnpServiceData = MNP_SERVICE_DATA_FROM_LINK (Entry); - - VlanData->Bits.Vid = MnpServiceData->VlanId; - VlanData->Bits.Priority = MnpServiceData->Priority; - VlanData++; - } - } - - Status = MnpSetVlanVariable (MnpDeviceData, MnpDeviceData->NumberOfVlan, VlanVariable); - - if (VlanVariable != NULL) { - FreePool (VlanVariable); - } - - return Status; -} diff --git a/MdeModulePkg/Universal/Network/MnpDxe/MnpVlan.h b/MdeModulePkg/Universal/Network/MnpDxe/MnpVlan.h deleted file mode 100644 index 4e0ddef2df..0000000000 --- a/MdeModulePkg/Universal/Network/MnpDxe/MnpVlan.h +++ /dev/null @@ -1,205 +0,0 @@ -/** @file - Header file to be included by MnpVlan.c. - -Copyright (c) 2009 - 2013, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef __MNP_VLAN_H__ -#define __MNP_VLAN_H__ - -#include "MnpDriver.h" - -extern EFI_VLAN_CONFIG_PROTOCOL mVlanConfigProtocolTemplate; - - -/** - Create a child handle for the VLAN ID. - - @param[in] ImageHandle The driver image handle. - @param[in] ControllerHandle Handle of device to bind driver to. - @param[in] VlanId The VLAN ID. - @param[out] Devicepath Pointer to returned device path for child handle. - - @return The handle of VLAN child or NULL if failed to create VLAN child. - -**/ -EFI_HANDLE -MnpCreateVlanChild ( - IN EFI_HANDLE ImageHandle, - IN EFI_HANDLE ControllerHandle, - IN UINT16 VlanId, - OUT EFI_DEVICE_PATH_PROTOCOL **Devicepath OPTIONAL - ); - -/** - Remove VLAN tag of a packet. - - @param[in, out] MnpDeviceData Pointer to the mnp device context data. - @param[in, out] Nbuf Pointer to the NET_BUF to remove VLAN tag. - @param[out] VlanId Pointer to the returned VLAN ID. - - @retval TRUE VLAN tag is removed from this packet. - @retval FALSE There is no VLAN tag in this packet. - -**/ -BOOLEAN -MnpRemoveVlanTag ( - IN OUT MNP_DEVICE_DATA *MnpDeviceData, - IN OUT NET_BUF *Nbuf, - OUT UINT16 *VlanId - ); - -/** - Build the vlan packet to transmit from the TxData passed in. - - @param MnpServiceData Pointer to the mnp service context data. - @param TxData Pointer to the transmit data containing the - information to build the packet. - @param ProtocolType Pointer to the Ethernet protocol type. - @param Packet Pointer to record the address of the packet. - @param Length Pointer to a UINT32 variable used to record the - packet's length. - -**/ -VOID -MnpInsertVlanTag ( - IN MNP_SERVICE_DATA *MnpServiceData, - IN EFI_MANAGED_NETWORK_TRANSMIT_DATA *TxData, - OUT UINT16 *ProtocolType, - IN OUT UINT8 **Packet, - IN OUT UINT32 *Length - ); - -/** - Get VLAN configuration variable. - - @param[in] MnpDeviceData Pointer to the MNP device context data. - @param[out] NumberOfVlan Pointer to number of VLAN to be returned. - @param[out] VlanVariable Pointer to the buffer to return requested - array of VLAN_TCI. - - @retval EFI_SUCCESS The array of VLAN_TCI was returned in VlanVariable - and number of VLAN was returned in NumberOfVlan. - @retval EFI_NOT_FOUND VLAN configuration variable not found. - @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the configuration. - -**/ -EFI_STATUS -MnpGetVlanVariable ( - IN MNP_DEVICE_DATA *MnpDeviceData, - OUT UINTN *NumberOfVlan, - OUT VLAN_TCI **VlanVariable - ); - -/** - Set VLAN configuration variable. - - @param[in] MnpDeviceData Pointer to the MNP device context data. - @param[in] NumberOfVlan Number of VLAN in array VlanVariable. - @param[in] VlanVariable Pointer to array of VLAN_TCI. - - @retval EFI_SUCCESS The VLAN variable is successfully set. - @retval EFI_OUT_OF_RESOURCES There is not enough resource to set the configuration. - -**/ -EFI_STATUS -MnpSetVlanVariable ( - IN MNP_DEVICE_DATA *MnpDeviceData, - IN UINTN NumberOfVlan, - IN VLAN_TCI *VlanVariable - ); - -/** - Create a VLAN device or modify the configuration parameter of an - already-configured VLAN. - - The Set() function is used to create a new VLAN device or change the VLAN - configuration parameters. If the VlanId hasn't been configured in the - physical Ethernet device, a new VLAN device will be created. If a VLAN with - this VlanId is already configured, then related configuration will be updated - as the input parameters. - - If VlanId is zero, the VLAN device will send and receive untagged frames. - Otherwise, the VLAN device will send and receive VLAN-tagged frames containing the VlanId. - If VlanId is out of scope of (0-4094), EFI_INVALID_PARAMETER is returned. - If Priority is out of the scope of (0-7), then EFI_INVALID_PARAMETER is returned. - If there is not enough system memory to perform the registration, then - EFI_OUT_OF_RESOURCES is returned. - - @param[in] This Points to the EFI_VLAN_CONFIG_PROTOCOL. - @param[in] VlanId A unique identifier (1-4094) of the VLAN which is being created - or modified, or zero (0). - @param[in] Priority 3 bit priority in VLAN header. Priority 0 is default value. If - VlanId is zero (0), Priority is ignored. - - @retval EFI_SUCCESS The VLAN is successfully configured. - @retval EFI_INVALID_PARAMETER One or more of following conditions is TRUE: - - This is NULL. - - VlanId is an invalid VLAN Identifier. - - Priority is invalid. - @retval EFI_OUT_OF_RESOURCES There is not enough system memory to perform the registration. - -**/ -EFI_STATUS -EFIAPI -VlanConfigSet ( - IN EFI_VLAN_CONFIG_PROTOCOL *This, - IN UINT16 VlanId, - IN UINT8 Priority - ); - -/** - Find configuration information for specified VLAN or all configured VLANs. - - The Find() function is used to find the configuration information for matching - VLAN and allocate a buffer into which those entries are copied. - - @param[in] This Points to the EFI_VLAN_CONFIG_PROTOCOL. - @param[in] VlanId Pointer to VLAN identifier. Set to NULL to find all - configured VLANs. - @param[out] NumberOfVlan The number of VLANs which is found by the specified criteria. - @param[out] Entries The buffer which receive the VLAN configuration. - - @retval EFI_SUCCESS The VLAN is successfully found. - @retval EFI_INVALID_PARAMETER One or more of following conditions is TRUE: - - This is NULL. - - Specified VlanId is invalid. - @retval EFI_NOT_FOUND No matching VLAN is found. - -**/ -EFI_STATUS -EFIAPI -VlanConfigFind ( - IN EFI_VLAN_CONFIG_PROTOCOL *This, - IN UINT16 *VlanId OPTIONAL, - OUT UINT16 *NumberOfVlan, - OUT EFI_VLAN_FIND_DATA **Entries - ); - -/** - Remove the configured VLAN device. - - The Remove() function is used to remove the specified VLAN device. - If the VlanId is out of the scope of (0-4094), EFI_INVALID_PARAMETER is returned. - If specified VLAN hasn't been previously configured, EFI_NOT_FOUND is returned. - - @param[in] This Points to the EFI_VLAN_CONFIG_PROTOCOL. - @param[in] VlanId Identifier (0-4094) of the VLAN to be removed. - - @retval EFI_SUCCESS The VLAN is successfully removed. - @retval EFI_INVALID_PARAMETER One or more of following conditions is TRUE: - - This is NULL. - - VlanId is an invalid parameter. - @retval EFI_NOT_FOUND The to-be-removed VLAN does not exist. - -**/ -EFI_STATUS -EFIAPI -VlanConfigRemove ( - IN EFI_VLAN_CONFIG_PROTOCOL *This, - IN UINT16 VlanId - ); - -#endif diff --git a/MdeModulePkg/Universal/Network/Mtftp4Dxe/ComponentName.c b/MdeModulePkg/Universal/Network/Mtftp4Dxe/ComponentName.c deleted file mode 100644 index 8b84caf113..0000000000 --- a/MdeModulePkg/Universal/Network/Mtftp4Dxe/ComponentName.c +++ /dev/null @@ -1,425 +0,0 @@ -/** @file - UEFI Component Name(2) protocol implementation for Mtftp4Dxe driver. - -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Mtftp4Impl.h" - -// -// EFI Component Name Functions -// -/** - Retrieves a Unicode string that is the user readable name of the driver. - - This function retrieves the user readable name of a driver in the form of a - Unicode string. If the driver specified by This has a user readable name in - the language specified by Language, then a pointer to the driver name is - returned in DriverName, and EFI_SUCCESS is returned. If the driver specified - by This does not support the language specified by Language, - then EFI_UNSUPPORTED is returned. - - @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param[in] Language A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified - in RFC 4646 or ISO 639-2 language code format. - - @param[out] DriverName A pointer to the Unicode string to return. - This Unicode string is the name of the - driver specified by This in the language - specified by Language. - - @retval EFI_SUCCESS The Unicode string for the Driver specified by - This and the language specified by Language was - returned in DriverName. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER DriverName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -Mtftp4ComponentNameGetDriverName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN CHAR8 *Language, - OUT CHAR16 **DriverName - ); - - -/** - Retrieves a Unicode string that is the user readable name of the controller - that is being managed by a driver. - - This function retrieves the user readable name of the controller specified by - ControllerHandle and ChildHandle in the form of a Unicode string. If the - driver specified by This has a user readable name in the language specified by - Language, then a pointer to the controller name is returned in ControllerName, - and EFI_SUCCESS is returned. If the driver specified by This is not currently - managing the controller specified by ControllerHandle and ChildHandle, - then EFI_UNSUPPORTED is returned. If the driver specified by This does not - support the language specified by Language, then EFI_UNSUPPORTED is returned. - - @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param[in] ControllerHandle The handle of a controller that the driver - specified by This is managing. This handle - specifies the controller whose name is to be - returned. - - @param[in] ChildHandle The handle of the child controller to retrieve - the name of. This is an optional parameter that - may be NULL. It will be NULL for device - drivers. It will also be NULL for a bus drivers - that wish to retrieve the name of the bus - controller. It will not be NULL for a bus - driver that wishes to retrieve the name of a - child controller. - - @param[in] Language A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified in - RFC 4646 or ISO 639-2 language code format. - - @param[out] ControllerName A pointer to the Unicode string to return. - This Unicode string is the name of the - controller specified by ControllerHandle and - ChildHandle in the language specified by - Language from the point of view of the driver - specified by This. - - @retval EFI_SUCCESS The Unicode string for the user readable name in - the language specified by Language for the - driver specified by This was returned in - DriverName. - - @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. - - @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid - EFI_HANDLE. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER ControllerName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This is not currently - managing the controller specified by - ControllerHandle and ChildHandle. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -Mtftp4ComponentNameGetControllerName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_HANDLE ChildHandle OPTIONAL, - IN CHAR8 *Language, - OUT CHAR16 **ControllerName - ); - - -/// -/// EFI Component Name Protocol -/// -GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gMtftp4ComponentName = { - Mtftp4ComponentNameGetDriverName, - Mtftp4ComponentNameGetControllerName, - "eng" -}; - -/// -/// EFI Component Name 2 Protocol -/// -GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gMtftp4ComponentName2 = { - (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) Mtftp4ComponentNameGetDriverName, - (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) Mtftp4ComponentNameGetControllerName, - "en" -}; - - -GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mMtftp4DriverNameTable[] = { - { - "eng;en", - L"MTFTP4 Network Service" - }, - { - NULL, - NULL - } -}; - -GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE *gMtftp4ControllerNameTable = NULL; - -/** - Retrieves a Unicode string that is the user readable name of the driver. - - This function retrieves the user readable name of a driver in the form of a - Unicode string. If the driver specified by This has a user readable name in - the language specified by Language, then a pointer to the driver name is - returned in DriverName, and EFI_SUCCESS is returned. If the driver specified - by This does not support the language specified by Language, - then EFI_UNSUPPORTED is returned. - - @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param[in] Language A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified - in RFC 4646 or ISO 639-2 language code format. - - @param[out] DriverName A pointer to the Unicode string to return. - This Unicode string is the name of the - driver specified by This in the language - specified by Language. - - @retval EFI_SUCCESS The Unicode string for the Driver specified by - This and the language specified by Language was - returned in DriverName. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER DriverName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -Mtftp4ComponentNameGetDriverName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN CHAR8 *Language, - OUT CHAR16 **DriverName - ) -{ - return LookupUnicodeString2 ( - Language, - This->SupportedLanguages, - mMtftp4DriverNameTable, - DriverName, - (BOOLEAN)(This == &gMtftp4ComponentName) - ); -} - -/** - Update the component name for the Mtftp4 child handle. - - @param Mtftp4[in] A pointer to the EFI_MTFTP4_PROTOCOL. - - - @retval EFI_SUCCESS Update the ControllerNameTable of this instance successfully. - @retval EFI_INVALID_PARAMETER The input parameter is invalid. - -**/ -EFI_STATUS -UpdateName ( - IN EFI_MTFTP4_PROTOCOL *Mtftp4 - ) -{ - EFI_STATUS Status; - CHAR16 HandleName[80]; - EFI_MTFTP4_MODE_DATA ModeData; - - if (Mtftp4 == NULL) { - return EFI_INVALID_PARAMETER; - } - - // - // Format the child name into the string buffer as: - // MTFTPv4 (ServerIp=192.168.1.10, ServerPort=69) - // - Status = Mtftp4->GetModeData (Mtftp4, &ModeData); - if (EFI_ERROR (Status)) { - return Status; - } - - UnicodeSPrint (HandleName, sizeof (HandleName), - L"MTFTPv4 (ServerIp=%d.%d.%d.%d, ServerPort=%d)", - ModeData.ConfigData.ServerIp.Addr[0], - ModeData.ConfigData.ServerIp.Addr[1], - ModeData.ConfigData.ServerIp.Addr[2], - ModeData.ConfigData.ServerIp.Addr[3], - ModeData.ConfigData.InitialServerPort - ); - - if (gMtftp4ControllerNameTable != NULL) { - FreeUnicodeStringTable (gMtftp4ControllerNameTable); - gMtftp4ControllerNameTable = NULL; - } - - Status = AddUnicodeString2 ( - "eng", - gMtftp4ComponentName.SupportedLanguages, - &gMtftp4ControllerNameTable, - HandleName, - TRUE - ); - if (EFI_ERROR (Status)) { - return Status; - } - - return AddUnicodeString2 ( - "en", - gMtftp4ComponentName2.SupportedLanguages, - &gMtftp4ControllerNameTable, - HandleName, - FALSE - ); -} - -/** - Retrieves a Unicode string that is the user readable name of the controller - that is being managed by a driver. - - This function retrieves the user readable name of the controller specified by - ControllerHandle and ChildHandle in the form of a Unicode string. If the - driver specified by This has a user readable name in the language specified by - Language, then a pointer to the controller name is returned in ControllerName, - and EFI_SUCCESS is returned. If the driver specified by This is not currently - managing the controller specified by ControllerHandle and ChildHandle, - then EFI_UNSUPPORTED is returned. If the driver specified by This does not - support the language specified by Language, then EFI_UNSUPPORTED is returned. - - @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param[in] ControllerHandle The handle of a controller that the driver - specified by This is managing. This handle - specifies the controller whose name is to be - returned. - - @param[in] ChildHandle The handle of the child controller to retrieve - the name of. This is an optional parameter that - may be NULL. It will be NULL for device - drivers. It will also be NULL for a bus drivers - that wish to retrieve the name of the bus - controller. It will not be NULL for a bus - driver that wishes to retrieve the name of a - child controller. - - @param[in] Language A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified in - RFC 4646 or ISO 639-2 language code format. - - @param[out] ControllerName A pointer to the Unicode string to return. - This Unicode string is the name of the - controller specified by ControllerHandle and - ChildHandle in the language specified by - Language from the point of view of the driver - specified by This. - - @retval EFI_SUCCESS The Unicode string for the user readable name in - the language specified by Language for the - driver specified by This was returned in - DriverName. - - @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. - - @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid - EFI_HANDLE. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER ControllerName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This is not currently - managing the controller specified by - ControllerHandle and ChildHandle. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -Mtftp4ComponentNameGetControllerName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_HANDLE ChildHandle OPTIONAL, - IN CHAR8 *Language, - OUT CHAR16 **ControllerName - ) -{ - EFI_STATUS Status; - EFI_MTFTP4_PROTOCOL *Mtftp4; - - // - // Only provide names for child handles. - // - if (ChildHandle == NULL) { - return EFI_UNSUPPORTED; - } - - // - // Make sure this driver produced ChildHandle - // - Status = EfiTestChildHandle ( - ControllerHandle, - ChildHandle, - &gEfiUdp4ProtocolGuid - ); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Retrieve an instance of a produced protocol from ChildHandle - // - Status = gBS->OpenProtocol ( - ChildHandle, - &gEfiMtftp4ProtocolGuid, - (VOID **)&Mtftp4, - NULL, - NULL, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Update the component name for this child handle. - // - Status = UpdateName (Mtftp4); - if (EFI_ERROR (Status)) { - return Status; - } - - return LookupUnicodeString2 ( - Language, - This->SupportedLanguages, - gMtftp4ControllerNameTable, - ControllerName, - (BOOLEAN)(This == &gMtftp4ComponentName) - ); -} diff --git a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Driver.c b/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Driver.c deleted file mode 100644 index ae9e65544a..0000000000 --- a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Driver.c +++ /dev/null @@ -1,739 +0,0 @@ -/** @file - Implementation of Mtftp drivers. - -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Mtftp4Impl.h" - -EFI_DRIVER_BINDING_PROTOCOL gMtftp4DriverBinding = { - Mtftp4DriverBindingSupported, - Mtftp4DriverBindingStart, - Mtftp4DriverBindingStop, - 0xa, - NULL, - NULL -}; - -EFI_SERVICE_BINDING_PROTOCOL gMtftp4ServiceBindingTemplete = { - Mtftp4ServiceBindingCreateChild, - Mtftp4ServiceBindingDestroyChild -}; - - -/** - The driver entry point which installs multiple protocols to the ImageHandle. - - @param ImageHandle The MTFTP's image handle. - @param SystemTable The system table. - - @retval EFI_SUCCESS The handles are successfully installed on the image. - @retval others some EFI_ERROR occured. - -**/ -EFI_STATUS -EFIAPI -Mtftp4DriverEntryPoint ( - IN EFI_HANDLE ImageHandle, - IN EFI_SYSTEM_TABLE *SystemTable - ) -{ - return EfiLibInstallDriverBindingComponentName2 ( - ImageHandle, - SystemTable, - &gMtftp4DriverBinding, - ImageHandle, - &gMtftp4ComponentName, - &gMtftp4ComponentName2 - ); -} - - -/** - Test whether MTFTP driver support this controller. - - @param This The MTFTP driver binding instance - @param Controller The controller to test - @param RemainingDevicePath The remaining device path - - @retval EFI_SUCCESS The controller has UDP service binding protocol - installed, MTFTP can support it. - @retval EFI_ALREADY_STARTED The device specified by ControllerHandle and - RemainingDevicePath is already being managed by - the driver specified by This. - @retval EFI_ACCESS_DENIED The device specified by ControllerHandle and - RemainingDevicePath is already being managed by a - different driver or an application that requires - exclusive access. - @retval EFI_UNSUPPORTED The device specified by ControllerHandle and - RemainingDevicePath is not supported by the driver - specified by This. - -**/ -EFI_STATUS -EFIAPI -Mtftp4DriverBindingSupported ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE Controller, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath - ) -{ - EFI_STATUS Status; - - Status = gBS->OpenProtocol ( - Controller, - &gEfiUdp4ServiceBindingProtocolGuid, - NULL, - This->DriverBindingHandle, - Controller, - EFI_OPEN_PROTOCOL_TEST_PROTOCOL - ); - - return Status; -} - - -/** - Config a NULL UDP that is used to keep the connection between UDP and MTFTP. - - Just leave the Udp child unconfigured. When UDP is unloaded, - MTFTP will be informed with DriverBinding Stop. - - @param UdpIo The UDP_IO to configure - @param Context The opaque parameter to the callback - - @retval EFI_SUCCESS It always return EFI_SUCCESS directly. - -**/ -EFI_STATUS -EFIAPI -Mtftp4ConfigNullUdp ( - IN UDP_IO *UdpIo, - IN VOID *Context - ) -{ - return EFI_SUCCESS; -} - - -/** - Create then initialize a MTFTP service binding instance. - - @param Controller The controller to install the MTFTP service - binding on - @param Image The driver binding image of the MTFTP driver - @param Service The variable to receive the created service - binding instance. - - @retval EFI_OUT_OF_RESOURCES Failed to allocate resource to create the instance - @retval EFI_DEVICE_ERROR Failed to create a NULL UDP port to keep - connection with UDP. - @retval EFI_SUCCESS The service instance is created for the - controller. - -**/ -EFI_STATUS -Mtftp4CreateService ( - IN EFI_HANDLE Controller, - IN EFI_HANDLE Image, - OUT MTFTP4_SERVICE **Service - ) -{ - MTFTP4_SERVICE *MtftpSb; - EFI_STATUS Status; - - *Service = NULL; - MtftpSb = AllocatePool (sizeof (MTFTP4_SERVICE)); - - if (MtftpSb == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - MtftpSb->Signature = MTFTP4_SERVICE_SIGNATURE; - MtftpSb->ServiceBinding = gMtftp4ServiceBindingTemplete; - MtftpSb->ChildrenNum = 0; - InitializeListHead (&MtftpSb->Children); - - MtftpSb->Timer = NULL; - MtftpSb->TimerNotifyLevel = NULL; - MtftpSb->TimerToGetMap = NULL; - MtftpSb->Controller = Controller; - MtftpSb->Image = Image; - MtftpSb->ConnectUdp = NULL; - - // - // Create the timer and a udp to be notified when UDP is uninstalled - // - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL | EVT_TIMER, - TPL_CALLBACK, - Mtftp4OnTimerTick, - MtftpSb, - &MtftpSb->Timer - ); - if (EFI_ERROR (Status)) { - FreePool (MtftpSb); - return Status; - } - - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL | EVT_TIMER, - TPL_NOTIFY, - Mtftp4OnTimerTickNotifyLevel, - MtftpSb, - &MtftpSb->TimerNotifyLevel - ); - if (EFI_ERROR (Status)) { - gBS->CloseEvent (MtftpSb->Timer); - FreePool (MtftpSb); - return Status; - } - - // - // Create the timer used to time out the procedure which is used to - // get the default IP address. - // - Status = gBS->CreateEvent ( - EVT_TIMER, - TPL_CALLBACK, - NULL, - NULL, - &MtftpSb->TimerToGetMap - ); - if (EFI_ERROR (Status)) { - gBS->CloseEvent (MtftpSb->TimerNotifyLevel); - gBS->CloseEvent (MtftpSb->Timer); - FreePool (MtftpSb); - return Status; - } - - MtftpSb->ConnectUdp = UdpIoCreateIo ( - Controller, - Image, - Mtftp4ConfigNullUdp, - UDP_IO_UDP4_VERSION, - NULL - ); - - if (MtftpSb->ConnectUdp == NULL) { - gBS->CloseEvent (MtftpSb->TimerToGetMap); - gBS->CloseEvent (MtftpSb->TimerNotifyLevel); - gBS->CloseEvent (MtftpSb->Timer); - FreePool (MtftpSb); - return EFI_DEVICE_ERROR; - } - - *Service = MtftpSb; - return EFI_SUCCESS; -} - - -/** - Release all the resource used the MTFTP service binding instance. - - @param MtftpSb The MTFTP service binding instance. - -**/ -VOID -Mtftp4CleanService ( - IN MTFTP4_SERVICE *MtftpSb - ) -{ - UdpIoFreeIo (MtftpSb->ConnectUdp); - gBS->CloseEvent (MtftpSb->TimerToGetMap); - gBS->CloseEvent (MtftpSb->TimerNotifyLevel); - gBS->CloseEvent (MtftpSb->Timer); -} - - -/** - Start the MTFTP driver on this controller. - - MTFTP driver will install a MTFTP SERVICE BINDING protocol on the supported - controller, which can be used to create/destroy MTFTP children. - - @param This The MTFTP driver binding protocol. - @param Controller The controller to manage. - @param RemainingDevicePath Remaining device path. - - @retval EFI_ALREADY_STARTED The MTFTP service binding protocol has been - started on the controller. - @retval EFI_SUCCESS The MTFTP service binding is installed on the - controller. - -**/ -EFI_STATUS -EFIAPI -Mtftp4DriverBindingStart ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE Controller, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath - ) -{ - MTFTP4_SERVICE *MtftpSb; - EFI_STATUS Status; - - // - // Directly return if driver is already running. - // - Status = gBS->OpenProtocol ( - Controller, - &gEfiMtftp4ServiceBindingProtocolGuid, - NULL, - This->DriverBindingHandle, - Controller, - EFI_OPEN_PROTOCOL_TEST_PROTOCOL - ); - - if (Status == EFI_SUCCESS) { - return EFI_ALREADY_STARTED; - } - - Status = Mtftp4CreateService (Controller, This->DriverBindingHandle, &MtftpSb); - - if (EFI_ERROR (Status)) { - return Status; - } - ASSERT (MtftpSb != NULL); - - Status = gBS->SetTimer (MtftpSb->Timer, TimerPeriodic, TICKS_PER_SECOND); - - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - Status = gBS->SetTimer (MtftpSb->TimerNotifyLevel, TimerPeriodic, TICKS_PER_SECOND); - - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - // - // Install the Mtftp4ServiceBinding Protocol onto Controller - // - Status = gBS->InstallMultipleProtocolInterfaces ( - &Controller, - &gEfiMtftp4ServiceBindingProtocolGuid, - &MtftpSb->ServiceBinding, - NULL - ); - - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - return EFI_SUCCESS; - -ON_ERROR: - Mtftp4CleanService (MtftpSb); - FreePool (MtftpSb); - - return Status; -} - -/** - Callback function which provided by user to remove one node in NetDestroyLinkList process. - - @param[in] Entry The entry to be removed. - @param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList. - - @retval EFI_SUCCESS The entry has been removed successfully. - @retval Others Fail to remove the entry. - -**/ -EFI_STATUS -EFIAPI -Mtftp4DestroyChildEntryInHandleBuffer ( - IN LIST_ENTRY *Entry, - IN VOID *Context - ) -{ - MTFTP4_PROTOCOL *Instance; - EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; - UINTN NumberOfChildren; - EFI_HANDLE *ChildHandleBuffer; - - if (Entry == NULL || Context == NULL) { - return EFI_INVALID_PARAMETER; - } - - Instance = NET_LIST_USER_STRUCT_S (Entry, MTFTP4_PROTOCOL, Link, MTFTP4_PROTOCOL_SIGNATURE); - ServiceBinding = ((MTFTP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *) Context)->ServiceBinding; - NumberOfChildren = ((MTFTP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *) Context)->NumberOfChildren; - ChildHandleBuffer = ((MTFTP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *) Context)->ChildHandleBuffer; - - if (!NetIsInHandleBuffer (Instance->Handle, NumberOfChildren, ChildHandleBuffer)) { - return EFI_SUCCESS; - } - - return ServiceBinding->DestroyChild (ServiceBinding, Instance->Handle); -} - -/** - Stop the MTFTP driver on controller. The controller is a UDP - child handle. - - @param This The MTFTP driver binding protocol - @param Controller The controller to stop - @param NumberOfChildren The number of children - @param ChildHandleBuffer The array of the child handle. - - @retval EFI_SUCCESS The driver is stopped on the controller. - @retval EFI_DEVICE_ERROR Failed to stop the driver on the controller. - -**/ -EFI_STATUS -EFIAPI -Mtftp4DriverBindingStop ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE Controller, - IN UINTN NumberOfChildren, - IN EFI_HANDLE *ChildHandleBuffer - ) -{ - EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; - MTFTP4_SERVICE *MtftpSb; - EFI_HANDLE NicHandle; - EFI_STATUS Status; - LIST_ENTRY *List; - MTFTP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT Context; - - // - // MTFTP driver opens UDP child, So, Controller is a UDP - // child handle. Locate the Nic handle first. Then get the - // MTFTP private data back. - // - NicHandle = NetLibGetNicHandle (Controller, &gEfiUdp4ProtocolGuid); - - if (NicHandle == NULL) { - return EFI_SUCCESS; - } - - Status = gBS->OpenProtocol ( - NicHandle, - &gEfiMtftp4ServiceBindingProtocolGuid, - (VOID **) &ServiceBinding, - This->DriverBindingHandle, - NicHandle, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - - if (EFI_ERROR (Status)) { - return EFI_DEVICE_ERROR; - } - - MtftpSb = MTFTP4_SERVICE_FROM_THIS (ServiceBinding); - - if (!IsListEmpty (&MtftpSb->Children)) { - // - // Destroy the Mtftp4 child instance in ChildHandleBuffer. - // - List = &MtftpSb->Children; - Context.ServiceBinding = ServiceBinding; - Context.NumberOfChildren = NumberOfChildren; - Context.ChildHandleBuffer = ChildHandleBuffer; - Status = NetDestroyLinkList ( - List, - Mtftp4DestroyChildEntryInHandleBuffer, - &Context, - NULL - ); - } - - if (NumberOfChildren == 0 && IsListEmpty (&MtftpSb->Children)) { - gBS->UninstallProtocolInterface ( - NicHandle, - &gEfiMtftp4ServiceBindingProtocolGuid, - ServiceBinding - ); - - Mtftp4CleanService (MtftpSb); - if (gMtftp4ControllerNameTable != NULL) { - FreeUnicodeStringTable (gMtftp4ControllerNameTable); - gMtftp4ControllerNameTable = NULL; - } - FreePool (MtftpSb); - - Status = EFI_SUCCESS; - } - - return Status; -} - - -/** - Initialize a MTFTP protocol instance which is the child of MtftpSb. - - @param MtftpSb The MTFTP service binding protocol. - @param Instance The MTFTP instance to initialize. - -**/ -VOID -Mtftp4InitProtocol ( - IN MTFTP4_SERVICE *MtftpSb, - OUT MTFTP4_PROTOCOL *Instance - ) -{ - ZeroMem (Instance, sizeof (MTFTP4_PROTOCOL)); - - Instance->Signature = MTFTP4_PROTOCOL_SIGNATURE; - InitializeListHead (&Instance->Link); - CopyMem (&Instance->Mtftp4, &gMtftp4ProtocolTemplate, sizeof (Instance->Mtftp4)); - Instance->State = MTFTP4_STATE_UNCONFIGED; - Instance->Service = MtftpSb; - - InitializeListHead (&Instance->Blocks); -} - - -/** - Create a MTFTP child for the service binding instance, then - install the MTFTP protocol to the ChildHandle. - - @param This The MTFTP service binding instance. - @param ChildHandle The Child handle to install the MTFTP protocol. - - @retval EFI_INVALID_PARAMETER The parameter is invalid. - @retval EFI_OUT_OF_RESOURCES Failed to allocate resource for the new child. - @retval EFI_SUCCESS The child is successfully create. - -**/ -EFI_STATUS -EFIAPI -Mtftp4ServiceBindingCreateChild ( - IN EFI_SERVICE_BINDING_PROTOCOL *This, - IN EFI_HANDLE *ChildHandle - ) -{ - MTFTP4_SERVICE *MtftpSb; - MTFTP4_PROTOCOL *Instance; - EFI_STATUS Status; - EFI_TPL OldTpl; - VOID *Udp4; - - if ((This == NULL) || (ChildHandle == NULL)) { - return EFI_INVALID_PARAMETER; - } - - Instance = AllocatePool (sizeof (*Instance)); - - if (Instance == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - MtftpSb = MTFTP4_SERVICE_FROM_THIS (This); - - Mtftp4InitProtocol (MtftpSb, Instance); - - Instance->UnicastPort = UdpIoCreateIo ( - MtftpSb->Controller, - MtftpSb->Image, - Mtftp4ConfigNullUdp, - UDP_IO_UDP4_VERSION, - Instance - ); - - if (Instance->UnicastPort == NULL) { - FreePool (Instance); - return EFI_OUT_OF_RESOURCES; - } - - // - // Install the MTFTP protocol onto ChildHandle - // - Status = gBS->InstallMultipleProtocolInterfaces ( - ChildHandle, - &gEfiMtftp4ProtocolGuid, - &Instance->Mtftp4, - NULL - ); - - if (EFI_ERROR (Status)) { - UdpIoFreeIo (Instance->UnicastPort); - FreePool (Instance); - return Status; - } - - Instance->Handle = *ChildHandle; - - // - // Open the Udp4 protocol BY_CHILD. - // - Status = gBS->OpenProtocol ( - MtftpSb->ConnectUdp->UdpHandle, - &gEfiUdp4ProtocolGuid, - (VOID **) &Udp4, - gMtftp4DriverBinding.DriverBindingHandle, - Instance->Handle, - EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER - ); - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - // - // Open the Udp4 protocol by child. - // - Status = gBS->OpenProtocol ( - Instance->UnicastPort->UdpHandle, - &gEfiUdp4ProtocolGuid, - (VOID **) &Udp4, - gMtftp4DriverBinding.DriverBindingHandle, - Instance->Handle, - EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER - ); - if (EFI_ERROR (Status)) { - // - // Close the Udp4 protocol. - // - gBS->CloseProtocol ( - MtftpSb->ConnectUdp->UdpHandle, - &gEfiUdp4ProtocolGuid, - gMtftp4DriverBinding.DriverBindingHandle, - ChildHandle - ); - goto ON_ERROR; - } - - // - // Add it to the parent's child list. - // - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - InsertTailList (&MtftpSb->Children, &Instance->Link); - MtftpSb->ChildrenNum++; - - gBS->RestoreTPL (OldTpl); - - return EFI_SUCCESS; - -ON_ERROR: - if (Instance->Handle != NULL) { - gBS->UninstallMultipleProtocolInterfaces ( - Instance->Handle, - &gEfiMtftp4ProtocolGuid, - &Instance->Mtftp4, - NULL - ); - } - - UdpIoFreeIo (Instance->UnicastPort); - FreePool (Instance); - - return Status; -} - - -/** - Destroy one of the service binding's child. - - @param This The service binding instance - @param ChildHandle The child handle to destroy - - @retval EFI_INVALID_PARAMETER The parameter is invaid. - @retval EFI_UNSUPPORTED The child may have already been destroyed. - @retval EFI_SUCCESS The child is destroyed and removed from the - parent's child list. - -**/ -EFI_STATUS -EFIAPI -Mtftp4ServiceBindingDestroyChild ( - IN EFI_SERVICE_BINDING_PROTOCOL *This, - IN EFI_HANDLE ChildHandle - ) -{ - MTFTP4_SERVICE *MtftpSb; - MTFTP4_PROTOCOL *Instance; - EFI_MTFTP4_PROTOCOL *Mtftp4; - EFI_STATUS Status; - EFI_TPL OldTpl; - - if ((This == NULL) || (ChildHandle == NULL)) { - return EFI_INVALID_PARAMETER; - } - - // - // Retrieve the private context data structures - // - Status = gBS->OpenProtocol ( - ChildHandle, - &gEfiMtftp4ProtocolGuid, - (VOID **) &Mtftp4, - gMtftp4DriverBinding.DriverBindingHandle, - ChildHandle, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - - if (EFI_ERROR (Status)) { - return EFI_UNSUPPORTED; - } - - Instance = MTFTP4_PROTOCOL_FROM_THIS (Mtftp4); - MtftpSb = MTFTP4_SERVICE_FROM_THIS (This); - - if (Instance->Service != MtftpSb) { - return EFI_INVALID_PARAMETER; - } - - if (Instance->InDestroy) { - return EFI_SUCCESS; - } - - Instance->InDestroy = TRUE; - - // - // Close the Udp4 protocol. - // - gBS->CloseProtocol ( - MtftpSb->ConnectUdp->UdpHandle, - &gEfiUdp4ProtocolGuid, - gMtftp4DriverBinding.DriverBindingHandle, - ChildHandle - ); - - gBS->CloseProtocol ( - Instance->UnicastPort->UdpHandle, - &gEfiUdp4ProtocolGuid, - gMtftp4DriverBinding.DriverBindingHandle, - ChildHandle - ); - - if (Instance->McastUdpPort != NULL) { - gBS->CloseProtocol ( - Instance->McastUdpPort->UdpHandle, - &gEfiUdp4ProtocolGuid, - gMtftp4DriverBinding.DriverBindingHandle, - ChildHandle - ); - } - - // - // Uninstall the MTFTP4 protocol first to enable a top down destruction. - // - Status = gBS->UninstallProtocolInterface ( - ChildHandle, - &gEfiMtftp4ProtocolGuid, - Mtftp4 - ); - - if (EFI_ERROR (Status)) { - Instance->InDestroy = FALSE; - return Status; - } - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - Mtftp4CleanOperation (Instance, EFI_DEVICE_ERROR); - UdpIoFreeIo (Instance->UnicastPort); - - RemoveEntryList (&Instance->Link); - MtftpSb->ChildrenNum--; - - gBS->RestoreTPL (OldTpl); - - FreePool (Instance); - return EFI_SUCCESS; -} diff --git a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Driver.h b/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Driver.h deleted file mode 100644 index c90e690186..0000000000 --- a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Driver.h +++ /dev/null @@ -1,131 +0,0 @@ -/** @file - Mtftp drivers function header. - -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef __EFI_MTFTP4_DRIVER_H__ -#define __EFI_MTFTP4_DRIVER_H__ - -#include - -#include - -#include -#include -#include - -extern EFI_COMPONENT_NAME_PROTOCOL gMtftp4ComponentName; -extern EFI_COMPONENT_NAME2_PROTOCOL gMtftp4ComponentName2; -extern EFI_DRIVER_BINDING_PROTOCOL gMtftp4DriverBinding; -extern EFI_UNICODE_STRING_TABLE *gMtftp4ControllerNameTable; - -/** - Test whether MTFTP driver support this controller. - - @param This The MTFTP driver binding instance - @param Controller The controller to test - @param RemainingDevicePath The remaining device path - - @retval EFI_SUCCESS The controller has UDP service binding protocol - installed, MTFTP can support it. - @retval Others MTFTP can't support the controller. - -**/ -EFI_STATUS -EFIAPI -Mtftp4DriverBindingSupported ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE Controller, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath - ); - -/** - Start the MTFTP driver on this controller. - - MTFTP driver will install a MTFTP SERVICE BINDING protocol on the supported - controller, which can be used to create/destroy MTFTP children. - - @param This The MTFTP driver binding protocol. - @param Controller The controller to manage. - @param RemainingDevicePath Remaining device path. - - @retval EFI_ALREADY_STARTED The MTFTP service binding protocol has been - started on the controller. - @retval EFI_SUCCESS The MTFTP service binding is installed on the - controller. - -**/ -EFI_STATUS -EFIAPI -Mtftp4DriverBindingStart ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE Controller, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath - ); - -/** - Stop the MTFTP driver on controller. The controller is a UDP - child handle. - - @param This The MTFTP driver binding protocol - @param Controller The controller to stop - @param NumberOfChildren The number of children - @param ChildHandleBuffer The array of the child handle. - - @retval EFI_SUCCESS The driver is stopped on the controller. - @retval EFI_DEVICE_ERROR Failed to stop the driver on the controller. - -**/ -EFI_STATUS -EFIAPI -Mtftp4DriverBindingStop ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE Controller, - IN UINTN NumberOfChildren, - IN EFI_HANDLE *ChildHandleBuffer - ); - -/** - Create a MTFTP child for the service binding instance, then - install the MTFTP protocol to the ChildHandle. - - @param This The MTFTP service binding instance. - @param ChildHandle The Child handle to install the MTFTP protocol. - - @retval EFI_INVALID_PARAMETER The parameter is invalid. - @retval EFI_OUT_OF_RESOURCES Failed to allocate resource for the new child. - @retval EFI_SUCCESS The child is successfully create. - -**/ -EFI_STATUS -EFIAPI -Mtftp4ServiceBindingCreateChild ( - IN EFI_SERVICE_BINDING_PROTOCOL *This, - IN EFI_HANDLE *ChildHandle - ); - -/** - Destroy one of the service binding's child. - - @param This The service binding instance - @param ChildHandle The child handle to destroy - - @retval EFI_INVALID_PARAMETER The parameter is invaid. - @retval EFI_UNSUPPORTED The child may have already been destroyed. - @retval EFI_SUCCESS The child is destroyed and removed from the - parent's child list. - -**/ -EFI_STATUS -EFIAPI -Mtftp4ServiceBindingDestroyChild ( - IN EFI_SERVICE_BINDING_PROTOCOL *This, - IN EFI_HANDLE ChildHandle - ); - - - -#endif diff --git a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Dxe.inf b/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Dxe.inf deleted file mode 100644 index 6e5335ca23..0000000000 --- a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Dxe.inf +++ /dev/null @@ -1,69 +0,0 @@ -## @file -# This module produces EFI MTFTPv4 Protocol and EFI MTFTPv4 Service Binding Protocol. -# -# This module produces EFI MTFTPv4 Protocol upon EFI UDPv4 Protocol, to provide -# basic services for client-side unicast and/or multicase TFTP operations. -# -# Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
-# SPDX-License-Identifier: BSD-2-Clause-Patent -# -# -## - -[Defines] - INF_VERSION = 0x00010005 - BASE_NAME = Mtftp4Dxe - MODULE_UNI_FILE = Mtftp4Dxe.uni - FILE_GUID = DC3641B8-2FA8-4ed3-BC1F-F9962A03454B - MODULE_TYPE = UEFI_DRIVER - VERSION_STRING = 1.0 - ENTRY_POINT = Mtftp4DriverEntryPoint - UNLOAD_IMAGE = NetLibDefaultUnload -# -# The following information is for reference only and not required by the build tools. -# -# VALID_ARCHITECTURES = IA32 X64 EBC -# -# DRIVER_BINDING = gMtftp4DriverBinding -# COMPONENT_NAME = gMtftp4ComponentName -# COMPONENT_NAME2 = gMtftp4ComponentName2 -# - -[Sources] - Mtftp4Option.c - Mtftp4Rrq.c - Mtftp4Impl.h - ComponentName.c - Mtftp4Support.c - Mtftp4Impl.c - Mtftp4Option.h - Mtftp4Support.h - Mtftp4Driver.h - Mtftp4Driver.c - Mtftp4Wrq.c - - -[Packages] - MdePkg/MdePkg.dec - MdeModulePkg/MdeModulePkg.dec - - -[LibraryClasses] - UefiLib - UefiBootServicesTableLib - UefiDriverEntryPoint - DebugLib - NetLib - UdpIoLib - MemoryAllocationLib - BaseMemoryLib - - -[Protocols] - gEfiMtftp4ServiceBindingProtocolGuid ## BY_START - gEfiUdp4ServiceBindingProtocolGuid ## TO_START - gEfiMtftp4ProtocolGuid ## BY_START - gEfiUdp4ProtocolGuid ## TO_START - -[UserExtensions.TianoCore."ExtraFiles"] - Mtftp4DxeExtra.uni diff --git a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Dxe.uni b/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Dxe.uni deleted file mode 100644 index 1c2c80bcd1..0000000000 --- a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Dxe.uni +++ /dev/null @@ -1,17 +0,0 @@ -// /** @file -// This module produces EFI MTFTPv4 Protocol and EFI MTFTPv4 Service Binding Protocol. -// -// This module produces EFI MTFTPv4 Protocol upon EFI UDPv4 Protocol, to provide -// basic services for client-side unicast and/or multicase TFTP operations. -// -// Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
-// -// SPDX-License-Identifier: BSD-2-Clause-Patent -// -// **/ - - -#string STR_MODULE_ABSTRACT #language en-US "Produces EFI MTFTPv4 Protocol and EFI MTFTPv4 Service Binding Protocol" - -#string STR_MODULE_DESCRIPTION #language en-US "This module produces EFI MTFTPv4 Protocol upon EFI UDPv4 Protocol, to provide basic services for client-side unicast or multicase TFTP operations or both." - diff --git a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4DxeExtra.uni b/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4DxeExtra.uni deleted file mode 100644 index cd685c452d..0000000000 --- a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4DxeExtra.uni +++ /dev/null @@ -1,14 +0,0 @@ -// /** @file -// Mtftp4Dxe Localized Strings and Content -// -// Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.
-// -// SPDX-License-Identifier: BSD-2-Clause-Patent -// -// **/ - -#string STR_PROPERTIES_MODULE_NAME -#language en-US -"MTFTP v4 DXE Driver" - - diff --git a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Impl.c b/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Impl.c deleted file mode 100644 index 70bd693e4e..0000000000 --- a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Impl.c +++ /dev/null @@ -1,1113 +0,0 @@ -/** @file - Interface routine for Mtftp4. - -(C) Copyright 2014 Hewlett-Packard Development Company, L.P.
-Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - - -#include "Mtftp4Impl.h" - - -/** - Clean up the MTFTP session to get ready for new operation. - - @param Instance The MTFTP session to clean up - @param Result The result to return to the caller who initiated - the operation. -**/ -VOID -Mtftp4CleanOperation ( - IN OUT MTFTP4_PROTOCOL *Instance, - IN EFI_STATUS Result - ) -{ - LIST_ENTRY *Entry; - LIST_ENTRY *Next; - MTFTP4_BLOCK_RANGE *Block; - EFI_MTFTP4_TOKEN *Token; - - // - // Free various resources. - // - Token = Instance->Token; - - if (Token != NULL) { - Token->Status = Result; - - if (Token->Event != NULL) { - gBS->SignalEvent (Token->Event); - } - - Instance->Token = NULL; - } - - ASSERT (Instance->UnicastPort != NULL); - UdpIoCleanIo (Instance->UnicastPort); - - if (Instance->LastPacket != NULL) { - NetbufFree (Instance->LastPacket); - Instance->LastPacket = NULL; - } - - if (Instance->McastUdpPort != NULL) { - gBS->CloseProtocol ( - Instance->McastUdpPort->UdpHandle, - &gEfiUdp4ProtocolGuid, - gMtftp4DriverBinding.DriverBindingHandle, - Instance->Handle - ); - UdpIoFreeIo (Instance->McastUdpPort); - Instance->McastUdpPort = NULL; - } - - NET_LIST_FOR_EACH_SAFE (Entry, Next, &Instance->Blocks) { - Block = NET_LIST_USER_STRUCT (Entry, MTFTP4_BLOCK_RANGE, Link); - RemoveEntryList (Entry); - FreePool (Block); - } - - ZeroMem (&Instance->RequestOption, sizeof (MTFTP4_OPTION)); - - Instance->Operation = 0; - - Instance->BlkSize = MTFTP4_DEFAULT_BLKSIZE; - Instance->WindowSize = 1; - Instance->TotalBlock = 0; - Instance->AckedBlock = 0; - Instance->LastBlock = 0; - Instance->ServerIp = 0; - Instance->ListeningPort = 0; - Instance->ConnectedPort = 0; - Instance->Gateway = 0; - Instance->PacketToLive = 0; - Instance->MaxRetry = 0; - Instance->CurRetry = 0; - Instance->Timeout = 0; - Instance->McastIp = 0; - Instance->McastPort = 0; - Instance->Master = TRUE; -} - - -/** - Check packet for GetInfo. - - GetInfo is implemented with EfiMtftp4ReadFile. It use Mtftp4GetInfoCheckPacket - to inspect the first packet from server, then abort the session. - - @param This The MTFTP4 protocol instance - @param Token The user's token - @param PacketLen The length of the packet - @param Packet The received packet. - - @retval EFI_ABORTED Abort the ReadFile operation and return. - -**/ -EFI_STATUS -EFIAPI -Mtftp4GetInfoCheckPacket ( - IN EFI_MTFTP4_PROTOCOL *This, - IN EFI_MTFTP4_TOKEN *Token, - IN UINT16 PacketLen, - IN EFI_MTFTP4_PACKET *Packet - ) -{ - MTFTP4_GETINFO_STATE *State; - EFI_STATUS Status; - UINT16 OpCode; - EFI_MTFTP4_ERROR_HEADER *ErrorHeader; - - State = (MTFTP4_GETINFO_STATE *) Token->Context; - OpCode = NTOHS (Packet->OpCode); - - // - // Set the GetInfo's return status according to the OpCode. - // - switch (OpCode) { - case EFI_MTFTP4_OPCODE_ERROR: - ErrorHeader = (EFI_MTFTP4_ERROR_HEADER *) Packet; - if (ErrorHeader->ErrorCode == EFI_MTFTP4_ERRORCODE_FILE_NOT_FOUND) { - DEBUG ((EFI_D_ERROR, "TFTP error code 1 (File Not Found)\n")); - } else { - DEBUG ((EFI_D_ERROR, "TFTP error code %d\n", ErrorHeader->ErrorCode)); - } - State->Status = EFI_TFTP_ERROR; - break; - - case EFI_MTFTP4_OPCODE_OACK: - State->Status = EFI_SUCCESS; - break; - - default: - State->Status = EFI_PROTOCOL_ERROR; - } - - // - // Allocate buffer then copy the packet over. Use gBS->AllocatePool - // in case AllocatePool will implements something tricky. - // - Status = gBS->AllocatePool (EfiBootServicesData, PacketLen, (VOID **) State->Packet); - - if (EFI_ERROR (Status)) { - State->Status = EFI_OUT_OF_RESOURCES; - return EFI_ABORTED; - } - - *(State->PacketLen) = PacketLen; - CopyMem (*(State->Packet), Packet, PacketLen); - - return EFI_ABORTED; -} - - -/** - Check whether the override data is valid. - - It will first validate whether the server is a valid unicast. If a gateway - is provided in the Override, it also check that it is a unicast on the - connected network. - - @param Instance The MTFTP instance - @param Override The override data to validate. - - @retval TRUE The override data is valid - @retval FALSE The override data is invalid - -**/ -BOOLEAN -Mtftp4OverrideValid ( - IN MTFTP4_PROTOCOL *Instance, - IN EFI_MTFTP4_OVERRIDE_DATA *Override - ) -{ - EFI_MTFTP4_CONFIG_DATA *Config; - IP4_ADDR Ip; - IP4_ADDR Netmask; - IP4_ADDR Gateway; - - CopyMem (&Ip, &Override->ServerIp, sizeof (IP4_ADDR)); - if (IP4_IS_UNSPECIFIED (NTOHL (Ip)) || IP4_IS_LOCAL_BROADCAST (NTOHL (Ip))) { - return FALSE; - } - - Config = &Instance->Config; - - CopyMem (&Gateway, &Override->GatewayIp, sizeof (IP4_ADDR)); - Gateway = NTOHL (Gateway); - - if (!Config->UseDefaultSetting && (Gateway != 0)) { - CopyMem (&Netmask, &Config->SubnetMask, sizeof (IP4_ADDR)); - CopyMem (&Ip, &Config->StationIp, sizeof (IP4_ADDR)); - - Netmask = NTOHL (Netmask); - Ip = NTOHL (Ip); - - if ((Netmask != 0 && !NetIp4IsUnicast (Gateway, Netmask)) || !IP4_NET_EQUAL (Gateway, Ip, Netmask)) { - return FALSE; - } - } - - return TRUE; -} - - -/** - Poll the UDP to get the IP4 default address, which may be retrieved - by DHCP. - - The default time out value is 5 seconds. If IP has retrieved the default address, - the UDP is reconfigured. - - @param Instance The Mtftp instance - @param UdpIo The UDP_IO to poll - @param UdpCfgData The UDP configure data to reconfigure the UDP_IO - - @retval TRUE The default address is retrieved and UDP is reconfigured. - @retval FALSE Some error occured. - -**/ -BOOLEAN -Mtftp4GetMapping ( - IN MTFTP4_PROTOCOL *Instance, - IN UDP_IO *UdpIo, - IN EFI_UDP4_CONFIG_DATA *UdpCfgData - ) -{ - MTFTP4_SERVICE *Service; - EFI_IP4_MODE_DATA Ip4Mode; - EFI_UDP4_PROTOCOL *Udp; - EFI_STATUS Status; - - ASSERT (Instance->Config.UseDefaultSetting); - - Service = Instance->Service; - Udp = UdpIo->Protocol.Udp4; - - Status = gBS->SetTimer ( - Service->TimerToGetMap, - TimerRelative, - MTFTP4_TIME_TO_GETMAP * TICKS_PER_SECOND - ); - if (EFI_ERROR (Status)) { - return FALSE; - } - - while (EFI_ERROR (gBS->CheckEvent (Service->TimerToGetMap))) { - Udp->Poll (Udp); - - if (!EFI_ERROR (Udp->GetModeData (Udp, NULL, &Ip4Mode, NULL, NULL)) && - Ip4Mode.IsConfigured) { - - Udp->Configure (Udp, NULL); - return (BOOLEAN) (Udp->Configure (Udp, UdpCfgData) == EFI_SUCCESS); - } - } - - return FALSE; -} - - -/** - Configure the UDP port for unicast receiving. - - @param UdpIo The UDP_IO instance - @param Instance The MTFTP session - - @retval EFI_SUCCESS The UDP port is successfully configured for the - session to unicast receive. - -**/ -EFI_STATUS -Mtftp4ConfigUnicastPort ( - IN UDP_IO *UdpIo, - IN MTFTP4_PROTOCOL *Instance - ) -{ - EFI_MTFTP4_CONFIG_DATA *Config; - EFI_UDP4_CONFIG_DATA UdpConfig; - EFI_STATUS Status; - IP4_ADDR Ip; - - Config = &Instance->Config; - - UdpConfig.AcceptBroadcast = FALSE; - UdpConfig.AcceptPromiscuous = FALSE; - UdpConfig.AcceptAnyPort = FALSE; - UdpConfig.AllowDuplicatePort = FALSE; - UdpConfig.TypeOfService = 0; - UdpConfig.TimeToLive = 64; - UdpConfig.DoNotFragment = FALSE; - UdpConfig.ReceiveTimeout = 0; - UdpConfig.TransmitTimeout = 0; - UdpConfig.UseDefaultAddress = Config->UseDefaultSetting; - IP4_COPY_ADDRESS (&UdpConfig.StationAddress, &Config->StationIp); - IP4_COPY_ADDRESS (&UdpConfig.SubnetMask, &Config->SubnetMask); - UdpConfig.StationPort = Config->LocalPort; - UdpConfig.RemotePort = 0; - - Ip = HTONL (Instance->ServerIp); - IP4_COPY_ADDRESS (&UdpConfig.RemoteAddress, &Ip); - - Status = UdpIo->Protocol.Udp4->Configure (UdpIo->Protocol.Udp4, &UdpConfig); - - if ((Status == EFI_NO_MAPPING) && Mtftp4GetMapping (Instance, UdpIo, &UdpConfig)) { - return EFI_SUCCESS; - } - - if (!Config->UseDefaultSetting && !EFI_IP4_EQUAL (&mZeroIp4Addr, &Config->GatewayIp)) { - // - // The station IP address is manually configured and the Gateway IP is not 0. - // Add the default route for this UDP instance. - // - Status = UdpIo->Protocol.Udp4->Routes ( - UdpIo->Protocol.Udp4, - FALSE, - &mZeroIp4Addr, - &mZeroIp4Addr, - &Config->GatewayIp - ); - if (EFI_ERROR (Status)) { - UdpIo->Protocol.Udp4->Configure (UdpIo->Protocol.Udp4, NULL); - } - } - return Status; -} - - -/** - Start the MTFTP session to do the operation, such as read file, - write file, and read directory. - - @param This The MTFTP session - @param Token The token than encapsues the user's request. - @param Operation The operation to do - - @retval EFI_INVALID_PARAMETER Some of the parameters are invalid. - @retval EFI_NOT_STARTED The MTFTP session hasn't been configured. - @retval EFI_ALREADY_STARTED There is pending operation for the session. - @retval EFI_SUCCESS The operation is successfully started. - -**/ -EFI_STATUS -Mtftp4Start ( - IN EFI_MTFTP4_PROTOCOL *This, - IN EFI_MTFTP4_TOKEN *Token, - IN UINT16 Operation - ) -{ - MTFTP4_PROTOCOL *Instance; - EFI_MTFTP4_OVERRIDE_DATA *Override; - EFI_MTFTP4_CONFIG_DATA *Config; - EFI_TPL OldTpl; - EFI_STATUS Status; - EFI_STATUS TokenStatus; - - // - // Validate the parameters - // - if ((This == NULL) || (Token == NULL) || (Token->Filename == NULL) || - ((Token->OptionCount != 0) && (Token->OptionList == NULL))) { - return EFI_INVALID_PARAMETER; - } - - // - // User must provide at least one method to collect the data for download. - // - if (((Operation == EFI_MTFTP4_OPCODE_RRQ) || (Operation == EFI_MTFTP4_OPCODE_DIR)) && - ((Token->Buffer == NULL) && (Token->CheckPacket == NULL))) { - return EFI_INVALID_PARAMETER; - } - - // - // User must provide at least one method to provide the data for upload. - // - if ((Operation == EFI_MTFTP4_OPCODE_WRQ) && - ((Token->Buffer == NULL) && (Token->PacketNeeded == NULL))) { - return EFI_INVALID_PARAMETER; - } - - Instance = MTFTP4_PROTOCOL_FROM_THIS (This); - - Status = EFI_SUCCESS; - TokenStatus = EFI_SUCCESS; - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - if (Instance->State != MTFTP4_STATE_CONFIGED) { - Status = EFI_NOT_STARTED; - } - - if (Instance->Operation != 0) { - Status = EFI_ACCESS_DENIED; - } - - if ((Token->OverrideData != NULL) && !Mtftp4OverrideValid (Instance, Token->OverrideData)) { - Status = EFI_INVALID_PARAMETER; - } - - if (EFI_ERROR (Status)) { - gBS->RestoreTPL (OldTpl); - return Status; - } - - // - // Set the Operation now to prevent the application start other - // operations. - // - Instance->Operation = Operation; - Override = Token->OverrideData; - - if (Token->OptionCount != 0) { - Status = Mtftp4ParseOption ( - Token->OptionList, - Token->OptionCount, - TRUE, - Instance->Operation, - &Instance->RequestOption - ); - - if (EFI_ERROR (Status)) { - TokenStatus = EFI_DEVICE_ERROR; - goto ON_ERROR; - } - } - - // - // Set the operation parameters from the configuration or override data. - // - Config = &Instance->Config; - Instance->Token = Token; - Instance->BlkSize = MTFTP4_DEFAULT_BLKSIZE; - Instance->WindowSize = MTFTP4_DEFAULT_WINDOWSIZE; - - CopyMem (&Instance->ServerIp, &Config->ServerIp, sizeof (IP4_ADDR)); - Instance->ServerIp = NTOHL (Instance->ServerIp); - - Instance->ListeningPort = Config->InitialServerPort; - Instance->ConnectedPort = 0; - - CopyMem (&Instance->Gateway, &Config->GatewayIp, sizeof (IP4_ADDR)); - Instance->Gateway = NTOHL (Instance->Gateway); - - Instance->MaxRetry = Config->TryCount; - Instance->Timeout = Config->TimeoutValue; - Instance->Master = TRUE; - - if (Override != NULL) { - CopyMem (&Instance->ServerIp, &Override->ServerIp, sizeof (IP4_ADDR)); - CopyMem (&Instance->Gateway, &Override->GatewayIp, sizeof (IP4_ADDR)); - - Instance->ServerIp = NTOHL (Instance->ServerIp); - Instance->Gateway = NTOHL (Instance->Gateway); - - Instance->ListeningPort = Override->ServerPort; - Instance->MaxRetry = Override->TryCount; - Instance->Timeout = Override->TimeoutValue; - } - - if (Instance->ListeningPort == 0) { - Instance->ListeningPort = MTFTP4_DEFAULT_SERVER_PORT; - } - - if (Instance->MaxRetry == 0) { - Instance->MaxRetry = MTFTP4_DEFAULT_RETRY; - } - - if (Instance->Timeout == 0) { - Instance->Timeout = MTFTP4_DEFAULT_TIMEOUT; - } - - // - // Config the unicast UDP child to send initial request - // - Status = Mtftp4ConfigUnicastPort (Instance->UnicastPort, Instance); - if (EFI_ERROR (Status)) { - TokenStatus = EFI_DEVICE_ERROR; - goto ON_ERROR; - } - - // - // Set initial status. - // - Token->Status = EFI_NOT_READY; - - // - // Build and send an initial requests - // - if (Operation == EFI_MTFTP4_OPCODE_WRQ) { - Status = Mtftp4WrqStart (Instance, Operation); - } else { - Status = Mtftp4RrqStart (Instance, Operation); - } - - if (EFI_ERROR (Status)) { - TokenStatus = EFI_DEVICE_ERROR; - goto ON_ERROR; - } - - gBS->RestoreTPL(OldTpl); - - if (Token->Event != NULL) { - return EFI_SUCCESS; - } - - // - // Return immediately for asynchronous operation or poll the - // instance for synchronous operation. - // - while (Token->Status == EFI_NOT_READY) { - This->Poll (This); - } - - return Token->Status; - -ON_ERROR: - Mtftp4CleanOperation (Instance, TokenStatus); - gBS->RestoreTPL (OldTpl); - - return Status; -} - - -/** - Reads the current operational settings. - - The GetModeData()function reads the current operational settings of this - EFI MTFTPv4 Protocol driver instance. - - @param This Pointer to the EFI_MTFTP4_PROTOCOL instance. - @param ModeData Pointer to storage for the EFI MTFTPv4 Protocol - driver mode data. - - @retval EFI_SUCCESS The configuration data was successfully returned. - @retval EFI_OUT_OF_RESOURCES The required mode data could not be allocated. - @retval EFI_INVALID_PARAMETER This is NULL or ModeData is NULL. - -**/ -EFI_STATUS -EFIAPI -EfiMtftp4GetModeData ( - IN EFI_MTFTP4_PROTOCOL *This, - OUT EFI_MTFTP4_MODE_DATA *ModeData - ) -{ - MTFTP4_PROTOCOL *Instance; - EFI_TPL OldTpl; - - if ((This == NULL) || (ModeData == NULL)) { - return EFI_INVALID_PARAMETER; - } - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - Instance = MTFTP4_PROTOCOL_FROM_THIS (This); - CopyMem(&ModeData->ConfigData, &Instance->Config, sizeof (Instance->Config)); - ModeData->SupportedOptionCount = MTFTP4_SUPPORTED_OPTIONS; - ModeData->SupportedOptoins = (UINT8 **) mMtftp4SupportedOptions; - ModeData->UnsupportedOptionCount = 0; - ModeData->UnsupportedOptoins = NULL; - - gBS->RestoreTPL (OldTpl); - - return EFI_SUCCESS; -} - - - -/** - Initializes, changes, or resets the default operational setting for this - EFI MTFTPv4 Protocol driver instance. - - The Configure() function is used to set and change the configuration data for - this EFI MTFTPv4 Protocol driver instance. The configuration data can be reset - to startup defaults by calling Configure() with MtftpConfigData set to NULL. - Whenever the instance is reset, any pending operation is aborted. By changing - the EFI MTFTPv4 Protocol driver instance configuration data, the client can - connect to different MTFTPv4 servers. The configuration parameters in - MtftpConfigData are used as the default parameters in later MTFTPv4 operations - and can be overridden in later operations. - - @param This Pointer to the EFI_MTFTP4_PROTOCOL instance - @param ConfigData MtftpConfigDataPointer to the configuration data - structure - - @retval EFI_SUCCESS The EFI MTFTPv4 Protocol driver was configured - successfully. - @retval EFI_INVALID_PARAMETER One or more following conditions are TRUE: - 1.This is NULL. - 2.MtftpConfigData.UseDefaultSetting is FALSE and - MtftpConfigData.StationIp is not a valid IPv4 - unicast address. - 3.MtftpCofigData.UseDefaultSetting is FALSE and - MtftpConfigData.SubnetMask is invalid. - 4.MtftpCofigData.ServerIp is not a valid IPv4 - unicast address. - 5.MtftpConfigData.UseDefaultSetting is FALSE and - MtftpConfigData.GatewayIp is not a valid IPv4 - unicast address or is not in the same subnet - with station address. - @retval EFI_ACCESS_DENIED The EFI configuration could not be changed at this - time because there is one MTFTP background operation - in progress. - @retval EFI_NO_MAPPING When using a default address, configuration - (DHCP, BOOTP, RARP, etc.) has not finished yet. - @retval EFI_UNSUPPORTED A configuration protocol (DHCP, BOOTP, RARP, etc.) - could not be located when clients choose to use - the default address settings. - @retval EFI_OUT_OF_RESOURCES The EFI MTFTPv4 Protocol driver instance data could - not be allocated. - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. - The EFI MTFTPv4 Protocol driver instance is not - configured. - -**/ -EFI_STATUS -EFIAPI -EfiMtftp4Configure ( - IN EFI_MTFTP4_PROTOCOL *This, - IN EFI_MTFTP4_CONFIG_DATA *ConfigData - ) -{ - MTFTP4_PROTOCOL *Instance; - EFI_TPL OldTpl; - IP4_ADDR Ip; - IP4_ADDR Netmask; - IP4_ADDR Gateway; - IP4_ADDR ServerIp; - - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - Instance = MTFTP4_PROTOCOL_FROM_THIS (This); - - if (ConfigData == NULL) { - // - // Reset the operation if ConfigData is NULL - // - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - Mtftp4CleanOperation (Instance, EFI_ABORTED); - ZeroMem (&Instance->Config, sizeof (EFI_MTFTP4_CONFIG_DATA)); - Instance->State = MTFTP4_STATE_UNCONFIGED; - - gBS->RestoreTPL (OldTpl); - - } else { - // - // Configure the parameters for new operation. - // - CopyMem (&Ip, &ConfigData->StationIp, sizeof (IP4_ADDR)); - CopyMem (&Netmask, &ConfigData->SubnetMask, sizeof (IP4_ADDR)); - CopyMem (&Gateway, &ConfigData->GatewayIp, sizeof (IP4_ADDR)); - CopyMem (&ServerIp, &ConfigData->ServerIp, sizeof (IP4_ADDR)); - - Ip = NTOHL (Ip); - Netmask = NTOHL (Netmask); - Gateway = NTOHL (Gateway); - ServerIp = NTOHL (ServerIp); - - if (ServerIp == 0 || IP4_IS_LOCAL_BROADCAST (ServerIp)) { - return EFI_INVALID_PARAMETER; - } - - if (!ConfigData->UseDefaultSetting && - ((!IP4_IS_VALID_NETMASK (Netmask) || (Netmask != 0 && !NetIp4IsUnicast (Ip, Netmask))))) { - - return EFI_INVALID_PARAMETER; - } - - if ((Gateway != 0) && - ((Netmask != 0xFFFFFFFF && !IP4_NET_EQUAL (Gateway, Ip, Netmask)) || (Netmask != 0 && !NetIp4IsUnicast (Gateway, Netmask)))) { - - return EFI_INVALID_PARAMETER; - } - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - if ((Instance->State == MTFTP4_STATE_CONFIGED) && (Instance->Operation != 0)) { - gBS->RestoreTPL (OldTpl); - return EFI_ACCESS_DENIED; - } - - CopyMem(&Instance->Config, ConfigData, sizeof (*ConfigData));; - Instance->State = MTFTP4_STATE_CONFIGED; - - gBS->RestoreTPL (OldTpl); - } - - return EFI_SUCCESS; -} - - - -/** - Parses the options in an MTFTPv4 OACK packet. - - The ParseOptions() function parses the option fields in an MTFTPv4 OACK packet - and returns the number of options that were found and optionally a list of - pointers to the options in the packet. - If one or more of the option fields are not valid, then EFI_PROTOCOL_ERROR is - returned and *OptionCount and *OptionList stop at the last valid option. - The OptionList is allocated by this function, and caller should free it when used. - - @param This Pointer to the EFI_MTFTP4_PROTOCOL instance. - @param PacketLen Length of the OACK packet to be parsed. - @param Packet Pointer to the OACK packet to be parsed. - @param OptionCount Pointer to the number of options in following OptionList. - @param OptionList Pointer to EFI_MTFTP4_OPTION storage. Call the - EFI Boot Service FreePool() to release theOptionList - if the options in this OptionList are not needed - any more - - @retval EFI_SUCCESS The OACK packet was valid and the OptionCount and - OptionList parameters have been updated. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - 1.PacketLen is 0. - 2.Packet is NULL or Packet is not a valid MTFTPv4 packet. - 3.OptionCount is NULL. - @retval EFI_NOT_FOUND No options were found in the OACK packet. - @retval EFI_OUT_OF_RESOURCES Storage for the OptionList array cannot be allocated. - @retval EFI_PROTOCOL_ERROR One or more of the option fields is invalid. - -**/ -EFI_STATUS -EFIAPI -EfiMtftp4ParseOptions ( - IN EFI_MTFTP4_PROTOCOL *This, - IN UINT32 PacketLen, - IN EFI_MTFTP4_PACKET *Packet, - OUT UINT32 *OptionCount, - OUT EFI_MTFTP4_OPTION **OptionList OPTIONAL - ) -{ - EFI_STATUS Status; - - if ((This == NULL) || (PacketLen < MTFTP4_OPCODE_LEN) || - (Packet == NULL) || (OptionCount == NULL)) { - - return EFI_INVALID_PARAMETER; - } - - Status = Mtftp4ExtractOptions (Packet, PacketLen, OptionCount, OptionList); - - if (EFI_ERROR (Status)) { - return Status; - } - - if (*OptionCount == 0) { - return EFI_NOT_FOUND; - } - - return EFI_SUCCESS; -} - - -/** - Downloads a file from an MTFTPv4 server. - - The ReadFile() function is used to initialize and start an MTFTPv4 download - process and optionally wait for completion. When the download operation completes, - whether successfully or not, the Token.Status field is updated by the EFI MTFTPv4 - Protocol driver and then Token.Event is signaled (if it is not NULL). - Data can be downloaded from the MTFTPv4 server into either of the following locations: - 1.A fixed buffer that is pointed to by Token.Buffer - 2.A download service function that is pointed to by Token.CheckPacket - If both Token.Buffer and Token.CheckPacket are used, then Token.CheckPacket - will be called first. If the call is successful, the packet will be stored in - Token.Buffer. - - @param This Pointer to the EFI_MTFTP4_PROTOCOL instance - @param Token Pointer to the token structure to provide the - parameters that are used in this operation. - - @retval EFI_SUCCESS The data file has been transferred successfully. - @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. - @retval EFI_BUFFER_TOO_SMALL BufferSize is not large enough to hold the downloaded - data in downloading process. - @retval EFI_ABORTED Current operation is aborted by user. - @retval EFI_ICMP_ERROR An ICMP ERROR packet was received. - @retval EFI_TIMEOUT No responses were received from the MTFTPv4 server. - @retval EFI_TFTP_ERROR An MTFTPv4 ERROR packet was received. - @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred. - @retval EFI_NO_MEDIA There was a media error. - -**/ -EFI_STATUS -EFIAPI -EfiMtftp4ReadFile ( - IN EFI_MTFTP4_PROTOCOL *This, - IN EFI_MTFTP4_TOKEN *Token - ) -{ - return Mtftp4Start (This, Token, EFI_MTFTP4_OPCODE_RRQ); -} - - -/** - Sends a data file to an MTFTPv4 server. May be unsupported in some EFI implementations - - The WriteFile() function is used to initialize an uploading operation with the - given option list and optionally wait for completion. If one or more of the - options is not supported by the server, the unsupported options are ignored and - a standard TFTP process starts instead. When the upload process completes, - whether successfully or not, Token.Event is signaled, and the EFI MTFTPv4 Protocol - driver updates Token.Status. - The caller can supply the data to be uploaded in the following two modes: - 1.Through the user-provided buffer - 2.Through a callback function - With the user-provided buffer, the Token.BufferSize field indicates the length - of the buffer, and the driver will upload the data in the buffer. With an - EFI_MTFTP4_PACKET_NEEDED callback function, the driver will call this callback - function to get more data from the user to upload. See the definition of - EFI_MTFTP4_PACKET_NEEDED for more information. These two modes cannot be used at - the same time. The callback function will be ignored if the user provides the buffer. - - @param This Pointer to the EFI_MTFTP4_PROTOCOL instance. - @param Token Pointer to the token structure to provide the - parameters that are used in this function - - @retval EFI_SUCCESS The upload session has started. - @retval EFI_UNSUPPORTED The operation is not supported by this implementation. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - 1. This is NULL. - 2. Token is NULL. - 3. Token.Filename is NULL. - 4. Token.OptionCount is not zero and - Token.OptionList is NULL. - 5. One or more options in Token.OptionList have wrong - format. - 6. Token.Buffer and Token.PacketNeeded are both - NULL. - 7. One or more IPv4 addresses in Token.OverrideData - are not valid unicast IPv4 addresses if - Token.OverrideData is not NULL. - @retval EFI_UNSUPPORTED One or more options in the Token.OptionList are in the - unsupported list of structure EFI_MTFTP4_MODE_DATA. - @retval EFI_NOT_STARTED The EFI MTFTPv4 Protocol driver has not been started. - @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, - BOOTP, RARP, etc.) is not finished yet. - @retval EFI_ALREADY_STARTED This Token is already being used in another MTFTPv4 - session. - @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. - @retval EFI_ACCESS_DENIED The previous operation has not completed yet. - @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred. - -**/ -EFI_STATUS -EFIAPI -EfiMtftp4WriteFile ( - IN EFI_MTFTP4_PROTOCOL *This, - IN EFI_MTFTP4_TOKEN *Token - ) -{ - return Mtftp4Start (This, Token, EFI_MTFTP4_OPCODE_WRQ); -} - - -/** - Downloads a data file "directory" from an MTFTPv4 server. - May be unsupported in some EFI implementations - - The ReadDirectory() function is used to return a list of files on the MTFTPv4 - server that are logically (or operationally) related to Token.Filename. The - directory request packet that is sent to the server is built with the option - list that was provided by caller, if present. - The file information that the server returns is put into either of the following - locations: - 1.A fixed buffer that is pointed to by Token.Buffer - 2.A download service function that is pointed to by Token.CheckPacket - If both Token.Buffer and Token.CheckPacket are used, then Token.CheckPacket will - be called first. If the call is successful, the packet will be stored in Token.Buffer. - The returned directory listing in the Token.Buffer or EFI_MTFTP4_PACKET consists - of a list of two or three variable-length ASCII strings, each terminated by a - null character, for each file in the directory. If the multicast option is involved, - the first field of each directory entry is the static multicast IP address and - UDP port number that is associated with the file name. The format of the field - is ip:ip:ip:ip:port. If the multicast option is not involved, this field and its - terminating null character are not present. - The next field of each directory entry is the file name and the last field is - the file information string. The information string contains the file size and - the create/modify timestamp. The format of the information string is filesize - yyyy-mm-dd hh:mm:ss:ffff. The timestamp is Coordinated Universal Time - (UTC; also known as Greenwich Mean Time [GMT]). - The only difference between ReadFile and ReadDirectory is the opcode used. - - @param This Pointer to the EFI_MTFTP4_PROTOCOL instance - @param Token Pointer to the token structure to provide the - parameters that are used in this function - - @retval EFI_SUCCESS The MTFTPv4 related file "directory" has been downloaded. - @retval EFI_UNSUPPORTED The operation is not supported by this implementation. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - 1. This is NULL. - 2. Token is NULL. - 3. Token.Filename is NULL. - 4. Token.OptionCount is not zero and - Token.OptionList is NULL. - 5. One or more options in Token.OptionList have wrong - format. - 6. Token.Buffer and Token.PacketNeeded are both - NULL. - 7. One or more IPv4 addresses in Token.OverrideData - are not valid unicast IPv4 addresses if - Token.OverrideData is not NULL. - @retval EFI_UNSUPPORTED One or more options in the Token.OptionList are in the - unsupported list of structure EFI_MTFTP4_MODE_DATA. - @retval EFI_NOT_STARTED The EFI MTFTPv4 Protocol driver has not been started. - @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, - BOOTP, RARP, etc.) is not finished yet. - @retval EFI_ALREADY_STARTED This Token is already being used in another MTFTPv4 - session. - @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. - @retval EFI_ACCESS_DENIED The previous operation has not completed yet. - @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred. - -**/ -EFI_STATUS -EFIAPI -EfiMtftp4ReadDirectory ( - IN EFI_MTFTP4_PROTOCOL *This, - IN EFI_MTFTP4_TOKEN *Token - ) -{ - return Mtftp4Start (This, Token, EFI_MTFTP4_OPCODE_DIR); -} - - -/** - Gets information about a file from an MTFTPv4 server. - - The GetInfo() function assembles an MTFTPv4 request packet with options; - sends it to the MTFTPv4 server; and may return an MTFTPv4 OACK, MTFTPv4 ERROR, - or ICMP ERROR packet. Retries occur only if no response packets are received - from the MTFTPv4 server before the timeout expires. - It is implemented with EfiMtftp4ReadFile: build a token, then pass it to - EfiMtftp4ReadFile. In its check packet callback abort the opertions. - - @param This Pointer to the EFI_MTFTP4_PROTOCOL instance - @param OverrideData Data that is used to override the existing - parameters. If NULL, the default parameters that - were set in the EFI_MTFTP4_PROTOCOL.Configure() - function are used - @param Filename Pointer to null-terminated ASCII file name string - @param ModeStr Pointer to null-terminated ASCII mode string. If NULL, "octet" - will be used - @param OptionCount Number of option/value string pairs in OptionList - @param OptionList Pointer to array of option/value string pairs. - Ignored if OptionCount is zero - @param PacketLength The number of bytes in the returned packet - @param Packet PacketThe pointer to the received packet. This - buffer must be freed by the caller. - - @retval EFI_SUCCESS An MTFTPv4 OACK packet was received and is in - the Buffer. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - 1.This is NULL. - 2.Filename is NULL. - 3.OptionCount is not zero and OptionList is NULL. - 4.One or more options in OptionList have wrong format. - 5.PacketLength is NULL. - 6.One or more IPv4 addresses in OverrideData are - not valid unicast IPv4 addresses if OverrideData - is not NULL. - @retval EFI_UNSUPPORTED One or more options in the OptionList are in the - unsupported list of structure EFI_MTFTP4_MODE_DATA - @retval EFI_NOT_STARTED The EFI MTFTPv4 Protocol driver has not been started. - @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, - BOOTP, RARP, etc.) has not finished yet. - @retval EFI_ACCESS_DENIED The previous operation has not completed yet. - @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. - @retval EFI_TFTP_ERROR An MTFTPv4 ERROR packet was received and is in - the Buffer. - @retval EFI_ICMP_ERROR An ICMP ERROR packet was received and the Packet - is set to NULL. - @retval EFI_PROTOCOL_ERROR An unexpected MTFTPv4 packet was received and is - in the Buffer. - @retval EFI_TIMEOUT No responses were received from the MTFTPv4 server. - @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred. - @retval EFI_NO_MEDIA There was a media error. - -**/ -EFI_STATUS -EFIAPI -EfiMtftp4GetInfo ( - IN EFI_MTFTP4_PROTOCOL *This, - IN EFI_MTFTP4_OVERRIDE_DATA *OverrideData OPTIONAL, - IN UINT8 *Filename, - IN UINT8 *ModeStr OPTIONAL, - IN UINT8 OptionCount, - IN EFI_MTFTP4_OPTION *OptionList OPTIONAL, - OUT UINT32 *PacketLength, - OUT EFI_MTFTP4_PACKET **Packet OPTIONAL - ) -{ - EFI_MTFTP4_TOKEN Token; - MTFTP4_GETINFO_STATE State; - EFI_STATUS Status; - - if ((This == NULL) || (Filename == NULL) || (PacketLength == NULL) || - ((OptionCount != 0) && (OptionList == NULL))) { - return EFI_INVALID_PARAMETER; - } - - if (Packet != NULL) { - *Packet = NULL; - } - - *PacketLength = 0; - State.Packet = Packet; - State.PacketLen = PacketLength; - State.Status = EFI_SUCCESS; - - // - // Fill in the Token to issue an synchronous ReadFile operation - // - Token.Status = EFI_SUCCESS; - Token.Event = NULL; - Token.OverrideData = OverrideData; - Token.Filename = Filename; - Token.ModeStr = ModeStr; - Token.OptionCount = OptionCount; - Token.OptionList = OptionList; - Token.BufferSize = 0; - Token.Buffer = NULL; - Token.Context = &State; - Token.CheckPacket = Mtftp4GetInfoCheckPacket; - Token.TimeoutCallback = NULL; - Token.PacketNeeded = NULL; - - Status = EfiMtftp4ReadFile (This, &Token); - - if (EFI_ABORTED == Status) { - return State.Status; - } - - return Status; -} - -/** - Polls for incoming data packets and processes outgoing data packets. - - The Poll() function can be used by network drivers and applications to increase - the rate that data packets are moved between the communications device and the - transmit and receive queues. - In some systems, the periodic timer event in the managed network driver may not - poll the underlying communications device fast enough to transmit and/or receive - all data packets without missing incoming packets or dropping outgoing packets. - Drivers and applications that are experiencing packet loss should try calling - the Poll() function more often. - - @param This Pointer to the EFI_MTFTP4_PROTOCOL instance - - @retval EFI_SUCCESS Incoming or outgoing data was processed. - @retval EFI_NOT_STARTED This EFI MTFTPv4 Protocol instance has not been started. - @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, - BOOTP, RARP, etc.) is not finished yet. - @retval EFI_INVALID_PARAMETER This is NULL. - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. - @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive - queue. Consider increasing the polling rate. - -**/ -EFI_STATUS -EFIAPI -EfiMtftp4Poll ( - IN EFI_MTFTP4_PROTOCOL *This - ) -{ - MTFTP4_PROTOCOL *Instance; - EFI_UDP4_PROTOCOL *Udp; - EFI_STATUS Status; - - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - Instance = MTFTP4_PROTOCOL_FROM_THIS (This); - - if (Instance->State == MTFTP4_STATE_UNCONFIGED) { - return EFI_NOT_STARTED; - } else if (Instance->State == MTFTP4_STATE_DESTROY) { - return EFI_DEVICE_ERROR; - } - - Udp = Instance->UnicastPort->Protocol.Udp4; - Status = Udp->Poll (Udp); - Mtftp4OnTimerTick (NULL, Instance->Service); - return Status; -} - -EFI_MTFTP4_PROTOCOL gMtftp4ProtocolTemplate = { - EfiMtftp4GetModeData, - EfiMtftp4Configure, - EfiMtftp4GetInfo, - EfiMtftp4ParseOptions, - EfiMtftp4ReadFile, - EfiMtftp4WriteFile, - EfiMtftp4ReadDirectory, - EfiMtftp4Poll -}; diff --git a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Impl.h b/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Impl.h deleted file mode 100644 index 33393d4247..0000000000 --- a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Impl.h +++ /dev/null @@ -1,226 +0,0 @@ -/** @file - - Mtftp4 Implementation. - - Mtftp4 Implementation, it supports the following RFCs: - RFC1350 - THE TFTP PROTOCOL (REVISION 2) - RFC2090 - TFTP Multicast Option - RFC2347 - TFTP Option Extension - RFC2348 - TFTP Blocksize Option - RFC2349 - TFTP Timeout Interval and Transfer Size Options - RFC7440 - TFTP Windowsize Option - -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - - -#ifndef __EFI_MTFTP4_IMPL_H__ -#define __EFI_MTFTP4_IMPL_H__ - -#include - -#include -#include - -#include -#include -#include -#include -#include -#include - -extern EFI_MTFTP4_PROTOCOL gMtftp4ProtocolTemplate; - -typedef struct _MTFTP4_SERVICE MTFTP4_SERVICE; -typedef struct _MTFTP4_PROTOCOL MTFTP4_PROTOCOL; - -#include "Mtftp4Driver.h" -#include "Mtftp4Option.h" -#include "Mtftp4Support.h" - - -/// -/// Some constant value of Mtftp service. -/// -#define MTFTP4_SERVICE_SIGNATURE SIGNATURE_32 ('T', 'F', 'T', 'P') -#define MTFTP4_PROTOCOL_SIGNATURE SIGNATURE_32 ('t', 'f', 't', 'p') - -#define MTFTP4_DEFAULT_SERVER_PORT 69 -#define MTFTP4_DEFAULT_TIMEOUT 3 -#define MTFTP4_DEFAULT_RETRY 5 -#define MTFTP4_DEFAULT_BLKSIZE 512 -#define MTFTP4_DEFAULT_WINDOWSIZE 1 -#define MTFTP4_TIME_TO_GETMAP 5 - -#define MTFTP4_STATE_UNCONFIGED 0 -#define MTFTP4_STATE_CONFIGED 1 -#define MTFTP4_STATE_DESTROY 2 - -/// -/// Mtftp service block -/// -struct _MTFTP4_SERVICE { - UINT32 Signature; - EFI_SERVICE_BINDING_PROTOCOL ServiceBinding; - - UINT16 ChildrenNum; - LIST_ENTRY Children; - - EFI_EVENT Timer; ///< Ticking timer for all the MTFTP clients to handle the packet timeout case. - EFI_EVENT TimerNotifyLevel; ///< Ticking timer for all the MTFTP clients to calculate the packet live time. - EFI_EVENT TimerToGetMap; - - EFI_HANDLE Controller; - EFI_HANDLE Image; - - // - // This UDP child is used to keep the connection between the UDP - // and MTFTP, so MTFTP will be notified when UDP is uninstalled. - // - UDP_IO *ConnectUdp; -}; - - -typedef struct { - EFI_MTFTP4_PACKET **Packet; - UINT32 *PacketLen; - EFI_STATUS Status; -} MTFTP4_GETINFO_STATE; - -struct _MTFTP4_PROTOCOL { - UINT32 Signature; - LIST_ENTRY Link; - EFI_MTFTP4_PROTOCOL Mtftp4; - - INTN State; - BOOLEAN InDestroy; - - MTFTP4_SERVICE *Service; - EFI_HANDLE Handle; - - EFI_MTFTP4_CONFIG_DATA Config; - - // - // Operation parameters: token and requested options. - // - EFI_MTFTP4_TOKEN *Token; - MTFTP4_OPTION RequestOption; - UINT16 Operation; - - // - // Blocks is a list of MTFTP4_BLOCK_RANGE which contains - // holes in the file - // - UINT16 BlkSize; - UINT16 LastBlock; - LIST_ENTRY Blocks; - - UINT16 WindowSize; - - // - // Record the total received and saved block number. - // - UINT64 TotalBlock; - - // - // Record the acked block number. - // - UINT64 AckedBlock; - - // - // The server's communication end point: IP and two ports. one for - // initial request, one for its selected port. - // - IP4_ADDR ServerIp; - UINT16 ListeningPort; - UINT16 ConnectedPort; - IP4_ADDR Gateway; - UDP_IO *UnicastPort; - - // - // Timeout and retransmit status - // - NET_BUF *LastPacket; - UINT32 PacketToLive; - BOOLEAN HasTimeout; - UINT32 CurRetry; - UINT32 MaxRetry; - UINT32 Timeout; - - // - // Parameter used by RRQ's multicast download. - // - IP4_ADDR McastIp; - UINT16 McastPort; - BOOLEAN Master; - UDP_IO *McastUdpPort; -}; - -typedef struct { - EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; - UINTN NumberOfChildren; - EFI_HANDLE *ChildHandleBuffer; -} MTFTP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT; - -/** - Clean up the MTFTP session to get ready for new operation. - - @param Instance The MTFTP session to clean up - @param Result The result to return to the caller who initiated - the operation. -**/ -VOID -Mtftp4CleanOperation ( - IN OUT MTFTP4_PROTOCOL *Instance, - IN EFI_STATUS Result - ); - -/** - Start the MTFTP session for upload. - - It will first init some states, then send the WRQ request packet, - and start receiving the packet. - - @param Instance The MTFTP session - @param Operation Redundant parameter, which is always - EFI_MTFTP4_OPCODE_WRQ here. - - @retval EFI_SUCCESS The upload process has been started. - @retval Others Failed to start the upload. - -**/ -EFI_STATUS -Mtftp4WrqStart ( - IN MTFTP4_PROTOCOL *Instance, - IN UINT16 Operation - ); - -/** - Start the MTFTP session to download. - - It will first initialize some of the internal states then build and send a RRQ - reqeuest packet, at last, it will start receive for the downloading. - - @param Instance The Mtftp session - @param Operation The MTFTP opcode, it may be a EFI_MTFTP4_OPCODE_RRQ - or EFI_MTFTP4_OPCODE_DIR. - - @retval EFI_SUCCESS The mtftp download session is started. - @retval Others Failed to start downloading. - -**/ -EFI_STATUS -Mtftp4RrqStart ( - IN MTFTP4_PROTOCOL *Instance, - IN UINT16 Operation - ); - -#define MTFTP4_SERVICE_FROM_THIS(a) \ - CR (a, MTFTP4_SERVICE, ServiceBinding, MTFTP4_SERVICE_SIGNATURE) - -#define MTFTP4_PROTOCOL_FROM_THIS(a) \ - CR (a, MTFTP4_PROTOCOL, Mtftp4, MTFTP4_PROTOCOL_SIGNATURE) - -#endif diff --git a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Option.c b/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Option.c deleted file mode 100644 index d97f157f17..0000000000 --- a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Option.c +++ /dev/null @@ -1,549 +0,0 @@ -/** @file - Routines to process MTFTP4 options. - -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Mtftp4Impl.h" - -CHAR8 *mMtftp4SupportedOptions[MTFTP4_SUPPORTED_OPTIONS] = { - "blksize", - "windowsize", - "timeout", - "tsize", - "multicast" -}; - - -/** - Check whether two ascii strings are equel, ignore the case. - - @param Str1 The first ascii string - @param Str2 The second ascii string - - @retval TRUE Two strings are equal when case is ignored. - @retval FALSE Two string are not equal. - -**/ -BOOLEAN -NetStringEqualNoCase ( - IN UINT8 *Str1, - IN UINT8 *Str2 - ) -{ - UINT8 Ch1; - UINT8 Ch2; - - ASSERT ((Str1 != NULL) && (Str2 != NULL)); - - for (; (*Str1 != '\0') && (*Str2 != '\0'); Str1++, Str2++) { - Ch1 = *Str1; - Ch2 = *Str2; - - // - // Convert them to lower case then compare two - // - if (('A' <= Ch1) && (Ch1 <= 'Z')) { - Ch1 += 'a' - 'A'; - } - - if (('A' <= Ch2) && (Ch2 <= 'Z')) { - Ch2 += 'a' - 'A'; - } - - if (Ch1 != Ch2) { - return FALSE; - } - } - - return (BOOLEAN) (*Str1 == *Str2); -} - - -/** - Convert a string to a UINT32 number. - - @param Str The string to convert from - - @return The number get from the string - -**/ -UINT32 -NetStringToU32 ( - IN UINT8 *Str - ) -{ - UINT32 Num; - - ASSERT (Str != NULL); - - Num = 0; - - for (; NET_IS_DIGIT (*Str); Str++) { - Num = Num * 10 + (*Str - '0'); - } - - return Num; -} - - -/** - Convert a string of the format "192.168.0.1" to an IP address. - - @param Str The string representation of IP - @param Ip The varible to get IP. - - @retval EFI_INVALID_PARAMETER The IP string is invalid. - @retval EFI_SUCCESS The IP is parsed into the Ip - -**/ -EFI_STATUS -NetStringToIp ( - IN UINT8 *Str, - OUT IP4_ADDR *Ip - ) -{ - UINT32 Byte; - UINT32 Addr; - UINTN Index; - - *Ip = 0; - Addr = 0; - - for (Index = 0; Index < 4; Index++) { - if (!NET_IS_DIGIT (*Str)) { - return EFI_INVALID_PARAMETER; - } - - Byte = NetStringToU32 (Str); - - if (Byte > 255) { - return EFI_INVALID_PARAMETER; - } - - Addr = (Addr << 8) | Byte; - - // - // Skip all the digitals and check whether the sepeator is the dot - // - while (NET_IS_DIGIT (*Str)) { - Str++; - } - - if ((Index < 3) && (*Str != '.')) { - return EFI_INVALID_PARAMETER; - } - - Str++; - } - - *Ip = Addr; - - return EFI_SUCCESS; -} - - -/** - Go through the packet to fill the Options array with the start - addresses of each MTFTP option name/value pair. - - @param Packet The packet to check - @param PacketLen The packet's length - @param Count The size of the Options on input. The actual - options on output - @param Options The option array to fill in - - @retval EFI_INVALID_PARAMETER The packet is mal-formated - @retval EFI_BUFFER_TOO_SMALL The Options array is too small - @retval EFI_SUCCESS The packet has been parsed into the Options array. - -**/ -EFI_STATUS -Mtftp4FillOptions ( - IN EFI_MTFTP4_PACKET *Packet, - IN UINT32 PacketLen, - IN OUT UINT32 *Count, - OUT EFI_MTFTP4_OPTION *Options OPTIONAL - ) -{ - UINT8 *Cur; - UINT8 *Last; - UINT8 Num; - UINT8 *Name; - UINT8 *Value; - - Num = 0; - Cur = (UINT8 *) Packet + MTFTP4_OPCODE_LEN; - Last = (UINT8 *) Packet + PacketLen - 1; - - // - // process option name and value pairs. The last byte is always zero - // - while (Cur < Last) { - Name = Cur; - - while (*Cur != 0) { - Cur++; - } - - if (Cur == Last) { - return EFI_INVALID_PARAMETER; - } - - Value = ++Cur; - - while (*Cur != 0) { - Cur++; - } - - Num++; - - if ((Options != NULL) && (Num <= *Count)) { - Options[Num - 1].OptionStr = Name; - Options[Num - 1].ValueStr = Value; - } - - Cur++; - } - - if ((*Count < Num) || (Options == NULL)) { - *Count = Num; - return EFI_BUFFER_TOO_SMALL; - } - - *Count = Num; - return EFI_SUCCESS; -} - - -/** - Allocate and fill in a array of Mtftp options from the Packet. - - It first calls Mtftp4FillOption to get the option number, then allocate - the array, at last, call Mtftp4FillOption again to save the options. - - @param Packet The packet to parse - @param PacketLen The length of the packet - @param OptionCount The number of options in the packet - @param OptionList The point to get the option array. - - @retval EFI_INVALID_PARAMETER The parametera are invalid or packet isn't a - well-formated OACK packet. - @retval EFI_SUCCESS The option array is build - @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the array - -**/ -EFI_STATUS -Mtftp4ExtractOptions ( - IN EFI_MTFTP4_PACKET *Packet, - IN UINT32 PacketLen, - OUT UINT32 *OptionCount, - OUT EFI_MTFTP4_OPTION **OptionList OPTIONAL - ) -{ - EFI_STATUS Status; - - *OptionCount = 0; - - if (OptionList != NULL) { - *OptionList = NULL; - } - - if (NTOHS (Packet->OpCode) != EFI_MTFTP4_OPCODE_OACK) { - return EFI_INVALID_PARAMETER; - } - - if (PacketLen == MTFTP4_OPCODE_LEN) { - return EFI_SUCCESS; - } - - // - // The last byte must be zero to terminate the options - // - if (*((UINT8 *) Packet + PacketLen - 1) != 0) { - return EFI_INVALID_PARAMETER; - } - - // - // Get the number of options - // - Status = Mtftp4FillOptions (Packet, PacketLen, OptionCount, NULL); - - if ((Status == EFI_SUCCESS) || (Status != EFI_BUFFER_TOO_SMALL)) { - return Status; - } - - // - // Allocate memory for the options, then call Mtftp4FillOptions to - // fill it if caller want that. - // - if (OptionList == NULL) { - return EFI_SUCCESS; - } - - *OptionList = AllocatePool (*OptionCount * sizeof (EFI_MTFTP4_OPTION)); - - if (*OptionList == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - Mtftp4FillOptions (Packet, PacketLen, OptionCount, *OptionList); - return EFI_SUCCESS; -} - - -/** - Parse the MTFTP multicast option. - - @param Value The Mtftp multicast value string - @param Option The option to save the info into. - - @retval EFI_INVALID_PARAMETER The multicast value string is invalid. - @retval EFI_SUCCESS The multicast value is parsed into the Option - -**/ -EFI_STATUS -Mtftp4ExtractMcast ( - IN UINT8 *Value, - IN OUT MTFTP4_OPTION *Option - ) -{ - EFI_STATUS Status; - UINT32 Num; - - // - // The multicast option is formated like "204.0.0.1,1857,1" - // The server can also omit the ip and port, use ",,1" - // - if (*Value == ',') { - Option->McastIp = 0; - } else { - Status = NetStringToIp (Value, &Option->McastIp); - - if (EFI_ERROR (Status)) { - return Status; - } - - while ((*Value != 0) && (*Value != ',')) { - Value++; - } - } - - if (*Value != ',') { - return EFI_INVALID_PARAMETER; - } - - Value++; - - // - // Convert the port setting. the server can send us a port number or - // empty string. such as the port in ",,1" - // - if (*Value == ',') { - Option->McastPort = 0; - } else { - Num = NetStringToU32 (Value); - - if (Num > 65535) { - return EFI_INVALID_PARAMETER; - } - - Option->McastPort = (UINT16) Num; - - while (NET_IS_DIGIT (*Value)) { - Value++; - } - } - - if (*Value != ',') { - return EFI_INVALID_PARAMETER; - } - - Value++; - - // - // Check the master/slave setting, 1 for master, 0 for slave. - // - Num = NetStringToU32 (Value); - - if ((Num != 0) && (Num != 1)) { - return EFI_INVALID_PARAMETER; - } - - Option->Master = (BOOLEAN) (Num == 1); - - while (NET_IS_DIGIT (*Value)) { - Value++; - } - - if (*Value != '\0') { - return EFI_INVALID_PARAMETER; - } - - return EFI_SUCCESS; -} - - -/** - Parse the option in Options array to MTFTP4_OPTION which program - can access directly. - - @param Options The option array, which contains addresses of each - option's name/value string. - @param Count The number of options in the Options - @param Request Whether this is a request or OACK. The format of - multicast is different according to this setting. - @param Operation The current performed operation. - @param MtftpOption The MTFTP4_OPTION for easy access. - - @retval EFI_INVALID_PARAMETER The option is mal-formated - @retval EFI_UNSUPPORTED Some option isn't supported - @retval EFI_SUCCESS The option are OK and has been parsed. - -**/ -EFI_STATUS -Mtftp4ParseOption ( - IN EFI_MTFTP4_OPTION *Options, - IN UINT32 Count, - IN BOOLEAN Request, - IN UINT16 Operation, - OUT MTFTP4_OPTION *MtftpOption - ) -{ - EFI_STATUS Status; - UINT32 Index; - UINT32 Value; - EFI_MTFTP4_OPTION *This; - - MtftpOption->Exist = 0; - - for (Index = 0; Index < Count; Index++) { - This = Options + Index; - - if ((This->OptionStr == NULL) || (This->ValueStr == NULL)) { - return EFI_INVALID_PARAMETER; - } - - if (NetStringEqualNoCase (This->OptionStr, (UINT8 *) "blksize")) { - // - // block size option, valid value is between [8, 65464] - // - Value = NetStringToU32 (This->ValueStr); - - if ((Value < 8) || (Value > 65464)) { - return EFI_INVALID_PARAMETER; - } - - MtftpOption->BlkSize = (UINT16) Value; - MtftpOption->Exist |= MTFTP4_BLKSIZE_EXIST; - - } else if (NetStringEqualNoCase (This->OptionStr, (UINT8 *) "timeout")) { - // - // timeout option, valid value is between [1, 255] - // - Value = NetStringToU32 (This->ValueStr); - - if ((Value < 1) || (Value > 255)) { - return EFI_INVALID_PARAMETER; - } - - MtftpOption->Timeout = (UINT8) Value; - - } else if (NetStringEqualNoCase (This->OptionStr, (UINT8 *) "tsize")) { - // - // tsize option, the biggest transfer supported is 4GB with block size option - // - MtftpOption->Tsize = NetStringToU32 (This->ValueStr); - MtftpOption->Exist |= MTFTP4_TSIZE_EXIST; - - } else if (NetStringEqualNoCase (This->OptionStr, (UINT8 *) "multicast")) { - // - // Multicast option, if it is a request, the value must be a zero - // length string, otherwise, it is formated like "204.0.0.1,1857,1\0" - // - if (Request) { - if (*(This->ValueStr) != '\0') { - return EFI_INVALID_PARAMETER; - } - - } else { - Status = Mtftp4ExtractMcast (This->ValueStr, MtftpOption); - - if (EFI_ERROR (Status)) { - return Status; - } - } - - MtftpOption->Exist |= MTFTP4_MCAST_EXIST; - - } else if (NetStringEqualNoCase (This->OptionStr, (UINT8 *) "windowsize")) { - if (Operation == EFI_MTFTP4_OPCODE_WRQ) { - // - // Currently, windowsize is not supported in the write operation. - // - return EFI_UNSUPPORTED; - } - - Value = NetStringToU32 (This->ValueStr); - - if (Value < 1) { - return EFI_INVALID_PARAMETER; - } - - MtftpOption->WindowSize = (UINT16) Value; - MtftpOption->Exist |= MTFTP4_WINDOWSIZE_EXIST; - } else if (Request) { - // - // Ignore the unsupported option if it is a reply, and return - // EFI_UNSUPPORTED if it's a request according to the UEFI spec. - // - return EFI_UNSUPPORTED; - } - } - - return EFI_SUCCESS; -} - - -/** - Parse the options in the OACK packet to MTFTP4_OPTION which program - can access directly. - - @param Packet The OACK packet to parse - @param PacketLen The length of the packet - @param Operation The current performed operation. - @param MtftpOption The MTFTP_OPTION for easy access. - - @retval EFI_INVALID_PARAMETER The packet option is mal-formated - @retval EFI_UNSUPPORTED Some option isn't supported - @retval EFI_SUCCESS The option are OK and has been parsed. - -**/ -EFI_STATUS -Mtftp4ParseOptionOack ( - IN EFI_MTFTP4_PACKET *Packet, - IN UINT32 PacketLen, - IN UINT16 Operation, - OUT MTFTP4_OPTION *MtftpOption - ) -{ - EFI_MTFTP4_OPTION *OptionList; - EFI_STATUS Status; - UINT32 Count; - - MtftpOption->Exist = 0; - - Status = Mtftp4ExtractOptions (Packet, PacketLen, &Count, &OptionList); - - if (EFI_ERROR (Status) || (Count == 0)) { - return Status; - } - ASSERT (OptionList != NULL); - - Status = Mtftp4ParseOption (OptionList, Count, FALSE, Operation, MtftpOption); - - FreePool (OptionList); - return Status; -} diff --git a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Option.h b/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Option.h deleted file mode 100644 index fcc4cbe8fd..0000000000 --- a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Option.h +++ /dev/null @@ -1,111 +0,0 @@ -/** @file - Routines to process MTFTP4 options. - -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - - -#ifndef __EFI_MTFTP4_OPTION_H__ -#define __EFI_MTFTP4_OPTION_H__ - -#define MTFTP4_SUPPORTED_OPTIONS 5 -#define MTFTP4_OPCODE_LEN 2 -#define MTFTP4_ERRCODE_LEN 2 -#define MTFTP4_BLKNO_LEN 2 -#define MTFTP4_DATA_HEAD_LEN 4 - -#define MTFTP4_BLKSIZE_EXIST 0x01 -#define MTFTP4_TIMEOUT_EXIST 0x02 -#define MTFTP4_TSIZE_EXIST 0x04 -#define MTFTP4_MCAST_EXIST 0x08 -#define MTFTP4_WINDOWSIZE_EXIST 0x10 - -typedef struct { - UINT16 BlkSize; - UINT16 WindowSize; - UINT8 Timeout; - UINT32 Tsize; - IP4_ADDR McastIp; - UINT16 McastPort; - BOOLEAN Master; - UINT32 Exist; -} MTFTP4_OPTION; - -/** - Allocate and fill in a array of Mtftp options from the Packet. - - It first calls Mtftp4FillOption to get the option number, then allocate - the array, at last, call Mtftp4FillOption again to save the options. - - @param Packet The packet to parse - @param PacketLen The length of the packet - @param OptionCount The number of options in the packet - @param OptionList The point to get the option array. - - @retval EFI_INVALID_PARAMETER The parametera are invalid or packet isn't a - well-formated OACK packet. - @retval EFI_SUCCESS The option array is build - @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the array - -**/ -EFI_STATUS -Mtftp4ExtractOptions ( - IN EFI_MTFTP4_PACKET *Packet, - IN UINT32 PacketLen, - OUT UINT32 *OptionCount, - OUT EFI_MTFTP4_OPTION **OptionList OPTIONAL - ); - -/** - Parse the option in Options array to MTFTP4_OPTION which program - can access directly. - - @param Options The option array, which contains addresses of each - option's name/value string. - @param Count The number of options in the Options - @param Request Whether this is a request or OACK. The format of - multicast is different according to this setting. - @param Operation The current performed operation. - @param MtftpOption The MTFTP4_OPTION for easy access. - - @retval EFI_INVALID_PARAMETER The option is mal-formated - @retval EFI_UNSUPPORTED Some option isn't supported - @retval EFI_SUCCESS The option are OK and has been parsed. - -**/ -EFI_STATUS -Mtftp4ParseOption ( - IN EFI_MTFTP4_OPTION *Options, - IN UINT32 Count, - IN BOOLEAN Request, - IN UINT16 Operation, - OUT MTFTP4_OPTION *MtftpOption - ); - -/** - Parse the options in the OACK packet to MTFTP4_OPTION which program - can access directly. - - @param Packet The OACK packet to parse - @param PacketLen The length of the packet - @param Operation The current performed operation. - @param MtftpOption The MTFTP_OPTION for easy access. - - @retval EFI_INVALID_PARAMETER The packet option is mal-formated - @retval EFI_UNSUPPORTED Some option isn't supported - @retval EFI_SUCCESS The option are OK and has been parsed. - -**/ -EFI_STATUS -Mtftp4ParseOptionOack ( - IN EFI_MTFTP4_PACKET *Packet, - IN UINT32 PacketLen, - IN UINT16 Operation, - OUT MTFTP4_OPTION *MtftpOption - ); - -extern CHAR8 *mMtftp4SupportedOptions[MTFTP4_SUPPORTED_OPTIONS]; - -#endif diff --git a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Rrq.c b/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Rrq.c deleted file mode 100644 index 24c965afb5..0000000000 --- a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Rrq.c +++ /dev/null @@ -1,818 +0,0 @@ -/** @file - Routines to process Rrq (download). - -(C) Copyright 2014 Hewlett-Packard Development Company, L.P.
-Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - - -#include "Mtftp4Impl.h" - - -/** - The packet process callback for MTFTP download. - - @param UdpPacket The packet received - @param EndPoint The local/remote access point of the packet - @param IoStatus The status of the receiving - @param Context Opaque parameter, which is the MTFTP session - -**/ -VOID -EFIAPI -Mtftp4RrqInput ( - IN NET_BUF *UdpPacket, - IN UDP_END_POINT *EndPoint, - IN EFI_STATUS IoStatus, - IN VOID *Context - ); - - -/** - Start the MTFTP session to download. - - It will first initialize some of the internal states then build and send a RRQ - reqeuest packet, at last, it will start receive for the downloading. - - @param Instance The Mtftp session - @param Operation The MTFTP opcode, it may be a EFI_MTFTP4_OPCODE_RRQ - or EFI_MTFTP4_OPCODE_DIR. - - @retval EFI_SUCCESS The mtftp download session is started. - @retval Others Failed to start downloading. - -**/ -EFI_STATUS -Mtftp4RrqStart ( - IN MTFTP4_PROTOCOL *Instance, - IN UINT16 Operation - ) -{ - EFI_STATUS Status; - - // - // The valid block number range are [1, 0xffff]. For example: - // the client sends an RRQ request to the server, the server - // transfers the DATA1 block. If option negoitation is ongoing, - // the server will send back an OACK, then client will send ACK0. - // - Status = Mtftp4InitBlockRange (&Instance->Blocks, 1, 0xffff); - - if (EFI_ERROR (Status)) { - return Status; - } - - Status = Mtftp4SendRequest (Instance); - - if (EFI_ERROR (Status)) { - return Status; - } - - return UdpIoRecvDatagram (Instance->UnicastPort, Mtftp4RrqInput, Instance, 0); -} - - -/** - Build and send a ACK packet for the download session. - - @param Instance The Mtftp session - @param BlkNo The BlkNo to ack. - - @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the packet - @retval EFI_SUCCESS The ACK has been sent - @retval Others Failed to send the ACK. - -**/ -EFI_STATUS -Mtftp4RrqSendAck ( - IN MTFTP4_PROTOCOL *Instance, - IN UINT16 BlkNo - ) -{ - EFI_MTFTP4_PACKET *Ack; - NET_BUF *Packet; - EFI_STATUS Status; - - Status = EFI_SUCCESS; - - Packet = NetbufAlloc (sizeof (EFI_MTFTP4_ACK_HEADER)); - if (Packet == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - Ack = (EFI_MTFTP4_PACKET *) NetbufAllocSpace ( - Packet, - sizeof (EFI_MTFTP4_ACK_HEADER), - FALSE - ); - ASSERT (Ack != NULL); - - Ack->Ack.OpCode = HTONS (EFI_MTFTP4_OPCODE_ACK); - Ack->Ack.Block[0] = HTONS (BlkNo); - - Status = Mtftp4SendPacket (Instance, Packet); - if (!EFI_ERROR (Status)) { - Instance->AckedBlock = Instance->TotalBlock; - } - - return Status; -} - - -/** - Deliver the received data block to the user, which can be saved - in the user provide buffer or through the CheckPacket callback. - - @param Instance The Mtftp session - @param Packet The received data packet - @param Len The packet length - - @retval EFI_SUCCESS The data is saved successfully - @retval EFI_ABORTED The user tells to abort by return an error through - CheckPacket - @retval EFI_BUFFER_TOO_SMALL The user's buffer is too small and buffer length is - updated to the actual buffer size needed. - -**/ -EFI_STATUS -Mtftp4RrqSaveBlock ( - IN OUT MTFTP4_PROTOCOL *Instance, - IN EFI_MTFTP4_PACKET *Packet, - IN UINT32 Len - ) -{ - EFI_MTFTP4_TOKEN *Token; - EFI_STATUS Status; - UINT16 Block; - UINT64 Start; - UINT32 DataLen; - UINT64 BlockCounter; - BOOLEAN Completed; - - Completed = FALSE; - Token = Instance->Token; - Block = NTOHS (Packet->Data.Block); - DataLen = Len - MTFTP4_DATA_HEAD_LEN; - - // - // This is the last block, save the block no - // - if (DataLen < Instance->BlkSize) { - Completed = TRUE; - Instance->LastBlock = Block; - Mtftp4SetLastBlockNum (&Instance->Blocks, Block); - } - - // - // Remove this block number from the file hole. If Mtftp4RemoveBlockNum - // returns EFI_NOT_FOUND, the block has been saved, don't save it again. - // Note that : For bigger files, allowing the block counter to roll over - // to accept transfers of unlimited size. So BlockCounter is memorised as - // continuous block counter. - // - Status = Mtftp4RemoveBlockNum (&Instance->Blocks, Block, Completed, &BlockCounter); - - if (Status == EFI_NOT_FOUND) { - return EFI_SUCCESS; - } else if (EFI_ERROR (Status)) { - return Status; - } - - if (Token->CheckPacket != NULL) { - Status = Token->CheckPacket (&Instance->Mtftp4, Token, (UINT16) Len, Packet); - - if (EFI_ERROR (Status)) { - Mtftp4SendError ( - Instance, - EFI_MTFTP4_ERRORCODE_ILLEGAL_OPERATION, - (UINT8 *) "User aborted download" - ); - - return EFI_ABORTED; - } - } - - if (Token->Buffer != NULL) { - Start = MultU64x32 (BlockCounter - 1, Instance->BlkSize); - - if (Start + DataLen <= Token->BufferSize) { - CopyMem ((UINT8 *) Token->Buffer + Start, Packet->Data.Data, DataLen); - - // - // Update the file size when received the last block - // - if ((Instance->LastBlock == Block) && Completed) { - Token->BufferSize = Start + DataLen; - } - - } else if (Instance->LastBlock != 0) { - // - // Don't save the data if the buffer is too small, return - // EFI_BUFFER_TOO_SMALL if received the last packet. This - // will give a accurate file length. - // - Token->BufferSize = Start + DataLen; - - Mtftp4SendError ( - Instance, - EFI_MTFTP4_ERRORCODE_DISK_FULL, - (UINT8 *) "User provided memory block is too small" - ); - - return EFI_BUFFER_TOO_SMALL; - } - } - - return EFI_SUCCESS; -} - - -/** - Function to process the received data packets. - - It will save the block then send back an ACK if it is active. - - @param Instance The downloading MTFTP session - @param Packet The packet received - @param Len The length of the packet - @param Multicast Whether this packet is multicast or unicast - @param Completed Return whether the download has completed - - @retval EFI_SUCCESS The data packet is successfully processed - @retval EFI_ABORTED The download is aborted by the user - @retval EFI_BUFFER_TOO_SMALL The user provided buffer is too small - -**/ -EFI_STATUS -Mtftp4RrqHandleData ( - IN MTFTP4_PROTOCOL *Instance, - IN EFI_MTFTP4_PACKET *Packet, - IN UINT32 Len, - IN BOOLEAN Multicast, - OUT BOOLEAN *Completed - ) -{ - EFI_STATUS Status; - UINT16 BlockNum; - INTN Expected; - - *Completed = FALSE; - Status = EFI_SUCCESS; - BlockNum = NTOHS (Packet->Data.Block); - Expected = Mtftp4GetNextBlockNum (&Instance->Blocks); - - ASSERT (Expected >= 0); - - // - // If we are active (Master) and received an unexpected packet, transmit - // the ACK for the block we received, then restart receiving the - // expected one. If we are passive (Slave), save the block. - // - if (Instance->Master && (Expected != BlockNum)) { - // - // If Expected is 0, (UINT16) (Expected - 1) is also the expected Ack number (65535). - // - return Mtftp4RrqSendAck (Instance, (UINT16) (Expected - 1)); - } - - Status = Mtftp4RrqSaveBlock (Instance, Packet, Len); - - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Record the total received and saved block number. - // - Instance->TotalBlock ++; - - // - // Reset the passive client's timer whenever it received a - // valid data packet. - // - if (!Instance->Master) { - Mtftp4SetTimeout (Instance); - } - - // - // Check whether we have received all the blocks. Send the ACK if we - // are active (unicast client or master client for multicast download). - // If we have received all the blocks, send an ACK even if we are passive - // to tell the server that we are done. - // - Expected = Mtftp4GetNextBlockNum (&Instance->Blocks); - - if (Instance->Master || (Expected < 0)) { - if (Expected < 0) { - // - // If we are passive client, then the just received Block maybe - // isn't the last block. We need to send an ACK to the last block - // to inform the server that we are done. If we are active client, - // the Block == Instance->LastBlock. - // - BlockNum = Instance->LastBlock; - *Completed = TRUE; - - } else { - BlockNum = (UINT16) (Expected - 1); - } - - if (Instance->WindowSize == (Instance->TotalBlock - Instance->AckedBlock) || Expected < 0) { - Status = Mtftp4RrqSendAck (Instance, BlockNum); - } - - } - - return Status; -} - - -/** - Validate whether the options received in the server's OACK packet is valid. - - The options are valid only if: - 1. The server doesn't include options not requested by us - 2. The server can only use smaller blksize than that is requested - 3. The server can only use the same timeout as requested - 4. The server doesn't change its multicast channel. - - @param This The downloading Mtftp session - @param Reply The options in the OACK packet - @param Request The requested options - - @retval TRUE The options in the OACK is OK. - @retval FALSE The options in the OACK is invalid. - -**/ -BOOLEAN -Mtftp4RrqOackValid ( - IN MTFTP4_PROTOCOL *This, - IN MTFTP4_OPTION *Reply, - IN MTFTP4_OPTION *Request - ) -{ - - // - // It is invalid for server to return options we don't request - // - if ((Reply->Exist &~Request->Exist) != 0) { - return FALSE; - } - - // - // Server can only specify a smaller block size and window size to be used and - // return the timeout matches that requested. - // - if ((((Reply->Exist & MTFTP4_BLKSIZE_EXIST) != 0)&& (Reply->BlkSize > Request->BlkSize)) || - (((Reply->Exist & MTFTP4_WINDOWSIZE_EXIST) != 0)&& (Reply->WindowSize > Request->WindowSize)) || - (((Reply->Exist & MTFTP4_TIMEOUT_EXIST) != 0) && (Reply->Timeout != Request->Timeout)) - ) { - return FALSE; - } - - // - // The server can send ",,master" to client to change its master - // setting. But if it use the specific multicast channel, it can't - // change the setting. - // - if (((Reply->Exist & MTFTP4_MCAST_EXIST) != 0) && (This->McastIp != 0)) { - if ((Reply->McastIp != 0) && (Reply->McastIp != This->McastIp)) { - return FALSE; - } - - if ((Reply->McastPort != 0) && (Reply->McastPort != This->McastPort)) { - return FALSE; - } - } - - return TRUE; -} - - -/** - Configure a UDP IO port to receive the multicast. - - @param McastIo The UDP IO to configure - @param Context The opaque parameter to the function which is the - MTFTP session. - - @retval EFI_SUCCESS The UDP child is successfully configured. - @retval Others Failed to configure the UDP child. - -**/ -EFI_STATUS -EFIAPI -Mtftp4RrqConfigMcastPort ( - IN UDP_IO *McastIo, - IN VOID *Context - ) -{ - MTFTP4_PROTOCOL *Instance; - EFI_MTFTP4_CONFIG_DATA *Config; - EFI_UDP4_CONFIG_DATA UdpConfig; - EFI_IPv4_ADDRESS Group; - EFI_STATUS Status; - IP4_ADDR Ip; - - Instance = (MTFTP4_PROTOCOL *) Context; - Config = &Instance->Config; - - UdpConfig.AcceptBroadcast = FALSE; - UdpConfig.AcceptPromiscuous = FALSE; - UdpConfig.AcceptAnyPort = FALSE; - UdpConfig.AllowDuplicatePort = FALSE; - UdpConfig.TypeOfService = 0; - UdpConfig.TimeToLive = 64; - UdpConfig.DoNotFragment = FALSE; - UdpConfig.ReceiveTimeout = 0; - UdpConfig.TransmitTimeout = 0; - UdpConfig.UseDefaultAddress = Config->UseDefaultSetting; - IP4_COPY_ADDRESS (&UdpConfig.StationAddress, &Config->StationIp); - IP4_COPY_ADDRESS (&UdpConfig.SubnetMask, &Config->SubnetMask); - UdpConfig.StationPort = Instance->McastPort; - UdpConfig.RemotePort = 0; - - Ip = HTONL (Instance->ServerIp); - IP4_COPY_ADDRESS (&UdpConfig.RemoteAddress, &Ip); - - Status = McastIo->Protocol.Udp4->Configure (McastIo->Protocol.Udp4, &UdpConfig); - - if (EFI_ERROR (Status)) { - return Status; - } - - if (!Config->UseDefaultSetting && - !EFI_IP4_EQUAL (&mZeroIp4Addr, &Config->GatewayIp)) { - // - // The station IP address is manually configured and the Gateway IP is not 0. - // Add the default route for this UDP instance. - // - Status = McastIo->Protocol.Udp4->Routes ( - McastIo->Protocol.Udp4, - FALSE, - &mZeroIp4Addr, - &mZeroIp4Addr, - &Config->GatewayIp - ); - - if (EFI_ERROR (Status)) { - McastIo->Protocol.Udp4->Configure (McastIo->Protocol.Udp4, NULL); - return Status; - } - } - - // - // join the multicast group - // - Ip = HTONL (Instance->McastIp); - IP4_COPY_ADDRESS (&Group, &Ip); - - return McastIo->Protocol.Udp4->Groups (McastIo->Protocol.Udp4, TRUE, &Group); -} - - -/** - Function to process the OACK. - - It will first validate the OACK packet, then update the various negotiated parameters. - - @param Instance The download MTFTP session - @param Packet The packet received - @param Len The packet length - @param Multicast Whether this packet is received as a multicast - @param Completed Returns whether the download has completed. NOT - used by this function. - - @retval EFI_DEVICE_ERROR Failed to create/start a multicast UDP child - @retval EFI_TFTP_ERROR Some error happened during the process - @retval EFI_SUCCESS The OACK is successfully processed. - -**/ -EFI_STATUS -Mtftp4RrqHandleOack ( - IN OUT MTFTP4_PROTOCOL *Instance, - IN EFI_MTFTP4_PACKET *Packet, - IN UINT32 Len, - IN BOOLEAN Multicast, - OUT BOOLEAN *Completed - ) -{ - MTFTP4_OPTION Reply; - EFI_STATUS Status; - INTN Expected; - EFI_UDP4_PROTOCOL *Udp4; - - *Completed = FALSE; - - // - // If already started the master download, don't change the - // setting. Master download always succeeds. - // - Expected = Mtftp4GetNextBlockNum (&Instance->Blocks); - ASSERT (Expected != -1); - - if (Instance->Master && (Expected != 1)) { - return EFI_SUCCESS; - } - - // - // Parse and validate the options from server - // - ZeroMem (&Reply, sizeof (MTFTP4_OPTION)); - - Status = Mtftp4ParseOptionOack (Packet, Len, Instance->Operation, &Reply); - - if (EFI_ERROR (Status) || - !Mtftp4RrqOackValid (Instance, &Reply, &Instance->RequestOption)) { - // - // Don't send an ERROR packet if the error is EFI_OUT_OF_RESOURCES. - // - if (Status != EFI_OUT_OF_RESOURCES) { - Mtftp4SendError ( - Instance, - EFI_MTFTP4_ERRORCODE_ILLEGAL_OPERATION, - (UINT8 *) "Mal-formated OACK packet" - ); - } - - return EFI_TFTP_ERROR; - } - - if ((Reply.Exist & MTFTP4_MCAST_EXIST) != 0) { - - // - // Save the multicast info. Always update the Master, only update the - // multicast IP address, block size, window size, timeoute at the first time. If IP - // address is updated, create a UDP child to receive the multicast. - // - Instance->Master = Reply.Master; - - if (Instance->McastIp == 0) { - if ((Reply.McastIp == 0) || (Reply.McastPort == 0)) { - Mtftp4SendError ( - Instance, - EFI_MTFTP4_ERRORCODE_ILLEGAL_OPERATION, - (UINT8 *) "Illegal multicast setting" - ); - - return EFI_TFTP_ERROR; - } - - // - // Create a UDP child then start receive the multicast from it. - // - Instance->McastIp = Reply.McastIp; - Instance->McastPort = Reply.McastPort; - if (Instance->McastUdpPort == NULL) { - Instance->McastUdpPort = UdpIoCreateIo ( - Instance->Service->Controller, - Instance->Service->Image, - Mtftp4RrqConfigMcastPort, - UDP_IO_UDP4_VERSION, - Instance - ); - if (Instance->McastUdpPort != NULL) { - Status = gBS->OpenProtocol ( - Instance->McastUdpPort->UdpHandle, - &gEfiUdp4ProtocolGuid, - (VOID **) &Udp4, - Instance->Service->Image, - Instance->Handle, - EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER - ); - if (EFI_ERROR (Status)) { - UdpIoFreeIo (Instance->McastUdpPort); - Instance->McastUdpPort = NULL; - return EFI_DEVICE_ERROR; - } - } - } - - - if (Instance->McastUdpPort == NULL) { - return EFI_DEVICE_ERROR; - } - - Status = UdpIoRecvDatagram (Instance->McastUdpPort, Mtftp4RrqInput, Instance, 0); - - if (EFI_ERROR (Status)) { - Mtftp4SendError ( - Instance, - EFI_MTFTP4_ERRORCODE_ACCESS_VIOLATION, - (UINT8 *) "Failed to create socket to receive multicast packet" - ); - - return Status; - } - - // - // Update the parameters used. - // - if (Reply.BlkSize != 0) { - Instance->BlkSize = Reply.BlkSize; - } - - if (Reply.WindowSize != 0) { - Instance->WindowSize = Reply.WindowSize; - } - - if (Reply.Timeout != 0) { - Instance->Timeout = Reply.Timeout; - } - } - - } else { - Instance->Master = TRUE; - - if (Reply.BlkSize != 0) { - Instance->BlkSize = Reply.BlkSize; - } - - if (Reply.WindowSize != 0) { - Instance->WindowSize = Reply.WindowSize; - } - - if (Reply.Timeout != 0) { - Instance->Timeout = Reply.Timeout; - } - } - - // - // Send an ACK to (Expected - 1) which is 0 for unicast download, - // or tell the server we want to receive the Expected block. - // - return Mtftp4RrqSendAck (Instance, (UINT16) (Expected - 1)); -} - - -/** - The packet process callback for MTFTP download. - - @param UdpPacket The packet received - @param EndPoint The local/remote access point of the packet - @param IoStatus The status of the receiving - @param Context Opaque parameter, which is the MTFTP session - -**/ -VOID -EFIAPI -Mtftp4RrqInput ( - IN NET_BUF *UdpPacket, - IN UDP_END_POINT *EndPoint, - IN EFI_STATUS IoStatus, - IN VOID *Context - ) -{ - MTFTP4_PROTOCOL *Instance; - EFI_MTFTP4_PACKET *Packet; - BOOLEAN Completed; - BOOLEAN Multicast; - EFI_STATUS Status; - UINT16 Opcode; - UINT32 Len; - - Instance = (MTFTP4_PROTOCOL *) Context; - NET_CHECK_SIGNATURE (Instance, MTFTP4_PROTOCOL_SIGNATURE); - - Status = EFI_SUCCESS; - Packet = NULL; - Completed = FALSE; - Multicast = FALSE; - - if (EFI_ERROR (IoStatus)) { - Status = IoStatus; - goto ON_EXIT; - } - - ASSERT (UdpPacket != NULL); - - // - // Find the port this packet is from to restart receive correctly. - // - Multicast = (BOOLEAN) (EndPoint->LocalAddr.Addr[0] == Instance->McastIp); - - if (UdpPacket->TotalSize < MTFTP4_OPCODE_LEN) { - goto ON_EXIT; - } - - // - // Client send initial request to server's listening port. Server - // will select a UDP port to communicate with the client. The server - // is required to use the same port as RemotePort to multicast the - // data. - // - if (EndPoint->RemotePort != Instance->ConnectedPort) { - if (Instance->ConnectedPort != 0) { - goto ON_EXIT; - } else { - Instance->ConnectedPort = EndPoint->RemotePort; - } - } - - // - // Copy the MTFTP packet to a continuous buffer if it isn't already so. - // - Len = UdpPacket->TotalSize; - - if (UdpPacket->BlockOpNum > 1) { - Packet = AllocatePool (Len); - - if (Packet == NULL) { - Status = EFI_OUT_OF_RESOURCES; - goto ON_EXIT; - } - - NetbufCopy (UdpPacket, 0, Len, (UINT8 *) Packet); - - } else { - Packet = (EFI_MTFTP4_PACKET *) NetbufGetByte (UdpPacket, 0, NULL); - ASSERT (Packet != NULL); - } - - Opcode = NTOHS (Packet->OpCode); - - // - // Call the user's CheckPacket if provided. Abort the transmission - // if CheckPacket returns an EFI_ERROR code. - // - if ((Instance->Token->CheckPacket != NULL) && - ((Opcode == EFI_MTFTP4_OPCODE_OACK) || (Opcode == EFI_MTFTP4_OPCODE_ERROR))) { - - Status = Instance->Token->CheckPacket ( - &Instance->Mtftp4, - Instance->Token, - (UINT16) Len, - Packet - ); - - if (EFI_ERROR (Status)) { - // - // Send an error message to the server to inform it - // - if (Opcode != EFI_MTFTP4_OPCODE_ERROR) { - Mtftp4SendError ( - Instance, - EFI_MTFTP4_ERRORCODE_REQUEST_DENIED, - (UINT8 *) "User aborted the transfer" - ); - } - - Status = EFI_ABORTED; - goto ON_EXIT; - } - } - - switch (Opcode) { - case EFI_MTFTP4_OPCODE_DATA: - if ((Len > (UINT32) (MTFTP4_DATA_HEAD_LEN + Instance->BlkSize)) || - (Len < (UINT32) MTFTP4_DATA_HEAD_LEN)) { - goto ON_EXIT; - } - - Status = Mtftp4RrqHandleData (Instance, Packet, Len, Multicast, &Completed); - break; - - case EFI_MTFTP4_OPCODE_OACK: - if (Multicast || (Len <= MTFTP4_OPCODE_LEN)) { - goto ON_EXIT; - } - - Status = Mtftp4RrqHandleOack (Instance, Packet, Len, Multicast, &Completed); - break; - - case EFI_MTFTP4_OPCODE_ERROR: - Status = EFI_TFTP_ERROR; - break; - - default: - break; - } - -ON_EXIT: - - // - // Free the resources, then if !EFI_ERROR (Status), restart the - // receive, otherwise end the session. - // - if ((Packet != NULL) && (UdpPacket->BlockOpNum > 1)) { - FreePool (Packet); - } - - if (UdpPacket != NULL) { - NetbufFree (UdpPacket); - } - - if (!EFI_ERROR (Status) && !Completed) { - if (Multicast) { - Status = UdpIoRecvDatagram (Instance->McastUdpPort, Mtftp4RrqInput, Instance, 0); - } else { - Status = UdpIoRecvDatagram (Instance->UnicastPort, Mtftp4RrqInput, Instance, 0); - } - } - - if (EFI_ERROR (Status) || Completed) { - Mtftp4CleanOperation (Instance, Status); - } -} diff --git a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Support.c b/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Support.c deleted file mode 100644 index ad2ff7bf3a..0000000000 --- a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Support.c +++ /dev/null @@ -1,663 +0,0 @@ -/** @file - Support routines for Mtftp. - -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Mtftp4Impl.h" - - -/** - Allocate a MTFTP4 block range, then init it to the range of [Start, End] - - @param Start The start block number - @param End The last block number in the range - - @return Pointer to the created block range, NULL if failed to allocate memory. - -**/ -MTFTP4_BLOCK_RANGE * -Mtftp4AllocateRange ( - IN UINT16 Start, - IN UINT16 End - ) -{ - MTFTP4_BLOCK_RANGE *Range; - - Range = AllocateZeroPool (sizeof (MTFTP4_BLOCK_RANGE)); - - if (Range == NULL) { - return NULL; - } - - InitializeListHead (&Range->Link); - Range->Start = Start; - Range->End = End; - Range->Bound = End; - - return Range; -} - - -/** - Initialize the block range for either RRQ or WRQ. - - RRQ and WRQ have different requirements for Start and End. - For example, during start up, WRQ initializes its whole valid block range - to [0, 0xffff]. This is bacause the server will send us a ACK0 to inform us - to start the upload. When the client received ACK0, it will remove 0 from the - range, get the next block number, which is 1, then upload the BLOCK1. For RRQ - without option negotiation, the server will directly send us the BLOCK1 in - response to the client's RRQ. When received BLOCK1, the client will remove - it from the block range and send an ACK. It also works if there is option - negotiation. - - @param Head The block range head to initialize - @param Start The Start block number. - @param End The last block number. - - @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for initial block range - @retval EFI_SUCCESS The initial block range is created. - -**/ -EFI_STATUS -Mtftp4InitBlockRange ( - IN LIST_ENTRY *Head, - IN UINT16 Start, - IN UINT16 End - ) -{ - MTFTP4_BLOCK_RANGE *Range; - - Range = Mtftp4AllocateRange (Start, End); - - if (Range == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - InsertTailList (Head, &Range->Link); - return EFI_SUCCESS; -} - - -/** - Get the first valid block number on the range list. - - @param Head The block range head - - @return The first valid block number, -1 if the block range is empty. - -**/ -INTN -Mtftp4GetNextBlockNum ( - IN LIST_ENTRY *Head - ) -{ - MTFTP4_BLOCK_RANGE *Range; - - if (IsListEmpty (Head)) { - return -1; - } - - Range = NET_LIST_HEAD (Head, MTFTP4_BLOCK_RANGE, Link); - return Range->Start; -} - - -/** - Set the last block number of the block range list. - - It will remove all the blocks after the Last. MTFTP initialize the block range - to the maximum possible range, such as [0, 0xffff] for WRQ. When it gets the - last block number, it will call this function to set the last block number. - - @param Head The block range list - @param Last The last block number - -**/ -VOID -Mtftp4SetLastBlockNum ( - IN LIST_ENTRY *Head, - IN UINT16 Last - ) -{ - MTFTP4_BLOCK_RANGE *Range; - - // - // Iterate from the tail to head to remove the block number - // after the last. - // - while (!IsListEmpty (Head)) { - Range = NET_LIST_TAIL (Head, MTFTP4_BLOCK_RANGE, Link); - - if (Range->Start > Last) { - RemoveEntryList (&Range->Link); - FreePool (Range); - continue; - } - - if (Range->End > Last) { - Range->End = Last; - } - - return ; - } -} - - -/** - Remove the block number from the block range list. - - @param Head The block range list to remove from - @param Num The block number to remove - @param Completed Whether Num is the last block number. - @param BlockCounter The continuous block counter instead of the value after roll-over. - - @retval EFI_NOT_FOUND The block number isn't in the block range list - @retval EFI_SUCCESS The block number has been removed from the list - @retval EFI_OUT_OF_RESOURCES Failed to allocate resource - -**/ -EFI_STATUS -Mtftp4RemoveBlockNum ( - IN LIST_ENTRY *Head, - IN UINT16 Num, - IN BOOLEAN Completed, - OUT UINT64 *BlockCounter - ) -{ - MTFTP4_BLOCK_RANGE *Range; - MTFTP4_BLOCK_RANGE *NewRange; - LIST_ENTRY *Entry; - - NET_LIST_FOR_EACH (Entry, Head) { - - // - // Each block represents a hole [Start, End] in the file, - // skip to the first range with End >= Num - // - Range = NET_LIST_USER_STRUCT (Entry, MTFTP4_BLOCK_RANGE, Link); - - if (Range->End < Num) { - continue; - } - - // - // There are three different cases for Start - // 1. (Start > Num) && (End >= Num): - // because all the holes before this one has the condition of - // End < Num, so this block number has been removed. - // - // 2. (Start == Num) && (End >= Num): - // Need to increase the Start by one, and if End == Num, this - // hole has been removed completely, remove it. - // - // 3. (Start < Num) && (End >= Num): - // if End == Num, only need to decrease the End by one because - // we have (Start < Num) && (Num == End), so (Start <= End - 1). - // if (End > Num), the hold is splited into two holes, with - // [Start, Num - 1] and [Num + 1, End]. - // - if (Range->Start > Num) { - return EFI_NOT_FOUND; - - } else if (Range->Start == Num) { - Range->Start++; - - // - // Note that: RFC 1350 does not mention block counter roll-over, - // but several TFTP hosts implement the roll-over be able to accept - // transfers of unlimited size. There is no consensus, however, whether - // the counter should wrap around to zero or to one. Many implementations - // wrap to zero, because this is the simplest to implement. Here we choose - // this solution. - // - *BlockCounter = Num; - - if (Range->Round > 0) { - *BlockCounter += Range->Bound + MultU64x32 ((UINTN) (Range->Round -1), (UINT32) (Range->Bound + 1)) + 1; - } - - if (Range->Start > Range->Bound) { - Range->Start = 0; - Range->Round ++; - } - - if ((Range->Start > Range->End) || Completed) { - RemoveEntryList (&Range->Link); - FreePool (Range); - } - - return EFI_SUCCESS; - - } else { - if (Range->End == Num) { - Range->End--; - } else { - NewRange = Mtftp4AllocateRange ((UINT16) (Num + 1), (UINT16) Range->End); - - if (NewRange == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - Range->End = Num - 1; - NetListInsertAfter (&Range->Link, &NewRange->Link); - } - - return EFI_SUCCESS; - } - } - - return EFI_NOT_FOUND; -} - - -/** - Build then transmit the request packet for the MTFTP session. - - @param Instance The Mtftp session - - @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the request - @retval EFI_SUCCESS The request is built and sent - @retval Others Failed to transmit the packet. - -**/ -EFI_STATUS -Mtftp4SendRequest ( - IN MTFTP4_PROTOCOL *Instance - ) -{ - EFI_MTFTP4_PACKET *Packet; - EFI_MTFTP4_OPTION *Options; - EFI_MTFTP4_TOKEN *Token; - RETURN_STATUS Status; - NET_BUF *Nbuf; - UINT8 *Mode; - UINT8 *Cur; - UINTN Index; - UINT32 BufferLength; - UINTN FileNameLength; - UINTN ModeLength; - UINTN OptionStrLength; - UINTN ValueStrLength; - - Token = Instance->Token; - Options = Token->OptionList; - Mode = Instance->Token->ModeStr; - - if (Mode == NULL) { - Mode = (UINT8 *) "octet"; - } - - // - // Compute the packet length - // - FileNameLength = AsciiStrLen ((CHAR8 *) Token->Filename); - ModeLength = AsciiStrLen ((CHAR8 *) Mode); - BufferLength = (UINT32) FileNameLength + (UINT32) ModeLength + 4; - - for (Index = 0; Index < Token->OptionCount; Index++) { - OptionStrLength = AsciiStrLen ((CHAR8 *) Options[Index].OptionStr); - ValueStrLength = AsciiStrLen ((CHAR8 *) Options[Index].ValueStr); - BufferLength += (UINT32) OptionStrLength + (UINT32) ValueStrLength + 2; - } - // - // Allocate a packet then copy the data over - // - if ((Nbuf = NetbufAlloc (BufferLength)) == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - Packet = (EFI_MTFTP4_PACKET *) NetbufAllocSpace (Nbuf, BufferLength, FALSE); - ASSERT (Packet != NULL); - - Packet->OpCode = HTONS (Instance->Operation); - BufferLength -= sizeof (Packet->OpCode); - - Cur = Packet->Rrq.Filename; - Status = AsciiStrCpyS ((CHAR8 *) Cur, BufferLength, (CHAR8 *) Token->Filename); - ASSERT_EFI_ERROR (Status); - BufferLength -= (UINT32) (FileNameLength + 1); - Cur += FileNameLength + 1; - Status = AsciiStrCpyS ((CHAR8 *) Cur, BufferLength, (CHAR8 *) Mode); - ASSERT_EFI_ERROR (Status); - BufferLength -= (UINT32) (ModeLength + 1); - Cur += ModeLength + 1; - - for (Index = 0; Index < Token->OptionCount; ++Index) { - OptionStrLength = AsciiStrLen ((CHAR8 *) Options[Index].OptionStr); - ValueStrLength = AsciiStrLen ((CHAR8 *) Options[Index].ValueStr); - - Status = AsciiStrCpyS ((CHAR8 *) Cur, BufferLength, (CHAR8 *) Options[Index].OptionStr); - ASSERT_EFI_ERROR (Status); - BufferLength -= (UINT32) (OptionStrLength + 1); - Cur += OptionStrLength + 1; - - Status = AsciiStrCpyS ((CHAR8 *) Cur, BufferLength, (CHAR8 *) Options[Index].ValueStr); - ASSERT_EFI_ERROR (Status); - BufferLength -= (UINT32) (ValueStrLength + 1); - Cur += ValueStrLength + 1; - - } - - return Mtftp4SendPacket (Instance, Nbuf); -} - - -/** - Build then send an error message. - - @param Instance The MTFTP session - @param ErrCode The error code - @param ErrInfo The error message - - @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the error packet - @retval EFI_SUCCESS The error packet is transmitted. - @retval Others Failed to transmit the packet. - -**/ -EFI_STATUS -Mtftp4SendError ( - IN MTFTP4_PROTOCOL *Instance, - IN UINT16 ErrCode, - IN UINT8 *ErrInfo - ) -{ - NET_BUF *Packet; - EFI_MTFTP4_PACKET *TftpError; - UINT32 Len; - - Len = (UINT32) (AsciiStrLen ((CHAR8 *) ErrInfo) + sizeof (EFI_MTFTP4_ERROR_HEADER)); - Packet = NetbufAlloc (Len); - if (Packet == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - TftpError = (EFI_MTFTP4_PACKET *) NetbufAllocSpace (Packet, Len, FALSE); - ASSERT (TftpError != NULL); - - TftpError->OpCode = HTONS (EFI_MTFTP4_OPCODE_ERROR); - TftpError->Error.ErrorCode = HTONS (ErrCode); - - AsciiStrCpyS ((CHAR8 *) TftpError->Error.ErrorMessage, Len, (CHAR8 *) ErrInfo); - - return Mtftp4SendPacket (Instance, Packet); -} - - -/** - The callback function called when the packet is transmitted. - - It simply frees the packet. - - @param Packet The transmitted (or failed to) packet - @param EndPoint The local and remote UDP access point - @param IoStatus The result of the transmission - @param Context Opaque parameter to the callback - -**/ -VOID -EFIAPI -Mtftp4OnPacketSent ( - IN NET_BUF *Packet, - IN UDP_END_POINT *EndPoint, - IN EFI_STATUS IoStatus, - IN VOID *Context - ) -{ - NetbufFree (Packet); -} - - -/** - Set the timeout for the instance. User a longer time for passive instances. - - @param Instance The Mtftp session to set time out - -**/ -VOID -Mtftp4SetTimeout ( - IN OUT MTFTP4_PROTOCOL *Instance - ) -{ - if (Instance->Master) { - Instance->PacketToLive = Instance->Timeout; - } else { - Instance->PacketToLive = Instance->Timeout * 2; - } -} - - -/** - Send the packet for the instance. - - It will first save a reference to the packet for later retransmission. - Then determine the destination port, listen port for requests, and connected - port for others. At last, send the packet out. - - @param Instance The Mtftp instance - @param Packet The packet to send - - @retval EFI_SUCCESS The packet is sent out - @retval Others Failed to transmit the packet. - -**/ -EFI_STATUS -Mtftp4SendPacket ( - IN OUT MTFTP4_PROTOCOL *Instance, - IN OUT NET_BUF *Packet - ) -{ - UDP_END_POINT UdpPoint; - EFI_STATUS Status; - UINT16 OpCode; - UINT8 *Buffer; - - // - // Save the packet for retransmission - // - if (Instance->LastPacket != NULL) { - NetbufFree (Instance->LastPacket); - } - - Instance->LastPacket = Packet; - - Instance->CurRetry = 0; - Mtftp4SetTimeout (Instance); - - ZeroMem (&UdpPoint, sizeof (UdpPoint)); - UdpPoint.RemoteAddr.Addr[0] = Instance->ServerIp; - - // - // Send the requests to the listening port, other packets - // to the connected port - // - Buffer = NetbufGetByte (Packet, 0, NULL); - ASSERT (Buffer != NULL); - OpCode = NTOHS (*(UINT16 *)Buffer); - - if ((OpCode == EFI_MTFTP4_OPCODE_RRQ) || - (OpCode == EFI_MTFTP4_OPCODE_DIR) || - (OpCode == EFI_MTFTP4_OPCODE_WRQ)) { - UdpPoint.RemotePort = Instance->ListeningPort; - } else { - UdpPoint.RemotePort = Instance->ConnectedPort; - } - - NET_GET_REF (Packet); - - Status = UdpIoSendDatagram ( - Instance->UnicastPort, - Packet, - &UdpPoint, - NULL, - Mtftp4OnPacketSent, - Instance - ); - - if (EFI_ERROR (Status)) { - NET_PUT_REF (Packet); - } - - return Status; -} - - -/** - Retransmit the last packet for the instance. - - @param Instance The Mtftp instance - - @retval EFI_SUCCESS The last packet is retransmitted. - @retval Others Failed to retransmit. - -**/ -EFI_STATUS -Mtftp4Retransmit ( - IN MTFTP4_PROTOCOL *Instance - ) -{ - UDP_END_POINT UdpPoint; - EFI_STATUS Status; - UINT16 OpCode; - UINT8 *Buffer; - - ASSERT (Instance->LastPacket != NULL); - - ZeroMem (&UdpPoint, sizeof (UdpPoint)); - UdpPoint.RemoteAddr.Addr[0] = Instance->ServerIp; - - // - // Set the requests to the listening port, other packets to the connected port - // - Buffer = NetbufGetByte (Instance->LastPacket, 0, NULL); - ASSERT (Buffer != NULL); - OpCode = NTOHS (*(UINT16 *) Buffer); - - if ((OpCode == EFI_MTFTP4_OPCODE_RRQ) || (OpCode == EFI_MTFTP4_OPCODE_DIR) || - (OpCode == EFI_MTFTP4_OPCODE_WRQ)) { - UdpPoint.RemotePort = Instance->ListeningPort; - } else { - UdpPoint.RemotePort = Instance->ConnectedPort; - } - - NET_GET_REF (Instance->LastPacket); - - Status = UdpIoSendDatagram ( - Instance->UnicastPort, - Instance->LastPacket, - &UdpPoint, - NULL, - Mtftp4OnPacketSent, - Instance - ); - - if (EFI_ERROR (Status)) { - NET_PUT_REF (Instance->LastPacket); - } - - return Status; -} - - -/** - The timer ticking function in TPL_NOTIFY level for the Mtftp service instance. - - @param Event The ticking event - @param Context The Mtftp service instance - -**/ -VOID -EFIAPI -Mtftp4OnTimerTickNotifyLevel ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - MTFTP4_SERVICE *MtftpSb; - LIST_ENTRY *Entry; - LIST_ENTRY *Next; - MTFTP4_PROTOCOL *Instance; - - MtftpSb = (MTFTP4_SERVICE *) Context; - - // - // Iterate through all the children of the Mtftp service instance. Time - // out the current packet transmit. - // - NET_LIST_FOR_EACH_SAFE (Entry, Next, &MtftpSb->Children) { - Instance = NET_LIST_USER_STRUCT (Entry, MTFTP4_PROTOCOL, Link); - if ((Instance->PacketToLive == 0) || (--Instance->PacketToLive > 0)) { - Instance->HasTimeout = FALSE; - } else { - Instance->HasTimeout = TRUE; - } - } -} - - -/** - The timer ticking function for the Mtftp service instance. - - @param Event The ticking event - @param Context The Mtftp service instance - -**/ -VOID -EFIAPI -Mtftp4OnTimerTick ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - MTFTP4_SERVICE *MtftpSb; - LIST_ENTRY *Entry; - LIST_ENTRY *Next; - MTFTP4_PROTOCOL *Instance; - EFI_MTFTP4_TOKEN *Token; - - MtftpSb = (MTFTP4_SERVICE *) Context; - - // - // Iterate through all the children of the Mtftp service instance. - // - NET_LIST_FOR_EACH_SAFE (Entry, Next, &MtftpSb->Children) { - Instance = NET_LIST_USER_STRUCT (Entry, MTFTP4_PROTOCOL, Link); - if (!Instance->HasTimeout) { - continue; - } - - Instance->HasTimeout = FALSE; - - // - // Call the user's time out handler - // - Token = Instance->Token; - - if (Token != NULL && Token->TimeoutCallback != NULL && - EFI_ERROR (Token->TimeoutCallback (&Instance->Mtftp4, Token))) { - Mtftp4SendError ( - Instance, - EFI_MTFTP4_ERRORCODE_REQUEST_DENIED, - (UINT8 *) "User aborted the transfer in time out" - ); - - Mtftp4CleanOperation (Instance, EFI_ABORTED); - continue; - } - - // - // Retransmit the packet if haven't reach the maxmium retry count, - // otherwise exit the transfer. - // - if (++Instance->CurRetry < Instance->MaxRetry) { - Mtftp4Retransmit (Instance); - Mtftp4SetTimeout (Instance); - } else { - Mtftp4CleanOperation (Instance, EFI_TIMEOUT); - continue; - } - } -} diff --git a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Support.h b/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Support.h deleted file mode 100644 index cfa7582faa..0000000000 --- a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Support.h +++ /dev/null @@ -1,198 +0,0 @@ -/** @file - Support routines for MTFTP. - -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef __EFI_MTFTP4_SUPPORT_H__ -#define __EFI_MTFTP4_SUPPORT_H__ - -// -// The structure representing a range of block numbers, [Start, End]. -// It is used to remember the holes in the MTFTP block space. If all -// the holes are filled in, then the download or upload has completed. -// -typedef struct { - LIST_ENTRY Link; - INTN Start; - INTN End; - INTN Round; - INTN Bound; -} MTFTP4_BLOCK_RANGE; - - -/** - Initialize the block range for either RRQ or WRQ. - - RRQ and WRQ have different requirements for Start and End. - For example, during start up, WRQ initializes its whole valid block range - to [0, 0xffff]. This is bacause the server will send us a ACK0 to inform us - to start the upload. When the client received ACK0, it will remove 0 from the - range, get the next block number, which is 1, then upload the BLOCK1. For RRQ - without option negotiation, the server will directly send us the BLOCK1 in - response to the client's RRQ. When received BLOCK1, the client will remove - it from the block range and send an ACK. It also works if there is option - negotiation. - - @param Head The block range head to initialize - @param Start The Start block number. - @param End The last block number. - - @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for initial block range - @retval EFI_SUCCESS The initial block range is created. - -**/ -EFI_STATUS -Mtftp4InitBlockRange ( - IN LIST_ENTRY *Head, - IN UINT16 Start, - IN UINT16 End - ); - -/** - Get the first valid block number on the range list. - - @param Head The block range head - - @return The first valid block number, -1 if the block range is empty. - -**/ -INTN -Mtftp4GetNextBlockNum ( - IN LIST_ENTRY *Head - ); - -/** - Set the last block number of the block range list. - - It will remove all the blocks after the Last. MTFTP initialize the block range - to the maximum possible range, such as [0, 0xffff] for WRQ. When it gets the - last block number, it will call this function to set the last block number. - - @param Head The block range list - @param Last The last block number - -**/ -VOID -Mtftp4SetLastBlockNum ( - IN LIST_ENTRY *Head, - IN UINT16 Last - ); - -/** - Remove the block number from the block range list. - - @param Head The block range list to remove from - @param Num The block number to remove - @param Completed Whether Num is the last block number. - @param BlockCounter The continuous block counter instead of the value after roll-over. - - @retval EFI_NOT_FOUND The block number isn't in the block range list - @retval EFI_SUCCESS The block number has been removed from the list - @retval EFI_OUT_OF_RESOURCES Failed to allocate resource - -**/ -EFI_STATUS -Mtftp4RemoveBlockNum ( - IN LIST_ENTRY *Head, - IN UINT16 Num, - IN BOOLEAN Completed, - OUT UINT64 *BlockCounter - ); - -/** - Set the timeout for the instance. User a longer time for passive instances. - - @param Instance The Mtftp session to set time out - -**/ -VOID -Mtftp4SetTimeout ( - IN OUT MTFTP4_PROTOCOL *Instance - ); - -/** - Send the packet for the instance. - - It will first save a reference to the packet for later retransmission. - Then determine the destination port, listen port for requests, and connected - port for others. At last, send the packet out. - - @param Instance The Mtftp instance - @param Packet The packet to send - - @retval EFI_SUCCESS The packet is sent out - @retval Others Failed to transmit the packet. - -**/ -EFI_STATUS -Mtftp4SendPacket ( - IN OUT MTFTP4_PROTOCOL *Instance, - IN OUT NET_BUF *Packet - ); - -/** - Build then transmit the request packet for the MTFTP session. - - @param Instance The Mtftp session - - @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the request - @retval EFI_SUCCESS The request is built and sent - @retval Others Failed to transmit the packet. - -**/ -EFI_STATUS -Mtftp4SendRequest ( - IN MTFTP4_PROTOCOL *Instance - ); - -/** - Build then send an error message. - - @param Instance The MTFTP session - @param ErrCode The error code - @param ErrInfo The error message - - @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the error packet - @retval EFI_SUCCESS The error packet is transmitted. - @retval Others Failed to transmit the packet. - -**/ -EFI_STATUS -Mtftp4SendError ( - IN MTFTP4_PROTOCOL *Instance, - IN UINT16 ErrCode, - IN UINT8 *ErrInfo - ); - - -/** - The timer ticking function in TPL_NOTIFY level for the Mtftp service instance. - - @param Event The ticking event - @param Context The Mtftp service instance - -**/ -VOID -EFIAPI -Mtftp4OnTimerTickNotifyLevel ( - IN EFI_EVENT Event, - IN VOID *Context - ); - -/** - The timer ticking function for the Mtftp service instance. - - @param Event The ticking event - @param Context The Mtftp service instance - -**/ -VOID -EFIAPI -Mtftp4OnTimerTick ( - IN EFI_EVENT Event, - IN VOID *Context - ); -#endif diff --git a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Wrq.c b/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Wrq.c deleted file mode 100644 index 14156b801e..0000000000 --- a/MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Wrq.c +++ /dev/null @@ -1,529 +0,0 @@ -/** @file - Routines to process Wrq (upload). - -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Mtftp4Impl.h" - - - -/** - Build then send a MTFTP data packet for the MTFTP upload session. - - @param Instance The MTFTP upload session. - @param BlockNum The block number to send. - - @retval EFI_OUT_OF_RESOURCES Failed to build the packet. - @retval EFI_ABORTED The consumer of this child directs to abort the - transmission by return an error through PacketNeeded. - @retval EFI_SUCCESS The data is sent. - -**/ -EFI_STATUS -Mtftp4WrqSendBlock ( - IN OUT MTFTP4_PROTOCOL *Instance, - IN UINT16 BlockNum - ) -{ - EFI_MTFTP4_PACKET *Packet; - EFI_MTFTP4_TOKEN *Token; - NET_BUF *UdpPacket; - EFI_STATUS Status; - UINT16 DataLen; - UINT8 *DataBuf; - UINT64 Start; - - // - // Allocate a buffer to hold the user data - // - UdpPacket = NetbufAlloc (Instance->BlkSize + MTFTP4_DATA_HEAD_LEN); - - if (UdpPacket == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - Packet = (EFI_MTFTP4_PACKET *) NetbufAllocSpace (UdpPacket, MTFTP4_DATA_HEAD_LEN, FALSE); - ASSERT (Packet != NULL); - - Packet->Data.OpCode = HTONS (EFI_MTFTP4_OPCODE_DATA); - Packet->Data.Block = HTONS (BlockNum); - - // - // Read the block from either the buffer or PacketNeeded callback - // - Token = Instance->Token; - DataLen = Instance->BlkSize; - - if (Token->Buffer != NULL) { - Start = MultU64x32 (BlockNum - 1, Instance->BlkSize); - - if (Token->BufferSize < Start + Instance->BlkSize) { - DataLen = (UINT16) (Token->BufferSize - Start); - Instance->LastBlock = BlockNum; - Mtftp4SetLastBlockNum (&Instance->Blocks, BlockNum); - } - - if (DataLen > 0) { - NetbufAllocSpace (UdpPacket, DataLen, FALSE); - CopyMem (Packet->Data.Data, (UINT8 *) Token->Buffer + Start, DataLen); - } - - } else { - // - // Get data from PacketNeeded - // - DataBuf = NULL; - Status = Token->PacketNeeded ( - &Instance->Mtftp4, - Token, - &DataLen, - (VOID **) &DataBuf - ); - - if (EFI_ERROR (Status) || (DataLen > Instance->BlkSize)) { - if (DataBuf != NULL) { - FreePool (DataBuf); - } - - if (UdpPacket != NULL) { - NetbufFree (UdpPacket); - } - - Mtftp4SendError ( - Instance, - EFI_MTFTP4_ERRORCODE_REQUEST_DENIED, - (UINT8 *) "User aborted the transfer" - ); - - return EFI_ABORTED; - } - - if (DataLen < Instance->BlkSize) { - Instance->LastBlock = BlockNum; - Mtftp4SetLastBlockNum (&Instance->Blocks, BlockNum); - } - - if (DataLen > 0) { - NetbufAllocSpace (UdpPacket, DataLen, FALSE); - CopyMem (Packet->Data.Data, DataBuf, DataLen); - FreePool (DataBuf); - } - } - - return Mtftp4SendPacket (Instance, UdpPacket); -} - - -/** - Function to handle received ACK packet. - - If the ACK number matches the expected block number, and there are more - data pending, send the next block. Otherwise tell the caller that we are done. - - @param Instance The MTFTP upload session - @param Packet The MTFTP packet received - @param Len The packet length - @param Completed Return whether the upload has finished. - - @retval EFI_SUCCESS The ACK is successfully processed. - @retval EFI_TFTP_ERROR The block number loops back. - @retval Others Failed to transmit the next data packet. - -**/ -EFI_STATUS -Mtftp4WrqHandleAck ( - IN MTFTP4_PROTOCOL *Instance, - IN EFI_MTFTP4_PACKET *Packet, - IN UINT32 Len, - OUT BOOLEAN *Completed - ) -{ - UINT16 AckNum; - INTN Expected; - UINT64 BlockCounter; - - *Completed = FALSE; - AckNum = NTOHS (Packet->Ack.Block[0]); - Expected = Mtftp4GetNextBlockNum (&Instance->Blocks); - - ASSERT (Expected >= 0); - - // - // Get an unwanted ACK, return EFI_SUCCESS to let Mtftp4WrqInput - // restart receive. - // - if (Expected != AckNum) { - return EFI_SUCCESS; - } - - // - // Remove the acked block number, if this is the last block number, - // tell the Mtftp4WrqInput to finish the transfer. This is the last - // block number if the block range are empty. - // - Mtftp4RemoveBlockNum (&Instance->Blocks, AckNum, *Completed, &BlockCounter); - - Expected = Mtftp4GetNextBlockNum (&Instance->Blocks); - - if (Expected < 0) { - - // - // The block range is empty. It may either because the the last - // block has been ACKed, or the sequence number just looped back, - // that is, there is more than 0xffff blocks. - // - if (Instance->LastBlock == AckNum) { - ASSERT (Instance->LastBlock >= 1); - *Completed = TRUE; - return EFI_SUCCESS; - - } else { - Mtftp4SendError ( - Instance, - EFI_MTFTP4_ERRORCODE_REQUEST_DENIED, - (UINT8 *) "Block number rolls back, not supported, try blksize option" - ); - - return EFI_TFTP_ERROR; - } - } - - return Mtftp4WrqSendBlock (Instance, (UINT16) Expected); -} - - -/** - Check whether the received OACK is valid. - - The OACK is valid only if: - 1. It only include options requested by us - 2. It can only include a smaller block size - 3. It can't change the proposed time out value. - 4. Other requirements of the individal MTFTP options as required. - - @param Reply The options included in the OACK - @param Request The options we requested - - @retval TRUE The options included in OACK is valid. - @retval FALSE The options included in OACK is invalid. - -**/ -BOOLEAN -Mtftp4WrqOackValid ( - IN MTFTP4_OPTION *Reply, - IN MTFTP4_OPTION *Request - ) -{ - // - // It is invalid for server to return options we don't request - // - if ((Reply->Exist & ~Request->Exist) != 0) { - return FALSE; - } - - // - // Server can only specify a smaller block size to be used and - // return the timeout matches that requested. - // - if ((((Reply->Exist & MTFTP4_BLKSIZE_EXIST) != 0) && (Reply->BlkSize > Request->BlkSize)) || - (((Reply->Exist & MTFTP4_TIMEOUT_EXIST) != 0) && (Reply->Timeout != Request->Timeout))) { - return FALSE; - } - - return TRUE; -} - - -/** - Function to handle the MTFTP OACK packet. - - It parses the packet's options, and update the internal states of the session. - - @param Instance The MTFTP session - @param Packet The received OACK packet - @param Len The length of the packet - @param Completed Whether the transmisson has completed. NOT used by - this function. - - @retval EFI_SUCCESS The OACK process is OK - @retval EFI_TFTP_ERROR Some error occured, and the session reset. - -**/ -EFI_STATUS -Mtftp4WrqHandleOack ( - IN OUT MTFTP4_PROTOCOL *Instance, - IN EFI_MTFTP4_PACKET *Packet, - IN UINT32 Len, - OUT BOOLEAN *Completed - ) -{ - MTFTP4_OPTION Reply; - EFI_MTFTP4_PACKET Bogus; - EFI_STATUS Status; - INTN Expected; - - *Completed = FALSE; - - // - // Ignore the OACK if already started the upload - // - Expected = Mtftp4GetNextBlockNum (&Instance->Blocks); - - if (Expected != 0) { - return EFI_SUCCESS; - } - - // - // Parse and validate the options from server - // - ZeroMem (&Reply, sizeof (MTFTP4_OPTION)); - Status = Mtftp4ParseOptionOack (Packet, Len, Instance->Operation, &Reply); - - if (EFI_ERROR (Status) || !Mtftp4WrqOackValid (&Reply, &Instance->RequestOption)) { - // - // Don't send a MTFTP error packet when out of resource, it can - // only make it worse. - // - if (Status != EFI_OUT_OF_RESOURCES) { - Mtftp4SendError ( - Instance, - EFI_MTFTP4_ERRORCODE_ILLEGAL_OPERATION, - (UINT8 *) "Mal-formated OACK packet" - ); - } - - return EFI_TFTP_ERROR; - } - - if (Reply.BlkSize != 0) { - Instance->BlkSize = Reply.BlkSize; - } - - if (Reply.Timeout != 0) { - Instance->Timeout = Reply.Timeout; - } - - // - // Build a bogus ACK0 packet then pass it to the Mtftp4WrqHandleAck, - // which will start the transmission of the first data block. - // - Bogus.Ack.OpCode = HTONS (EFI_MTFTP4_OPCODE_ACK); - Bogus.Ack.Block[0] = 0; - - Status = Mtftp4WrqHandleAck ( - Instance, - &Bogus, - sizeof (EFI_MTFTP4_ACK_HEADER), - Completed - ); - - return Status; -} - - -/** - The input process routine for MTFTP upload. - - @param UdpPacket The received MTFTP packet. - @param EndPoint The local/remote access point - @param IoStatus The result of the packet receiving - @param Context Opaque parameter for the callback, which is the - MTFTP session. -**/ -VOID -EFIAPI -Mtftp4WrqInput ( - IN NET_BUF *UdpPacket, - IN UDP_END_POINT *EndPoint, - IN EFI_STATUS IoStatus, - IN VOID *Context - ) -{ - MTFTP4_PROTOCOL *Instance; - EFI_MTFTP4_PACKET *Packet; - BOOLEAN Completed; - EFI_STATUS Status; - UINT32 Len; - UINT16 Opcode; - - Instance = (MTFTP4_PROTOCOL *) Context; - NET_CHECK_SIGNATURE (Instance, MTFTP4_PROTOCOL_SIGNATURE); - - Completed = FALSE; - Packet = NULL; - Status = EFI_SUCCESS; - - if (EFI_ERROR (IoStatus)) { - Status = IoStatus; - goto ON_EXIT; - } - - ASSERT (UdpPacket != NULL); - - if (UdpPacket->TotalSize < MTFTP4_OPCODE_LEN) { - goto ON_EXIT; - } - - // - // Client send initial request to server's listening port. Server - // will select a UDP port to communicate with the client. - // - if (EndPoint->RemotePort != Instance->ConnectedPort) { - if (Instance->ConnectedPort != 0) { - goto ON_EXIT; - } else { - Instance->ConnectedPort = EndPoint->RemotePort; - } - } - - // - // Copy the MTFTP packet to a continuous buffer if it isn't already so. - // - Len = UdpPacket->TotalSize; - - if (UdpPacket->BlockOpNum > 1) { - Packet = AllocatePool (Len); - - if (Packet == NULL) { - Status = EFI_OUT_OF_RESOURCES; - goto ON_EXIT; - } - - NetbufCopy (UdpPacket, 0, Len, (UINT8 *) Packet); - - } else { - Packet = (EFI_MTFTP4_PACKET *) NetbufGetByte (UdpPacket, 0, NULL); - ASSERT (Packet != NULL); - } - - Opcode = NTOHS (Packet->OpCode); - - // - // Call the user's CheckPacket if provided. Abort the transmission - // if CheckPacket returns an EFI_ERROR code. - // - if ((Instance->Token->CheckPacket != NULL) && - ((Opcode == EFI_MTFTP4_OPCODE_OACK) || (Opcode == EFI_MTFTP4_OPCODE_ERROR))) { - - Status = Instance->Token->CheckPacket ( - &Instance->Mtftp4, - Instance->Token, - (UINT16) Len, - Packet - ); - - if (EFI_ERROR (Status)) { - // - // Send an error message to the server to inform it - // - if (Opcode != EFI_MTFTP4_OPCODE_ERROR) { - Mtftp4SendError ( - Instance, - EFI_MTFTP4_ERRORCODE_REQUEST_DENIED, - (UINT8 *) "User aborted the transfer" - ); - } - - Status = EFI_ABORTED; - goto ON_EXIT; - } - } - - switch (Opcode) { - case EFI_MTFTP4_OPCODE_ACK: - if (Len != MTFTP4_OPCODE_LEN + MTFTP4_BLKNO_LEN) { - goto ON_EXIT; - } - - Status = Mtftp4WrqHandleAck (Instance, Packet, Len, &Completed); - break; - - case EFI_MTFTP4_OPCODE_OACK: - if (Len <= MTFTP4_OPCODE_LEN) { - goto ON_EXIT; - } - - Status = Mtftp4WrqHandleOack (Instance, Packet, Len, &Completed); - break; - - case EFI_MTFTP4_OPCODE_ERROR: - Status = EFI_TFTP_ERROR; - break; - - default: - break; - } - -ON_EXIT: - // - // Free the resources, then if !EFI_ERROR (Status) and not completed, - // restart the receive, otherwise end the session. - // - if ((Packet != NULL) && (UdpPacket->BlockOpNum > 1)) { - FreePool (Packet); - } - - if (UdpPacket != NULL) { - NetbufFree (UdpPacket); - } - - if (!EFI_ERROR (Status) && !Completed) { - Status = UdpIoRecvDatagram (Instance->UnicastPort, Mtftp4WrqInput, Instance, 0); - } - - // - // Status may have been updated by UdpIoRecvDatagram - // - if (EFI_ERROR (Status) || Completed) { - Mtftp4CleanOperation (Instance, Status); - } -} - - - -/** - Start the MTFTP session for upload. - - It will first init some states, then send the WRQ request packet, - and start receiving the packet. - - @param Instance The MTFTP session - @param Operation Redundant parameter, which is always - EFI_MTFTP4_OPCODE_WRQ here. - - @retval EFI_SUCCESS The upload process has been started. - @retval Others Failed to start the upload. - -**/ -EFI_STATUS -Mtftp4WrqStart ( - IN MTFTP4_PROTOCOL *Instance, - IN UINT16 Operation - ) -{ - EFI_STATUS Status; - - // - // The valid block number range are [0, 0xffff]. For example: - // the client sends an WRQ request to the server, the server - // ACK with an ACK0 to let client start transfer the first - // packet. - // - Status = Mtftp4InitBlockRange (&Instance->Blocks, 0, 0xffff); - - if (EFI_ERROR (Status)) { - return Status; - } - - Status = Mtftp4SendRequest (Instance); - - if (EFI_ERROR (Status)) { - return Status; - } - - return UdpIoRecvDatagram (Instance->UnicastPort, Mtftp4WrqInput, Instance, 0); -} - diff --git a/MdeModulePkg/Universal/Network/SnpDxe/Callback.c b/MdeModulePkg/Universal/Network/SnpDxe/Callback.c deleted file mode 100644 index 6387dbdb35..0000000000 --- a/MdeModulePkg/Universal/Network/SnpDxe/Callback.c +++ /dev/null @@ -1,354 +0,0 @@ -/** @file - This file contains the callback routines for undi3.1. - the callback routines for Undi3.1 have an extra parameter UniqueId which - stores the interface context for the NIC that snp is trying to talk. - -Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Snp.h" - -/** - Acquire or release a lock of the exclusive access to a critical section of the - code/data. - - This is a callback routine supplied to UNDI3.1 at undi_start time. - New callbacks for 3.1: there won't be a virtual2physical callback for UNDI 3.1 - because undi3.1 uses the MemMap call to map the required address by itself! - - @param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this to - store Undi interface context (Undi does not read or write - this variable). - @param Enable Non-zero indicates acquire; Zero indicates release. - -**/ -VOID -EFIAPI -SnpUndi32CallbackBlock ( - IN UINT64 UniqueId, - IN UINT32 Enable - ) -{ - SNP_DRIVER *Snp; - - Snp = (SNP_DRIVER *) (UINTN) UniqueId; - // - // tcpip was calling snp at tpl_notify and when we acquire a lock that was - // created at a lower level (TPL_CALLBACK) it gives an assert! - // - if (Enable != 0) { - EfiAcquireLock (&Snp->Lock); - } else { - EfiReleaseLock (&Snp->Lock); - } -} - -/** - Delay MicroSeconds of micro seconds. - - This is a callback routine supplied to UNDI at undi_start time. - - @param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this to - store Undi interface context (Undi does not read or write - this variable). - @param MicroSeconds Number of micro seconds to pause, ususlly multiple of 10. - -**/ -VOID -EFIAPI -SnpUndi32CallbackDelay ( - IN UINT64 UniqueId, - IN UINT64 MicroSeconds - ) -{ - if (MicroSeconds != 0) { - gBS->Stall ((UINTN) MicroSeconds); - } -} - -/** - IO routine for UNDI3.1. - - This is a callback routine supplied to UNDI at undi_start time. - - @param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this - to store Undi interface context (Undi does not read or - write this variable). - @param ReadOrWrite Indicates read or write, IO or Memory. - @param NumBytes Number of bytes to read or write. - @param MemOrPortAddr IO or memory address to read from or write to. - @param BufferPtr Memory location to read into or that contains the bytes - to write. - -**/ -VOID -EFIAPI -SnpUndi32CallbackMemio ( - IN UINT64 UniqueId, - IN UINT8 ReadOrWrite, - IN UINT8 NumBytes, - IN UINT64 MemOrPortAddr, - IN OUT UINT64 BufferPtr - ) -{ - SNP_DRIVER *Snp; - EFI_PCI_IO_PROTOCOL_WIDTH Width; - - Snp = (SNP_DRIVER *) (UINTN) UniqueId; - - Width = (EFI_PCI_IO_PROTOCOL_WIDTH) 0; - switch (NumBytes) { - case 2: - Width = (EFI_PCI_IO_PROTOCOL_WIDTH) 1; - break; - - case 4: - Width = (EFI_PCI_IO_PROTOCOL_WIDTH) 2; - break; - - case 8: - Width = (EFI_PCI_IO_PROTOCOL_WIDTH) 3; - break; - } - - switch (ReadOrWrite) { - case PXE_IO_READ: - Snp->PciIo->Io.Read ( - Snp->PciIo, - Width, - Snp->IoBarIndex, // BAR 1 (for 32bit regs), IO base address - MemOrPortAddr, - 1, // count - (VOID *) (UINTN) BufferPtr - ); - break; - - case PXE_IO_WRITE: - Snp->PciIo->Io.Write ( - Snp->PciIo, - Width, - Snp->IoBarIndex, // BAR 1 (for 32bit regs), IO base address - MemOrPortAddr, - 1, // count - (VOID *) (UINTN) BufferPtr - ); - break; - - case PXE_MEM_READ: - Snp->PciIo->Mem.Read ( - Snp->PciIo, - Width, - Snp->MemoryBarIndex, // BAR 0, Memory base address - MemOrPortAddr, - 1, // count - (VOID *) (UINTN) BufferPtr - ); - break; - - case PXE_MEM_WRITE: - Snp->PciIo->Mem.Write ( - Snp->PciIo, - Width, - Snp->MemoryBarIndex, // BAR 0, Memory base address - MemOrPortAddr, - 1, // count - (VOID *) (UINTN) BufferPtr - ); - break; - } - - return ; -} - -/** - Map a CPU address to a device address. - - This is a callback routine supplied to UNDI at undi_start time. - - @param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this to - store Undi interface context (Undi does not read or write - this variable). - @param CpuAddr Virtual address to be mapped. - @param NumBytes Size of memory to be mapped. - @param Direction Direction of data flow for this memory's usage: - cpu->device, device->cpu or both ways. - @param DeviceAddrPtr Pointer to return the mapped device address. - -**/ -VOID -EFIAPI -SnpUndi32CallbackMap ( - IN UINT64 UniqueId, - IN UINT64 CpuAddr, - IN UINT32 NumBytes, - IN UINT32 Direction, - IN OUT UINT64 DeviceAddrPtr - ) -{ - EFI_PHYSICAL_ADDRESS *DevAddrPtr; - EFI_PCI_IO_PROTOCOL_OPERATION DirectionFlag; - UINTN BuffSize; - SNP_DRIVER *Snp; - UINTN Index; - EFI_STATUS Status; - - BuffSize = (UINTN) NumBytes; - Snp = (SNP_DRIVER *) (UINTN) UniqueId; - DevAddrPtr = (EFI_PHYSICAL_ADDRESS *) (UINTN) DeviceAddrPtr; - - if (CpuAddr == 0) { - *DevAddrPtr = 0; - return ; - } - - switch (Direction) { - case TO_AND_FROM_DEVICE: - DirectionFlag = EfiPciIoOperationBusMasterCommonBuffer; - break; - - case FROM_DEVICE: - DirectionFlag = EfiPciIoOperationBusMasterWrite; - break; - - case TO_DEVICE: - DirectionFlag = EfiPciIoOperationBusMasterRead; - break; - - default: - *DevAddrPtr = 0; - // - // any non zero indicates error! - // - return ; - } - // - // find an unused map_list entry - // - for (Index = 0; Index < MAX_MAP_LENGTH; Index++) { - if (Snp->MapList[Index].VirtualAddress == 0) { - break; - } - } - - if (Index >= MAX_MAP_LENGTH) { - DEBUG ((EFI_D_INFO, "SNP maplist is FULL\n")); - *DevAddrPtr = 0; - return ; - } - - Snp->MapList[Index].VirtualAddress = (EFI_PHYSICAL_ADDRESS) CpuAddr; - - Status = Snp->PciIo->Map ( - Snp->PciIo, - DirectionFlag, - (VOID *) (UINTN) CpuAddr, - &BuffSize, - DevAddrPtr, - &(Snp->MapList[Index].MapCookie) - ); - if (Status != EFI_SUCCESS) { - *DevAddrPtr = 0; - Snp->MapList[Index].VirtualAddress = 0; - } - - return ; -} - -/** - Unmap an address that was previously mapped using map callback. - - This is a callback routine supplied to UNDI at undi_start time. - - @param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this to - store. Undi interface context (Undi does not read or write - this variable). - @param CpuAddr Virtual address that was mapped. - @param NumBytes Size of memory mapped. - @param Direction Direction of data flow for this memory's usage: - cpu->device, device->cpu or both ways. - @param DeviceAddr The mapped device address. - -**/ -VOID -EFIAPI -SnpUndi32CallbackUnmap ( - IN UINT64 UniqueId, - IN UINT64 CpuAddr, - IN UINT32 NumBytes, - IN UINT32 Direction, - IN UINT64 DeviceAddr - ) -{ - SNP_DRIVER *Snp; - UINT16 Index; - - Snp = (SNP_DRIVER *) (UINTN) UniqueId; - - for (Index = 0; Index < MAX_MAP_LENGTH; Index++) { - if (Snp->MapList[Index].VirtualAddress == CpuAddr) { - break; - } - } - - if (Index >= MAX_MAP_LENGTH) { - DEBUG ((EFI_D_ERROR, "SNP could not find a mapping, failed to unmap.\n")); - return ; - } - - Snp->PciIo->Unmap (Snp->PciIo, Snp->MapList[Index].MapCookie); - Snp->MapList[Index].VirtualAddress = 0; - Snp->MapList[Index].MapCookie = NULL; - return ; -} - -/** - Synchronize the virtual buffer contents with the mapped buffer contents. - - This is a callback routine supplied to UNDI at undi_start time. The virtual - and mapped buffers need not correspond to the same physical memory (especially - if the virtual address is > 4GB). Depending on the direction for which the - buffer is mapped, undi will need to synchronize their contents whenever it - writes to/reads from the buffer using either the cpu address or the device - address. - EFI does not provide a sync call since virt=physical, we should just do the - synchronization ourselves here. - - @param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this to - store Undi interface context (Undi does not read or write - this variable). - @param CpuAddr Virtual address that was mapped. - @param NumBytes Size of memory mapped. - @param Direction Direction of data flow for this memory's usage: - cpu->device, device->cpu or both ways. - @param DeviceAddr The mapped device address. - -**/ -VOID -EFIAPI -SnpUndi32CallbackSync ( - IN UINT64 UniqueId, - IN UINT64 CpuAddr, - IN UINT32 NumBytes, - IN UINT32 Direction, - IN UINT64 DeviceAddr - ) -{ - if ((CpuAddr == 0) || (DeviceAddr == 0) || (NumBytes == 0)) { - return ; - - } - - switch (Direction) { - case FROM_DEVICE: - CopyMem ((UINT8 *) (UINTN) CpuAddr, (UINT8 *) (UINTN) DeviceAddr, NumBytes); - break; - - case TO_DEVICE: - CopyMem ((UINT8 *) (UINTN) DeviceAddr, (UINT8 *) (UINTN) CpuAddr, NumBytes); - break; - } - - return ; -} diff --git a/MdeModulePkg/Universal/Network/SnpDxe/ComponentName.c b/MdeModulePkg/Universal/Network/SnpDxe/ComponentName.c deleted file mode 100644 index 2139e2a47f..0000000000 --- a/MdeModulePkg/Universal/Network/SnpDxe/ComponentName.c +++ /dev/null @@ -1,430 +0,0 @@ -/** @file - UEFI Component Name(2) protocol implementation for SnpDxe driver. - -Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - - -#include "Snp.h" - -// -// EFI Component Name Functions -// -/** - Retrieves a Unicode string that is the user readable name of the driver. - - This function retrieves the user readable name of a driver in the form of a - Unicode string. If the driver specified by This has a user readable name in - the language specified by Language, then a pointer to the driver name is - returned in DriverName, and EFI_SUCCESS is returned. If the driver specified - by This does not support the language specified by Language, - then EFI_UNSUPPORTED is returned. - - @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param Language[in] A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified - in RFC 4646 or ISO 639-2 language code format. - - @param DriverName[out] A pointer to the Unicode string to return. - This Unicode string is the name of the - driver specified by This in the language - specified by Language. - - @retval EFI_SUCCESS The Unicode string for the Driver specified by - This and the language specified by Language was - returned in DriverName. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER DriverName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -SimpleNetworkComponentNameGetDriverName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN CHAR8 *Language, - OUT CHAR16 **DriverName - ); - - -/** - Retrieves a Unicode string that is the user readable name of the controller - that is being managed by a driver. - - This function retrieves the user readable name of the controller specified by - ControllerHandle and ChildHandle in the form of a Unicode string. If the - driver specified by This has a user readable name in the language specified by - Language, then a pointer to the controller name is returned in ControllerName, - and EFI_SUCCESS is returned. If the driver specified by This is not currently - managing the controller specified by ControllerHandle and ChildHandle, - then EFI_UNSUPPORTED is returned. If the driver specified by This does not - support the language specified by Language, then EFI_UNSUPPORTED is returned. - - @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param ControllerHandle[in] The handle of a controller that the driver - specified by This is managing. This handle - specifies the controller whose name is to be - returned. - - @param ChildHandle[in] The handle of the child controller to retrieve - the name of. This is an optional parameter that - may be NULL. It will be NULL for device - drivers. It will also be NULL for a bus drivers - that wish to retrieve the name of the bus - controller. It will not be NULL for a bus - driver that wishes to retrieve the name of a - child controller. - - @param Language[in] A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified in - RFC 4646 or ISO 639-2 language code format. - - @param ControllerName[out] A pointer to the Unicode string to return. - This Unicode string is the name of the - controller specified by ControllerHandle and - ChildHandle in the language specified by - Language from the point of view of the driver - specified by This. - - @retval EFI_SUCCESS The Unicode string for the user readable name in - the language specified by Language for the - driver specified by This was returned in - DriverName. - - @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. - - @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid - EFI_HANDLE. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER ControllerName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This is not currently - managing the controller specified by - ControllerHandle and ChildHandle. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -SimpleNetworkComponentNameGetControllerName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_HANDLE ChildHandle OPTIONAL, - IN CHAR8 *Language, - OUT CHAR16 **ControllerName - ); - - -// -// EFI Component Name Protocol -// -GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gSimpleNetworkComponentName = { - SimpleNetworkComponentNameGetDriverName, - SimpleNetworkComponentNameGetControllerName, - "eng" -}; - -// -// EFI Component Name 2 Protocol -// -GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gSimpleNetworkComponentName2 = { - (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) SimpleNetworkComponentNameGetDriverName, - (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) SimpleNetworkComponentNameGetControllerName, - "en" -}; - - -GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mSimpleNetworkDriverNameTable[] = { - { - "eng;en", - L"Simple Network Protocol Driver" - }, - { - NULL, - NULL - } -}; - -GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE *gSimpleNetworkControllerNameTable = NULL; - -/** - Retrieves a Unicode string that is the user readable name of the driver. - - This function retrieves the user readable name of a driver in the form of a - Unicode string. If the driver specified by This has a user readable name in - the language specified by Language, then a pointer to the driver name is - returned in DriverName, and EFI_SUCCESS is returned. If the driver specified - by This does not support the language specified by Language, - then EFI_UNSUPPORTED is returned. - - @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param Language[in] A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified - in RFC 4646 or ISO 639-2 language code format. - - @param DriverName[out] A pointer to the Unicode string to return. - This Unicode string is the name of the - driver specified by This in the language - specified by Language. - - @retval EFI_SUCCESS The Unicode string for the Driver specified by - This and the language specified by Language was - returned in DriverName. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER DriverName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -SimpleNetworkComponentNameGetDriverName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN CHAR8 *Language, - OUT CHAR16 **DriverName - ) -{ - return LookupUnicodeString2 ( - Language, - This->SupportedLanguages, - mSimpleNetworkDriverNameTable, - DriverName, - (BOOLEAN)(This == &gSimpleNetworkComponentName) - ); -} - -/** - Update the component name for the Snp child handle. - - @param Snp[in] A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL. - - - @retval EFI_SUCCESS Update the ControllerNameTable of this instance successfully. - @retval EFI_INVALID_PARAMETER The input parameter is invalid. - -**/ -EFI_STATUS -UpdateName ( - IN EFI_SIMPLE_NETWORK_PROTOCOL *Snp - ) -{ - EFI_STATUS Status; - CHAR16 HandleName[80]; - UINTN OffSet; - UINTN Index; - - if (Snp == NULL) { - return EFI_INVALID_PARAMETER; - } - - OffSet = 0; - OffSet += UnicodeSPrint ( - HandleName, - sizeof (HandleName), - L"SNP (MAC=" - ); - for (Index = 0; Index < Snp->Mode->HwAddressSize; Index++) { - OffSet += UnicodeSPrint ( - HandleName + OffSet, - sizeof (HandleName) - OffSet * sizeof (CHAR16), - L"%02X-", - Snp->Mode->CurrentAddress.Addr[Index] - ); - } - ASSERT (OffSet > 0); - // - // Remove the last '-' - // - OffSet--; - OffSet += UnicodeSPrint ( - HandleName + OffSet, - sizeof (HandleName) - OffSet * sizeof (CHAR16), - L")" - ); - if (gSimpleNetworkControllerNameTable != NULL) { - FreeUnicodeStringTable (gSimpleNetworkControllerNameTable); - gSimpleNetworkControllerNameTable = NULL; - } - - Status = AddUnicodeString2 ( - "eng", - gSimpleNetworkComponentName.SupportedLanguages, - &gSimpleNetworkControllerNameTable, - HandleName, - TRUE - ); - if (EFI_ERROR (Status)) { - return Status; - } - - return AddUnicodeString2 ( - "en", - gSimpleNetworkComponentName2.SupportedLanguages, - &gSimpleNetworkControllerNameTable, - HandleName, - FALSE - ); -} - -/** - Retrieves a Unicode string that is the user readable name of the controller - that is being managed by a driver. - - This function retrieves the user readable name of the controller specified by - ControllerHandle and ChildHandle in the form of a Unicode string. If the - driver specified by This has a user readable name in the language specified by - Language, then a pointer to the controller name is returned in ControllerName, - and EFI_SUCCESS is returned. If the driver specified by This is not currently - managing the controller specified by ControllerHandle and ChildHandle, - then EFI_UNSUPPORTED is returned. If the driver specified by This does not - support the language specified by Language, then EFI_UNSUPPORTED is returned. - Currently not implemented. - - @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param ControllerHandle[in] The handle of a controller that the driver - specified by This is managing. This handle - specifies the controller whose name is to be - returned. - - @param ChildHandle[in] The handle of the child controller to retrieve - the name of. This is an optional parameter that - may be NULL. It will be NULL for device - drivers. It will also be NULL for a bus drivers - that wish to retrieve the name of the bus - controller. It will not be NULL for a bus - driver that wishes to retrieve the name of a - child controller. - - @param Language[in] A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified in - RFC 4646 or ISO 639-2 language code format. - - @param ControllerName[out] A pointer to the Unicode string to return. - This Unicode string is the name of the - controller specified by ControllerHandle and - ChildHandle in the language specified by - Language from the point of view of the driver - specified by This. - - @retval EFI_SUCCESS The Unicode string for the user readable name in - the language specified by Language for the - driver specified by This was returned in - DriverName. - - @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. - - @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid - EFI_HANDLE. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER ControllerName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This is not currently - managing the controller specified by - ControllerHandle and ChildHandle. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -SimpleNetworkComponentNameGetControllerName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_HANDLE ChildHandle OPTIONAL, - IN CHAR8 *Language, - OUT CHAR16 **ControllerName - ) -{ - EFI_STATUS Status; - EFI_SIMPLE_NETWORK_PROTOCOL *Snp; - - if (ChildHandle != NULL) { - return EFI_UNSUPPORTED; - } - - // - // Make sure this driver is currently managing ControllHandle - // - Status = EfiTestManagedDevice ( - ControllerHandle, - gSimpleNetworkDriverBinding.DriverBindingHandle, - &gEfiSimpleNetworkProtocolGuid - ); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Retrieve an instance of a produced protocol from ControllerHandle - // - Status = gBS->OpenProtocol ( - ControllerHandle, - &gEfiSimpleNetworkProtocolGuid, - (VOID **)&Snp, - NULL, - NULL, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - if (EFI_ERROR (Status)) { - return Status; - } - // - // Update the component name for this child handle. - // - Status = UpdateName (Snp); - if (EFI_ERROR (Status)) { - return Status; - } - - return LookupUnicodeString2 ( - Language, - This->SupportedLanguages, - gSimpleNetworkControllerNameTable, - ControllerName, - (BOOLEAN)(This == &gSimpleNetworkComponentName) - ); -} diff --git a/MdeModulePkg/Universal/Network/SnpDxe/Get_status.c b/MdeModulePkg/Universal/Network/SnpDxe/Get_status.c deleted file mode 100644 index be6608a0b3..0000000000 --- a/MdeModulePkg/Universal/Network/SnpDxe/Get_status.c +++ /dev/null @@ -1,257 +0,0 @@ -/** @file - Implementation of reading the current interrupt status and recycled transmit - buffer status from a network interface. - -Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Snp.h" - -/** - Call undi to get the status of the interrupts, get the list of recycled transmit - buffers that completed transmitting. The recycled transmit buffer address will - be saved into Snp->RecycledTxBuf. This function will also update the MediaPresent - field of EFI_SIMPLE_NETWORK_MODE if UNDI support it. - - @param[in] Snp Pointer to snp driver structure. - @param[out] InterruptStatusPtr A non null pointer to contain the interrupt - status. - @param[in] GetTransmittedBuf Set to TRUE to retrieve the recycled transmit - buffer address. - - @retval EFI_SUCCESS The status of the network interface was retrieved. - @retval EFI_DEVICE_ERROR The command could not be sent to the network - interface. - -**/ -EFI_STATUS -PxeGetStatus ( - IN SNP_DRIVER *Snp, - OUT UINT32 *InterruptStatusPtr, - IN BOOLEAN GetTransmittedBuf - ) -{ - PXE_DB_GET_STATUS *Db; - UINT16 InterruptFlags; - UINT32 Index; - UINT64 *Tmp; - - Tmp = NULL; - Db = Snp->Db; - Snp->Cdb.OpCode = PXE_OPCODE_GET_STATUS; - - Snp->Cdb.OpFlags = 0; - - if (GetTransmittedBuf) { - Snp->Cdb.OpFlags |= PXE_OPFLAGS_GET_TRANSMITTED_BUFFERS; - ZeroMem (Db->TxBuffer, sizeof (Db->TxBuffer)); - } - - if (InterruptStatusPtr != NULL) { - Snp->Cdb.OpFlags |= PXE_OPFLAGS_GET_INTERRUPT_STATUS; - } - - if (Snp->MediaStatusSupported) { - Snp->Cdb.OpFlags |= PXE_OPFLAGS_GET_MEDIA_STATUS; - } - - Snp->Cdb.CPBsize = PXE_CPBSIZE_NOT_USED; - Snp->Cdb.CPBaddr = PXE_CPBADDR_NOT_USED; - - Snp->Cdb.DBsize = (UINT16) sizeof (PXE_DB_GET_STATUS); - Snp->Cdb.DBaddr = (UINT64)(UINTN) Db; - - Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; - Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; - Snp->Cdb.IFnum = Snp->IfNum; - Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; - - // - // Issue UNDI command and check result. - // - DEBUG ((EFI_D_NET, "\nSnp->undi.get_status() ")); - - (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); - - if (Snp->Cdb.StatCode != PXE_STATCODE_SUCCESS) { - DEBUG ( - (EFI_D_NET, - "\nSnp->undi.get_status() %xh:%xh\n", - Snp->Cdb.StatFlags, - Snp->Cdb.StatCode) - ); - - return EFI_DEVICE_ERROR; - } - // - // report the values back.. - // - if (InterruptStatusPtr != NULL) { - InterruptFlags = (UINT16) (Snp->Cdb.StatFlags & PXE_STATFLAGS_GET_STATUS_INTERRUPT_MASK); - - *InterruptStatusPtr = 0; - - if ((InterruptFlags & PXE_STATFLAGS_GET_STATUS_RECEIVE) == PXE_STATFLAGS_GET_STATUS_RECEIVE) { - *InterruptStatusPtr |= EFI_SIMPLE_NETWORK_RECEIVE_INTERRUPT; - } - - if ((InterruptFlags & PXE_STATFLAGS_GET_STATUS_TRANSMIT) == PXE_STATFLAGS_GET_STATUS_TRANSMIT) { - *InterruptStatusPtr |= EFI_SIMPLE_NETWORK_TRANSMIT_INTERRUPT; - } - - if ((InterruptFlags & PXE_STATFLAGS_GET_STATUS_COMMAND) == PXE_STATFLAGS_GET_STATUS_COMMAND) { - *InterruptStatusPtr |= EFI_SIMPLE_NETWORK_COMMAND_INTERRUPT; - } - - if ((InterruptFlags & PXE_STATFLAGS_GET_STATUS_SOFTWARE) == PXE_STATFLAGS_GET_STATUS_SOFTWARE) { - *InterruptStatusPtr |= EFI_SIMPLE_NETWORK_COMMAND_INTERRUPT; - } - - } - - if (GetTransmittedBuf) { - if ((Snp->Cdb.StatFlags & PXE_STATFLAGS_GET_STATUS_NO_TXBUFS_WRITTEN) == 0) { - // - // UNDI has written some transmitted buffer addresses into the DB. Store them into Snp->RecycledTxBuf. - // - for (Index = 0; Index < MAX_XMIT_BUFFERS; Index++) { - if (Db->TxBuffer[Index] != 0) { - if (Snp->RecycledTxBufCount == Snp->MaxRecycledTxBuf) { - // - // Snp->RecycledTxBuf is full, reallocate a new one. - // - if ((Snp->MaxRecycledTxBuf + SNP_TX_BUFFER_INCREASEMENT) >= SNP_MAX_TX_BUFFER_NUM) { - return EFI_DEVICE_ERROR; - } - Tmp = AllocatePool (sizeof (UINT64) * (Snp->MaxRecycledTxBuf + SNP_TX_BUFFER_INCREASEMENT)); - if (Tmp == NULL) { - return EFI_DEVICE_ERROR; - } - CopyMem (Tmp, Snp->RecycledTxBuf, sizeof (UINT64) * Snp->RecycledTxBufCount); - FreePool (Snp->RecycledTxBuf); - Snp->RecycledTxBuf = Tmp; - Snp->MaxRecycledTxBuf += SNP_TX_BUFFER_INCREASEMENT; - } - Snp->RecycledTxBuf[Snp->RecycledTxBufCount] = Db->TxBuffer[Index]; - Snp->RecycledTxBufCount++; - } - } - } - } - - // - // Update MediaPresent field of EFI_SIMPLE_NETWORK_MODE if the UNDI support - // returning media status from GET_STATUS command - // - if (Snp->MediaStatusSupported) { - Snp->Snp.Mode->MediaPresent = - (BOOLEAN) (((Snp->Cdb.StatFlags & PXE_STATFLAGS_GET_STATUS_NO_MEDIA) != 0) ? FALSE : TRUE); - } - - return EFI_SUCCESS; -} - -/** - Reads the current interrupt status and recycled transmit buffer status from a - network interface. - - This function gets the current interrupt and recycled transmit buffer status - from the network interface. The interrupt status is returned as a bit mask in - InterruptStatus. If InterruptStatus is NULL, the interrupt status will not be - read. If TxBuf is not NULL, a recycled transmit buffer address will be retrieved. - If a recycled transmit buffer address is returned in TxBuf, then the buffer has - been successfully transmitted, and the status for that buffer is cleared. If - the status of the network interface is successfully collected, EFI_SUCCESS - will be returned. If the driver has not been initialized, EFI_DEVICE_ERROR will - be returned. - - @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. - @param InterruptStatus A pointer to the bit mask of the currently active - interrupts (see "Related Definitions"). If this is NULL, - the interrupt status will not be read from the device. - If this is not NULL, the interrupt status will be read - from the device. When the interrupt status is read, it - will also be cleared. Clearing the transmit interrupt does - not empty the recycled transmit buffer array. - @param TxBuf Recycled transmit buffer address. The network interface - will not transmit if its internal recycled transmit - buffer array is full. Reading the transmit buffer does - not clear the transmit interrupt. If this is NULL, then - the transmit buffer status will not be read. If there - are no transmit buffers to recycle and TxBuf is not NULL, - TxBuf will be set to NULL. - - @retval EFI_SUCCESS The status of the network interface was retrieved. - @retval EFI_NOT_STARTED The network interface has not been started. - @retval EFI_INVALID_PARAMETER This parameter was NULL or did not point to a valid - EFI_SIMPLE_NETWORK_PROTOCOL structure. - @retval EFI_DEVICE_ERROR The command could not be sent to the network - interface. - -**/ -EFI_STATUS -EFIAPI -SnpUndi32GetStatus ( - IN EFI_SIMPLE_NETWORK_PROTOCOL *This, - OUT UINT32 *InterruptStatus, OPTIONAL - OUT VOID **TxBuf OPTIONAL - ) -{ - SNP_DRIVER *Snp; - EFI_TPL OldTpl; - EFI_STATUS Status; - - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - if (InterruptStatus == NULL && TxBuf == NULL) { - return EFI_INVALID_PARAMETER; - } - - Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This); - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - if (Snp == NULL) { - return EFI_DEVICE_ERROR; - } - - switch (Snp->Mode.State) { - case EfiSimpleNetworkInitialized: - break; - - case EfiSimpleNetworkStopped: - Status = EFI_NOT_STARTED; - goto ON_EXIT; - - default: - Status = EFI_DEVICE_ERROR; - goto ON_EXIT; - } - - if (Snp->RecycledTxBufCount == 0 && TxBuf != NULL) { - Status = PxeGetStatus (Snp, InterruptStatus, TRUE); - } else { - Status = PxeGetStatus (Snp, InterruptStatus, FALSE); - } - - if (TxBuf != NULL) { - // - // Get a recycled buf from Snp->RecycledTxBuf - // - if (Snp->RecycledTxBufCount == 0) { - *TxBuf = NULL; - } else { - Snp->RecycledTxBufCount--; - *TxBuf = (VOID *) (UINTN) Snp->RecycledTxBuf[Snp->RecycledTxBufCount]; - } - } - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - - return Status; -} diff --git a/MdeModulePkg/Universal/Network/SnpDxe/Initialize.c b/MdeModulePkg/Universal/Network/SnpDxe/Initialize.c deleted file mode 100644 index 4d33154241..0000000000 --- a/MdeModulePkg/Universal/Network/SnpDxe/Initialize.c +++ /dev/null @@ -1,277 +0,0 @@ -/** @file - Implementation of initializing a network adapter. - -Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - - -#include "Snp.h" - -/** - Call UNDI to initialize the interface. - - @param Snp Pointer to snp driver structure. - @param CableDetectFlag Do/don't detect the cable (depending on what - undi supports). - - @retval EFI_SUCCESS UNDI is initialized successfully. - @retval EFI_DEVICE_ERROR UNDI could not be initialized. - @retval Other Other errors as indicated. - -**/ -EFI_STATUS -PxeInit ( - SNP_DRIVER *Snp, - UINT16 CableDetectFlag - ) -{ - PXE_CPB_INITIALIZE *Cpb; - VOID *Addr; - EFI_STATUS Status; - - Status = EFI_SUCCESS; - - Cpb = Snp->Cpb; - if (Snp->TxRxBufferSize != 0) { - Status = Snp->PciIo->AllocateBuffer ( - Snp->PciIo, - AllocateAnyPages, - EfiBootServicesData, - SNP_MEM_PAGES (Snp->TxRxBufferSize), - &Addr, - 0 - ); - - if (Status != EFI_SUCCESS) { - DEBUG ( - (EFI_D_ERROR, - "\nSnp->PxeInit() AllocateBuffer %xh (%r)\n", - Status, - Status) - ); - - return Status; - } - - ASSERT (Addr); - - Snp->TxRxBuffer = Addr; - } - - Cpb->MemoryAddr = (UINT64)(UINTN) Snp->TxRxBuffer; - - Cpb->MemoryLength = Snp->TxRxBufferSize; - - // - // let UNDI decide/detect these values - // - Cpb->LinkSpeed = 0; - Cpb->TxBufCnt = 0; - Cpb->TxBufSize = 0; - Cpb->RxBufCnt = 0; - Cpb->RxBufSize = 0; - - Cpb->DuplexMode = PXE_DUPLEX_DEFAULT; - - Cpb->LoopBackMode = LOOPBACK_NORMAL; - - Snp->Cdb.OpCode = PXE_OPCODE_INITIALIZE; - Snp->Cdb.OpFlags = CableDetectFlag; - - Snp->Cdb.CPBsize = (UINT16) sizeof (PXE_CPB_INITIALIZE); - Snp->Cdb.DBsize = (UINT16) sizeof (PXE_DB_INITIALIZE); - - Snp->Cdb.CPBaddr = (UINT64)(UINTN) Snp->Cpb; - Snp->Cdb.DBaddr = (UINT64)(UINTN) Snp->Db; - - Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; - Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; - Snp->Cdb.IFnum = Snp->IfNum; - Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; - - DEBUG ((EFI_D_NET, "\nSnp->undi.initialize() ")); - - (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); - - // - // There are two fields need to be checked here: - // First is the upper two bits (14 & 15) in the CDB.StatFlags field. Until these bits change to report - // PXE_STATFLAGS_COMMAND_COMPLETE or PXE_STATFLAGS_COMMAND_FAILED, the command has not been executed by the UNDI. - // Second is the CDB.StatCode field. After command execution completes, either successfully or not, - // the CDB.StatCode field contains the result of the command execution. - // - if ((((Snp->Cdb.StatFlags) & PXE_STATFLAGS_STATUS_MASK) == PXE_STATFLAGS_COMMAND_COMPLETE) && - (Snp->Cdb.StatCode == PXE_STATCODE_SUCCESS)) { - // - // If cable detect feature is enabled in CDB.OpFlags, check the CDB.StatFlags to see if there is an - // active connection to this network device. If the no media StatFlag is set, the UNDI and network - // device are still initialized. - // - if (CableDetectFlag == PXE_OPFLAGS_INITIALIZE_DETECT_CABLE) { - if(((Snp->Cdb.StatFlags) & PXE_STATFLAGS_INITIALIZED_NO_MEDIA) != PXE_STATFLAGS_INITIALIZED_NO_MEDIA) { - Snp->Mode.MediaPresent = TRUE; - } else { - Snp->Mode.MediaPresent = FALSE; - } - } - - Snp->Mode.State = EfiSimpleNetworkInitialized; - Status = EFI_SUCCESS; - } else { - DEBUG ( - (EFI_D_WARN, - "\nSnp->undi.initialize() %xh:%xh\n", - Snp->Cdb.StatFlags, - Snp->Cdb.StatCode) - ); - - if (Snp->TxRxBuffer != NULL) { - Snp->PciIo->FreeBuffer ( - Snp->PciIo, - SNP_MEM_PAGES (Snp->TxRxBufferSize), - (VOID *) Snp->TxRxBuffer - ); - } - - Snp->TxRxBuffer = NULL; - - Status = EFI_DEVICE_ERROR; - } - - return Status; -} - - -/** - Resets a network adapter and allocates the transmit and receive buffers - required by the network interface; optionally, also requests allocation of - additional transmit and receive buffers. - - This function allocates the transmit and receive buffers required by the network - interface. If this allocation fails, then EFI_OUT_OF_RESOURCES is returned. - If the allocation succeeds and the network interface is successfully initialized, - then EFI_SUCCESS will be returned. - - @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. - - @param ExtraRxBufferSize The size, in bytes, of the extra receive buffer space - that the driver should allocate for the network interface. - Some network interfaces will not be able to use the - extra buffer, and the caller will not know if it is - actually being used. - @param ExtraTxBufferSize The size, in bytes, of the extra transmit buffer space - that the driver should allocate for the network interface. - Some network interfaces will not be able to use the - extra buffer, and the caller will not know if it is - actually being used. - - @retval EFI_SUCCESS The network interface was initialized. - @retval EFI_NOT_STARTED The network interface has not been started. - @retval EFI_OUT_OF_RESOURCES There was not enough memory for the transmit and - receive buffers. - @retval EFI_INVALID_PARAMETER This parameter was NULL or did not point to a valid - EFI_SIMPLE_NETWORK_PROTOCOL structure. - @retval EFI_DEVICE_ERROR The command could not be sent to the network interface. - @retval EFI_UNSUPPORTED The increased buffer size feature is not supported. - -**/ -EFI_STATUS -EFIAPI -SnpUndi32Initialize ( - IN EFI_SIMPLE_NETWORK_PROTOCOL *This, - IN UINTN ExtraRxBufferSize OPTIONAL, - IN UINTN ExtraTxBufferSize OPTIONAL - ) -{ - EFI_STATUS EfiStatus; - SNP_DRIVER *Snp; - EFI_TPL OldTpl; - - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This); - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - if (Snp == NULL) { - EfiStatus = EFI_INVALID_PARAMETER; - goto ON_EXIT; - } - - switch (Snp->Mode.State) { - case EfiSimpleNetworkStarted: - break; - - case EfiSimpleNetworkStopped: - EfiStatus = EFI_NOT_STARTED; - goto ON_EXIT; - - default: - EfiStatus = EFI_DEVICE_ERROR; - goto ON_EXIT; - } - - EfiStatus = gBS->CreateEvent ( - EVT_NOTIFY_WAIT, - TPL_NOTIFY, - &SnpWaitForPacketNotify, - Snp, - &Snp->Snp.WaitForPacket - ); - - if (EFI_ERROR (EfiStatus)) { - Snp->Snp.WaitForPacket = NULL; - EfiStatus = EFI_DEVICE_ERROR; - goto ON_EXIT; - } - // - // - // - Snp->Mode.MCastFilterCount = 0; - Snp->Mode.ReceiveFilterSetting = 0; - ZeroMem (Snp->Mode.MCastFilter, sizeof Snp->Mode.MCastFilter); - CopyMem ( - &Snp->Mode.CurrentAddress, - &Snp->Mode.PermanentAddress, - sizeof (EFI_MAC_ADDRESS) - ); - - // - // Compute tx/rx buffer sizes based on UNDI init info and parameters. - // - Snp->TxRxBufferSize = (UINT32) (Snp->InitInfo.MemoryRequired + ExtraRxBufferSize + ExtraTxBufferSize); - - // - // If UNDI support cable detect for INITIALIZE command, try it first. - // - if (Snp->CableDetectSupported) { - if (PxeInit (Snp, PXE_OPFLAGS_INITIALIZE_DETECT_CABLE) == EFI_SUCCESS) { - goto ON_EXIT; - } - } - - Snp->Mode.MediaPresent = FALSE; - - EfiStatus = PxeInit (Snp, PXE_OPFLAGS_INITIALIZE_DO_NOT_DETECT_CABLE); - - if (EFI_ERROR (EfiStatus)) { - gBS->CloseEvent (Snp->Snp.WaitForPacket); - goto ON_EXIT; - } - - // - // Try to update the MediaPresent field of EFI_SIMPLE_NETWORK_MODE if the UNDI support it. - // - if (Snp->MediaStatusSupported) { - PxeGetStatus (Snp, NULL, FALSE); - } - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - - return EfiStatus; -} diff --git a/MdeModulePkg/Universal/Network/SnpDxe/Mcast_ip_to_mac.c b/MdeModulePkg/Universal/Network/SnpDxe/Mcast_ip_to_mac.c deleted file mode 100644 index 9863c1f9ea..0000000000 --- a/MdeModulePkg/Universal/Network/SnpDxe/Mcast_ip_to_mac.c +++ /dev/null @@ -1,173 +0,0 @@ -/** @file - Implementation of converting an multicast IP address to multicast HW MAC - address. - -Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Snp.h" - -/** - Call undi to convert an multicast IP address to a MAC address. - - @param Snp Pointer to snp driver structure. - @param IPv6 Flag to indicate if this is an ipv6 address. - @param IP Multicast IP address. - @param MAC Pointer to hold the return MAC address. - - @retval EFI_SUCCESS The multicast IP address was mapped to the - multicast HW MAC address. - @retval EFI_INVALID_PARAMETER Invalid UNDI command. - @retval EFI_UNSUPPORTED Command is not supported by UNDI. - @retval EFI_DEVICE_ERROR Fail to execute UNDI command. - -**/ -EFI_STATUS -PxeIp2Mac ( - IN SNP_DRIVER *Snp, - IN BOOLEAN IPv6, - IN EFI_IP_ADDRESS *IP, - IN OUT EFI_MAC_ADDRESS *MAC - ) -{ - PXE_CPB_MCAST_IP_TO_MAC *Cpb; - PXE_DB_MCAST_IP_TO_MAC *Db; - - Cpb = Snp->Cpb; - Db = Snp->Db; - Snp->Cdb.OpCode = PXE_OPCODE_MCAST_IP_TO_MAC; - Snp->Cdb.OpFlags = (UINT16) (IPv6 ? PXE_OPFLAGS_MCAST_IPV6_TO_MAC : PXE_OPFLAGS_MCAST_IPV4_TO_MAC); - Snp->Cdb.CPBsize = (UINT16) sizeof (PXE_CPB_MCAST_IP_TO_MAC); - Snp->Cdb.DBsize = (UINT16) sizeof (PXE_DB_MCAST_IP_TO_MAC); - - Snp->Cdb.CPBaddr = (UINT64)(UINTN) Cpb; - Snp->Cdb.DBaddr = (UINT64)(UINTN) Db; - - Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; - Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; - Snp->Cdb.IFnum = Snp->IfNum; - Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; - - CopyMem (&Cpb->IP, IP, sizeof (PXE_IP_ADDR)); - - // - // Issue UNDI command and check result. - // - DEBUG ((EFI_D_NET, "\nSnp->undi.mcast_ip_to_mac() ")); - - (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); - - switch (Snp->Cdb.StatCode) { - case PXE_STATCODE_SUCCESS: - break; - - case PXE_STATCODE_INVALID_CPB: - return EFI_INVALID_PARAMETER; - - case PXE_STATCODE_UNSUPPORTED: - DEBUG ( - (EFI_D_NET, - "\nSnp->undi.mcast_ip_to_mac() %xh:%xh\n", - Snp->Cdb.StatFlags, - Snp->Cdb.StatCode) - ); - return EFI_UNSUPPORTED; - - default: - // - // UNDI command failed. Return EFI_DEVICE_ERROR - // to caller. - // - DEBUG ( - (EFI_D_NET, - "\nSnp->undi.mcast_ip_to_mac() %xh:%xh\n", - Snp->Cdb.StatFlags, - Snp->Cdb.StatCode) - ); - - return EFI_DEVICE_ERROR; - } - - CopyMem (MAC, &Db->MAC, sizeof (PXE_MAC_ADDR)); - return EFI_SUCCESS; -} - - -/** - Converts a multicast IP address to a multicast HW MAC address. - - This function converts a multicast IP address to a multicast HW MAC address - for all packet transactions. If the mapping is accepted, then EFI_SUCCESS will - be returned. - - @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. - @param IPv6 Set to TRUE if the multicast IP address is IPv6 [RFC 2460]. - Set to FALSE if the multicast IP address is IPv4 [RFC 791]. - @param IP The multicast IP address that is to be converted to a multicast - HW MAC address. - @param MAC The multicast HW MAC address that is to be generated from IP. - - @retval EFI_SUCCESS The multicast IP address was mapped to the - multicast HW MAC address. - @retval EFI_NOT_STARTED The Simple Network Protocol interface has not - been started by calling Start(). - @retval EFI_INVALID_PARAMETER IP is NULL. - @retval EFI_INVALID_PARAMETER MAC is NULL. - @retval EFI_INVALID_PARAMETER IP does not point to a valid IPv4 or IPv6 - multicast address. - @retval EFI_DEVICE_ERROR The Simple Network Protocol interface has not - been initialized by calling Initialize(). - @retval EFI_UNSUPPORTED IPv6 is TRUE and the implementation does not - support IPv6 multicast to MAC address conversion. - -**/ -EFI_STATUS -EFIAPI -SnpUndi32McastIpToMac ( - IN EFI_SIMPLE_NETWORK_PROTOCOL *This, - IN BOOLEAN IPv6, - IN EFI_IP_ADDRESS *IP, - OUT EFI_MAC_ADDRESS *MAC - ) -{ - SNP_DRIVER *Snp; - EFI_TPL OldTpl; - EFI_STATUS Status; - - // - // Get pointer to SNP driver instance for *this. - // - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - if (IP == NULL || MAC == NULL) { - return EFI_INVALID_PARAMETER; - } - - Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This); - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - switch (Snp->Mode.State) { - case EfiSimpleNetworkInitialized: - break; - - case EfiSimpleNetworkStopped: - Status = EFI_NOT_STARTED; - goto ON_EXIT; - - default: - Status = EFI_DEVICE_ERROR; - goto ON_EXIT; - } - - Status = PxeIp2Mac (Snp, IPv6, IP, MAC); - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - - return Status; -} diff --git a/MdeModulePkg/Universal/Network/SnpDxe/Nvdata.c b/MdeModulePkg/Universal/Network/SnpDxe/Nvdata.c deleted file mode 100644 index 7010b63a54..0000000000 --- a/MdeModulePkg/Universal/Network/SnpDxe/Nvdata.c +++ /dev/null @@ -1,217 +0,0 @@ -/** @file - Implementation of reading and writing operations on the NVRAM device - attached to a network interface. - -Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Snp.h" - - -/** - This routine calls Undi to read the desired number of eeprom bytes. - - @param Snp pointer to the snp driver structure - @param Offset eeprom register value relative to the base address - @param BufferSize number of bytes to read - @param Buffer pointer where to read into - - @retval EFI_SUCCESS The NVRAM access was performed. - @retval EFI_INVALID_PARAMETER Invalid UNDI command. - @retval EFI_UNSUPPORTED Command is not supported by UNDI. - @retval EFI_DEVICE_ERROR Fail to execute UNDI command. - -**/ -EFI_STATUS -PxeNvDataRead ( - IN SNP_DRIVER *Snp, - IN UINTN Offset, - IN UINTN BufferSize, - IN OUT VOID *Buffer - ) -{ - PXE_DB_NVDATA *Db; - - Db = Snp->Db; - Snp->Cdb.OpCode = PXE_OPCODE_NVDATA; - - Snp->Cdb.OpFlags = PXE_OPFLAGS_NVDATA_READ; - - Snp->Cdb.CPBsize = PXE_CPBSIZE_NOT_USED; - Snp->Cdb.CPBaddr = PXE_CPBADDR_NOT_USED; - - Snp->Cdb.DBsize = (UINT16) sizeof (PXE_DB_NVDATA); - Snp->Cdb.DBaddr = (UINT64)(UINTN) Db; - - Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; - Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; - Snp->Cdb.IFnum = Snp->IfNum; - Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; - - // - // Issue UNDI command and check result. - // - DEBUG ((EFI_D_NET, "\nsnp->undi.nvdata () ")); - - (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); - - switch (Snp->Cdb.StatCode) { - case PXE_STATCODE_SUCCESS: - break; - - case PXE_STATCODE_UNSUPPORTED: - DEBUG ( - (EFI_D_NET, - "\nsnp->undi.nvdata() %xh:%xh\n", - Snp->Cdb.StatFlags, - Snp->Cdb.StatCode) - ); - - return EFI_UNSUPPORTED; - - default: - DEBUG ( - (EFI_D_NET, - "\nsnp->undi.nvdata() %xh:%xh\n", - Snp->Cdb.StatFlags, - Snp->Cdb.StatCode) - ); - - return EFI_DEVICE_ERROR; - } - - ASSERT (Offset < sizeof (Db->Data)); - - CopyMem (Buffer, &Db->Data.Byte[Offset], BufferSize); - - return EFI_SUCCESS; -} - - -/** - Performs read and write operations on the NVRAM device attached to a network - interface. - - This function performs read and write operations on the NVRAM device attached - to a network interface. If ReadWrite is TRUE, a read operation is performed. - If ReadWrite is FALSE, a write operation is performed. Offset specifies the - byte offset at which to start either operation. Offset must be a multiple of - NvRamAccessSize , and it must have a value between zero and NvRamSize. - BufferSize specifies the length of the read or write operation. BufferSize must - also be a multiple of NvRamAccessSize, and Offset + BufferSize must not exceed - NvRamSize. - If any of the above conditions is not met, then EFI_INVALID_PARAMETER will be - returned. - If all the conditions are met and the operation is "read," the NVRAM device - attached to the network interface will be read into Buffer and EFI_SUCCESS - will be returned. If this is a write operation, the contents of Buffer will be - used to update the contents of the NVRAM device attached to the network - interface and EFI_SUCCESS will be returned. - - It does the basic checking on the input parameters and retrieves snp structure - and then calls the read_nvdata() call which does the actual reading - - @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. - @param ReadWrite TRUE for read operations, FALSE for write operations. - @param Offset Byte offset in the NVRAM device at which to start the read or - write operation. This must be a multiple of NvRamAccessSize - and less than NvRamSize. (See EFI_SIMPLE_NETWORK_MODE) - @param BufferSize The number of bytes to read or write from the NVRAM device. - This must also be a multiple of NvramAccessSize. - @param Buffer A pointer to the data buffer. - - @retval EFI_SUCCESS The NVRAM access was performed. - @retval EFI_NOT_STARTED The network interface has not been started. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - * The This parameter is NULL - * The This parameter does not point to a valid - EFI_SIMPLE_NETWORK_PROTOCOL structure - * The Offset parameter is not a multiple of - EFI_SIMPLE_NETWORK_MODE.NvRamAccessSize - * The Offset parameter is not less than - EFI_SIMPLE_NETWORK_MODE.NvRamSize - * The BufferSize parameter is not a multiple of - EFI_SIMPLE_NETWORK_MODE.NvRamAccessSize - * The Buffer parameter is NULL - @retval EFI_DEVICE_ERROR The command could not be sent to the network - interface. - @retval EFI_UNSUPPORTED This function is not supported by the network - interface. - -**/ -EFI_STATUS -EFIAPI -SnpUndi32NvData ( - IN EFI_SIMPLE_NETWORK_PROTOCOL *This, - IN BOOLEAN ReadWrite, - IN UINTN Offset, - IN UINTN BufferSize, - IN OUT VOID *Buffer - ) -{ - SNP_DRIVER *Snp; - EFI_TPL OldTpl; - EFI_STATUS Status; - - // - // Get pointer to SNP driver instance for *this. - // - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This); - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - // - // Return error if the SNP is not initialized. - // - switch (Snp->Mode.State) { - case EfiSimpleNetworkInitialized: - break; - - case EfiSimpleNetworkStopped: - Status = EFI_NOT_STARTED; - goto ON_EXIT; - - default: - Status = EFI_DEVICE_ERROR; - goto ON_EXIT; - } - // - // Return error if non-volatile memory variables are not valid. - // - if (Snp->Mode.NvRamSize == 0 || Snp->Mode.NvRamAccessSize == 0) { - Status = EFI_UNSUPPORTED; - goto ON_EXIT; - } - // - // Check for invalid parameter combinations. - // - if ((BufferSize == 0) || - (Buffer == NULL) || - (Offset >= Snp->Mode.NvRamSize) || - (Offset + BufferSize > Snp->Mode.NvRamSize) || - (BufferSize % Snp->Mode.NvRamAccessSize != 0) || - (Offset % Snp->Mode.NvRamAccessSize != 0) - ) { - Status = EFI_INVALID_PARAMETER; - goto ON_EXIT; - } - // - // check the implementation flags of undi if we can write the nvdata! - // - if (!ReadWrite) { - Status = EFI_UNSUPPORTED; - } else { - Status = PxeNvDataRead (Snp, Offset, BufferSize, Buffer); - } - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - - return Status; -} diff --git a/MdeModulePkg/Universal/Network/SnpDxe/Receive.c b/MdeModulePkg/Universal/Network/SnpDxe/Receive.c deleted file mode 100644 index 28cea0d2e9..0000000000 --- a/MdeModulePkg/Universal/Network/SnpDxe/Receive.c +++ /dev/null @@ -1,251 +0,0 @@ -/** @file - Implementation of receiving a packet from a network interface. - -Copyright (c) 2004 - 2010, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - - -#include "Snp.h" - -/** - Call UNDI to receive a packet and fills in the data in the input pointers. - - @param Snp Pointer to snp driver structure - @param Buffer Pointer to the memory for the received data - @param BufferSize Pointer to the length of the buffer on entry and contains - the length of the received data on return - @param HeaderSize Pointer to the header portion of the data received. - @param SrcAddr Pointer to contain the source ethernet address on return - @param DestAddr Pointer to contain the destination ethernet address on - return - @param Protocol Pointer to contain the protocol type from the ethernet - header on return - - - @retval EFI_SUCCESS The received data was stored in Buffer, and - BufferSize has been updated to the number of - bytes received. - @retval EFI_DEVICE_ERROR Fail to execute UNDI command. - @retval EFI_NOT_READY No packets have been received on the network - interface. - @retval EFI_BUFFER_TOO_SMALL BufferSize is too small for the received - packets. BufferSize has been updated to the - required size. - -**/ -EFI_STATUS -PxeReceive ( - SNP_DRIVER *Snp, - VOID *Buffer, - UINTN *BufferSize, - UINTN *HeaderSize, - EFI_MAC_ADDRESS *SrcAddr, - EFI_MAC_ADDRESS *DestAddr, - UINT16 *Protocol - ) -{ - PXE_CPB_RECEIVE *Cpb; - PXE_DB_RECEIVE *Db; - UINTN BuffSize; - - Cpb = Snp->Cpb; - Db = Snp->Db; - BuffSize = *BufferSize; - - Cpb->BufferAddr = (UINT64)(UINTN) Buffer; - Cpb->BufferLen = (UINT32) *BufferSize; - - Cpb->reserved = 0; - - Snp->Cdb.OpCode = PXE_OPCODE_RECEIVE; - Snp->Cdb.OpFlags = PXE_OPFLAGS_NOT_USED; - - Snp->Cdb.CPBsize = (UINT16) sizeof (PXE_CPB_RECEIVE); - Snp->Cdb.CPBaddr = (UINT64)(UINTN) Cpb; - - Snp->Cdb.DBsize = (UINT16) sizeof (PXE_DB_RECEIVE); - Snp->Cdb.DBaddr = (UINT64)(UINTN) Db; - - Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; - Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; - Snp->Cdb.IFnum = Snp->IfNum; - Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; - - // - // Issue UNDI command and check result. - // - DEBUG ((EFI_D_NET, "\nsnp->undi.receive () ")); - - (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); - - switch (Snp->Cdb.StatCode) { - case PXE_STATCODE_SUCCESS: - break; - - case PXE_STATCODE_NO_DATA: - DEBUG ( - (EFI_D_NET, - "\nsnp->undi.receive () %xh:%xh\n", - Snp->Cdb.StatFlags, - Snp->Cdb.StatCode) - ); - - return EFI_NOT_READY; - - default: - DEBUG ( - (EFI_D_ERROR, - "\nsnp->undi.receive() %xh:%xh\n", - Snp->Cdb.StatFlags, - Snp->Cdb.StatCode) - ); - - return EFI_DEVICE_ERROR; - } - - *BufferSize = Db->FrameLen; - - if (HeaderSize != NULL) { - *HeaderSize = Db->MediaHeaderLen; - } - - if (SrcAddr != NULL) { - CopyMem (SrcAddr, &Db->SrcAddr, Snp->Mode.HwAddressSize); - } - - if (DestAddr != NULL) { - CopyMem (DestAddr, &Db->DestAddr, Snp->Mode.HwAddressSize); - } - - if (Protocol != NULL) { - // - // We need to do the byte swapping - // - *Protocol = (UINT16) PXE_SWAP_UINT16 (Db->Protocol); - } - - // - // We have received a packet from network interface, which implies that the - // network cable should be present. While, some UNDI driver may not report - // correct media status during Snp->Initialize(). So, we need ensure - // MediaPresent in SNP mode data is set to correct value. - // - if (Snp->Mode.MediaPresentSupported && !Snp->Mode.MediaPresent) { - Snp->Mode.MediaPresent = TRUE; - } - - return (*BufferSize <= BuffSize) ? EFI_SUCCESS : EFI_BUFFER_TOO_SMALL; -} - -/** - Receives a packet from a network interface. - - This function retrieves one packet from the receive queue of a network interface. - If there are no packets on the receive queue, then EFI_NOT_READY will be - returned. If there is a packet on the receive queue, and the size of the packet - is smaller than BufferSize, then the contents of the packet will be placed in - Buffer, and BufferSize will be updated with the actual size of the packet. - In addition, if SrcAddr, DestAddr, and Protocol are not NULL, then these values - will be extracted from the media header and returned. EFI_SUCCESS will be - returned if a packet was successfully received. - If BufferSize is smaller than the received packet, then the size of the receive - packet will be placed in BufferSize and EFI_BUFFER_TOO_SMALL will be returned. - If the driver has not been initialized, EFI_DEVICE_ERROR will be returned. - - @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. - @param HeaderSize The size, in bytes, of the media header received on the network - interface. If this parameter is NULL, then the media header size - will not be returned. - @param BufferSize On entry, the size, in bytes, of Buffer. On exit, the size, in - bytes, of the packet that was received on the network interface. - @param Buffer A pointer to the data buffer to receive both the media - header and the data. - @param SrcAddr The source HW MAC address. If this parameter is NULL, the HW - MAC source address will not be extracted from the media header. - @param DestAddr The destination HW MAC address. If this parameter is NULL, - the HW MAC destination address will not be extracted from - the media header. - @param Protocol The media header type. If this parameter is NULL, then the - protocol will not be extracted from the media header. See - RFC 1700 section "Ether Types" for examples. - - @retval EFI_SUCCESS The received data was stored in Buffer, and - BufferSize has been updated to the number of - bytes received. - @retval EFI_NOT_STARTED The network interface has not been started. - @retval EFI_NOT_READY No packets have been received on the network interface. - @retval EFI_BUFFER_TOO_SMALL BufferSize is too small for the received packets. - BufferSize has been updated to the required size. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - * The This parameter is NULL - * The This parameter does not point to a valid - EFI_SIMPLE_NETWORK_PROTOCOL structure. - * The BufferSize parameter is NULL - * The Buffer parameter is NULL - @retval EFI_DEVICE_ERROR The command could not be sent to the network interface. - -**/ -EFI_STATUS -EFIAPI -SnpUndi32Receive ( - IN EFI_SIMPLE_NETWORK_PROTOCOL *This, - OUT UINTN *HeaderSize OPTIONAL, - IN OUT UINTN *BufferSize, - OUT VOID *Buffer, - OUT EFI_MAC_ADDRESS *SrcAddr OPTIONAL, - OUT EFI_MAC_ADDRESS *DestAddr OPTIONAL, - OUT UINT16 *Protocol OPTIONAL - ) -{ - SNP_DRIVER *Snp; - EFI_TPL OldTpl; - EFI_STATUS Status; - - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This); - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - switch (Snp->Mode.State) { - case EfiSimpleNetworkInitialized: - break; - - case EfiSimpleNetworkStopped: - Status = EFI_NOT_STARTED; - goto ON_EXIT; - - default: - Status = EFI_DEVICE_ERROR; - goto ON_EXIT; - } - - if ((BufferSize == NULL) || (Buffer == NULL)) { - Status = EFI_INVALID_PARAMETER; - goto ON_EXIT; - } - - if (Snp->Mode.ReceiveFilterSetting == 0) { - Status = EFI_DEVICE_ERROR; - goto ON_EXIT; - } - - Status = PxeReceive ( - Snp, - Buffer, - BufferSize, - HeaderSize, - SrcAddr, - DestAddr, - Protocol - ); - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - - return Status; -} diff --git a/MdeModulePkg/Universal/Network/SnpDxe/Receive_filters.c b/MdeModulePkg/Universal/Network/SnpDxe/Receive_filters.c deleted file mode 100644 index 494d2709b6..0000000000 --- a/MdeModulePkg/Universal/Network/SnpDxe/Receive_filters.c +++ /dev/null @@ -1,478 +0,0 @@ -/** @file - Implementation of managing the multicast receive filters of a network - interface. - -Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - - - -#include "Snp.h" - -/** - Call undi to enable the receive filters. - - @param Snp Pointer to snp driver structure. - @param EnableFlags Bit mask for enabling the receive filters. - @param MCastAddressCount Multicast address count for a new multicast address - list. - @param MCastAddressList List of new multicast addresses. - - @retval EFI_SUCCESS The multicast receive filter list was updated. - @retval EFI_INVALID_PARAMETER Invalid UNDI command. - @retval EFI_UNSUPPORTED Command is not supported by UNDI. - @retval EFI_DEVICE_ERROR Fail to execute UNDI command. - -**/ -EFI_STATUS -PxeRecvFilterEnable ( - SNP_DRIVER *Snp, - UINT32 EnableFlags, - UINTN MCastAddressCount, - EFI_MAC_ADDRESS *MCastAddressList - ) -{ - Snp->Cdb.OpCode = PXE_OPCODE_RECEIVE_FILTERS; - Snp->Cdb.OpFlags = PXE_OPFLAGS_RECEIVE_FILTER_ENABLE; - Snp->Cdb.CPBsize = PXE_CPBSIZE_NOT_USED; - Snp->Cdb.DBsize = PXE_DBSIZE_NOT_USED; - Snp->Cdb.CPBaddr = PXE_CPBADDR_NOT_USED; - Snp->Cdb.DBaddr = PXE_DBADDR_NOT_USED; - Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; - Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; - Snp->Cdb.IFnum = Snp->IfNum; - Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; - - if ((EnableFlags & EFI_SIMPLE_NETWORK_RECEIVE_UNICAST) != 0) { - Snp->Cdb.OpFlags |= PXE_OPFLAGS_RECEIVE_FILTER_UNICAST; - } - - if ((EnableFlags & EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST) != 0) { - Snp->Cdb.OpFlags |= PXE_OPFLAGS_RECEIVE_FILTER_BROADCAST; - } - - if ((EnableFlags & EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS) != 0) { - Snp->Cdb.OpFlags |= PXE_OPFLAGS_RECEIVE_FILTER_PROMISCUOUS; - } - - if ((EnableFlags & EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST) != 0) { - Snp->Cdb.OpFlags |= PXE_OPFLAGS_RECEIVE_FILTER_ALL_MULTICAST; - } - - if ((EnableFlags & EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST) != 0) { - Snp->Cdb.OpFlags |= PXE_OPFLAGS_RECEIVE_FILTER_FILTERED_MULTICAST; - } - - if (MCastAddressCount != 0) { - Snp->Cdb.CPBsize = (UINT16) (MCastAddressCount * sizeof (EFI_MAC_ADDRESS)); - Snp->Cdb.CPBaddr = (UINT64)(UINTN)Snp->Cpb; - CopyMem (Snp->Cpb, MCastAddressList, Snp->Cdb.CPBsize); - } - // - // Issue UNDI command and check result. - // - DEBUG ((EFI_D_NET, "\nsnp->undi.receive_filters() ")); - - (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); - - if (Snp->Cdb.StatCode != PXE_STATCODE_SUCCESS) { - // - // UNDI command failed. Return UNDI status to caller. - // - DEBUG ( - (EFI_D_ERROR, - "\nsnp->undi.receive_filters() %xh:%xh\n", - Snp->Cdb.StatFlags, - Snp->Cdb.StatCode) - ); - - switch (Snp->Cdb.StatCode) { - case PXE_STATCODE_INVALID_CDB: - case PXE_STATCODE_INVALID_CPB: - case PXE_STATCODE_INVALID_PARAMETER: - return EFI_INVALID_PARAMETER; - - case PXE_STATCODE_UNSUPPORTED: - return EFI_UNSUPPORTED; - } - - return EFI_DEVICE_ERROR; - } - - return EFI_SUCCESS; -} - -/** - Call undi to disable the receive filters. - - @param Snp Pointer to snp driver structure - @param DisableFlags Bit mask for disabling the receive filters - @param ResetMCastList Boolean flag to reset/delete the multicast filter - list. - - @retval EFI_SUCCESS The multicast receive filter list was updated. - @retval EFI_DEVICE_ERROR Fail to execute UNDI command. - -**/ -EFI_STATUS -PxeRecvFilterDisable ( - SNP_DRIVER *Snp, - UINT32 DisableFlags, - BOOLEAN ResetMCastList - ) -{ - Snp->Cdb.OpCode = PXE_OPCODE_RECEIVE_FILTERS; - Snp->Cdb.CPBsize = PXE_CPBSIZE_NOT_USED; - Snp->Cdb.DBsize = PXE_DBSIZE_NOT_USED; - Snp->Cdb.CPBaddr = PXE_CPBADDR_NOT_USED; - Snp->Cdb.DBaddr = PXE_DBADDR_NOT_USED; - Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; - Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; - Snp->Cdb.IFnum = Snp->IfNum; - Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; - - Snp->Cdb.OpFlags = (UINT16) ((DisableFlags != 0) ? PXE_OPFLAGS_RECEIVE_FILTER_DISABLE : PXE_OPFLAGS_NOT_USED); - - if (ResetMCastList) { - Snp->Cdb.OpFlags |= PXE_OPFLAGS_RECEIVE_FILTER_RESET_MCAST_LIST; - } - - if ((DisableFlags & EFI_SIMPLE_NETWORK_RECEIVE_UNICAST) != 0) { - Snp->Cdb.OpFlags |= PXE_OPFLAGS_RECEIVE_FILTER_UNICAST; - } - - if ((DisableFlags & EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST) != 0) { - Snp->Cdb.OpFlags |= PXE_OPFLAGS_RECEIVE_FILTER_BROADCAST; - } - - if ((DisableFlags & EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS) != 0) { - Snp->Cdb.OpFlags |= PXE_OPFLAGS_RECEIVE_FILTER_PROMISCUOUS; - } - - if ((DisableFlags & EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST) != 0) { - Snp->Cdb.OpFlags |= PXE_OPFLAGS_RECEIVE_FILTER_ALL_MULTICAST; - } - - if ((DisableFlags & EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST) != 0) { - Snp->Cdb.OpFlags |= PXE_OPFLAGS_RECEIVE_FILTER_FILTERED_MULTICAST; - } - // - // Issue UNDI command and check result. - // - DEBUG ((EFI_D_NET, "\nsnp->undi.receive_filters() ")); - - (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); - - if (Snp->Cdb.StatCode != PXE_STATCODE_SUCCESS) { - // - // UNDI command failed. Return UNDI status to caller. - // - DEBUG ( - (EFI_D_ERROR, - "\nsnp->undi.receive_filters() %xh:%xh\n", - Snp->Cdb.StatFlags, - Snp->Cdb.StatCode) - ); - - return EFI_DEVICE_ERROR; - } - - return EFI_SUCCESS; -} - -/** - Call undi to read the receive filters. - - @param Snp Pointer to snp driver structure. - - @retval EFI_SUCCESS The receive filter was read. - @retval EFI_DEVICE_ERROR Fail to execute UNDI command. - -**/ -EFI_STATUS -PxeRecvFilterRead ( - SNP_DRIVER *Snp - ) -{ - Snp->Cdb.OpCode = PXE_OPCODE_RECEIVE_FILTERS; - Snp->Cdb.OpFlags = PXE_OPFLAGS_RECEIVE_FILTER_READ; - Snp->Cdb.CPBsize = PXE_CPBSIZE_NOT_USED; - Snp->Cdb.DBsize = (UINT16) (Snp->Mode.MaxMCastFilterCount * sizeof (EFI_MAC_ADDRESS)); - Snp->Cdb.CPBaddr = PXE_CPBADDR_NOT_USED; - if (Snp->Cdb.DBsize == 0) { - Snp->Cdb.DBaddr = (UINT64)(UINTN) NULL; - } else { - Snp->Cdb.DBaddr = (UINT64)(UINTN) Snp->Db; - ZeroMem (Snp->Db, Snp->Cdb.DBsize); - } - - Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; - Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; - Snp->Cdb.IFnum = Snp->IfNum; - Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; - - DEBUG ((EFI_D_NET, "\nsnp->undi.receive_filters() ")); - - (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); - - if (Snp->Cdb.StatCode != PXE_STATCODE_SUCCESS) { - // - // UNDI command failed. Return UNDI status to caller. - // - DEBUG ( - (EFI_D_ERROR, - "\nsnp->undi.receive_filters() %xh:%xh\n", - Snp->Cdb.StatFlags, - Snp->Cdb.StatCode) - ); - - return EFI_DEVICE_ERROR; - } - // - // Convert UNDI32 StatFlags to EFI SNP filter flags. - // - Snp->Mode.ReceiveFilterSetting = 0; - - if ((Snp->Cdb.StatFlags & PXE_STATFLAGS_RECEIVE_FILTER_UNICAST) != 0) { - Snp->Mode.ReceiveFilterSetting |= EFI_SIMPLE_NETWORK_RECEIVE_UNICAST; - } - - if ((Snp->Cdb.StatFlags & PXE_STATFLAGS_RECEIVE_FILTER_BROADCAST) != 0) { - Snp->Mode.ReceiveFilterSetting |= EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST; - } - - if ((Snp->Cdb.StatFlags & PXE_STATFLAGS_RECEIVE_FILTER_PROMISCUOUS) != 0) { - Snp->Mode.ReceiveFilterSetting |= EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS; - } - - if ((Snp->Cdb.StatFlags & PXE_STATFLAGS_RECEIVE_FILTER_ALL_MULTICAST) != 0) { - Snp->Mode.ReceiveFilterSetting |= EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST; - } - - if ((Snp->Cdb.StatFlags & PXE_STATFLAGS_RECEIVE_FILTER_FILTERED_MULTICAST) != 0) { - Snp->Mode.ReceiveFilterSetting |= EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST; - } - - CopyMem (Snp->Mode.MCastFilter, Snp->Db, Snp->Cdb.DBsize); - - // - // Count number of active entries in multicast filter list. - // - { - EFI_MAC_ADDRESS ZeroMacAddr; - - SetMem (&ZeroMacAddr, sizeof ZeroMacAddr, 0); - - for (Snp->Mode.MCastFilterCount = 0; - Snp->Mode.MCastFilterCount < Snp->Mode.MaxMCastFilterCount; - Snp->Mode.MCastFilterCount++ - ) { - if (CompareMem ( - &Snp->Mode.MCastFilter[Snp->Mode.MCastFilterCount], - &ZeroMacAddr, - sizeof ZeroMacAddr - ) == 0) { - break; - } - } - } - - return EFI_SUCCESS; -} - - -/** - Manages the multicast receive filters of a network interface. - - This function is used enable and disable the hardware and software receive - filters for the underlying network device. - The receive filter change is broken down into three steps: - * The filter mask bits that are set (ON) in the Enable parameter are added to - the current receive filter settings. - * The filter mask bits that are set (ON) in the Disable parameter are subtracted - from the updated receive filter settings. - * If the resulting receive filter setting is not supported by the hardware a - more liberal setting is selected. - If the same bits are set in the Enable and Disable parameters, then the bits - in the Disable parameter takes precedence. - If the ResetMCastFilter parameter is TRUE, then the multicast address list - filter is disabled (irregardless of what other multicast bits are set in the - Enable and Disable parameters). The SNP->Mode->MCastFilterCount field is set - to zero. The Snp->Mode->MCastFilter contents are undefined. - After enabling or disabling receive filter settings, software should verify - the new settings by checking the Snp->Mode->ReceiveFilterSettings, - Snp->Mode->MCastFilterCount and Snp->Mode->MCastFilter fields. - Note: Some network drivers and/or devices will automatically promote receive - filter settings if the requested setting can not be honored. For example, if - a request for four multicast addresses is made and the underlying hardware - only supports two multicast addresses the driver might set the promiscuous - or promiscuous multicast receive filters instead. The receiving software is - responsible for discarding any extra packets that get through the hardware - receive filters. - Note: Note: To disable all receive filter hardware, the network driver must - be Shutdown() and Stopped(). Calling ReceiveFilters() with Disable set to - Snp->Mode->ReceiveFilterSettings will make it so no more packets are - returned by the Receive() function, but the receive hardware may still be - moving packets into system memory before inspecting and discarding them. - Unexpected system errors, reboots and hangs can occur if an OS is loaded - and the network devices are not Shutdown() and Stopped(). - If ResetMCastFilter is TRUE, then the multicast receive filter list on the - network interface will be reset to the default multicast receive filter list. - If ResetMCastFilter is FALSE, and this network interface allows the multicast - receive filter list to be modified, then the MCastFilterCnt and MCastFilter - are used to update the current multicast receive filter list. The modified - receive filter list settings can be found in the MCastFilter field of - EFI_SIMPLE_NETWORK_MODE. If the network interface does not allow the multicast - receive filter list to be modified, then EFI_INVALID_PARAMETER will be returned. - If the driver has not been initialized, EFI_DEVICE_ERROR will be returned. - If the receive filter mask and multicast receive filter list have been - successfully updated on the network interface, EFI_SUCCESS will be returned. - - @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. - @param Enable A bit mask of receive filters to enable on the network - interface. - @param Disable A bit mask of receive filters to disable on the network - interface. For backward compatibility with EFI 1.1 - platforms, the EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST bit - must be set when the ResetMCastFilter parameter is TRUE. - @param ResetMCastFilter Set to TRUE to reset the contents of the multicast - receive filters on the network interface to their - default values. - @param MCastFilterCnt Number of multicast HW MAC addresses in the new MCastFilter - list. This value must be less than or equal to the - MCastFilterCnt field of EFI_SIMPLE_NETWORK_MODE. - This field is optional if ResetMCastFilter is TRUE. - @param MCastFilter A pointer to a list of new multicast receive filter HW - MAC addresses. This list will replace any existing - multicast HW MAC address list. This field is optional - if ResetMCastFilter is TRUE. - - @retval EFI_SUCCESS The multicast receive filter list was updated. - @retval EFI_NOT_STARTED The network interface has not been started. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - * This is NULL - * There are bits set in Enable that are not set - in Snp->Mode->ReceiveFilterMask - * There are bits set in Disable that are not set - in Snp->Mode->ReceiveFilterMask - * Multicast is being enabled (the - EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST bit is - set in Enable, it is not set in Disable, and - ResetMCastFilter is FALSE) and MCastFilterCount - is zero - * Multicast is being enabled and MCastFilterCount - is greater than Snp->Mode->MaxMCastFilterCount - * Multicast is being enabled and MCastFilter is NULL - * Multicast is being enabled and one or more of - the addresses in the MCastFilter list are not - valid multicast MAC addresses - @retval EFI_DEVICE_ERROR One or more of the following conditions is TRUE: - * The network interface has been started but has - not been initialized - * An unexpected error was returned by the - underlying network driver or device - @retval EFI_UNSUPPORTED This function is not supported by the network - interface. - -**/ -EFI_STATUS -EFIAPI -SnpUndi32ReceiveFilters ( - IN EFI_SIMPLE_NETWORK_PROTOCOL *This, - IN UINT32 Enable, - IN UINT32 Disable, - IN BOOLEAN ResetMCastFilter, - IN UINTN MCastFilterCnt, OPTIONAL - IN EFI_MAC_ADDRESS *MCastFilter OPTIONAL - ) -{ - SNP_DRIVER *Snp; - EFI_STATUS Status; - EFI_TPL OldTpl; - - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This); - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - switch (Snp->Mode.State) { - case EfiSimpleNetworkInitialized: - break; - - case EfiSimpleNetworkStopped: - Status = EFI_NOT_STARTED; - goto ON_EXIT; - - default: - Status = EFI_DEVICE_ERROR; - goto ON_EXIT; - } - // - // check if we are asked to enable or disable something that the UNDI - // does not even support! - // - if (((Enable &~Snp->Mode.ReceiveFilterMask) != 0) || - ((Disable &~Snp->Mode.ReceiveFilterMask) != 0)) { - Status = EFI_INVALID_PARAMETER; - goto ON_EXIT; - } - - if (ResetMCastFilter) { - - Disable |= EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST & Snp->Mode.ReceiveFilterMask; - MCastFilterCnt = 0; - MCastFilter = NULL; - } else { - if (MCastFilterCnt != 0) { - if ((MCastFilterCnt > Snp->Mode.MaxMCastFilterCount) || - (MCastFilter == NULL)) { - - Status = EFI_INVALID_PARAMETER; - goto ON_EXIT; - } - } - } - - if (Enable == 0 && Disable == 0 && !ResetMCastFilter && MCastFilterCnt == 0) { - Status = EFI_SUCCESS; - goto ON_EXIT; - } - - if ((Enable & EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST) != 0 && MCastFilterCnt == 0) { - Status = EFI_INVALID_PARAMETER; - goto ON_EXIT; - } - - if ((Enable != 0) || (MCastFilterCnt != 0)) { - Status = PxeRecvFilterEnable ( - Snp, - Enable, - MCastFilterCnt, - MCastFilter - ); - - if (EFI_ERROR (Status)) { - goto ON_EXIT; - } - } - - if ((Disable != 0) || ResetMCastFilter) { - Status = PxeRecvFilterDisable (Snp, Disable, ResetMCastFilter); - - if (EFI_ERROR (Status)) { - goto ON_EXIT; - } - } - - Status = PxeRecvFilterRead (Snp); - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - - return Status; -} diff --git a/MdeModulePkg/Universal/Network/SnpDxe/Reset.c b/MdeModulePkg/Universal/Network/SnpDxe/Reset.c deleted file mode 100644 index 3069bfde66..0000000000 --- a/MdeModulePkg/Universal/Network/SnpDxe/Reset.c +++ /dev/null @@ -1,130 +0,0 @@ -/** @file - Implementation of resetting a network adapter. - -Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Snp.h" - - -/** - Call UNDI to reset the NIC. - - @param Snp Pointer to the snp driver structure. - - @return EFI_SUCCESSFUL The NIC was reset. - @retval EFI_DEVICE_ERROR The NIC cannot be reset. - -**/ -EFI_STATUS -PxeReset ( - SNP_DRIVER *Snp - ) -{ - Snp->Cdb.OpCode = PXE_OPCODE_RESET; - Snp->Cdb.OpFlags = PXE_OPFLAGS_NOT_USED; - Snp->Cdb.CPBsize = PXE_CPBSIZE_NOT_USED; - Snp->Cdb.DBsize = PXE_DBSIZE_NOT_USED; - Snp->Cdb.CPBaddr = PXE_CPBADDR_NOT_USED; - Snp->Cdb.DBaddr = PXE_DBADDR_NOT_USED; - Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; - Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; - Snp->Cdb.IFnum = Snp->IfNum; - Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; - - // - // Issue UNDI command and check result. - // - DEBUG ((EFI_D_NET, "\nsnp->undi.reset() ")); - - (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); - - if (Snp->Cdb.StatCode != PXE_STATCODE_SUCCESS) { - DEBUG ( - (EFI_D_WARN, - "\nsnp->undi32.reset() %xh:%xh\n", - Snp->Cdb.StatFlags, - Snp->Cdb.StatCode) - ); - - // - // UNDI could not be reset. Return UNDI error. - // - return EFI_DEVICE_ERROR; - } - - return EFI_SUCCESS; -} - - -/** - Resets a network adapter and reinitializes it with the parameters that were - provided in the previous call to Initialize(). - - This function resets a network adapter and reinitializes it with the parameters - that were provided in the previous call to Initialize(). The transmit and - receive queues are emptied and all pending interrupts are cleared. - Receive filters, the station address, the statistics, and the multicast-IP-to-HW - MAC addresses are not reset by this call. If the network interface was - successfully reset, then EFI_SUCCESS will be returned. If the driver has not - been initialized, EFI_DEVICE_ERROR will be returned. - - @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. - @param ExtendedVerification Indicates that the driver may perform a more - exhaustive verification operation of the device - during reset. - - @retval EFI_SUCCESS The network interface was reset. - @retval EFI_NOT_STARTED The network interface has not been started. - @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value. - @retval EFI_DEVICE_ERROR The command could not be sent to the network interface. - @retval EFI_UNSUPPORTED This function is not supported by the network interface. - -**/ -EFI_STATUS -EFIAPI -SnpUndi32Reset ( - IN EFI_SIMPLE_NETWORK_PROTOCOL *This, - IN BOOLEAN ExtendedVerification - ) -{ - SNP_DRIVER *Snp; - EFI_TPL OldTpl; - EFI_STATUS Status; - - // - // Resolve Warning 4 unreferenced parameter problem - // - ExtendedVerification = 0; - DEBUG ((EFI_D_WARN, "ExtendedVerification = %d is not implemented!\n", ExtendedVerification)); - - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This); - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - switch (Snp->Mode.State) { - case EfiSimpleNetworkInitialized: - break; - - case EfiSimpleNetworkStopped: - Status = EFI_NOT_STARTED; - goto ON_EXIT; - - default: - Status = EFI_DEVICE_ERROR; - goto ON_EXIT; - } - - Status = PxeReset (Snp); - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - - return Status; -} diff --git a/MdeModulePkg/Universal/Network/SnpDxe/Shutdown.c b/MdeModulePkg/Universal/Network/SnpDxe/Shutdown.c deleted file mode 100644 index aad0fe8493..0000000000 --- a/MdeModulePkg/Universal/Network/SnpDxe/Shutdown.c +++ /dev/null @@ -1,146 +0,0 @@ -/** @file - Implementation of shuting down a network adapter. - -Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Snp.h" - - -/** - Call UNDI to shut down the interface. - - @param Snp Pointer to snp driver structure. - - @retval EFI_SUCCESS UNDI is shut down successfully. - @retval EFI_DEVICE_ERROR UNDI could not be shut down. - -**/ -EFI_STATUS -PxeShutdown ( - IN SNP_DRIVER *Snp - ) -{ - Snp->Cdb.OpCode = PXE_OPCODE_SHUTDOWN; - Snp->Cdb.OpFlags = PXE_OPFLAGS_NOT_USED; - Snp->Cdb.CPBsize = PXE_CPBSIZE_NOT_USED; - Snp->Cdb.DBsize = PXE_DBSIZE_NOT_USED; - Snp->Cdb.CPBaddr = PXE_CPBADDR_NOT_USED; - Snp->Cdb.DBaddr = PXE_DBADDR_NOT_USED; - Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; - Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; - Snp->Cdb.IFnum = Snp->IfNum; - Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; - - // - // Issue UNDI command and check result. - // - DEBUG ((EFI_D_NET, "\nsnp->undi.shutdown() ")); - - (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); - - if (Snp->Cdb.StatCode != PXE_STATCODE_SUCCESS) { - // - // UNDI could not be shutdown. Return UNDI error. - // - DEBUG ((EFI_D_WARN, "\nsnp->undi.shutdown() %xh:%xh\n", Snp->Cdb.StatFlags, Snp->Cdb.StatCode)); - - return EFI_DEVICE_ERROR; - } - // - // Free allocated memory. - // - if (Snp->TxRxBuffer != NULL) { - Snp->PciIo->FreeBuffer ( - Snp->PciIo, - SNP_MEM_PAGES (Snp->TxRxBufferSize), - (VOID *) Snp->TxRxBuffer - ); - } - - Snp->TxRxBuffer = NULL; - Snp->TxRxBufferSize = 0; - - return EFI_SUCCESS; -} - - -/** - Resets a network adapter and leaves it in a state that is safe for another - driver to initialize. - - This function releases the memory buffers assigned in the Initialize() call. - Pending transmits and receives are lost, and interrupts are cleared and disabled. - After this call, only the Initialize() and Stop() calls may be used. If the - network interface was successfully shutdown, then EFI_SUCCESS will be returned. - If the driver has not been initialized, EFI_DEVICE_ERROR will be returned. - - @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. - - @retval EFI_SUCCESS The network interface was shutdown. - @retval EFI_NOT_STARTED The network interface has not been started. - @retval EFI_INVALID_PARAMETER This parameter was NULL or did not point to a valid - EFI_SIMPLE_NETWORK_PROTOCOL structure. - @retval EFI_DEVICE_ERROR The command could not be sent to the network interface. - -**/ -EFI_STATUS -EFIAPI -SnpUndi32Shutdown ( - IN EFI_SIMPLE_NETWORK_PROTOCOL *This - ) -{ - SNP_DRIVER *Snp; - EFI_STATUS Status; - EFI_TPL OldTpl; - - // - // Get pointer to SNP driver instance for *This. - // - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This); - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - // - // Return error if the SNP is not initialized. - // - switch (Snp->Mode.State) { - case EfiSimpleNetworkInitialized: - break; - - case EfiSimpleNetworkStopped: - Status = EFI_NOT_STARTED; - goto ON_EXIT; - - default: - Status = EFI_DEVICE_ERROR; - goto ON_EXIT; - } - - Status = PxeShutdown (Snp); - - Snp->Mode.State = EfiSimpleNetworkStarted; - Snp->Mode.ReceiveFilterSetting = 0; - - Snp->Mode.MCastFilterCount = 0; - Snp->Mode.ReceiveFilterSetting = 0; - ZeroMem (Snp->Mode.MCastFilter, sizeof Snp->Mode.MCastFilter); - CopyMem ( - &Snp->Mode.CurrentAddress, - &Snp->Mode.PermanentAddress, - sizeof (EFI_MAC_ADDRESS) - ); - - gBS->CloseEvent (Snp->Snp.WaitForPacket); - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - - return Status; -} diff --git a/MdeModulePkg/Universal/Network/SnpDxe/Snp.c b/MdeModulePkg/Universal/Network/SnpDxe/Snp.c deleted file mode 100644 index a23af05078..0000000000 --- a/MdeModulePkg/Universal/Network/SnpDxe/Snp.c +++ /dev/null @@ -1,862 +0,0 @@ -/** @file - Implementation of driver entry point and driver binding protocol. - -Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Snp.h" - -/** - One notified function to stop UNDI device when gBS->ExitBootServices() called. - - @param Event Pointer to this event - @param Context Event handler private data - -**/ -VOID -EFIAPI -SnpNotifyExitBootServices ( - EFI_EVENT Event, - VOID *Context - ) -{ - SNP_DRIVER *Snp; - - Snp = (SNP_DRIVER *)Context; - - // - // Shutdown and stop UNDI driver - // - PxeShutdown (Snp); - PxeStop (Snp); -} - -/** - Send command to UNDI. It does nothing currently. - - @param Cdb command to be sent to UNDI. - - @retval EFI_INVALID_PARAMETER The command is 0. - @retval EFI_UNSUPPORTED Default return status because it's not - supported currently. - -**/ -EFI_STATUS -EFIAPI -IssueHwUndiCommand ( - UINT64 Cdb - ) -{ - DEBUG ((EFI_D_ERROR, "\nIssueHwUndiCommand() - This should not be called!")); - - if (Cdb == 0) { - return EFI_INVALID_PARAMETER; - - } - // - // %%TBD - For now, nothing is done. - // - return EFI_UNSUPPORTED; -} - - -/** - Compute 8-bit checksum of a buffer. - - @param Buffer Pointer to buffer. - @param Length Length of buffer in bytes. - - @return 8-bit checksum of all bytes in buffer, or zero if ptr is NULL or len - is zero. - -**/ -UINT8 -Calc8BitCksum ( - VOID *Buffer, - UINTN Length - ) -{ - UINT8 *Ptr; - UINT8 Cksum; - - Ptr = Buffer; - Cksum = 0; - - if (Ptr == NULL || Length == 0) { - return 0; - } - - while (Length-- != 0) { - Cksum = (UINT8) (Cksum + *Ptr++); - } - - return Cksum; -} - -/** - Test to see if this driver supports ControllerHandle. This service - is called by the EFI boot service ConnectController(). In - order to make drivers as small as possible, there are a few calling - restrictions for this service. ConnectController() must - follow these calling restrictions. If any other agent wishes to call - Supported() it must also follow these calling restrictions. - - @param This Protocol instance pointer. - @param ControllerHandle Handle of device to test. - @param RemainingDevicePath Optional parameter use to pick a specific child - device to start. - - @retval EFI_SUCCESS This driver supports this device. - @retval EFI_ALREADY_STARTED This driver is already running on this device. - @retval other This driver does not support this device. - -**/ -EFI_STATUS -EFIAPI -SimpleNetworkDriverSupported ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE Controller, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath - ) -{ - EFI_STATUS Status; - EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL *NiiProtocol; - PXE_UNDI *Pxe; - - Status = gBS->OpenProtocol ( - Controller, - &gEfiDevicePathProtocolGuid, - NULL, - This->DriverBindingHandle, - Controller, - EFI_OPEN_PROTOCOL_TEST_PROTOCOL - ); - if (EFI_ERROR (Status)) { - return Status; - } - - Status = gBS->OpenProtocol ( - Controller, - &gEfiNetworkInterfaceIdentifierProtocolGuid_31, - (VOID **) &NiiProtocol, - This->DriverBindingHandle, - Controller, - EFI_OPEN_PROTOCOL_BY_DRIVER - ); - - if (EFI_ERROR (Status)) { - if (Status == EFI_ALREADY_STARTED) { - DEBUG ((EFI_D_INFO, "Support(): Already Started. on handle %p\n", Controller)); - } - return Status; - } - - DEBUG ((EFI_D_INFO, "Support(): UNDI3.1 found on handle %p\n", Controller)); - - // - // check the version, we don't want to connect to the undi16 - // - if (NiiProtocol->Type != EfiNetworkInterfaceUndi) { - Status = EFI_UNSUPPORTED; - goto Done; - } - // - // Check to see if !PXE structure is valid. Paragraph alignment of !PXE structure is required. - // - if ((NiiProtocol->Id & 0x0F) != 0) { - DEBUG ((EFI_D_NET, "\n!PXE structure is not paragraph aligned.\n")); - Status = EFI_UNSUPPORTED; - goto Done; - } - - Pxe = (PXE_UNDI *) (UINTN) (NiiProtocol->Id); - - // - // Verify !PXE revisions. - // - if (Pxe->hw.Signature != PXE_ROMID_SIGNATURE) { - DEBUG ((EFI_D_NET, "\n!PXE signature is not valid.\n")); - Status = EFI_UNSUPPORTED; - goto Done; - } - - if (Pxe->hw.Rev < PXE_ROMID_REV) { - DEBUG ((EFI_D_NET, "\n!PXE.Rev is not supported.\n")); - Status = EFI_UNSUPPORTED; - goto Done; - } - - if (Pxe->hw.MajorVer < PXE_ROMID_MAJORVER) { - - DEBUG ((EFI_D_NET, "\n!PXE.MajorVer is not supported.\n")); - Status = EFI_UNSUPPORTED; - goto Done; - - } else if (Pxe->hw.MajorVer == PXE_ROMID_MAJORVER && Pxe->hw.MinorVer < PXE_ROMID_MINORVER) { - DEBUG ((EFI_D_NET, "\n!PXE.MinorVer is not supported.")); - Status = EFI_UNSUPPORTED; - goto Done; - } - // - // Do S/W UNDI specific checks. - // - if ((Pxe->hw.Implementation & PXE_ROMID_IMP_HW_UNDI) == 0) { - if (Pxe->sw.EntryPoint < Pxe->sw.Len) { - DEBUG ((EFI_D_NET, "\n!PXE S/W entry point is not valid.")); - Status = EFI_UNSUPPORTED; - goto Done; - } - - if (Pxe->sw.BusCnt == 0) { - DEBUG ((EFI_D_NET, "\n!PXE.BusCnt is zero.")); - Status = EFI_UNSUPPORTED; - goto Done; - } - } - - Status = EFI_SUCCESS; - DEBUG ((EFI_D_INFO, "Support(): supported on %p\n", Controller)); - -Done: - gBS->CloseProtocol ( - Controller, - &gEfiNetworkInterfaceIdentifierProtocolGuid_31, - This->DriverBindingHandle, - Controller - ); - - return Status; -} - -/** - Start this driver on ControllerHandle. This service is called by the - EFI boot service ConnectController(). In order to make - drivers as small as possible, there are a few calling restrictions for - this service. ConnectController() must follow these - calling restrictions. If any other agent wishes to call Start() it - must also follow these calling restrictions. - - @param This Protocol instance pointer. - @param ControllerHandle Handle of device to bind driver to. - @param RemainingDevicePath Optional parameter use to pick a specific child - device to start. - - @retval EFI_SUCCESS This driver is added to ControllerHandle - @retval EFI_DEVICE_ERROR This driver could not be started due to a device error - @retval other This driver does not support this device - -**/ -EFI_STATUS -EFIAPI -SimpleNetworkDriverStart ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE Controller, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath - ) -{ - EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL *Nii; - EFI_DEVICE_PATH_PROTOCOL *NiiDevicePath; - EFI_STATUS Status; - PXE_UNDI *Pxe; - SNP_DRIVER *Snp; - VOID *Address; - EFI_HANDLE Handle; - UINT8 BarIndex; - PXE_STATFLAGS InitStatFlags; - EFI_PCI_IO_PROTOCOL *PciIo; - EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *BarDesc; - BOOLEAN FoundIoBar; - BOOLEAN FoundMemoryBar; - - DEBUG ((EFI_D_NET, "\nSnpNotifyNetworkInterfaceIdentifier() ")); - - Status = gBS->OpenProtocol ( - Controller, - &gEfiDevicePathProtocolGuid, - (VOID **) &NiiDevicePath, - This->DriverBindingHandle, - Controller, - EFI_OPEN_PROTOCOL_BY_DRIVER - ); - - if (EFI_ERROR (Status)) { - return Status; - } - - Status = gBS->LocateDevicePath ( - &gEfiPciIoProtocolGuid, - &NiiDevicePath, - &Handle - ); - - if (EFI_ERROR (Status)) { - return Status; - } - - Status = gBS->OpenProtocol ( - Handle, - &gEfiPciIoProtocolGuid, - (VOID **) &PciIo, - This->DriverBindingHandle, - Controller, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - if (EFI_ERROR (Status)) { - return Status; - } - // - // Get the NII interface. - // - Status = gBS->OpenProtocol ( - Controller, - &gEfiNetworkInterfaceIdentifierProtocolGuid_31, - (VOID **) &Nii, - This->DriverBindingHandle, - Controller, - EFI_OPEN_PROTOCOL_BY_DRIVER - ); - if (EFI_ERROR (Status)) { - gBS->CloseProtocol ( - Controller, - &gEfiDevicePathProtocolGuid, - This->DriverBindingHandle, - Controller - ); - return Status; - } - - DEBUG ((EFI_D_INFO, "Start(): UNDI3.1 found\n")); - - Pxe = (PXE_UNDI *) (UINTN) (Nii->Id); - - if (Calc8BitCksum (Pxe, Pxe->hw.Len) != 0) { - DEBUG ((EFI_D_NET, "\n!PXE checksum is not correct.\n")); - goto NiiError; - } - - if ((Pxe->hw.Implementation & PXE_ROMID_IMP_PROMISCUOUS_RX_SUPPORTED) != 0) { - // - // We can get any packets. - // - } else if ((Pxe->hw.Implementation & PXE_ROMID_IMP_BROADCAST_RX_SUPPORTED) != 0) { - // - // We need to be able to get broadcast packets for DHCP. - // If we do not have promiscuous support, we must at least have - // broadcast support or we cannot do DHCP! - // - } else { - DEBUG ((EFI_D_NET, "\nUNDI does not have promiscuous or broadcast support.")); - goto NiiError; - } - // - // OK, we like this UNDI, and we know snp is not already there on this handle - // Allocate and initialize a new simple network protocol structure. - // - Status = PciIo->AllocateBuffer ( - PciIo, - AllocateAnyPages, - EfiBootServicesData, - SNP_MEM_PAGES (sizeof (SNP_DRIVER)), - &Address, - 0 - ); - - if (Status != EFI_SUCCESS) { - DEBUG ((EFI_D_NET, "\nCould not allocate SNP_DRIVER structure.\n")); - goto NiiError; - } - - Snp = (SNP_DRIVER *) (UINTN) Address; - - ZeroMem (Snp, sizeof (SNP_DRIVER)); - - Snp->PciIo = PciIo; - Snp->Signature = SNP_DRIVER_SIGNATURE; - - EfiInitializeLock (&Snp->Lock, TPL_NOTIFY); - - Snp->Snp.Revision = EFI_SIMPLE_NETWORK_PROTOCOL_REVISION; - Snp->Snp.Start = SnpUndi32Start; - Snp->Snp.Stop = SnpUndi32Stop; - Snp->Snp.Initialize = SnpUndi32Initialize; - Snp->Snp.Reset = SnpUndi32Reset; - Snp->Snp.Shutdown = SnpUndi32Shutdown; - Snp->Snp.ReceiveFilters = SnpUndi32ReceiveFilters; - Snp->Snp.StationAddress = SnpUndi32StationAddress; - Snp->Snp.Statistics = SnpUndi32Statistics; - Snp->Snp.MCastIpToMac = SnpUndi32McastIpToMac; - Snp->Snp.NvData = SnpUndi32NvData; - Snp->Snp.GetStatus = SnpUndi32GetStatus; - Snp->Snp.Transmit = SnpUndi32Transmit; - Snp->Snp.Receive = SnpUndi32Receive; - Snp->Snp.WaitForPacket = NULL; - - Snp->Snp.Mode = &Snp->Mode; - - Snp->TxRxBufferSize = 0; - Snp->TxRxBuffer = NULL; - - Snp->RecycledTxBuf = AllocatePool (sizeof (UINT64) * SNP_TX_BUFFER_INCREASEMENT); - if (Snp->RecycledTxBuf == NULL) { - Status = EFI_OUT_OF_RESOURCES; - goto Error_DeleteSNP; - } - Snp->MaxRecycledTxBuf = SNP_TX_BUFFER_INCREASEMENT; - Snp->RecycledTxBufCount = 0; - - if (Nii->Revision >= EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_REVISION) { - Snp->IfNum = Nii->IfNum; - - } else { - Snp->IfNum = (UINT8) (Nii->IfNum & 0xFF); - } - - if ((Pxe->hw.Implementation & PXE_ROMID_IMP_HW_UNDI) != 0) { - Snp->IsSwUndi = FALSE; - Snp->IssueUndi32Command = &IssueHwUndiCommand; - } else { - Snp->IsSwUndi = TRUE; - - if ((Pxe->sw.Implementation & PXE_ROMID_IMP_SW_VIRT_ADDR) != 0) { - Snp->IssueUndi32Command = (ISSUE_UNDI32_COMMAND) (UINTN) Pxe->sw.EntryPoint; - } else { - Snp->IssueUndi32Command = (ISSUE_UNDI32_COMMAND) (UINTN) ((UINT8) (UINTN) Pxe + Pxe->sw.EntryPoint); - } - } - // - // Allocate a global CPB and DB buffer for this UNDI interface. - // we do this because: - // - // -UNDI 3.0 wants all the addresses passed to it (even the cpb and db) to be - // within 2GB limit, create them here and map them so that when undi calls - // v2p callback to check if the physical address is < 2gb, we will pass. - // - // -This is not a requirement for 3.1 or later UNDIs but the code looks - // simpler if we use the same cpb, db variables for both old and new undi - // interfaces from all the SNP interface calls (we don't map the buffers - // for the newer undi interfaces though) - // . - // -it is OK to allocate one global set of CPB, DB pair for each UNDI - // interface as EFI does not multi-task and so SNP will not be re-entered! - // - Status = PciIo->AllocateBuffer ( - PciIo, - AllocateAnyPages, - EfiBootServicesData, - SNP_MEM_PAGES (4096), - &Address, - 0 - ); - - if (Status != EFI_SUCCESS) { - DEBUG ((EFI_D_NET, "\nCould not allocate CPB and DB structures.\n")); - goto Error_DeleteSNP; - } - - Snp->Cpb = (VOID *) (UINTN) Address; - Snp->Db = (VOID *) ((UINTN) Address + 2048); - - // - // Find the correct BAR to do IO. - // - // Enumerate through the PCI BARs for the device to determine which one is - // the IO BAR. Save the index of the BAR into the adapter info structure. - // for regular 32bit BARs, 0 is memory mapped, 1 is io mapped - // - Snp->MemoryBarIndex = 0; - Snp->IoBarIndex = 1; - FoundMemoryBar = FALSE; - FoundIoBar = FALSE; - for (BarIndex = 0; BarIndex < PCI_MAX_BAR; BarIndex++) { - Status = PciIo->GetBarAttributes ( - PciIo, - BarIndex, - NULL, - (VOID**) &BarDesc - ); - if (Status == EFI_UNSUPPORTED) { - continue; - } else if (EFI_ERROR (Status)) { - goto Error_DeleteSNP; - } - - if ((!FoundMemoryBar) && (BarDesc->ResType == ACPI_ADDRESS_SPACE_TYPE_MEM)) { - Snp->MemoryBarIndex = BarIndex; - FoundMemoryBar = TRUE; - } else if ((!FoundIoBar) && (BarDesc->ResType == ACPI_ADDRESS_SPACE_TYPE_IO)) { - Snp->IoBarIndex = BarIndex; - FoundIoBar = TRUE; - } - - FreePool (BarDesc); - - if (FoundMemoryBar && FoundIoBar) { - break; - } - } - - Status = PxeStart (Snp); - - if (Status != EFI_SUCCESS) { - goto Error_DeleteSNP; - } - - Snp->Cdb.OpCode = PXE_OPCODE_GET_INIT_INFO; - Snp->Cdb.OpFlags = PXE_OPFLAGS_NOT_USED; - - Snp->Cdb.CPBsize = PXE_CPBSIZE_NOT_USED; - Snp->Cdb.CPBaddr = PXE_DBADDR_NOT_USED; - - Snp->Cdb.DBsize = (UINT16) sizeof (Snp->InitInfo); - Snp->Cdb.DBaddr = (UINT64)(UINTN) (&Snp->InitInfo); - - Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; - Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; - - Snp->Cdb.IFnum = Snp->IfNum; - Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; - - DEBUG ((EFI_D_NET, "\nSnp->undi.get_init_info() ")); - - (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); - - // - // Save the INIT Stat Code... - // - InitStatFlags = Snp->Cdb.StatFlags; - - if (Snp->Cdb.StatCode != PXE_STATCODE_SUCCESS) { - DEBUG ((EFI_D_NET, "\nSnp->undi.init_info() %xh:%xh\n", Snp->Cdb.StatFlags, Snp->Cdb.StatCode)); - PxeStop (Snp); - goto Error_DeleteSNP; - } - - // - // Initialize simple network protocol mode structure - // - Snp->Mode.State = EfiSimpleNetworkStopped; - Snp->Mode.HwAddressSize = Snp->InitInfo.HWaddrLen; - Snp->Mode.MediaHeaderSize = Snp->InitInfo.MediaHeaderLen; - Snp->Mode.MaxPacketSize = Snp->InitInfo.FrameDataLen; - Snp->Mode.NvRamAccessSize = Snp->InitInfo.NvWidth; - Snp->Mode.NvRamSize = Snp->InitInfo.NvCount * Snp->Mode.NvRamAccessSize; - Snp->Mode.IfType = Snp->InitInfo.IFtype; - Snp->Mode.MaxMCastFilterCount = Snp->InitInfo.MCastFilterCnt; - Snp->Mode.MCastFilterCount = 0; - - switch (InitStatFlags & PXE_STATFLAGS_CABLE_DETECT_MASK) { - case PXE_STATFLAGS_CABLE_DETECT_SUPPORTED: - Snp->CableDetectSupported = TRUE; - break; - - case PXE_STATFLAGS_CABLE_DETECT_NOT_SUPPORTED: - default: - Snp->CableDetectSupported = FALSE; - } - - switch (InitStatFlags & PXE_STATFLAGS_GET_STATUS_NO_MEDIA_MASK) { - case PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED: - Snp->MediaStatusSupported = TRUE; - break; - - case PXE_STATFLAGS_GET_STATUS_NO_MEDIA_NOT_SUPPORTED: - default: - Snp->MediaStatusSupported = FALSE; - } - - if (Snp->CableDetectSupported || Snp->MediaStatusSupported) { - Snp->Mode.MediaPresentSupported = TRUE; - } - - if ((Pxe->hw.Implementation & PXE_ROMID_IMP_STATION_ADDR_SETTABLE) != 0) { - Snp->Mode.MacAddressChangeable = TRUE; - } else { - Snp->Mode.MacAddressChangeable = FALSE; - } - - if ((Pxe->hw.Implementation & PXE_ROMID_IMP_MULTI_FRAME_SUPPORTED) != 0) { - Snp->Mode.MultipleTxSupported = TRUE; - } else { - Snp->Mode.MultipleTxSupported = FALSE; - } - - Snp->Mode.ReceiveFilterMask = EFI_SIMPLE_NETWORK_RECEIVE_UNICAST; - - if ((Pxe->hw.Implementation & PXE_ROMID_IMP_PROMISCUOUS_MULTICAST_RX_SUPPORTED) != 0) { - Snp->Mode.ReceiveFilterMask |= EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST; - - } - - if ((Pxe->hw.Implementation & PXE_ROMID_IMP_PROMISCUOUS_RX_SUPPORTED) != 0) { - Snp->Mode.ReceiveFilterMask |= EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS; - - } - - if ((Pxe->hw.Implementation & PXE_ROMID_IMP_BROADCAST_RX_SUPPORTED) != 0) { - Snp->Mode.ReceiveFilterMask |= EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST; - - } - - if ((Pxe->hw.Implementation & PXE_ROMID_IMP_FILTERED_MULTICAST_RX_SUPPORTED) != 0) { - Snp->Mode.ReceiveFilterMask |= EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST; - - } - - if ((Pxe->hw.Implementation & PXE_ROMID_IMP_PROMISCUOUS_MULTICAST_RX_SUPPORTED) != 0) { - Snp->Mode.ReceiveFilterMask |= EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST; - - } - - Snp->Mode.ReceiveFilterSetting = 0; - - // - // need to get the station address to save in the mode structure. we need to - // initialize the UNDI first for this. - // - Snp->TxRxBufferSize = Snp->InitInfo.MemoryRequired; - Status = PxeInit (Snp, PXE_OPFLAGS_INITIALIZE_DO_NOT_DETECT_CABLE); - - if (EFI_ERROR (Status)) { - PxeStop (Snp); - goto Error_DeleteSNP; - } - - Status = PxeGetStnAddr (Snp); - - if (Status != EFI_SUCCESS) { - DEBUG ((EFI_D_ERROR, "\nSnp->undi.get_station_addr() failed.\n")); - PxeShutdown (Snp); - PxeStop (Snp); - goto Error_DeleteSNP; - } - - Snp->Mode.MediaPresent = FALSE; - - // - // We should not leave UNDI started and initialized here. this DriverStart() - // routine must only find and attach the SNP interface to UNDI layer that it - // finds on the given handle! - // The UNDI layer will be started when upper layers call Snp->start. - // How ever, this DriverStart() must fill up the snp mode structure which - // contains the MAC address of the NIC. For this reason we started and - // initialized UNDI here, now we are done, do a shutdown and stop of the - // UNDI interface! - // - PxeShutdown (Snp); - PxeStop (Snp); - - // - // Create EXIT_BOOT_SERIVES Event - // - Status = gBS->CreateEventEx ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, - SnpNotifyExitBootServices, - Snp, - &gEfiEventExitBootServicesGuid, - &Snp->ExitBootServicesEvent - ); - if (EFI_ERROR (Status)) { - goto Error_DeleteSNP; - } - - // - // add SNP to the undi handle - // - Status = gBS->InstallProtocolInterface ( - &Controller, - &gEfiSimpleNetworkProtocolGuid, - EFI_NATIVE_INTERFACE, - &(Snp->Snp) - ); - - if (!EFI_ERROR (Status)) { - return Status; - } - - PciIo->FreeBuffer ( - PciIo, - SNP_MEM_PAGES (4096), - Snp->Cpb - ); - -Error_DeleteSNP: - - if (Snp->RecycledTxBuf != NULL) { - FreePool (Snp->RecycledTxBuf); - } - - PciIo->FreeBuffer ( - PciIo, - SNP_MEM_PAGES (sizeof (SNP_DRIVER)), - Snp - ); -NiiError: - gBS->CloseProtocol ( - Controller, - &gEfiNetworkInterfaceIdentifierProtocolGuid_31, - This->DriverBindingHandle, - Controller - ); - - gBS->CloseProtocol ( - Controller, - &gEfiDevicePathProtocolGuid, - This->DriverBindingHandle, - Controller - ); - - // - // If we got here that means we are in error state. - // - if (!EFI_ERROR (Status)) { - Status = EFI_DEVICE_ERROR; - } - - return Status; -} - -/** - Stop this driver on ControllerHandle. This service is called by the - EFI boot service DisconnectController(). In order to - make drivers as small as possible, there are a few calling - restrictions for this service. DisconnectController() - must follow these calling restrictions. If any other agent wishes - to call Stop() it must also follow these calling restrictions. - - @param This Protocol instance pointer. - @param ControllerHandle Handle of device to stop driver on - @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of - children is zero stop the entire bus driver. - @param ChildHandleBuffer List of Child Handles to Stop. - - @retval EFI_SUCCESS This driver is removed ControllerHandle - @retval other This driver was not removed from this device - -**/ -EFI_STATUS -EFIAPI -SimpleNetworkDriverStop ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE Controller, - IN UINTN NumberOfChildren, - IN EFI_HANDLE *ChildHandleBuffer - ) -{ - EFI_STATUS Status; - EFI_SIMPLE_NETWORK_PROTOCOL *SnpProtocol; - SNP_DRIVER *Snp; - EFI_PCI_IO_PROTOCOL *PciIo; - - // - // Get our context back. - // - Status = gBS->OpenProtocol ( - Controller, - &gEfiSimpleNetworkProtocolGuid, - (VOID **) &SnpProtocol, - This->DriverBindingHandle, - Controller, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - - if (EFI_ERROR (Status)) { - return EFI_UNSUPPORTED; - } - - Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (SnpProtocol); - - Status = gBS->UninstallProtocolInterface ( - Controller, - &gEfiSimpleNetworkProtocolGuid, - &Snp->Snp - ); - - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Close EXIT_BOOT_SERIVES Event - // - gBS->CloseEvent (Snp->ExitBootServicesEvent); - - Status = gBS->CloseProtocol ( - Controller, - &gEfiNetworkInterfaceIdentifierProtocolGuid_31, - This->DriverBindingHandle, - Controller - ); - - Status = gBS->CloseProtocol ( - Controller, - &gEfiDevicePathProtocolGuid, - This->DriverBindingHandle, - Controller - ); - - PxeShutdown (Snp); - PxeStop (Snp); - - FreePool (Snp->RecycledTxBuf); - - PciIo = Snp->PciIo; - PciIo->FreeBuffer ( - PciIo, - SNP_MEM_PAGES (4096), - Snp->Cpb - ); - - PciIo->FreeBuffer ( - PciIo, - SNP_MEM_PAGES (sizeof (SNP_DRIVER)), - Snp - ); - - return Status; -} - -// -// Simple Network Protocol Driver Global Variables -// -EFI_DRIVER_BINDING_PROTOCOL gSimpleNetworkDriverBinding = { - SimpleNetworkDriverSupported, - SimpleNetworkDriverStart, - SimpleNetworkDriverStop, - 0xa, - NULL, - NULL -}; - -/** - The SNP driver entry point. - - @param ImageHandle The driver image handle. - @param SystemTable The system table. - - @retval EFI_SUCEESS Initialization routine has found UNDI hardware, - loaded it's ROM, and installed a notify event for - the Network Indentifier Interface Protocol - successfully. - @retval Other Return value from HandleProtocol for - DeviceIoProtocol or LoadedImageProtocol - -**/ -EFI_STATUS -EFIAPI -InitializeSnpNiiDriver ( - IN EFI_HANDLE ImageHandle, - IN EFI_SYSTEM_TABLE *SystemTable - ) -{ - return EfiLibInstallDriverBindingComponentName2 ( - ImageHandle, - SystemTable, - &gSimpleNetworkDriverBinding, - ImageHandle, - &gSimpleNetworkComponentName, - &gSimpleNetworkComponentName2 - ); -} diff --git a/MdeModulePkg/Universal/Network/SnpDxe/Snp.h b/MdeModulePkg/Universal/Network/SnpDxe/Snp.h deleted file mode 100644 index e6b6293039..0000000000 --- a/MdeModulePkg/Universal/Network/SnpDxe/Snp.h +++ /dev/null @@ -1,1033 +0,0 @@ -/** @file - Declaration of strctures and functions for SnpDxe driver. - -Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ -#ifndef _SNP_H_ -#define _SNP_H_ - - -#include - -#include -#include -#include -#include - -#include - -#include -#include -#include -#include -#include -#include -#include -#include - -#include -#include - -#define FOUR_GIGABYTES (UINT64) 0x100000000ULL - - -#define SNP_DRIVER_SIGNATURE SIGNATURE_32 ('s', 'n', 'd', 's') -#define MAX_MAP_LENGTH 100 - -#define PCI_BAR_IO_MASK 0x00000003 -#define PCI_BAR_IO_MODE 0x00000001 - -#define PCI_BAR_MEM_MASK 0x0000000F -#define PCI_BAR_MEM_MODE 0x00000000 -#define PCI_BAR_MEM_64BIT 0x00000004 - -#define SNP_TX_BUFFER_INCREASEMENT MAX_XMIT_BUFFERS -#define SNP_MAX_TX_BUFFER_NUM 65536 - -typedef -EFI_STATUS -(EFIAPI *ISSUE_UNDI32_COMMAND) ( - UINT64 Cdb - ); - -typedef struct { - UINT32 Signature; - EFI_LOCK Lock; - - EFI_SIMPLE_NETWORK_PROTOCOL Snp; - EFI_SIMPLE_NETWORK_MODE Mode; - - EFI_HANDLE DeviceHandle; - EFI_DEVICE_PATH_PROTOCOL *DevicePath; - - // - // Local instance data needed by SNP driver - // - // Pointer to S/W UNDI API entry point - // This will be NULL for H/W UNDI - // - ISSUE_UNDI32_COMMAND IssueUndi32Command; - - BOOLEAN IsSwUndi; - - // - // undi interface number, if one undi manages more nics - // - PXE_IFNUM IfNum; - - // - // Allocated tx/rx buffer that was passed to UNDI Initialize. - // - UINT32 TxRxBufferSize; - VOID *TxRxBuffer; - // - // mappable buffers for receive and fill header for undi3.0 - // these will be used if the user buffers are above 4GB limit (instead of - // mapping the user buffers) - // - UINT8 *ReceiveBufffer; - VOID *ReceiveBufferUnmap; - UINT8 *FillHeaderBuffer; - VOID *FillHeaderBufferUnmap; - - EFI_PCI_IO_PROTOCOL *PciIo; - UINT8 IoBarIndex; - UINT8 MemoryBarIndex; - - // - // Buffers for command descriptor block, command parameter block - // and data block. - // - PXE_CDB Cdb; - VOID *Cpb; - VOID *CpbUnmap; - VOID *Db; - - // - // UNDI structure, we need to remember the init info for a long time! - // - PXE_DB_GET_INIT_INFO InitInfo; - - VOID *SnpDriverUnmap; - // - // when ever we map an address, we must remember it's address and the un-map - // cookie so that we can unmap later - // - struct MAP_LIST { - EFI_PHYSICAL_ADDRESS VirtualAddress; - VOID *MapCookie; - } MapList[MAX_MAP_LENGTH]; - - EFI_EVENT ExitBootServicesEvent; - - // - // Whether UNDI support reporting media status from GET_STATUS command, - // i.e. PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED or - // PXE_STATFLAGS_GET_STATUS_NO_MEDIA_NOT_SUPPORTED - // - BOOLEAN MediaStatusSupported; - - // - // Whether UNDI support cable detect for INITIALIZE command, - // i.e. PXE_STATFLAGS_CABLE_DETECT_SUPPORTED or - // PXE_STATFLAGS_CABLE_DETECT_NOT_SUPPORTED - // - BOOLEAN CableDetectSupported; - - // - // Array of the recycled transmit buffer address from UNDI. - // - UINT64 *RecycledTxBuf; - // - // The maximum number of recycled buffer pointers in RecycledTxBuf. - // - UINT32 MaxRecycledTxBuf; - // - // Current number of recycled buffer pointers in RecycledTxBuf. - // - UINT32 RecycledTxBufCount; -} SNP_DRIVER; - -#define EFI_SIMPLE_NETWORK_DEV_FROM_THIS(a) CR (a, SNP_DRIVER, Snp, SNP_DRIVER_SIGNATURE) - -// -// Global Variables -// -extern EFI_DRIVER_BINDING_PROTOCOL gSimpleNetworkDriverBinding; -extern EFI_COMPONENT_NAME_PROTOCOL gSimpleNetworkComponentName; -extern EFI_COMPONENT_NAME2_PROTOCOL gSimpleNetworkComponentName2; - -/** - this routine calls undi to start the interface and changes the snp state. - - @param Snp pointer to snp driver structure - - @retval EFI_DEVICE_ERROR UNDI could not be started - @retval EFI_SUCCESS UNDI is started successfully - -**/ -EFI_STATUS -PxeStart ( - IN SNP_DRIVER *Snp - ); - -/** - this routine calls undi to stop the interface and changes the snp state. - - @param Snp pointer to snp driver structure - - @retval EFI_INVALID_PARAMETER invalid parameter - @retval EFI_NOT_STARTED SNP is not started - @retval EFI_DEVICE_ERROR SNP is not initialized - @retval EFI_UNSUPPORTED operation unsupported - -**/ -EFI_STATUS -PxeStop ( - SNP_DRIVER *Snp - ); - -/** - this routine calls undi to initialize the interface. - - @param Snp pointer to snp driver structure - @param CableDetectFlag Do/don't detect the cable (depending on what undi supports) - - @retval EFI_SUCCESS UNDI is initialized successfully - @retval EFI_DEVICE_ERROR UNDI could not be initialized - @retval Other other errors - -**/ -EFI_STATUS -PxeInit ( - SNP_DRIVER *Snp, - UINT16 CableDetectFlag - ); - -/** - this routine calls undi to shut down the interface. - - @param Snp pointer to snp driver structure - - @retval EFI_SUCCESS UNDI is shut down successfully - @retval EFI_DEVICE_ERROR UNDI could not be shut down - -**/ -EFI_STATUS -PxeShutdown ( - IN SNP_DRIVER *Snp - ); - -/** - this routine calls undi to read the MAC address of the NIC and updates the - mode structure with the address. - - @param Snp pointer to snp driver structure. - - @retval EFI_SUCCESS the MAC address of the NIC is read successfully. - @retval EFI_DEVICE_ERROR failed to read the MAC address of the NIC. - -**/ -EFI_STATUS -PxeGetStnAddr ( - SNP_DRIVER *Snp - ); - -/** - Call undi to get the status of the interrupts, get the list of recycled transmit - buffers that completed transmitting. The recycled transmit buffer address will - be saved into Snp->RecycledTxBuf. This function will also update the MediaPresent - field of EFI_SIMPLE_NETWORK_MODE if UNDI support it. - - @param[in] Snp Pointer to snp driver structure. - @param[out] InterruptStatusPtr A non null pointer to contain the interrupt - status. - @param[in] GetTransmittedBuf Set to TRUE to retrieve the recycled transmit - buffer address. - - @retval EFI_SUCCESS The status of the network interface was retrieved. - @retval EFI_DEVICE_ERROR The command could not be sent to the network - interface. - -**/ -EFI_STATUS -PxeGetStatus ( - IN SNP_DRIVER *Snp, - OUT UINT32 *InterruptStatusPtr, - IN BOOLEAN GetTransmittedBuf - ); - -/** - This is a callback routine supplied to UNDI3.1 at undi_start time. - UNDI call this routine when it wants to have exclusive access to a critical - section of the code/data. - New callbacks for 3.1: - there won't be a virtual2physical callback for UNDI 3.1 because undi3.1 uses - the MemMap call to map the required address by itself! - - @param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this to - store Undi interface context (Undi does not read or write - this variable) - @param Enable non-zero indicates acquire - zero indicates release -**/ -VOID -EFIAPI -SnpUndi32CallbackBlock ( - IN UINT64 UniqueId, - IN UINT32 Enable - ); - -/** - This is a callback routine supplied to UNDI at undi_start time. - UNDI call this routine with the number of micro seconds when it wants to - pause. - - @param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this to - store Undi interface context (Undi does not read or write - this variable) - @param MicroSeconds number of micro seconds to pause, ususlly multiple of 10. -**/ -VOID -EFIAPI -SnpUndi32CallbackDelay ( - IN UINT64 UniqueId, - IN UINT64 MicroSeconds - ); - -/** - This is a callback routine supplied to UNDI at undi_start time. - This is the IO routine for UNDI3.1 to start CPB. - - @param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this - to store Undi interface context (Undi does not read or - write this variable) - @param ReadOrWrite indicates read or write, IO or Memory. - @param NumBytes number of bytes to read or write. - @param MemOrPortAddr IO or memory address to read from or write to. - @param BufferPtr memory location to read into or that contains the bytes - to write. -**/ -VOID -EFIAPI -SnpUndi32CallbackMemio ( - IN UINT64 UniqueId, - IN UINT8 ReadOrWrite, - IN UINT8 NumBytes, - IN UINT64 MemOrPortAddr, - IN OUT UINT64 BufferPtr - ); - -/** - This is a callback routine supplied to UNDI at undi_start time. - UNDI call this routine when it has to map a CPU address to a device - address. - - @param UniqueId - This was supplied to UNDI at Undi_Start, SNP uses this to store - Undi interface context (Undi does not read or write this variable) - @param CpuAddr - Virtual address to be mapped! - @param NumBytes - size of memory to be mapped - @param Direction - direction of data flow for this memory's usage: - cpu->device, device->cpu or both ways - @param DeviceAddrPtr - pointer to return the mapped device address - -**/ -VOID -EFIAPI -SnpUndi32CallbackMap ( - IN UINT64 UniqueId, - IN UINT64 CpuAddr, - IN UINT32 NumBytes, - IN UINT32 Direction, - IN OUT UINT64 DeviceAddrPtr - ); - -/** - This is a callback routine supplied to UNDI at undi_start time. - UNDI call this routine when it wants to unmap an address that was previously - mapped using map callback. - - @param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this to store. - Undi interface context (Undi does not read or write this variable) - @param CpuAddr Virtual address that was mapped! - @param NumBytes size of memory mapped - @param Direction direction of data flow for this memory's usage: - cpu->device, device->cpu or both ways - @param DeviceAddr the mapped device address - -**/ -VOID -EFIAPI -SnpUndi32CallbackUnmap ( - IN UINT64 UniqueId, - IN UINT64 CpuAddr, - IN UINT32 NumBytes, - IN UINT32 Direction, - IN UINT64 DeviceAddr - ); - -/** - This is a callback routine supplied to UNDI at undi_start time. - UNDI call this routine when it wants synchronize the virtual buffer contents - with the mapped buffer contents. The virtual and mapped buffers need not - correspond to the same physical memory (especially if the virtual address is - > 4GB). Depending on the direction for which the buffer is mapped, undi will - need to synchronize their contents whenever it writes to/reads from the buffer - using either the cpu address or the device address. - - EFI does not provide a sync call, since virt=physical, we sould just do - the synchronization ourself here! - - @param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this to store - Undi interface context (Undi does not read or write this variable) - @param CpuAddr Virtual address that was mapped! - @param NumBytes size of memory mapped. - @param Direction direction of data flow for this memory's usage: - cpu->device, device->cpu or both ways. - @param DeviceAddr the mapped device address. - -**/ -VOID -EFIAPI -SnpUndi32CallbackSync ( - IN UINT64 UniqueId, - IN UINT64 CpuAddr, - IN UINT32 NumBytes, - IN UINT32 Direction, - IN UINT64 DeviceAddr - ); - -/** - Changes the state of a network interface from "stopped" to "started". - - This function starts a network interface. If the network interface successfully - starts, then EFI_SUCCESS will be returned. - - @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. - - @retval EFI_SUCCESS The network interface was started. - @retval EFI_ALREADY_STARTED The network interface is already in the started state. - @retval EFI_INVALID_PARAMETER This parameter was NULL or did not point to a valid - EFI_SIMPLE_NETWORK_PROTOCOL structure. - @retval EFI_DEVICE_ERROR The command could not be sent to the network interface. - @retval EFI_UNSUPPORTED This function is not supported by the network interface. - -**/ -EFI_STATUS -EFIAPI -SnpUndi32Start ( - IN EFI_SIMPLE_NETWORK_PROTOCOL *This - ); - -/** - Changes the state of a network interface from "started" to "stopped". - - This function stops a network interface. This call is only valid if the network - interface is in the started state. If the network interface was successfully - stopped, then EFI_SUCCESS will be returned. - - @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. - - - @retval EFI_SUCCESS The network interface was stopped. - @retval EFI_NOT_STARTED The network interface has not been started. - @retval EFI_INVALID_PARAMETER This parameter was NULL or did not point to a valid - EFI_SIMPLE_NETWORK_PROTOCOL structure. - @retval EFI_DEVICE_ERROR The command could not be sent to the network interface. - @retval EFI_UNSUPPORTED This function is not supported by the network interface. - -**/ -EFI_STATUS -EFIAPI -SnpUndi32Stop ( - IN EFI_SIMPLE_NETWORK_PROTOCOL *This - ); - -/** - Resets a network adapter and allocates the transmit and receive buffers - required by the network interface; optionally, also requests allocation of - additional transmit and receive buffers. - - This function allocates the transmit and receive buffers required by the network - interface. If this allocation fails, then EFI_OUT_OF_RESOURCES is returned. - If the allocation succeeds and the network interface is successfully initialized, - then EFI_SUCCESS will be returned. - - @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. - - @param ExtraRxBufferSize The size, in bytes, of the extra receive buffer space - that the driver should allocate for the network interface. - Some network interfaces will not be able to use the - extra buffer, and the caller will not know if it is - actually being used. - @param ExtraTxBufferSize The size, in bytes, of the extra transmit buffer space - that the driver should allocate for the network interface. - Some network interfaces will not be able to use the - extra buffer, and the caller will not know if it is - actually being used. - - @retval EFI_SUCCESS The network interface was initialized. - @retval EFI_NOT_STARTED The network interface has not been started. - @retval EFI_OUT_OF_RESOURCES There was not enough memory for the transmit and - receive buffers. - @retval EFI_INVALID_PARAMETER This parameter was NULL or did not point to a valid - EFI_SIMPLE_NETWORK_PROTOCOL structure. - @retval EFI_DEVICE_ERROR The command could not be sent to the network interface. - @retval EFI_UNSUPPORTED The increased buffer size feature is not supported. - -**/ -EFI_STATUS -EFIAPI -SnpUndi32Initialize ( - IN EFI_SIMPLE_NETWORK_PROTOCOL *This, - IN UINTN ExtraRxBufferSize OPTIONAL, - IN UINTN ExtraTxBufferSize OPTIONAL - ); - -/** - Resets a network adapter and reinitializes it with the parameters that were - provided in the previous call to Initialize(). - - This function resets a network adapter and reinitializes it with the parameters - that were provided in the previous call to Initialize(). The transmit and - receive queues are emptied and all pending interrupts are cleared. - Receive filters, the station address, the statistics, and the multicast-IP-to-HW - MAC addresses are not reset by this call. If the network interface was - successfully reset, then EFI_SUCCESS will be returned. If the driver has not - been initialized, EFI_DEVICE_ERROR will be returned. - - @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. - @param ExtendedVerification Indicates that the driver may perform a more - exhaustive verification operation of the device - during reset. - - @retval EFI_SUCCESS The network interface was reset. - @retval EFI_NOT_STARTED The network interface has not been started. - @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value. - @retval EFI_DEVICE_ERROR The command could not be sent to the network interface. - @retval EFI_UNSUPPORTED This function is not supported by the network interface. - -**/ -EFI_STATUS -EFIAPI -SnpUndi32Reset ( - IN EFI_SIMPLE_NETWORK_PROTOCOL *This, - IN BOOLEAN ExtendedVerification - ); - -/** - Resets a network adapter and leaves it in a state that is safe for another - driver to initialize. - - This function releases the memory buffers assigned in the Initialize() call. - Pending transmits and receives are lost, and interrupts are cleared and disabled. - After this call, only the Initialize() and Stop() calls may be used. If the - network interface was successfully shutdown, then EFI_SUCCESS will be returned. - If the driver has not been initialized, EFI_DEVICE_ERROR will be returned. - - @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. - - @retval EFI_SUCCESS The network interface was shutdown. - @retval EFI_NOT_STARTED The network interface has not been started. - @retval EFI_INVALID_PARAMETER This parameter was NULL or did not point to a valid - EFI_SIMPLE_NETWORK_PROTOCOL structure. - @retval EFI_DEVICE_ERROR The command could not be sent to the network interface. - -**/ -EFI_STATUS -EFIAPI -SnpUndi32Shutdown ( - IN EFI_SIMPLE_NETWORK_PROTOCOL *This - ); - -/** - Manages the multicast receive filters of a network interface. - - This function is used enable and disable the hardware and software receive - filters for the underlying network device. - The receive filter change is broken down into three steps: - * The filter mask bits that are set (ON) in the Enable parameter are added to - the current receive filter settings. - * The filter mask bits that are set (ON) in the Disable parameter are subtracted - from the updated receive filter settings. - * If the resulting receive filter setting is not supported by the hardware a - more liberal setting is selected. - If the same bits are set in the Enable and Disable parameters, then the bits - in the Disable parameter takes precedence. - If the ResetMCastFilter parameter is TRUE, then the multicast address list - filter is disabled (irregardless of what other multicast bits are set in the - Enable and Disable parameters). The SNP->Mode->MCastFilterCount field is set - to zero. The Snp->Mode->MCastFilter contents are undefined. - After enabling or disabling receive filter settings, software should verify - the new settings by checking the Snp->Mode->ReceiveFilterSettings, - Snp->Mode->MCastFilterCount and Snp->Mode->MCastFilter fields. - Note: Some network drivers and/or devices will automatically promote receive - filter settings if the requested setting can not be honored. For example, if - a request for four multicast addresses is made and the underlying hardware - only supports two multicast addresses the driver might set the promiscuous - or promiscuous multicast receive filters instead. The receiving software is - responsible for discarding any extra packets that get through the hardware - receive filters. - Note: Note: To disable all receive filter hardware, the network driver must - be Shutdown() and Stopped(). Calling ReceiveFilters() with Disable set to - Snp->Mode->ReceiveFilterSettings will make it so no more packets are - returned by the Receive() function, but the receive hardware may still be - moving packets into system memory before inspecting and discarding them. - Unexpected system errors, reboots and hangs can occur if an OS is loaded - and the network devices are not Shutdown() and Stopped(). - If ResetMCastFilter is TRUE, then the multicast receive filter list on the - network interface will be reset to the default multicast receive filter list. - If ResetMCastFilter is FALSE, and this network interface allows the multicast - receive filter list to be modified, then the MCastFilterCnt and MCastFilter - are used to update the current multicast receive filter list. The modified - receive filter list settings can be found in the MCastFilter field of - EFI_SIMPLE_NETWORK_MODE. If the network interface does not allow the multicast - receive filter list to be modified, then EFI_INVALID_PARAMETER will be returned. - If the driver has not been initialized, EFI_DEVICE_ERROR will be returned. - If the receive filter mask and multicast receive filter list have been - successfully updated on the network interface, EFI_SUCCESS will be returned. - - @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. - @param Enable A bit mask of receive filters to enable on the network - interface. - @param Disable A bit mask of receive filters to disable on the network - interface. For backward compatibility with EFI 1.1 - platforms, the EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST bit - must be set when the ResetMCastFilter parameter is TRUE. - @param ResetMCastFilter Set to TRUE to reset the contents of the multicast - receive filters on the network interface to their - default values. - @param MCastFilterCnt Number of multicast HW MAC addresses in the new MCastFilter - list. This value must be less than or equal to the - MCastFilterCnt field of EFI_SIMPLE_NETWORK_MODE. - This field is optional if ResetMCastFilter is TRUE. - @param MCastFilter A pointer to a list of new multicast receive filter HW - MAC addresses. This list will replace any existing - multicast HW MAC address list. This field is optional - if ResetMCastFilter is TRUE. - - @retval EFI_SUCCESS The multicast receive filter list was updated. - @retval EFI_NOT_STARTED The network interface has not been started. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - * This is NULL - * There are bits set in Enable that are not set - in Snp->Mode->ReceiveFilterMask - * There are bits set in Disable that are not set - in Snp->Mode->ReceiveFilterMask - * Multicast is being enabled (the - EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST bit is - set in Enable, it is not set in Disable, and - ResetMCastFilter is FALSE) and MCastFilterCount - is zero - * Multicast is being enabled and MCastFilterCount - is greater than Snp->Mode->MaxMCastFilterCount - * Multicast is being enabled and MCastFilter is NULL - * Multicast is being enabled and one or more of - the addresses in the MCastFilter list are not - valid multicast MAC addresses - @retval EFI_DEVICE_ERROR One or more of the following conditions is TRUE: - * The network interface has been started but has - not been initialized - * An unexpected error was returned by the - underlying network driver or device - @retval EFI_UNSUPPORTED This function is not supported by the network - interface. - -**/ -EFI_STATUS -EFIAPI -SnpUndi32ReceiveFilters ( - IN EFI_SIMPLE_NETWORK_PROTOCOL *This, - IN UINT32 Enable, - IN UINT32 Disable, - IN BOOLEAN ResetMCastFilter, - IN UINTN MCastFilterCnt, OPTIONAL - IN EFI_MAC_ADDRESS *MCastFilter OPTIONAL - ); - -/** - Modifies or resets the current station address, if supported. - - This function modifies or resets the current station address of a network - interface, if supported. If Reset is TRUE, then the current station address is - set to the network interface's permanent address. If Reset is FALSE, and the - network interface allows its station address to be modified, then the current - station address is changed to the address specified by New. If the network - interface does not allow its station address to be modified, then - EFI_INVALID_PARAMETER will be returned. If the station address is successfully - updated on the network interface, EFI_SUCCESS will be returned. If the driver - has not been initialized, EFI_DEVICE_ERROR will be returned. - - @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. - @param Reset Flag used to reset the station address to the network interface's - permanent address. - @param New New station address to be used for the network interface. - - - @retval EFI_SUCCESS The network interface's station address was updated. - @retval EFI_NOT_STARTED The Simple Network Protocol interface has not been - started by calling Start(). - @retval EFI_INVALID_PARAMETER The New station address was not accepted by the NIC. - @retval EFI_INVALID_PARAMETER Reset is FALSE and New is NULL. - @retval EFI_DEVICE_ERROR The Simple Network Protocol interface has not - been initialized by calling Initialize(). - @retval EFI_DEVICE_ERROR An error occurred attempting to set the new - station address. - @retval EFI_UNSUPPORTED The NIC does not support changing the network - interface's station address. - -**/ -EFI_STATUS -EFIAPI -SnpUndi32StationAddress ( - IN EFI_SIMPLE_NETWORK_PROTOCOL *This, - IN BOOLEAN Reset, - IN EFI_MAC_ADDRESS *New OPTIONAL - ); - -/** - Resets or collects the statistics on a network interface. - - This function resets or collects the statistics on a network interface. If the - size of the statistics table specified by StatisticsSize is not big enough for - all the statistics that are collected by the network interface, then a partial - buffer of statistics is returned in StatisticsTable, StatisticsSize is set to - the size required to collect all the available statistics, and - EFI_BUFFER_TOO_SMALL is returned. - If StatisticsSize is big enough for all the statistics, then StatisticsTable - will be filled, StatisticsSize will be set to the size of the returned - StatisticsTable structure, and EFI_SUCCESS is returned. - If the driver has not been initialized, EFI_DEVICE_ERROR will be returned. - If Reset is FALSE, and both StatisticsSize and StatisticsTable are NULL, then - no operations will be performed, and EFI_SUCCESS will be returned. - If Reset is TRUE, then all of the supported statistics counters on this network - interface will be reset to zero. - - @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. - @param Reset Set to TRUE to reset the statistics for the network interface. - @param StatisticsSize On input the size, in bytes, of StatisticsTable. On output - the size, in bytes, of the resulting table of statistics. - @param StatisticsTable A pointer to the EFI_NETWORK_STATISTICS structure that - contains the statistics. Type EFI_NETWORK_STATISTICS is - defined in "Related Definitions" below. - - @retval EFI_SUCCESS The requested operation succeeded. - @retval EFI_NOT_STARTED The Simple Network Protocol interface has not been - started by calling Start(). - @retval EFI_BUFFER_TOO_SMALL StatisticsSize is not NULL and StatisticsTable is - NULL. The current buffer size that is needed to - hold all the statistics is returned in StatisticsSize. - @retval EFI_BUFFER_TOO_SMALL StatisticsSize is not NULL and StatisticsTable is - not NULL. The current buffer size that is needed - to hold all the statistics is returned in - StatisticsSize. A partial set of statistics is - returned in StatisticsTable. - @retval EFI_INVALID_PARAMETER StatisticsSize is NULL and StatisticsTable is not - NULL. - @retval EFI_DEVICE_ERROR The Simple Network Protocol interface has not - been initialized by calling Initialize(). - @retval EFI_DEVICE_ERROR An error was encountered collecting statistics - from the NIC. - @retval EFI_UNSUPPORTED The NIC does not support collecting statistics - from the network interface. - -**/ -EFI_STATUS -EFIAPI -SnpUndi32Statistics ( - IN EFI_SIMPLE_NETWORK_PROTOCOL *This, - IN BOOLEAN Reset, - IN OUT UINTN *StatisticsSize, OPTIONAL - IN OUT EFI_NETWORK_STATISTICS *StatisticsTable OPTIONAL - ); - -/** - Converts a multicast IP address to a multicast HW MAC address. - - This function converts a multicast IP address to a multicast HW MAC address - for all packet transactions. If the mapping is accepted, then EFI_SUCCESS will - be returned. - - @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. - @param IPv6 Set to TRUE if the multicast IP address is IPv6 [RFC 2460]. - Set to FALSE if the multicast IP address is IPv4 [RFC 791]. - @param IP The multicast IP address that is to be converted to a multicast - HW MAC address. - @param MAC The multicast HW MAC address that is to be generated from IP. - - @retval EFI_SUCCESS The multicast IP address was mapped to the - multicast HW MAC address. - @retval EFI_NOT_STARTED The Simple Network Protocol interface has not - been started by calling Start(). - @retval EFI_INVALID_PARAMETER IP is NULL. - @retval EFI_INVALID_PARAMETER MAC is NULL. - @retval EFI_INVALID_PARAMETER IP does not point to a valid IPv4 or IPv6 - multicast address. - @retval EFI_DEVICE_ERROR The Simple Network Protocol interface has not - been initialized by calling Initialize(). - @retval EFI_UNSUPPORTED IPv6 is TRUE and the implementation does not - support IPv6 multicast to MAC address conversion. - -**/ -EFI_STATUS -EFIAPI -SnpUndi32McastIpToMac ( - IN EFI_SIMPLE_NETWORK_PROTOCOL *This, - IN BOOLEAN IPv6, - IN EFI_IP_ADDRESS *IP, - OUT EFI_MAC_ADDRESS *MAC - ); - -/** - Performs read and write operations on the NVRAM device attached to a network - interface. - - This function performs read and write operations on the NVRAM device attached - to a network interface. If ReadWrite is TRUE, a read operation is performed. - If ReadWrite is FALSE, a write operation is performed. Offset specifies the - byte offset at which to start either operation. Offset must be a multiple of - NvRamAccessSize , and it must have a value between zero and NvRamSize. - BufferSize specifies the length of the read or write operation. BufferSize must - also be a multiple of NvRamAccessSize, and Offset + BufferSize must not exceed - NvRamSize. - If any of the above conditions is not met, then EFI_INVALID_PARAMETER will be - returned. - If all the conditions are met and the operation is "read," the NVRAM device - attached to the network interface will be read into Buffer and EFI_SUCCESS - will be returned. If this is a write operation, the contents of Buffer will be - used to update the contents of the NVRAM device attached to the network - interface and EFI_SUCCESS will be returned. - - It does the basic checking on the input parameters and retrieves snp structure - and then calls the read_nvdata() call which does the actual reading - - @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. - @param ReadWrite TRUE for read operations, FALSE for write operations. - @param Offset Byte offset in the NVRAM device at which to start the read or - write operation. This must be a multiple of NvRamAccessSize - and less than NvRamSize. (See EFI_SIMPLE_NETWORK_MODE) - @param BufferSize The number of bytes to read or write from the NVRAM device. - This must also be a multiple of NvramAccessSize. - @param Buffer A pointer to the data buffer. - - @retval EFI_SUCCESS The NVRAM access was performed. - @retval EFI_NOT_STARTED The network interface has not been started. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - * The This parameter is NULL - * The This parameter does not point to a valid - EFI_SIMPLE_NETWORK_PROTOCOL structure - * The Offset parameter is not a multiple of - EFI_SIMPLE_NETWORK_MODE.NvRamAccessSize - * The Offset parameter is not less than - EFI_SIMPLE_NETWORK_MODE.NvRamSize - * The BufferSize parameter is not a multiple of - EFI_SIMPLE_NETWORK_MODE.NvRamAccessSize - * The Buffer parameter is NULL - @retval EFI_DEVICE_ERROR The command could not be sent to the network - interface. - @retval EFI_UNSUPPORTED This function is not supported by the network - interface. - -**/ -EFI_STATUS -EFIAPI -SnpUndi32NvData ( - IN EFI_SIMPLE_NETWORK_PROTOCOL *This, - IN BOOLEAN ReadWrite, - IN UINTN Offset, - IN UINTN BufferSize, - IN OUT VOID *Buffer - ); - -/** - Reads the current interrupt status and recycled transmit buffer status from a - network interface. - - This function gets the current interrupt and recycled transmit buffer status - from the network interface. The interrupt status is returned as a bit mask in - InterruptStatus. If InterruptStatus is NULL, the interrupt status will not be - read. If TxBuf is not NULL, a recycled transmit buffer address will be retrieved. - If a recycled transmit buffer address is returned in TxBuf, then the buffer has - been successfully transmitted, and the status for that buffer is cleared. If - the status of the network interface is successfully collected, EFI_SUCCESS - will be returned. If the driver has not been initialized, EFI_DEVICE_ERROR will - be returned. - - @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. - @param InterruptStatus A pointer to the bit mask of the currently active - interrupts (see "Related Definitions"). If this is NULL, - the interrupt status will not be read from the device. - If this is not NULL, the interrupt status will be read - from the device. When the interrupt status is read, it - will also be cleared. Clearing the transmit interrupt does - not empty the recycled transmit buffer array. - @param TxBuf Recycled transmit buffer address. The network interface - will not transmit if its internal recycled transmit - buffer array is full. Reading the transmit buffer does - not clear the transmit interrupt. If this is NULL, then - the transmit buffer status will not be read. If there - are no transmit buffers to recycle and TxBuf is not NULL, - TxBuf will be set to NULL. - - @retval EFI_SUCCESS The status of the network interface was retrieved. - @retval EFI_NOT_STARTED The network interface has not been started. - @retval EFI_INVALID_PARAMETER This parameter was NULL or did not point to a valid - EFI_SIMPLE_NETWORK_PROTOCOL structure. - @retval EFI_DEVICE_ERROR The command could not be sent to the network - interface. - -**/ -EFI_STATUS -EFIAPI -SnpUndi32GetStatus ( - IN EFI_SIMPLE_NETWORK_PROTOCOL *This, - OUT UINT32 *InterruptStatus, OPTIONAL - OUT VOID **TxBuf OPTIONAL - ); - -/** - Places a packet in the transmit queue of a network interface. - - This function places the packet specified by Header and Buffer on the transmit - queue. If HeaderSize is nonzero and HeaderSize is not equal to - This->Mode->MediaHeaderSize, then EFI_INVALID_PARAMETER will be returned. If - BufferSize is less than This->Mode->MediaHeaderSize, then EFI_BUFFER_TOO_SMALL - will be returned. If Buffer is NULL, then EFI_INVALID_PARAMETER will be - returned. If HeaderSize is nonzero and DestAddr or Protocol is NULL, then - EFI_INVALID_PARAMETER will be returned. If the transmit engine of the network - interface is busy, then EFI_NOT_READY will be returned. If this packet can be - accepted by the transmit engine of the network interface, the packet contents - specified by Buffer will be placed on the transmit queue of the network - interface, and EFI_SUCCESS will be returned. GetStatus() can be used to - determine when the packet has actually been transmitted. The contents of the - Buffer must not be modified until the packet has actually been transmitted. - The Transmit() function performs nonblocking I/O. A caller who wants to perform - blocking I/O, should call Transmit(), and then GetStatus() until the - transmitted buffer shows up in the recycled transmit buffer. - If the driver has not been initialized, EFI_DEVICE_ERROR will be returned. - - @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. - @param HeaderSize The size, in bytes, of the media header to be filled in by the - Transmit() function. If HeaderSize is nonzero, then it must - be equal to This->Mode->MediaHeaderSize and the DestAddr and - Protocol parameters must not be NULL. - @param BufferSize The size, in bytes, of the entire packet (media header and - data) to be transmitted through the network interface. - @param Buffer A pointer to the packet (media header followed by data) to be - transmitted. This parameter cannot be NULL. If HeaderSize is - zero, then the media header in Buffer must already be filled - in by the caller. If HeaderSize is nonzero, then the media - header will be filled in by the Transmit() function. - @param SrcAddr The source HW MAC address. If HeaderSize is zero, then this - parameter is ignored. If HeaderSize is nonzero and SrcAddr - is NULL, then This->Mode->CurrentAddress is used for the - source HW MAC address. - @param DestAddr The destination HW MAC address. If HeaderSize is zero, then - this parameter is ignored. - @param Protocol The type of header to build. If HeaderSize is zero, then this - parameter is ignored. See RFC 1700, section "Ether Types," - for examples. - - @retval EFI_SUCCESS The packet was placed on the transmit queue. - @retval EFI_NOT_STARTED The network interface has not been started. - @retval EFI_NOT_READY The network interface is too busy to accept this - transmit request. - @retval EFI_BUFFER_TOO_SMALL The BufferSize parameter is too small. - @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported - value. - @retval EFI_DEVICE_ERROR The command could not be sent to the network interface. - @retval EFI_UNSUPPORTED This function is not supported by the network interface. - -**/ -EFI_STATUS -EFIAPI -SnpUndi32Transmit ( - IN EFI_SIMPLE_NETWORK_PROTOCOL *This, - IN UINTN HeaderSize, - IN UINTN BufferSize, - IN VOID *Buffer, - IN EFI_MAC_ADDRESS *SrcAddr, OPTIONAL - IN EFI_MAC_ADDRESS *DestAddr, OPTIONAL - IN UINT16 *Protocol OPTIONAL - ); - -/** - Receives a packet from a network interface. - - This function retrieves one packet from the receive queue of a network interface. - If there are no packets on the receive queue, then EFI_NOT_READY will be - returned. If there is a packet on the receive queue, and the size of the packet - is smaller than BufferSize, then the contents of the packet will be placed in - Buffer, and BufferSize will be updated with the actual size of the packet. - In addition, if SrcAddr, DestAddr, and Protocol are not NULL, then these values - will be extracted from the media header and returned. EFI_SUCCESS will be - returned if a packet was successfully received. - If BufferSize is smaller than the received packet, then the size of the receive - packet will be placed in BufferSize and EFI_BUFFER_TOO_SMALL will be returned. - If the driver has not been initialized, EFI_DEVICE_ERROR will be returned. - - @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. - @param HeaderSize The size, in bytes, of the media header received on the network - interface. If this parameter is NULL, then the media header size - will not be returned. - @param BufferSize On entry, the size, in bytes, of Buffer. On exit, the size, in - bytes, of the packet that was received on the network interface. - @param Buffer A pointer to the data buffer to receive both the media - header and the data. - @param SrcAddr The source HW MAC address. If this parameter is NULL, the HW - MAC source address will not be extracted from the media header. - @param DestAddr The destination HW MAC address. If this parameter is NULL, - the HW MAC destination address will not be extracted from - the media header. - @param Protocol The media header type. If this parameter is NULL, then the - protocol will not be extracted from the media header. See - RFC 1700 section "Ether Types" for examples. - - @retval EFI_SUCCESS The received data was stored in Buffer, and - BufferSize has been updated to the number of - bytes received. - @retval EFI_NOT_STARTED The network interface has not been started. - @retval EFI_NOT_READY No packets have been received on the network interface. - @retval EFI_BUFFER_TOO_SMALL BufferSize is too small for the received packets. - BufferSize has been updated to the required size. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - * The This parameter is NULL - * The This parameter does not point to a valid - EFI_SIMPLE_NETWORK_PROTOCOL structure. - * The BufferSize parameter is NULL - * The Buffer parameter is NULL - @retval EFI_DEVICE_ERROR The command could not be sent to the network interface. - -**/ -EFI_STATUS -EFIAPI -SnpUndi32Receive ( - IN EFI_SIMPLE_NETWORK_PROTOCOL *This, - OUT UINTN *HeaderSize OPTIONAL, - IN OUT UINTN *BufferSize, - OUT VOID *Buffer, - OUT EFI_MAC_ADDRESS *SrcAddr OPTIONAL, - OUT EFI_MAC_ADDRESS *DestAddr OPTIONAL, - OUT UINT16 *Protocol OPTIONAL - ); - -/** - Nofication call back function for WaitForPacket event. - - @param Event EFI Event. - @param SnpPtr Pointer to SNP_DRIVER structure. - -**/ -VOID -EFIAPI -SnpWaitForPacketNotify ( - EFI_EVENT Event, - VOID *SnpPtr - ); - -#define SNP_MEM_PAGES(x) (((x) - 1) / 4096 + 1) - - -#endif /* _SNP_H_ */ diff --git a/MdeModulePkg/Universal/Network/SnpDxe/SnpDxe.inf b/MdeModulePkg/Universal/Network/SnpDxe/SnpDxe.inf deleted file mode 100644 index eab97d2e9e..0000000000 --- a/MdeModulePkg/Universal/Network/SnpDxe/SnpDxe.inf +++ /dev/null @@ -1,77 +0,0 @@ -## @file -# This module produces EFI SNP Protocol. -# -# This module produces Simple Network Protocol upon EFI Network Interface -# Identifier Protocol, to provide a packet level interface to a network adapter. -# -# Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-# SPDX-License-Identifier: BSD-2-Clause-Patent -# -## - -[Defines] - INF_VERSION = 0x00010005 - BASE_NAME = SnpDxe - MODULE_UNI_FILE = SnpDxe.uni - FILE_GUID = A2f436EA-A127-4EF8-957C-8048606FF670 - MODULE_TYPE = UEFI_DRIVER - VERSION_STRING = 1.0 - ENTRY_POINT = InitializeSnpNiiDriver - UNLOAD_IMAGE = NetLibDefaultUnload - -# -# The following information is for reference only and not required by the build tools. -# -# VALID_ARCHITECTURES = IA32 X64 EBC -# -# DRIVER_BINDING = mSimpleNetworkDriverBinding -# COMPONENT_NAME = gSimpleNetworkComponentName -# COMPONENT_NAME2 = gSimpleNetworkComponentName2 -# - -[Sources] - Receive.c - Snp.h - Nvdata.c - Get_status.c - Start.c - Snp.c - Stop.c - Statistics.c - Reset.c - Shutdown.c - Mcast_ip_to_mac.c - Transmit.c - WaitForPacket.c - Receive_filters.c - Initialize.c - ComponentName.c - Callback.c - Station_address.c - - -[Packages] - MdePkg/MdePkg.dec - MdeModulePkg/MdeModulePkg.dec - - -[LibraryClasses] - UefiLib - BaseLib - UefiBootServicesTableLib - UefiDriverEntryPoint - BaseMemoryLib - DebugLib - NetLib - -[Guids] - gEfiEventExitBootServicesGuid ## SOMETIMES_CONSUMES ## Event - -[Protocols] - gEfiSimpleNetworkProtocolGuid ## BY_START - gEfiDevicePathProtocolGuid ## TO_START - gEfiNetworkInterfaceIdentifierProtocolGuid_31 ## TO_START - gEfiPciIoProtocolGuid ## TO_START - -[UserExtensions.TianoCore."ExtraFiles"] - SnpDxeExtra.uni diff --git a/MdeModulePkg/Universal/Network/SnpDxe/SnpDxe.uni b/MdeModulePkg/Universal/Network/SnpDxe/SnpDxe.uni deleted file mode 100644 index f37bb17fe0..0000000000 --- a/MdeModulePkg/Universal/Network/SnpDxe/SnpDxe.uni +++ /dev/null @@ -1,17 +0,0 @@ -// /** @file -// This module produces EFI SNP Protocol. -// -// This module produces Simple Network Protocol upon EFI Network Interface -// Identifier Protocol, to provide a packet level interface to a network adapter. -// -// Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-// -// SPDX-License-Identifier: BSD-2-Clause-Patent -// -// **/ - - -#string STR_MODULE_ABSTRACT #language en-US "Produces EFI SNP Protocol" - -#string STR_MODULE_DESCRIPTION #language en-US "This module produces Simple Network Protocol upon EFI Network Interface Identifier Protocol to provide a packet level interface to a network adapter." - diff --git a/MdeModulePkg/Universal/Network/SnpDxe/SnpDxeExtra.uni b/MdeModulePkg/Universal/Network/SnpDxe/SnpDxeExtra.uni deleted file mode 100644 index 5cf6e9d18e..0000000000 --- a/MdeModulePkg/Universal/Network/SnpDxe/SnpDxeExtra.uni +++ /dev/null @@ -1,14 +0,0 @@ -// /** @file -// SnpDxe Localized Strings and Content -// -// Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.
-// -// SPDX-License-Identifier: BSD-2-Clause-Patent -// -// **/ - -#string STR_PROPERTIES_MODULE_NAME -#language en-US -"SNP DXE Driver" - - diff --git a/MdeModulePkg/Universal/Network/SnpDxe/Start.c b/MdeModulePkg/Universal/Network/SnpDxe/Start.c deleted file mode 100644 index 033ca22f66..0000000000 --- a/MdeModulePkg/Universal/Network/SnpDxe/Start.c +++ /dev/null @@ -1,162 +0,0 @@ -/** @file - Implementation of starting a network adapter. - -Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Snp.h" - - -/** - Call UNDI to start the interface and changes the snp state. - - @param Snp pointer to snp driver structure. - - @retval EFI_SUCCESS UNDI is started successfully. - @retval EFI_DEVICE_ERROR UNDI could not be started. - -**/ -EFI_STATUS -PxeStart ( - IN SNP_DRIVER *Snp - ) -{ - PXE_CPB_START_31 *Cpb31; - - Cpb31 = Snp->Cpb; - // - // Initialize UNDI Start CDB for H/W UNDI - // - Snp->Cdb.OpCode = PXE_OPCODE_START; - Snp->Cdb.OpFlags = PXE_OPFLAGS_NOT_USED; - Snp->Cdb.CPBsize = PXE_CPBSIZE_NOT_USED; - Snp->Cdb.DBsize = PXE_DBSIZE_NOT_USED; - Snp->Cdb.CPBaddr = PXE_CPBADDR_NOT_USED; - Snp->Cdb.DBaddr = PXE_DBADDR_NOT_USED; - Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; - Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; - Snp->Cdb.IFnum = Snp->IfNum; - Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; - - // - // Make changes to H/W UNDI Start CDB if this is - // a S/W UNDI. - // - if (Snp->IsSwUndi) { - Snp->Cdb.CPBsize = (UINT16) sizeof (PXE_CPB_START_31); - Snp->Cdb.CPBaddr = (UINT64)(UINTN) Cpb31; - - Cpb31->Delay = (UINT64)(UINTN) &SnpUndi32CallbackDelay; - Cpb31->Block = (UINT64)(UINTN) &SnpUndi32CallbackBlock; - - // - // Virtual == Physical. This can be set to zero. - // - Cpb31->Virt2Phys = (UINT64)(UINTN) 0; - Cpb31->Mem_IO = (UINT64)(UINTN) &SnpUndi32CallbackMemio; - - Cpb31->Map_Mem = (UINT64)(UINTN) &SnpUndi32CallbackMap; - Cpb31->UnMap_Mem = (UINT64)(UINTN) &SnpUndi32CallbackUnmap; - Cpb31->Sync_Mem = (UINT64)(UINTN) &SnpUndi32CallbackSync; - - Cpb31->Unique_ID = (UINT64)(UINTN) Snp; - } - // - // Issue UNDI command and check result. - // - DEBUG ((EFI_D_NET, "\nsnp->undi.start() ")); - - (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); - - if (Snp->Cdb.StatCode != PXE_STATCODE_SUCCESS) { - // - // UNDI could not be started. Return UNDI error. - // - DEBUG ( - (EFI_D_ERROR, - "\nsnp->undi.start() %xh:%xh\n", - Snp->Cdb.StatCode, - Snp->Cdb.StatFlags) - ); - - return EFI_DEVICE_ERROR; - } - // - // Set simple network state to Started and return success. - // - Snp->Mode.State = EfiSimpleNetworkStarted; - - return EFI_SUCCESS; -} - - -/** - Change the state of a network interface from "stopped" to "started." - - This function starts a network interface. If the network interface successfully - starts, then EFI_SUCCESS will be returned. - - @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. - - @retval EFI_SUCCESS The network interface was started. - @retval EFI_ALREADY_STARTED The network interface is already in the started state. - @retval EFI_INVALID_PARAMETER This parameter was NULL or did not point to a valid - EFI_SIMPLE_NETWORK_PROTOCOL structure. - @retval EFI_DEVICE_ERROR The command could not be sent to the network interface. - @retval EFI_UNSUPPORTED This function is not supported by the network interface. - -**/ -EFI_STATUS -EFIAPI -SnpUndi32Start ( - IN EFI_SIMPLE_NETWORK_PROTOCOL *This - ) -{ - SNP_DRIVER *Snp; - EFI_STATUS Status; - UINTN Index; - EFI_TPL OldTpl; - - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This); - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - switch (Snp->Mode.State) { - case EfiSimpleNetworkStopped: - break; - - case EfiSimpleNetworkStarted: - case EfiSimpleNetworkInitialized: - Status = EFI_ALREADY_STARTED; - goto ON_EXIT; - - default: - Status = EFI_DEVICE_ERROR; - goto ON_EXIT; - } - - Status = PxeStart (Snp); - if (EFI_ERROR (Status)) { - goto ON_EXIT; - } - // - // clear the map_list in SNP structure - // - for (Index = 0; Index < MAX_MAP_LENGTH; Index++) { - Snp->MapList[Index].VirtualAddress = 0; - Snp->MapList[Index].MapCookie = 0; - } - - Snp->Mode.MCastFilterCount = 0; - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - - return Status; -} diff --git a/MdeModulePkg/Universal/Network/SnpDxe/Station_address.c b/MdeModulePkg/Universal/Network/SnpDxe/Station_address.c deleted file mode 100644 index a5c87d4799..0000000000 --- a/MdeModulePkg/Universal/Network/SnpDxe/Station_address.c +++ /dev/null @@ -1,243 +0,0 @@ -/** @file - Implementation of reading the MAC address of a network adapter. - -Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Snp.h" - - -/** - Call UNDI to read the MAC address of the NIC and update the mode structure - with the address. - - @param Snp Pointer to snp driver structure. - - @retval EFI_SUCCESS The MAC address of the NIC is read successfully. - @retval EFI_DEVICE_ERROR Failed to read the MAC address of the NIC. - -**/ -EFI_STATUS -PxeGetStnAddr ( - SNP_DRIVER *Snp - ) -{ - PXE_DB_STATION_ADDRESS *Db; - - Db = Snp->Db; - Snp->Cdb.OpCode = PXE_OPCODE_STATION_ADDRESS; - Snp->Cdb.OpFlags = PXE_OPFLAGS_STATION_ADDRESS_READ; - - Snp->Cdb.CPBaddr = PXE_CPBADDR_NOT_USED; - Snp->Cdb.CPBsize = PXE_CPBSIZE_NOT_USED; - - Snp->Cdb.DBsize = (UINT16) sizeof (PXE_DB_STATION_ADDRESS); - Snp->Cdb.DBaddr = (UINT64)(UINTN) Db; - - Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; - Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; - Snp->Cdb.IFnum = Snp->IfNum; - Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; - - // - // Issue UNDI command and check result. - // - DEBUG ((EFI_D_NET, "\nsnp->undi.station_addr() ")); - - (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); - - if (Snp->Cdb.StatCode != PXE_STATCODE_SUCCESS) { - DEBUG ( - (EFI_D_ERROR, - "\nsnp->undi.station_addr() %xh:%xh\n", - Snp->Cdb.StatFlags, - Snp->Cdb.StatCode) - ); - - return EFI_DEVICE_ERROR; - } - // - // Set new station address in SNP->Mode structure and return success. - // - CopyMem ( - &(Snp->Mode.CurrentAddress), - &Db->StationAddr, - Snp->Mode.HwAddressSize - ); - - CopyMem ( - &Snp->Mode.BroadcastAddress, - &Db->BroadcastAddr, - Snp->Mode.HwAddressSize - ); - - CopyMem ( - &Snp->Mode.PermanentAddress, - &Db->PermanentAddr, - Snp->Mode.HwAddressSize - ); - - return EFI_SUCCESS; -} - - -/** - Call UNDI to set a new MAC address for the NIC. - - @param Snp Pointer to Snp driver structure. - @param NewMacAddr Pointer to a MAC address to be set for the NIC, if this is - NULL then this routine resets the mac address to the NIC's - original address. - - -**/ -EFI_STATUS -PxeSetStnAddr ( - SNP_DRIVER *Snp, - EFI_MAC_ADDRESS *NewMacAddr - ) -{ - PXE_CPB_STATION_ADDRESS *Cpb; - PXE_DB_STATION_ADDRESS *Db; - - Cpb = Snp->Cpb; - Db = Snp->Db; - Snp->Cdb.OpCode = PXE_OPCODE_STATION_ADDRESS; - - if (NewMacAddr == NULL) { - Snp->Cdb.OpFlags = PXE_OPFLAGS_STATION_ADDRESS_RESET; - Snp->Cdb.CPBsize = PXE_CPBSIZE_NOT_USED; - Snp->Cdb.CPBaddr = PXE_CPBADDR_NOT_USED; - } else { - Snp->Cdb.OpFlags = PXE_OPFLAGS_STATION_ADDRESS_WRITE; - // - // Supplying a new address in the CPB will make undi change the mac address to the new one. - // - CopyMem (&Cpb->StationAddr, NewMacAddr, Snp->Mode.HwAddressSize); - - Snp->Cdb.CPBsize = (UINT16) sizeof (PXE_CPB_STATION_ADDRESS); - Snp->Cdb.CPBaddr = (UINT64)(UINTN) Cpb; - } - - Snp->Cdb.DBsize = (UINT16) sizeof (PXE_DB_STATION_ADDRESS); - Snp->Cdb.DBaddr = (UINT64)(UINTN) Db; - - Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; - Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; - Snp->Cdb.IFnum = Snp->IfNum; - Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; - - // - // Issue UNDI command and check result. - // - DEBUG ((EFI_D_NET, "\nsnp->undi.station_addr() ")); - - (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); - - if (Snp->Cdb.StatCode != PXE_STATCODE_SUCCESS) { - DEBUG ( - (EFI_D_ERROR, - "\nsnp->undi.station_addr() %xh:%xh\n", - Snp->Cdb.StatFlags, - Snp->Cdb.StatCode) - ); - - // - // UNDI command failed. Return UNDI status to caller. - // - return EFI_DEVICE_ERROR; - } - // - // read the changed address and save it in SNP->Mode structure - // - PxeGetStnAddr (Snp); - - return EFI_SUCCESS; -} - - -/** - Modifies or resets the current station address, if supported. - - This function modifies or resets the current station address of a network - interface, if supported. If Reset is TRUE, then the current station address is - set to the network interface's permanent address. If Reset is FALSE, and the - network interface allows its station address to be modified, then the current - station address is changed to the address specified by New. If the network - interface does not allow its station address to be modified, then - EFI_INVALID_PARAMETER will be returned. If the station address is successfully - updated on the network interface, EFI_SUCCESS will be returned. If the driver - has not been initialized, EFI_DEVICE_ERROR will be returned. - - @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. - @param Reset Flag used to reset the station address to the network interface's - permanent address. - @param New New station address to be used for the network interface. - - - @retval EFI_SUCCESS The network interface's station address was updated. - @retval EFI_NOT_STARTED The Simple Network Protocol interface has not been - started by calling Start(). - @retval EFI_INVALID_PARAMETER The New station address was not accepted by the NIC. - @retval EFI_INVALID_PARAMETER Reset is FALSE and New is NULL. - @retval EFI_DEVICE_ERROR The Simple Network Protocol interface has not - been initialized by calling Initialize(). - @retval EFI_DEVICE_ERROR An error occurred attempting to set the new - station address. - @retval EFI_UNSUPPORTED The NIC does not support changing the network - interface's station address. - -**/ -EFI_STATUS -EFIAPI -SnpUndi32StationAddress ( - IN EFI_SIMPLE_NETWORK_PROTOCOL *This, - IN BOOLEAN Reset, - IN EFI_MAC_ADDRESS *New OPTIONAL - ) -{ - SNP_DRIVER *Snp; - EFI_STATUS Status; - EFI_TPL OldTpl; - - // - // Check for invalid parameter combinations. - // - if ((This == NULL) || - (!Reset && (New == NULL))) { - return EFI_INVALID_PARAMETER; - } - - Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This); - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - // - // Return error if the SNP is not initialized. - // - switch (Snp->Mode.State) { - case EfiSimpleNetworkInitialized: - break; - - case EfiSimpleNetworkStopped: - Status = EFI_NOT_STARTED; - goto ON_EXIT; - - default: - Status = EFI_DEVICE_ERROR; - goto ON_EXIT; - } - - if (Reset) { - Status = PxeSetStnAddr (Snp, NULL); - } else { - Status = PxeSetStnAddr (Snp, New); - } - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - - return Status; -} diff --git a/MdeModulePkg/Universal/Network/SnpDxe/Statistics.c b/MdeModulePkg/Universal/Network/SnpDxe/Statistics.c deleted file mode 100644 index 480e261780..0000000000 --- a/MdeModulePkg/Universal/Network/SnpDxe/Statistics.c +++ /dev/null @@ -1,224 +0,0 @@ -/** @file - Implementation of collecting the statistics on a network interface. - -Copyright (c) 2004 - 2010, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - - -#include "Snp.h" - - -/** - Resets or collects the statistics on a network interface. - - This function resets or collects the statistics on a network interface. If the - size of the statistics table specified by StatisticsSize is not big enough for - all the statistics that are collected by the network interface, then a partial - buffer of statistics is returned in StatisticsTable, StatisticsSize is set to - the size required to collect all the available statistics, and - EFI_BUFFER_TOO_SMALL is returned. - If StatisticsSize is big enough for all the statistics, then StatisticsTable - will be filled, StatisticsSize will be set to the size of the returned - StatisticsTable structure, and EFI_SUCCESS is returned. - If the driver has not been initialized, EFI_DEVICE_ERROR will be returned. - If Reset is FALSE, and both StatisticsSize and StatisticsTable are NULL, then - no operations will be performed, and EFI_SUCCESS will be returned. - If Reset is TRUE, then all of the supported statistics counters on this network - interface will be reset to zero. - - @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. - @param Reset Set to TRUE to reset the statistics for the network interface. - @param StatisticsSize On input the size, in bytes, of StatisticsTable. On output - the size, in bytes, of the resulting table of statistics. - @param StatisticsTable A pointer to the EFI_NETWORK_STATISTICS structure that - contains the statistics. Type EFI_NETWORK_STATISTICS is - defined in "Related Definitions" below. - - @retval EFI_SUCCESS The requested operation succeeded. - @retval EFI_NOT_STARTED The Simple Network Protocol interface has not been - started by calling Start(). - @retval EFI_BUFFER_TOO_SMALL StatisticsSize is not NULL and StatisticsTable is - NULL. The current buffer size that is needed to - hold all the statistics is returned in StatisticsSize. - @retval EFI_BUFFER_TOO_SMALL StatisticsSize is not NULL and StatisticsTable is - not NULL. The current buffer size that is needed - to hold all the statistics is returned in - StatisticsSize. A partial set of statistics is - returned in StatisticsTable. - @retval EFI_INVALID_PARAMETER StatisticsSize is NULL and StatisticsTable is not - NULL. - @retval EFI_DEVICE_ERROR The Simple Network Protocol interface has not - been initialized by calling Initialize(). - @retval EFI_DEVICE_ERROR An error was encountered collecting statistics - from the NIC. - @retval EFI_UNSUPPORTED The NIC does not support collecting statistics - from the network interface. - -**/ -EFI_STATUS -EFIAPI -SnpUndi32Statistics ( - IN EFI_SIMPLE_NETWORK_PROTOCOL *This, - IN BOOLEAN Reset, - IN OUT UINTN *StatisticsSize, OPTIONAL - IN OUT EFI_NETWORK_STATISTICS *StatisticsTable OPTIONAL - ) -{ - SNP_DRIVER *Snp; - PXE_DB_STATISTICS *Db; - UINT64 *Stp; - UINT64 Mask; - UINTN Size; - UINTN Index; - EFI_TPL OldTpl; - EFI_STATUS Status; - - // - // Get pointer to SNP driver instance for *This. - // - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This); - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - // - // Return error if the SNP is not initialized. - // - switch (Snp->Mode.State) { - case EfiSimpleNetworkInitialized: - break; - - case EfiSimpleNetworkStopped: - Status = EFI_NOT_STARTED; - goto ON_EXIT; - - default: - Status = EFI_DEVICE_ERROR; - goto ON_EXIT; - } - // - // if we are not resetting the counters, we have to have a valid stat table - // with >0 size. if no reset, no table and no size, return success. - // - if (!Reset && StatisticsSize == NULL) { - Status = (StatisticsTable != NULL) ? EFI_INVALID_PARAMETER : EFI_SUCCESS; - goto ON_EXIT; - } - // - // Initialize UNDI Statistics CDB - // - Snp->Cdb.OpCode = PXE_OPCODE_STATISTICS; - Snp->Cdb.CPBsize = PXE_CPBSIZE_NOT_USED; - Snp->Cdb.CPBaddr = PXE_CPBADDR_NOT_USED; - Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; - Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; - Snp->Cdb.IFnum = Snp->IfNum; - Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; - - if (Reset) { - Snp->Cdb.OpFlags = PXE_OPFLAGS_STATISTICS_RESET; - Snp->Cdb.DBsize = PXE_DBSIZE_NOT_USED; - Snp->Cdb.DBaddr = PXE_DBADDR_NOT_USED; - Db = Snp->Db; - } else { - Snp->Cdb.OpFlags = PXE_OPFLAGS_STATISTICS_READ; - Snp->Cdb.DBsize = (UINT16) sizeof (PXE_DB_STATISTICS); - Snp->Cdb.DBaddr = (UINT64)(UINTN) (Db = Snp->Db); - } - // - // Issue UNDI command and check result. - // - DEBUG ((EFI_D_NET, "\nsnp->undi.statistics() ")); - - (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); - - switch (Snp->Cdb.StatCode) { - case PXE_STATCODE_SUCCESS: - break; - - case PXE_STATCODE_UNSUPPORTED: - DEBUG ( - (EFI_D_ERROR, - "\nsnp->undi.statistics() %xh:%xh\n", - Snp->Cdb.StatFlags, - Snp->Cdb.StatCode) - ); - - Status = EFI_UNSUPPORTED; - goto ON_EXIT; - - default: - DEBUG ( - (EFI_D_ERROR, - "\nsnp->undi.statistics() %xh:%xh\n", - Snp->Cdb.StatFlags, - Snp->Cdb.StatCode) - ); - - Status = EFI_DEVICE_ERROR; - goto ON_EXIT; - } - - if (Reset) { - Status = EFI_SUCCESS; - goto ON_EXIT; - } - - if (StatisticsTable == NULL) { - *StatisticsSize = sizeof (EFI_NETWORK_STATISTICS); - Status = EFI_BUFFER_TOO_SMALL; - goto ON_EXIT; - } - // - // Convert the UNDI statistics information to SNP statistics - // information. - // - ZeroMem (StatisticsTable, *StatisticsSize); - Stp = (UINT64 *) StatisticsTable; - Size = 0; - - for (Index = 0, Mask = 1; Index < 64; Index++, Mask = LShiftU64 (Mask, 1), Stp++) { - // - // There must be room for a full UINT64. Partial - // numbers will not be stored. - // - if ((Index + 1) * sizeof (UINT64) > *StatisticsSize) { - break; - } - - if ((Db->Supported & Mask) != 0) { - *Stp = Db->Data[Index]; - Size = Index + 1; - } else { - SetMem (Stp, sizeof (UINT64), 0xFF); - } - } - // - // Compute size up to last supported statistic. - // - while (++Index < 64) { - if ((Db->Supported & (Mask = LShiftU64 (Mask, 1))) != 0) { - Size = Index; - } - } - - Size *= sizeof (UINT64); - - if (*StatisticsSize >= Size) { - *StatisticsSize = Size; - Status = EFI_SUCCESS; - } else { - *StatisticsSize = Size; - Status = EFI_BUFFER_TOO_SMALL; - } - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - - return Status; -} diff --git a/MdeModulePkg/Universal/Network/SnpDxe/Stop.c b/MdeModulePkg/Universal/Network/SnpDxe/Stop.c deleted file mode 100644 index f1c1bd847c..0000000000 --- a/MdeModulePkg/Universal/Network/SnpDxe/Stop.c +++ /dev/null @@ -1,120 +0,0 @@ -/** @file - Implementation of stopping a network interface. - -Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Snp.h" - - -/** - Call UNDI to stop the interface and changes the snp state. - - @param Snp Pointer to snp driver structure - - @retval EFI_SUCCESS The network interface was stopped. - @retval EFI_DEVICE_ERROR SNP is not initialized. - -**/ -EFI_STATUS -PxeStop ( - SNP_DRIVER *Snp - ) -{ - Snp->Cdb.OpCode = PXE_OPCODE_STOP; - Snp->Cdb.OpFlags = PXE_OPFLAGS_NOT_USED; - Snp->Cdb.CPBsize = PXE_CPBSIZE_NOT_USED; - Snp->Cdb.DBsize = PXE_DBSIZE_NOT_USED; - Snp->Cdb.CPBaddr = PXE_CPBADDR_NOT_USED; - Snp->Cdb.DBaddr = PXE_DBADDR_NOT_USED; - Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; - Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; - Snp->Cdb.IFnum = Snp->IfNum; - Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; - - // - // Issue UNDI command - // - DEBUG ((EFI_D_NET, "\nsnp->undi.stop() ")); - - (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); - - if (Snp->Cdb.StatCode != PXE_STATCODE_SUCCESS) { - DEBUG ( - (EFI_D_WARN, - "\nsnp->undi.stop() %xh:%xh\n", - Snp->Cdb.StatFlags, - Snp->Cdb.StatCode) - ); - - return EFI_DEVICE_ERROR; - } - // - // Set simple network state to Started and return success. - // - Snp->Mode.State = EfiSimpleNetworkStopped; - return EFI_SUCCESS; -} - - -/** - Changes the state of a network interface from "started" to "stopped." - - This function stops a network interface. This call is only valid if the network - interface is in the started state. If the network interface was successfully - stopped, then EFI_SUCCESS will be returned. - - @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL - instance. - - - @retval EFI_SUCCESS The network interface was stopped. - @retval EFI_NOT_STARTED The network interface has not been started. - @retval EFI_INVALID_PARAMETER This parameter was NULL or did not point to a - valid EFI_SIMPLE_NETWORK_PROTOCOL structure. - @retval EFI_DEVICE_ERROR The command could not be sent to the network - interface. - @retval EFI_UNSUPPORTED This function is not supported by the network - interface. - -**/ -EFI_STATUS -EFIAPI -SnpUndi32Stop ( - IN EFI_SIMPLE_NETWORK_PROTOCOL *This - ) -{ - SNP_DRIVER *Snp; - EFI_TPL OldTpl; - EFI_STATUS Status; - - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This); - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - switch (Snp->Mode.State) { - case EfiSimpleNetworkStarted: - break; - - case EfiSimpleNetworkStopped: - Status = EFI_NOT_STARTED; - goto ON_EXIT; - - default: - Status = EFI_DEVICE_ERROR; - goto ON_EXIT; - } - - Status = PxeStop (Snp); - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - - return Status; -} diff --git a/MdeModulePkg/Universal/Network/SnpDxe/Transmit.c b/MdeModulePkg/Universal/Network/SnpDxe/Transmit.c deleted file mode 100644 index 44fdd71f41..0000000000 --- a/MdeModulePkg/Universal/Network/SnpDxe/Transmit.c +++ /dev/null @@ -1,353 +0,0 @@ -/** @file - Implementation of transmitting a packet. - -Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Snp.h" - - -/** - Call UNDI to create the meadia header for the given data buffer. - - @param Snp Pointer to SNP driver structure. - @param MacHeaderPtr Address where the media header will be filled in. - @param HeaderSize Size of the memory at MacHeaderPtr. - @param Buffer Data buffer pointer. - @param BufferSize Size of data in the Buffer - @param DestAddr Address of the destination mac address buffer. - @param SrcAddr Address of the source mac address buffer. - @param ProtocolPtr Address of the protocol type. - - @retval EFI_SUCCESS Successfully completed the undi call. - @retval Other Error return from undi call. - -**/ -EFI_STATUS -PxeFillHeader ( - SNP_DRIVER *Snp, - VOID *MacHeaderPtr, - UINTN HeaderSize, - VOID *Buffer, - UINTN BufferSize, - EFI_MAC_ADDRESS *DestAddr, - EFI_MAC_ADDRESS *SrcAddr, - UINT16 *ProtocolPtr - ) -{ - PXE_CPB_FILL_HEADER_FRAGMENTED *Cpb; - - Cpb = Snp->Cpb; - if (SrcAddr != NULL) { - CopyMem ( - (VOID *) Cpb->SrcAddr, - (VOID *) SrcAddr, - Snp->Mode.HwAddressSize - ); - } else { - CopyMem ( - (VOID *) Cpb->SrcAddr, - (VOID *) &(Snp->Mode.CurrentAddress), - Snp->Mode.HwAddressSize - ); - } - - CopyMem ( - (VOID *) Cpb->DestAddr, - (VOID *) DestAddr, - Snp->Mode.HwAddressSize - ); - - // - // we need to do the byte swapping - // - Cpb->Protocol = (UINT16) PXE_SWAP_UINT16 (*ProtocolPtr); - - Cpb->PacketLen = (UINT32) (BufferSize); - Cpb->MediaHeaderLen = (UINT16) HeaderSize; - - Cpb->FragCnt = 2; - Cpb->reserved = 0; - - Cpb->FragDesc[0].FragAddr = (UINT64)(UINTN) MacHeaderPtr; - Cpb->FragDesc[0].FragLen = (UINT32) HeaderSize; - Cpb->FragDesc[1].FragAddr = (UINT64)(UINTN) Buffer; - Cpb->FragDesc[1].FragLen = (UINT32) BufferSize; - - Cpb->FragDesc[0].reserved = Cpb->FragDesc[1].reserved = 0; - - Snp->Cdb.OpCode = PXE_OPCODE_FILL_HEADER; - Snp->Cdb.OpFlags = PXE_OPFLAGS_FILL_HEADER_FRAGMENTED; - - Snp->Cdb.DBsize = PXE_DBSIZE_NOT_USED; - Snp->Cdb.DBaddr = PXE_DBADDR_NOT_USED; - - Snp->Cdb.CPBsize = (UINT16) sizeof (PXE_CPB_FILL_HEADER_FRAGMENTED); - Snp->Cdb.CPBaddr = (UINT64)(UINTN) Cpb; - - Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; - Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; - Snp->Cdb.IFnum = Snp->IfNum; - Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; - - // - // Issue UNDI command and check result. - // - DEBUG ((EFI_D_NET, "\nSnp->undi.fill_header() ")); - - (*Snp->IssueUndi32Command) ((UINT64) (UINTN) &Snp->Cdb); - - switch (Snp->Cdb.StatCode) { - case PXE_STATCODE_SUCCESS: - return EFI_SUCCESS; - - case PXE_STATCODE_INVALID_PARAMETER: - DEBUG ( - (EFI_D_ERROR, - "\nSnp->undi.fill_header() %xh:%xh\n", - Snp->Cdb.StatFlags, - Snp->Cdb.StatCode) - ); - - return EFI_INVALID_PARAMETER; - - default: - DEBUG ( - (EFI_D_ERROR, - "\nSnp->undi.fill_header() %xh:%xh\n", - Snp->Cdb.StatFlags, - Snp->Cdb.StatCode) - ); - - return EFI_DEVICE_ERROR; - } -} - - -/** - This routine calls undi to transmit the given data buffer - - @param Snp pointer to SNP driver structure - @param Buffer data buffer pointer - @param BufferSize Size of data in the Buffer - - @retval EFI_SUCCESS if successfully completed the undi call - @retval Other error return from undi call. - -**/ -EFI_STATUS -PxeTransmit ( - SNP_DRIVER *Snp, - VOID *Buffer, - UINTN BufferSize - ) -{ - PXE_CPB_TRANSMIT *Cpb; - EFI_STATUS Status; - - Cpb = Snp->Cpb; - Cpb->FrameAddr = (UINT64) (UINTN) Buffer; - Cpb->DataLen = (UINT32) BufferSize; - - Cpb->MediaheaderLen = 0; - Cpb->reserved = 0; - - Snp->Cdb.OpFlags = PXE_OPFLAGS_TRANSMIT_WHOLE; - - Snp->Cdb.CPBsize = (UINT16) sizeof (PXE_CPB_TRANSMIT); - Snp->Cdb.CPBaddr = (UINT64)(UINTN) Cpb; - - Snp->Cdb.OpCode = PXE_OPCODE_TRANSMIT; - Snp->Cdb.DBsize = PXE_DBSIZE_NOT_USED; - Snp->Cdb.DBaddr = PXE_DBADDR_NOT_USED; - - Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; - Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; - Snp->Cdb.IFnum = Snp->IfNum; - Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; - - // - // Issue UNDI command and check result. - // - DEBUG ((EFI_D_NET, "\nSnp->undi.transmit() ")); - DEBUG ((EFI_D_NET, "\nSnp->Cdb.OpCode == %x", Snp->Cdb.OpCode)); - DEBUG ((EFI_D_NET, "\nSnp->Cdb.CPBaddr == %LX", Snp->Cdb.CPBaddr)); - DEBUG ((EFI_D_NET, "\nSnp->Cdb.DBaddr == %LX", Snp->Cdb.DBaddr)); - DEBUG ((EFI_D_NET, "\nCpb->FrameAddr == %LX\n", Cpb->FrameAddr)); - - (*Snp->IssueUndi32Command) ((UINT64) (UINTN) &Snp->Cdb); - - DEBUG ((EFI_D_NET, "\nexit Snp->undi.transmit() ")); - - // - // we will unmap the buffers in get_status call, not here - // - switch (Snp->Cdb.StatCode) { - case PXE_STATCODE_SUCCESS: - return EFI_SUCCESS; - - case PXE_STATCODE_BUFFER_FULL: - case PXE_STATCODE_QUEUE_FULL: - case PXE_STATCODE_BUSY: - Status = EFI_NOT_READY; - DEBUG ( - (EFI_D_NET, - "\nSnp->undi.transmit() %xh:%xh\n", - Snp->Cdb.StatFlags, - Snp->Cdb.StatCode) - ); - break; - - default: - DEBUG ( - (EFI_D_ERROR, - "\nSnp->undi.transmit() %xh:%xh\n", - Snp->Cdb.StatFlags, - Snp->Cdb.StatCode) - ); - Status = EFI_DEVICE_ERROR; - } - - return Status; -} - -/** - Places a packet in the transmit queue of a network interface. - - This function places the packet specified by Header and Buffer on the transmit - queue. If HeaderSize is nonzero and HeaderSize is not equal to - This->Mode->MediaHeaderSize, then EFI_INVALID_PARAMETER will be returned. If - BufferSize is less than This->Mode->MediaHeaderSize, then EFI_BUFFER_TOO_SMALL - will be returned. If Buffer is NULL, then EFI_INVALID_PARAMETER will be - returned. If HeaderSize is nonzero and DestAddr or Protocol is NULL, then - EFI_INVALID_PARAMETER will be returned. If the transmit engine of the network - interface is busy, then EFI_NOT_READY will be returned. If this packet can be - accepted by the transmit engine of the network interface, the packet contents - specified by Buffer will be placed on the transmit queue of the network - interface, and EFI_SUCCESS will be returned. GetStatus() can be used to - determine when the packet has actually been transmitted. The contents of the - Buffer must not be modified until the packet has actually been transmitted. - The Transmit() function performs nonblocking I/O. A caller who wants to perform - blocking I/O, should call Transmit(), and then GetStatus() until the - transmitted buffer shows up in the recycled transmit buffer. - If the driver has not been initialized, EFI_DEVICE_ERROR will be returned. - - @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. - @param HeaderSize The size, in bytes, of the media header to be filled in by the - Transmit() function. If HeaderSize is nonzero, then it must - be equal to This->Mode->MediaHeaderSize and the DestAddr and - Protocol parameters must not be NULL. - @param BufferSize The size, in bytes, of the entire packet (media header and - data) to be transmitted through the network interface. - @param Buffer A pointer to the packet (media header followed by data) to be - transmitted. This parameter cannot be NULL. If HeaderSize is - zero, then the media header in Buffer must already be filled - in by the caller. If HeaderSize is nonzero, then the media - header will be filled in by the Transmit() function. - @param SrcAddr The source HW MAC address. If HeaderSize is zero, then this - parameter is ignored. If HeaderSize is nonzero and SrcAddr - is NULL, then This->Mode->CurrentAddress is used for the - source HW MAC address. - @param DestAddr The destination HW MAC address. If HeaderSize is zero, then - this parameter is ignored. - @param Protocol The type of header to build. If HeaderSize is zero, then this - parameter is ignored. See RFC 1700, section "Ether Types," - for examples. - - @retval EFI_SUCCESS The packet was placed on the transmit queue. - @retval EFI_NOT_STARTED The network interface has not been started. - @retval EFI_NOT_READY The network interface is too busy to accept this - transmit request. - @retval EFI_BUFFER_TOO_SMALL The BufferSize parameter is too small. - @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported - value. - @retval EFI_DEVICE_ERROR The command could not be sent to the network interface. - @retval EFI_UNSUPPORTED This function is not supported by the network interface. - -**/ -EFI_STATUS -EFIAPI -SnpUndi32Transmit ( - IN EFI_SIMPLE_NETWORK_PROTOCOL *This, - IN UINTN HeaderSize, - IN UINTN BufferSize, - IN VOID *Buffer, - IN EFI_MAC_ADDRESS *SrcAddr, OPTIONAL - IN EFI_MAC_ADDRESS *DestAddr, OPTIONAL - IN UINT16 *Protocol OPTIONAL - ) -{ - SNP_DRIVER *Snp; - EFI_STATUS Status; - EFI_TPL OldTpl; - - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This); - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - if (Snp == NULL) { - return EFI_DEVICE_ERROR; - } - - switch (Snp->Mode.State) { - case EfiSimpleNetworkInitialized: - break; - - case EfiSimpleNetworkStopped: - Status = EFI_NOT_STARTED; - goto ON_EXIT; - - default: - Status = EFI_DEVICE_ERROR; - goto ON_EXIT; - } - - if (Buffer == NULL) { - Status = EFI_INVALID_PARAMETER; - goto ON_EXIT; - } - - if (BufferSize < Snp->Mode.MediaHeaderSize) { - Status = EFI_BUFFER_TOO_SMALL; - goto ON_EXIT; - } - - // - // if the HeaderSize is non-zero, we need to fill up the header and for that - // we need the destination address and the protocol - // - if (HeaderSize != 0) { - if (HeaderSize != Snp->Mode.MediaHeaderSize || DestAddr == 0 || Protocol == 0) { - Status = EFI_INVALID_PARAMETER; - goto ON_EXIT; - } - - Status = PxeFillHeader ( - Snp, - Buffer, - HeaderSize, - (UINT8 *) Buffer + HeaderSize, - BufferSize - HeaderSize, - DestAddr, - SrcAddr, - Protocol - ); - - if (EFI_ERROR (Status)) { - goto ON_EXIT; - } - } - - Status = PxeTransmit (Snp, Buffer, BufferSize); - -ON_EXIT: - gBS->RestoreTPL (OldTpl); - - return Status; -} diff --git a/MdeModulePkg/Universal/Network/SnpDxe/WaitForPacket.c b/MdeModulePkg/Universal/Network/SnpDxe/WaitForPacket.c deleted file mode 100644 index 866a1e8c0e..0000000000 --- a/MdeModulePkg/Universal/Network/SnpDxe/WaitForPacket.c +++ /dev/null @@ -1,86 +0,0 @@ -/** @file - Event handler to check for available packet. - -Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Snp.h" - - -/** - Nofication call back function for WaitForPacket event. - - @param Event EFI Event. - @param SnpPtr Pointer to SNP_DRIVER structure. - -**/ -VOID -EFIAPI -SnpWaitForPacketNotify ( - EFI_EVENT Event, - VOID *SnpPtr - ) -{ - PXE_DB_GET_STATUS PxeDbGetStatus; - - // - // Do nothing if either parameter is a NULL pointer. - // - if (Event == NULL || SnpPtr == NULL) { - return ; - } - // - // Do nothing if the SNP interface is not initialized. - // - switch (((SNP_DRIVER *) SnpPtr)->Mode.State) { - case EfiSimpleNetworkInitialized: - break; - - case EfiSimpleNetworkStopped: - case EfiSimpleNetworkStarted: - default: - return ; - } - // - // Fill in CDB for UNDI GetStatus(). - // - ((SNP_DRIVER *) SnpPtr)->Cdb.OpCode = PXE_OPCODE_GET_STATUS; - ((SNP_DRIVER *) SnpPtr)->Cdb.OpFlags = 0; - ((SNP_DRIVER *) SnpPtr)->Cdb.CPBsize = PXE_CPBSIZE_NOT_USED; - ((SNP_DRIVER *) SnpPtr)->Cdb.CPBaddr = PXE_CPBADDR_NOT_USED; - ((SNP_DRIVER *) SnpPtr)->Cdb.DBsize = (UINT16) (sizeof (UINT32) * 2); - ((SNP_DRIVER *) SnpPtr)->Cdb.DBaddr = (UINT64)(UINTN) (((SNP_DRIVER *) SnpPtr)->Db); - ((SNP_DRIVER *) SnpPtr)->Cdb.StatCode = PXE_STATCODE_INITIALIZE; - ((SNP_DRIVER *) SnpPtr)->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; - ((SNP_DRIVER *) SnpPtr)->Cdb.IFnum = ((SNP_DRIVER *) SnpPtr)->IfNum; - ((SNP_DRIVER *) SnpPtr)->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; - - // - // Clear contents of DB buffer. - // - ZeroMem (((SNP_DRIVER *) SnpPtr)->Db, sizeof (UINT32) * 2); - - // - // Issue UNDI command and check result. - // - (*((SNP_DRIVER *) SnpPtr)->IssueUndi32Command) ((UINT64)(UINTN) &((SNP_DRIVER *) SnpPtr)->Cdb); - - if (((SNP_DRIVER *) SnpPtr)->Cdb.StatCode != EFI_SUCCESS) { - return ; - } - // - // We might have a packet. Check the receive length and signal - // the event if the length is not zero. - // - CopyMem ( - &PxeDbGetStatus, - ((SNP_DRIVER *) SnpPtr)->Db, - sizeof (UINT32) * 2 - ); - - if (PxeDbGetStatus.RxFrameLen != 0) { - gBS->SignalEvent (Event); - } -} diff --git a/MdeModulePkg/Universal/Network/Udp4Dxe/ComponentName.c b/MdeModulePkg/Universal/Network/Udp4Dxe/ComponentName.c deleted file mode 100644 index 41bd834c6d..0000000000 --- a/MdeModulePkg/Universal/Network/Udp4Dxe/ComponentName.c +++ /dev/null @@ -1,429 +0,0 @@ -/** @file - -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - - -#include "Udp4Impl.h" - -// -// EFI Component Name Functions -// -/** - Retrieves a Unicode string that is the user readable name of the driver. - - This function retrieves the user readable name of a driver in the form of a - Unicode string. If the driver specified by This has a user readable name in - the language specified by Language, then a pointer to the driver name is - returned in DriverName, and EFI_SUCCESS is returned. If the driver specified - by This does not support the language specified by Language, - then EFI_UNSUPPORTED is returned. - - @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param[in] Language A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified - in RFC 4646 or ISO 639-2 language code format. - - @param[out] DriverName A pointer to the Unicode string to return. - This Unicode string is the name of the - driver specified by This in the language - specified by Language. - - @retval EFI_SUCCESS The Unicode string for the Driver specified by - This and the language specified by Language was - returned in DriverName. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER DriverName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -UdpComponentNameGetDriverName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN CHAR8 *Language, - OUT CHAR16 **DriverName - ); - - -/** - Retrieves a Unicode string that is the user readable name of the controller - that is being managed by a driver. - - This function retrieves the user readable name of the controller specified by - ControllerHandle and ChildHandle in the form of a Unicode string. If the - driver specified by This has a user readable name in the language specified by - Language, then a pointer to the controller name is returned in ControllerName, - and EFI_SUCCESS is returned. If the driver specified by This is not currently - managing the controller specified by ControllerHandle and ChildHandle, - then EFI_UNSUPPORTED is returned. If the driver specified by This does not - support the language specified by Language, then EFI_UNSUPPORTED is returned. - - @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param[in] ControllerHandle The handle of a controller that the driver - specified by This is managing. This handle - specifies the controller whose name is to be - returned. - - @param[in] ChildHandle The handle of the child controller to retrieve - the name of. This is an optional parameter that - may be NULL. It will be NULL for device - drivers. It will also be NULL for a bus drivers - that wish to retrieve the name of the bus - controller. It will not be NULL for a bus - driver that wishes to retrieve the name of a - child controller. - - @param[in] Language A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified in - RFC 4646 or ISO 639-2 language code format. - - @param[out] ControllerName A pointer to the Unicode string to return. - This Unicode string is the name of the - controller specified by ControllerHandle and - ChildHandle in the language specified by - Language from the point of view of the driver - specified by This. - - @retval EFI_SUCCESS The Unicode string for the user readable name in - the language specified by Language for the - driver specified by This was returned in - DriverName. - - @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. - - @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid - EFI_HANDLE. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER ControllerName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This is not currently - managing the controller specified by - ControllerHandle and ChildHandle. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -UdpComponentNameGetControllerName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_HANDLE ChildHandle OPTIONAL, - IN CHAR8 *Language, - OUT CHAR16 **ControllerName - ); - - -// -// EFI Component Name Protocol -// -GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gUdp4ComponentName = { - UdpComponentNameGetDriverName, - UdpComponentNameGetControllerName, - "eng" -}; - -// -// EFI Component Name 2 Protocol -// -GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gUdp4ComponentName2 = { - (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) UdpComponentNameGetDriverName, - (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) UdpComponentNameGetControllerName, - "en" -}; - - -GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mUdpDriverNameTable[] = { - { - "eng;en", - L"UDP Network Service Driver" - }, - { - NULL, - NULL - } -}; - -GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE *gUdpControllerNameTable = NULL; - -/** - Retrieves a Unicode string that is the user readable name of the driver. - - This function retrieves the user readable name of a driver in the form of a - Unicode string. If the driver specified by This has a user readable name in - the language specified by Language, then a pointer to the driver name is - returned in DriverName, and EFI_SUCCESS is returned. If the driver specified - by This does not support the language specified by Language, - then EFI_UNSUPPORTED is returned. - - @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param[in] Language A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified - in RFC 4646 or ISO 639-2 language code format. - - @param[out] DriverName A pointer to the Unicode string to return. - This Unicode string is the name of the - driver specified by This in the language - specified by Language. - - @retval EFI_SUCCESS The Unicode string for the Driver specified by - This and the language specified by Language was - returned in DriverName. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER DriverName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -UdpComponentNameGetDriverName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN CHAR8 *Language, - OUT CHAR16 **DriverName - ) -{ - return LookupUnicodeString2 ( - Language, - This->SupportedLanguages, - mUdpDriverNameTable, - DriverName, - (BOOLEAN)(This == &gUdp4ComponentName) - ); -} - -/** - Update the component name for the Udp4 child handle. - - @param Udp4[in] A pointer to the EFI_UDP4_PROTOCOL. - - - @retval EFI_SUCCESS Update the ControllerNameTable of this instance successfully. - @retval EFI_INVALID_PARAMETER The input parameter is invalid. - -**/ -EFI_STATUS -UpdateName ( - EFI_UDP4_PROTOCOL *Udp4 - ) -{ - EFI_STATUS Status; - CHAR16 HandleName[64]; - EFI_UDP4_CONFIG_DATA Udp4ConfigData; - - if (Udp4 == NULL) { - return EFI_INVALID_PARAMETER; - } - - // - // Format the child name into the string buffer as: - // UDPv4 (SrcPort=59, DestPort=60) - // - Status = Udp4->GetModeData (Udp4, &Udp4ConfigData, NULL, NULL, NULL); - if (!EFI_ERROR (Status)) { - UnicodeSPrint (HandleName, sizeof (HandleName), - L"UDPv4 (SrcPort=%d, DestPort=%d)", - Udp4ConfigData.StationPort, - Udp4ConfigData.RemotePort - ); - } else if (Status == EFI_NOT_STARTED) { - UnicodeSPrint ( - HandleName, - sizeof (HandleName), - L"UDPv4 (Not started)" - ); - } else { - return Status; - } - - if (gUdpControllerNameTable != NULL) { - FreeUnicodeStringTable (gUdpControllerNameTable); - gUdpControllerNameTable = NULL; - } - - Status = AddUnicodeString2 ( - "eng", - gUdp4ComponentName.SupportedLanguages, - &gUdpControllerNameTable, - HandleName, - TRUE - ); - if (EFI_ERROR (Status)) { - return Status; - } - - return AddUnicodeString2 ( - "en", - gUdp4ComponentName2.SupportedLanguages, - &gUdpControllerNameTable, - HandleName, - FALSE - ); -} - -/** - Retrieves a Unicode string that is the user readable name of the controller - that is being managed by a driver. - - This function retrieves the user readable name of the controller specified by - ControllerHandle and ChildHandle in the form of a Unicode string. If the - driver specified by This has a user readable name in the language specified by - Language, then a pointer to the controller name is returned in ControllerName, - and EFI_SUCCESS is returned. If the driver specified by This is not currently - managing the controller specified by ControllerHandle and ChildHandle, - then EFI_UNSUPPORTED is returned. If the driver specified by This does not - support the language specified by Language, then EFI_UNSUPPORTED is returned. - - @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - - @param[in] ControllerHandle The handle of a controller that the driver - specified by This is managing. This handle - specifies the controller whose name is to be - returned. - - @param[in] ChildHandle The handle of the child controller to retrieve - the name of. This is an optional parameter that - may be NULL. It will be NULL for device - drivers. It will also be NULL for a bus drivers - that wish to retrieve the name of the bus - controller. It will not be NULL for a bus - driver that wishes to retrieve the name of a - child controller. - - @param[in] Language A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified in - RFC 4646 or ISO 639-2 language code format. - - @param[out] ControllerName A pointer to the Unicode string to return. - This Unicode string is the name of the - controller specified by ControllerHandle and - ChildHandle in the language specified by - Language from the point of view of the driver - specified by This. - - @retval EFI_SUCCESS The Unicode string for the user readable name in - the language specified by Language for the - driver specified by This was returned in - DriverName. - - @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. - - @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid - EFI_HANDLE. - - @retval EFI_INVALID_PARAMETER Language is NULL. - - @retval EFI_INVALID_PARAMETER ControllerName is NULL. - - @retval EFI_UNSUPPORTED The driver specified by This is not currently - managing the controller specified by - ControllerHandle and ChildHandle. - - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -UdpComponentNameGetControllerName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_HANDLE ChildHandle OPTIONAL, - IN CHAR8 *Language, - OUT CHAR16 **ControllerName - ) -{ - EFI_STATUS Status; - EFI_UDP4_PROTOCOL *Udp4; - - // - // Only provide names for child handles. - // - if (ChildHandle == NULL) { - return EFI_UNSUPPORTED; - } - - // - // Make sure this driver produced ChildHandle - // - Status = EfiTestChildHandle ( - ControllerHandle, - ChildHandle, - &gEfiIp4ProtocolGuid - ); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Retrieve an instance of a produced protocol from ChildHandle - // - Status = gBS->OpenProtocol ( - ChildHandle, - &gEfiUdp4ProtocolGuid, - (VOID **)&Udp4, - NULL, - NULL, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Update the component name for this child handle. - // - Status = UpdateName (Udp4); - if (EFI_ERROR (Status)) { - return Status; - } - - return LookupUnicodeString2 ( - Language, - This->SupportedLanguages, - gUdpControllerNameTable, - ControllerName, - (BOOLEAN)(This == &gUdp4ComponentName) - ); -} - diff --git a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Driver.c b/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Driver.c deleted file mode 100644 index 63b103b8ef..0000000000 --- a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Driver.c +++ /dev/null @@ -1,584 +0,0 @@ -/** @file - -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - - -#include "Udp4Impl.h" - -EFI_DRIVER_BINDING_PROTOCOL gUdp4DriverBinding = { - Udp4DriverBindingSupported, - Udp4DriverBindingStart, - Udp4DriverBindingStop, - 0xa, - NULL, - NULL -}; - -EFI_SERVICE_BINDING_PROTOCOL mUdp4ServiceBinding = { - Udp4ServiceBindingCreateChild, - Udp4ServiceBindingDestroyChild -}; - -/** - Callback function which provided by user to remove one node in NetDestroyLinkList process. - - @param[in] Entry The entry to be removed. - @param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList. - - @retval EFI_SUCCESS The entry has been removed successfully. - @retval Others Fail to remove the entry. - -**/ -EFI_STATUS -EFIAPI -Udp4DestroyChildEntryInHandleBuffer ( - IN LIST_ENTRY *Entry, - IN VOID *Context - ) -{ - UDP4_INSTANCE_DATA *Instance; - EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; - UINTN NumberOfChildren; - EFI_HANDLE *ChildHandleBuffer; - - if (Entry == NULL || Context == NULL) { - return EFI_INVALID_PARAMETER; - } - - Instance = NET_LIST_USER_STRUCT_S (Entry, UDP4_INSTANCE_DATA, Link, UDP4_INSTANCE_DATA_SIGNATURE); - ServiceBinding = ((UDP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *) Context)->ServiceBinding; - NumberOfChildren = ((UDP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *) Context)->NumberOfChildren; - ChildHandleBuffer = ((UDP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *) Context)->ChildHandleBuffer; - - if (!NetIsInHandleBuffer (Instance->ChildHandle, NumberOfChildren, ChildHandleBuffer)) { - return EFI_SUCCESS; - } - - return ServiceBinding->DestroyChild (ServiceBinding, Instance->ChildHandle); -} - - -/** - Test to see if this driver supports ControllerHandle. This service - is called by the EFI boot service ConnectController(). In - order to make drivers as small as possible, there are a few calling - restrictions for this service. ConnectController() must - follow these calling restrictions. If any other agent wishes to call - Supported() it must also follow these calling restrictions. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to test - @param[in] RemainingDevicePath Optional parameter use to pick a specific child - device to start. - - @retval EFI_SUCCESS This driver supports this device - @retval EFI_ALREADY_STARTED This driver is already running on this device - @retval other This driver does not support this device - -**/ -EFI_STATUS -EFIAPI -Udp4DriverBindingSupported ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL - ) -{ - EFI_STATUS Status; - - // - // Test for the Udp4ServiceBinding Protocol - // - Status = gBS->OpenProtocol ( - ControllerHandle, - &gEfiUdp4ServiceBindingProtocolGuid, - NULL, - This->DriverBindingHandle, - ControllerHandle, - EFI_OPEN_PROTOCOL_TEST_PROTOCOL - ); - if (!EFI_ERROR (Status)) { - return EFI_ALREADY_STARTED; - } - - // - // Test for the Ip4 Protocol - // - Status = gBS->OpenProtocol ( - ControllerHandle, - &gEfiIp4ServiceBindingProtocolGuid, - NULL, - This->DriverBindingHandle, - ControllerHandle, - EFI_OPEN_PROTOCOL_TEST_PROTOCOL - ); - - return Status; -} - - -/** - Start this driver on ControllerHandle. This service is called by the - EFI boot service ConnectController(). In order to make - drivers as small as possible, there are a few calling restrictions for - this service. ConnectController() must follow these - calling restrictions. If any other agent wishes to call Start() it - must also follow these calling restrictions. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to bind driver to - @param[in] RemainingDevicePath Optional parameter use to pick a specific child - device to start. - - @retval EFI_SUCCESS This driver is added to ControllerHandle - @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle - @retval other This driver does not support this device - -**/ -EFI_STATUS -EFIAPI -Udp4DriverBindingStart ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL - ) -{ - EFI_STATUS Status; - UDP4_SERVICE_DATA *Udp4Service; - - // - // Allocate Private Context Data Structure. - // - Udp4Service = AllocatePool (sizeof (UDP4_SERVICE_DATA)); - if (Udp4Service == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - Status = Udp4CreateService (Udp4Service, This->DriverBindingHandle, ControllerHandle); - if (EFI_ERROR (Status)) { - FreePool (Udp4Service); - return Status; - } - - // - // Install the Udp4ServiceBindingProtocol on the ControllerHandle. - // - Status = gBS->InstallMultipleProtocolInterfaces ( - &ControllerHandle, - &gEfiUdp4ServiceBindingProtocolGuid, - &Udp4Service->ServiceBinding, - NULL - ); - if (EFI_ERROR (Status)) { - Udp4CleanService (Udp4Service); - FreePool (Udp4Service); - } - - return Status; -} - - -/** - Stop this driver on ControllerHandle. This service is called by the - EFI boot service DisconnectController(). In order to - make drivers as small as possible, there are a few calling - restrictions for this service. DisconnectController() - must follow these calling restrictions. If any other agent wishes - to call Stop() it must also follow these calling restrictions. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to stop driver on - @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number of - children is zero stop the entire bus driver. - @param[in] ChildHandleBuffer List of Child Handles to Stop. - - @retval EFI_SUCCESS This driver is removed ControllerHandle - @retval other This driver was not removed from this device - -**/ -EFI_STATUS -EFIAPI -Udp4DriverBindingStop ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN UINTN NumberOfChildren, - IN EFI_HANDLE *ChildHandleBuffer - ) -{ - EFI_STATUS Status; - EFI_HANDLE NicHandle; - EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; - UDP4_SERVICE_DATA *Udp4Service; - UDP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT Context; - LIST_ENTRY *List; - - // - // Find the NicHandle where UDP4 ServiceBinding Protocol is installed. - // - NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiIp4ProtocolGuid); - if (NicHandle == NULL) { - return EFI_SUCCESS; - } - - // - // Retrieve the UDP4 ServiceBinding Protocol. - // - Status = gBS->OpenProtocol ( - NicHandle, - &gEfiUdp4ServiceBindingProtocolGuid, - (VOID **) &ServiceBinding, - This->DriverBindingHandle, - NicHandle, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - if (EFI_ERROR (Status)) { - return EFI_DEVICE_ERROR; - } - - Udp4Service = UDP4_SERVICE_DATA_FROM_THIS (ServiceBinding); - if (NumberOfChildren != 0) { - // - // NumberOfChildren is not zero, destroy the children instances in ChildHandleBuffer. - // - List = &Udp4Service->ChildrenList; - Context.ServiceBinding = ServiceBinding; - Context.NumberOfChildren = NumberOfChildren; - Context.ChildHandleBuffer = ChildHandleBuffer; - Status = NetDestroyLinkList ( - List, - Udp4DestroyChildEntryInHandleBuffer, - &Context, - NULL - ); - } else { - gBS->UninstallMultipleProtocolInterfaces ( - NicHandle, - &gEfiUdp4ServiceBindingProtocolGuid, - &Udp4Service->ServiceBinding, - NULL - ); - - Udp4CleanService (Udp4Service); - - if (gUdpControllerNameTable != NULL) { - FreeUnicodeStringTable (gUdpControllerNameTable); - gUdpControllerNameTable = NULL; - } - FreePool (Udp4Service); - } - - return Status; -} - - -/** - Creates a child handle and installs a protocol. - - The CreateChild() function installs a protocol on ChildHandle. - If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. - If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle. - - @param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. - @param[in] ChildHandle Pointer to the handle of the child to create. If it is NULL, - then a new handle is created. If it is a pointer to an existing UEFI handle, - then the protocol is added to the existing UEFI handle. - - @retval EFI_SUCCES The protocol was added to ChildHandle. - @retval EFI_INVALID_PARAMETER ChildHandle is NULL. - @retval EFI_OUT_OF_RESOURCES There are not enough resources available to create - the child - @retval other The child handle was not created - -**/ -EFI_STATUS -EFIAPI -Udp4ServiceBindingCreateChild ( - IN EFI_SERVICE_BINDING_PROTOCOL *This, - IN EFI_HANDLE *ChildHandle - ) -{ - EFI_STATUS Status; - UDP4_SERVICE_DATA *Udp4Service; - UDP4_INSTANCE_DATA *Instance; - EFI_TPL OldTpl; - VOID *Ip4; - - if ((This == NULL) || (ChildHandle == NULL)) { - return EFI_INVALID_PARAMETER; - } - - Udp4Service = UDP4_SERVICE_DATA_FROM_THIS (This); - - // - // Allocate the instance private data structure. - // - Instance = AllocateZeroPool (sizeof (UDP4_INSTANCE_DATA)); - if (Instance == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - Udp4InitInstance (Udp4Service, Instance); - - // - // Add an IpInfo for this instance. - // - Instance->IpInfo = IpIoAddIp (Udp4Service->IpIo); - if (Instance->IpInfo == NULL) { - Status = EFI_OUT_OF_RESOURCES; - goto ON_ERROR; - } - - // - // Install the Udp4Protocol for this instance. - // - Status = gBS->InstallMultipleProtocolInterfaces ( - ChildHandle, - &gEfiUdp4ProtocolGuid, - &Instance->Udp4Proto, - NULL - ); - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - Instance->ChildHandle = *ChildHandle; - - // - // Open the default Ip4 protocol in the IP_IO BY_CHILD. - // - Status = gBS->OpenProtocol ( - Udp4Service->IpIo->ChildHandle, - &gEfiIp4ProtocolGuid, - (VOID **) &Ip4, - gUdp4DriverBinding.DriverBindingHandle, - Instance->ChildHandle, - EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER - ); - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - // - // Open this instance's Ip4 protocol in the IpInfo BY_CHILD. - // - Status = gBS->OpenProtocol ( - Instance->IpInfo->ChildHandle, - &gEfiIp4ProtocolGuid, - (VOID **) &Ip4, - gUdp4DriverBinding.DriverBindingHandle, - Instance->ChildHandle, - EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER - ); - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - // - // Link this instance into the service context data and increase the ChildrenNumber. - // - InsertTailList (&Udp4Service->ChildrenList, &Instance->Link); - Udp4Service->ChildrenNumber++; - - gBS->RestoreTPL (OldTpl); - - return EFI_SUCCESS; - -ON_ERROR: - - if (Instance->ChildHandle != NULL) { - gBS->UninstallMultipleProtocolInterfaces ( - Instance->ChildHandle, - &gEfiUdp4ProtocolGuid, - &Instance->Udp4Proto, - NULL - ); - } - - if (Instance->IpInfo != NULL) { - IpIoRemoveIp (Udp4Service->IpIo, Instance->IpInfo); - } - - Udp4CleanInstance (Instance); - - FreePool (Instance); - - return Status; -} - - -/** - Destroys a child handle with a protocol installed on it. - - The DestroyChild() function does the opposite of CreateChild(). It removes a protocol - that was installed by CreateChild() from ChildHandle. If the removed protocol is the - last protocol on ChildHandle, then ChildHandle is destroyed. - - @param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. - @param[in] ChildHandle Handle of the child to destroy - - @retval EFI_SUCCES The protocol was removed from ChildHandle. - @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed. - @retval EFI_INVALID_PARAMETER Child handle is NULL. - @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle - because its services are being used. - @retval other The child handle was not destroyed - -**/ -EFI_STATUS -EFIAPI -Udp4ServiceBindingDestroyChild ( - IN EFI_SERVICE_BINDING_PROTOCOL *This, - IN EFI_HANDLE ChildHandle - ) -{ - EFI_STATUS Status; - UDP4_SERVICE_DATA *Udp4Service; - EFI_UDP4_PROTOCOL *Udp4Proto; - UDP4_INSTANCE_DATA *Instance; - EFI_TPL OldTpl; - - if ((This == NULL) || (ChildHandle == NULL)) { - return EFI_INVALID_PARAMETER; - } - - Udp4Service = UDP4_SERVICE_DATA_FROM_THIS (This); - - // - // Try to get the Udp4 protocol from the ChildHandle. - // - Status = gBS->OpenProtocol ( - ChildHandle, - &gEfiUdp4ProtocolGuid, - (VOID **) &Udp4Proto, - gUdp4DriverBinding.DriverBindingHandle, - ChildHandle, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - if (EFI_ERROR (Status)) { - return EFI_UNSUPPORTED; - } - - Instance = UDP4_INSTANCE_DATA_FROM_THIS (Udp4Proto); - - if (Instance->InDestroy) { - return EFI_SUCCESS; - } - - // - // Use the Destroyed flag to avoid the re-entering of the following code. - // - Instance->InDestroy = TRUE; - - // - // Close the Ip4 protocol. - // - gBS->CloseProtocol ( - Udp4Service->IpIo->ChildHandle, - &gEfiIp4ProtocolGuid, - gUdp4DriverBinding.DriverBindingHandle, - Instance->ChildHandle - ); - // - // Close the Ip4 protocol on this instance's IpInfo. - // - gBS->CloseProtocol ( - Instance->IpInfo->ChildHandle, - &gEfiIp4ProtocolGuid, - gUdp4DriverBinding.DriverBindingHandle, - Instance->ChildHandle - ); - - // - // Uninstall the Udp4Protocol previously installed on the ChildHandle. - // - Status = gBS->UninstallMultipleProtocolInterfaces ( - ChildHandle, - &gEfiUdp4ProtocolGuid, - (VOID *) &Instance->Udp4Proto, - NULL - ); - if (EFI_ERROR (Status)) { - Instance->InDestroy = FALSE; - return Status; - } - - // - // Reset the configuration in case the instance's consumer forgets to do this. - // - Udp4Proto->Configure (Udp4Proto, NULL); - - // - // Remove the IpInfo this instance consumes. - // - IpIoRemoveIp (Udp4Service->IpIo, Instance->IpInfo); - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - // - // Remove this instance from the service context data's ChildrenList. - // - RemoveEntryList (&Instance->Link); - Udp4Service->ChildrenNumber--; - - // - // Clean the instance. - // - Udp4CleanInstance (Instance); - - gBS->RestoreTPL (OldTpl); - - FreePool (Instance); - - return EFI_SUCCESS; -} - -/** - This is the declaration of an EFI image entry point. This entry point is - the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including - both device drivers and bus drivers. - - The entry point for Udp4 driver which installs the driver binding - and component name protocol on its ImageHandle. - - @param[in] ImageHandle The firmware allocated handle for the UEFI image. - @param[in] SystemTable A pointer to the EFI System Table. - - @retval EFI_SUCCESS The operation completed successfully. - @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. - -**/ -EFI_STATUS -EFIAPI -Udp4DriverEntryPoint ( - IN EFI_HANDLE ImageHandle, - IN EFI_SYSTEM_TABLE *SystemTable - ) -{ - EFI_STATUS Status; - - // - // Install the Udp4DriverBinding and Udp4ComponentName protocols. - // - Status = EfiLibInstallDriverBindingComponentName2 ( - ImageHandle, - SystemTable, - &gUdp4DriverBinding, - ImageHandle, - &gUdp4ComponentName, - &gUdp4ComponentName2 - ); - if (!EFI_ERROR (Status)) { - // - // Initialize the UDP random port. - // - mUdp4RandomPort = (UINT16) (((UINT16) NetRandomInitSeed ()) % UDP4_PORT_KNOWN + UDP4_PORT_KNOWN); - } - - return Status; -} - diff --git a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Driver.h b/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Driver.h deleted file mode 100644 index 4e9a0c7356..0000000000 --- a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Driver.h +++ /dev/null @@ -1,148 +0,0 @@ -/** @file - -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef _UDP4_DRIVER_H_ -#define _UDP4_DRIVER_H_ - -#include -#include -#include -#include -#include - -/** - Test to see if this driver supports ControllerHandle. This service - is called by the EFI boot service ConnectController(). In - order to make drivers as small as possible, there are a few calling - restrictions for this service. ConnectController() must - follow these calling restrictions. If any other agent wishes to call - Supported() it must also follow these calling restrictions. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to test - @param[in] RemainingDevicePath Optional parameter use to pick a specific child - device to start. - - @retval EFI_SUCCESS This driver supports this device - @retval EFI_ALREADY_STARTED This driver is already running on this device - @retval other This driver does not support this device - -**/ -EFI_STATUS -EFIAPI -Udp4DriverBindingSupported ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL - ); - -/** - Start this driver on ControllerHandle. This service is called by the - EFI boot service ConnectController(). In order to make - drivers as small as possible, there are a few calling restrictions for - this service. ConnectController() must follow these - calling restrictions. If any other agent wishes to call Start() it - must also follow these calling restrictions. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to bind driver to - @param[in] RemainingDevicePath Optional parameter use to pick a specific child - device to start. - - @retval EFI_SUCCESS This driver is added to ControllerHandle - @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle - @retval other This driver does not support this device - -**/ -EFI_STATUS -EFIAPI -Udp4DriverBindingStart ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL - ); - -/** - Stop this driver on ControllerHandle. This service is called by the - EFI boot service DisconnectController(). In order to - make drivers as small as possible, there are a few calling - restrictions for this service. DisconnectController() - must follow these calling restrictions. If any other agent wishes - to call Stop() it must also follow these calling restrictions. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to stop driver on - @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number of - children is zero stop the entire bus driver. - @param[in] ChildHandleBuffer List of Child Handles to Stop. - - @retval EFI_SUCCESS This driver is removed ControllerHandle - @retval other This driver was not removed from this device - -**/ -EFI_STATUS -EFIAPI -Udp4DriverBindingStop ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN UINTN NumberOfChildren, - IN EFI_HANDLE *ChildHandleBuffer - ); - -/** - Creates a child handle and installs a protocol. - - The CreateChild() function installs a protocol on ChildHandle. - If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. - If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle. - - @param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. - @param[in] ChildHandle Pointer to the handle of the child to create. If it is NULL, - then a new handle is created. If it is a pointer to an existing UEFI handle, - then the protocol is added to the existing UEFI handle. - - @retval EFI_SUCCES The protocol was added to ChildHandle. - @retval EFI_INVALID_PARAMETER ChildHandle is NULL. - @retval EFI_OUT_OF_RESOURCES There are not enough resources available to create - the child - @retval other The child handle was not created - -**/ -EFI_STATUS -EFIAPI -Udp4ServiceBindingCreateChild ( - IN EFI_SERVICE_BINDING_PROTOCOL *This, - IN EFI_HANDLE *ChildHandle - ); - -/** - Destroys a child handle with a protocol installed on it. - - The DestroyChild() function does the opposite of CreateChild(). It removes a protocol - that was installed by CreateChild() from ChildHandle. If the removed protocol is the - last protocol on ChildHandle, then ChildHandle is destroyed. - - @param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. - @param[in] ChildHandle Handle of the child to destroy - - @retval EFI_SUCCES The protocol was removed from ChildHandle. - @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed. - @retval EFI_INVALID_PARAMETER Child handle is NULL. - @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle - because its services are being used. - @retval other The child handle was not destroyed - -**/ -EFI_STATUS -EFIAPI -Udp4ServiceBindingDestroyChild ( - IN EFI_SERVICE_BINDING_PROTOCOL *This, - IN EFI_HANDLE ChildHandle - ); - -#endif - diff --git a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Dxe.inf b/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Dxe.inf deleted file mode 100644 index ba623a6637..0000000000 --- a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Dxe.inf +++ /dev/null @@ -1,64 +0,0 @@ -## @file -# This module produces EFI UDP Protocol and EFI UDPv4 Service Binding Protocol. -# -# This module produces EFI UDP(User Datagram Protocol) Protocol upon EFI IPv4 -# Protocol, to provide basic UDPv4 I/O services. -# -# Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-# SPDX-License-Identifier: BSD-2-Clause-Patent -# -# -## - -[Defines] - INF_VERSION = 0x00010005 - BASE_NAME = Udp4Dxe - MODULE_UNI_FILE = Udp4Dxe.uni - FILE_GUID = 6d6963ab-906d-4a65-a7ca-bd40e5d6af2b - MODULE_TYPE = UEFI_DRIVER - VERSION_STRING = 1.0 - ENTRY_POINT = Udp4DriverEntryPoint - UNLOAD_IMAGE = NetLibDefaultUnload -# -# The following information is for reference only and not required by the build tools. -# -# VALID_ARCHITECTURES = IA32 X64 EBC -# -# DRIVER_BINDING = gUdp4DriverBinding -# COMPONENT_NAME = gUdp4ComponentName -# COMPONENT_NAME2 = gUdp4ComponentName2 -# - -[Sources] - Udp4Impl.h - Udp4Main.c - ComponentName.c - Udp4Impl.c - Udp4Driver.h - Udp4Driver.c - - -[Packages] - MdePkg/MdePkg.dec - MdeModulePkg/MdeModulePkg.dec - - -[LibraryClasses] - UefiLib - BaseLib - UefiBootServicesTableLib - UefiDriverEntryPoint - UefiRuntimeServicesTableLib - DebugLib - IpIoLib - NetLib - DpcLib - -[Protocols] - gEfiUdp4ServiceBindingProtocolGuid ## BY_START - gEfiIp4ServiceBindingProtocolGuid ## TO_START - gEfiUdp4ProtocolGuid ## BY_START - gEfiIp4ProtocolGuid ## TO_START - -[UserExtensions.TianoCore."ExtraFiles"] - Udp4DxeExtra.uni diff --git a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Dxe.uni b/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Dxe.uni deleted file mode 100644 index 1e3e4aafe7..0000000000 --- a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Dxe.uni +++ /dev/null @@ -1,17 +0,0 @@ -// /** @file -// This module produces EFI UDP Protocol and EFI UDPv4 Service Binding Protocol. -// -// This module produces EFI UDP(User Datagram Protocol) Protocol upon EFI IPv4 -// Protocol, to provide basic UDPv4 I/O services. -// -// Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-// -// SPDX-License-Identifier: BSD-2-Clause-Patent -// -// **/ - - -#string STR_MODULE_ABSTRACT #language en-US "Produces EFI UDP Protocol and EFI UDPv4 Service Binding Protocol" - -#string STR_MODULE_DESCRIPTION #language en-US "This module produces EFI UDP(User Datagram Protocol) Protocol upon EFI IPv4 Protocol to provide basic UDPv4 I/O services." - diff --git a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4DxeExtra.uni b/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4DxeExtra.uni deleted file mode 100644 index b048ce31a5..0000000000 --- a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4DxeExtra.uni +++ /dev/null @@ -1,14 +0,0 @@ -// /** @file -// Udp4Dxe Localized Strings and Content -// -// Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.
-// -// SPDX-License-Identifier: BSD-2-Clause-Patent -// -// **/ - -#string STR_PROPERTIES_MODULE_NAME -#language en-US -"UDP v4 DXE Driver" - - diff --git a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Impl.c b/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Impl.c deleted file mode 100644 index fb1951fb13..0000000000 --- a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Impl.c +++ /dev/null @@ -1,1908 +0,0 @@ -/** @file - The implementation of the Udp4 protocol. - -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - - -#include "Udp4Impl.h" - -UINT16 mUdp4RandomPort; - -/** - This function checks and timeouts the I/O datagrams holding by the corresponding - service context. - - @param[in] Event The event this function registered to. - @param[in] Context The context data registered during the creation of - the Event. - -**/ -VOID -EFIAPI -Udp4CheckTimeout ( - IN EFI_EVENT Event, - IN VOID *Context - ); - -/** - This function finds the udp instance by the specified pair. - - @param[in] InstanceList Pointer to the head of the list linking the udp - instances. - @param[in] Address Pointer to the specified IPv4 address. - @param[in] Port The udp port number. - - @retval TRUE The specified pair is found. - @retval FALSE Otherwise. - -**/ -BOOLEAN -Udp4FindInstanceByPort ( - IN LIST_ENTRY *InstanceList, - IN EFI_IPv4_ADDRESS *Address, - IN UINT16 Port - ); - -/** - This function is the packet transmitting notify function registered to the IpIo - interface. It's called to signal the udp TxToken when IpIo layer completes the - transmitting of the udp datagram. - - @param[in] Status The completion status of the output udp datagram. - @param[in] Context Pointer to the context data. - @param[in] Sender Specify a pointer of EFI_IP4_PROTOCOL for sending. - @param[in] NotifyData Pointer to the notify data. - -**/ -VOID -EFIAPI -Udp4DgramSent ( - IN EFI_STATUS Status, - IN VOID *Context, - IN IP_IO_IP_PROTOCOL Sender, - IN VOID *NotifyData - ); - -/** - This function processes the received datagram passed up by the IpIo layer. - - @param[in] Status The status of this udp datagram. - @param[in] IcmpError The IcmpError code, only available when Status is - EFI_ICMP_ERROR. - @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA. - @param[in] Packet Pointer to the NET_BUF containing the received udp - datagram. - @param[in] Context Pointer to the context data. - -**/ -VOID -EFIAPI -Udp4DgramRcvd ( - IN EFI_STATUS Status, - IN UINT8 IcmpError, - IN EFI_NET_SESSION_DATA *NetSession, - IN NET_BUF *Packet, - IN VOID *Context - ); - -/** - This function cancels the token specified by Arg in the Map. This is a callback - used by Udp4InstanceCancelToken(). - - @param[in] Map Pointer to the NET_MAP. - @param[in] Item Pointer to the NET_MAP_ITEM. - @param[in] Arg Pointer to the token to be cancelled, if NULL, - the token specified by Item is cancelled. - - @retval EFI_SUCCESS The token is cancelled if Arg is NULL or the token - is not the same as that in the Item if Arg is not - NULL. - @retval EFI_ABORTED Arg is not NULL, and the token specified by Arg is - cancelled. - -**/ -EFI_STATUS -EFIAPI -Udp4CancelTokens ( - IN NET_MAP *Map, - IN NET_MAP_ITEM *Item, - IN VOID *Arg OPTIONAL - ); - -/** - This function matches the received udp datagram with the Instance. - - @param[in] Instance Pointer to the udp instance context data. - @param[in] Udp4Session Pointer to the EFI_UDP4_SESSION_DATA abstracted - from the received udp datagram. - - @retval TRUE The udp datagram matches the receiving requirments of the - udp Instance. - @retval FALSE Otherwise. - -**/ -BOOLEAN -Udp4MatchDgram ( - IN UDP4_INSTANCE_DATA *Instance, - IN EFI_UDP4_SESSION_DATA *Udp4Session - ); - -/** - This function removes the Wrap specified by Context and release relevant resources. - - @param[in] Event The Event this notify function registered to. - @param[in] Context Pointer to the context data. - -**/ -VOID -EFIAPI -Udp4RecycleRxDataWrap ( - IN EFI_EVENT Event, - IN VOID *Context - ); - -/** - This function wraps the Packet and the RxData. - - @param[in] Instance Pointer to the instance context data. - @param[in] Packet Pointer to the buffer containing the received - datagram. - @param[in] RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this - datagram. - - @return Pointer to the structure wrapping the RxData and the Packet. - -**/ -UDP4_RXDATA_WRAP * -Udp4WrapRxData ( - IN UDP4_INSTANCE_DATA *Instance, - IN NET_BUF *Packet, - IN EFI_UDP4_RECEIVE_DATA *RxData - ); - -/** - This function enqueues the received datagram into the instances' receiving queues. - - @param[in] Udp4Service Pointer to the udp service context data. - @param[in] Packet Pointer to the buffer containing the received - datagram. - @param[in] RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this - datagram. - - @return The times this datagram is enqueued. - -**/ -UINTN -Udp4EnqueueDgram ( - IN UDP4_SERVICE_DATA *Udp4Service, - IN NET_BUF *Packet, - IN EFI_UDP4_RECEIVE_DATA *RxData - ); - -/** - This function delivers the datagrams enqueued in the instances. - - @param[in] Udp4Service Pointer to the udp service context data. - -**/ -VOID -Udp4DeliverDgram ( - IN UDP4_SERVICE_DATA *Udp4Service - ); - -/** - This function demultiplexes the received udp datagram to the appropriate instances. - - @param[in] Udp4Service Pointer to the udp service context data. - @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA abstracted from - the received datagram. - @param[in] Packet Pointer to the buffer containing the received udp - datagram. - -**/ -VOID -Udp4Demultiplex ( - IN UDP4_SERVICE_DATA *Udp4Service, - IN EFI_NET_SESSION_DATA *NetSession, - IN NET_BUF *Packet - ); - -/** - This function handles the received Icmp Error message and demultiplexes it to the - instance. - - @param[in] Udp4Service Pointer to the udp service context data. - @param[in] IcmpError The icmp error code. - @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA abstracted - from the received Icmp Error packet. - @param[in] Packet Pointer to the Icmp Error packet. - -**/ -VOID -Udp4IcmpHandler ( - IN UDP4_SERVICE_DATA *Udp4Service, - IN UINT8 IcmpError, - IN EFI_NET_SESSION_DATA *NetSession, - IN NET_BUF *Packet - ); - -/** - This function builds and sends out a icmp port unreachable message. - - @param[in] IpIo Pointer to the IP_IO instance. - @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA of the packet - causes this icmp error message. - @param[in] Udp4Header Pointer to the udp header of the datagram causes - this icmp error message. - -**/ -VOID -Udp4SendPortUnreach ( - IN IP_IO *IpIo, - IN EFI_NET_SESSION_DATA *NetSession, - IN VOID *Udp4Header - ); - - -/** - Create the Udp service context data. - - @param[in, out] Udp4Service Pointer to the UDP4_SERVICE_DATA. - @param[in] ImageHandle The image handle of this udp4 driver. - @param[in] ControllerHandle The controller handle this udp4 driver binds on. - - @retval EFI_SUCCESS The udp4 service context data is created and - initialized. - @retval EFI_OUT_OF_RESOURCES Cannot allocate memory. - @retval other Other error occurs. - -**/ -EFI_STATUS -Udp4CreateService ( - IN OUT UDP4_SERVICE_DATA *Udp4Service, - IN EFI_HANDLE ImageHandle, - IN EFI_HANDLE ControllerHandle - ) -{ - EFI_STATUS Status; - IP_IO_OPEN_DATA OpenData; - EFI_IP4_CONFIG_DATA *Ip4ConfigData; - - ZeroMem (Udp4Service, sizeof (UDP4_SERVICE_DATA)); - - Udp4Service->Signature = UDP4_SERVICE_DATA_SIGNATURE; - Udp4Service->ServiceBinding = mUdp4ServiceBinding; - Udp4Service->ImageHandle = ImageHandle; - Udp4Service->ControllerHandle = ControllerHandle; - Udp4Service->ChildrenNumber = 0; - - InitializeListHead (&Udp4Service->ChildrenList); - - // - // Create the IpIo for this service context. - // - Udp4Service->IpIo = IpIoCreate (ImageHandle, ControllerHandle, IP_VERSION_4); - if (Udp4Service->IpIo == NULL) { - return EFI_OUT_OF_RESOURCES; - } - - // - // Set the OpenData used to open the IpIo. - // - Ip4ConfigData = &OpenData.IpConfigData.Ip4CfgData; - CopyMem (Ip4ConfigData, &mIp4IoDefaultIpConfigData, sizeof (EFI_IP4_CONFIG_DATA)); - Ip4ConfigData->AcceptBroadcast = TRUE; - OpenData.RcvdContext = (VOID *) Udp4Service; - OpenData.SndContext = NULL; - OpenData.PktRcvdNotify = Udp4DgramRcvd; - OpenData.PktSentNotify = Udp4DgramSent; - - // - // Configure and start the IpIo. - // - Status = IpIoOpen (Udp4Service->IpIo, &OpenData); - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - // - // Create the event for Udp timeout checking. - // - Status = gBS->CreateEvent ( - EVT_TIMER | EVT_NOTIFY_SIGNAL, - TPL_CALLBACK, - Udp4CheckTimeout, - Udp4Service, - &Udp4Service->TimeoutEvent - ); - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - // - // Start the timeout timer event. - // - Status = gBS->SetTimer ( - Udp4Service->TimeoutEvent, - TimerPeriodic, - UDP4_TIMEOUT_INTERVAL - ); - if (EFI_ERROR (Status)) { - goto ON_ERROR; - } - - return EFI_SUCCESS; - -ON_ERROR: - - if (Udp4Service->TimeoutEvent != NULL) { - gBS->CloseEvent (Udp4Service->TimeoutEvent); - } - - IpIoDestroy (Udp4Service->IpIo); - - return Status; -} - - -/** - Clean the Udp service context data. - - @param[in] Udp4Service Pointer to the UDP4_SERVICE_DATA. - -**/ -VOID -Udp4CleanService ( - IN UDP4_SERVICE_DATA *Udp4Service - ) -{ - // - // Cancel the TimeoutEvent timer. - // - gBS->SetTimer (Udp4Service->TimeoutEvent, TimerCancel, 0); - - // - // Close the TimeoutEvent timer. - // - gBS->CloseEvent (Udp4Service->TimeoutEvent); - - // - // Destroy the IpIo. - // - IpIoDestroy (Udp4Service->IpIo); -} - - -/** - This function checks and timeouts the I/O datagrams holding by the corresponding - service context. - - @param[in] Event The event this function registered to. - @param[in] Context The context data registered during the creation of - the Event. - -**/ -VOID -EFIAPI -Udp4CheckTimeout ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - UDP4_SERVICE_DATA *Udp4Service; - LIST_ENTRY *Entry; - UDP4_INSTANCE_DATA *Instance; - LIST_ENTRY *WrapEntry; - LIST_ENTRY *NextEntry; - UDP4_RXDATA_WRAP *Wrap; - - Udp4Service = (UDP4_SERVICE_DATA *) Context; - NET_CHECK_SIGNATURE (Udp4Service, UDP4_SERVICE_DATA_SIGNATURE); - - NET_LIST_FOR_EACH (Entry, &Udp4Service->ChildrenList) { - // - // Iterate all the instances belonging to this service context. - // - Instance = NET_LIST_USER_STRUCT (Entry, UDP4_INSTANCE_DATA, Link); - NET_CHECK_SIGNATURE (Instance, UDP4_INSTANCE_DATA_SIGNATURE); - - if (!Instance->Configured || (Instance->ConfigData.ReceiveTimeout == 0)) { - // - // Skip this instance if it's not configured or no receive timeout. - // - continue; - } - - NET_LIST_FOR_EACH_SAFE (WrapEntry, NextEntry, &Instance->RcvdDgramQue) { - // - // Iterate all the rxdatas belonging to this udp instance. - // - Wrap = NET_LIST_USER_STRUCT (WrapEntry, UDP4_RXDATA_WRAP, Link); - - // - // TimeoutTick unit is microsecond, MNP_TIMEOUT_CHECK_INTERVAL unit is 100ns. - // - if (Wrap->TimeoutTick < (UDP4_TIMEOUT_INTERVAL / 10)) { - // - // Remove this RxData if it timeouts. - // - Udp4RecycleRxDataWrap (NULL, (VOID *) Wrap); - } else { - Wrap->TimeoutTick -= (UDP4_TIMEOUT_INTERVAL / 10); - } - } - } -} - - -/** - This function intializes the new created udp instance. - - @param[in] Udp4Service Pointer to the UDP4_SERVICE_DATA. - @param[in, out] Instance Pointer to the un-initialized UDP4_INSTANCE_DATA. - -**/ -VOID -Udp4InitInstance ( - IN UDP4_SERVICE_DATA *Udp4Service, - IN OUT UDP4_INSTANCE_DATA *Instance - ) -{ - // - // Set the signature. - // - Instance->Signature = UDP4_INSTANCE_DATA_SIGNATURE; - - // - // Init the lists. - // - InitializeListHead (&Instance->Link); - InitializeListHead (&Instance->RcvdDgramQue); - InitializeListHead (&Instance->DeliveredDgramQue); - - // - // Init the NET_MAPs. - // - NetMapInit (&Instance->TxTokens); - NetMapInit (&Instance->RxTokens); - NetMapInit (&Instance->McastIps); - - // - // Save the pointer to the UDP4_SERVICE_DATA, and initialize other members. - // - Instance->Udp4Service = Udp4Service; - CopyMem (&Instance->Udp4Proto, &mUdp4Protocol, sizeof (Instance->Udp4Proto)); - Instance->IcmpError = EFI_SUCCESS; - Instance->Configured = FALSE; - Instance->IsNoMapping = FALSE; - Instance->InDestroy = FALSE; -} - - -/** - This function cleans the udp instance. - - @param[in] Instance Pointer to the UDP4_INSTANCE_DATA to clean. - -**/ -VOID -Udp4CleanInstance ( - IN UDP4_INSTANCE_DATA *Instance - ) -{ - NetMapClean (&Instance->McastIps); - NetMapClean (&Instance->RxTokens); - NetMapClean (&Instance->TxTokens); -} - - -/** - This function finds the udp instance by the specified pair. - - @param[in] InstanceList Pointer to the head of the list linking the udp - instances. - @param[in] Address Pointer to the specified IPv4 address. - @param[in] Port The udp port number. - - @retval TRUE The specified pair is found. - @retval FALSE Otherwise. - -**/ -BOOLEAN -Udp4FindInstanceByPort ( - IN LIST_ENTRY *InstanceList, - IN EFI_IPv4_ADDRESS *Address, - IN UINT16 Port - ) -{ - LIST_ENTRY *Entry; - UDP4_INSTANCE_DATA *Instance; - EFI_UDP4_CONFIG_DATA *ConfigData; - - NET_LIST_FOR_EACH (Entry, InstanceList) { - // - // Iterate all the udp instances. - // - Instance = NET_LIST_USER_STRUCT (Entry, UDP4_INSTANCE_DATA, Link); - ConfigData = &Instance->ConfigData; - - if (!Instance->Configured || ConfigData->AcceptAnyPort) { - // - // If the instance is not configured or the configdata of the instance indicates - // this instance accepts any port, skip it. - // - continue; - } - - if (EFI_IP4_EQUAL (&ConfigData->StationAddress, Address) && - (ConfigData->StationPort == Port)) { - // - // if both the address and the port are the same, return TRUE. - // - return TRUE; - } - } - - // - // return FALSE when matching fails. - // - return FALSE; -} - - -/** - This function tries to bind the udp instance according to the configured port - allocation strategy. - - @param[in] InstanceList Pointer to the head of the list linking the udp - instances. - @param[in, out] ConfigData Pointer to the ConfigData of the instance to be - bound. ConfigData->StationPort will be assigned - with an available port value on success. - - @retval EFI_SUCCESS The bound operation is completed successfully. - @retval EFI_ACCESS_DENIED The specified by the ConfigData is - already used by other instance. - @retval EFI_OUT_OF_RESOURCES No available port resources. - -**/ -EFI_STATUS -Udp4Bind ( - IN LIST_ENTRY *InstanceList, - IN OUT EFI_UDP4_CONFIG_DATA *ConfigData - ) -{ - EFI_IPv4_ADDRESS *StationAddress; - UINT16 StartPort; - - if (ConfigData->AcceptAnyPort) { - return EFI_SUCCESS; - } - - StationAddress = &ConfigData->StationAddress; - - if (ConfigData->StationPort != 0) { - - if (!ConfigData->AllowDuplicatePort && - Udp4FindInstanceByPort (InstanceList, StationAddress, ConfigData->StationPort)) { - // - // Do not allow duplicate port and the port is already used by other instance. - // - return EFI_ACCESS_DENIED; - } - } else { - // - // select a random port for this instance; - // - - if (ConfigData->AllowDuplicatePort) { - // - // Just pick up the random port if the instance allows duplicate port. - // - ConfigData->StationPort = mUdp4RandomPort; - } else { - - StartPort = mUdp4RandomPort; - - while (Udp4FindInstanceByPort(InstanceList, StationAddress, mUdp4RandomPort)) { - - mUdp4RandomPort++; - if (mUdp4RandomPort == 0) { - mUdp4RandomPort = UDP4_PORT_KNOWN; - } - - if (mUdp4RandomPort == StartPort) { - // - // No available port. - // - return EFI_OUT_OF_RESOURCES; - } - } - - ConfigData->StationPort = mUdp4RandomPort; - } - - mUdp4RandomPort++; - if (mUdp4RandomPort == 0) { - mUdp4RandomPort = UDP4_PORT_KNOWN; - } - } - - return EFI_SUCCESS; -} - - -/** - This function is used to check whether the NewConfigData has any un-reconfigurable - parameters changed compared to the OldConfigData. - - @param[in] OldConfigData Pointer to the current ConfigData the udp instance - uses. - @param[in] NewConfigData Pointer to the new ConfigData. - - @retval TRUE The instance is reconfigurable. - @retval FALSE Otherwise. - -**/ -BOOLEAN -Udp4IsReconfigurable ( - IN EFI_UDP4_CONFIG_DATA *OldConfigData, - IN EFI_UDP4_CONFIG_DATA *NewConfigData - ) -{ - if ((NewConfigData->AcceptAnyPort != OldConfigData->AcceptAnyPort) || - (NewConfigData->AcceptBroadcast != OldConfigData->AcceptBroadcast) || - (NewConfigData->AcceptPromiscuous != OldConfigData->AcceptPromiscuous) || - (NewConfigData->AllowDuplicatePort != OldConfigData->AllowDuplicatePort) - ) { - // - // The receiving filter parameters cannot be changed. - // - return FALSE; - } - - if ((!NewConfigData->AcceptAnyPort) && - (NewConfigData->StationPort != OldConfigData->StationPort) - ) { - // - // The port is not changeable. - // - return FALSE; - } - - if (!NewConfigData->AcceptPromiscuous) { - - if (NewConfigData->UseDefaultAddress != OldConfigData->UseDefaultAddress) { - // - // The NewConfigData differs to the old one on the UseDefaultAddress. - // - return FALSE; - } - - if (!NewConfigData->UseDefaultAddress && - (!EFI_IP4_EQUAL (&NewConfigData->StationAddress, &OldConfigData->StationAddress) || - !EFI_IP4_EQUAL (&NewConfigData->SubnetMask, &OldConfigData->SubnetMask)) - ) { - // - // If the instance doesn't use the default address, and the new address or - // new subnet mask is different from the old values. - // - return FALSE; - } - } - - if (!EFI_IP4_EQUAL (&NewConfigData->RemoteAddress, &OldConfigData->RemoteAddress)) { - // - // The remoteaddress is not the same. - // - return FALSE; - } - - if (!EFI_IP4_EQUAL (&NewConfigData->RemoteAddress, &mZeroIp4Addr) && - NewConfigData->RemotePort != OldConfigData->RemotePort - ) { - // - // The RemotePort differs if it's designated in the configdata. - // - return FALSE; - } - - // - // All checks pass, return TRUE. - // - return TRUE; -} - - -/** - This function builds the Ip4 configdata from the Udp4ConfigData. - - @param[in] Udp4ConfigData Pointer to the EFI_UDP4_CONFIG_DATA. - @param[in, out] Ip4ConfigData Pointer to the EFI_IP4_CONFIG_DATA. - -**/ -VOID -Udp4BuildIp4ConfigData ( - IN EFI_UDP4_CONFIG_DATA *Udp4ConfigData, - IN OUT EFI_IP4_CONFIG_DATA *Ip4ConfigData - ) -{ - CopyMem (Ip4ConfigData, &mIp4IoDefaultIpConfigData, sizeof (*Ip4ConfigData)); - - Ip4ConfigData->DefaultProtocol = EFI_IP_PROTO_UDP; - Ip4ConfigData->AcceptBroadcast = Udp4ConfigData->AcceptBroadcast; - Ip4ConfigData->AcceptPromiscuous = Udp4ConfigData->AcceptPromiscuous; - Ip4ConfigData->UseDefaultAddress = Udp4ConfigData->UseDefaultAddress; - CopyMem (&Ip4ConfigData->StationAddress, &Udp4ConfigData->StationAddress, sizeof (EFI_IPv4_ADDRESS)); - CopyMem (&Ip4ConfigData->SubnetMask, &Udp4ConfigData->SubnetMask, sizeof (EFI_IPv4_ADDRESS)); - - // - // use the -1 magic number to disable the receiving process of the ip instance. - // - Ip4ConfigData->ReceiveTimeout = (UINT32) (-1); -} - - -/** - This function validates the TxToken, it returns the error code according to the spec. - - @param[in] Instance Pointer to the udp instance context data. - @param[in] TxToken Pointer to the token to be checked. - - @retval EFI_SUCCESS The TxToken is valid. - @retval EFI_INVALID_PARAMETER One or more of the following are TRUE: This is - NULL. Token is NULL. Token.Event is NULL. - Token.Packet.TxData is NULL. - Token.Packet.TxData.FragmentCount is zero. - Token.Packet.TxData.DataLength is not equal to the - sum of fragment lengths. One or more of the - Token.Packet.TxData.FragmentTable[]. - FragmentLength fields is zero. One or more of the - Token.Packet.TxData.FragmentTable[]. - FragmentBuffer fields is NULL. - Token.Packet.TxData. GatewayAddress is not a - unicast IPv4 address if it is not NULL. One or - more IPv4 addresses in Token.Packet.TxData. - UdpSessionData are not valid unicast IPv4 - addresses if the UdpSessionData is not NULL. - @retval EFI_BAD_BUFFER_SIZE The data length is greater than the maximum UDP - packet size. - -**/ -EFI_STATUS -Udp4ValidateTxToken ( - IN UDP4_INSTANCE_DATA *Instance, - IN EFI_UDP4_COMPLETION_TOKEN *TxToken - ) -{ - EFI_UDP4_TRANSMIT_DATA *TxData; - UINT32 Index; - UINT32 TotalLen; - EFI_UDP4_CONFIG_DATA *ConfigData; - EFI_UDP4_SESSION_DATA *UdpSessionData; - IP4_ADDR SourceAddress; - IP4_ADDR GatewayAddress; - - if (TxToken->Event == NULL) { - return EFI_INVALID_PARAMETER; - } - - TxData = TxToken->Packet.TxData; - - if ((TxData == NULL) || (TxData->FragmentCount == 0)) { - return EFI_INVALID_PARAMETER; - } - - TotalLen = 0; - for (Index = 0; Index < TxData->FragmentCount; Index++) { - - if ((TxData->FragmentTable[Index].FragmentBuffer == NULL) || - (TxData->FragmentTable[Index].FragmentLength == 0)) { - // - // if the FragmentBuffer is NULL or the FragmentLeng is zero. - // - return EFI_INVALID_PARAMETER; - } - - TotalLen += TxData->FragmentTable[Index].FragmentLength; - } - - if (TotalLen != TxData->DataLength) { - // - // The TotalLen calculated by adding all the FragmentLeng doesn't equal to the - // DataLength. - // - return EFI_INVALID_PARAMETER; - } - - if (TxData->GatewayAddress != NULL) { - CopyMem (&GatewayAddress, TxData->GatewayAddress, sizeof (IP4_ADDR)); - - if (!Instance->ConfigData.UseDefaultAddress && - (EFI_NTOHL(Instance->ConfigData.SubnetMask) != 0) && - !NetIp4IsUnicast (NTOHL (GatewayAddress), EFI_NTOHL(Instance->ConfigData.SubnetMask))) { - // - // The specified GatewayAddress is not a unicast IPv4 address while it's not 0. - // - return EFI_INVALID_PARAMETER; - } - } - - ConfigData = &Instance->ConfigData; - UdpSessionData = TxData->UdpSessionData; - - if (UdpSessionData != NULL) { - - CopyMem (&SourceAddress, &UdpSessionData->SourceAddress, sizeof (IP4_ADDR)); - - if ((SourceAddress != 0) && - !Instance->ConfigData.UseDefaultAddress && - (EFI_NTOHL(Instance->ConfigData.SubnetMask) != 0) && - !NetIp4IsUnicast (HTONL (SourceAddress), EFI_NTOHL(Instance->ConfigData.SubnetMask))) { - // - // Check whether SourceAddress is a valid IPv4 address in case it's not zero. - // The configured station address is used if SourceAddress is zero. - // - return EFI_INVALID_PARAMETER; - } - - if ((UdpSessionData->DestinationPort == 0) && (ConfigData->RemotePort == 0)) { - // - // Ambiguous, no avalaible DestinationPort for this token. - // - return EFI_INVALID_PARAMETER; - } - - if (EFI_IP4_EQUAL (&UdpSessionData->DestinationAddress, &mZeroIp4Addr)) { - // - // The DestinationAddress specified in the UdpSessionData is 0. - // - return EFI_INVALID_PARAMETER; - } - } else if (EFI_IP4_EQUAL (&ConfigData->RemoteAddress, &mZeroIp4Addr)) { - // - // the configured RemoteAddress is all zero, and the user doens't override the - // destination address. - // - return EFI_INVALID_PARAMETER; - } - - if (TxData->DataLength > UDP4_MAX_DATA_SIZE) { - return EFI_BAD_BUFFER_SIZE; - } - - return EFI_SUCCESS; -} - - -/** - This function checks whether the specified Token duplicates with the one in the Map. - - @param[in] Map Pointer to the NET_MAP. - @param[in] Item Pointer to the NET_MAP_ITEM contain the pointer to - the Token. - @param[in] Context Pointer to the Token to be checked. - - @retval EFI_SUCCESS The Token specified by Context differs from the - one in the Item. - @retval EFI_ACCESS_DENIED The Token duplicates with the one in the Item. - -**/ -EFI_STATUS -EFIAPI -Udp4TokenExist ( - IN NET_MAP *Map, - IN NET_MAP_ITEM *Item, - IN VOID *Context - ) -{ - EFI_UDP4_COMPLETION_TOKEN *Token; - EFI_UDP4_COMPLETION_TOKEN *TokenInItem; - - Token = (EFI_UDP4_COMPLETION_TOKEN*) Context; - TokenInItem = (EFI_UDP4_COMPLETION_TOKEN*) Item->Key; - - if ((Token == TokenInItem) || (Token->Event == TokenInItem->Event)) { - // - // The Token duplicates with the TokenInItem in case either the two pointers are the - // same or the Events of these two tokens are the same. - // - return EFI_ACCESS_DENIED; - } - - return EFI_SUCCESS; -} - - -/** - This function calculates the checksum for the Packet, utilizing the pre-calculated - pseudo HeadSum to reduce some overhead. - - @param[in] Packet Pointer to the NET_BUF contains the udp datagram. - @param[in] HeadSum Checksum of the pseudo header execpt the length - field. - - @retval The 16-bit checksum of this udp datagram. - -**/ -UINT16 -Udp4Checksum ( - IN NET_BUF *Packet, - IN UINT16 HeadSum - ) -{ - UINT16 Checksum; - - Checksum = NetbufChecksum (Packet); - Checksum = NetAddChecksum (Checksum, HeadSum); - - Checksum = NetAddChecksum (Checksum, HTONS ((UINT16) Packet->TotalSize)); - - return (UINT16) ~Checksum; -} - - -/** - This function removes the specified Token from the TokenMap. - - @param[in, out] TokenMap Pointer to the NET_MAP containing the tokens. - @param[in] Token Pointer to the Token to be removed. - - @retval EFI_SUCCESS The specified Token is removed from the TokenMap. - @retval EFI_NOT_FOUND The specified Token is not found in the TokenMap. - -**/ -EFI_STATUS -Udp4RemoveToken ( - IN OUT NET_MAP *TokenMap, - IN EFI_UDP4_COMPLETION_TOKEN *Token - ) -{ - NET_MAP_ITEM *Item; - - // - // Find the Token first. - // - Item = NetMapFindKey (TokenMap, (VOID *) Token); - - if (Item != NULL) { - // - // Remove the token if it's found in the map. - // - NetMapRemoveItem (TokenMap, Item, NULL); - - return EFI_SUCCESS; - } - - return EFI_NOT_FOUND; -} - - -/** - This function is the packet transmitting notify function registered to the IpIo - interface. It's called to signal the udp TxToken when IpIo layer completes the - transmitting of the udp datagram. - - @param[in] Status The completion status of the output udp datagram. - @param[in] Context Pointer to the context data. - @param[in] Sender Specify a pointer of EFI_IP4_PROTOCOL for sending. - @param[in] NotifyData Pointer to the notify data. - -**/ -VOID -EFIAPI -Udp4DgramSent ( - IN EFI_STATUS Status, - IN VOID *Context, - IN IP_IO_IP_PROTOCOL Sender, - IN VOID *NotifyData - ) -{ - UDP4_INSTANCE_DATA *Instance; - EFI_UDP4_COMPLETION_TOKEN *Token; - - Instance = (UDP4_INSTANCE_DATA *) Context; - Token = (EFI_UDP4_COMPLETION_TOKEN *) NotifyData; - - if (Udp4RemoveToken (&Instance->TxTokens, Token) == EFI_SUCCESS) { - // - // The token may be cancelled. Only signal it if the remove operation succeeds. - // - Token->Status = Status; - gBS->SignalEvent (Token->Event); - DispatchDpc (); - } -} - - -/** - This function processes the received datagram passed up by the IpIo layer. - - @param[in] Status The status of this udp datagram. - @param[in] IcmpError The IcmpError code, only available when Status is - EFI_ICMP_ERROR. - @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA. - @param[in] Packet Pointer to the NET_BUF containing the received udp - datagram. - @param[in] Context Pointer to the context data. - -**/ -VOID -EFIAPI -Udp4DgramRcvd ( - IN EFI_STATUS Status, - IN UINT8 IcmpError, - IN EFI_NET_SESSION_DATA *NetSession, - IN NET_BUF *Packet, - IN VOID *Context - ) -{ - NET_CHECK_SIGNATURE (Packet, NET_BUF_SIGNATURE); - - // - // IpIo only passes received packets with Status EFI_SUCCESS or EFI_ICMP_ERROR. - // - if (Status == EFI_SUCCESS) { - // - // Demultiplex the received datagram. - // - Udp4Demultiplex ((UDP4_SERVICE_DATA *) Context, NetSession, Packet); - } else { - // - // Handle the ICMP_ERROR packet. - // - Udp4IcmpHandler ((UDP4_SERVICE_DATA *) Context, IcmpError, NetSession, Packet); - } - - // - // Dispatch the DPC queued by the NotifyFunction of the rx token's events - // which are signaled with received data. - // - DispatchDpc (); -} - - -/** - This function removes the multicast group specified by Arg from the Map. - - @param[in, out] Map Pointer to the NET_MAP. - @param[in] Item Pointer to the NET_MAP_ITEM. - @param[in] Arg Pointer to the Arg, it's the pointer to a - multicast IPv4 Address. - - @retval EFI_SUCCESS The multicast address is removed. - @retval EFI_ABORTED The specified multicast address is removed and the - Arg is not NULL. - -**/ -EFI_STATUS -EFIAPI -Udp4LeaveGroup ( - IN OUT NET_MAP *Map, - IN NET_MAP_ITEM *Item, - IN VOID *Arg OPTIONAL - ) -{ - EFI_IPv4_ADDRESS *McastIp; - - McastIp = Arg; - - if ((McastIp != NULL) && (!EFI_IP4_EQUAL (McastIp, &(Item->Key)))) { - // - // McastIp is not NULL and the multicast address contained in the Item - // is not the same as McastIp. - // - return EFI_SUCCESS; - } - - // - // Remove this Item. - // - NetMapRemoveItem (Map, Item, NULL); - - if (McastIp != NULL) { - // - // Return EFI_ABORTED in case McastIp is not NULL to terminate the iteration. - // - return EFI_ABORTED; - } - - return EFI_SUCCESS; -} - - -/** - This function cancels the token specified by Arg in the Map. This is a callback - used by Udp4InstanceCancelToken(). - - @param[in] Map Pointer to the NET_MAP. - @param[in] Item Pointer to the NET_MAP_ITEM. - @param[in] Arg Pointer to the token to be cancelled, if NULL, - the token specified by Item is cancelled. - - @retval EFI_SUCCESS The token is cancelled if Arg is NULL or the token - is not the same as that in the Item if Arg is not - NULL. - @retval EFI_ABORTED Arg is not NULL, and the token specified by Arg is - cancelled. - -**/ -EFI_STATUS -EFIAPI -Udp4CancelTokens ( - IN NET_MAP *Map, - IN NET_MAP_ITEM *Item, - IN VOID *Arg OPTIONAL - ) -{ - EFI_UDP4_COMPLETION_TOKEN *TokenToCancel; - NET_BUF *Packet; - IP_IO *IpIo; - - if ((Arg != NULL) && (Item->Key != Arg)) { - return EFI_SUCCESS; - } - - if (Item->Value != NULL) { - // - // If the token is a transmit token, the corresponding Packet is recorded in - // Item->Value, invoke IpIo to cancel this packet first. The IpIoCancelTxToken - // will invoke Udp4DgramSent, the token will be signaled and this Item will - // be removed from the Map there. - // - Packet = (NET_BUF *) (Item->Value); - IpIo = (IP_IO *) (*((UINTN *) &Packet->ProtoData[0])); - - IpIoCancelTxToken (IpIo, Packet); - } else { - // - // The token is a receive token. Abort it and remove it from the Map. - // - TokenToCancel = (EFI_UDP4_COMPLETION_TOKEN *) Item->Key; - NetMapRemoveItem (Map, Item, NULL); - - TokenToCancel->Status = EFI_ABORTED; - gBS->SignalEvent (TokenToCancel->Event); - } - - if (Arg != NULL) { - return EFI_ABORTED; - } - - return EFI_SUCCESS; -} - - -/** - This function removes all the Wrap datas in the RcvdDgramQue. - - @param[in] Instance Pointer to the udp instance context data. - -**/ -VOID -Udp4FlushRcvdDgram ( - IN UDP4_INSTANCE_DATA *Instance - ) -{ - UDP4_RXDATA_WRAP *Wrap; - - while (!IsListEmpty (&Instance->RcvdDgramQue)) { - // - // Iterate all the Wraps in the RcvdDgramQue. - // - Wrap = NET_LIST_HEAD (&Instance->RcvdDgramQue, UDP4_RXDATA_WRAP, Link); - - // - // The Wrap will be removed from the RcvdDgramQue by this function call. - // - Udp4RecycleRxDataWrap (NULL, (VOID *) Wrap); - } -} - - - -/** - Cancel Udp4 tokens from the Udp4 instance. - - @param[in] Instance Pointer to the udp instance context data. - @param[in] Token Pointer to the token to be canceled, if NULL, all - tokens in this instance will be cancelled. - - @retval EFI_SUCCESS The Token is cancelled. - @retval EFI_NOT_FOUND The Token is not found. - -**/ -EFI_STATUS -Udp4InstanceCancelToken ( - IN UDP4_INSTANCE_DATA *Instance, - IN EFI_UDP4_COMPLETION_TOKEN *Token OPTIONAL - ) -{ - EFI_STATUS Status; - - // - // Cancel this token from the TxTokens map. - // - Status = NetMapIterate (&Instance->TxTokens, Udp4CancelTokens, Token); - - if ((Token != NULL) && (Status == EFI_ABORTED)) { - // - // If Token isn't NULL and Status is EFI_ABORTED, the token is cancelled from - // the TxTokens, just return success. - // - return EFI_SUCCESS; - } - - // - // Try to cancel this token from the RxTokens map in condition either the Token - // is NULL or the specified Token is not in TxTokens. - // - Status = NetMapIterate (&Instance->RxTokens, Udp4CancelTokens, Token); - - if ((Token != NULL) && (Status == EFI_SUCCESS)) { - // - // If Token isn't NULL and Status is EFI_SUCCESS, the token is neither in the - // TxTokens nor the RxTokens, or say, it's not found. - // - return EFI_NOT_FOUND; - } - - ASSERT ((Token != NULL) || ((0 == NetMapGetCount (&Instance->TxTokens)) - && (0 == NetMapGetCount (&Instance->RxTokens)))); - - return EFI_SUCCESS; -} - - -/** - This function matches the received udp datagram with the Instance. - - @param[in] Instance Pointer to the udp instance context data. - @param[in] Udp4Session Pointer to the EFI_UDP4_SESSION_DATA abstracted - from the received udp datagram. - - @retval TRUE The udp datagram matches the receiving requirments of the - udp Instance. - @retval FALSE Otherwise. - -**/ -BOOLEAN -Udp4MatchDgram ( - IN UDP4_INSTANCE_DATA *Instance, - IN EFI_UDP4_SESSION_DATA *Udp4Session - ) -{ - EFI_UDP4_CONFIG_DATA *ConfigData; - IP4_ADDR Destination; - - ConfigData = &Instance->ConfigData; - - if (ConfigData->AcceptPromiscuous) { - // - // Always matches if this instance is in the promiscuous state. - // - return TRUE; - } - - if ((!ConfigData->AcceptAnyPort && (Udp4Session->DestinationPort != ConfigData->StationPort)) || - ((ConfigData->RemotePort != 0) && (Udp4Session->SourcePort != ConfigData->RemotePort)) - ) { - // - // The local port or the remote port doesn't match. - // - return FALSE; - } - - if (!EFI_IP4_EQUAL (&ConfigData->RemoteAddress, &mZeroIp4Addr) && - !EFI_IP4_EQUAL (&ConfigData->RemoteAddress, &Udp4Session->SourceAddress) - ) { - // - // This datagram doesn't come from the instance's specified sender. - // - return FALSE; - } - - if (EFI_IP4_EQUAL (&ConfigData->StationAddress, &mZeroIp4Addr) || - EFI_IP4_EQUAL (&Udp4Session->DestinationAddress, &ConfigData->StationAddress) - ) { - // - // The instance is configured to receive datagrams destined to any station IP or - // the destination address of this datagram matches the configured station IP. - // - return TRUE; - } - - CopyMem (&Destination, &Udp4Session->DestinationAddress, sizeof (IP4_ADDR)); - - if (IP4_IS_LOCAL_BROADCAST (Destination) && ConfigData->AcceptBroadcast) { - // - // The instance is configured to receive broadcast and this is a broadcast packet. - // - return TRUE; - } - - if (IP4_IS_MULTICAST (NTOHL (Destination)) && - NetMapFindKey (&Instance->McastIps, (VOID *) (UINTN) Destination) != NULL - ) { - // - // It's a multicast packet and the multicast address is accepted by this instance. - // - return TRUE; - } - - return FALSE; -} - - -/** - This function removes the Wrap specified by Context and release relevant resources. - - @param[in] Event The Event this notify function registered to. - @param[in] Context Pointer to the context data. - -**/ -VOID -EFIAPI -Udp4RecycleRxDataWrap ( - IN EFI_EVENT Event, - IN VOID *Context - ) -{ - UDP4_RXDATA_WRAP *Wrap; - - Wrap = (UDP4_RXDATA_WRAP *) Context; - - // - // Remove the Wrap from the list it belongs to. - // - RemoveEntryList (&Wrap->Link); - - // - // Free the Packet associated with this Wrap. - // - NetbufFree (Wrap->Packet); - - // - // Close the event. - // - gBS->CloseEvent (Wrap->RxData.RecycleSignal); - - FreePool (Wrap); -} - - -/** - This function wraps the Packet and the RxData. - - @param[in] Instance Pointer to the instance context data. - @param[in] Packet Pointer to the buffer containing the received - datagram. - @param[in] RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this - datagram. - - @return Pointer to the structure wrapping the RxData and the Packet. - -**/ -UDP4_RXDATA_WRAP * -Udp4WrapRxData ( - IN UDP4_INSTANCE_DATA *Instance, - IN NET_BUF *Packet, - IN EFI_UDP4_RECEIVE_DATA *RxData - ) -{ - EFI_STATUS Status; - UDP4_RXDATA_WRAP *Wrap; - - // - // Allocate buffer for the Wrap. - // - Wrap = AllocatePool (sizeof (UDP4_RXDATA_WRAP) + - (Packet->BlockOpNum - 1) * sizeof (EFI_UDP4_FRAGMENT_DATA)); - if (Wrap == NULL) { - return NULL; - } - - InitializeListHead (&Wrap->Link); - - CopyMem (&Wrap->RxData, RxData, sizeof (Wrap->RxData)); - - // - // Create the Recycle event. - // - Status = gBS->CreateEvent ( - EVT_NOTIFY_SIGNAL, - TPL_NOTIFY, - Udp4RecycleRxDataWrap, - Wrap, - &Wrap->RxData.RecycleSignal - ); - if (EFI_ERROR (Status)) { - FreePool (Wrap); - return NULL; - } - - Wrap->Packet = Packet; - Wrap->TimeoutTick = Instance->ConfigData.ReceiveTimeout; - - return Wrap; -} - - -/** - This function enqueues the received datagram into the instances' receiving queues. - - @param[in] Udp4Service Pointer to the udp service context data. - @param[in] Packet Pointer to the buffer containing the received - datagram. - @param[in] RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this - datagram. - - @return The times this datagram is enqueued. - -**/ -UINTN -Udp4EnqueueDgram ( - IN UDP4_SERVICE_DATA *Udp4Service, - IN NET_BUF *Packet, - IN EFI_UDP4_RECEIVE_DATA *RxData - ) -{ - LIST_ENTRY *Entry; - UDP4_INSTANCE_DATA *Instance; - UDP4_RXDATA_WRAP *Wrap; - UINTN Enqueued; - - Enqueued = 0; - - NET_LIST_FOR_EACH (Entry, &Udp4Service->ChildrenList) { - // - // Iterate the instances. - // - Instance = NET_LIST_USER_STRUCT (Entry, UDP4_INSTANCE_DATA, Link); - - if (!Instance->Configured) { - continue; - } - - if (Udp4MatchDgram (Instance, &RxData->UdpSession)) { - // - // Wrap the RxData and put this Wrap into the instances RcvdDgramQue. - // - Wrap = Udp4WrapRxData (Instance, Packet, RxData); - if (Wrap == NULL) { - continue; - } - - NET_GET_REF (Packet); - - InsertTailList (&Instance->RcvdDgramQue, &Wrap->Link); - - Enqueued++; - } - } - - return Enqueued; -} - - -/** - This function delivers the received datagrams for the specified instance. - - @param[in] Instance Pointer to the instance context data. - -**/ -VOID -Udp4InstanceDeliverDgram ( - IN UDP4_INSTANCE_DATA *Instance - ) -{ - UDP4_RXDATA_WRAP *Wrap; - EFI_UDP4_COMPLETION_TOKEN *Token; - NET_BUF *Dup; - EFI_UDP4_RECEIVE_DATA *RxData; - EFI_TPL OldTpl; - - if (!IsListEmpty (&Instance->RcvdDgramQue) && - !NetMapIsEmpty (&Instance->RxTokens)) { - - Wrap = NET_LIST_HEAD (&Instance->RcvdDgramQue, UDP4_RXDATA_WRAP, Link); - - if (NET_BUF_SHARED (Wrap->Packet)) { - // - // Duplicate the Packet if it is shared between instances. - // - Dup = NetbufDuplicate (Wrap->Packet, NULL, 0); - if (Dup == NULL) { - return; - } - - NetbufFree (Wrap->Packet); - - Wrap->Packet = Dup; - } - - NetListRemoveHead (&Instance->RcvdDgramQue); - - Token = (EFI_UDP4_COMPLETION_TOKEN *) NetMapRemoveHead (&Instance->RxTokens, NULL); - - // - // Build the FragmentTable and set the FragmentCount in RxData. - // - RxData = &Wrap->RxData; - RxData->FragmentCount = Wrap->Packet->BlockOpNum; - - NetbufBuildExt ( - Wrap->Packet, - (NET_FRAGMENT *) RxData->FragmentTable, - &RxData->FragmentCount - ); - - Token->Status = EFI_SUCCESS; - Token->Packet.RxData = &Wrap->RxData; - - OldTpl = gBS->RaiseTPL (TPL_NOTIFY); - InsertTailList (&Instance->DeliveredDgramQue, &Wrap->Link); - gBS->RestoreTPL (OldTpl); - - gBS->SignalEvent (Token->Event); - } -} - - -/** - This function delivers the datagrams enqueued in the instances. - - @param[in] Udp4Service Pointer to the udp service context data. - -**/ -VOID -Udp4DeliverDgram ( - IN UDP4_SERVICE_DATA *Udp4Service - ) -{ - LIST_ENTRY *Entry; - UDP4_INSTANCE_DATA *Instance; - - NET_LIST_FOR_EACH (Entry, &Udp4Service->ChildrenList) { - // - // Iterate the instances. - // - Instance = NET_LIST_USER_STRUCT (Entry, UDP4_INSTANCE_DATA, Link); - - if (!Instance->Configured) { - continue; - } - - // - // Deliver the datagrams of this instance. - // - Udp4InstanceDeliverDgram (Instance); - } -} - - -/** - This function demultiplexes the received udp datagram to the appropriate instances. - - @param[in] Udp4Service Pointer to the udp service context data. - @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA abstracted from - the received datagram. - @param[in] Packet Pointer to the buffer containing the received udp - datagram. - -**/ -VOID -Udp4Demultiplex ( - IN UDP4_SERVICE_DATA *Udp4Service, - IN EFI_NET_SESSION_DATA *NetSession, - IN NET_BUF *Packet - ) -{ - EFI_UDP_HEADER *Udp4Header; - UINT16 HeadSum; - EFI_UDP4_RECEIVE_DATA RxData; - EFI_UDP4_SESSION_DATA *Udp4Session; - UINTN Enqueued; - - if (Packet->TotalSize < sizeof (EFI_UDP_HEADER)) { - NetbufFree (Packet); - return; - } - - // - // Get the datagram header from the packet buffer. - // - Udp4Header = (EFI_UDP_HEADER *) NetbufGetByte (Packet, 0, NULL); - ASSERT (Udp4Header != NULL); - - if (Udp4Header->Checksum != 0) { - // - // check the checksum. - // - HeadSum = NetPseudoHeadChecksum ( - NetSession->Source.Addr[0], - NetSession->Dest.Addr[0], - EFI_IP_PROTO_UDP, - 0 - ); - - if (Udp4Checksum (Packet, HeadSum) != 0) { - // - // Wrong checksum. - // - NetbufFree (Packet); - return; - } - } - - Udp4Session = &RxData.UdpSession; - Udp4Session->SourcePort = NTOHS (Udp4Header->SrcPort); - Udp4Session->DestinationPort = NTOHS (Udp4Header->DstPort); - - CopyMem (&Udp4Session->SourceAddress, &NetSession->Source, sizeof (EFI_IPv4_ADDRESS)); - CopyMem (&Udp4Session->DestinationAddress, &NetSession->Dest, sizeof (EFI_IPv4_ADDRESS)); - - // - // Trim the UDP header. - // - NetbufTrim (Packet, UDP4_HEADER_SIZE, TRUE); - - RxData.DataLength = (UINT32) Packet->TotalSize; - - // - // Try to enqueue this datagram into the instances. - // - Enqueued = Udp4EnqueueDgram (Udp4Service, Packet, &RxData); - - if (Enqueued == 0) { - // - // Send the port unreachable ICMP packet before we free this NET_BUF - // - Udp4SendPortUnreach (Udp4Service->IpIo, NetSession, Udp4Header); - } - - // - // Try to free the packet before deliver it. - // - NetbufFree (Packet); - - if (Enqueued > 0) { - // - // Deliver the datagram. - // - Udp4DeliverDgram (Udp4Service); - } -} - - -/** - This function builds and sends out a icmp port unreachable message. - - @param[in] IpIo Pointer to the IP_IO instance. - @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA of the packet - causes this icmp error message. - @param[in] Udp4Header Pointer to the udp header of the datagram causes - this icmp error message. - -**/ -VOID -Udp4SendPortUnreach ( - IN IP_IO *IpIo, - IN EFI_NET_SESSION_DATA *NetSession, - IN VOID *Udp4Header - ) -{ - NET_BUF *Packet; - UINT32 Len; - IP4_ICMP_ERROR_HEAD *IcmpErrHdr; - EFI_IP4_HEADER *IpHdr; - UINT8 *Ptr; - IP_IO_OVERRIDE Override; - IP_IO_IP_INFO *IpSender; - - IpSender = IpIoFindSender (&IpIo, NetSession->IpVersion, &NetSession->Dest); - if (IpSender == NULL) { - // - // No appropriate sender, since we cannot send out the ICMP message through - // the default zero station address IP instance, abort. - // - return; - } - - IpHdr = NetSession->IpHdr.Ip4Hdr; - - // - // Calculate the required length of the icmp error message. - // - Len = sizeof (IP4_ICMP_ERROR_HEAD) + (EFI_IP4_HEADER_LEN (IpHdr) - - sizeof (IP4_HEAD)) + ICMP_ERROR_PACKET_LENGTH; - - // - // Allocate buffer for the icmp error message. - // - Packet = NetbufAlloc (Len); - if (Packet == NULL) { - return; - } - - // - // Allocate space for the IP4_ICMP_ERROR_HEAD. - // - IcmpErrHdr = (IP4_ICMP_ERROR_HEAD *) NetbufAllocSpace (Packet, Len, FALSE); - ASSERT (IcmpErrHdr != NULL); - - // - // Set the required fields for the icmp port unreachable message. - // - IcmpErrHdr->Head.Type = ICMP_TYPE_UNREACH; - IcmpErrHdr->Head.Code = ICMP_CODE_UNREACH_PORT; - IcmpErrHdr->Head.Checksum = 0; - IcmpErrHdr->Fourth = 0; - - // - // Copy the IP header of the datagram tragged the error. - // - CopyMem (&IcmpErrHdr->IpHead, IpHdr, EFI_IP4_HEADER_LEN (IpHdr)); - - // - // Copy the UDP header. - // - Ptr = (UINT8 *) &IcmpErrHdr->IpHead + EFI_IP4_HEADER_LEN (IpHdr); - CopyMem (Ptr, Udp4Header, ICMP_ERROR_PACKET_LENGTH); - - // - // Calculate the checksum. - // - IcmpErrHdr->Head.Checksum = (UINT16) ~(NetbufChecksum (Packet)); - - // - // Fill the override data. - // - Override.Ip4OverrideData.DoNotFragment = FALSE; - Override.Ip4OverrideData.TypeOfService = 0; - Override.Ip4OverrideData.TimeToLive = 255; - Override.Ip4OverrideData.Protocol = EFI_IP_PROTO_ICMP; - - CopyMem (&Override.Ip4OverrideData.SourceAddress, &NetSession->Dest, sizeof (EFI_IPv4_ADDRESS)); - ZeroMem (&Override.Ip4OverrideData.GatewayAddress, sizeof (EFI_IPv4_ADDRESS)); - - // - // Send out this icmp packet. - // - IpIoSend (IpIo, Packet, IpSender, NULL, NULL, &NetSession->Source, &Override); - - NetbufFree (Packet); -} - - -/** - This function handles the received Icmp Error message and demultiplexes it to the - instance. - - @param[in] Udp4Service Pointer to the udp service context data. - @param[in] IcmpError The icmp error code. - @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA abstracted - from the received Icmp Error packet. - @param[in] Packet Pointer to the Icmp Error packet. - -**/ -VOID -Udp4IcmpHandler ( - IN UDP4_SERVICE_DATA *Udp4Service, - IN UINT8 IcmpError, - IN EFI_NET_SESSION_DATA *NetSession, - IN NET_BUF *Packet - ) -{ - EFI_UDP_HEADER *Udp4Header; - EFI_UDP4_SESSION_DATA Udp4Session; - LIST_ENTRY *Entry; - UDP4_INSTANCE_DATA *Instance; - - if (Packet->TotalSize < sizeof (EFI_UDP_HEADER)) { - NetbufFree (Packet); - return; - } - - Udp4Header = (EFI_UDP_HEADER *) NetbufGetByte (Packet, 0, NULL); - ASSERT (Udp4Header != NULL); - - CopyMem (&Udp4Session.SourceAddress, &NetSession->Source, sizeof (EFI_IPv4_ADDRESS)); - CopyMem (&Udp4Session.DestinationAddress, &NetSession->Dest, sizeof (EFI_IPv4_ADDRESS)); - - Udp4Session.SourcePort = NTOHS (Udp4Header->DstPort); - Udp4Session.DestinationPort = NTOHS (Udp4Header->SrcPort); - - NET_LIST_FOR_EACH (Entry, &Udp4Service->ChildrenList) { - // - // Iterate all the instances. - // - Instance = NET_LIST_USER_STRUCT (Entry, UDP4_INSTANCE_DATA, Link); - - if (!Instance->Configured) { - continue; - } - - if (Udp4MatchDgram (Instance, &Udp4Session)) { - // - // Translate the Icmp Error code according to the udp spec. - // - Instance->IcmpError = IpIoGetIcmpErrStatus (IcmpError, IP_VERSION_4, NULL, NULL); - - if (IcmpError > ICMP_ERR_UNREACH_PORT) { - Instance->IcmpError = EFI_ICMP_ERROR; - } - - // - // Notify the instance with the received Icmp Error. - // - Udp4ReportIcmpError (Instance); - - break; - } - } - - NetbufFree (Packet); -} - - -/** - This function reports the received ICMP error. - - @param[in] Instance Pointer to the udp instance context data. - -**/ -VOID -Udp4ReportIcmpError ( - IN UDP4_INSTANCE_DATA *Instance - ) -{ - EFI_UDP4_COMPLETION_TOKEN *Token; - - if (NetMapIsEmpty (&Instance->RxTokens)) { - // - // There are no receive tokens to deliver the ICMP error. - // - return; - } - - if (EFI_ERROR (Instance->IcmpError)) { - // - // Try to get a RxToken from the RxTokens map. - // - Token = (EFI_UDP4_COMPLETION_TOKEN *) NetMapRemoveHead (&Instance->RxTokens, NULL); - - if (Token != NULL) { - // - // Report the error through the Token. - // - Token->Status = Instance->IcmpError; - gBS->SignalEvent (Token->Event); - - // - // Clear the IcmpError. - // - Instance->IcmpError = EFI_SUCCESS; - } - } -} - - -/** - This function is a dummy ext-free function for the NET_BUF created for the output - udp datagram. - - @param[in] Context Pointer to the context data. - -**/ -VOID -EFIAPI -Udp4NetVectorExtFree ( - VOID *Context - ) -{ -} - diff --git a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Impl.h b/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Impl.h deleted file mode 100644 index a5dd1ecabe..0000000000 --- a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Impl.h +++ /dev/null @@ -1,689 +0,0 @@ -/** @file - EFI UDPv4 protocol implementation. - -Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef _UDP4_IMPL_H_ -#define _UDP4_IMPL_H_ - -#include - -#include -#include - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - -#include "Udp4Driver.h" - - -extern EFI_COMPONENT_NAME_PROTOCOL gUdp4ComponentName; -extern EFI_COMPONENT_NAME2_PROTOCOL gUdp4ComponentName2; -extern EFI_UNICODE_STRING_TABLE *gUdpControllerNameTable; -extern EFI_SERVICE_BINDING_PROTOCOL mUdp4ServiceBinding; -extern EFI_UDP4_PROTOCOL mUdp4Protocol; -extern UINT16 mUdp4RandomPort; - -#define ICMP_ERROR_PACKET_LENGTH 8 - -#define UDP4_TIMEOUT_INTERVAL (50 * TICKS_PER_MS) // 50 milliseconds - -#define UDP4_HEADER_SIZE sizeof (EFI_UDP_HEADER) -#define UDP4_MAX_DATA_SIZE 65507 - -#define UDP4_PORT_KNOWN 1024 - -#define UDP4_SERVICE_DATA_SIGNATURE SIGNATURE_32('U', 'd', 'p', '4') - -#define UDP4_SERVICE_DATA_FROM_THIS(a) \ - CR ( \ - (a), \ - UDP4_SERVICE_DATA, \ - ServiceBinding, \ - UDP4_SERVICE_DATA_SIGNATURE \ - ) - -typedef struct _UDP4_SERVICE_DATA_ { - UINT32 Signature; - EFI_SERVICE_BINDING_PROTOCOL ServiceBinding; - EFI_HANDLE ImageHandle; - EFI_HANDLE ControllerHandle; - LIST_ENTRY ChildrenList; - UINTN ChildrenNumber; - IP_IO *IpIo; - - EFI_EVENT TimeoutEvent; -} UDP4_SERVICE_DATA; - -#define UDP4_INSTANCE_DATA_SIGNATURE SIGNATURE_32('U', 'd', 'p', 'I') - -#define UDP4_INSTANCE_DATA_FROM_THIS(a) \ - CR ( \ - (a), \ - UDP4_INSTANCE_DATA, \ - Udp4Proto, \ - UDP4_INSTANCE_DATA_SIGNATURE \ - ) - -typedef struct _UDP4_INSTANCE_DATA_ { - UINT32 Signature; - LIST_ENTRY Link; - - UDP4_SERVICE_DATA *Udp4Service; - EFI_UDP4_PROTOCOL Udp4Proto; - EFI_UDP4_CONFIG_DATA ConfigData; - EFI_HANDLE ChildHandle; - BOOLEAN Configured; - BOOLEAN IsNoMapping; - - NET_MAP TxTokens; - NET_MAP RxTokens; - - NET_MAP McastIps; - - LIST_ENTRY RcvdDgramQue; - LIST_ENTRY DeliveredDgramQue; - - UINT16 HeadSum; - - EFI_STATUS IcmpError; - - IP_IO_IP_INFO *IpInfo; - - BOOLEAN InDestroy; -} UDP4_INSTANCE_DATA; - -typedef struct _UDP4_RXDATA_WRAP_ { - LIST_ENTRY Link; - NET_BUF *Packet; - UINT32 TimeoutTick; - EFI_UDP4_RECEIVE_DATA RxData; -} UDP4_RXDATA_WRAP; - -typedef struct { - EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; - UINTN NumberOfChildren; - EFI_HANDLE *ChildHandleBuffer; -} UDP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT; - -/** - Reads the current operational settings. - - The GetModeData() function copies the current operational settings of this EFI - UDPv4 Protocol instance into user-supplied buffers. This function is used - optionally to retrieve the operational mode data of underlying networks or - drivers. - - @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. - @param[out] Udp4ConfigData Pointer to the buffer to receive the current configuration data. - @param[out] Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure. - @param[out] MnpConfigData Pointer to the managed network configuration data structure. - @param[out] SnpModeData Pointer to the simple network mode data structure. - - @retval EFI_SUCCESS The mode data was read. - @retval EFI_NOT_STARTED When Udp4ConfigData is queried, no configuration data is - available because this instance has not been started. - @retval EFI_INVALID_PARAMETER This is NULL. - -**/ -EFI_STATUS -EFIAPI -Udp4GetModeData ( - IN EFI_UDP4_PROTOCOL *This, - OUT EFI_UDP4_CONFIG_DATA *Udp4ConfigData OPTIONAL, - OUT EFI_IP4_MODE_DATA *Ip4ModeData OPTIONAL, - OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL, - OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL - ); - -/** - Initializes, changes, or resets the operational parameters for this instance of the EFI UDPv4 - Protocol. - - The Configure() function is used to do the following: - * Initialize and start this instance of the EFI UDPv4 Protocol. - * Change the filtering rules and operational parameters. - * Reset this instance of the EFI UDPv4 Protocol. - Until these parameters are initialized, no network traffic can be sent or - received by this instance. This instance can be also reset by calling Configure() - with UdpConfigData set to NULL. Once reset, the receiving queue and transmitting - queue are flushed and no traffic is allowed through this instance. - With different parameters in UdpConfigData, Configure() can be used to bind - this instance to specified port. - - @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. - @param[in] UdpConfigData Pointer to the buffer to receive the current configuration data. - - @retval EFI_SUCCESS The configuration settings were set, changed, or reset successfully. - @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, - RARP, etc.) is not finished yet. - @retval EFI_INVALID_PARAMETER One or more following conditions are TRUE: - @retval EFI_ALREADY_STARTED The EFI UDPv4 Protocol instance is already started/configured - and must be stopped/reset before it can be reconfigured. - @retval EFI_ACCESS_DENIED UdpConfigData. AllowDuplicatePort is FALSE - and UdpConfigData.StationPort is already used by - other instance. - @retval EFI_OUT_OF_RESOURCES The EFI UDPv4 Protocol driver cannot allocate memory for this - EFI UDPv4 Protocol instance. - @retval EFI_DEVICE_ERROR An unexpected network or system error occurred and this instance - was not opened. - -**/ -EFI_STATUS -EFIAPI -Udp4Configure ( - IN EFI_UDP4_PROTOCOL *This, - IN EFI_UDP4_CONFIG_DATA *UdpConfigData OPTIONAL - ); - -/** - Joins and leaves multicast groups. - - The Groups() function is used to enable and disable the multicast group - filtering. If the JoinFlag is FALSE and the MulticastAddress is NULL, then all - currently joined groups are left. - - @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. - @param[in] JoinFlag Set to TRUE to join a multicast group. Set to FALSE to leave one - or all multicast groups. - @param[in] MulticastAddress Pointer to multicast group address to join or leave. - - @retval EFI_SUCCESS The operation completed successfully. - @retval EFI_NOT_STARTED The EFI UDPv4 Protocol instance has not been started. - @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, - RARP, etc.) is not finished yet. - @retval EFI_OUT_OF_RESOURCES Could not allocate resources to join the group. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - - This is NULL. - - JoinFlag is TRUE and MulticastAddress is NULL. - - JoinFlag is TRUE and *MulticastAddress is not - a valid multicast address. - @retval EFI_ALREADY_STARTED The group address is already in the group table (when - JoinFlag is TRUE). - @retval EFI_NOT_FOUND The group address is not in the group table (when JoinFlag is - FALSE). - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. - -**/ -EFI_STATUS -EFIAPI -Udp4Groups ( - IN EFI_UDP4_PROTOCOL *This, - IN BOOLEAN JoinFlag, - IN EFI_IPv4_ADDRESS *MulticastAddress OPTIONAL - ); - -/** - Adds and deletes routing table entries. - - The Routes() function adds a route to or deletes a route from the routing table. - Routes are determined by comparing the SubnetAddress with the destination IP - address and arithmetically AND-ing it with the SubnetMask. The gateway address - must be on the same subnet as the configured station address. - The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0. - The default route matches all destination IP addresses that do not match any - other routes. - A zero GatewayAddress is a nonroute. Packets are sent to the destination IP - address if it can be found in the Address Resolution Protocol (ARP) cache or - on the local subnet. One automatic nonroute entry will be inserted into the - routing table for outgoing packets that are addressed to a local subnet - (gateway address of 0.0.0.0). - Each instance of the EFI UDPv4 Protocol has its own independent routing table. - Instances of the EFI UDPv4 Protocol that use the default IP address will also - have copies of the routing table provided by the EFI_IP4_CONFIG_PROTOCOL. These - copies will be updated automatically whenever the IP driver reconfigures its - instances; as a result, the previous modification to these copies will be lost. - - @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. - @param[in] DeleteRoute Set to TRUE to delete this route from the routing table. - Set to FALSE to add this route to the routing table. - @param[in] SubnetAddress The destination network address that needs to be routed. - @param[in] SubnetMask The subnet mask of SubnetAddress. - @param[in] GatewayAddress The gateway IP address for this route. - - @retval EFI_SUCCESS The operation completed successfully. - @retval EFI_NOT_STARTED The EFI UDPv4 Protocol instance has not been started. - @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, - - RARP, etc.) is not finished yet. - @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - @retval EFI_OUT_OF_RESOURCES Could not add the entry to the routing table. - @retval EFI_NOT_FOUND This route is not in the routing table. - @retval EFI_ACCESS_DENIED The route is already defined in the routing table. - -**/ -EFI_STATUS -EFIAPI -Udp4Routes ( - IN EFI_UDP4_PROTOCOL *This, - IN BOOLEAN DeleteRoute, - IN EFI_IPv4_ADDRESS *SubnetAddress, - IN EFI_IPv4_ADDRESS *SubnetMask, - IN EFI_IPv4_ADDRESS *GatewayAddress - ); - -/** - Queues outgoing data packets into the transmit queue. - - The Transmit() function places a sending request to this instance of the EFI - UDPv4 Protocol, alongside the transmit data that was filled by the user. Whenever - the packet in the token is sent out or some errors occur, the Token.Event will - be signaled and Token.Status is updated. Providing a proper notification function - and context for the event will enable the user to receive the notification and - transmitting status. - - @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. - @param[in] Token Pointer to the completion token that will be placed into the - transmit queue. - - @retval EFI_SUCCESS The data has been queued for transmission. - @retval EFI_NOT_STARTED This EFI UDPv4 Protocol instance has not been started. - @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, - RARP, etc.) is not finished yet. - @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - @retval EFI_ACCESS_DENIED The transmit completion token with the same - Token.Event was already in the transmit queue. - @retval EFI_NOT_READY The completion token could not be queued because the - transmit queue is full. - @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data. - @retval EFI_NOT_FOUND There is no route to the destination network or address. - @retval EFI_BAD_BUFFER_SIZE The data length is greater than the maximum UDP packet - size. Or the length of the IP header + UDP header + data - length is greater than MTU if DoNotFragment is TRUE. - -**/ -EFI_STATUS -EFIAPI -Udp4Transmit ( - IN EFI_UDP4_PROTOCOL *This, - IN EFI_UDP4_COMPLETION_TOKEN *Token - ); - -/** - Places an asynchronous receive request into the receiving queue. - - The Receive() function places a completion token into the receive packet queue. - This function is always asynchronous. - The caller must fill in the Token.Event field in the completion token, and this - field cannot be NULL. When the receive operation completes, the EFI UDPv4 Protocol - driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event - is signaled. Providing a proper notification function and context for the event - will enable the user to receive the notification and receiving status. That - notification function is guaranteed to not be re-entered. - - @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. - @param[in] Token Pointer to a token that is associated with - the receive data descriptor. - - @retval EFI_SUCCESS The receive completion token was cached. - @retval EFI_NOT_STARTED This EFI UDPv4 Protocol instance has not been started. - @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, RARP, etc.) - is not finished yet. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system - resources (usually memory). - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. - @retval EFI_ACCESS_DENIED A receive completion token with the same Token.Event was already in - the receive queue. - @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full. - -**/ -EFI_STATUS -EFIAPI -Udp4Receive ( - IN EFI_UDP4_PROTOCOL *This, - IN EFI_UDP4_COMPLETION_TOKEN *Token - ); - -/** - Aborts an asynchronous transmit or receive request. - - The Cancel() function is used to abort a pending transmit or receive request. - If the token is in the transmit or receive request queues, after calling this - function, Token.Status will be set to EFI_ABORTED and then Token.Event will be - signaled. If the token is not in one of the queues, which usually means that - the asynchronous operation has completed, this function will not signal the - token and EFI_NOT_FOUND is returned. - - @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. - @param[in] Token Pointer to a token that has been issued by - EFI_UDP4_PROTOCOL.Transmit() or - EFI_UDP4_PROTOCOL.Receive().If NULL, all pending - tokens are aborted. - - @retval EFI_SUCCESS The asynchronous I/O request was aborted and Token.Event - was signaled. When Token is NULL, all pending requests are - aborted and their events are signaled. - @retval EFI_INVALID_PARAMETER This is NULL. - @retval EFI_NOT_STARTED This instance has not been started. - @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, - RARP, etc.) is not finished yet. - @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O request was - not found in the transmit or receive queue. It has either completed - or was not issued by Transmit() and Receive(). - -**/ -EFI_STATUS -EFIAPI -Udp4Cancel ( - IN EFI_UDP4_PROTOCOL *This, - IN EFI_UDP4_COMPLETION_TOKEN *Token OPTIONAL - ); - -/** - Polls for incoming data packets and processes outgoing data packets. - - The Poll() function can be used by network drivers and applications to increase - the rate that data packets are moved between the communications device and the - transmit and receive queues. - In some systems, the periodic timer event in the managed network driver may not - poll the underlying communications device fast enough to transmit and/or receive - all data packets without missing incoming packets or dropping outgoing packets. - Drivers and applications that are experiencing packet loss should try calling - the Poll() function more often. - - @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. - - @retval EFI_SUCCESS Incoming or outgoing data was processed. - @retval EFI_INVALID_PARAMETER This is NULL. - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. - @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue. - -**/ -EFI_STATUS -EFIAPI -Udp4Poll ( - IN EFI_UDP4_PROTOCOL *This - ); - -/** - Create the Udp service context data. - - @param[in, out] Udp4Service Pointer to the UDP4_SERVICE_DATA. - @param[in] ImageHandle The image handle of this udp4 driver. - @param[in] ControllerHandle The controller handle this udp4 driver binds on. - - @retval EFI_SUCCESS The udp4 service context data is created and - initialized. - @retval EFI_OUT_OF_RESOURCES Cannot allocate memory. - @retval other Other error occurs. - -**/ -EFI_STATUS -Udp4CreateService ( - IN OUT UDP4_SERVICE_DATA *Udp4Service, - IN EFI_HANDLE ImageHandle, - IN EFI_HANDLE ControllerHandle - ); - -/** - Clean the Udp service context data. - - @param[in] Udp4Service Pointer to the UDP4_SERVICE_DATA. - -**/ -VOID -Udp4CleanService ( - IN UDP4_SERVICE_DATA *Udp4Service - ); - -/** - This function intializes the new created udp instance. - - @param[in] Udp4Service Pointer to the UDP4_SERVICE_DATA. - @param[in, out] Instance Pointer to the un-initialized UDP4_INSTANCE_DATA. - -**/ -VOID -Udp4InitInstance ( - IN UDP4_SERVICE_DATA *Udp4Service, - IN OUT UDP4_INSTANCE_DATA *Instance - ); - -/** - This function cleans the udp instance. - - @param[in] Instance Pointer to the UDP4_INSTANCE_DATA to clean. - -**/ -VOID -Udp4CleanInstance ( - IN UDP4_INSTANCE_DATA *Instance - ); - -/** - This function tries to bind the udp instance according to the configured port - allocation strategy. - - @param[in] InstanceList Pointer to the head of the list linking the udp - instances. - @param[in, out] ConfigData Pointer to the ConfigData of the instance to be - bound. ConfigData->StationPort will be assigned - with an available port value on success. - - @retval EFI_SUCCESS The bound operation is completed successfully. - @retval EFI_ACCESS_DENIED The specified by the ConfigData is - already used by other instance. - @retval EFI_OUT_OF_RESOURCES No available port resources. - -**/ -EFI_STATUS -Udp4Bind ( - IN LIST_ENTRY *InstanceList, - IN OUT EFI_UDP4_CONFIG_DATA *ConfigData - ); - -/** - This function is used to check whether the NewConfigData has any un-reconfigurable - parameters changed compared to the OldConfigData. - - @param[in] OldConfigData Pointer to the current ConfigData the udp instance - uses. - @param[in] NewConfigData Pointer to the new ConfigData. - - @retval TRUE The instance is reconfigurable. - @retval FALSE Otherwise. - -**/ -BOOLEAN -Udp4IsReconfigurable ( - IN EFI_UDP4_CONFIG_DATA *OldConfigData, - IN EFI_UDP4_CONFIG_DATA *NewConfigData - ); - -/** - This function builds the Ip4 configdata from the Udp4ConfigData. - - @param[in] Udp4ConfigData Pointer to the EFI_UDP4_CONFIG_DATA. - @param[in, out] Ip4ConfigData Pointer to the EFI_IP4_CONFIG_DATA. - -**/ -VOID -Udp4BuildIp4ConfigData ( - IN EFI_UDP4_CONFIG_DATA *Udp4ConfigData, - IN OUT EFI_IP4_CONFIG_DATA *Ip4ConfigData - ); - -/** - This function validates the TxToken, it returns the error code according to the spec. - - @param[in] Instance Pointer to the udp instance context data. - @param[in] TxToken Pointer to the token to be checked. - - @retval EFI_SUCCESS The TxToken is valid. - @retval EFI_INVALID_PARAMETER One or more of the following are TRUE: This is - NULL. Token is NULL. Token.Event is NULL. - Token.Packet.TxData is NULL. - Token.Packet.TxData.FragmentCount is zero. - Token.Packet.TxData.DataLength is not equal to the - sum of fragment lengths. One or more of the - Token.Packet.TxData.FragmentTable[]. - FragmentLength fields is zero. One or more of the - Token.Packet.TxData.FragmentTable[]. - FragmentBuffer fields is NULL. - Token.Packet.TxData. GatewayAddress is not a - unicast IPv4 address if it is not NULL. One or - more IPv4 addresses in Token.Packet.TxData. - UdpSessionData are not valid unicast IPv4 - addresses if the UdpSessionData is not NULL. - @retval EFI_BAD_BUFFER_SIZE The data length is greater than the maximum UDP - packet size. - -**/ -EFI_STATUS -Udp4ValidateTxToken ( - IN UDP4_INSTANCE_DATA *Instance, - IN EFI_UDP4_COMPLETION_TOKEN *TxToken - ); - -/** - This function checks whether the specified Token duplicates with the one in the Map. - - @param[in] Map Pointer to the NET_MAP. - @param[in] Item Pointer to the NET_MAP_ITEM contain the pointer to - the Token. - @param[in] Context Pointer to the Token to be checked. - - @retval EFI_SUCCESS The Token specified by Context differs from the - one in the Item. - @retval EFI_ACCESS_DENIED The Token duplicates with the one in the Item. - -**/ -EFI_STATUS -EFIAPI -Udp4TokenExist ( - IN NET_MAP *Map, - IN NET_MAP_ITEM *Item, - IN VOID *Context - ); - -/** - This function calculates the checksum for the Packet, utilizing the pre-calculated - pseudo HeadSum to reduce some overhead. - - @param[in] Packet Pointer to the NET_BUF contains the udp datagram. - @param[in] HeadSum Checksum of the pseudo header execpt the length - field. - - @retval The 16-bit checksum of this udp datagram. - -**/ -UINT16 -Udp4Checksum ( - IN NET_BUF *Packet, - IN UINT16 HeadSum - ); - -/** - This function removes the specified Token from the TokenMap. - - @param[in, out] TokenMap Pointer to the NET_MAP containing the tokens. - @param[in] Token Pointer to the Token to be removed. - - @retval EFI_SUCCESS The specified Token is removed from the TokenMap. - @retval EFI_NOT_FOUND The specified Token is not found in the TokenMap. - -**/ -EFI_STATUS -Udp4RemoveToken ( - IN OUT NET_MAP *TokenMap, - IN EFI_UDP4_COMPLETION_TOKEN *Token - ); - -/** - This function removes the multicast group specified by Arg from the Map. - - @param[in, out] Map Pointer to the NET_MAP. - @param[in] Item Pointer to the NET_MAP_ITEM. - @param[in] Arg Pointer to the Arg, it's the pointer to a - multicast IPv4 Address. - - @retval EFI_SUCCESS The multicast address is removed. - @retval EFI_ABORTED The specified multicast address is removed and the - Arg is not NULL. - -**/ -EFI_STATUS -EFIAPI -Udp4LeaveGroup ( - IN OUT NET_MAP *Map, - IN NET_MAP_ITEM *Item, - IN VOID *Arg OPTIONAL - ); - -/** - This function removes all the Wrap datas in the RcvdDgramQue. - - @param[in] Instance Pointer to the udp instance context data. - -**/ -VOID -Udp4FlushRcvdDgram ( - IN UDP4_INSTANCE_DATA *Instance - ); - -/** - Cancel Udp4 tokens from the Udp4 instance. - - @param[in] Instance Pointer to the udp instance context data. - @param[in] Token Pointer to the token to be canceled, if NULL, all - tokens in this instance will be cancelled. - - @retval EFI_SUCCESS The Token is cancelled. - @retval EFI_NOT_FOUND The Token is not found. - -**/ -EFI_STATUS -Udp4InstanceCancelToken ( - IN UDP4_INSTANCE_DATA *Instance, - IN EFI_UDP4_COMPLETION_TOKEN *Token OPTIONAL - ); - -/** - This function delivers the received datagrams for the specified instance. - - @param[in] Instance Pointer to the instance context data. - -**/ -VOID -Udp4InstanceDeliverDgram ( - IN UDP4_INSTANCE_DATA *Instance - ); - -/** - This function reports the received ICMP error. - - @param[in] Instance Pointer to the udp instance context data. - -**/ -VOID -Udp4ReportIcmpError ( - IN UDP4_INSTANCE_DATA *Instance - ); - -/** - This function is a dummy ext-free function for the NET_BUF created for the output - udp datagram. - - @param[in] Context Pointer to the context data. - -**/ -VOID -EFIAPI -Udp4NetVectorExtFree ( - VOID *Context - ); - -#endif diff --git a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Main.c b/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Main.c deleted file mode 100644 index aa1956cd4b..0000000000 --- a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Main.c +++ /dev/null @@ -1,902 +0,0 @@ -/** @file - -(C) Copyright 2014 Hewlett-Packard Development Company, L.P.
-Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "Udp4Impl.h" - -EFI_UDP4_PROTOCOL mUdp4Protocol = { - Udp4GetModeData, - Udp4Configure, - Udp4Groups, - Udp4Routes, - Udp4Transmit, - Udp4Receive, - Udp4Cancel, - Udp4Poll -}; - - -/** - Reads the current operational settings. - - The GetModeData() function copies the current operational settings of this EFI - UDPv4 Protocol instance into user-supplied buffers. This function is used - optionally to retrieve the operational mode data of underlying networks or - drivers. - - @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. - @param[out] Udp4ConfigData Pointer to the buffer to receive the current configuration data. - @param[out] Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure. - @param[out] MnpConfigData Pointer to the managed network configuration data structure. - @param[out] SnpModeData Pointer to the simple network mode data structure. - - @retval EFI_SUCCESS The mode data was read. - @retval EFI_NOT_STARTED When Udp4ConfigData is queried, no configuration data is - available because this instance has not been started. - @retval EFI_INVALID_PARAMETER This is NULL. - -**/ -EFI_STATUS -EFIAPI -Udp4GetModeData ( - IN EFI_UDP4_PROTOCOL *This, - OUT EFI_UDP4_CONFIG_DATA *Udp4ConfigData OPTIONAL, - OUT EFI_IP4_MODE_DATA *Ip4ModeData OPTIONAL, - OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL, - OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL - ) -{ - UDP4_INSTANCE_DATA *Instance; - EFI_IP4_PROTOCOL *Ip; - EFI_TPL OldTpl; - EFI_STATUS Status; - - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - Instance = UDP4_INSTANCE_DATA_FROM_THIS (This); - - if (!Instance->Configured && (Udp4ConfigData != NULL)) { - return EFI_NOT_STARTED; - } - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - if (Udp4ConfigData != NULL) { - // - // Set the Udp4ConfigData. - // - CopyMem (Udp4ConfigData, &Instance->ConfigData, sizeof (*Udp4ConfigData)); - } - - Ip = Instance->IpInfo->Ip.Ip4; - - // - // Get the underlying Ip4ModeData, MnpConfigData and SnpModeData. - // - Status = Ip->GetModeData (Ip, Ip4ModeData, MnpConfigData, SnpModeData); - - gBS->RestoreTPL (OldTpl); - - return Status; -} - - -/** - Initializes, changes, or resets the operational parameters for this instance of the EFI UDPv4 - Protocol. - - The Configure() function is used to do the following: - * Initialize and start this instance of the EFI UDPv4 Protocol. - * Change the filtering rules and operational parameters. - * Reset this instance of the EFI UDPv4 Protocol. - Until these parameters are initialized, no network traffic can be sent or - received by this instance. This instance can be also reset by calling Configure() - with UdpConfigData set to NULL. Once reset, the receiving queue and transmitting - queue are flushed and no traffic is allowed through this instance. - With different parameters in UdpConfigData, Configure() can be used to bind - this instance to specified port. - - @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. - @param[in] UdpConfigData Pointer to the buffer to receive the current configuration data. - - @retval EFI_SUCCESS The configuration settings were set, changed, or reset successfully. - @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, - RARP, etc.) is not finished yet. - @retval EFI_INVALID_PARAMETER One or more following conditions are TRUE: - @retval EFI_ALREADY_STARTED The EFI UDPv4 Protocol instance is already started/configured - and must be stopped/reset before it can be reconfigured. - @retval EFI_ACCESS_DENIED UdpConfigData. AllowDuplicatePort is FALSE - and UdpConfigData.StationPort is already used by - other instance. - @retval EFI_OUT_OF_RESOURCES The EFI UDPv4 Protocol driver cannot allocate memory for this - EFI UDPv4 Protocol instance. - @retval EFI_DEVICE_ERROR An unexpected network or system error occurred and this instance - was not opened. - -**/ -EFI_STATUS -EFIAPI -Udp4Configure ( - IN EFI_UDP4_PROTOCOL *This, - IN EFI_UDP4_CONFIG_DATA *UdpConfigData OPTIONAL - ) -{ - EFI_STATUS Status; - UDP4_INSTANCE_DATA *Instance; - UDP4_SERVICE_DATA *Udp4Service; - EFI_TPL OldTpl; - IP4_ADDR StationAddress; - IP4_ADDR SubnetMask; - IP4_ADDR RemoteAddress; - EFI_IP4_CONFIG_DATA Ip4ConfigData; - IP4_ADDR LocalAddr; - IP4_ADDR RemoteAddr; - - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - Instance = UDP4_INSTANCE_DATA_FROM_THIS (This); - - if (!Instance->Configured && (UdpConfigData == NULL)) { - return EFI_SUCCESS; - } - - Udp4Service = Instance->Udp4Service; - Status = EFI_SUCCESS; - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - if (UdpConfigData != NULL) { - - CopyMem (&StationAddress, &UdpConfigData->StationAddress, sizeof (IP4_ADDR)); - CopyMem (&SubnetMask, &UdpConfigData->SubnetMask, sizeof (IP4_ADDR)); - CopyMem (&RemoteAddress, &UdpConfigData->RemoteAddress, sizeof (IP4_ADDR)); - - StationAddress = NTOHL (StationAddress); - SubnetMask = NTOHL (SubnetMask); - RemoteAddress = NTOHL (RemoteAddress); - - - if (!UdpConfigData->UseDefaultAddress && - (!IP4_IS_VALID_NETMASK (SubnetMask) || - !((StationAddress == 0) || (SubnetMask != 0 && NetIp4IsUnicast (StationAddress, SubnetMask))) || - IP4_IS_LOCAL_BROADCAST (RemoteAddress))) { - // - // Don't use default address, and subnet mask is invalid or StationAddress is not - // a valid unicast IPv4 address or RemoteAddress is not a valid unicast IPv4 address - // if it is not 0. - // - Status = EFI_INVALID_PARAMETER; - goto ON_EXIT; - } - - if (Instance->Configured) { - // - // The instance is already configured, try to do the re-configuration. - // - if (!Udp4IsReconfigurable (&Instance->ConfigData, UdpConfigData)) { - // - // If the new configuration data wants to change some unreconfigurable - // settings, return EFI_ALREADY_STARTED. - // - Status = EFI_ALREADY_STARTED; - goto ON_EXIT; - } - - // - // Save the reconfigurable parameters. - // - Instance->ConfigData.TypeOfService = UdpConfigData->TypeOfService; - Instance->ConfigData.TimeToLive = UdpConfigData->TimeToLive; - Instance->ConfigData.DoNotFragment = UdpConfigData->DoNotFragment; - Instance->ConfigData.ReceiveTimeout = UdpConfigData->ReceiveTimeout; - Instance->ConfigData.TransmitTimeout = UdpConfigData->TransmitTimeout; - } else { - // - // Construct the Ip configuration data from the UdpConfigData. - // - Udp4BuildIp4ConfigData (UdpConfigData, &Ip4ConfigData); - - // - // Configure the Ip instance wrapped in the IpInfo. - // - Status = IpIoConfigIp (Instance->IpInfo, &Ip4ConfigData); - if (EFI_ERROR (Status)) { - if (Status == EFI_NO_MAPPING) { - Instance->IsNoMapping = TRUE; - } - - goto ON_EXIT; - } - - Instance->IsNoMapping = FALSE; - - // - // Save the configuration data. - // - CopyMem (&Instance->ConfigData, UdpConfigData, sizeof (Instance->ConfigData)); - IP4_COPY_ADDRESS (&Instance->ConfigData.StationAddress, &Ip4ConfigData.StationAddress); - IP4_COPY_ADDRESS (&Instance->ConfigData.SubnetMask, &Ip4ConfigData.SubnetMask); - - // - // Try to allocate the required port resource. - // - Status = Udp4Bind (&Udp4Service->ChildrenList, &Instance->ConfigData); - if (EFI_ERROR (Status)) { - // - // Reset the ip instance if bind fails. - // - IpIoConfigIp (Instance->IpInfo, NULL); - goto ON_EXIT; - } - - // - // Pre calculate the checksum for the pseudo head, ignore the UDP length first. - // - CopyMem (&LocalAddr, &Instance->ConfigData.StationAddress, sizeof (IP4_ADDR)); - CopyMem (&RemoteAddr, &Instance->ConfigData.RemoteAddress, sizeof (IP4_ADDR)); - Instance->HeadSum = NetPseudoHeadChecksum ( - LocalAddr, - RemoteAddr, - EFI_IP_PROTO_UDP, - 0 - ); - - Instance->Configured = TRUE; - } - } else { - // - // UdpConfigData is NULL, reset the instance. - // - Instance->Configured = FALSE; - Instance->IsNoMapping = FALSE; - - // - // Reset the Ip instance wrapped in the IpInfo. - // - IpIoConfigIp (Instance->IpInfo, NULL); - - // - // Cancel all the user tokens. - // - Instance->Udp4Proto.Cancel (&Instance->Udp4Proto, NULL); - - // - // Remove the buffered RxData for this instance. - // - Udp4FlushRcvdDgram (Instance); - - ASSERT (IsListEmpty (&Instance->DeliveredDgramQue)); - } - -ON_EXIT: - - gBS->RestoreTPL (OldTpl); - - return Status; -} - - -/** - Joins and leaves multicast groups. - - The Groups() function is used to enable and disable the multicast group - filtering. If the JoinFlag is FALSE and the MulticastAddress is NULL, then all - currently joined groups are left. - - @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. - @param[in] JoinFlag Set to TRUE to join a multicast group. Set to FALSE to leave one - or all multicast groups. - @param[in] MulticastAddress Pointer to multicast group address to join or leave. - - @retval EFI_SUCCESS The operation completed successfully. - @retval EFI_NOT_STARTED The EFI UDPv4 Protocol instance has not been started. - @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, - RARP, etc.) is not finished yet. - @retval EFI_OUT_OF_RESOURCES Could not allocate resources to join the group. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - - This is NULL. - - JoinFlag is TRUE and MulticastAddress is NULL. - - JoinFlag is TRUE and *MulticastAddress is not - a valid multicast address. - @retval EFI_ALREADY_STARTED The group address is already in the group table (when - JoinFlag is TRUE). - @retval EFI_NOT_FOUND The group address is not in the group table (when JoinFlag is - FALSE). - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. - -**/ -EFI_STATUS -EFIAPI -Udp4Groups ( - IN EFI_UDP4_PROTOCOL *This, - IN BOOLEAN JoinFlag, - IN EFI_IPv4_ADDRESS *MulticastAddress OPTIONAL - ) -{ - EFI_STATUS Status; - UDP4_INSTANCE_DATA *Instance; - EFI_IP4_PROTOCOL *Ip; - EFI_TPL OldTpl; - IP4_ADDR McastIp; - - if ((This == NULL) || (JoinFlag && (MulticastAddress == NULL))) { - return EFI_INVALID_PARAMETER; - } - - McastIp = 0; - if (JoinFlag) { - CopyMem (&McastIp, MulticastAddress, sizeof (IP4_ADDR)); - - if (!IP4_IS_MULTICAST (NTOHL (McastIp))) { - return EFI_INVALID_PARAMETER; - } - } - - Instance = UDP4_INSTANCE_DATA_FROM_THIS (This); - - if (Instance->IsNoMapping) { - return EFI_NO_MAPPING; - } - - if (!Instance->Configured) { - return EFI_NOT_STARTED; - } - - Ip = Instance->IpInfo->Ip.Ip4; - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - // - // Invoke the Ip instance the Udp4 instance consumes to do the group operation. - // - Status = Ip->Groups (Ip, JoinFlag, MulticastAddress); - - if (EFI_ERROR (Status)) { - goto ON_EXIT; - } - - // - // Keep a local copy of the configured multicast IPs because IpIo receives - // datagrams from the 0 station address IP instance and then UDP delivers to - // the matched instance. This copy of multicast IPs is used to avoid receive - // the mutlicast datagrams destined to multicast IPs the other instances configured. - // - if (JoinFlag) { - - NetMapInsertTail (&Instance->McastIps, (VOID *) (UINTN) McastIp, NULL); - } else { - - NetMapIterate (&Instance->McastIps, Udp4LeaveGroup, MulticastAddress); - } - -ON_EXIT: - - gBS->RestoreTPL (OldTpl); - - return Status; -} - - -/** - Adds and deletes routing table entries. - - The Routes() function adds a route to or deletes a route from the routing table. - Routes are determined by comparing the SubnetAddress with the destination IP - address and arithmetically AND-ing it with the SubnetMask. The gateway address - must be on the same subnet as the configured station address. - The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0. - The default route matches all destination IP addresses that do not match any - other routes. - A zero GatewayAddress is a nonroute. Packets are sent to the destination IP - address if it can be found in the Address Resolution Protocol (ARP) cache or - on the local subnet. One automatic nonroute entry will be inserted into the - routing table for outgoing packets that are addressed to a local subnet - (gateway address of 0.0.0.0). - Each instance of the EFI UDPv4 Protocol has its own independent routing table. - Instances of the EFI UDPv4 Protocol that use the default IP address will also - have copies of the routing table provided by the EFI_IP4_CONFIG_PROTOCOL. These - copies will be updated automatically whenever the IP driver reconfigures its - instances; as a result, the previous modification to these copies will be lost. - - @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. - @param[in] DeleteRoute Set to TRUE to delete this route from the routing table. - Set to FALSE to add this route to the routing table. - @param[in] SubnetAddress The destination network address that needs to be routed. - @param[in] SubnetMask The subnet mask of SubnetAddress. - @param[in] GatewayAddress The gateway IP address for this route. - - @retval EFI_SUCCESS The operation completed successfully. - @retval EFI_NOT_STARTED The EFI UDPv4 Protocol instance has not been started. - @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, - - RARP, etc.) is not finished yet. - @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - @retval EFI_OUT_OF_RESOURCES Could not add the entry to the routing table. - @retval EFI_NOT_FOUND This route is not in the routing table. - @retval EFI_ACCESS_DENIED The route is already defined in the routing table. - -**/ -EFI_STATUS -EFIAPI -Udp4Routes ( - IN EFI_UDP4_PROTOCOL *This, - IN BOOLEAN DeleteRoute, - IN EFI_IPv4_ADDRESS *SubnetAddress, - IN EFI_IPv4_ADDRESS *SubnetMask, - IN EFI_IPv4_ADDRESS *GatewayAddress - ) -{ - UDP4_INSTANCE_DATA *Instance; - EFI_IP4_PROTOCOL *Ip; - - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - Instance = UDP4_INSTANCE_DATA_FROM_THIS (This); - - if (Instance->IsNoMapping) { - return EFI_NO_MAPPING; - } - - if (!Instance->Configured) { - return EFI_NOT_STARTED; - } - - Ip = Instance->IpInfo->Ip.Ip4; - - // - // Invoke the Ip instance the Udp4 instance consumes to do the actual operation. - // - return Ip->Routes (Ip, DeleteRoute, SubnetAddress, SubnetMask, GatewayAddress); -} - - -/** - Queues outgoing data packets into the transmit queue. - - The Transmit() function places a sending request to this instance of the EFI - UDPv4 Protocol, alongside the transmit data that was filled by the user. Whenever - the packet in the token is sent out or some errors occur, the Token.Event will - be signaled and Token.Status is updated. Providing a proper notification function - and context for the event will enable the user to receive the notification and - transmitting status. - - @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. - @param[in] Token Pointer to the completion token that will be placed into the - transmit queue. - - @retval EFI_SUCCESS The data has been queued for transmission. - @retval EFI_NOT_STARTED This EFI UDPv4 Protocol instance has not been started. - @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, - RARP, etc.) is not finished yet. - @retval EFI_INVALID_PARAMETER One or more parameters are invalid. - @retval EFI_ACCESS_DENIED The transmit completion token with the same - Token.Event was already in the transmit queue. - @retval EFI_NOT_READY The completion token could not be queued because the - transmit queue is full. - @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data. - @retval EFI_NOT_FOUND There is no route to the destination network or address. - @retval EFI_BAD_BUFFER_SIZE The data length is greater than the maximum UDP packet - size. Or the length of the IP header + UDP header + data - length is greater than MTU if DoNotFragment is TRUE. - -**/ -EFI_STATUS -EFIAPI -Udp4Transmit ( - IN EFI_UDP4_PROTOCOL *This, - IN EFI_UDP4_COMPLETION_TOKEN *Token - ) -{ - EFI_STATUS Status; - UDP4_INSTANCE_DATA *Instance; - EFI_TPL OldTpl; - NET_BUF *Packet; - EFI_UDP_HEADER *Udp4Header; - EFI_UDP4_CONFIG_DATA *ConfigData; - IP4_ADDR Source; - IP4_ADDR Destination; - EFI_UDP4_TRANSMIT_DATA *TxData; - EFI_UDP4_SESSION_DATA *UdpSessionData; - UDP4_SERVICE_DATA *Udp4Service; - IP_IO_OVERRIDE Override; - UINT16 HeadSum; - EFI_IP_ADDRESS IpDestAddr; - - if ((This == NULL) || (Token == NULL)) { - return EFI_INVALID_PARAMETER; - } - - Instance = UDP4_INSTANCE_DATA_FROM_THIS (This); - - if (Instance->IsNoMapping) { - return EFI_NO_MAPPING; - } - - if (!Instance->Configured) { - return EFI_NOT_STARTED; - } - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - // - // Validate the Token, if the token is invalid return the error code. - // - Status = Udp4ValidateTxToken (Instance, Token); - if (EFI_ERROR (Status)) { - goto ON_EXIT; - } - - if (EFI_ERROR (NetMapIterate (&Instance->TxTokens, Udp4TokenExist, Token)) || - EFI_ERROR (NetMapIterate (&Instance->RxTokens, Udp4TokenExist, Token))) { - // - // Try to find a duplicate token in the two token maps, if found, return - // EFI_ACCESS_DENIED. - // - Status = EFI_ACCESS_DENIED; - goto ON_EXIT; - } - - TxData = Token->Packet.TxData; - - // - // Create a net buffer to hold the user buffer and the udp header. - // - Packet = NetbufFromExt ( - (NET_FRAGMENT *)TxData->FragmentTable, - TxData->FragmentCount, - UDP4_HEADER_SIZE, - 0, - Udp4NetVectorExtFree, - NULL - ); - if (Packet == NULL) { - Status = EFI_OUT_OF_RESOURCES; - goto ON_EXIT; - } - - // - // Store the IpIo in ProtoData. - // - Udp4Service = Instance->Udp4Service; - *((UINTN *) &Packet->ProtoData[0]) = (UINTN) (Udp4Service->IpIo); - - Udp4Header = (EFI_UDP_HEADER *) NetbufAllocSpace (Packet, UDP4_HEADER_SIZE, TRUE); - ASSERT (Udp4Header != NULL); - - ConfigData = &Instance->ConfigData; - - // - // Fill the udp header. - // - Udp4Header->SrcPort = HTONS (ConfigData->StationPort); - Udp4Header->DstPort = HTONS (ConfigData->RemotePort); - Udp4Header->Length = HTONS ((UINT16) Packet->TotalSize); - Udp4Header->Checksum = 0; - - UdpSessionData = TxData->UdpSessionData; - IP4_COPY_ADDRESS (&Override.Ip4OverrideData.SourceAddress, &ConfigData->StationAddress); - - if (UdpSessionData != NULL) { - // - // Set the SourceAddress, SrcPort and Destination according to the specified - // UdpSessionData. - // - if (!EFI_IP4_EQUAL (&UdpSessionData->SourceAddress, &mZeroIp4Addr)) { - IP4_COPY_ADDRESS (&Override.Ip4OverrideData.SourceAddress, &UdpSessionData->SourceAddress); - } - - if (UdpSessionData->SourcePort != 0) { - Udp4Header->SrcPort = HTONS (UdpSessionData->SourcePort); - } - - if (UdpSessionData->DestinationPort != 0) { - Udp4Header->DstPort = HTONS (UdpSessionData->DestinationPort); - } - - CopyMem (&Source, &Override.Ip4OverrideData.SourceAddress, sizeof (IP4_ADDR)); - CopyMem (&Destination, &UdpSessionData->DestinationAddress, sizeof (IP4_ADDR)); - - // - // calculate the pseudo head checksum using the overridden parameters. - // - HeadSum = NetPseudoHeadChecksum ( - Source, - Destination, - EFI_IP_PROTO_UDP, - 0 - ); - } else { - // - // UdpSessionData is NULL, use the address and port information previously configured. - // - CopyMem (&Destination, &ConfigData->RemoteAddress, sizeof (IP4_ADDR)); - - HeadSum = Instance->HeadSum; - } - - // - // calculate the checksum. - // - Udp4Header->Checksum = Udp4Checksum (Packet, HeadSum); - if (Udp4Header->Checksum == 0) { - // - // If the calculated checksum is 0, fill the Checksum field with all ones. - // - Udp4Header->Checksum = 0xffff; - } - - // - // Fill the IpIo Override data. - // - if (TxData->GatewayAddress != NULL) { - IP4_COPY_ADDRESS (&Override.Ip4OverrideData.GatewayAddress, TxData->GatewayAddress); - } else { - ZeroMem (&Override.Ip4OverrideData.GatewayAddress, sizeof (EFI_IPv4_ADDRESS)); - } - - Override.Ip4OverrideData.Protocol = EFI_IP_PROTO_UDP; - Override.Ip4OverrideData.TypeOfService = ConfigData->TypeOfService; - Override.Ip4OverrideData.TimeToLive = ConfigData->TimeToLive; - Override.Ip4OverrideData.DoNotFragment = ConfigData->DoNotFragment; - - // - // Save the token into the TxToken map. - // - Status = NetMapInsertTail (&Instance->TxTokens, Token, Packet); - if (EFI_ERROR (Status)) { - goto FREE_PACKET; - } - - // - // Send out this datagram through IpIo. - // - IpDestAddr.Addr[0] = Destination; - Status = IpIoSend ( - Udp4Service->IpIo, - Packet, - Instance->IpInfo, - Instance, - Token, - &IpDestAddr, - &Override - ); - if (EFI_ERROR (Status)) { - // - // Remove this token from the TxTokens. - // - Udp4RemoveToken (&Instance->TxTokens, Token); - } - -FREE_PACKET: - - NetbufFree (Packet); - -ON_EXIT: - - gBS->RestoreTPL (OldTpl); - - return Status; -} - - -/** - Places an asynchronous receive request into the receiving queue. - - The Receive() function places a completion token into the receive packet queue. - This function is always asynchronous. - The caller must fill in the Token.Event field in the completion token, and this - field cannot be NULL. When the receive operation completes, the EFI UDPv4 Protocol - driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event - is signaled. Providing a proper notification function and context for the event - will enable the user to receive the notification and receiving status. That - notification function is guaranteed to not be re-entered. - - @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. - @param[in] Token Pointer to a token that is associated with - the receive data descriptor. - - @retval EFI_SUCCESS The receive completion token was cached. - @retval EFI_NOT_STARTED This EFI UDPv4 Protocol instance has not been started. - @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, RARP, etc.) - is not finished yet. - @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: - @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system - resources (usually memory). - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. - @retval EFI_ACCESS_DENIED A receive completion token with the same Token.Event was already in - the receive queue. - @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full. - -**/ -EFI_STATUS -EFIAPI -Udp4Receive ( - IN EFI_UDP4_PROTOCOL *This, - IN EFI_UDP4_COMPLETION_TOKEN *Token - ) -{ - EFI_STATUS Status; - UDP4_INSTANCE_DATA *Instance; - EFI_TPL OldTpl; - - if ((This == NULL) || (Token == NULL) || (Token->Event == NULL)) { - return EFI_INVALID_PARAMETER; - } - - Instance = UDP4_INSTANCE_DATA_FROM_THIS (This); - - if (Instance->IsNoMapping) { - return EFI_NO_MAPPING; - } - - if (!Instance->Configured) { - return EFI_NOT_STARTED; - } - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - if (EFI_ERROR (NetMapIterate (&Instance->RxTokens, Udp4TokenExist, Token))|| - EFI_ERROR (NetMapIterate (&Instance->TxTokens, Udp4TokenExist, Token))) { - // - // Return EFI_ACCESS_DENIED if the specified token is already in the TxTokens or - // RxTokens map. - // - Status = EFI_ACCESS_DENIED; - goto ON_EXIT; - } - - Token->Packet.RxData = NULL; - - // - // Save the token into the RxTokens map. - // - Status = NetMapInsertTail (&Instance->RxTokens, Token, NULL); - if (EFI_ERROR (Status)) { - Status = EFI_NOT_READY; - goto ON_EXIT; - } - - // - // If there is an icmp error, report it. - // - Udp4ReportIcmpError (Instance); - - // - // Try to deliver the received datagrams. - // - Udp4InstanceDeliverDgram (Instance); - - // - // Dispatch the DPC queued by the NotifyFunction of Token->Event. - // - DispatchDpc (); - -ON_EXIT: - - gBS->RestoreTPL (OldTpl); - - return Status; -} - - -/** - Aborts an asynchronous transmit or receive request. - - The Cancel() function is used to abort a pending transmit or receive request. - If the token is in the transmit or receive request queues, after calling this - function, Token.Status will be set to EFI_ABORTED and then Token.Event will be - signaled. If the token is not in one of the queues, which usually means that - the asynchronous operation has completed, this function will not signal the - token and EFI_NOT_FOUND is returned. - - @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. - @param[in] Token Pointer to a token that has been issued by - EFI_UDP4_PROTOCOL.Transmit() or - EFI_UDP4_PROTOCOL.Receive().If NULL, all pending - tokens are aborted. - - @retval EFI_SUCCESS The asynchronous I/O request was aborted and Token.Event - was signaled. When Token is NULL, all pending requests are - aborted and their events are signaled. - @retval EFI_INVALID_PARAMETER This is NULL. - @retval EFI_NOT_STARTED This instance has not been started. - @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, - RARP, etc.) is not finished yet. - @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O request was - not found in the transmit or receive queue. It has either completed - or was not issued by Transmit() and Receive(). - -**/ -EFI_STATUS -EFIAPI -Udp4Cancel ( - IN EFI_UDP4_PROTOCOL *This, - IN EFI_UDP4_COMPLETION_TOKEN *Token OPTIONAL - ) -{ - EFI_STATUS Status; - UDP4_INSTANCE_DATA *Instance; - EFI_TPL OldTpl; - - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - Instance = UDP4_INSTANCE_DATA_FROM_THIS (This); - - if (Instance->IsNoMapping) { - return EFI_NO_MAPPING; - } - - if (!Instance->Configured) { - return EFI_NOT_STARTED; - } - - OldTpl = gBS->RaiseTPL (TPL_CALLBACK); - - // - // Cancle the tokens specified by Token for this instance. - // - Status = Udp4InstanceCancelToken (Instance, Token); - - // - // Dispatch the DPC queued by the NotifyFunction of the cancelled token's events. - // - DispatchDpc (); - - gBS->RestoreTPL (OldTpl); - - return Status; -} - - -/** - Polls for incoming data packets and processes outgoing data packets. - - The Poll() function can be used by network drivers and applications to increase - the rate that data packets are moved between the communications device and the - transmit and receive queues. - In some systems, the periodic timer event in the managed network driver may not - poll the underlying communications device fast enough to transmit and/or receive - all data packets without missing incoming packets or dropping outgoing packets. - Drivers and applications that are experiencing packet loss should try calling - the Poll() function more often. - - @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. - - @retval EFI_SUCCESS Incoming or outgoing data was processed. - @retval EFI_INVALID_PARAMETER This is NULL. - @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. - @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue. - -**/ -EFI_STATUS -EFIAPI -Udp4Poll ( - IN EFI_UDP4_PROTOCOL *This - ) -{ - UDP4_INSTANCE_DATA *Instance; - EFI_IP4_PROTOCOL *Ip; - - if (This == NULL) { - return EFI_INVALID_PARAMETER; - } - - Instance = UDP4_INSTANCE_DATA_FROM_THIS (This); - Ip = Instance->IpInfo->Ip.Ip4; - - // - // Invode the Ip instance consumed by the udp instance to do the poll operation. - // - return Ip->Poll (Ip); -} diff --git a/MdeModulePkg/Universal/Network/VlanConfigDxe/ComponentName.c b/MdeModulePkg/Universal/Network/VlanConfigDxe/ComponentName.c deleted file mode 100644 index f36d29f8bd..0000000000 --- a/MdeModulePkg/Universal/Network/VlanConfigDxe/ComponentName.c +++ /dev/null @@ -1,164 +0,0 @@ -/** @file - UEFI Component Name(2) protocol implementation for VlanConfigDxe driver. - -Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "VlanConfigImpl.h" - -// -// EFI Component Name Protocol -// -GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gVlanConfigComponentName = { - VlanConfigComponentNameGetDriverName, - VlanConfigComponentNameGetControllerName, - "eng" -}; - -// -// EFI Component Name 2 Protocol -// -GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gVlanConfigComponentName2 = { - (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) VlanConfigComponentNameGetDriverName, - (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) VlanConfigComponentNameGetControllerName, - "en" -}; - -GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mVlanConfigDriverNameTable[] = { - { - "eng;en", - L"VLAN Configuration Driver" - }, - { - NULL, - NULL - } -}; - -// -// EFI Component Name Functions -// - -/** - Retrieves a Unicode string that is the user readable name of the driver. - - This function retrieves the user readable name of a driver in the form of a - Unicode string. If the driver specified by This has a user readable name in - the language specified by Language, then a pointer to the driver name is - returned in DriverName, and EFI_SUCCESS is returned. If the driver specified - by This does not support the language specified by Language, - then EFI_UNSUPPORTED is returned. - - @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - @param Language[in] A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified - in RFC 4646 or ISO 639-2 language code format. - @param DriverName[out] A pointer to the Unicode string to return. - This Unicode string is the name of the - driver specified by This in the language - specified by Language. - - @retval EFI_SUCCESS The Unicode string for the Driver specified by - This and the language specified by Language was - returned in DriverName. - @retval EFI_INVALID_PARAMETER Language is NULL. - @retval EFI_INVALID_PARAMETER DriverName is NULL. - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -VlanConfigComponentNameGetDriverName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN CHAR8 *Language, - OUT CHAR16 **DriverName - ) -{ - return LookupUnicodeString2 ( - Language, - This->SupportedLanguages, - mVlanConfigDriverNameTable, - DriverName, - (BOOLEAN)(This == &gVlanConfigComponentName) - ); -} - -/** - Retrieves a Unicode string that is the user readable name of the controller - that is being managed by a driver. - - This function retrieves the user readable name of the controller specified by - ControllerHandle and ChildHandle in the form of a Unicode string. If the - driver specified by This has a user readable name in the language specified by - Language, then a pointer to the controller name is returned in ControllerName, - and EFI_SUCCESS is returned. If the driver specified by This is not currently - managing the controller specified by ControllerHandle and ChildHandle, - then EFI_UNSUPPORTED is returned. If the driver specified by This does not - support the language specified by Language, then EFI_UNSUPPORTED is returned. - - @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - @param ControllerHandle[in] The handle of a controller that the driver - specified by This is managing. This handle - specifies the controller whose name is to be - returned. - @param ChildHandle[in] The handle of the child controller to retrieve - the name of. This is an optional parameter that - may be NULL. It will be NULL for device - drivers. It will also be NULL for a bus drivers - that wish to retrieve the name of the bus - controller. It will not be NULL for a bus - driver that wishes to retrieve the name of a - child controller. - @param Language[in] A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified in - RFC 4646 or ISO 639-2 language code format. - @param ControllerName[out] A pointer to the Unicode string to return. - This Unicode string is the name of the - controller specified by ControllerHandle and - ChildHandle in the language specified by - Language from the point of view of the driver - specified by This. - - @retval EFI_SUCCESS The Unicode string for the user readable name in - the language specified by Language for the - driver specified by This was returned in - DriverName. - @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. - @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid - EFI_HANDLE. - @retval EFI_INVALID_PARAMETER Language is NULL. - @retval EFI_INVALID_PARAMETER ControllerName is NULL. - @retval EFI_UNSUPPORTED The driver specified by This is not currently - managing the controller specified by - ControllerHandle and ChildHandle. - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -VlanConfigComponentNameGetControllerName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_HANDLE ChildHandle OPTIONAL, - IN CHAR8 *Language, - OUT CHAR16 **ControllerName - ) -{ - return EFI_UNSUPPORTED; -} diff --git a/MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfig.vfr b/MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfig.vfr deleted file mode 100644 index e493325295..0000000000 --- a/MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfig.vfr +++ /dev/null @@ -1,72 +0,0 @@ -///** @file -// VLAN configuration formset. -// -// Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.
-// SPDX-License-Identifier: BSD-2-Clause-Patent -// -//**/ - -#include "VlanConfigNvData.h" - -formset - guid = VLAN_CONFIG_FORM_SET_GUID, - title = STRING_TOKEN(STR_VLAN_FORM_SET_TITLE), - help = STRING_TOKEN(STR_VLAN_FORM_SET_TITLE_HELP), - classguid = EFI_HII_PLATFORM_SETUP_FORMSET_GUID, - - varstore VLAN_CONFIGURATION, - varid = VLAN_CONFIGURATION_VARSTORE_ID, - name = VlanNvData, - guid = VLAN_CONFIG_FORM_SET_GUID; - - form formid = VLAN_HEAD_FORM_ID, - title = STRING_TOKEN(STR_VLAN_FORM_TITLE); - - goto VLAN_CONFIGURATION_FORM_ID, - prompt = STRING_TOKEN (STR_GET_CURRENT_SETTING), - help = STRING_TOKEN (STR_GET_CURRENT_SETTING_HELP), - flags = INTERACTIVE, - key = VLAN_UPDATE_QUESTION_ID; - - endform; - - form formid = VLAN_CONFIGURATION_FORM_ID, - title = STRING_TOKEN(STR_VLAN_FORM_TITLE); - - subtitle text = STRING_TOKEN(STR_VLAN_CREATE_VLAN); - - numeric varid = VlanNvData.VlanId, - prompt = STRING_TOKEN(STR_VLAN_VID_PROMPT), - help = STRING_TOKEN(STR_VLAN_VID_HELP), - minimum = 0, - maximum = 4094, - endnumeric; - - numeric varid = VlanNvData.Priority, - prompt = STRING_TOKEN(STR_VLAN_PRIORITY_PROMPT), - help = STRING_TOKEN(STR_VLAN_PRIORITY_HELP), - minimum = 0, - maximum = 7, - endnumeric; - - text - help = STRING_TOKEN(STR_VLAN_ADD_VLAN_HELP), - text = STRING_TOKEN(STR_VLAN_ADD_VLAN_PROMPT), - flags = INTERACTIVE, - key = VLAN_ADD_QUESTION_ID; - - subtitle text = STRING_TOKEN(STR_VLAN_NULL_STRING); - subtitle text = STRING_TOKEN(STR_VLAN_VLAN_LIST); - - label LABEL_VLAN_LIST; - label LABEL_END; - - text - help = STRING_TOKEN(STR_VLAN_REMOVE_VLAN_HELP), - text = STRING_TOKEN(STR_VLAN_REMOVE_VLAN_PROMPT), - flags = INTERACTIVE, - key = VLAN_REMOVE_QUESTION_ID; - - endform; - -endformset; diff --git a/MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigDriver.c b/MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigDriver.c deleted file mode 100644 index c717d9ea52..0000000000 --- a/MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigDriver.c +++ /dev/null @@ -1,299 +0,0 @@ -/** @file - The driver binding for VLAN configuration module. - -Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "VlanConfigImpl.h" - -EFI_DRIVER_BINDING_PROTOCOL gVlanConfigDriverBinding = { - VlanConfigDriverBindingSupported, - VlanConfigDriverBindingStart, - VlanConfigDriverBindingStop, - 0xa, - NULL, - NULL -}; - -/** - The entry point for IP4 config driver which install the driver - binding and component name protocol on its image. - - @param[in] ImageHandle The image handle of the driver. - @param[in] SystemTable The system table. - - @retval EFI_SUCCES All the related protocols are installed on the driver. - @retval Others Failed to install protocols. - -**/ -EFI_STATUS -EFIAPI -VlanConfigDriverEntryPoint ( - IN EFI_HANDLE ImageHandle, - IN EFI_SYSTEM_TABLE *SystemTable - ) -{ - return EfiLibInstallDriverBindingComponentName2 ( - ImageHandle, - SystemTable, - &gVlanConfigDriverBinding, - ImageHandle, - &gVlanConfigComponentName, - &gVlanConfigComponentName2 - ); -} - - -/** - Test to see if this driver supports ControllerHandle. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to test - @param[in] RemainingDevicePath Optional parameter use to pick a specific child - device to start. - - @retval EFI_SUCCES This driver supports this device - @retval EFI_ALREADY_STARTED This driver is already running on this device - @retval other This driver does not support this device - -**/ -EFI_STATUS -EFIAPI -VlanConfigDriverBindingSupported ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL - ) -{ - EFI_STATUS Status; - EFI_VLAN_CONFIG_PROTOCOL *VlanConfig; - - Status = gBS->OpenProtocol ( - ControllerHandle, - &gEfiVlanConfigProtocolGuid, - (VOID **) &VlanConfig, - This->DriverBindingHandle, - ControllerHandle, - EFI_OPEN_PROTOCOL_BY_DRIVER - ); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Close the VlanConfig protocol opened for supported test - // - gBS->CloseProtocol ( - ControllerHandle, - &gEfiVlanConfigProtocolGuid, - This->DriverBindingHandle, - ControllerHandle - ); - - return Status; -} - - -/** - Start this driver on ControllerHandle. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to bind driver to - @param[in] RemainingDevicePath Optional parameter use to pick a specific child - device to start. - - @retval EFI_SUCCES This driver is added to ControllerHandle - @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle - @retval other This driver does not support this device - -**/ -EFI_STATUS -EFIAPI -VlanConfigDriverBindingStart ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL - ) -{ - EFI_STATUS Status; - EFI_VLAN_CONFIG_PROTOCOL *VlanConfig; - EFI_DEVICE_PATH_PROTOCOL *DevicePath; - VLAN_CONFIG_PRIVATE_DATA *PrivateData; - - // - // Check for multiple start - // - Status = gBS->OpenProtocol ( - ControllerHandle, - &gEfiCallerIdGuid, - (VOID **) &PrivateData, - This->DriverBindingHandle, - ControllerHandle, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - if (!EFI_ERROR (Status)) { - return EFI_ALREADY_STARTED; - } - - // - // Open VlanConfig protocol by driver - // - Status = gBS->OpenProtocol ( - ControllerHandle, - &gEfiVlanConfigProtocolGuid, - (VOID **) &VlanConfig, - This->DriverBindingHandle, - ControllerHandle, - EFI_OPEN_PROTOCOL_BY_DRIVER - ); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Get parent device path - // - Status = gBS->OpenProtocol ( - ControllerHandle, - &gEfiDevicePathProtocolGuid, - (VOID **) &DevicePath, - This->DriverBindingHandle, - ControllerHandle, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - if (EFI_ERROR (Status)) { - goto ErrorExit; - } - - // - // Create a private data for this network device - // - PrivateData = AllocateCopyPool (sizeof (VLAN_CONFIG_PRIVATE_DATA), &mVlanConfigPrivateDateTemplate); - if (PrivateData == NULL) { - Status = EFI_OUT_OF_RESOURCES; - goto ErrorExit; - } - - PrivateData->ImageHandle = This->DriverBindingHandle; - PrivateData->ControllerHandle = ControllerHandle; - PrivateData->VlanConfig = VlanConfig; - PrivateData->ParentDevicePath = DevicePath; - - // - // Install VLAN configuration form - // - Status = InstallVlanConfigForm (PrivateData); - if (EFI_ERROR (Status)) { - goto ErrorExit; - } - - // - // Install private GUID - // - Status = gBS->InstallMultipleProtocolInterfaces ( - &ControllerHandle, - &gEfiCallerIdGuid, - PrivateData, - NULL - ); - if (EFI_ERROR (Status)) { - goto ErrorExit; - } - return Status; - -ErrorExit: - gBS->CloseProtocol ( - ControllerHandle, - &gEfiVlanConfigProtocolGuid, - This->DriverBindingHandle, - ControllerHandle - ); - - gBS->CloseProtocol ( - ControllerHandle, - &gEfiDevicePathProtocolGuid, - This->DriverBindingHandle, - ControllerHandle - ); - - if (PrivateData != NULL) { - UninstallVlanConfigForm (PrivateData); - FreePool (PrivateData); - } - - return Status; -} - - -/** - Stop this driver on ControllerHandle. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to stop driver on - @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number - of children is zero stop the entire bus driver. - @param[in] ChildHandleBuffer List of Child Handles to Stop. - - @retval EFI_SUCCES This driver is removed ControllerHandle - @retval other This driver was not removed from this device - -**/ -EFI_STATUS -EFIAPI -VlanConfigDriverBindingStop ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN UINTN NumberOfChildren, - IN EFI_HANDLE *ChildHandleBuffer - ) -{ - EFI_STATUS Status; - VLAN_CONFIG_PRIVATE_DATA *PrivateData; - - // - // Retrieve the PrivateData from ControllerHandle - // - Status = gBS->OpenProtocol ( - ControllerHandle, - &gEfiCallerIdGuid, - (VOID **) &PrivateData, - This->DriverBindingHandle, - ControllerHandle, - EFI_OPEN_PROTOCOL_GET_PROTOCOL - ); - if (EFI_ERROR (Status)) { - return Status; - } - ASSERT (PrivateData->Signature == VLAN_CONFIG_PRIVATE_DATA_SIGNATURE); - - if (NumberOfChildren != 0) { - if (NumberOfChildren != 1 || ChildHandleBuffer[0] != PrivateData->DriverHandle) { - return EFI_DEVICE_ERROR; - } - - return UninstallVlanConfigForm (PrivateData); - } - - // - // Uninstall the private GUID - // - Status = gBS->UninstallMultipleProtocolInterfaces ( - ControllerHandle, - &gEfiCallerIdGuid, - PrivateData, - NULL - ); - if (EFI_ERROR (Status)) { - return Status; - } - - Status = gBS->CloseProtocol ( - ControllerHandle, - &gEfiVlanConfigProtocolGuid, - This->DriverBindingHandle, - ControllerHandle - ); - return Status; -} diff --git a/MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigDxe.inf b/MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigDxe.inf deleted file mode 100644 index 72af88d695..0000000000 --- a/MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigDxe.inf +++ /dev/null @@ -1,66 +0,0 @@ -## @file -# This module provides one way to configurate VALN setting. -# -# This module produces EFI HII Configuration Access Protocol to provide one way to -# configurate VALN setting -# -# Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.
-# SPDX-License-Identifier: BSD-2-Clause-Patent -# -## - -[Defines] - INF_VERSION = 0x00010005 - BASE_NAME = VlanConfigDxe - MODULE_UNI_FILE = VlanConfigDxe.uni - FILE_GUID = E4F61863-FE2C-4b56-A8F4-08519BC439DF - MODULE_TYPE = UEFI_DRIVER - VERSION_STRING = 1.0 - ENTRY_POINT = VlanConfigDriverEntryPoint - UNLOAD_IMAGE = NetLibDefaultUnload - - -# -# VALID_ARCHITECTURES = IA32 X64 EBC -# - -[Sources] - ComponentName.c - VlanConfigDriver.c - VlanConfigImpl.c - VlanConfigImpl.h - VlanConfig.vfr - VlanConfigStrings.uni - VlanConfigNvData.h - -[Packages] - MdePkg/MdePkg.dec - MdeModulePkg/MdeModulePkg.dec - -[LibraryClasses] - BaseLib - BaseMemoryLib - MemoryAllocationLib - UefiLib - UefiBootServicesTableLib - UefiDriverEntryPoint - DebugLib - NetLib - HiiLib - -[Guids] - gEfiIfrTianoGuid ## SOMETIMES_PRODUCES ## UNDEFINED - ## SOMETIMES_CONSUMES ## UNDEFINED # HiiIsConfigHdrMatch mVlanStorageName - ## SOMETIMES_PRODUCES ## UNDEFINED # HiiConstructConfigHdr mVlanStorageName - ## SOMETIMES_PRODUCES ## UNDEFINED # HiiGetBrowserData mVlanStorageName - ## SOMETIMES_CONSUMES ## UNDEFINED # HiiSetBrowserData mVlanStorageName - ## SOMETIMES_CONSUMES ## HII - gVlanConfigFormSetGuid - -[Protocols] - gEfiHiiConfigAccessProtocolGuid ## BY_START - gEfiHiiConfigRoutingProtocolGuid ## CONSUMES - gEfiVlanConfigProtocolGuid ## TO_START - -[UserExtensions.TianoCore."ExtraFiles"] - VlanConfigDxeExtra.uni diff --git a/MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigDxe.uni b/MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigDxe.uni deleted file mode 100644 index abc5a1ade1..0000000000 --- a/MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigDxe.uni +++ /dev/null @@ -1,17 +0,0 @@ -// /** @file -// This module provides one way to configurate VALN setting. -// -// This module produces EFI HII Configuration Access Protocol to provide one way to -// configurate VALN setting -// -// Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.
-// -// SPDX-License-Identifier: BSD-2-Clause-Patent -// -// **/ - - -#string STR_MODULE_ABSTRACT #language en-US "Provides a way to configure VLAN settings" - -#string STR_MODULE_DESCRIPTION #language en-US "This module produces EFI HII Configuration Access Protocol to provide a way to configure VLAN settings." - diff --git a/MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigDxeExtra.uni b/MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigDxeExtra.uni deleted file mode 100644 index 0c4eada240..0000000000 --- a/MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigDxeExtra.uni +++ /dev/null @@ -1,14 +0,0 @@ -// /** @file -// VlanConfigDxe Localized Strings and Content -// -// Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.
-// -// SPDX-License-Identifier: BSD-2-Clause-Patent -// -// **/ - -#string STR_PROPERTIES_MODULE_NAME -#language en-US -"VLAN Configuration DXE Driver" - - diff --git a/MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigImpl.c b/MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigImpl.c deleted file mode 100644 index 24d844cbf1..0000000000 --- a/MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigImpl.c +++ /dev/null @@ -1,664 +0,0 @@ -/** @file - HII Config Access protocol implementation of VLAN configuration module. - -Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include "VlanConfigImpl.h" - -CHAR16 mVlanStorageName[] = L"VlanNvData"; -EFI_HII_CONFIG_ROUTING_PROTOCOL *mHiiConfigRouting = NULL; - -VLAN_CONFIG_PRIVATE_DATA mVlanConfigPrivateDateTemplate = { - VLAN_CONFIG_PRIVATE_DATA_SIGNATURE, - { - VlanExtractConfig, - VlanRouteConfig, - VlanCallback - } -}; - -VENDOR_DEVICE_PATH mHiiVendorDevicePathNode = { - { - HARDWARE_DEVICE_PATH, - HW_VENDOR_DP, - { - (UINT8) (sizeof (VENDOR_DEVICE_PATH)), - (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8) - } - }, - VLAN_CONFIG_FORM_SET_GUID -}; - -/** - This function allows a caller to extract the current configuration for one - or more named elements from the target driver. - - @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL. - @param[in] Request A null-terminated Unicode string in - format. - @param[out] Progress On return, points to a character in the Request - string. Points to the string's null terminator if - request was successful. Points to the most recent - '&' before the first failing name/value pair (or - the beginning of the string if the failure is in - the first name/value pair) if the request was not - successful. - @param[out] Results A null-terminated Unicode string in - format which has all values filled - in for the names in the Request string. String to - be allocated by the called function. - - @retval EFI_SUCCESS The Results is filled with the requested values. - @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results. - @retval EFI_INVALID_PARAMETER Request is illegal syntax, or unknown name. - @retval EFI_NOT_FOUND Routing data doesn't match any storage in this - driver. - -**/ -EFI_STATUS -EFIAPI -VlanExtractConfig ( - IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This, - IN CONST EFI_STRING Request, - OUT EFI_STRING *Progress, - OUT EFI_STRING *Results - ) -{ - EFI_STATUS Status; - UINTN BufferSize; - VLAN_CONFIGURATION Configuration; - VLAN_CONFIG_PRIVATE_DATA *PrivateData; - EFI_STRING ConfigRequestHdr; - EFI_STRING ConfigRequest; - BOOLEAN AllocatedRequest; - UINTN Size; - - if (Progress == NULL || Results == NULL) { - return EFI_INVALID_PARAMETER; - } - - *Progress = Request; - if ((Request != NULL) && !HiiIsConfigHdrMatch (Request, &gVlanConfigFormSetGuid, mVlanStorageName)) { - return EFI_NOT_FOUND; - } - - ConfigRequestHdr = NULL; - ConfigRequest = NULL; - AllocatedRequest = FALSE; - Size = 0; - - // - // Retrieve the pointer to the UEFI HII Config Routing Protocol - // - if (mHiiConfigRouting == NULL) { - gBS->LocateProtocol (&gEfiHiiConfigRoutingProtocolGuid, NULL, (VOID **) &mHiiConfigRouting); - } - ASSERT (mHiiConfigRouting != NULL); - - // - // Convert buffer data to by helper function BlockToConfig() - // - PrivateData = VLAN_CONFIG_PRIVATE_DATA_FROM_THIS (This); - ZeroMem (&Configuration, sizeof (VLAN_CONFIGURATION)); - BufferSize = sizeof (Configuration); - ConfigRequest = Request; - if ((Request == NULL) || (StrStr (Request, L"OFFSET") == NULL)) { - // - // Request has no request element, construct full request string. - // Allocate and fill a buffer large enough to hold the template - // followed by "&OFFSET=0&WIDTH=WWWWWWWWWWWWWWWW" followed by a Null-terminator - // - ConfigRequestHdr = HiiConstructConfigHdr (&gVlanConfigFormSetGuid, mVlanStorageName, PrivateData->DriverHandle); - Size = (StrLen (ConfigRequestHdr) + 32 + 1) * sizeof (CHAR16); - ConfigRequest = AllocateZeroPool (Size); - ASSERT (ConfigRequest != NULL); - AllocatedRequest = TRUE; - UnicodeSPrint (ConfigRequest, Size, L"%s&OFFSET=0&WIDTH=%016LX", ConfigRequestHdr, (UINT64)BufferSize); - FreePool (ConfigRequestHdr); - } - - Status = mHiiConfigRouting->BlockToConfig ( - mHiiConfigRouting, - ConfigRequest, - (UINT8 *) &Configuration, - BufferSize, - Results, - Progress - ); - // - // Free the allocated config request string. - // - if (AllocatedRequest) { - FreePool (ConfigRequest); - ConfigRequest = NULL; - } - // - // Set Progress string to the original request string. - // - if (Request == NULL) { - *Progress = NULL; - } else if (StrStr (Request, L"OFFSET") == NULL) { - *Progress = Request + StrLen (Request); - } - - return Status; -} - - -/** - This function processes the results of changes in configuration. - - @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL. - @param[in] Configuration A null-terminated Unicode string in - format. - @param[out] Progress A pointer to a string filled in with the offset of - the most recent '&' before the first failing - name/value pair (or the beginning of the string if - the failure is in the first name/value pair) or - the terminating NULL if all was successful. - - @retval EFI_SUCCESS The Results is processed successfully. - @retval EFI_INVALID_PARAMETER Configuration is NULL. - @retval EFI_NOT_FOUND Routing data doesn't match any storage in this - driver. - -**/ -EFI_STATUS -EFIAPI -VlanRouteConfig ( - IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This, - IN CONST EFI_STRING Configuration, - OUT EFI_STRING *Progress - ) -{ - if (Configuration == NULL || Progress == NULL) { - return EFI_INVALID_PARAMETER; - } - - *Progress = Configuration; - if (!HiiIsConfigHdrMatch (Configuration, &gVlanConfigFormSetGuid, mVlanStorageName)) { - return EFI_NOT_FOUND; - } - - *Progress = Configuration + StrLen (Configuration); - return EFI_SUCCESS; -} - -/** - This function processes the results of changes in configuration. - - @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL. - @param[in] Action Specifies the type of action taken by the browser. - @param[in] QuestionId A unique value which is sent to the original - exporting driver so that it can identify the type - of data to expect. - @param[in] Type The type of value for the question. - @param[in] Value A pointer to the data being sent to the original - exporting driver. - @param[out] ActionRequest On return, points to the action requested by the - callback function. - - @retval EFI_SUCCESS The callback successfully handled the action. - @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the - variable and its data. - @retval EFI_DEVICE_ERROR The variable could not be saved. - @retval EFI_UNSUPPORTED The specified Action is not supported by the - callback. - -**/ -EFI_STATUS -EFIAPI -VlanCallback ( - IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This, - IN EFI_BROWSER_ACTION Action, - IN EFI_QUESTION_ID QuestionId, - IN UINT8 Type, - IN EFI_IFR_TYPE_VALUE *Value, - OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest - ) -{ - VLAN_CONFIG_PRIVATE_DATA *PrivateData; - VLAN_CONFIGURATION *Configuration; - EFI_VLAN_CONFIG_PROTOCOL *VlanConfig; - UINTN Index; - EFI_HANDLE VlanHandle; - - PrivateData = VLAN_CONFIG_PRIVATE_DATA_FROM_THIS (This); - - if ((Action == EFI_BROWSER_ACTION_FORM_OPEN) || (Action == EFI_BROWSER_ACTION_FORM_CLOSE)) { - return EFI_SUCCESS; - } - - if ((Action != EFI_BROWSER_ACTION_CHANGED) && (Action != EFI_BROWSER_ACTION_CHANGING)) { - // - // All other action return unsupported. - // - return EFI_UNSUPPORTED; - } - - // - // Get Browser data - // - Configuration = AllocateZeroPool (sizeof (VLAN_CONFIGURATION)); - ASSERT (Configuration != NULL); - HiiGetBrowserData (&gVlanConfigFormSetGuid, mVlanStorageName, sizeof (VLAN_CONFIGURATION), (UINT8 *) Configuration); - - VlanConfig = PrivateData->VlanConfig; - - if (Action == EFI_BROWSER_ACTION_CHANGED) { - switch (QuestionId) { - case VLAN_ADD_QUESTION_ID: - // - // Add a VLAN - // - VlanConfig->Set (VlanConfig, Configuration->VlanId, Configuration->Priority); - VlanUpdateForm (PrivateData); - - // - // Connect the newly created VLAN device - // - VlanHandle = NetLibGetVlanHandle (PrivateData->ControllerHandle, Configuration->VlanId); - if (VlanHandle == NULL) { - // - // There may be no child handle created for VLAN ID 0, connect the parent handle - // - VlanHandle = PrivateData->ControllerHandle; - } - gBS->ConnectController (VlanHandle, NULL, NULL, TRUE); - - // - // Clear UI data - // - *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_APPLY; - Configuration->VlanId = 0; - Configuration->Priority = 0; - break; - - case VLAN_REMOVE_QUESTION_ID: - // - // Remove VLAN - // - ASSERT (PrivateData->NumberOfVlan <= MAX_VLAN_NUMBER); - for (Index = 0; Index < PrivateData->NumberOfVlan; Index++) { - if (Configuration->VlanList[Index] != 0) { - // - // Checkbox is selected, need remove this VLAN - // - VlanConfig->Remove (VlanConfig, PrivateData->VlanId[Index]); - } - } - - VlanUpdateForm (PrivateData); - if (PrivateData->NumberOfVlan == 0) { - // - // No VLAN device now, connect the physical NIC handle. - // Note: PrivateData->NumberOfVlan has been updated by VlanUpdateForm() - // - gBS->ConnectController (PrivateData->ControllerHandle, NULL, NULL, TRUE); - } - - *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_APPLY; - ZeroMem (Configuration->VlanList, MAX_VLAN_NUMBER); - break; - - default: - break; - } - } else if (Action == EFI_BROWSER_ACTION_CHANGING) { - switch (QuestionId) { - case VLAN_UPDATE_QUESTION_ID: - // - // Update current VLAN list into Form. - // - VlanUpdateForm (PrivateData); - break; - - default: - break; - } - } - - HiiSetBrowserData (&gVlanConfigFormSetGuid, mVlanStorageName, sizeof (VLAN_CONFIGURATION), (UINT8 *) Configuration, NULL); - FreePool (Configuration); - return EFI_SUCCESS; -} - - -/** - This function update VLAN list in the VLAN configuration Form. - - @param[in, out] PrivateData Points to VLAN configuration private data. - -**/ -VOID -VlanUpdateForm ( - IN OUT VLAN_CONFIG_PRIVATE_DATA *PrivateData - ) -{ - EFI_VLAN_CONFIG_PROTOCOL *VlanConfig; - UINT16 NumberOfVlan; - UINTN Index; - EFI_VLAN_FIND_DATA *VlanData; - VOID *StartOpCodeHandle; - EFI_IFR_GUID_LABEL *StartLabel; - VOID *EndOpCodeHandle; - EFI_IFR_GUID_LABEL *EndLabel; - CHAR16 *String; - CHAR16 VlanStr[30]; - CHAR16 VlanIdStr[6]; - UINTN DigitalCount; - EFI_STRING_ID StringId; - - // - // Find current VLAN configuration - // - VlanData = NULL; - NumberOfVlan = 0; - VlanConfig = PrivateData->VlanConfig; - VlanConfig->Find (VlanConfig, NULL, &NumberOfVlan, &VlanData); - - // - // Update VLAN configuration in PrivateData - // - if (NumberOfVlan > MAX_VLAN_NUMBER) { - NumberOfVlan = MAX_VLAN_NUMBER; - } - PrivateData->NumberOfVlan = NumberOfVlan; - - // - // Init OpCode Handle - // - StartOpCodeHandle = HiiAllocateOpCodeHandle (); - ASSERT (StartOpCodeHandle != NULL); - - EndOpCodeHandle = HiiAllocateOpCodeHandle (); - ASSERT (EndOpCodeHandle != NULL); - - // - // Create Hii Extend Label OpCode as the start opcode - // - StartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode ( - StartOpCodeHandle, - &gEfiIfrTianoGuid, - NULL, - sizeof (EFI_IFR_GUID_LABEL) - ); - StartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL; - StartLabel->Number = LABEL_VLAN_LIST; - - // - // Create Hii Extend Label OpCode as the end opcode - // - EndLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode ( - EndOpCodeHandle, - &gEfiIfrTianoGuid, - NULL, - sizeof (EFI_IFR_GUID_LABEL) - ); - EndLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL; - EndLabel->Number = LABEL_END; - - ZeroMem (PrivateData->VlanId, MAX_VLAN_NUMBER); - for (Index = 0; Index < NumberOfVlan; Index++) { - String = VlanStr; - - StrCpyS (String, (sizeof (VlanStr) /sizeof (CHAR16)), L" VLAN ID:"); - String += 10; - // - // Pad VlanId string up to 4 characters with space - // - UnicodeValueToStringS (VlanIdStr, sizeof (VlanIdStr), 0, VlanData[Index].VlanId, 5); - DigitalCount = StrnLenS (VlanIdStr, ARRAY_SIZE (VlanIdStr)); - SetMem16 (String, (4 - DigitalCount) * sizeof (CHAR16), L' '); - StrCpyS (String + 4 - DigitalCount, (sizeof (VlanStr) /sizeof (CHAR16)) - 10 - (4 - DigitalCount), VlanIdStr); - String += 4; - - StrCpyS (String, (sizeof (VlanStr) /sizeof (CHAR16)) - 10 - (4 - DigitalCount) - 4, L", Priority:"); - String += 11; - UnicodeValueToStringS ( - String, - sizeof (VlanStr) - ((UINTN)String - (UINTN)VlanStr), - 0, - VlanData[Index].Priority, - 4 - ); - String += StrnLenS (String, ARRAY_SIZE (VlanStr) - ((UINTN)String - (UINTN)VlanStr) / sizeof (CHAR16)); - *String = 0; - - StringId = HiiSetString (PrivateData->HiiHandle, 0, VlanStr, NULL); - ASSERT (StringId != 0); - - HiiCreateCheckBoxOpCode ( - StartOpCodeHandle, - (EFI_QUESTION_ID) (VLAN_LIST_VAR_OFFSET + Index), - VLAN_CONFIGURATION_VARSTORE_ID, - (UINT16) (VLAN_LIST_VAR_OFFSET + Index), - StringId, - STRING_TOKEN (STR_VLAN_VLAN_LIST_HELP), - 0, - 0, - NULL - ); - - // - // Save VLAN id to private data - // - PrivateData->VlanId[Index] = VlanData[Index].VlanId; - } - - HiiUpdateForm ( - PrivateData->HiiHandle, // HII handle - &gVlanConfigFormSetGuid, // Formset GUID - VLAN_CONFIGURATION_FORM_ID, // Form ID - StartOpCodeHandle, // Label for where to insert opcodes - EndOpCodeHandle // Replace data - ); - - HiiFreeOpCodeHandle (StartOpCodeHandle); - HiiFreeOpCodeHandle (EndOpCodeHandle); - - if (VlanData != NULL) { - FreePool (VlanData); - } -} - - -/** - This function publish the VLAN configuration Form for a network device. The - HII Config Access protocol will be installed on a child handle of the network - device. - - @param[in, out] PrivateData Points to VLAN configuration private data. - - @retval EFI_SUCCESS HII Form is installed for this network device. - @retval EFI_OUT_OF_RESOURCES Not enough resource for HII Form installation. - @retval Others Other errors as indicated. - -**/ -EFI_STATUS -InstallVlanConfigForm ( - IN OUT VLAN_CONFIG_PRIVATE_DATA *PrivateData - ) -{ - EFI_STATUS Status; - EFI_HII_HANDLE HiiHandle; - EFI_HANDLE DriverHandle; - CHAR16 Str[26 + sizeof (EFI_MAC_ADDRESS) * 2 + 1]; - CHAR16 *MacString; - EFI_DEVICE_PATH_PROTOCOL *ChildDevicePath; - EFI_HII_CONFIG_ACCESS_PROTOCOL *ConfigAccess; - EFI_VLAN_CONFIG_PROTOCOL *VlanConfig; - - // - // Create child handle and install HII Config Access Protocol - // - ChildDevicePath = AppendDevicePathNode ( - PrivateData->ParentDevicePath, - (CONST EFI_DEVICE_PATH_PROTOCOL *) &mHiiVendorDevicePathNode - ); - if (ChildDevicePath == NULL) { - return EFI_OUT_OF_RESOURCES; - } - PrivateData->ChildDevicePath = ChildDevicePath; - - DriverHandle = NULL; - ConfigAccess = &PrivateData->ConfigAccess; - Status = gBS->InstallMultipleProtocolInterfaces ( - &DriverHandle, - &gEfiDevicePathProtocolGuid, - ChildDevicePath, - &gEfiHiiConfigAccessProtocolGuid, - ConfigAccess, - NULL - ); - if (EFI_ERROR (Status)) { - return Status; - } - PrivateData->DriverHandle = DriverHandle; - - // - // Establish the parent-child relationship between the new created - // child handle and the ControllerHandle. - // - Status = gBS->OpenProtocol ( - PrivateData->ControllerHandle, - &gEfiVlanConfigProtocolGuid, - (VOID **)&VlanConfig, - PrivateData->ImageHandle, - PrivateData->DriverHandle, - EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER - ); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Publish the HII package list - // - HiiHandle = HiiAddPackages ( - &gVlanConfigFormSetGuid, - DriverHandle, - VlanConfigDxeStrings, - VlanConfigBin, - NULL - ); - if (HiiHandle == NULL) { - return EFI_OUT_OF_RESOURCES; - } - PrivateData->HiiHandle = HiiHandle; - - // - // Update formset title help string. - // - MacString = NULL; - Status = NetLibGetMacString (PrivateData->ControllerHandle, PrivateData->ImageHandle, &MacString); - if (EFI_ERROR (Status)) { - return Status; - } - PrivateData->MacString = MacString; - - StrCpyS (Str, sizeof (Str) / sizeof (CHAR16), L"VLAN Configuration (MAC:"); - StrCatS (Str, sizeof (Str) / sizeof (CHAR16), MacString); - StrCatS (Str, sizeof (Str) / sizeof (CHAR16), L")"); - HiiSetString ( - HiiHandle, - STRING_TOKEN (STR_VLAN_FORM_SET_TITLE_HELP), - Str, - NULL - ); - - // - // Update form title help string. - // - HiiSetString ( - HiiHandle, - STRING_TOKEN (STR_VLAN_FORM_HELP), - Str, - NULL - ); - - return EFI_SUCCESS; -} - -/** - This function remove the VLAN configuration Form for a network device. The - child handle for HII Config Access protocol will be destroyed. - - @param[in, out] PrivateData Points to VLAN configuration private data. - - @retval EFI_SUCCESS HII Form has been uninstalled successfully. - @retval Others Other errors as indicated. - -**/ -EFI_STATUS -UninstallVlanConfigForm ( - IN OUT VLAN_CONFIG_PRIVATE_DATA *PrivateData - ) -{ - EFI_STATUS Status; - EFI_VLAN_CONFIG_PROTOCOL *VlanConfig; - - // - // End the parent-child relationship. - // - Status = gBS->CloseProtocol ( - PrivateData->ControllerHandle, - &gEfiVlanConfigProtocolGuid, - PrivateData->ImageHandle, - PrivateData->DriverHandle - ); - if (EFI_ERROR (Status)) { - return Status; - } - - // - // Uninstall HII Config Access Protocol - // - if (PrivateData->DriverHandle != NULL) { - Status = gBS->UninstallMultipleProtocolInterfaces ( - PrivateData->DriverHandle, - &gEfiDevicePathProtocolGuid, - PrivateData->ChildDevicePath, - &gEfiHiiConfigAccessProtocolGuid, - &PrivateData->ConfigAccess, - NULL - ); - if (EFI_ERROR (Status)) { - gBS->OpenProtocol ( - PrivateData->ControllerHandle, - &gEfiVlanConfigProtocolGuid, - (VOID **)&VlanConfig, - PrivateData->ImageHandle, - PrivateData->DriverHandle, - EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER - ); - return Status; - } - PrivateData->DriverHandle = NULL; - - if (PrivateData->ChildDevicePath != NULL) { - FreePool (PrivateData->ChildDevicePath); - PrivateData->ChildDevicePath = NULL; - } - } - - // - // Free MAC string - // - if (PrivateData->MacString != NULL) { - FreePool (PrivateData->MacString); - PrivateData->MacString = NULL; - } - - // - // Uninstall HII package list - // - if (PrivateData->HiiHandle != NULL) { - HiiRemovePackages (PrivateData->HiiHandle); - PrivateData->HiiHandle = NULL; - } - return EFI_SUCCESS; -} diff --git a/MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigImpl.h b/MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigImpl.h deleted file mode 100644 index 14f99c03b7..0000000000 --- a/MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigImpl.h +++ /dev/null @@ -1,381 +0,0 @@ -/** @file - Header file for driver binding protocol and HII config access protocol. - -Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef __VLAN_CONFIG_IMPL_H__ -#define __VLAN_CONFIG_IMPL_H__ - -#include - -#include -#include -#include -#include -#include - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - -#include - -#include "VlanConfigNvData.h" - -extern EFI_COMPONENT_NAME2_PROTOCOL gVlanConfigComponentName2; -extern EFI_COMPONENT_NAME_PROTOCOL gVlanConfigComponentName; - -// -// Tool generated IFR binary data and String package data -// -extern UINT8 VlanConfigBin[]; -extern UINT8 VlanConfigDxeStrings[]; - -#define VLAN_LIST_VAR_OFFSET ((UINT16) OFFSET_OF (VLAN_CONFIGURATION, VlanList)) - -typedef struct { - UINTN Signature; - - EFI_HII_CONFIG_ACCESS_PROTOCOL ConfigAccess; - EFI_HII_HANDLE HiiHandle; - EFI_HANDLE DriverHandle; - EFI_DEVICE_PATH_PROTOCOL *ChildDevicePath; - - EFI_HANDLE ControllerHandle; - EFI_HANDLE ImageHandle; - EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath; - EFI_VLAN_CONFIG_PROTOCOL *VlanConfig; - CHAR16 *MacString; - - UINT16 NumberOfVlan; - UINT16 VlanId[MAX_VLAN_NUMBER]; -} VLAN_CONFIG_PRIVATE_DATA; - -#define VLAN_CONFIG_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('V', 'C', 'P', 'D') -#define VLAN_CONFIG_PRIVATE_DATA_FROM_THIS(a) CR (a, VLAN_CONFIG_PRIVATE_DATA, ConfigAccess, VLAN_CONFIG_PRIVATE_DATA_SIGNATURE) - -extern VLAN_CONFIG_PRIVATE_DATA mVlanConfigPrivateDateTemplate; - - -/** - Retrieves a Unicode string that is the user readable name of the driver. - - This function retrieves the user readable name of a driver in the form of a - Unicode string. If the driver specified by This has a user readable name in - the language specified by Language, then a pointer to the driver name is - returned in DriverName, and EFI_SUCCESS is returned. If the driver specified - by This does not support the language specified by Language, - then EFI_UNSUPPORTED is returned. - - @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - @param Language[in] A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified - in RFC 4646 or ISO 639-2 language code format. - @param DriverName[out] A pointer to the Unicode string to return. - This Unicode string is the name of the - driver specified by This in the language - specified by Language. - - @retval EFI_SUCCESS The Unicode string for the Driver specified by - This and the language specified by Language was - returned in DriverName. - @retval EFI_INVALID_PARAMETER Language is NULL. - @retval EFI_INVALID_PARAMETER DriverName is NULL. - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -VlanConfigComponentNameGetDriverName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN CHAR8 *Language, - OUT CHAR16 **DriverName - ); - -/** - Retrieves a Unicode string that is the user readable name of the controller - that is being managed by a driver. - - This function retrieves the user readable name of the controller specified by - ControllerHandle and ChildHandle in the form of a Unicode string. If the - driver specified by This has a user readable name in the language specified by - Language, then a pointer to the controller name is returned in ControllerName, - and EFI_SUCCESS is returned. If the driver specified by This is not currently - managing the controller specified by ControllerHandle and ChildHandle, - then EFI_UNSUPPORTED is returned. If the driver specified by This does not - support the language specified by Language, then EFI_UNSUPPORTED is returned. - - @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or - EFI_COMPONENT_NAME_PROTOCOL instance. - @param ControllerHandle[in] The handle of a controller that the driver - specified by This is managing. This handle - specifies the controller whose name is to be - returned. - @param ChildHandle[in] The handle of the child controller to retrieve - the name of. This is an optional parameter that - may be NULL. It will be NULL for device - drivers. It will also be NULL for a bus drivers - that wish to retrieve the name of the bus - controller. It will not be NULL for a bus - driver that wishes to retrieve the name of a - child controller. - @param Language[in] A pointer to a Null-terminated ASCII string - array indicating the language. This is the - language of the driver name that the caller is - requesting, and it must match one of the - languages specified in SupportedLanguages. The - number of languages supported by a driver is up - to the driver writer. Language is specified in - RFC 4646 or ISO 639-2 language code format. - @param ControllerName[out] A pointer to the Unicode string to return. - This Unicode string is the name of the - controller specified by ControllerHandle and - ChildHandle in the language specified by - Language from the point of view of the driver - specified by This. - - @retval EFI_SUCCESS The Unicode string for the user readable name in - the language specified by Language for the - driver specified by This was returned in - DriverName. - @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. - @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid - EFI_HANDLE. - @retval EFI_INVALID_PARAMETER Language is NULL. - @retval EFI_INVALID_PARAMETER ControllerName is NULL. - @retval EFI_UNSUPPORTED The driver specified by This is not currently - managing the controller specified by - ControllerHandle and ChildHandle. - @retval EFI_UNSUPPORTED The driver specified by This does not support - the language specified by Language. - -**/ -EFI_STATUS -EFIAPI -VlanConfigComponentNameGetControllerName ( - IN EFI_COMPONENT_NAME_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_HANDLE ChildHandle OPTIONAL, - IN CHAR8 *Language, - OUT CHAR16 **ControllerName - ); - -/** - Test to see if this driver supports ControllerHandle. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to test - @param[in] RemainingDevicePath Optional parameter use to pick a specific child - device to start. - - @retval EFI_SUCCES This driver supports this device - @retval EFI_ALREADY_STARTED This driver is already running on this device - @retval other This driver does not support this device - -**/ -EFI_STATUS -EFIAPI -VlanConfigDriverBindingSupported ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL - ); - -/** - Start this driver on ControllerHandle. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to bind driver to - @param[in] RemainingDevicePath Optional parameter use to pick a specific child - device to start. - - @retval EFI_SUCCES This driver is added to ControllerHandle - @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle - @retval other This driver does not support this device - -**/ -EFI_STATUS -EFIAPI -VlanConfigDriverBindingStart ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL - ); - -/** - Stop this driver on ControllerHandle. - - @param[in] This Protocol instance pointer. - @param[in] ControllerHandle Handle of device to stop driver on - @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number - of children is zero stop the entire bus driver. - @param[in] ChildHandleBuffer List of Child Handles to Stop. - - @retval EFI_SUCCES This driver is removed ControllerHandle - @retval other This driver was not removed from this device - -**/ -EFI_STATUS -EFIAPI -VlanConfigDriverBindingStop ( - IN EFI_DRIVER_BINDING_PROTOCOL *This, - IN EFI_HANDLE ControllerHandle, - IN UINTN NumberOfChildren, - IN EFI_HANDLE *ChildHandleBuffer - ); - -/** - This function update VLAN list in the VLAN configuration Form. - - @param[in, out] PrivateData Points to VLAN configuration private data. - -**/ -VOID -VlanUpdateForm ( - IN OUT VLAN_CONFIG_PRIVATE_DATA *PrivateData - ); - -/** - This function publish the VLAN configuration Form for a network device. The - HII Config Access protocol will be installed on a child handle of the network - device. - - @param[in, out] PrivateData Points to VLAN configuration private data. - - @retval EFI_SUCCESS HII Form is installed for this network device. - @retval EFI_OUT_OF_RESOURCES Not enough resource for HII Form installation. - @retval Others Other errors as indicated. - -**/ -EFI_STATUS -InstallVlanConfigForm ( - IN OUT VLAN_CONFIG_PRIVATE_DATA *PrivateData - ); - -/** - This function remove the VLAN configuration Form for a network device. The - child handle for HII Config Access protocol will be destroyed. - - @param[in, out] PrivateData Points to VLAN configuration private data. - - @retval EFI_SUCCESS HII Form has been uninstalled successfully. - @retval Others Other errors as indicated. - -**/ -EFI_STATUS -UninstallVlanConfigForm ( - IN OUT VLAN_CONFIG_PRIVATE_DATA *PrivateData - ); - -/** - This function allows a caller to extract the current configuration for one - or more named elements from the target driver. - - @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL. - @param[in] Request A null-terminated Unicode string in - format. - @param[out] Progress On return, points to a character in the Request - string. Points to the string's null terminator if - request was successful. Points to the most recent - '&' before the first failing name/value pair (or - the beginning of the string if the failure is in - the first name/value pair) if the request was not - successful. - @param[out] Results A null-terminated Unicode string in - format which has all values filled - in for the names in the Request string. String to - be allocated by the called function. - - @retval EFI_SUCCESS The Results is filled with the requested values. - @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results. - @retval EFI_INVALID_PARAMETER Request is NULL, illegal syntax, or unknown name. - @retval EFI_NOT_FOUND Routing data doesn't match any storage in this - driver. - -**/ -EFI_STATUS -EFIAPI -VlanExtractConfig ( - IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This, - IN CONST EFI_STRING Request, - OUT EFI_STRING *Progress, - OUT EFI_STRING *Results - ); - -/** - This function processes the results of changes in configuration. - - @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL. - @param[in] Configuration A null-terminated Unicode string in - format. - @param[out] Progress A pointer to a string filled in with the offset of - the most recent '&' before the first failing - name/value pair (or the beginning of the string if - the failure is in the first name/value pair) or - the terminating NULL if all was successful. - - @retval EFI_SUCCESS The Results is processed successfully. - @retval EFI_INVALID_PARAMETER Configuration is NULL. - @retval EFI_NOT_FOUND Routing data doesn't match any storage in this - driver. - -**/ -EFI_STATUS -EFIAPI -VlanRouteConfig ( - IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This, - IN CONST EFI_STRING Configuration, - OUT EFI_STRING *Progress - ); - -/** - This function processes the results of changes in configuration. - - @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL. - @param[in] Action Specifies the type of action taken by the browser. - @param[in] QuestionId A unique value which is sent to the original - exporting driver so that it can identify the type - of data to expect. - @param[in] Type The type of value for the question. - @param[in] Value A pointer to the data being sent to the original - exporting driver. - @param[out] ActionRequest On return, points to the action requested by the - callback function. - - @retval EFI_SUCCESS The callback successfully handled the action. - @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the - variable and its data. - @retval EFI_DEVICE_ERROR The variable could not be saved. - @retval EFI_UNSUPPORTED The specified Action is not supported by the - callback. - -**/ -EFI_STATUS -EFIAPI -VlanCallback ( - IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This, - IN EFI_BROWSER_ACTION Action, - IN EFI_QUESTION_ID QuestionId, - IN UINT8 Type, - IN EFI_IFR_TYPE_VALUE *Value, - OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest - ); - -#endif diff --git a/MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigNvData.h b/MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigNvData.h deleted file mode 100644 index 00b5486901..0000000000 --- a/MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigNvData.h +++ /dev/null @@ -1,40 +0,0 @@ -/** @file - Header file for NV data structure definition. - -Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.
-SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#ifndef __VLAN_CONFIG_NV_DATA_H__ -#define __VLAN_CONFIG_NV_DATA_H__ - -#include -#include - -#define VLAN_CONFIGURATION_VARSTORE_ID 0x0001 -#define VLAN_CONFIGURATION_FORM_ID 0x0001 -#define VLAN_HEAD_FORM_ID 0x0002 - -#define VLAN_ADD_QUESTION_ID 0x1000 -#define VLAN_REMOVE_QUESTION_ID 0x2000 -#define VLAN_UPDATE_QUESTION_ID 0x3000 - -#define LABEL_VLAN_LIST 0x0001 -#define LABEL_END 0xffff - -// -// The maximum number of VLAN that will be displayed on the menu -// -#define MAX_VLAN_NUMBER 100 - -// -// Nv Data structure referenced by IFR -// -typedef struct { - UINT16 VlanId; - UINT8 Priority; - UINT8 VlanList[MAX_VLAN_NUMBER]; -} VLAN_CONFIGURATION; - -#endif diff --git a/MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigStrings.uni b/MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigStrings.uni deleted file mode 100644 index 1ccfd60016..0000000000 --- a/MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigStrings.uni +++ /dev/null @@ -1,31 +0,0 @@ -///** @file -// String definitions for VLAN Configuration Form. -// -// Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.
-// SPDX-License-Identifier: BSD-2-Clause-Patent -// -//**/ - -/=# - -#langdef en-US "English" - -#string STR_VLAN_FORM_SET_TITLE #language en-US "VLAN Configuration" -#string STR_VLAN_FORM_SET_TITLE_HELP #language en-US "VLAN configuration for this network device" -#string STR_VLAN_FORM_TITLE #language en-US "VLAN Configuration" -#string STR_VLAN_FORM_HELP #language en-US "VLAN Configuration Help" -#string STR_VLAN_CREATE_VLAN #language en-US "Create new VLAN" - -#string STR_VLAN_VID_PROMPT #language en-US " VLAN ID" -#string STR_VLAN_VID_HELP #language en-US "VLAN ID of new VLAN or existing VLAN, valid value is 0~4094" -#string STR_VLAN_PRIORITY_PROMPT #language en-US " Priority" -#string STR_VLAN_PRIORITY_HELP #language en-US "802.1Q Priority, valid value is 0~7" -#string STR_VLAN_ADD_VLAN_PROMPT #language en-US "Add VLAN" -#string STR_VLAN_ADD_VLAN_HELP #language en-US "Create a new VLAN or update existing VLAN" -#string STR_VLAN_VLAN_LIST #language en-US "Configured VLAN List" -#string STR_VLAN_VLAN_LIST_HELP #language en-US "Select for remove" -#string STR_VLAN_REMOVE_VLAN_PROMPT #language en-US "Remove VLAN" -#string STR_VLAN_REMOVE_VLAN_HELP #language en-US "Remove selected VLANs" -#string STR_VLAN_NULL_STRING #language en-US "" -#string STR_GET_CURRENT_SETTING #language en-US "Enter Configuration Menu" -#string STR_GET_CURRENT_SETTING_HELP #language en-US "Press ENTER to enter configuration menu for VLAN configuration." diff --git a/NetworkPkg/ArpDxe/ArpDriver.c b/NetworkPkg/ArpDxe/ArpDriver.c new file mode 100644 index 0000000000..632d691d75 --- /dev/null +++ b/NetworkPkg/ArpDxe/ArpDriver.c @@ -0,0 +1,811 @@ +/** @file + ARP driver functions. + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "ArpDriver.h" +#include "ArpImpl.h" + +EFI_DRIVER_BINDING_PROTOCOL gArpDriverBinding = { + ArpDriverBindingSupported, + ArpDriverBindingStart, + ArpDriverBindingStop, + 0xa, + NULL, + NULL +}; + + +/** + Create and initialize the arp service context data. + + @param[in] ImageHandle The image handle representing the loaded driver + image. + @param[in] ControllerHandle The controller handle the driver binds to. + @param[in, out] ArpService Pointer to the buffer containing the arp service + context data. + + @retval EFI_SUCCESS The arp service context is initialized. + + @retval EFI_UNSUPPORTED The underlayer Snp mode type is not ethernet. + Failed to initialize the service context. + @retval other Failed to initialize the arp service context. + +**/ +EFI_STATUS +ArpCreateService ( + IN EFI_HANDLE ImageHandle, + IN EFI_HANDLE ControllerHandle, + IN OUT ARP_SERVICE_DATA *ArpService + ) +{ + EFI_STATUS Status; + + ASSERT (ArpService != NULL); + + ArpService->Signature = ARP_SERVICE_DATA_SIGNATURE; + + // + // Init the lists. + // + InitializeListHead (&ArpService->ChildrenList); + InitializeListHead (&ArpService->PendingRequestTable); + InitializeListHead (&ArpService->DeniedCacheTable); + InitializeListHead (&ArpService->ResolvedCacheTable); + + // + // Init the servicebinding protocol members. + // + ArpService->ServiceBinding.CreateChild = ArpServiceBindingCreateChild; + ArpService->ServiceBinding.DestroyChild = ArpServiceBindingDestroyChild; + + // + // Save the handles. + // + ArpService->ImageHandle = ImageHandle; + ArpService->ControllerHandle = ControllerHandle; + + // + // Create a MNP child instance. + // + Status = NetLibCreateServiceChild ( + ControllerHandle, + ImageHandle, + &gEfiManagedNetworkServiceBindingProtocolGuid, + &ArpService->MnpChildHandle + ); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Open the MNP protocol. + // + Status = gBS->OpenProtocol ( + ArpService->MnpChildHandle, + &gEfiManagedNetworkProtocolGuid, + (VOID **)&ArpService->Mnp, + ImageHandle, + ControllerHandle, + EFI_OPEN_PROTOCOL_BY_DRIVER + ); + if (EFI_ERROR (Status)) { + goto ERROR_EXIT; + } + + // + // Get the underlayer Snp mode data. + // + Status = ArpService->Mnp->GetModeData (ArpService->Mnp, NULL, &ArpService->SnpMode); + if ((Status != EFI_NOT_STARTED) && EFI_ERROR (Status)) { + goto ERROR_EXIT; + } + + if (ArpService->SnpMode.IfType != NET_IFTYPE_ETHERNET) { + // + // Only support the ethernet. + // + Status = EFI_UNSUPPORTED; + goto ERROR_EXIT; + } + + // + // Set the Mnp config parameters. + // + ArpService->MnpConfigData.ReceivedQueueTimeoutValue = 0; + ArpService->MnpConfigData.TransmitQueueTimeoutValue = 0; + ArpService->MnpConfigData.ProtocolTypeFilter = ARP_ETHER_PROTO_TYPE; + ArpService->MnpConfigData.EnableUnicastReceive = TRUE; + ArpService->MnpConfigData.EnableMulticastReceive = FALSE; + ArpService->MnpConfigData.EnableBroadcastReceive = TRUE; + ArpService->MnpConfigData.EnablePromiscuousReceive = FALSE; + ArpService->MnpConfigData.FlushQueuesOnReset = TRUE; + ArpService->MnpConfigData.EnableReceiveTimestamps = FALSE; + ArpService->MnpConfigData.DisableBackgroundPolling = FALSE; + + // + // Configure the Mnp child. + // + Status = ArpService->Mnp->Configure (ArpService->Mnp, &ArpService->MnpConfigData); + if (EFI_ERROR (Status)) { + goto ERROR_EXIT; + } + + // + // Create the event used in the RxToken. + // + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, + ArpOnFrameRcvd, + ArpService, + &ArpService->RxToken.Event + ); + if (EFI_ERROR (Status)) { + goto ERROR_EXIT; + } + + // + // Create the Arp heartbeat timer. + // + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL | EVT_TIMER, + TPL_CALLBACK, + ArpTimerHandler, + ArpService, + &ArpService->PeriodicTimer + ); + if (EFI_ERROR (Status)) { + goto ERROR_EXIT; + } + + // + // Start the heartbeat timer. + // + Status = gBS->SetTimer ( + ArpService->PeriodicTimer, + TimerPeriodic, + ARP_PERIODIC_TIMER_INTERVAL + ); + +ERROR_EXIT: + + return Status; +} + + +/** + Clean the arp service context data. + + @param[in, out] ArpService Pointer to the buffer containing the arp service + context data. + + @return None. + +**/ +VOID +ArpCleanService ( + IN OUT ARP_SERVICE_DATA *ArpService + ) +{ + NET_CHECK_SIGNATURE (ArpService, ARP_SERVICE_DATA_SIGNATURE); + + if (ArpService->PeriodicTimer != NULL) { + // + // Cancle and close the PeriodicTimer. + // + gBS->SetTimer (ArpService->PeriodicTimer, TimerCancel, 0); + gBS->CloseEvent (ArpService->PeriodicTimer); + } + + if (ArpService->RxToken.Event != NULL) { + // + // Cancle the RxToken and close the event in the RxToken. + // + ArpService->Mnp->Cancel (ArpService->Mnp, NULL); + gBS->CloseEvent (ArpService->RxToken.Event); + } + + if (ArpService->Mnp != NULL) { + // + // Reset the Mnp child and close the Mnp protocol. + // + ArpService->Mnp->Configure (ArpService->Mnp, NULL); + gBS->CloseProtocol ( + ArpService->MnpChildHandle, + &gEfiManagedNetworkProtocolGuid, + ArpService->ImageHandle, + ArpService->ControllerHandle + ); + } + + if (ArpService->MnpChildHandle != NULL) { + // + // Destroy the mnp child. + // + NetLibDestroyServiceChild( + ArpService->ControllerHandle, + ArpService->ImageHandle, + &gEfiManagedNetworkServiceBindingProtocolGuid, + ArpService->MnpChildHandle + ); + } +} + +/** + Callback function which provided by user to remove one node in NetDestroyLinkList process. + + @param[in] Entry The entry to be removed. + @param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList. + + @retval EFI_SUCCESS The entry has been removed successfully. + @retval Others Fail to remove the entry. + +**/ +EFI_STATUS +EFIAPI +ArpDestroyChildEntryInHandleBuffer ( + IN LIST_ENTRY *Entry, + IN VOID *Context + ) +{ + ARP_INSTANCE_DATA *Instance; + EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; + + if (Entry == NULL || Context == NULL) { + return EFI_INVALID_PARAMETER; + } + + Instance = NET_LIST_USER_STRUCT_S (Entry, ARP_INSTANCE_DATA, List, ARP_INSTANCE_DATA_SIGNATURE); + ServiceBinding = (EFI_SERVICE_BINDING_PROTOCOL *) Context; + + return ServiceBinding->DestroyChild (ServiceBinding, Instance->Handle); +} + +/** + Tests to see if this driver supports a given controller. + + If a child device is provided, it further tests to see if this driver supports + creating a handle for the specified child device. + + @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. + @param[in] ControllerHandle The handle of the controller to test. This handle + must support a protocol interface that supplies + an I/O abstraction to the driver. + @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. + This parameter is ignored by device drivers, + and is optional for bus drivers. + + @retval EFI_SUCCESS The device specified by ControllerHandle and + RemainingDevicePath is supported by the driver + specified by This. + @retval EFI_ALREADY_STARTED The device specified by ControllerHandle and + RemainingDevicePath is already being managed + by the driver specified by This. + @retval EFI_ACCESS_DENIED The device specified by ControllerHandle and + RemainingDevicePath is already being managed by + a different driver or an application that + requires exclusive acces. Currently not implemented. + @retval EFI_UNSUPPORTED The device specified by ControllerHandle and + RemainingDevicePath is not supported by the + driver specified by This. + +**/ +EFI_STATUS +EFIAPI +ArpDriverBindingSupported ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL + ) +{ + EFI_STATUS Status; + + // + // Test to see if Arp SB is already installed. + // + Status = gBS->OpenProtocol ( + ControllerHandle, + &gEfiArpServiceBindingProtocolGuid, + NULL, + This->DriverBindingHandle, + ControllerHandle, + EFI_OPEN_PROTOCOL_TEST_PROTOCOL + ); + if (Status == EFI_SUCCESS) { + return EFI_ALREADY_STARTED; + } + + // + // Test to see if MNP SB is installed. + // + Status = gBS->OpenProtocol ( + ControllerHandle, + &gEfiManagedNetworkServiceBindingProtocolGuid, + NULL, + This->DriverBindingHandle, + ControllerHandle, + EFI_OPEN_PROTOCOL_TEST_PROTOCOL + ); + + return Status; +} + + +/** + Start this driver on ControllerHandle. + + The Start() function is designed to be invoked from the EFI boot service ConnectController(). + As a result, much of the error checking on the parameters to Start() has been + moved into this common boot service. It is legal to call Start() from other locations, + but the following calling restrictions must be followed or the system behavior + will not be deterministic. + 1. ControllerHandle must be a valid EFI_HANDLE. + 2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally + aligned EFI_DEVICE_PATH_PROTOCOL. + 3. Prior to calling Start(), the Supported() function for the driver specified + by This must have been called with the same calling parameters, and Supported() + must have returned EFI_SUCCESS. + + @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. + @param[in] ControllerHandle The handle of the controller to start. This handle + must support a protocol interface that supplies + an I/O abstraction to the driver. + @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. + This parameter is ignored by device drivers, + and is optional for bus drivers. + + @retval EFI_SUCCESS The device was started. + @retval EFI_DEVICE_ERROR The device could not be started due to a device error. + Currently not implemented. + @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of + resources. + @retval Others The driver failded to start the device. + +**/ +EFI_STATUS +EFIAPI +ArpDriverBindingStart ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL + ) +{ + EFI_STATUS Status; + ARP_SERVICE_DATA *ArpService; + + // + // Allocate a zero pool for ArpService. + // + ArpService = AllocateZeroPool (sizeof(ARP_SERVICE_DATA)); + if (ArpService == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + // + // Initialize the arp service context data. + // + Status = ArpCreateService (This->DriverBindingHandle, ControllerHandle, ArpService); + if (EFI_ERROR (Status)) { + goto ERROR; + } + + // + // Install the ARP service binding protocol. + // + Status = gBS->InstallMultipleProtocolInterfaces ( + &ControllerHandle, + &gEfiArpServiceBindingProtocolGuid, + &ArpService->ServiceBinding, + NULL + ); + if (EFI_ERROR (Status)) { + goto ERROR; + } + + // + // OK, start to receive arp packets from Mnp. + // + Status = ArpService->Mnp->Receive (ArpService->Mnp, &ArpService->RxToken); + if (EFI_ERROR (Status)) { + goto ERROR; + } + + return Status; + +ERROR: + + // + // On error, clean the arp service context data, and free the memory allocated. + // + ArpCleanService (ArpService); + FreePool (ArpService); + + return Status; +} + + +/** + Stop this driver on ControllerHandle. + + Release the control of this controller and remove the IScsi functions. The Stop() + function is designed to be invoked from the EFI boot service DisconnectController(). + As a result, much of the error checking on the parameters to Stop() has been moved + into this common boot service. It is legal to call Stop() from other locations, + but the following calling restrictions must be followed or the system behavior + will not be deterministic. + 1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this + same driver's Start() function. + 2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid + EFI_HANDLE. In addition, all of these handles must have been created in this driver's + Start() function, and the Start() function must have called OpenProtocol() on + ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER. + + @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. + @param[in] ControllerHandle A handle to the device being stopped. The handle must + support a bus specific I/O protocol for the driver + to use to stop the device. + @param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer. + Not used. + @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL + if NumberOfChildren is 0.Not used. + + @retval EFI_SUCCESS The device was stopped. + @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error. + +**/ +EFI_STATUS +EFIAPI +ArpDriverBindingStop ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN UINTN NumberOfChildren, + IN EFI_HANDLE *ChildHandleBuffer + ) +{ + EFI_STATUS Status; + EFI_HANDLE NicHandle; + EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; + ARP_SERVICE_DATA *ArpService; + LIST_ENTRY *List; + + // + // Get the NicHandle which the arp servicebinding is installed on. + // + NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiManagedNetworkProtocolGuid); + if (NicHandle == NULL) { + return EFI_SUCCESS; + } + + // + // Try to get the arp servicebinding protocol on the NicHandle. + // + Status = gBS->OpenProtocol ( + NicHandle, + &gEfiArpServiceBindingProtocolGuid, + (VOID **)&ServiceBinding, + This->DriverBindingHandle, + ControllerHandle, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + if (EFI_ERROR (Status)) { + DEBUG ((EFI_D_ERROR, "ArpDriverBindingStop: Open ArpSb failed, %r.\n", Status)); + return EFI_DEVICE_ERROR; + } + + ArpService = ARP_SERVICE_DATA_FROM_THIS (ServiceBinding); + + if (NumberOfChildren != 0) { + // + // NumberOfChildren is not zero, destroy all the ARP children instances. + // + List = &ArpService->ChildrenList; + Status = NetDestroyLinkList ( + List, + ArpDestroyChildEntryInHandleBuffer, + ServiceBinding, + NULL + ); + ASSERT (IsListEmpty (&ArpService->PendingRequestTable)); + ASSERT (IsListEmpty (&ArpService->DeniedCacheTable)); + ASSERT (IsListEmpty (&ArpService->ResolvedCacheTable)); + } else if (IsListEmpty (&ArpService->ChildrenList)) { + // + // Uninstall the ARP ServiceBinding protocol. + // + gBS->UninstallMultipleProtocolInterfaces ( + NicHandle, + &gEfiArpServiceBindingProtocolGuid, + &ArpService->ServiceBinding, + NULL + ); + + // + // Clean the arp servicebinding context data and free the memory allocated. + // + ArpCleanService (ArpService); + + FreePool (ArpService); + } + + return EFI_SUCCESS; +} + +/** + Creates a child handle and installs a protocol. + + The CreateChild() function installs a protocol on ChildHandle. + If ChildHandle is a pointer to NULL, then a new handle is created and returned + in ChildHandle. If ChildHandle is not a pointer to NULL, then the protocol + installs on the existing ChildHandle. + + @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. + @param ChildHandle Pointer to the handle of the child to create. If it is NULL, + then a new handle is created. If it is a pointer to an existing + UEFI handle, then the protocol is added to the existing UEFI handle. + + @retval EFI_SUCCES The protocol was added to ChildHandle. + @retval EFI_INVALID_PARAMETER ChildHandle is NULL. + @retval EFI_OUT_OF_RESOURCES There are not enough resources available to create + the child + @retval other The child handle was not created + +**/ +EFI_STATUS +EFIAPI +ArpServiceBindingCreateChild ( + IN EFI_SERVICE_BINDING_PROTOCOL *This, + IN EFI_HANDLE *ChildHandle + ) +{ + EFI_STATUS Status; + ARP_SERVICE_DATA *ArpService; + ARP_INSTANCE_DATA *Instance; + VOID *Mnp; + EFI_TPL OldTpl; + + if ((This == NULL) || (ChildHandle == NULL)) { + return EFI_INVALID_PARAMETER; + } + + ArpService = ARP_SERVICE_DATA_FROM_THIS (This); + + // + // Allocate memory for the instance context data. + // + Instance = AllocateZeroPool (sizeof(ARP_INSTANCE_DATA)); + if (Instance == NULL) { + DEBUG ((EFI_D_ERROR, "ArpSBCreateChild: Failed to allocate memory for Instance.\n")); + + return EFI_OUT_OF_RESOURCES; + } + + // + // Init the instance context data. + // + ArpInitInstance (ArpService, Instance); + + // + // Install the ARP protocol onto the ChildHandle. + // + Status = gBS->InstallMultipleProtocolInterfaces ( + ChildHandle, + &gEfiArpProtocolGuid, + (VOID *)&Instance->ArpProto, + NULL + ); + if (EFI_ERROR (Status)) { + DEBUG ((EFI_D_ERROR, "ArpSBCreateChild: faild to install ARP protocol, %r.\n", Status)); + + FreePool (Instance); + return Status; + } + + // + // Save the ChildHandle. + // + Instance->Handle = *ChildHandle; + + // + // Open the Managed Network protocol BY_CHILD. + // + Status = gBS->OpenProtocol ( + ArpService->MnpChildHandle, + &gEfiManagedNetworkProtocolGuid, + (VOID **) &Mnp, + gArpDriverBinding.DriverBindingHandle, + Instance->Handle, + EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER + ); + if (EFI_ERROR (Status)) { + goto ERROR; + } + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + // + // Insert the instance into children list managed by the arp service context data. + // + InsertTailList (&ArpService->ChildrenList, &Instance->List); + ArpService->ChildrenNumber++; + + gBS->RestoreTPL (OldTpl); + +ERROR: + + if (EFI_ERROR (Status)) { + + gBS->CloseProtocol ( + ArpService->MnpChildHandle, + &gEfiManagedNetworkProtocolGuid, + gArpDriverBinding.DriverBindingHandle, + Instance->Handle + ); + + gBS->UninstallMultipleProtocolInterfaces ( + Instance->Handle, + &gEfiArpProtocolGuid, + &Instance->ArpProto, + NULL + ); + + // + // Free the allocated memory. + // + FreePool (Instance); + } + + return Status; +} + + +/** + Destroys a child handle with a protocol installed on it. + + The DestroyChild() function does the opposite of CreateChild(). It removes a protocol + that was installed by CreateChild() from ChildHandle. If the removed protocol is the + last protocol on ChildHandle, then ChildHandle is destroyed. + + @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. + @param ChildHandle Handle of the child to destroy + + @retval EFI_SUCCES The protocol was removed from ChildHandle. + @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is + being removed. + @retval EFI_INVALID_PARAMETER Child handle is NULL. + @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle + because its services are being used. + @retval other The child handle was not destroyed + +**/ +EFI_STATUS +EFIAPI +ArpServiceBindingDestroyChild ( + IN EFI_SERVICE_BINDING_PROTOCOL *This, + IN EFI_HANDLE ChildHandle + ) +{ + EFI_STATUS Status; + ARP_SERVICE_DATA *ArpService; + ARP_INSTANCE_DATA *Instance; + EFI_ARP_PROTOCOL *Arp; + EFI_TPL OldTpl; + + if ((This == NULL) || (ChildHandle == NULL)) { + return EFI_INVALID_PARAMETER; + } + + ArpService = ARP_SERVICE_DATA_FROM_THIS (This); + + // + // Get the arp protocol. + // + Status = gBS->OpenProtocol ( + ChildHandle, + &gEfiArpProtocolGuid, + (VOID **)&Arp, + ArpService->ImageHandle, + ChildHandle, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + if (EFI_ERROR (Status)) { + return EFI_UNSUPPORTED; + } + + Instance = ARP_INSTANCE_DATA_FROM_THIS (Arp); + + if (Instance->InDestroy) { + return EFI_SUCCESS; + } + + // + // Use the InDestroy as a flag to avoid re-entrance. + // + Instance->InDestroy = TRUE; + + // + // Close the Managed Network protocol. + // + gBS->CloseProtocol ( + ArpService->MnpChildHandle, + &gEfiManagedNetworkProtocolGuid, + gArpDriverBinding.DriverBindingHandle, + ChildHandle + ); + + // + // Uninstall the ARP protocol. + // + Status = gBS->UninstallMultipleProtocolInterfaces ( + ChildHandle, + &gEfiArpProtocolGuid, + &Instance->ArpProto, + NULL + ); + if (EFI_ERROR (Status)) { + DEBUG ((EFI_D_ERROR, "ArpSBDestroyChild: Failed to uninstall the arp protocol, %r.\n", + Status)); + + Instance->InDestroy = FALSE; + return Status; + } + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + if (Instance->Configured) { + // + // Delete the related cache entry. + // + ArpDeleteCacheEntry (Instance, FALSE, NULL, TRUE); + + // + // Reset the instance configuration. + // + ArpConfigureInstance (Instance, NULL); + } + + // + // Remove this instance from the ChildrenList. + // + RemoveEntryList (&Instance->List); + ArpService->ChildrenNumber--; + + gBS->RestoreTPL (OldTpl); + + FreePool (Instance); + + return Status; +} + +/** + The entry point for Arp driver which installs the driver binding and component name + protocol on its ImageHandle. + + @param[in] ImageHandle The image handle of the driver. + @param[in] SystemTable The system table. + + @retval EFI_SUCCESS if the driver binding and component name protocols + are successfully + @retval Others Failed to install the protocols. + +**/ +EFI_STATUS +EFIAPI +ArpDriverEntryPoint ( + IN EFI_HANDLE ImageHandle, + IN EFI_SYSTEM_TABLE *SystemTable + ) +{ + return EfiLibInstallDriverBindingComponentName2 ( + ImageHandle, + SystemTable, + &gArpDriverBinding, + ImageHandle, + &gArpComponentName, + &gArpComponentName2 + ); +} + diff --git a/NetworkPkg/ArpDxe/ArpDriver.h b/NetworkPkg/ArpDxe/ArpDriver.h new file mode 100644 index 0000000000..0b5b06ee37 --- /dev/null +++ b/NetworkPkg/ArpDxe/ArpDriver.h @@ -0,0 +1,334 @@ +/** @file + ARP driver header file. + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef _ARP_DRIVER_H_ +#define _ARP_DRIVER_H_ + + +#include + +#include +#include +#include + +#include +#include +#include +#include + + +// +// Global variables +// +extern EFI_DRIVER_BINDING_PROTOCOL gArpDriverBinding; +extern EFI_COMPONENT_NAME_PROTOCOL gArpComponentName; +extern EFI_COMPONENT_NAME2_PROTOCOL gArpComponentName2; + +// +// Function prototypes for the Drivr Binding Protocol +// +/** + Tests to see if this driver supports a given controller. + + If a child device is provided, it further tests to see if this driver supports + creating a handle for the specified child device. + + @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. + @param[in] ControllerHandle The handle of the controller to test. This handle + must support a protocol interface that supplies + an I/O abstraction to the driver. + @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. + This parameter is ignored by device drivers, + and is optional for bus drivers. + + @retval EFI_SUCCESS The device specified by ControllerHandle and + RemainingDevicePath is supported by the driver + specified by This. + @retval EFI_ALREADY_STARTED The device specified by ControllerHandle and + RemainingDevicePath is already being managed + by the driver specified by This. + @retval EFI_ACCESS_DENIED The device specified by ControllerHandle and + RemainingDevicePath is already being managed by + a different driver or an application that + requires exclusive acces. Currently not implemented. + @retval EFI_UNSUPPORTED The device specified by ControllerHandle and + RemainingDevicePath is not supported by the + driver specified by This. + +**/ +EFI_STATUS +EFIAPI +ArpDriverBindingSupported ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL + ); + +/** + Start this driver on ControllerHandle. + + The Start() function is designed to be invoked from the EFI boot service ConnectController(). + As a result, much of the error checking on the parameters to Start() has been + moved into this common boot service. It is legal to call Start() from other locations, + but the following calling restrictions must be followed or the system behavior + will not be deterministic. + 1. ControllerHandle must be a valid EFI_HANDLE. + 2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally + aligned EFI_DEVICE_PATH_PROTOCOL. + 3. Prior to calling Start(), the Supported() function for the driver specified + by This must have been called with the same calling parameters, and Supported() + must have returned EFI_SUCCESS. + + @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. + @param[in] ControllerHandle The handle of the controller to start. This handle + must support a protocol interface that supplies + an I/O abstraction to the driver. + @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. + This parameter is ignored by device drivers, + and is optional for bus drivers. + + @retval EFI_SUCCESS The device was started. + @retval EFI_DEVICE_ERROR The device could not be started due to a device error. + Currently not implemented. + @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of + resources. + @retval Others The driver failded to start the device. + +**/ +EFI_STATUS +EFIAPI +ArpDriverBindingStart ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL + ); + +/** + Stop this driver on ControllerHandle. + + Release the control of this controller and remove the IScsi functions. The Stop() + function is designed to be invoked from the EFI boot service DisconnectController(). + As a result, much of the error checking on the parameters to Stop() has been moved + into this common boot service. It is legal to call Stop() from other locations, + but the following calling restrictions must be followed or the system behavior + will not be deterministic. + 1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this + same driver's Start() function. + 2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid + EFI_HANDLE. In addition, all of these handles must have been created in this driver's + Start() function, and the Start() function must have called OpenProtocol() on + ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER. + + @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. + @param[in] ControllerHandle A handle to the device being stopped. The handle must + support a bus specific I/O protocol for the driver + to use to stop the device. + @param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer. + Not used. + @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL + if NumberOfChildren is 0.Not used. + + @retval EFI_SUCCESS The device was stopped. + @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error. + +**/ +EFI_STATUS +EFIAPI +ArpDriverBindingStop ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN UINTN NumberOfChildren, + IN EFI_HANDLE *ChildHandleBuffer + ); + +/** + Creates a child handle and installs a protocol. + + The CreateChild() function installs a protocol on ChildHandle. + If ChildHandle is a pointer to NULL, then a new handle is created and returned + in ChildHandle. If ChildHandle is not a pointer to NULL, then the protocol + installs on the existing ChildHandle. + + @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. + @param ChildHandle Pointer to the handle of the child to create. If it is NULL, + then a new handle is created. If it is a pointer to an existing + UEFI handle, then the protocol is added to the existing UEFI handle. + + @retval EFI_SUCCES The protocol was added to ChildHandle. + @retval EFI_INVALID_PARAMETER ChildHandle is NULL. + @retval EFI_OUT_OF_RESOURCES There are not enough resources available to create + the child + @retval other The child handle was not created + +**/ +EFI_STATUS +EFIAPI +ArpServiceBindingCreateChild ( + IN EFI_SERVICE_BINDING_PROTOCOL *This, + IN EFI_HANDLE *ChildHandle + ); + +/** + Destroys a child handle with a protocol installed on it. + + The DestroyChild() function does the opposite of CreateChild(). It removes a protocol + that was installed by CreateChild() from ChildHandle. If the removed protocol is the + last protocol on ChildHandle, then ChildHandle is destroyed. + + @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. + @param ChildHandle Handle of the child to destroy + + @retval EFI_SUCCES The protocol was removed from ChildHandle. + @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is + being removed. + @retval EFI_INVALID_PARAMETER Child handle is NULL. + @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle + because its services are being used. + @retval other The child handle was not destroyed + +**/ +EFI_STATUS +EFIAPI +ArpServiceBindingDestroyChild ( + IN EFI_SERVICE_BINDING_PROTOCOL *This, + IN EFI_HANDLE ChildHandle + ); + + +// +// EFI Component Name Functions +// +/** + Retrieves a Unicode string that is the user readable name of the driver. + + This function retrieves the user readable name of a driver in the form of a + Unicode string. If the driver specified by This has a user readable name in + the language specified by Language, then a pointer to the driver name is + returned in DriverName, and EFI_SUCCESS is returned. If the driver specified + by This does not support the language specified by Language, + then EFI_UNSUPPORTED is returned. + + @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param[in] Language A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified + in RFC 4646 or ISO 639-2 language code format. + + @param[out] DriverName A pointer to the Unicode string to return. + This Unicode string is the name of the + driver specified by This in the language + specified by Language. + + @retval EFI_SUCCESS The Unicode string for the Driver specified by + This and the language specified by Language was + returned in DriverName. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER DriverName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +ArpComponentNameGetDriverName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN CHAR8 *Language, + OUT CHAR16 **DriverName + ); + + +/** + Retrieves a Unicode string that is the user readable name of the controller + that is being managed by a driver. + + This function retrieves the user readable name of the controller specified by + ControllerHandle and ChildHandle in the form of a Unicode string. If the + driver specified by This has a user readable name in the language specified by + Language, then a pointer to the controller name is returned in ControllerName, + and EFI_SUCCESS is returned. If the driver specified by This is not currently + managing the controller specified by ControllerHandle and ChildHandle, + then EFI_UNSUPPORTED is returned. If the driver specified by This does not + support the language specified by Language, then EFI_UNSUPPORTED is returned. + + @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param[in] ControllerHandle The handle of a controller that the driver + specified by This is managing. This handle + specifies the controller whose name is to be + returned. + + @param[in] ChildHandle The handle of the child controller to retrieve + the name of. This is an optional parameter that + may be NULL. It will be NULL for device + drivers. It will also be NULL for a bus drivers + that wish to retrieve the name of the bus + controller. It will not be NULL for a bus + driver that wishes to retrieve the name of a + child controller. + + @param[in] Language A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified in + RFC 4646 or ISO 639-2 language code format. + + @param[out] ControllerName A pointer to the Unicode string to return. + This Unicode string is the name of the + controller specified by ControllerHandle and + ChildHandle in the language specified by + Language from the point of view of the driver + specified by This. + + @retval EFI_SUCCESS The Unicode string for the user readable name in + the language specified by Language for the + driver specified by This was returned in + DriverName. + + @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. + + @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid + EFI_HANDLE. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER ControllerName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This is not currently + managing the controller specified by + ControllerHandle and ChildHandle. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +ArpComponentNameGetControllerName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_HANDLE ChildHandle OPTIONAL, + IN CHAR8 *Language, + OUT CHAR16 **ControllerName + ); + + +#endif + diff --git a/NetworkPkg/ArpDxe/ArpDxe.inf b/NetworkPkg/ArpDxe/ArpDxe.inf new file mode 100644 index 0000000000..78344edf90 --- /dev/null +++ b/NetworkPkg/ArpDxe/ArpDxe.inf @@ -0,0 +1,62 @@ +## @file +# This module produces EFI ARP Protocol and EFI ARP Service Binding Protocol. +# +# This module produces EFI ARP Protocol upon EFI MNP Protocol, to provide a generic +# implementation of the Address Resolution Protocol that is described in RFCs 826 +# and 1122. +# +# Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+# SPDX-License-Identifier: BSD-2-Clause-Patent +# +# +## + +[Defines] + INF_VERSION = 0x00010005 + BASE_NAME = ArpDxe + MODULE_UNI_FILE = ArpDxe.uni + FILE_GUID = 529D3F93-E8E9-4e73-B1E1-BDF6A9D50113 + MODULE_TYPE = UEFI_DRIVER + VERSION_STRING = 1.0 + ENTRY_POINT = ArpDriverEntryPoint + UNLOAD_IMAGE = NetLibDefaultUnload +# +# The following information is for reference only and not required by the build tools. +# +# VALID_ARCHITECTURES = IA32 X64 EBC +# +# DRIVER_BINDING = gArpDriverBinding +# COMPONENT_NAME = gArpComponentName +# COMPONENT_NAME2 = gArpComponentName2 +# + +[Sources] + ArpMain.c + ArpDriver.h + ComponentName.c + ArpImpl.h + ArpImpl.c + ArpDriver.c + + +[Packages] + MdePkg/MdePkg.dec + MdeModulePkg/MdeModulePkg.dec + + +[LibraryClasses] + UefiLib + UefiBootServicesTableLib + UefiDriverEntryPoint + DebugLib + NetLib + DpcLib + +[Protocols] + gEfiArpServiceBindingProtocolGuid ## BY_START + gEfiManagedNetworkServiceBindingProtocolGuid ## TO_START + gEfiArpProtocolGuid ## BY_START + gEfiManagedNetworkProtocolGuid ## TO_START + +[UserExtensions.TianoCore."ExtraFiles"] + ArpDxeExtra.uni diff --git a/NetworkPkg/ArpDxe/ArpDxe.uni b/NetworkPkg/ArpDxe/ArpDxe.uni new file mode 100644 index 0000000000..f72063dd43 --- /dev/null +++ b/NetworkPkg/ArpDxe/ArpDxe.uni @@ -0,0 +1,18 @@ +// /** @file +// This module produces EFI ARP Protocol and EFI ARP Service Binding Protocol. +// +// This module produces EFI ARP Protocol upon EFI MNP Protocol, to provide a generic +// implementation of the Address Resolution Protocol that is described in RFCs 826 +// and 1122. +// +// Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+// +// SPDX-License-Identifier: BSD-2-Clause-Patent +// +// **/ + + +#string STR_MODULE_ABSTRACT #language en-US "EFI Address Resolution Protocol" + +#string STR_MODULE_DESCRIPTION #language en-US "This module produces EFI ARP Protocol using the EFI MNP Protocol to provide a generic implementation of the Address Resolution Protocol that is described in RFCs 826 and 1122." + diff --git a/NetworkPkg/ArpDxe/ArpDxeExtra.uni b/NetworkPkg/ArpDxe/ArpDxeExtra.uni new file mode 100644 index 0000000000..be612d002e --- /dev/null +++ b/NetworkPkg/ArpDxe/ArpDxeExtra.uni @@ -0,0 +1,14 @@ +// /** @file +// ArpDxe Localized Strings and Content +// +// Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.
+// +// SPDX-License-Identifier: BSD-2-Clause-Patent +// +// **/ + +#string STR_PROPERTIES_MODULE_NAME +#language en-US +"ARP DXE Driver" + + diff --git a/NetworkPkg/ArpDxe/ArpImpl.c b/NetworkPkg/ArpDxe/ArpImpl.c new file mode 100644 index 0000000000..0e9ef103ef --- /dev/null +++ b/NetworkPkg/ArpDxe/ArpImpl.c @@ -0,0 +1,1667 @@ +/** @file + The implementation of the ARP protocol. + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "ArpImpl.h" + +// +// Global variable of EFI ARP Protocol Interface. +// +EFI_ARP_PROTOCOL mEfiArpProtocolTemplate = { + ArpConfigure, + ArpAdd, + ArpFind, + ArpDelete, + ArpFlush, + ArpRequest, + ArpCancel +}; + + +/** + Initialize the instance context data. + + @param[in] ArpService Pointer to the arp service context data this + instance belongs to. + @param[out] Instance Pointer to the instance context data. + + @return None. + +**/ +VOID +ArpInitInstance ( + IN ARP_SERVICE_DATA *ArpService, + OUT ARP_INSTANCE_DATA *Instance + ) +{ + NET_CHECK_SIGNATURE (ArpService, ARP_SERVICE_DATA_SIGNATURE); + + Instance->Signature = ARP_INSTANCE_DATA_SIGNATURE; + Instance->ArpService = ArpService; + + CopyMem (&Instance->ArpProto, &mEfiArpProtocolTemplate, sizeof (Instance->ArpProto)); + + Instance->Configured = FALSE; + Instance->InDestroy = FALSE; + + InitializeListHead (&Instance->List); +} + + +/** + Process the Arp packets received from Mnp, the procedure conforms to RFC826. + + @param[in] Context Pointer to the context data registerd to the + Event. + + @return None. + +**/ +VOID +EFIAPI +ArpOnFrameRcvdDpc ( + IN VOID *Context + ) +{ + EFI_STATUS Status; + ARP_SERVICE_DATA *ArpService; + EFI_MANAGED_NETWORK_COMPLETION_TOKEN *RxToken; + EFI_MANAGED_NETWORK_RECEIVE_DATA *RxData; + ARP_HEAD *Head; + ARP_ADDRESS ArpAddress; + ARP_CACHE_ENTRY *CacheEntry; + LIST_ENTRY *Entry; + ARP_INSTANCE_DATA *Instance; + EFI_ARP_CONFIG_DATA *ConfigData; + NET_ARP_ADDRESS SenderAddress[2]; + BOOLEAN ProtoMatched; + BOOLEAN IsTarget; + BOOLEAN MergeFlag; + + ArpService = (ARP_SERVICE_DATA *)Context; + NET_CHECK_SIGNATURE (ArpService, ARP_SERVICE_DATA_SIGNATURE); + + RxToken = &ArpService->RxToken; + + if (RxToken->Status == EFI_ABORTED) { + // + // The Token is aborted, possibly by arp itself, just return and the receiving + // process is stopped. + // + return; + } + + if (EFI_ERROR (RxToken->Status)) { + // + // Restart the receiving if any other error Status occurs. + // + goto RESTART_RECEIVE; + } + + // + // Status is EFI_SUCCESS, process the received frame. + // + RxData = RxToken->Packet.RxData; + // + // Sanity check. + // + if (RxData->DataLength < sizeof (ARP_HEAD)) { + // + // Restart the receiving if packet size is not correct. + // + goto RESTART_RECEIVE; + } + + // + // Convert the byte order of the multi-byte fields. + // + Head = (ARP_HEAD *) RxData->PacketData; + Head->HwType = NTOHS (Head->HwType); + Head->ProtoType = NTOHS (Head->ProtoType); + Head->OpCode = NTOHS (Head->OpCode); + + if (RxData->DataLength < (sizeof (ARP_HEAD) + 2 * Head->HwAddrLen + 2 * Head->ProtoAddrLen)) { + goto RESTART_RECEIVE; + } + + if ((Head->HwType != ArpService->SnpMode.IfType) || + (Head->HwAddrLen != ArpService->SnpMode.HwAddressSize) || + (RxData->ProtocolType != ARP_ETHER_PROTO_TYPE)) { + // + // The hardware type or the hardware address length doesn't match. + // There is a sanity check for the protocol type too. + // + goto RECYCLE_RXDATA; + } + + // + // Set the pointers to the addresses contained in the arp packet. + // + ArpAddress.SenderHwAddr = (UINT8 *)(Head + 1); + ArpAddress.SenderProtoAddr = ArpAddress.SenderHwAddr + Head->HwAddrLen; + ArpAddress.TargetHwAddr = ArpAddress.SenderProtoAddr + Head->ProtoAddrLen; + ArpAddress.TargetProtoAddr = ArpAddress.TargetHwAddr + Head->HwAddrLen; + + SenderAddress[Hardware].Type = Head->HwType; + SenderAddress[Hardware].Length = Head->HwAddrLen; + SenderAddress[Hardware].AddressPtr = ArpAddress.SenderHwAddr; + + SenderAddress[Protocol].Type = Head->ProtoType; + SenderAddress[Protocol].Length = Head->ProtoAddrLen; + SenderAddress[Protocol].AddressPtr = ArpAddress.SenderProtoAddr; + + // + // First, check the denied cache table. + // + CacheEntry = ArpFindDeniedCacheEntry ( + ArpService, + &SenderAddress[Protocol], + &SenderAddress[Hardware] + ); + if (CacheEntry != NULL) { + // + // This address (either hardware or protocol address, or both) is configured to + // be a deny entry, silently skip the normal process. + // + goto RECYCLE_RXDATA; + } + + ProtoMatched = FALSE; + IsTarget = FALSE; + Instance = NULL; + NET_LIST_FOR_EACH (Entry, &ArpService->ChildrenList) { + // + // Iterate all the children. + // + Instance = NET_LIST_USER_STRUCT (Entry, ARP_INSTANCE_DATA, List); + NET_CHECK_SIGNATURE (Instance, ARP_INSTANCE_DATA_SIGNATURE); + ConfigData = &Instance->ConfigData; + + if ((Instance->Configured) && + (Head->ProtoType == ConfigData->SwAddressType) && + (Head->ProtoAddrLen == ConfigData->SwAddressLength)) { + // + // The protocol type is matched for the received arp packet. + // + ProtoMatched = TRUE; + if (0 == CompareMem ( + (VOID *)ArpAddress.TargetProtoAddr, + ConfigData->StationAddress, + ConfigData->SwAddressLength + )) { + // + // The arp driver has the target address required by the received arp packet. + // + IsTarget = TRUE; + break; + } + } + } + + if (!ProtoMatched) { + // + // Protocol type unmatchable, skip. + // + goto RECYCLE_RXDATA; + } + + // + // Check whether the sender's address information is already in the cache. + // + MergeFlag = FALSE; + CacheEntry = ArpFindNextCacheEntryInTable ( + &ArpService->ResolvedCacheTable, + NULL, + ByProtoAddress, + &SenderAddress[Protocol], + NULL + ); + if (CacheEntry != NULL) { + // + // Update the entry with the new information. + // + ArpFillAddressInCacheEntry (CacheEntry, &SenderAddress[Hardware], NULL); + CacheEntry->DecayTime = CacheEntry->DefaultDecayTime; + MergeFlag = TRUE; + } + + if (!IsTarget) { + // + // This arp packet isn't targeted to us, skip now. + // + goto RECYCLE_RXDATA; + } + + if (!MergeFlag) { + // + // Add the triplet + // to the translation table. + // + CacheEntry = ArpFindNextCacheEntryInTable ( + &ArpService->PendingRequestTable, + NULL, + ByProtoAddress, + &SenderAddress[Protocol], + NULL + ); + if (CacheEntry == NULL) { + // + // Allocate a new CacheEntry. + // + CacheEntry = ArpAllocCacheEntry (NULL); + if (CacheEntry == NULL) { + goto RECYCLE_RXDATA; + } + } + + if (!IsListEmpty (&CacheEntry->List)) { + RemoveEntryList (&CacheEntry->List); + } + + // + // Fill the addresses into the CacheEntry. + // + ArpFillAddressInCacheEntry ( + CacheEntry, + &SenderAddress[Hardware], + &SenderAddress[Protocol] + ); + + // + // Inform the user. + // + ArpAddressResolved (CacheEntry, NULL, NULL); + + // + // Add this entry into the ResolvedCacheTable + // + InsertHeadList (&ArpService->ResolvedCacheTable, &CacheEntry->List); + } + + if (Head->OpCode == ARP_OPCODE_REQUEST) { + // + // Send back the ARP Reply. If we reach here, Instance is not NULL and CacheEntry + // is not NULL. + // + ArpSendFrame (Instance, CacheEntry, ARP_OPCODE_REPLY); + } + +RECYCLE_RXDATA: + + // + // Signal Mnp to recycle the RxData. + // + gBS->SignalEvent (RxData->RecycleEvent); + +RESTART_RECEIVE: + + // + // Continue to receive packets from Mnp. + // + Status = ArpService->Mnp->Receive (ArpService->Mnp, RxToken); + + DEBUG_CODE ( + if (EFI_ERROR (Status)) { + DEBUG ((EFI_D_ERROR, "ArpOnFrameRcvd: ArpService->Mnp->Receive " + "failed, %r\n.", Status)); + } + ); +} + +/** + Queue ArpOnFrameRcvdDpc as a DPC at TPL_CALLBACK. + + @param[in] Event The Event this notify function registered to. + @param[in] Context Pointer to the context data registerd to the + Event. + + @return None. + +**/ +VOID +EFIAPI +ArpOnFrameRcvd ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + // + // Request ArpOnFrameRcvdDpc as a DPC at TPL_CALLBACK + // + QueueDpc (TPL_CALLBACK, ArpOnFrameRcvdDpc, Context); +} + +/** + Process the already sent arp packets. + + @param[in] Context Pointer to the context data registerd to the + Event. + + @return None. + +**/ +VOID +EFIAPI +ArpOnFrameSentDpc ( + IN VOID *Context + ) +{ + EFI_MANAGED_NETWORK_COMPLETION_TOKEN *TxToken; + EFI_MANAGED_NETWORK_TRANSMIT_DATA *TxData; + + ASSERT (Context != NULL); + + TxToken = (EFI_MANAGED_NETWORK_COMPLETION_TOKEN *)Context; + TxData = TxToken->Packet.TxData; + + DEBUG_CODE ( + if (EFI_ERROR (TxToken->Status)) { + DEBUG ((EFI_D_ERROR, "ArpOnFrameSent: TxToken->Status, %r.\n", TxToken->Status)); + } + ); + + // + // Free the allocated memory and close the event. + // + FreePool (TxData->FragmentTable[0].FragmentBuffer); + FreePool (TxData); + gBS->CloseEvent (TxToken->Event); + FreePool (TxToken); +} + +/** + Request ArpOnFrameSentDpc as a DPC at TPL_CALLBACK. + + @param[in] Event The Event this notify function registered to. + @param[in] Context Pointer to the context data registerd to the + Event. + + @return None. + +**/ +VOID +EFIAPI +ArpOnFrameSent ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + // + // Request ArpOnFrameSentDpc as a DPC at TPL_CALLBACK + // + QueueDpc (TPL_CALLBACK, ArpOnFrameSentDpc, Context); +} + + +/** + Process the arp cache olding and drive the retrying arp requests. + + @param[in] Event The Event this notify function registered to. + @param[in] Context Pointer to the context data registerd to the + Event. + + @return None. + +**/ +VOID +EFIAPI +ArpTimerHandler ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + ARP_SERVICE_DATA *ArpService; + LIST_ENTRY *Entry; + LIST_ENTRY *NextEntry; + LIST_ENTRY *ContextEntry; + ARP_CACHE_ENTRY *CacheEntry; + USER_REQUEST_CONTEXT *RequestContext; + + ASSERT (Context != NULL); + ArpService = (ARP_SERVICE_DATA *)Context; + + // + // Iterate all the pending requests to see whether a retry is needed to send out + // or the request finally fails because the retry time reaches the limitation. + // + NET_LIST_FOR_EACH_SAFE (Entry, NextEntry, &ArpService->PendingRequestTable) { + CacheEntry = NET_LIST_USER_STRUCT (Entry, ARP_CACHE_ENTRY, List); + + if (CacheEntry->NextRetryTime <= ARP_PERIODIC_TIMER_INTERVAL) { + // + // Timeout, if we can retry more, send out the request again, otherwise abort + // this request. + // + if (CacheEntry->RetryCount == 0) { + // + // Abort this request. + // + ArpAddressResolved (CacheEntry, NULL, NULL); + ASSERT (IsListEmpty (&CacheEntry->UserRequestList)); + + RemoveEntryList (&CacheEntry->List); + FreePool (CacheEntry); + } else { + // + // resend the ARP request. + // + ASSERT (!IsListEmpty(&CacheEntry->UserRequestList)); + + ContextEntry = CacheEntry->UserRequestList.ForwardLink; + RequestContext = NET_LIST_USER_STRUCT (ContextEntry, USER_REQUEST_CONTEXT, List); + + ArpSendFrame (RequestContext->Instance, CacheEntry, ARP_OPCODE_REQUEST); + + CacheEntry->RetryCount--; + CacheEntry->NextRetryTime = RequestContext->Instance->ConfigData.RetryTimeOut; + } + } else { + // + // Update the NextRetryTime. + // + CacheEntry->NextRetryTime -= ARP_PERIODIC_TIMER_INTERVAL; + } + } + + // + // Check the timeouts for the DeniedCacheTable. + // + NET_LIST_FOR_EACH_SAFE (Entry, NextEntry, &ArpService->DeniedCacheTable) { + CacheEntry = NET_LIST_USER_STRUCT (Entry, ARP_CACHE_ENTRY, List); + ASSERT (IsListEmpty (&CacheEntry->UserRequestList)); + + if (CacheEntry->DefaultDecayTime == 0) { + // + // It's a static entry, skip it. + // + continue; + } + + if (CacheEntry->DecayTime <= ARP_PERIODIC_TIMER_INTERVAL) { + // + // Time out, remove it. + // + RemoveEntryList (&CacheEntry->List); + FreePool (CacheEntry); + } else { + // + // Update the DecayTime. + // + CacheEntry->DecayTime -= ARP_PERIODIC_TIMER_INTERVAL; + } + } + + // + // Check the timeouts for the ResolvedCacheTable. + // + NET_LIST_FOR_EACH_SAFE (Entry, NextEntry, &ArpService->ResolvedCacheTable) { + CacheEntry = NET_LIST_USER_STRUCT (Entry, ARP_CACHE_ENTRY, List); + ASSERT (IsListEmpty (&CacheEntry->UserRequestList)); + + if (CacheEntry->DefaultDecayTime == 0) { + // + // It's a static entry, skip it. + // + continue; + } + + if (CacheEntry->DecayTime <= ARP_PERIODIC_TIMER_INTERVAL) { + // + // Time out, remove it. + // + RemoveEntryList (&CacheEntry->List); + FreePool (CacheEntry); + } else { + // + // Update the DecayTime. + // + CacheEntry->DecayTime -= ARP_PERIODIC_TIMER_INTERVAL; + } + } +} + + +/** + Match the two NET_ARP_ADDRESSes. + + @param[in] AddressOne Pointer to the first address to match. + @param[in] AddressTwo Pointer to the second address to match. + + @return The two addresses match or not. + +**/ +BOOLEAN +ArpMatchAddress ( + IN NET_ARP_ADDRESS *AddressOne, + IN NET_ARP_ADDRESS *AddressTwo + ) +{ + ASSERT (AddressOne != NULL && AddressTwo != NULL); + + if ((AddressOne->Type != AddressTwo->Type) || + (AddressOne->Length != AddressTwo->Length)) { + // + // Either Type or Length doesn't match. + // + return FALSE; + } + + if ((AddressOne->AddressPtr != NULL) && + (CompareMem ( + AddressOne->AddressPtr, + AddressTwo->AddressPtr, + AddressOne->Length + ) != 0)) { + // + // The address is not the same. + // + return FALSE; + } + + return TRUE; +} + + +/** + Find the CacheEntry which matches the requirements in the specified CacheTable. + + @param[in] CacheTable Pointer to the arp cache table. + @param[in] StartEntry Pointer to the start entry this search begins with + in the cache table. + @param[in] FindOpType The search type. + @param[in] ProtocolAddress Pointer to the protocol address to match. + @param[in] HardwareAddress Pointer to the hardware address to match. + + @return Pointer to the matched arp cache entry, if NULL, no match is found. + +**/ +ARP_CACHE_ENTRY * +ArpFindNextCacheEntryInTable ( + IN LIST_ENTRY *CacheTable, + IN LIST_ENTRY *StartEntry, + IN FIND_OPTYPE FindOpType, + IN NET_ARP_ADDRESS *ProtocolAddress OPTIONAL, + IN NET_ARP_ADDRESS *HardwareAddress OPTIONAL + ) +{ + LIST_ENTRY *Entry; + ARP_CACHE_ENTRY *CacheEntry; + + if (StartEntry == NULL) { + // + // Start from the beginning of the table if no StartEntry is specified. + // + StartEntry = CacheTable; + } + + for (Entry = StartEntry->ForwardLink; Entry != CacheTable; Entry = Entry->ForwardLink) { + CacheEntry = NET_LIST_USER_STRUCT (Entry, ARP_CACHE_ENTRY, List); + + if ((FindOpType & MATCH_SW_ADDRESS) != 0) { + // + // Find by the software address. + // + if (!ArpMatchAddress (ProtocolAddress, &CacheEntry->Addresses[Protocol])) { + // + // The ProtocolAddress doesn't match, continue to the next cache entry. + // + continue; + } + } + + if ((FindOpType & MATCH_HW_ADDRESS) != 0) { + // + // Find by the hardware address. + // + if (!ArpMatchAddress (HardwareAddress, &CacheEntry->Addresses[Hardware])) { + // + // The HardwareAddress doesn't match, continue to the next cache entry. + // + continue; + } + } + + // + // The CacheEntry meets the requirements now, return this entry. + // + return CacheEntry; + } + + // + // No matching. + // + return NULL; +} + + +/** + Find the CacheEntry, using ProtocolAddress or HardwareAddress or both, as the keyword, + in the DeniedCacheTable. + + @param[in] ArpService Pointer to the arp service context data. + @param[in] ProtocolAddress Pointer to the protocol address. + @param[in] HardwareAddress Pointer to the hardware address. + + @return Pointer to the matched cache entry, if NULL no match is found. + +**/ +ARP_CACHE_ENTRY * +ArpFindDeniedCacheEntry ( + IN ARP_SERVICE_DATA *ArpService, + IN NET_ARP_ADDRESS *ProtocolAddress OPTIONAL, + IN NET_ARP_ADDRESS *HardwareAddress OPTIONAL + ) +{ + ARP_CACHE_ENTRY *CacheEntry; + + ASSERT ((ProtocolAddress != NULL) || (HardwareAddress != NULL)); + NET_CHECK_SIGNATURE (ArpService, ARP_SERVICE_DATA_SIGNATURE); + + CacheEntry = NULL; + + if ((ProtocolAddress != NULL) && (ProtocolAddress->AddressPtr != NULL)) { + // + // Find the cache entry in the DeniedCacheTable by the protocol address. + // + CacheEntry = ArpFindNextCacheEntryInTable ( + &ArpService->DeniedCacheTable, + NULL, + ByProtoAddress, + ProtocolAddress, + NULL + ); + if (CacheEntry != NULL) { + // + // There is a match. + // + return CacheEntry; + } + } + + if ((HardwareAddress != NULL) && (HardwareAddress->AddressPtr != NULL)) { + // + // Find the cache entry in the DeniedCacheTable by the hardware address. + // + CacheEntry = ArpFindNextCacheEntryInTable ( + &ArpService->DeniedCacheTable, + NULL, + ByHwAddress, + NULL, + HardwareAddress + ); + } + + return CacheEntry; +} + + +/** + Allocate a cache entry and initialize it. + + @param[in] Instance Pointer to the instance context data. + + @return Pointer to the new created cache entry. + +**/ +ARP_CACHE_ENTRY * +ArpAllocCacheEntry ( + IN ARP_INSTANCE_DATA *Instance + ) +{ + ARP_CACHE_ENTRY *CacheEntry; + NET_ARP_ADDRESS *Address; + UINT16 Index; + + // + // Allocate memory for the cache entry. + // + CacheEntry = AllocatePool (sizeof (ARP_CACHE_ENTRY)); + if (CacheEntry == NULL) { + return NULL; + } + + // + // Init the lists. + // + InitializeListHead (&CacheEntry->List); + InitializeListHead (&CacheEntry->UserRequestList); + + for (Index = 0; Index < 2; Index++) { + // + // Init the address pointers to point to the concrete buffer. + // + Address = &CacheEntry->Addresses[Index]; + Address->AddressPtr = Address->Buffer.ProtoAddress; + } + + // + // Zero the hardware address first. + // + ZeroMem (CacheEntry->Addresses[Hardware].AddressPtr, ARP_MAX_HARDWARE_ADDRESS_LEN); + + if (Instance != NULL) { + // + // Inherit the parameters from the instance configuration. + // + CacheEntry->RetryCount = Instance->ConfigData.RetryCount; + CacheEntry->NextRetryTime = Instance->ConfigData.RetryTimeOut; + CacheEntry->DefaultDecayTime = Instance->ConfigData.EntryTimeOut; + CacheEntry->DecayTime = Instance->ConfigData.EntryTimeOut; + } else { + // + // Use the default parameters if this cache entry isn't allocate in a + // instance's scope. + // + CacheEntry->RetryCount = ARP_DEFAULT_RETRY_COUNT; + CacheEntry->NextRetryTime = ARP_DEFAULT_RETRY_INTERVAL; + CacheEntry->DefaultDecayTime = ARP_DEFAULT_TIMEOUT_VALUE; + CacheEntry->DecayTime = ARP_DEFAULT_TIMEOUT_VALUE; + } + + return CacheEntry; +} + + +/** + Turn the CacheEntry into the resolved status. + + @param[in] CacheEntry Pointer to the resolved cache entry. + @param[in] Instance Pointer to the instance context data. + @param[in] UserEvent Pointer to the UserEvent to notify. + + @return The count of notifications sent to the instance. + +**/ +UINTN +ArpAddressResolved ( + IN ARP_CACHE_ENTRY *CacheEntry, + IN ARP_INSTANCE_DATA *Instance OPTIONAL, + IN EFI_EVENT UserEvent OPTIONAL + ) +{ + LIST_ENTRY *Entry; + LIST_ENTRY *NextEntry; + USER_REQUEST_CONTEXT *Context; + UINTN Count; + + Count = 0; + + // + // Iterate all the linked user requests to notify them. + // + NET_LIST_FOR_EACH_SAFE (Entry, NextEntry, &CacheEntry->UserRequestList) { + Context = NET_LIST_USER_STRUCT (Entry, USER_REQUEST_CONTEXT, List); + + if (((Instance == NULL) || (Context->Instance == Instance)) && + ((UserEvent == NULL) || (Context->UserRequestEvent == UserEvent))) { + // + // Copy the address to the user-provided buffer and notify the user. + // + CopyMem ( + Context->UserHwAddrBuffer, + CacheEntry->Addresses[Hardware].AddressPtr, + CacheEntry->Addresses[Hardware].Length + ); + gBS->SignalEvent (Context->UserRequestEvent); + + // + // Remove this user request and free the context data. + // + RemoveEntryList (&Context->List); + FreePool (Context); + + Count++; + } + } + + // + // Dispatch the DPCs queued by the NotifyFunction of the Context->UserRequestEvent. + // + DispatchDpc (); + + return Count; +} + + +/** + Fill the addresses in the CacheEntry using the information passed in by + HwAddr and SwAddr. + + @param[in] CacheEntry Pointer to the cache entry. + @param[in] HwAddr Pointer to the software address. + @param[in] SwAddr Pointer to the hardware address. + + @return None. + +**/ +VOID +ArpFillAddressInCacheEntry ( + IN ARP_CACHE_ENTRY *CacheEntry, + IN NET_ARP_ADDRESS *HwAddr OPTIONAL, + IN NET_ARP_ADDRESS *SwAddr OPTIONAL + ) +{ + NET_ARP_ADDRESS *Address[2]; + NET_ARP_ADDRESS *CacheAddress; + UINT32 Index; + + Address[Hardware] = HwAddr; + Address[Protocol] = SwAddr; + + for (Index = 0; Index < 2; Index++) { + if (Address[Index] != NULL) { + // + // Fill the address if the passed in pointer is not NULL. + // + CacheAddress = &CacheEntry->Addresses[Index]; + + CacheAddress->Type = Address[Index]->Type; + CacheAddress->Length = Address[Index]->Length; + + if (Address[Index]->AddressPtr != NULL) { + // + // Copy it if the AddressPtr points to some buffer. + // + CopyMem ( + CacheAddress->AddressPtr, + Address[Index]->AddressPtr, + CacheAddress->Length + ); + } else { + // + // Zero the corresponding address buffer in the CacheEntry. + // + ZeroMem (CacheAddress->AddressPtr, CacheAddress->Length); + } + } + } +} + + +/** + Configure the instance using the ConfigData. ConfigData is already validated. + + @param[in] Instance Pointer to the instance context data to be + configured. + @param[in] ConfigData Pointer to the configuration data used to + configure the instance. + + @retval EFI_SUCCESS The instance is configured with the ConfigData. + @retval EFI_ACCESS_DENIED The instance is already configured and the + ConfigData tries to reset some unchangeable + fields. + @retval EFI_INVALID_PARAMETER The ConfigData provides a non-unicast IPv4 address + when the SwAddressType is IPv4. + @retval EFI_OUT_OF_RESOURCES The instance fails to configure due to memory + limitation. + +**/ +EFI_STATUS +ArpConfigureInstance ( + IN ARP_INSTANCE_DATA *Instance, + IN EFI_ARP_CONFIG_DATA *ConfigData OPTIONAL + ) +{ + EFI_ARP_CONFIG_DATA *OldConfigData; + IP4_ADDR Ip; + + OldConfigData = &Instance->ConfigData; + + if (ConfigData != NULL) { + + if (Instance->Configured) { + // + // The instance is configured, check the unchangeable fields. + // + if ((OldConfigData->SwAddressType != ConfigData->SwAddressType) || + (OldConfigData->SwAddressLength != ConfigData->SwAddressLength) || + (CompareMem ( + OldConfigData->StationAddress, + ConfigData->StationAddress, + OldConfigData->SwAddressLength + ) != 0)) { + // + // Deny the unallowed changes. + // + return EFI_ACCESS_DENIED; + } + } else { + // + // The instance is not configured. + // + + if (ConfigData->SwAddressType == IPV4_ETHER_PROTO_TYPE) { + CopyMem (&Ip, ConfigData->StationAddress, sizeof (IP4_ADDR)); + + if (IP4_IS_UNSPECIFIED (Ip) || IP4_IS_LOCAL_BROADCAST (Ip)) { + // + // The station address should not be zero or broadcast address. + // + return EFI_INVALID_PARAMETER; + } + } + + // + // Save the configuration. + // + CopyMem (OldConfigData, ConfigData, sizeof (*OldConfigData)); + + OldConfigData->StationAddress = AllocatePool (OldConfigData->SwAddressLength); + if (OldConfigData->StationAddress == NULL) { + DEBUG ((EFI_D_ERROR, "ArpConfigInstance: AllocatePool for the StationAddress " + "failed.\n")); + return EFI_OUT_OF_RESOURCES; + } + + // + // Save the StationAddress. + // + CopyMem ( + OldConfigData->StationAddress, + ConfigData->StationAddress, + OldConfigData->SwAddressLength + ); + + // + // Set the state to configured. + // + Instance->Configured = TRUE; + } + + // + // Use the implementation specific values if the following field is zero. + // + OldConfigData->EntryTimeOut = (ConfigData->EntryTimeOut == 0) ? + ARP_DEFAULT_TIMEOUT_VALUE : ConfigData->EntryTimeOut; + + OldConfigData->RetryCount = (ConfigData->RetryCount == 0) ? + ARP_DEFAULT_RETRY_COUNT : ConfigData->RetryCount; + + OldConfigData->RetryTimeOut = (ConfigData->RetryTimeOut == 0) ? + ARP_DEFAULT_RETRY_INTERVAL : ConfigData->RetryTimeOut; + } else { + // + // Reset the configuration. + // + + if (Instance->Configured) { + // + // Cancel the arp requests issued by this instance. + // + Instance->ArpProto.Cancel (&Instance->ArpProto, NULL, NULL); + + // + // Free the buffer previously allocated to hold the station address. + // + FreePool (OldConfigData->StationAddress); + } + + Instance->Configured = FALSE; + } + + return EFI_SUCCESS; +} + + +/** + Send out an arp frame using the CachEntry and the ArpOpCode. + + @param[in] Instance Pointer to the instance context data. + @param[in] CacheEntry Pointer to the configuration data used to + configure the instance. + @param[in] ArpOpCode The opcode used to send out this Arp frame, either + request or reply. + + @return None. + +**/ +VOID +ArpSendFrame ( + IN ARP_INSTANCE_DATA *Instance, + IN ARP_CACHE_ENTRY *CacheEntry, + IN UINT16 ArpOpCode + ) +{ + EFI_STATUS Status; + EFI_MANAGED_NETWORK_COMPLETION_TOKEN *TxToken; + EFI_MANAGED_NETWORK_TRANSMIT_DATA *TxData; + UINT32 TotalLength; + UINT8 *Packet; + ARP_SERVICE_DATA *ArpService; + EFI_SIMPLE_NETWORK_MODE *SnpMode; + EFI_ARP_CONFIG_DATA *ConfigData; + UINT8 *TmpPtr; + ARP_HEAD *ArpHead; + + ASSERT ((Instance != NULL) && (CacheEntry != NULL)); + + // + // Allocate memory for the TxToken. + // + TxToken = AllocatePool (sizeof(EFI_MANAGED_NETWORK_COMPLETION_TOKEN)); + if (TxToken == NULL) { + DEBUG ((EFI_D_ERROR, "ArpSendFrame: Allocate memory for TxToken failed.\n")); + return; + } + + TxToken->Event = NULL; + TxData = NULL; + Packet = NULL; + + // + // Create the event for this TxToken. + // + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, + ArpOnFrameSent, + (VOID *)TxToken, + &TxToken->Event + ); + if (EFI_ERROR (Status)) { + DEBUG ((EFI_D_ERROR, "ArpSendFrame: CreateEvent failed for TxToken->Event.\n")); + goto CLEAN_EXIT; + } + + // + // Allocate memory for the TxData used in the TxToken. + // + TxData = AllocatePool (sizeof(EFI_MANAGED_NETWORK_TRANSMIT_DATA)); + if (TxData == NULL) { + DEBUG ((EFI_D_ERROR, "ArpSendFrame: Allocate memory for TxData failed.\n")); + goto CLEAN_EXIT; + } + + ArpService = Instance->ArpService; + SnpMode = &ArpService->SnpMode; + ConfigData = &Instance->ConfigData; + + // + // Calculate the buffer length for this arp frame. + // + TotalLength = SnpMode->MediaHeaderSize + sizeof (ARP_HEAD) + + 2 * (ConfigData->SwAddressLength + SnpMode->HwAddressSize); + + // + // Allocate buffer for the arp frame. + // + Packet = AllocatePool (TotalLength); + if (Packet == NULL) { + DEBUG ((EFI_D_ERROR, "ArpSendFrame: Allocate memory for Packet failed.\n")); + ASSERT (Packet != NULL); + } + + TmpPtr = Packet; + + // + // The destination MAC address. + // + if (ArpOpCode == ARP_OPCODE_REQUEST) { + CopyMem (TmpPtr, &SnpMode->BroadcastAddress, SnpMode->HwAddressSize); + } else { + CopyMem ( + TmpPtr, + CacheEntry->Addresses[Hardware].AddressPtr, + SnpMode->HwAddressSize + ); + } + TmpPtr += SnpMode->HwAddressSize; + + // + // The source MAC address. + // + CopyMem (TmpPtr, &SnpMode->CurrentAddress, SnpMode->HwAddressSize); + TmpPtr += SnpMode->HwAddressSize; + + // + // The ethernet protocol type. + // + *(UINT16 *)TmpPtr = HTONS (ARP_ETHER_PROTO_TYPE); + TmpPtr += 2; + + // + // The ARP Head. + // + ArpHead = (ARP_HEAD *) TmpPtr; + ArpHead->HwType = HTONS ((UINT16)SnpMode->IfType); + ArpHead->ProtoType = HTONS (ConfigData->SwAddressType); + ArpHead->HwAddrLen = (UINT8)SnpMode->HwAddressSize; + ArpHead->ProtoAddrLen = ConfigData->SwAddressLength; + ArpHead->OpCode = HTONS (ArpOpCode); + TmpPtr += sizeof (ARP_HEAD); + + // + // The sender hardware address. + // + CopyMem (TmpPtr, &SnpMode->CurrentAddress, SnpMode->HwAddressSize); + TmpPtr += SnpMode->HwAddressSize; + + // + // The sender protocol address. + // + CopyMem (TmpPtr, ConfigData->StationAddress, ConfigData->SwAddressLength); + TmpPtr += ConfigData->SwAddressLength; + + // + // The target hardware address. + // + CopyMem ( + TmpPtr, + CacheEntry->Addresses[Hardware].AddressPtr, + SnpMode->HwAddressSize + ); + TmpPtr += SnpMode->HwAddressSize; + + // + // The target protocol address. + // + CopyMem ( + TmpPtr, + CacheEntry->Addresses[Protocol].AddressPtr, + ConfigData->SwAddressLength + ); + + // + // Set all the fields of the TxData. + // + TxData->DestinationAddress = NULL; + TxData->SourceAddress = NULL; + TxData->ProtocolType = 0; + TxData->DataLength = TotalLength - SnpMode->MediaHeaderSize; + TxData->HeaderLength = (UINT16) SnpMode->MediaHeaderSize; + TxData->FragmentCount = 1; + + TxData->FragmentTable[0].FragmentBuffer = Packet; + TxData->FragmentTable[0].FragmentLength = TotalLength; + + // + // Associate the TxData with the TxToken. + // + TxToken->Packet.TxData = TxData; + TxToken->Status = EFI_NOT_READY; + + // + // Send out this arp packet by Mnp. + // + Status = ArpService->Mnp->Transmit (ArpService->Mnp, TxToken); + if (EFI_ERROR (Status)) { + DEBUG ((EFI_D_ERROR, "Mnp->Transmit failed, %r.\n", Status)); + goto CLEAN_EXIT; + } + + return; + +CLEAN_EXIT: + + if (Packet != NULL) { + FreePool (Packet); + } + + if (TxData != NULL) { + FreePool (TxData); + } + + if (TxToken->Event != NULL) { + gBS->CloseEvent (TxToken->Event); + } + + FreePool (TxToken); +} + + +/** + Delete the cache entries in the specified CacheTable, using the BySwAddress, + SwAddressType, AddressBuffer combination as the matching key, if Force is TRUE, + the cache is deleted event it's a static entry. + + @param[in] CacheTable Pointer to the cache table to do the deletion. + @param[in] BySwAddress Delete the cache entry by software address or by + hardware address. + @param[in] SwAddressType The software address used to do the deletion. + @param[in] AddressBuffer Pointer to the buffer containing the address to + match for the deletion. + @param[in] Force This deletion is forced or not. + + @return The count of the deleted cache entries. + +**/ +UINTN +ArpDeleteCacheEntryInTable ( + IN LIST_ENTRY *CacheTable, + IN BOOLEAN BySwAddress, + IN UINT16 SwAddressType, + IN UINT8 *AddressBuffer OPTIONAL, + IN BOOLEAN Force + ) +{ + LIST_ENTRY *Entry; + LIST_ENTRY *NextEntry; + ARP_CACHE_ENTRY *CacheEntry; + UINTN Count; + + Count = 0; + + NET_LIST_FOR_EACH_SAFE (Entry, NextEntry, CacheTable) { + CacheEntry = NET_LIST_USER_STRUCT (Entry, ARP_CACHE_ENTRY, List); + + if ((CacheEntry->DefaultDecayTime == 0) && !Force) { + // + // It's a static entry and we are not forced to delete it, skip. + // + continue; + } + + if (BySwAddress) { + if (SwAddressType == CacheEntry->Addresses[Protocol].Type) { + // + // Protocol address type matched. Check the address. + // + if ((AddressBuffer == NULL) || + (CompareMem ( + AddressBuffer, + CacheEntry->Addresses[Protocol].AddressPtr, + CacheEntry->Addresses[Protocol].Length + ) == 0)) { + // + // Address matched. + // + goto MATCHED; + } + } + } else { + if ((AddressBuffer == NULL) || + (CompareMem ( + AddressBuffer, + CacheEntry->Addresses[Hardware].AddressPtr, + CacheEntry->Addresses[Hardware].Length + ) == 0)) { + // + // Address matched. + // + goto MATCHED; + } + } + + continue; + +MATCHED: + + // + // Delete this entry. + // + RemoveEntryList (&CacheEntry->List); + ASSERT (IsListEmpty (&CacheEntry->UserRequestList)); + FreePool (CacheEntry); + + Count++; + } + + return Count; +} + + +/** + Delete cache entries in all the cache tables. + + @param[in] Instance Pointer to the instance context data. + @param[in] BySwAddress Delete the cache entry by software address or by + hardware address. + @param[in] AddressBuffer Pointer to the buffer containing the address to + match for the deletion. + @param[in] Force This deletion is forced or not. + + @return The count of the deleted cache entries. + +**/ +UINTN +ArpDeleteCacheEntry ( + IN ARP_INSTANCE_DATA *Instance, + IN BOOLEAN BySwAddress, + IN UINT8 *AddressBuffer OPTIONAL, + IN BOOLEAN Force + ) +{ + ARP_SERVICE_DATA *ArpService; + UINTN Count; + + NET_CHECK_SIGNATURE (Instance, ARP_INSTANCE_DATA_SIGNATURE); + + ArpService = Instance->ArpService; + + // + // Delete the cache entries in the DeniedCacheTable. + // + Count = ArpDeleteCacheEntryInTable ( + &ArpService->DeniedCacheTable, + BySwAddress, + Instance->ConfigData.SwAddressType, + AddressBuffer, + Force + ); + + // + // Delete the cache entries inthe ResolvedCacheTable. + // + Count += ArpDeleteCacheEntryInTable ( + &ArpService->ResolvedCacheTable, + BySwAddress, + Instance->ConfigData.SwAddressType, + AddressBuffer, + Force + ); + + return Count; +} + + +/** + Cancel the arp request. + + @param[in] Instance Pointer to the instance context data. + @param[in] TargetSwAddress Pointer to the buffer containing the target + software address to match the arp request. + @param[in] UserEvent The user event used to notify this request + cancellation. + + @return The count of the cancelled requests. + +**/ +UINTN +ArpCancelRequest ( + IN ARP_INSTANCE_DATA *Instance, + IN VOID *TargetSwAddress OPTIONAL, + IN EFI_EVENT UserEvent OPTIONAL + ) +{ + ARP_SERVICE_DATA *ArpService; + LIST_ENTRY *Entry; + LIST_ENTRY *NextEntry; + ARP_CACHE_ENTRY *CacheEntry; + UINTN Count; + + NET_CHECK_SIGNATURE (Instance, ARP_INSTANCE_DATA_SIGNATURE); + + ArpService = Instance->ArpService; + + Count = 0; + NET_LIST_FOR_EACH_SAFE (Entry, NextEntry, &ArpService->PendingRequestTable) { + CacheEntry = NET_LIST_USER_STRUCT (Entry, ARP_CACHE_ENTRY, List); + + if ((TargetSwAddress == NULL) || + (CompareMem ( + TargetSwAddress, + CacheEntry->Addresses[Protocol].AddressPtr, + CacheEntry->Addresses[Protocol].Length + ) == 0)) { + // + // This request entry matches the TargetSwAddress or all requests are to be + // cancelled as TargetSwAddress is NULL. + // + Count += ArpAddressResolved (CacheEntry, Instance, UserEvent); + + if (IsListEmpty (&CacheEntry->UserRequestList)) { + // + // No user requests any more, remove this request cache entry. + // + RemoveEntryList (&CacheEntry->List); + FreePool (CacheEntry); + } + } + } + + return Count; +} + + +/** + Find the cache entry in the cache table. + + @param[in] Instance Pointer to the instance context data. + @param[in] BySwAddress Set to TRUE to look for matching software protocol + addresses. Set to FALSE to look for matching + hardware protocol addresses. + @param[in] AddressBuffer Pointer to address buffer. Set to NULL to match + all addresses. + @param[out] EntryLength The size of an entry in the entries buffer. + @param[out] EntryCount The number of ARP cache entries that are found by + the specified criteria. + @param[out] Entries Pointer to the buffer that will receive the ARP + cache entries. + @param[in] Refresh Set to TRUE to refresh the timeout value of the + matching ARP cache entry. + + @retval EFI_SUCCESS The requested ARP cache entries are copied into + the buffer. + @retval EFI_NOT_FOUND No matching entries found. + @retval EFI_OUT_OF_RESOURCE There is a memory allocation failure. + +**/ +EFI_STATUS +ArpFindCacheEntry ( + IN ARP_INSTANCE_DATA *Instance, + IN BOOLEAN BySwAddress, + IN VOID *AddressBuffer OPTIONAL, + OUT UINT32 *EntryLength OPTIONAL, + OUT UINT32 *EntryCount OPTIONAL, + OUT EFI_ARP_FIND_DATA **Entries OPTIONAL, + IN BOOLEAN Refresh + ) +{ + EFI_STATUS Status; + ARP_SERVICE_DATA *ArpService; + NET_ARP_ADDRESS MatchAddress; + FIND_OPTYPE FindOpType; + LIST_ENTRY *StartEntry; + ARP_CACHE_ENTRY *CacheEntry; + NET_MAP FoundEntries; + UINT32 FoundCount; + EFI_ARP_FIND_DATA *FindData; + LIST_ENTRY *CacheTable; + UINT32 FoundEntryLength; + + ArpService = Instance->ArpService; + + // + // Init the FounEntries used to hold the found cache entries. + // + NetMapInit (&FoundEntries); + + // + // Set the MatchAddress. + // + if (BySwAddress) { + MatchAddress.Type = Instance->ConfigData.SwAddressType; + MatchAddress.Length = Instance->ConfigData.SwAddressLength; + FindOpType = ByProtoAddress; + } else { + MatchAddress.Type = ArpService->SnpMode.IfType; + MatchAddress.Length = (UINT8)ArpService->SnpMode.HwAddressSize; + FindOpType = ByHwAddress; + } + + MatchAddress.AddressPtr = AddressBuffer; + + // + // Search the DeniedCacheTable + // + StartEntry = NULL; + while (TRUE) { + // + // Try to find the matched entries in the DeniedCacheTable. + // + CacheEntry = ArpFindNextCacheEntryInTable ( + &ArpService->DeniedCacheTable, + StartEntry, + FindOpType, + &MatchAddress, + &MatchAddress + ); + if (CacheEntry == NULL) { + // + // Once the CacheEntry is NULL, there are no more matches. + // + break; + } + + // + // Insert the found entry into the map. + // + NetMapInsertTail ( + &FoundEntries, + (VOID *)CacheEntry, + (VOID *)&ArpService->DeniedCacheTable + ); + + // + // Let the next search start from this cache entry. + // + StartEntry = &CacheEntry->List; + + if (Refresh) { + // + // Refresh the DecayTime if needed. + // + CacheEntry->DecayTime = CacheEntry->DefaultDecayTime; + } + } + + // + // Search the ResolvedCacheTable + // + StartEntry = NULL; + while (TRUE) { + CacheEntry = ArpFindNextCacheEntryInTable ( + &ArpService->ResolvedCacheTable, + StartEntry, + FindOpType, + &MatchAddress, + &MatchAddress + ); + if (CacheEntry == NULL) { + // + // Once the CacheEntry is NULL, there are no more matches. + // + break; + } + + // + // Insert the found entry into the map. + // + NetMapInsertTail ( + &FoundEntries, + (VOID *)CacheEntry, + (VOID *)&ArpService->ResolvedCacheTable + ); + + // + // Let the next search start from this cache entry. + // + StartEntry = &CacheEntry->List; + + if (Refresh) { + // + // Refresh the DecayTime if needed. + // + CacheEntry->DecayTime = CacheEntry->DefaultDecayTime; + } + } + + Status = EFI_SUCCESS; + + FoundCount = (UINT32) NetMapGetCount (&FoundEntries); + if (FoundCount == 0) { + Status = EFI_NOT_FOUND; + goto CLEAN_EXIT; + } + + // + // Found the entry length, make sure its 8 bytes alignment. + // + FoundEntryLength = (((sizeof (EFI_ARP_FIND_DATA) + Instance->ConfigData.SwAddressLength + + ArpService->SnpMode.HwAddressSize) + 3) & ~(0x3)); + + if (EntryLength != NULL) { + *EntryLength = FoundEntryLength; + } + + if (EntryCount != NULL) { + // + // Return the found entry count. + // + *EntryCount = FoundCount; + } + + if (Entries == NULL) { + goto CLEAN_EXIT; + } + + // + // Allocate buffer to copy the found entries. + // + FindData = AllocatePool (FoundCount * FoundEntryLength); + if (FindData == NULL) { + DEBUG ((EFI_D_ERROR, "ArpFindCacheEntry: Failed to allocate memory.\n")); + Status = EFI_OUT_OF_RESOURCES; + goto CLEAN_EXIT; + } + + // + // Return the address to the user. + // + *Entries = FindData; + + // + // Dump the entries. + // + while (!NetMapIsEmpty (&FoundEntries)) { + // + // Get a cache entry from the map. + // + CacheEntry = NetMapRemoveHead (&FoundEntries, (VOID **)&CacheTable); + + // + // Set the fields in FindData. + // + FindData->Size = FoundEntryLength; + FindData->DenyFlag = (BOOLEAN)(CacheTable == &ArpService->DeniedCacheTable); + FindData->StaticFlag = (BOOLEAN)(CacheEntry->DefaultDecayTime == 0); + FindData->HwAddressType = ArpService->SnpMode.IfType; + FindData->SwAddressType = Instance->ConfigData.SwAddressType; + FindData->HwAddressLength = (UINT8)ArpService->SnpMode.HwAddressSize; + FindData->SwAddressLength = Instance->ConfigData.SwAddressLength; + + // + // Copy the software address. + // + CopyMem ( + FindData + 1, + CacheEntry->Addresses[Protocol].AddressPtr, + FindData->SwAddressLength + ); + + // + // Copy the hardware address. + // + CopyMem ( + (UINT8 *)(FindData + 1) + FindData->SwAddressLength, + CacheEntry->Addresses[Hardware].AddressPtr, + FindData->HwAddressLength + ); + + // + // Slip to the next FindData. + // + FindData = (EFI_ARP_FIND_DATA *)((UINT8 *)FindData + FoundEntryLength); + } + +CLEAN_EXIT: + + NetMapClean (&FoundEntries); + + return Status; +} + diff --git a/NetworkPkg/ArpDxe/ArpImpl.h b/NetworkPkg/ArpDxe/ArpImpl.h new file mode 100644 index 0000000000..47eedc1cb6 --- /dev/null +++ b/NetworkPkg/ArpDxe/ArpImpl.h @@ -0,0 +1,770 @@ +/** @file + EFI Address Resolution Protocol (ARP) Protocol interface header file. + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef _ARP_IMPL_H_ +#define _ARP_IMPL_H_ + + +#include + +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +// +// Ethernet protocol type definitions. +// +#define ARP_ETHER_PROTO_TYPE 0x0806 +#define IPV4_ETHER_PROTO_TYPE 0x0800 +#define IPV6_ETHER_PROTO_TYPE 0x86DD + +// +// ARP opcode definitions. +// +#define ARP_OPCODE_REQUEST 0x0001 +#define ARP_OPCODE_REPLY 0x0002 + +// +// ARP timeout, retry count and interval definitions. +// +#define ARP_DEFAULT_TIMEOUT_VALUE (400 * TICKS_PER_SECOND) +#define ARP_DEFAULT_RETRY_COUNT 2 +#define ARP_DEFAULT_RETRY_INTERVAL (5 * TICKS_PER_MS) +#define ARP_PERIODIC_TIMER_INTERVAL (500 * TICKS_PER_MS) + +// +// ARP packet head definition. +// +#pragma pack(1) +typedef struct { + UINT16 HwType; + UINT16 ProtoType; + UINT8 HwAddrLen; + UINT8 ProtoAddrLen; + UINT16 OpCode; +} ARP_HEAD; +#pragma pack() + +// +// ARP Address definition for internal use. +// +typedef struct { + UINT8 *SenderHwAddr; + UINT8 *SenderProtoAddr; + UINT8 *TargetHwAddr; + UINT8 *TargetProtoAddr; +} ARP_ADDRESS; + +#define MATCH_SW_ADDRESS 0x1 +#define MATCH_HW_ADDRESS 0x2 + +// +// Enumeration for the search type. A search type is specified as the keyword to find +// a cache entry in the cache table. +// +typedef enum { + ByNone = 0, + ByProtoAddress = MATCH_SW_ADDRESS, + ByHwAddress = MATCH_HW_ADDRESS, + ByBoth = MATCH_SW_ADDRESS | MATCH_HW_ADDRESS +} FIND_OPTYPE; + +#define ARP_INSTANCE_DATA_SIGNATURE SIGNATURE_32('A', 'R', 'P', 'I') + +/** + Returns a pointer to the ARP_INSTANCE_DATA structure from the input a. + + If the signatures matches, then a pointer to the data structure that contains + a specified field of that data structure is returned. + + @param a Pointer to the field specified by ArpProto within a data + structure of type ARP_INSTANCE_DATA. + +**/ +#define ARP_INSTANCE_DATA_FROM_THIS(a) \ + CR ( \ + (a), \ + ARP_INSTANCE_DATA, \ + ArpProto, \ + ARP_INSTANCE_DATA_SIGNATURE \ + ) + +typedef struct _ARP_SERVICE_DATA ARP_SERVICE_DATA; + +// +// ARP instance context data structure. +// +typedef struct { + UINT32 Signature; + ARP_SERVICE_DATA *ArpService; + EFI_HANDLE Handle; + EFI_ARP_PROTOCOL ArpProto; + LIST_ENTRY List; + EFI_ARP_CONFIG_DATA ConfigData; + BOOLEAN Configured; + BOOLEAN InDestroy; +} ARP_INSTANCE_DATA; + +#define ARP_SERVICE_DATA_SIGNATURE SIGNATURE_32('A', 'R', 'P', 'S') + +/** + Returns a pointer to the ARP_SERVICE_DATA structure from the input a. + + If the signatures matches, then a pointer to the data structure that contains + a specified field of that data structure is returned. + + @param a Pointer to the field specified by ServiceBinding within + a data structure of type ARP_SERVICE_DATA. + +**/ +#define ARP_SERVICE_DATA_FROM_THIS(a) \ + CR ( \ + (a), \ + ARP_SERVICE_DATA, \ + ServiceBinding, \ + ARP_SERVICE_DATA_SIGNATURE \ + ) + +// +// ARP service data structure. +// +struct _ARP_SERVICE_DATA { + UINT32 Signature; + EFI_SERVICE_BINDING_PROTOCOL ServiceBinding; + + EFI_HANDLE MnpChildHandle; + EFI_HANDLE ImageHandle; + EFI_HANDLE ControllerHandle; + + EFI_MANAGED_NETWORK_PROTOCOL *Mnp; + EFI_MANAGED_NETWORK_CONFIG_DATA MnpConfigData; + EFI_MANAGED_NETWORK_COMPLETION_TOKEN RxToken; + + EFI_SIMPLE_NETWORK_MODE SnpMode; + + UINTN ChildrenNumber; + LIST_ENTRY ChildrenList; + + LIST_ENTRY PendingRequestTable; + LIST_ENTRY DeniedCacheTable; + LIST_ENTRY ResolvedCacheTable; + + EFI_EVENT PeriodicTimer; +}; + +// +// User request context structure. +// +typedef struct { + LIST_ENTRY List; + ARP_INSTANCE_DATA *Instance; + EFI_EVENT UserRequestEvent; + VOID *UserHwAddrBuffer; +} USER_REQUEST_CONTEXT; + +#define ARP_MAX_PROTOCOL_ADDRESS_LEN sizeof(EFI_IP_ADDRESS) +#define ARP_MAX_HARDWARE_ADDRESS_LEN sizeof(EFI_MAC_ADDRESS) + +typedef union { + UINT8 ProtoAddress[ARP_MAX_PROTOCOL_ADDRESS_LEN]; + UINT8 HwAddress[ARP_MAX_HARDWARE_ADDRESS_LEN]; +} NET_ARP_ADDRESS_UNION; + +// +// ARP address structure in an ARP packet. +// +typedef struct { + UINT16 Type; + UINT8 Length; + UINT8 *AddressPtr; + NET_ARP_ADDRESS_UNION Buffer; +} NET_ARP_ADDRESS; + +// +// Enumeration for ARP address type. +// +typedef enum { + Hardware, + Protocol +} ARP_ADDRESS_TYPE; + +// +// ARP cache entry definition. +// +typedef struct { + LIST_ENTRY List; + + UINT32 RetryCount; + UINT32 DefaultDecayTime; + UINT32 DecayTime; + UINT32 NextRetryTime; + + NET_ARP_ADDRESS Addresses[2]; + + LIST_ENTRY UserRequestList; +} ARP_CACHE_ENTRY; + +/** + This function is used to assign a station address to the ARP cache for this instance + of the ARP driver. + + Each ARP instance has one station address. The EFI_ARP_PROTOCOL driver will + respond to ARP requests that match this registered station address. A call to + this function with the ConfigData field set to NULL will reset this ARP instance. + + Once a protocol type and station address have been assigned to this ARP instance, + all the following ARP functions will use this information. Attempting to change + the protocol type or station address to a configured ARP instance will result in errors. + + @param This Pointer to the EFI_ARP_PROTOCOL instance. + @param ConfigData Pointer to the EFI_ARP_CONFIG_DATA structure. + + @retval EFI_SUCCESS The new station address was successfully + registered. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + This is NULL. SwAddressLength is zero when + ConfigData is not NULL. StationAddress is NULL + when ConfigData is not NULL. + @retval EFI_ACCESS_DENIED The SwAddressType, SwAddressLength, or + StationAddress is different from the one that is + already registered. + @retval EFI_OUT_OF_RESOURCES Storage for the new StationAddress could not be + allocated. + +**/ +EFI_STATUS +EFIAPI +ArpConfigure ( + IN EFI_ARP_PROTOCOL *This, + IN EFI_ARP_CONFIG_DATA *ConfigData OPTIONAL + ); + +/** + This function is used to insert entries into the ARP cache. + + ARP cache entries are typically inserted and updated by network protocol drivers + as network traffic is processed. Most ARP cache entries will time out and be + deleted if the network traffic stops. ARP cache entries that were inserted + by the Add() function may be static (will not time out) or dynamic (will time out). + Default ARP cache timeout values are not covered in most network protocol + specifications (although RFC 1122 comes pretty close) and will only be + discussed in general in this specification. The timeout values that are + used in the EFI Sample Implementation should be used only as a guideline. + Final product implementations of the EFI network stack should be tuned for + their expected network environments. + + @param This Pointer to the EFI_ARP_PROTOCOL instance. + @param DenyFlag Set to TRUE if this entry is a deny entry. Set to + FALSE if this entry is a normal entry. + @param TargetSwAddress Pointer to a protocol address to add (or deny). + May be set to NULL if DenyFlag is TRUE. + @param TargetHwAddress Pointer to a hardware address to add (or deny). + May be set to NULL if DenyFlag is TRUE. + @param TimeoutValue Time in 100-ns units that this entry will remain + in the ARP cache. A value of zero means that the + entry is permanent. A nonzero value will override + the one given by Configure() if the entry to be + added is a dynamic entry. + @param Overwrite If TRUE, the matching cache entry will be + overwritten with the supplied parameters. If + FALSE, EFI_ACCESS_DENIED is returned if the + corresponding cache entry already exists. + + @retval EFI_SUCCESS The entry has been added or updated. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + This is NULL. DenyFlag is FALSE and + TargetHwAddress is NULL. DenyFlag is FALSE and + TargetSwAddress is NULL. TargetHwAddress is NULL + and TargetSwAddress is NULL. Both TargetSwAddress + and TargetHwAddress are not NULL when DenyFlag is + TRUE. + @retval EFI_OUT_OF_RESOURCES The new ARP cache entry could not be allocated. + @retval EFI_ACCESS_DENIED The ARP cache entry already exists and Overwrite + is not true. + @retval EFI_NOT_STARTED The ARP driver instance has not been configured. + +**/ +EFI_STATUS +EFIAPI +ArpAdd ( + IN EFI_ARP_PROTOCOL *This, + IN BOOLEAN DenyFlag, + IN VOID *TargetSwAddress OPTIONAL, + IN VOID *TargetHwAddress OPTIONAL, + IN UINT32 TimeoutValue, + IN BOOLEAN Overwrite + ); + +/** + This function searches the ARP cache for matching entries and allocates a buffer into + which those entries are copied. + + The first part of the allocated buffer is EFI_ARP_FIND_DATA, following which + are protocol address pairs and hardware address pairs. + When finding a specific protocol address (BySwAddress is TRUE and AddressBuffer + is not NULL), the ARP cache timeout for the found entry is reset if Refresh is + set to TRUE. If the found ARP cache entry is a permanent entry, it is not + affected by Refresh. + + @param This Pointer to the EFI_ARP_PROTOCOL instance. + @param BySwAddress Set to TRUE to look for matching software protocol + addresses. Set to FALSE to look for matching + hardware protocol addresses. + @param AddressBuffer Pointer to address buffer. Set to NULL to match + all addresses. + @param EntryLength The size of an entry in the entries buffer. + @param EntryCount The number of ARP cache entries that are found by + the specified criteria. + @param Entries Pointer to the buffer that will receive the ARP + cache entries. + @param Refresh Set to TRUE to refresh the timeout value of the + matching ARP cache entry. + + @retval EFI_SUCCESS The requested ARP cache entries were copied into + the buffer. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + This is NULL. Both EntryCount and EntryLength are + NULL, when Refresh is FALSE. + @retval EFI_NOT_FOUND No matching entries were found. + @retval EFI_NOT_STARTED The ARP driver instance has not been configured. + +**/ +EFI_STATUS +EFIAPI +ArpFind ( + IN EFI_ARP_PROTOCOL *This, + IN BOOLEAN BySwAddress, + IN VOID *AddressBuffer OPTIONAL, + OUT UINT32 *EntryLength OPTIONAL, + OUT UINT32 *EntryCount OPTIONAL, + OUT EFI_ARP_FIND_DATA **Entries OPTIONAL, + IN BOOLEAN Refresh + ); + +/** + This function removes specified ARP cache entries. + + @param This Pointer to the EFI_ARP_PROTOCOL instance. + @param BySwAddress Set to TRUE to delete matching protocol addresses. + Set to FALSE to delete matching hardware + addresses. + @param AddressBuffer Pointer to the address buffer that is used as a + key to look for the cache entry. Set to NULL to + delete all entries. + + @retval EFI_SUCCESS The entry was removed from the ARP cache. + @retval EFI_INVALID_PARAMETER This is NULL. + @retval EFI_NOT_FOUND The specified deletion key was not found. + @retval EFI_NOT_STARTED The ARP driver instance has not been configured. + +**/ +EFI_STATUS +EFIAPI +ArpDelete ( + IN EFI_ARP_PROTOCOL *This, + IN BOOLEAN BySwAddress, + IN VOID *AddressBuffer OPTIONAL + ); + +/** + This function delete all dynamic entries from the ARP cache that match the specified + software protocol type. + + @param This Pointer to the EFI_ARP_PROTOCOL instance. + + @retval EFI_SUCCESS The cache has been flushed. + @retval EFI_INVALID_PARAMETER This is NULL. + @retval EFI_NOT_FOUND There are no matching dynamic cache entries. + @retval EFI_NOT_STARTED The ARP driver instance has not been configured. + +**/ +EFI_STATUS +EFIAPI +ArpFlush ( + IN EFI_ARP_PROTOCOL *This + ); + +/** + This function tries to resolve the TargetSwAddress and optionally returns a + TargetHwAddress if it already exists in the ARP cache. + + @param This Pointer to the EFI_ARP_PROTOCOL instance. + @param TargetSwAddress Pointer to the protocol address to resolve. + @param ResolvedEvent Pointer to the event that will be signaled when + the address is resolved or some error occurs. + @param TargetHwAddress Pointer to the buffer for the resolved hardware + address in network byte order. + + @retval EFI_SUCCESS The data is copied from the ARP cache into the + TargetHwAddress buffer. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + This is NULL. TargetHwAddress is NULL. + @retval EFI_ACCESS_DENIED The requested address is not present in the normal + ARP cache but is present in the deny address list. + Outgoing traffic to that address is forbidden. + @retval EFI_NOT_STARTED The ARP driver instance has not been configured. + @retval EFI_NOT_READY The request has been started and is not finished. + +**/ +EFI_STATUS +EFIAPI +ArpRequest ( + IN EFI_ARP_PROTOCOL *This, + IN VOID *TargetSwAddress OPTIONAL, + IN EFI_EVENT ResolvedEvent OPTIONAL, + OUT VOID *TargetHwAddress + ); + +/** + This function aborts the previous ARP request (identified by This, TargetSwAddress + and ResolvedEvent) that is issued by EFI_ARP_PROTOCOL.Request(). + + If the request is in the internal ARP request queue, the request is aborted + immediately and its ResolvedEvent is signaled. Only an asynchronous address + request needs to be canceled. If TargeSwAddress and ResolveEvent are both + NULL, all the pending asynchronous requests that have been issued by This + instance will be cancelled and their corresponding events will be signaled. + + @param This Pointer to the EFI_ARP_PROTOCOL instance. + @param TargetSwAddress Pointer to the protocol address in previous + request session. + @param ResolvedEvent Pointer to the event that is used as the + notification event in previous request session. + + @retval EFI_SUCCESS The pending request session(s) is/are aborted and + corresponding event(s) is/are signaled. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + This is NULL. TargetSwAddress is not NULL and + ResolvedEvent is NULL. TargetSwAddress is NULL and + ResolvedEvent is not NULL. + @retval EFI_NOT_STARTED The ARP driver instance has not been configured. + @retval EFI_NOT_FOUND The request is not issued by + EFI_ARP_PROTOCOL.Request(). + +**/ +EFI_STATUS +EFIAPI +ArpCancel ( + IN EFI_ARP_PROTOCOL *This, + IN VOID *TargetSwAddress OPTIONAL, + IN EFI_EVENT ResolvedEvent OPTIONAL + ); + +/** + Configure the instance using the ConfigData. ConfigData is already validated. + + @param[in] Instance Pointer to the instance context data to be + configured. + @param[in] ConfigData Pointer to the configuration data used to + configure the instance. + + @retval EFI_SUCCESS The instance is configured with the ConfigData. + @retval EFI_ACCESS_DENIED The instance is already configured and the + ConfigData tries to reset some unchangeable + fields. + @retval EFI_INVALID_PARAMETER The ConfigData provides a non-unicast IPv4 address + when the SwAddressType is IPv4. + @retval EFI_OUT_OF_RESOURCES The instance fails to configure due to memory + limitation. + +**/ +EFI_STATUS +ArpConfigureInstance ( + IN ARP_INSTANCE_DATA *Instance, + IN EFI_ARP_CONFIG_DATA *ConfigData OPTIONAL + ); + +/** + Find the CacheEntry, using ProtocolAddress or HardwareAddress or both, as the keyword, + in the DeniedCacheTable. + + @param[in] ArpService Pointer to the arp service context data. + @param[in] ProtocolAddress Pointer to the protocol address. + @param[in] HardwareAddress Pointer to the hardware address. + + @return Pointer to the matched cache entry, if NULL no match is found. + +**/ +ARP_CACHE_ENTRY * +ArpFindDeniedCacheEntry ( + IN ARP_SERVICE_DATA *ArpService, + IN NET_ARP_ADDRESS *ProtocolAddress OPTIONAL, + IN NET_ARP_ADDRESS *HardwareAddress OPTIONAL + ); + +/** + Find the CacheEntry which matches the requirements in the specified CacheTable. + + @param[in] CacheTable Pointer to the arp cache table. + @param[in] StartEntry Pointer to the start entry this search begins with + in the cache table. + @param[in] FindOpType The search type. + @param[in] ProtocolAddress Pointer to the protocol address to match. + @param[in] HardwareAddress Pointer to the hardware address to match. + + @return Pointer to the matched arp cache entry, if NULL, no match is found. + +**/ +ARP_CACHE_ENTRY * +ArpFindNextCacheEntryInTable ( + IN LIST_ENTRY *CacheTable, + IN LIST_ENTRY *StartEntry, + IN FIND_OPTYPE FindOpType, + IN NET_ARP_ADDRESS *ProtocolAddress OPTIONAL, + IN NET_ARP_ADDRESS *HardwareAddress OPTIONAL + ); + +/** + Allocate a cache entry and initialize it. + + @param[in] Instance Pointer to the instance context data. + + @return Pointer to the new created cache entry. + +**/ +ARP_CACHE_ENTRY * +ArpAllocCacheEntry ( + IN ARP_INSTANCE_DATA *Instance + ); + +/** + Fill the addresses in the CacheEntry using the information passed in by + HwAddr and SwAddr. + + @param[in] CacheEntry Pointer to the cache entry. + @param[in] HwAddr Pointer to the software address. + @param[in] SwAddr Pointer to the hardware address. + + @return None. + +**/ +VOID +ArpFillAddressInCacheEntry ( + IN ARP_CACHE_ENTRY *CacheEntry, + IN NET_ARP_ADDRESS *HwAddr OPTIONAL, + IN NET_ARP_ADDRESS *SwAddr OPTIONAL + ); + +/** + Turn the CacheEntry into the resolved status. + + @param[in] CacheEntry Pointer to the resolved cache entry. + @param[in] Instance Pointer to the instance context data. + @param[in] UserEvent Pointer to the UserEvent to notify. + + @return The count of notifications sent to the instance. + +**/ +UINTN +ArpAddressResolved ( + IN ARP_CACHE_ENTRY *CacheEntry, + IN ARP_INSTANCE_DATA *Instance OPTIONAL, + IN EFI_EVENT UserEvent OPTIONAL + ); + +/** + Delete cache entries in all the cache tables. + + @param[in] Instance Pointer to the instance context data. + @param[in] BySwAddress Delete the cache entry by software address or by + hardware address. + @param[in] AddressBuffer Pointer to the buffer containing the address to + match for the deletion. + @param[in] Force This deletion is forced or not. + + @return The count of the deleted cache entries. + +**/ +UINTN +ArpDeleteCacheEntry ( + IN ARP_INSTANCE_DATA *Instance, + IN BOOLEAN BySwAddress, + IN UINT8 *AddressBuffer OPTIONAL, + IN BOOLEAN Force + ); + +/** + Send out an arp frame using the CachEntry and the ArpOpCode. + + @param[in] Instance Pointer to the instance context data. + @param[in] CacheEntry Pointer to the configuration data used to + configure the instance. + @param[in] ArpOpCode The opcode used to send out this Arp frame, either + request or reply. + + @return None. + +**/ +VOID +ArpSendFrame ( + IN ARP_INSTANCE_DATA *Instance, + IN ARP_CACHE_ENTRY *CacheEntry, + IN UINT16 ArpOpCode + ); + +/** + Initialize the instance context data. + + @param[in] ArpService Pointer to the arp service context data this + instance belongs to. + @param[out] Instance Pointer to the instance context data. + + @return None. + +**/ +VOID +ArpInitInstance ( + IN ARP_SERVICE_DATA *ArpService, + OUT ARP_INSTANCE_DATA *Instance + ); + +/** + Process the Arp packets received from Mnp, the procedure conforms to RFC826. + + @param[in] Context Pointer to the context data registerd to the + Event. + + @return None. + +**/ +VOID +EFIAPI +ArpOnFrameRcvdDpc ( + IN VOID *Context + ); + +/** + Queue ArpOnFrameRcvdDpc as a DPC at TPL_CALLBACK. + + @param[in] Event The Event this notify function registered to. + @param[in] Context Pointer to the context data registerd to the + Event. + + @return None. + +**/ +VOID +EFIAPI +ArpOnFrameRcvd ( + IN EFI_EVENT Event, + IN VOID *Context + ); + +/** + Process the already sent arp packets. + + @param[in] Context Pointer to the context data registerd to the + Event. + + @return None. + +**/ +VOID +EFIAPI +ArpOnFrameSentDpc ( + IN VOID *Context + ); + +/** + Request ArpOnFrameSentDpc as a DPC at TPL_CALLBACK. + + @param[in] Event The Event this notify function registered to. + @param[in] Context Pointer to the context data registerd to the + Event. + + @return None. + +**/ +VOID +EFIAPI +ArpOnFrameSent ( + IN EFI_EVENT Event, + IN VOID *Context + ); + +/** + Process the arp cache olding and drive the retrying arp requests. + + @param[in] Event The Event this notify function registered to. + @param[in] Context Pointer to the context data registerd to the + Event. + + @return None. + +**/ +VOID +EFIAPI +ArpTimerHandler ( + IN EFI_EVENT Event, + IN VOID *Context + ); + +/** + Cancel the arp request. + + @param[in] Instance Pointer to the instance context data. + @param[in] TargetSwAddress Pointer to the buffer containing the target + software address to match the arp request. + @param[in] UserEvent The user event used to notify this request + cancellation. + + @return The count of the cancelled requests. + +**/ +UINTN +ArpCancelRequest ( + IN ARP_INSTANCE_DATA *Instance, + IN VOID *TargetSwAddress OPTIONAL, + IN EFI_EVENT UserEvent OPTIONAL + ); + +/** + Find the cache entry in the cache table. + + @param[in] Instance Pointer to the instance context data. + @param[in] BySwAddress Set to TRUE to look for matching software protocol + addresses. Set to FALSE to look for matching + hardware protocol addresses. + @param[in] AddressBuffer Pointer to address buffer. Set to NULL to match + all addresses. + @param[out] EntryLength The size of an entry in the entries buffer. + @param[out] EntryCount The number of ARP cache entries that are found by + the specified criteria. + @param[out] Entries Pointer to the buffer that will receive the ARP + cache entries. + @param[in] Refresh Set to TRUE to refresh the timeout value of the + matching ARP cache entry. + + @retval EFI_SUCCESS The requested ARP cache entries are copied into + the buffer. + @retval EFI_NOT_FOUND No matching entries found. + @retval EFI_OUT_OF_RESOURCE There is a memory allocation failure. + +**/ +EFI_STATUS +ArpFindCacheEntry ( + IN ARP_INSTANCE_DATA *Instance, + IN BOOLEAN BySwAddress, + IN VOID *AddressBuffer OPTIONAL, + OUT UINT32 *EntryLength OPTIONAL, + OUT UINT32 *EntryCount OPTIONAL, + OUT EFI_ARP_FIND_DATA **Entries OPTIONAL, + IN BOOLEAN Refresh + ); + +#endif diff --git a/NetworkPkg/ArpDxe/ArpMain.c b/NetworkPkg/ArpDxe/ArpMain.c new file mode 100644 index 0000000000..f06121fed4 --- /dev/null +++ b/NetworkPkg/ArpDxe/ArpMain.c @@ -0,0 +1,739 @@ +/** @file + Implementation of EFI Address Resolution Protocol (ARP) Protocol interface functions. + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "ArpImpl.h" + + +/** + This function is used to assign a station address to the ARP cache for this instance + of the ARP driver. + + Each ARP instance has one station address. The EFI_ARP_PROTOCOL driver will + respond to ARP requests that match this registered station address. A call to + this function with the ConfigData field set to NULL will reset this ARP instance. + + Once a protocol type and station address have been assigned to this ARP instance, + all the following ARP functions will use this information. Attempting to change + the protocol type or station address to a configured ARP instance will result in errors. + + @param This Pointer to the EFI_ARP_PROTOCOL instance. + @param ConfigData Pointer to the EFI_ARP_CONFIG_DATA structure. + + @retval EFI_SUCCESS The new station address was successfully + registered. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + This is NULL. SwAddressLength is zero when + ConfigData is not NULL. StationAddress is NULL + when ConfigData is not NULL. + @retval EFI_ACCESS_DENIED The SwAddressType, SwAddressLength, or + StationAddress is different from the one that is + already registered. + @retval EFI_OUT_OF_RESOURCES Storage for the new StationAddress could not be + allocated. + +**/ +EFI_STATUS +EFIAPI +ArpConfigure ( + IN EFI_ARP_PROTOCOL *This, + IN EFI_ARP_CONFIG_DATA *ConfigData OPTIONAL + ) +{ + EFI_STATUS Status; + ARP_INSTANCE_DATA *Instance; + EFI_TPL OldTpl; + + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + if ((ConfigData != NULL) && + ((ConfigData->SwAddressLength == 0) || + (ConfigData->StationAddress == NULL) || + (ConfigData->SwAddressType <= 1500))) { + return EFI_INVALID_PARAMETER; + } + + Instance = ARP_INSTANCE_DATA_FROM_THIS (This); + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + // + // Configure this instance, the ConfigData has already passed the basic checks. + // + Status = ArpConfigureInstance (Instance, ConfigData); + + gBS->RestoreTPL (OldTpl); + + return Status; +} + + +/** + This function is used to insert entries into the ARP cache. + + ARP cache entries are typically inserted and updated by network protocol drivers + as network traffic is processed. Most ARP cache entries will time out and be + deleted if the network traffic stops. ARP cache entries that were inserted + by the Add() function may be static (will not time out) or dynamic (will time out). + Default ARP cache timeout values are not covered in most network protocol + specifications (although RFC 1122 comes pretty close) and will only be + discussed in general in this specification. The timeout values that are + used in the EFI Sample Implementation should be used only as a guideline. + Final product implementations of the EFI network stack should be tuned for + their expected network environments. + + @param This Pointer to the EFI_ARP_PROTOCOL instance. + @param DenyFlag Set to TRUE if this entry is a deny entry. Set to + FALSE if this entry is a normal entry. + @param TargetSwAddress Pointer to a protocol address to add (or deny). + May be set to NULL if DenyFlag is TRUE. + @param TargetHwAddress Pointer to a hardware address to add (or deny). + May be set to NULL if DenyFlag is TRUE. + @param TimeoutValue Time in 100-ns units that this entry will remain + in the ARP cache. A value of zero means that the + entry is permanent. A nonzero value will override + the one given by Configure() if the entry to be + added is a dynamic entry. + @param Overwrite If TRUE, the matching cache entry will be + overwritten with the supplied parameters. If + FALSE, EFI_ACCESS_DENIED is returned if the + corresponding cache entry already exists. + + @retval EFI_SUCCESS The entry has been added or updated. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + This is NULL. DenyFlag is FALSE and + TargetHwAddress is NULL. DenyFlag is FALSE and + TargetSwAddress is NULL. TargetHwAddress is NULL + and TargetSwAddress is NULL. Both TargetSwAddress + and TargetHwAddress are not NULL when DenyFlag is + TRUE. + @retval EFI_OUT_OF_RESOURCES The new ARP cache entry could not be allocated. + @retval EFI_ACCESS_DENIED The ARP cache entry already exists and Overwrite + is not true. + @retval EFI_NOT_STARTED The ARP driver instance has not been configured. + +**/ +EFI_STATUS +EFIAPI +ArpAdd ( + IN EFI_ARP_PROTOCOL *This, + IN BOOLEAN DenyFlag, + IN VOID *TargetSwAddress OPTIONAL, + IN VOID *TargetHwAddress OPTIONAL, + IN UINT32 TimeoutValue, + IN BOOLEAN Overwrite + ) +{ + EFI_STATUS Status; + ARP_INSTANCE_DATA *Instance; + ARP_SERVICE_DATA *ArpService; + ARP_CACHE_ENTRY *CacheEntry; + EFI_SIMPLE_NETWORK_MODE *SnpMode; + NET_ARP_ADDRESS MatchAddress[2]; + EFI_TPL OldTpl; + + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + if (((!DenyFlag) && ((TargetHwAddress == NULL) || (TargetSwAddress == NULL))) || + (DenyFlag && (TargetHwAddress != NULL) && (TargetSwAddress != NULL)) || + ((TargetHwAddress == NULL) && (TargetSwAddress == NULL))) { + return EFI_INVALID_PARAMETER; + } + + Instance = ARP_INSTANCE_DATA_FROM_THIS (This); + + if (!Instance->Configured) { + return EFI_NOT_STARTED; + } + + Status = EFI_SUCCESS; + ArpService = Instance->ArpService; + SnpMode = &Instance->ArpService->SnpMode; + + // + // Fill the hardware address part in the MatchAddress. + // + MatchAddress[Hardware].Type = SnpMode->IfType; + MatchAddress[Hardware].Length = (UINT8) SnpMode->HwAddressSize; + MatchAddress[Hardware].AddressPtr = TargetHwAddress; + + // + // Fill the software address part in the MatchAddress. + // + MatchAddress[Protocol].Type = Instance->ConfigData.SwAddressType; + MatchAddress[Protocol].Length = Instance->ConfigData.SwAddressLength; + MatchAddress[Protocol].AddressPtr = TargetSwAddress; + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + // + // See whether the entry to add exists. Check the DeinedCacheTable first. + // + CacheEntry = ArpFindDeniedCacheEntry ( + ArpService, + &MatchAddress[Protocol], + &MatchAddress[Hardware] + ); + + if (CacheEntry == NULL) { + // + // Check the ResolvedCacheTable + // + CacheEntry = ArpFindNextCacheEntryInTable ( + &ArpService->ResolvedCacheTable, + NULL, + ByBoth, + &MatchAddress[Protocol], + &MatchAddress[Hardware] + ); + } + + if ((CacheEntry != NULL) && !Overwrite) { + // + // The entry to add exists, if not Overwirte, deny this add request. + // + Status = EFI_ACCESS_DENIED; + goto UNLOCK_EXIT; + } + + if ((CacheEntry == NULL) && (TargetSwAddress != NULL)) { + // + // Check whether there are pending requests matching the entry to be added. + // + CacheEntry = ArpFindNextCacheEntryInTable ( + &ArpService->PendingRequestTable, + NULL, + ByProtoAddress, + &MatchAddress[Protocol], + NULL + ); + } + + if (CacheEntry != NULL) { + // + // Remove it from the Table. + // + RemoveEntryList (&CacheEntry->List); + } else { + // + // It's a new entry, allocate memory for the entry. + // + CacheEntry = ArpAllocCacheEntry (Instance); + + if (CacheEntry == NULL) { + DEBUG ((EFI_D_ERROR, "ArpAdd: Failed to allocate pool for CacheEntry.\n")); + Status = EFI_OUT_OF_RESOURCES; + goto UNLOCK_EXIT; + } + } + + // + // Overwrite these parameters. + // + CacheEntry->DefaultDecayTime = TimeoutValue; + CacheEntry->DecayTime = TimeoutValue; + + // + // Fill in the addresses. + // + ArpFillAddressInCacheEntry ( + CacheEntry, + &MatchAddress[Hardware], + &MatchAddress[Protocol] + ); + + // + // Inform the user if there is any. + // + ArpAddressResolved (CacheEntry, NULL, NULL); + + // + // Add this CacheEntry to the corresponding CacheTable. + // + if (DenyFlag) { + InsertHeadList (&ArpService->DeniedCacheTable, &CacheEntry->List); + } else { + InsertHeadList (&ArpService->ResolvedCacheTable, &CacheEntry->List); + } + +UNLOCK_EXIT: + + gBS->RestoreTPL (OldTpl); + + return Status; +} + + +/** + This function searches the ARP cache for matching entries and allocates a buffer into + which those entries are copied. + + The first part of the allocated buffer is EFI_ARP_FIND_DATA, following which + are protocol address pairs and hardware address pairs. + When finding a specific protocol address (BySwAddress is TRUE and AddressBuffer + is not NULL), the ARP cache timeout for the found entry is reset if Refresh is + set to TRUE. If the found ARP cache entry is a permanent entry, it is not + affected by Refresh. + + @param This Pointer to the EFI_ARP_PROTOCOL instance. + @param BySwAddress Set to TRUE to look for matching software protocol + addresses. Set to FALSE to look for matching + hardware protocol addresses. + @param AddressBuffer Pointer to address buffer. Set to NULL to match + all addresses. + @param EntryLength The size of an entry in the entries buffer. + @param EntryCount The number of ARP cache entries that are found by + the specified criteria. + @param Entries Pointer to the buffer that will receive the ARP + cache entries. + @param Refresh Set to TRUE to refresh the timeout value of the + matching ARP cache entry. + + @retval EFI_SUCCESS The requested ARP cache entries were copied into + the buffer. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + This is NULL. Both EntryCount and EntryLength are + NULL, when Refresh is FALSE. + @retval EFI_NOT_FOUND No matching entries were found. + @retval EFI_NOT_STARTED The ARP driver instance has not been configured. + +**/ +EFI_STATUS +EFIAPI +ArpFind ( + IN EFI_ARP_PROTOCOL *This, + IN BOOLEAN BySwAddress, + IN VOID *AddressBuffer OPTIONAL, + OUT UINT32 *EntryLength OPTIONAL, + OUT UINT32 *EntryCount OPTIONAL, + OUT EFI_ARP_FIND_DATA **Entries OPTIONAL, + IN BOOLEAN Refresh + ) +{ + EFI_STATUS Status; + ARP_INSTANCE_DATA *Instance; + EFI_TPL OldTpl; + + if ((This == NULL) || + (!Refresh && (EntryCount == NULL) && (EntryLength == NULL)) || + ((Entries != NULL) && ((EntryLength == NULL) || (EntryCount == NULL)))) { + return EFI_INVALID_PARAMETER; + } + + Instance = ARP_INSTANCE_DATA_FROM_THIS (This); + + if (!Instance->Configured) { + return EFI_NOT_STARTED; + } + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + // + // All the check passed, find the cache entries now. + // + Status = ArpFindCacheEntry ( + Instance, + BySwAddress, + AddressBuffer, + EntryLength, + EntryCount, + Entries, + Refresh + ); + + gBS->RestoreTPL (OldTpl); + + return Status; +} + + +/** + This function removes specified ARP cache entries. + + @param This Pointer to the EFI_ARP_PROTOCOL instance. + @param BySwAddress Set to TRUE to delete matching protocol addresses. + Set to FALSE to delete matching hardware + addresses. + @param AddressBuffer Pointer to the address buffer that is used as a + key to look for the cache entry. Set to NULL to + delete all entries. + + @retval EFI_SUCCESS The entry was removed from the ARP cache. + @retval EFI_INVALID_PARAMETER This is NULL. + @retval EFI_NOT_FOUND The specified deletion key was not found. + @retval EFI_NOT_STARTED The ARP driver instance has not been configured. + +**/ +EFI_STATUS +EFIAPI +ArpDelete ( + IN EFI_ARP_PROTOCOL *This, + IN BOOLEAN BySwAddress, + IN VOID *AddressBuffer OPTIONAL + ) +{ + ARP_INSTANCE_DATA *Instance; + UINTN Count; + EFI_TPL OldTpl; + + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + Instance = ARP_INSTANCE_DATA_FROM_THIS (This); + + if (!Instance->Configured) { + return EFI_NOT_STARTED; + } + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + // + // Delete the specified cache entries. + // + Count = ArpDeleteCacheEntry (Instance, BySwAddress, AddressBuffer, TRUE); + + gBS->RestoreTPL (OldTpl); + + return (Count == 0) ? EFI_NOT_FOUND : EFI_SUCCESS; +} + + +/** + This function delete all dynamic entries from the ARP cache that match the specified + software protocol type. + + @param This Pointer to the EFI_ARP_PROTOCOL instance. + + @retval EFI_SUCCESS The cache has been flushed. + @retval EFI_INVALID_PARAMETER This is NULL. + @retval EFI_NOT_FOUND There are no matching dynamic cache entries. + @retval EFI_NOT_STARTED The ARP driver instance has not been configured. + +**/ +EFI_STATUS +EFIAPI +ArpFlush ( + IN EFI_ARP_PROTOCOL *This + ) +{ + ARP_INSTANCE_DATA *Instance; + UINTN Count; + EFI_TPL OldTpl; + + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + Instance = ARP_INSTANCE_DATA_FROM_THIS (This); + + if (!Instance->Configured) { + return EFI_NOT_STARTED; + } + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + // + // Delete the dynamic entries from the cache table. + // + Count = ArpDeleteCacheEntry (Instance, FALSE, NULL, FALSE); + + gBS->RestoreTPL (OldTpl); + + return (Count == 0) ? EFI_NOT_FOUND : EFI_SUCCESS; +} + + +/** + This function tries to resolve the TargetSwAddress and optionally returns a + TargetHwAddress if it already exists in the ARP cache. + + @param This Pointer to the EFI_ARP_PROTOCOL instance. + @param TargetSwAddress Pointer to the protocol address to resolve. + @param ResolvedEvent Pointer to the event that will be signaled when + the address is resolved or some error occurs. + @param TargetHwAddress Pointer to the buffer for the resolved hardware + address in network byte order. + + @retval EFI_SUCCESS The data is copied from the ARP cache into the + TargetHwAddress buffer. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + This is NULL. TargetHwAddress is NULL. + @retval EFI_ACCESS_DENIED The requested address is not present in the normal + ARP cache but is present in the deny address list. + Outgoing traffic to that address is forbidden. + @retval EFI_NOT_STARTED The ARP driver instance has not been configured. + @retval EFI_NOT_READY The request has been started and is not finished. + +**/ +EFI_STATUS +EFIAPI +ArpRequest ( + IN EFI_ARP_PROTOCOL *This, + IN VOID *TargetSwAddress OPTIONAL, + IN EFI_EVENT ResolvedEvent OPTIONAL, + OUT VOID *TargetHwAddress + ) +{ + EFI_STATUS Status; + ARP_INSTANCE_DATA *Instance; + ARP_SERVICE_DATA *ArpService; + EFI_SIMPLE_NETWORK_MODE *SnpMode; + ARP_CACHE_ENTRY *CacheEntry; + NET_ARP_ADDRESS HardwareAddress; + NET_ARP_ADDRESS ProtocolAddress; + USER_REQUEST_CONTEXT *RequestContext; + EFI_TPL OldTpl; + + if ((This == NULL) || (TargetHwAddress == NULL)) { + return EFI_INVALID_PARAMETER; + } + + Instance = ARP_INSTANCE_DATA_FROM_THIS (This); + + if (!Instance->Configured) { + return EFI_NOT_STARTED; + } + + Status = EFI_SUCCESS; + ArpService = Instance->ArpService; + SnpMode = &ArpService->SnpMode; + + if ((TargetSwAddress == NULL) || + ((Instance->ConfigData.SwAddressType == IPV4_ETHER_PROTO_TYPE) && + IP4_IS_LOCAL_BROADCAST (*((UINT32 *)TargetSwAddress)))) { + // + // Return the hardware broadcast address. + // + CopyMem (TargetHwAddress, &SnpMode->BroadcastAddress, SnpMode->HwAddressSize); + + goto SIGNAL_USER; + } + + if ((Instance->ConfigData.SwAddressType == IPV4_ETHER_PROTO_TYPE) && + IP4_IS_MULTICAST (NTOHL (*((UINT32 *)TargetSwAddress)))) { + // + // If the software address is an IPv4 multicast address, invoke Mnp to + // resolve the address. + // + Status = ArpService->Mnp->McastIpToMac ( + ArpService->Mnp, + FALSE, + TargetSwAddress, + TargetHwAddress + ); + goto SIGNAL_USER; + } + + HardwareAddress.Type = SnpMode->IfType; + HardwareAddress.Length = (UINT8)SnpMode->HwAddressSize; + HardwareAddress.AddressPtr = NULL; + + ProtocolAddress.Type = Instance->ConfigData.SwAddressType; + ProtocolAddress.Length = Instance->ConfigData.SwAddressLength; + ProtocolAddress.AddressPtr = TargetSwAddress; + + // + // Initialize the TargetHwAddrss to a zero address. + // + ZeroMem (TargetHwAddress, SnpMode->HwAddressSize); + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + // + // Check whether the software address is in the denied table. + // + CacheEntry = ArpFindDeniedCacheEntry (ArpService, &ProtocolAddress, NULL); + if (CacheEntry != NULL) { + Status = EFI_ACCESS_DENIED; + goto UNLOCK_EXIT; + } + + // + // Check whether the software address is already resolved. + // + CacheEntry = ArpFindNextCacheEntryInTable ( + &ArpService->ResolvedCacheTable, + NULL, + ByProtoAddress, + &ProtocolAddress, + NULL + ); + if (CacheEntry != NULL) { + // + // Resolved, copy the address into the user buffer. + // + CopyMem ( + TargetHwAddress, + CacheEntry->Addresses[Hardware].AddressPtr, + CacheEntry->Addresses[Hardware].Length + ); + + goto UNLOCK_EXIT; + } + + if (ResolvedEvent == NULL) { + Status = EFI_NOT_READY; + goto UNLOCK_EXIT; + } + + // + // Create a request context for this arp request. + // + RequestContext = AllocatePool (sizeof(USER_REQUEST_CONTEXT)); + if (RequestContext == NULL) { + DEBUG ((EFI_D_ERROR, "ArpRequest: Allocate memory for RequestContext failed.\n")); + + Status = EFI_OUT_OF_RESOURCES; + goto UNLOCK_EXIT; + } + + RequestContext->Instance = Instance; + RequestContext->UserRequestEvent = ResolvedEvent; + RequestContext->UserHwAddrBuffer = TargetHwAddress; + InitializeListHead (&RequestContext->List); + + // + // Check whether there is a same request. + // + CacheEntry = ArpFindNextCacheEntryInTable ( + &ArpService->PendingRequestTable, + NULL, + ByProtoAddress, + &ProtocolAddress, + NULL + ); + if (CacheEntry != NULL) { + + CacheEntry->NextRetryTime = Instance->ConfigData.RetryTimeOut; + CacheEntry->RetryCount = Instance->ConfigData.RetryCount; + } else { + // + // Allocate a cache entry for this request. + // + CacheEntry = ArpAllocCacheEntry (Instance); + if (CacheEntry == NULL) { + DEBUG ((EFI_D_ERROR, "ArpRequest: Allocate memory for CacheEntry failed.\n")); + FreePool (RequestContext); + + Status = EFI_OUT_OF_RESOURCES; + goto UNLOCK_EXIT; + } + + // + // Fill the software address. + // + ArpFillAddressInCacheEntry (CacheEntry, &HardwareAddress, &ProtocolAddress); + + // + // Add this entry into the PendingRequestTable. + // + InsertTailList (&ArpService->PendingRequestTable, &CacheEntry->List); + } + + // + // Link this request context into the cache entry. + // + InsertHeadList (&CacheEntry->UserRequestList, &RequestContext->List); + + // + // Send out the ARP Request frame. + // + ArpSendFrame (Instance, CacheEntry, ARP_OPCODE_REQUEST); + Status = EFI_NOT_READY; + +UNLOCK_EXIT: + + gBS->RestoreTPL (OldTpl); + +SIGNAL_USER: + + if ((ResolvedEvent != NULL) && (Status == EFI_SUCCESS)) { + gBS->SignalEvent (ResolvedEvent); + + // + // Dispatch the DPC queued by the NotifyFunction of ResolvedEvent. + // + DispatchDpc (); + } + + return Status; +} + + +/** + This function aborts the previous ARP request (identified by This, TargetSwAddress + and ResolvedEvent) that is issued by EFI_ARP_PROTOCOL.Request(). + + If the request is in the internal ARP request queue, the request is aborted + immediately and its ResolvedEvent is signaled. Only an asynchronous address + request needs to be canceled. If TargeSwAddress and ResolveEvent are both + NULL, all the pending asynchronous requests that have been issued by This + instance will be cancelled and their corresponding events will be signaled. + + @param This Pointer to the EFI_ARP_PROTOCOL instance. + @param TargetSwAddress Pointer to the protocol address in previous + request session. + @param ResolvedEvent Pointer to the event that is used as the + notification event in previous request session. + + @retval EFI_SUCCESS The pending request session(s) is/are aborted and + corresponding event(s) is/are signaled. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + This is NULL. TargetSwAddress is not NULL and + ResolvedEvent is NULL. TargetSwAddress is NULL and + ResolvedEvent is not NULL. + @retval EFI_NOT_STARTED The ARP driver instance has not been configured. + @retval EFI_NOT_FOUND The request is not issued by + EFI_ARP_PROTOCOL.Request(). + +**/ +EFI_STATUS +EFIAPI +ArpCancel ( + IN EFI_ARP_PROTOCOL *This, + IN VOID *TargetSwAddress OPTIONAL, + IN EFI_EVENT ResolvedEvent OPTIONAL + ) +{ + ARP_INSTANCE_DATA *Instance; + UINTN Count; + EFI_TPL OldTpl; + + if ((This == NULL) || + ((TargetSwAddress != NULL) && (ResolvedEvent == NULL)) || + ((TargetSwAddress == NULL) && (ResolvedEvent != NULL))) { + return EFI_INVALID_PARAMETER; + } + + Instance = ARP_INSTANCE_DATA_FROM_THIS (This); + + if (!Instance->Configured) { + return EFI_NOT_STARTED; + } + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + // + // Cancel the specified request. + // + Count = ArpCancelRequest (Instance, TargetSwAddress, ResolvedEvent); + + // + // Dispatch the DPCs queued by the NotifyFunction of the events signaled + // by ArpCancleRequest. + // + DispatchDpc (); + + gBS->RestoreTPL (OldTpl); + + return (Count == 0) ? EFI_NOT_FOUND : EFI_SUCCESS; +} diff --git a/NetworkPkg/ArpDxe/ComponentName.c b/NetworkPkg/ArpDxe/ComponentName.c new file mode 100644 index 0000000000..bcee1e1444 --- /dev/null +++ b/NetworkPkg/ArpDxe/ComponentName.c @@ -0,0 +1,219 @@ +/** @file + UEFI Component Name(2) protocol implementation for ArpDxe driver. + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "ArpDriver.h" + + +// +// EFI Component Name Protocol +// +GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gArpComponentName = { + ArpComponentNameGetDriverName, + ArpComponentNameGetControllerName, + "eng" +}; + +// +// EFI Component Name 2 Protocol +// +GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gArpComponentName2 = { + (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) ArpComponentNameGetDriverName, + (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) ArpComponentNameGetControllerName, + "en" +}; + + +GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mArpDriverNameTable[] = { + { "eng;en", L"ARP Network Service Driver" }, + { NULL, NULL } +}; + +GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mArpControllerNameTable[] = { + { "eng;en", L"ARP Controller" }, + { NULL, NULL } +}; + +/** + Retrieves a Unicode string that is the user readable name of the driver. + + This function retrieves the user readable name of a driver in the form of a + Unicode string. If the driver specified by This has a user readable name in + the language specified by Language, then a pointer to the driver name is + returned in DriverName, and EFI_SUCCESS is returned. If the driver specified + by This does not support the language specified by Language, + then EFI_UNSUPPORTED is returned. + + @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param[in] Language A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified + in RFC 4646 or ISO 639-2 language code format. + + @param[out] DriverName A pointer to the Unicode string to return. + This Unicode string is the name of the + driver specified by This in the language + specified by Language. + + @retval EFI_SUCCESS The Unicode string for the Driver specified by + This and the language specified by Language was + returned in DriverName. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER DriverName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +ArpComponentNameGetDriverName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN CHAR8 *Language, + OUT CHAR16 **DriverName + ) +{ + return LookupUnicodeString2 ( + Language, + This->SupportedLanguages, + mArpDriverNameTable, + DriverName, + (BOOLEAN)(This == &gArpComponentName) + ); +} + +/** + Retrieves a Unicode string that is the user readable name of the controller + that is being managed by a driver. + + This function retrieves the user readable name of the controller specified by + ControllerHandle and ChildHandle in the form of a Unicode string. If the + driver specified by This has a user readable name in the language specified by + Language, then a pointer to the controller name is returned in ControllerName, + and EFI_SUCCESS is returned. If the driver specified by This is not currently + managing the controller specified by ControllerHandle and ChildHandle, + then EFI_UNSUPPORTED is returned. If the driver specified by This does not + support the language specified by Language, then EFI_UNSUPPORTED is returned. + + @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param[in] ControllerHandle The handle of a controller that the driver + specified by This is managing. This handle + specifies the controller whose name is to be + returned. + + @param[in] ChildHandle The handle of the child controller to retrieve + the name of. This is an optional parameter that + may be NULL. It will be NULL for device + drivers. It will also be NULL for a bus drivers + that wish to retrieve the name of the bus + controller. It will not be NULL for a bus + driver that wishes to retrieve the name of a + child controller. + + @param[in] Language A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified in + RFC 4646 or ISO 639-2 language code format. + + @param[out] ControllerName A pointer to the Unicode string to return. + This Unicode string is the name of the + controller specified by ControllerHandle and + ChildHandle in the language specified by + Language from the point of view of the driver + specified by This. + + @retval EFI_SUCCESS The Unicode string for the user readable name in + the language specified by Language for the + driver specified by This was returned in + DriverName. + + @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. + + @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid + EFI_HANDLE. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER ControllerName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This is not currently + managing the controller specified by + ControllerHandle and ChildHandle. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +ArpComponentNameGetControllerName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_HANDLE ChildHandle OPTIONAL, + IN CHAR8 *Language, + OUT CHAR16 **ControllerName + ) +{ + EFI_STATUS Status; + EFI_ARP_PROTOCOL *Arp; + + // + // Only provide names for child handles. + // + if (ChildHandle == NULL) { + return EFI_UNSUPPORTED; + } + + // + // Make sure this driver produced ChildHandle + // + Status = EfiTestChildHandle ( + ControllerHandle, + ChildHandle, + &gEfiManagedNetworkProtocolGuid + ); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Retrieve an instance of a produced protocol from ChildHandle + // + Status = gBS->OpenProtocol ( + ChildHandle, + &gEfiArpProtocolGuid, + (VOID **)&Arp, + NULL, + NULL, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + if (EFI_ERROR (Status)) { + return Status; + } + + return LookupUnicodeString2 ( + Language, + This->SupportedLanguages, + mArpControllerNameTable, + ControllerName, + (BOOLEAN)(This == &gArpComponentName) + ); +} diff --git a/NetworkPkg/Dhcp4Dxe/ComponentName.c b/NetworkPkg/Dhcp4Dxe/ComponentName.c new file mode 100644 index 0000000000..7c404fa267 --- /dev/null +++ b/NetworkPkg/Dhcp4Dxe/ComponentName.c @@ -0,0 +1,431 @@ +/** @file + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + + +#include "Dhcp4Impl.h" + +// +// EFI Component Name Functions +// +/** + Retrieves a Unicode string that is the user readable name of the driver. + + This function retrieves the user readable name of a driver in the form of a + Unicode string. If the driver specified by This has a user readable name in + the language specified by Language, then a pointer to the driver name is + returned in DriverName, and EFI_SUCCESS is returned. If the driver specified + by This does not support the language specified by Language, + then EFI_UNSUPPORTED is returned. + + @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param[in] Language A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified + in RFC 4646 or ISO 639-2 language code format. + + @param[out] DriverName A pointer to the Unicode string to return. + This Unicode string is the name of the + driver specified by This in the language + specified by Language. + + @retval EFI_SUCCESS The Unicode string for the Driver specified by + This and the language specified by Language was + returned in DriverName. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER DriverName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +DhcpComponentNameGetDriverName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN CHAR8 *Language, + OUT CHAR16 **DriverName + ); + + +/** + Retrieves a Unicode string that is the user readable name of the controller + that is being managed by a driver. + + This function retrieves the user readable name of the controller specified by + ControllerHandle and ChildHandle in the form of a Unicode string. If the + driver specified by This has a user readable name in the language specified by + Language, then a pointer to the controller name is returned in ControllerName, + and EFI_SUCCESS is returned. If the driver specified by This is not currently + managing the controller specified by ControllerHandle and ChildHandle, + then EFI_UNSUPPORTED is returned. If the driver specified by This does not + support the language specified by Language, then EFI_UNSUPPORTED is returned. + + @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param[in] ControllerHandle The handle of a controller that the driver + specified by This is managing. This handle + specifies the controller whose name is to be + returned. + + @param[in] ChildHandle The handle of the child controller to retrieve + the name of. This is an optional parameter that + may be NULL. It will be NULL for device + drivers. It will also be NULL for a bus drivers + that wish to retrieve the name of the bus + controller. It will not be NULL for a bus + driver that wishes to retrieve the name of a + child controller. + + @param[in] Language A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified in + RFC 4646 or ISO 639-2 language code format. + + @param[out] ControllerName A pointer to the Unicode string to return. + This Unicode string is the name of the + controller specified by ControllerHandle and + ChildHandle in the language specified by + Language from the point of view of the driver + specified by This. + + @retval EFI_SUCCESS The Unicode string for the user readable name in + the language specified by Language for the + driver specified by This was returned in + DriverName. + + @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. + + @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid + EFI_HANDLE. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER ControllerName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This is not currently + managing the controller specified by + ControllerHandle and ChildHandle. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +DhcpComponentNameGetControllerName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_HANDLE ChildHandle OPTIONAL, + IN CHAR8 *Language, + OUT CHAR16 **ControllerName + ); + + +// +// EFI Component Name Protocol +// +GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gDhcp4ComponentName = { + DhcpComponentNameGetDriverName, + DhcpComponentNameGetControllerName, + "eng" +}; + +// +// EFI Component Name 2 Protocol +// +GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gDhcp4ComponentName2 = { + (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) DhcpComponentNameGetDriverName, + (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) DhcpComponentNameGetControllerName, + "en" +}; + + +GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mDhcpDriverNameTable[] = { + { + "eng;en", + L"DHCP Protocol Driver" + }, + { + NULL, + NULL + } +}; + +GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE *gDhcpControllerNameTable = NULL; + +CHAR16 *mDhcp4ControllerName[] = { + L"DHCPv4 (State=0, Stopped)", + L"DHCPv4 (State=1, Init)", + L"DHCPv4 (State=2, Selecting)", + L"DHCPv4 (State=3, Requesting)", + L"DHCPv4 (State=4, Bound)", + L"DHCPv4 (State=5, Renewing)", + L"DHCPv4 (State=6, Rebinding)", + L"DHCPv4 (State=7, InitReboot)", + L"DHCPv4 (State=8, Rebooting)" +}; + +/** + Retrieves a Unicode string that is the user readable name of the driver. + + This function retrieves the user readable name of a driver in the form of a + Unicode string. If the driver specified by This has a user readable name in + the language specified by Language, then a pointer to the driver name is + returned in DriverName, and EFI_SUCCESS is returned. If the driver specified + by This does not support the language specified by Language, + then EFI_UNSUPPORTED is returned. + + @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param[in] Language A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified + in RFC 4646 or ISO 639-2 language code format. + + @param[out] DriverName A pointer to the Unicode string to return. + This Unicode string is the name of the + driver specified by This in the language + specified by Language. + + @retval EFI_SUCCESS The Unicode string for the Driver specified by + This and the language specified by Language was + returned in DriverName. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER DriverName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +DhcpComponentNameGetDriverName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN CHAR8 *Language, + OUT CHAR16 **DriverName + ) +{ + return LookupUnicodeString2 ( + Language, + This->SupportedLanguages, + mDhcpDriverNameTable, + DriverName, + (BOOLEAN)(This == &gDhcp4ComponentName) + ); +} + +/** + Update the component name for the Dhcp4 child handle. + + @param Dhcp4[in] A pointer to the EFI_DHCP4_PROTOCOL. + + + @retval EFI_SUCCESS Update the ControllerNameTable of this instance successfully. + @retval EFI_INVALID_PARAMETER The input parameter is invalid. + @retval EFI_DEVICE_ERROR DHCP is in unknown state. + +**/ +EFI_STATUS +UpdateName ( + IN EFI_DHCP4_PROTOCOL *Dhcp4 + ) +{ + EFI_STATUS Status; + EFI_DHCP4_MODE_DATA Dhcp4ModeData; + + if (Dhcp4 == NULL) { + return EFI_INVALID_PARAMETER; + } + + // + // Format the child name into the string buffer. + // + Status = Dhcp4->GetModeData (Dhcp4, &Dhcp4ModeData); + if (EFI_ERROR (Status)) { + return Status; + } + + if (gDhcpControllerNameTable != NULL) { + FreeUnicodeStringTable (gDhcpControllerNameTable); + gDhcpControllerNameTable = NULL; + } + + if (Dhcp4ModeData.State > Dhcp4Rebooting) { + return EFI_DEVICE_ERROR; + } + + Status = AddUnicodeString2 ( + "eng", + gDhcp4ComponentName.SupportedLanguages, + &gDhcpControllerNameTable, + mDhcp4ControllerName[Dhcp4ModeData.State], + TRUE + ); + if (EFI_ERROR (Status)) { + return Status; + } + + return AddUnicodeString2 ( + "en", + gDhcp4ComponentName2.SupportedLanguages, + &gDhcpControllerNameTable, + mDhcp4ControllerName[Dhcp4ModeData.State], + FALSE + ); +} + +/** + Retrieves a Unicode string that is the user readable name of the controller + that is being managed by a driver. + + This function retrieves the user readable name of the controller specified by + ControllerHandle and ChildHandle in the form of a Unicode string. If the + driver specified by This has a user readable name in the language specified by + Language, then a pointer to the controller name is returned in ControllerName, + and EFI_SUCCESS is returned. If the driver specified by This is not currently + managing the controller specified by ControllerHandle and ChildHandle, + then EFI_UNSUPPORTED is returned. If the driver specified by This does not + support the language specified by Language, then EFI_UNSUPPORTED is returned. + + @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param[in] ControllerHandle The handle of a controller that the driver + specified by This is managing. This handle + specifies the controller whose name is to be + returned. + + @param[in] ChildHandle The handle of the child controller to retrieve + the name of. This is an optional parameter that + may be NULL. It will be NULL for device + drivers. It will also be NULL for a bus drivers + that wish to retrieve the name of the bus + controller. It will not be NULL for a bus + driver that wishes to retrieve the name of a + child controller. + + @param[in] Language A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified in + RFC 4646 or ISO 639-2 language code format. + + @param[out] ControllerName A pointer to the Unicode string to return. + This Unicode string is the name of the + controller specified by ControllerHandle and + ChildHandle in the language specified by + Language from the point of view of the driver + specified by This. + + @retval EFI_SUCCESS The Unicode string for the user readable name in + the language specified by Language for the + driver specified by This was returned in + DriverName. + + @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. + + @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid + EFI_HANDLE. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER ControllerName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This is not currently + managing the controller specified by + ControllerHandle and ChildHandle. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +DhcpComponentNameGetControllerName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_HANDLE ChildHandle OPTIONAL, + IN CHAR8 *Language, + OUT CHAR16 **ControllerName + ) +{ + EFI_STATUS Status; + EFI_DHCP4_PROTOCOL *Dhcp4; + + // + // Only provide names for child handles. + // + if (ChildHandle == NULL) { + return EFI_UNSUPPORTED; + } + + // + // Make sure this driver produced ChildHandle + // + Status = EfiTestChildHandle ( + ControllerHandle, + ChildHandle, + &gEfiUdp4ProtocolGuid + ); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Retrieve an instance of a produced protocol from ChildHandle + // + Status = gBS->OpenProtocol ( + ChildHandle, + &gEfiDhcp4ProtocolGuid, + (VOID **)&Dhcp4, + NULL, + NULL, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Update the component name for this child handle. + // + Status = UpdateName (Dhcp4); + if (EFI_ERROR (Status)) { + return Status; + } + + return LookupUnicodeString2 ( + Language, + This->SupportedLanguages, + gDhcpControllerNameTable, + ControllerName, + (BOOLEAN)(This == &gDhcp4ComponentName) + ); +} diff --git a/NetworkPkg/Dhcp4Dxe/Dhcp4Driver.c b/NetworkPkg/Dhcp4Dxe/Dhcp4Driver.c new file mode 100644 index 0000000000..e891b68883 --- /dev/null +++ b/NetworkPkg/Dhcp4Dxe/Dhcp4Driver.c @@ -0,0 +1,732 @@ +/** @file + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Dhcp4Impl.h" +#include "Dhcp4Driver.h" + +EFI_DRIVER_BINDING_PROTOCOL gDhcp4DriverBinding = { + Dhcp4DriverBindingSupported, + Dhcp4DriverBindingStart, + Dhcp4DriverBindingStop, + 0xa, + NULL, + NULL +}; + +EFI_SERVICE_BINDING_PROTOCOL mDhcp4ServiceBindingTemplate = { + Dhcp4ServiceBindingCreateChild, + Dhcp4ServiceBindingDestroyChild +}; + +/** + This is the declaration of an EFI image entry point. This entry point is + the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including + both device drivers and bus drivers. + + Entry point of the DHCP driver to install various protocols. + + @param[in] ImageHandle The firmware allocated handle for the UEFI image. + @param[in] SystemTable A pointer to the EFI System Table. + + @retval EFI_SUCCESS The operation completed successfully. + @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. + +**/ +EFI_STATUS +EFIAPI +Dhcp4DriverEntryPoint ( + IN EFI_HANDLE ImageHandle, + IN EFI_SYSTEM_TABLE *SystemTable + ) +{ + return EfiLibInstallDriverBindingComponentName2 ( + ImageHandle, + SystemTable, + &gDhcp4DriverBinding, + ImageHandle, + &gDhcp4ComponentName, + &gDhcp4ComponentName2 + ); +} + + +/** + Test to see if this driver supports ControllerHandle. This service + is called by the EFI boot service ConnectController(). In + order to make drivers as small as possible, there are a few calling + restrictions for this service. ConnectController() must + follow these calling restrictions. If any other agent wishes to call + Supported() it must also follow these calling restrictions. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to test + @param[in] RemainingDevicePath Optional parameter use to pick a specific child + device to start. + + @retval EFI_SUCCESS This driver supports this device + @retval EFI_ALREADY_STARTED This driver is already running on this device + @retval other This driver does not support this device + +**/ +EFI_STATUS +EFIAPI +Dhcp4DriverBindingSupported ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL + ) +{ + EFI_STATUS Status; + + Status = gBS->OpenProtocol ( + ControllerHandle, + &gEfiUdp4ServiceBindingProtocolGuid, + NULL, + This->DriverBindingHandle, + ControllerHandle, + EFI_OPEN_PROTOCOL_TEST_PROTOCOL + ); + + return Status; +} + + + +/** + Configure the default UDP child to receive all the DHCP traffics + on this network interface. + + @param[in] UdpIo The UDP IO to configure + @param[in] Context The context to the function + + @retval EFI_SUCCESS The UDP IO is successfully configured. + @retval Others Failed to configure the UDP child. + +**/ +EFI_STATUS +EFIAPI +DhcpConfigUdpIo ( + IN UDP_IO *UdpIo, + IN VOID *Context + ) +{ + EFI_UDP4_CONFIG_DATA UdpConfigData; + + UdpConfigData.AcceptBroadcast = TRUE; + UdpConfigData.AcceptPromiscuous = FALSE; + UdpConfigData.AcceptAnyPort = FALSE; + UdpConfigData.AllowDuplicatePort = TRUE; + UdpConfigData.TypeOfService = 0; + UdpConfigData.TimeToLive = 64; + UdpConfigData.DoNotFragment = FALSE; + UdpConfigData.ReceiveTimeout = 0; + UdpConfigData.TransmitTimeout = 0; + + UdpConfigData.UseDefaultAddress = FALSE; + UdpConfigData.StationPort = DHCP_CLIENT_PORT; + UdpConfigData.RemotePort = DHCP_SERVER_PORT; + + ZeroMem (&UdpConfigData.StationAddress, sizeof (EFI_IPv4_ADDRESS)); + ZeroMem (&UdpConfigData.SubnetMask, sizeof (EFI_IPv4_ADDRESS)); + ZeroMem (&UdpConfigData.RemoteAddress, sizeof (EFI_IPv4_ADDRESS)); + + return UdpIo->Protocol.Udp4->Configure (UdpIo->Protocol.Udp4, &UdpConfigData);; +} + + + +/** + Destroy the DHCP service. The Dhcp4 service may be partly initialized, + or partly destroyed. If a resource is destroyed, it is marked as so in + case the destroy failed and being called again later. + + @param[in] DhcpSb The DHCP service instance to destroy. + + @retval EFI_SUCCESS Always return success. + +**/ +EFI_STATUS +Dhcp4CloseService ( + IN DHCP_SERVICE *DhcpSb + ) +{ + DhcpCleanLease (DhcpSb); + + if (DhcpSb->UdpIo != NULL) { + UdpIoFreeIo (DhcpSb->UdpIo); + DhcpSb->UdpIo = NULL; + } + + if (DhcpSb->Timer != NULL) { + gBS->SetTimer (DhcpSb->Timer, TimerCancel, 0); + gBS->CloseEvent (DhcpSb->Timer); + + DhcpSb->Timer = NULL; + } + + return EFI_SUCCESS; +} + + + +/** + Create a new DHCP service binding instance for the controller. + + @param[in] Controller The controller to install DHCP service binding + protocol onto + @param[in] ImageHandle The driver's image handle + @param[out] Service The variable to receive the created DHCP service + instance. + + @retval EFI_OUT_OF_RESOURCES Failed to allocate resource . + @retval EFI_SUCCESS The DHCP service instance is created. + @retval other Other error occurs. + +**/ +EFI_STATUS +Dhcp4CreateService ( + IN EFI_HANDLE Controller, + IN EFI_HANDLE ImageHandle, + OUT DHCP_SERVICE **Service + ) +{ + DHCP_SERVICE *DhcpSb; + EFI_STATUS Status; + + *Service = NULL; + DhcpSb = AllocateZeroPool (sizeof (DHCP_SERVICE)); + + if (DhcpSb == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + DhcpSb->Signature = DHCP_SERVICE_SIGNATURE; + DhcpSb->ServiceState = DHCP_UNCONFIGED; + DhcpSb->Controller = Controller; + DhcpSb->Image = ImageHandle; + InitializeListHead (&DhcpSb->Children); + DhcpSb->DhcpState = Dhcp4Stopped; + DhcpSb->Xid = NET_RANDOM (NetRandomInitSeed ()); + CopyMem ( + &DhcpSb->ServiceBinding, + &mDhcp4ServiceBindingTemplate, + sizeof (EFI_SERVICE_BINDING_PROTOCOL) + ); + // + // Create various resources, UdpIo, Timer, and get Mac address + // + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL | EVT_TIMER, + TPL_CALLBACK, + DhcpOnTimerTick, + DhcpSb, + &DhcpSb->Timer + ); + + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + DhcpSb->UdpIo = UdpIoCreateIo ( + Controller, + ImageHandle, + DhcpConfigUdpIo, + UDP_IO_UDP4_VERSION, + NULL + ); + + if (DhcpSb->UdpIo == NULL) { + Status = EFI_OUT_OF_RESOURCES; + goto ON_ERROR; + } + + DhcpSb->HwLen = (UINT8) DhcpSb->UdpIo->SnpMode.HwAddressSize; + DhcpSb->HwType = DhcpSb->UdpIo->SnpMode.IfType; + CopyMem (&DhcpSb->Mac, &DhcpSb->UdpIo->SnpMode.CurrentAddress, sizeof (DhcpSb->Mac)); + + *Service = DhcpSb; + return EFI_SUCCESS; + +ON_ERROR: + Dhcp4CloseService (DhcpSb); + FreePool (DhcpSb); + + return Status; +} + + +/** + Start this driver on ControllerHandle. This service is called by the + EFI boot service ConnectController(). In order to make + drivers as small as possible, there are a few calling restrictions for + this service. ConnectController() must follow these + calling restrictions. If any other agent wishes to call Start() it + must also follow these calling restrictions. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to bind driver to + @param[in] RemainingDevicePath Optional parameter use to pick a specific child + device to start. + + @retval EFI_SUCCESS This driver is added to ControllerHandle + @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle + @retval other This driver does not support this device + +**/ +EFI_STATUS +EFIAPI +Dhcp4DriverBindingStart ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL + ) +{ + DHCP_SERVICE *DhcpSb; + EFI_STATUS Status; + + // + // First: test for the DHCP4 Protocol + // + Status = gBS->OpenProtocol ( + ControllerHandle, + &gEfiDhcp4ServiceBindingProtocolGuid, + NULL, + This->DriverBindingHandle, + ControllerHandle, + EFI_OPEN_PROTOCOL_TEST_PROTOCOL + ); + + if (Status == EFI_SUCCESS) { + return EFI_ALREADY_STARTED; + } + + Status = Dhcp4CreateService (ControllerHandle, This->DriverBindingHandle, &DhcpSb); + + if (EFI_ERROR (Status)) { + return Status; + } + ASSERT (DhcpSb != NULL); + + // + // Start the receiving + // + Status = UdpIoRecvDatagram (DhcpSb->UdpIo, DhcpInput, DhcpSb, 0); + + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + Status = gBS->SetTimer (DhcpSb->Timer, TimerPeriodic, TICKS_PER_SECOND); + + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + // + // Install the Dhcp4ServiceBinding Protocol onto ControlerHandle + // + Status = gBS->InstallMultipleProtocolInterfaces ( + &ControllerHandle, + &gEfiDhcp4ServiceBindingProtocolGuid, + &DhcpSb->ServiceBinding, + NULL + ); + + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + return Status; + +ON_ERROR: + Dhcp4CloseService (DhcpSb); + FreePool (DhcpSb); + return Status; +} + +/** + Callback function which provided by user to remove one node in NetDestroyLinkList process. + + @param[in] Entry The entry to be removed. + @param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList. + + @retval EFI_SUCCESS The entry has been removed successfully. + @retval Others Fail to remove the entry. + +**/ +EFI_STATUS +EFIAPI +Dhcp4DestroyChildEntry ( + IN LIST_ENTRY *Entry, + IN VOID *Context + ) +{ + DHCP_PROTOCOL *Instance; + EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; + + if (Entry == NULL || Context == NULL) { + return EFI_INVALID_PARAMETER; + } + + Instance = NET_LIST_USER_STRUCT_S (Entry, DHCP_PROTOCOL, Link, DHCP_PROTOCOL_SIGNATURE); + ServiceBinding = (EFI_SERVICE_BINDING_PROTOCOL *) Context; + + return ServiceBinding->DestroyChild (ServiceBinding, Instance->Handle); +} + + +/** + Stop this driver on ControllerHandle. This service is called by the + EFI boot service DisconnectController(). In order to + make drivers as small as possible, there are a few calling + restrictions for this service. DisconnectController() + must follow these calling restrictions. If any other agent wishes + to call Stop() it must also follow these calling restrictions. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to stop driver on + @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number of + children is zero stop the entire bus driver. + @param[in] ChildHandleBuffer List of Child Handles to Stop. + + @retval EFI_SUCCESS This driver is removed ControllerHandle + @retval other This driver was not removed from this device + +**/ +EFI_STATUS +EFIAPI +Dhcp4DriverBindingStop ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN UINTN NumberOfChildren, + IN EFI_HANDLE *ChildHandleBuffer + ) +{ + EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; + DHCP_SERVICE *DhcpSb; + EFI_HANDLE NicHandle; + EFI_STATUS Status; + LIST_ENTRY *List; + UINTN ListLength; + + // + // DHCP driver opens UDP child, So, the ControllerHandle is the + // UDP child handle. locate the Nic handle first. + // + NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiUdp4ProtocolGuid); + + if (NicHandle == NULL) { + return EFI_SUCCESS; + } + + Status = gBS->OpenProtocol ( + NicHandle, + &gEfiDhcp4ServiceBindingProtocolGuid, + (VOID **) &ServiceBinding, + This->DriverBindingHandle, + NicHandle, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + + if (EFI_ERROR (Status)) { + return EFI_DEVICE_ERROR; + } + + DhcpSb = DHCP_SERVICE_FROM_THIS (ServiceBinding); + if (!IsListEmpty (&DhcpSb->Children)) { + // + // Destroy all the children instances before destory the service. + // + List = &DhcpSb->Children; + Status = NetDestroyLinkList ( + List, + Dhcp4DestroyChildEntry, + ServiceBinding, + &ListLength + ); + if (EFI_ERROR (Status) || ListLength != 0) { + Status = EFI_DEVICE_ERROR; + } + } + + if (NumberOfChildren == 0 && !IsListEmpty (&DhcpSb->Children)) { + Status = EFI_DEVICE_ERROR; + } + + if (NumberOfChildren == 0 && IsListEmpty (&DhcpSb->Children)) { + // + // Destroy the service itself if no child instance left. + // + DhcpSb->ServiceState = DHCP_DESTROY; + + gBS->UninstallProtocolInterface ( + NicHandle, + &gEfiDhcp4ServiceBindingProtocolGuid, + ServiceBinding + ); + + Dhcp4CloseService (DhcpSb); + + if (gDhcpControllerNameTable != NULL) { + FreeUnicodeStringTable (gDhcpControllerNameTable); + gDhcpControllerNameTable = NULL; + } + FreePool (DhcpSb); + + Status = EFI_SUCCESS; + } + + return Status; +} + + +/** + Initialize a new DHCP instance. + + @param DhcpSb The dhcp service instance + @param Instance The dhcp instance to initialize + +**/ +VOID +DhcpInitProtocol ( + IN DHCP_SERVICE *DhcpSb, + IN OUT DHCP_PROTOCOL *Instance + ) +{ + Instance->Signature = DHCP_PROTOCOL_SIGNATURE; + CopyMem (&Instance->Dhcp4Protocol, &mDhcp4ProtocolTemplate, sizeof (Instance->Dhcp4Protocol)); + InitializeListHead (&Instance->Link); + Instance->Handle = NULL; + Instance->Service = DhcpSb; + Instance->InDestroy = FALSE; + Instance->CompletionEvent = NULL; + Instance->RenewRebindEvent = NULL; + Instance->Token = NULL; + Instance->UdpIo = NULL; + Instance->ElaspedTime = 0; + NetbufQueInit (&Instance->ResponseQueue); +} + + +/** + Creates a child handle and installs a protocol. + + The CreateChild() function installs a protocol on ChildHandle. + If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. + If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle. + + @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. + @param ChildHandle Pointer to the handle of the child to create. If it is NULL, + then a new handle is created. If it is a pointer to an existing UEFI handle, + then the protocol is added to the existing UEFI handle. + + @retval EFI_SUCCES The protocol was added to ChildHandle. + @retval EFI_INVALID_PARAMETER ChildHandle is NULL. + @retval EFI_OUT_OF_RESOURCES There are not enough resources available to create + the child + @retval other The child handle was not created + +**/ +EFI_STATUS +EFIAPI +Dhcp4ServiceBindingCreateChild ( + IN EFI_SERVICE_BINDING_PROTOCOL *This, + IN EFI_HANDLE *ChildHandle + ) +{ + DHCP_SERVICE *DhcpSb; + DHCP_PROTOCOL *Instance; + EFI_STATUS Status; + EFI_TPL OldTpl; + VOID *Udp4; + + if ((This == NULL) || (ChildHandle == NULL)) { + return EFI_INVALID_PARAMETER; + } + + Instance = AllocatePool (sizeof (*Instance)); + + if (Instance == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + DhcpSb = DHCP_SERVICE_FROM_THIS (This); + DhcpInitProtocol (DhcpSb, Instance); + + // + // Install DHCP4 onto ChildHandle + // + Status = gBS->InstallMultipleProtocolInterfaces ( + ChildHandle, + &gEfiDhcp4ProtocolGuid, + &Instance->Dhcp4Protocol, + NULL + ); + + if (EFI_ERROR (Status)) { + FreePool (Instance); + return Status; + } + + Instance->Handle = *ChildHandle; + + // + // Open the Udp4 protocol BY_CHILD. + // + Status = gBS->OpenProtocol ( + DhcpSb->UdpIo->UdpHandle, + &gEfiUdp4ProtocolGuid, + (VOID **) &Udp4, + gDhcp4DriverBinding.DriverBindingHandle, + Instance->Handle, + EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER + ); + if (EFI_ERROR (Status)) { + gBS->UninstallMultipleProtocolInterfaces ( + Instance->Handle, + &gEfiDhcp4ProtocolGuid, + &Instance->Dhcp4Protocol, + NULL + ); + + FreePool (Instance); + return Status; + } + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + InsertTailList (&DhcpSb->Children, &Instance->Link); + DhcpSb->NumChildren++; + + gBS->RestoreTPL (OldTpl); + + return EFI_SUCCESS; +} + + +/** + Destroys a child handle with a protocol installed on it. + + The DestroyChild() function does the opposite of CreateChild(). It removes a protocol + that was installed by CreateChild() from ChildHandle. If the removed protocol is the + last protocol on ChildHandle, then ChildHandle is destroyed. + + @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. + @param ChildHandle Handle of the child to destroy + + @retval EFI_SUCCES The protocol was removed from ChildHandle. + @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed. + @retval EFI_INVALID_PARAMETER Child handle is NULL. + @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle + because its services are being used. + @retval other The child handle was not destroyed + +**/ +EFI_STATUS +EFIAPI +Dhcp4ServiceBindingDestroyChild ( + IN EFI_SERVICE_BINDING_PROTOCOL *This, + IN EFI_HANDLE ChildHandle + ) +{ + DHCP_SERVICE *DhcpSb; + DHCP_PROTOCOL *Instance; + EFI_DHCP4_PROTOCOL *Dhcp; + EFI_TPL OldTpl; + EFI_STATUS Status; + + if ((This == NULL) || (ChildHandle == NULL)) { + return EFI_INVALID_PARAMETER; + } + + // + // Retrieve the private context data structures + // + Status = gBS->OpenProtocol ( + ChildHandle, + &gEfiDhcp4ProtocolGuid, + (VOID **) &Dhcp, + gDhcp4DriverBinding.DriverBindingHandle, + ChildHandle, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + + if (EFI_ERROR (Status)) { + return EFI_UNSUPPORTED; + } + + Instance = DHCP_INSTANCE_FROM_THIS (Dhcp); + DhcpSb = DHCP_SERVICE_FROM_THIS (This); + + if (Instance->Service != DhcpSb) { + return EFI_INVALID_PARAMETER; + } + + // + // A child can be destroyed more than once. For example, + // Dhcp4DriverBindingStop will destroy all of its children. + // when caller driver is being stopped, it will destroy the + // dhcp child it opens. + // + if (Instance->InDestroy) { + return EFI_SUCCESS; + } + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + Instance->InDestroy = TRUE; + + // + // Close the Udp4 protocol. + // + gBS->CloseProtocol ( + DhcpSb->UdpIo->UdpHandle, + &gEfiUdp4ProtocolGuid, + gDhcp4DriverBinding.DriverBindingHandle, + ChildHandle + ); + + // + // Uninstall the DHCP4 protocol first to enable a top down destruction. + // + gBS->RestoreTPL (OldTpl); + Status = gBS->UninstallProtocolInterface ( + ChildHandle, + &gEfiDhcp4ProtocolGuid, + Dhcp + ); + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + if (EFI_ERROR (Status)) { + Instance->InDestroy = FALSE; + + gBS->RestoreTPL (OldTpl); + return Status; + } + + if (DhcpSb->ActiveChild == Instance) { + DhcpYieldControl (DhcpSb); + } + + RemoveEntryList (&Instance->Link); + DhcpSb->NumChildren--; + + if (Instance->UdpIo != NULL) { + UdpIoCleanIo (Instance->UdpIo); + gBS->CloseProtocol ( + Instance->UdpIo->UdpHandle, + &gEfiUdp4ProtocolGuid, + Instance->Service->Image, + Instance->Handle + ); + UdpIoFreeIo (Instance->UdpIo); + Instance->UdpIo = NULL; + Instance->Token = NULL; + } + + gBS->RestoreTPL (OldTpl); + + FreePool (Instance); + return EFI_SUCCESS; +} diff --git a/NetworkPkg/Dhcp4Dxe/Dhcp4Driver.h b/NetworkPkg/Dhcp4Dxe/Dhcp4Driver.h new file mode 100644 index 0000000000..cebde20dca --- /dev/null +++ b/NetworkPkg/Dhcp4Dxe/Dhcp4Driver.h @@ -0,0 +1,146 @@ +/** @file + Header for the DHCP4 driver. + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef __EFI_DHCP4_DRIVER_H__ +#define __EFI_DHCP4_DRIVER_H__ + +extern EFI_COMPONENT_NAME_PROTOCOL gDhcp4ComponentName; +extern EFI_COMPONENT_NAME2_PROTOCOL gDhcp4ComponentName2; +extern EFI_UNICODE_STRING_TABLE *gDhcpControllerNameTable; + +/** + Test to see if this driver supports ControllerHandle. This service + is called by the EFI boot service ConnectController(). In + order to make drivers as small as possible, there are a few calling + restrictions for this service. ConnectController() must + follow these calling restrictions. If any other agent wishes to call + Supported() it must also follow these calling restrictions. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to test + @param[in] RemainingDevicePath Optional parameter use to pick a specific child + device to start. + + @retval EFI_SUCCESS This driver supports this device + @retval EFI_ALREADY_STARTED This driver is already running on this device + @retval other This driver does not support this device + +**/ +EFI_STATUS +EFIAPI +Dhcp4DriverBindingSupported ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL + ); + +/** + Start this driver on ControllerHandle. This service is called by the + EFI boot service ConnectController(). In order to make + drivers as small as possible, there are a few calling restrictions for + this service. ConnectController() must follow these + calling restrictions. If any other agent wishes to call Start() it + must also follow these calling restrictions. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to bind driver to + @param[in] RemainingDevicePath Optional parameter use to pick a specific child + device to start. + + @retval EFI_SUCCESS This driver is added to ControllerHandle + @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle + @retval other This driver does not support this device + +**/ +EFI_STATUS +EFIAPI +Dhcp4DriverBindingStart ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL + ); + +/** + Stop this driver on ControllerHandle. This service is called by the + EFI boot service DisconnectController(). In order to + make drivers as small as possible, there are a few calling + restrictions for this service. DisconnectController() + must follow these calling restrictions. If any other agent wishes + to call Stop() it must also follow these calling restrictions. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to stop driver on + @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number of + children is zero stop the entire bus driver. + @param[in] ChildHandleBuffer List of Child Handles to Stop. + + @retval EFI_SUCCESS This driver is removed ControllerHandle + @retval other This driver was not removed from this device + +**/ +EFI_STATUS +EFIAPI +Dhcp4DriverBindingStop ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN UINTN NumberOfChildren, + IN EFI_HANDLE *ChildHandleBuffer + ); + +/** + Creates a child handle and installs a protocol. + + The CreateChild() function installs a protocol on ChildHandle. + If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. + If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle. + + @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. + @param ChildHandle Pointer to the handle of the child to create. If it is NULL, + then a new handle is created. If it is a pointer to an existing UEFI handle, + then the protocol is added to the existing UEFI handle. + + @retval EFI_SUCCES The protocol was added to ChildHandle. + @retval EFI_INVALID_PARAMETER ChildHandle is NULL. + @retval EFI_OUT_OF_RESOURCES There are not enough resources available to create + the child + @retval other The child handle was not created + +**/ +EFI_STATUS +EFIAPI +Dhcp4ServiceBindingCreateChild ( + IN EFI_SERVICE_BINDING_PROTOCOL *This, + IN EFI_HANDLE *ChildHandle + ); + +/** + Destroys a child handle with a protocol installed on it. + + The DestroyChild() function does the opposite of CreateChild(). It removes a protocol + that was installed by CreateChild() from ChildHandle. If the removed protocol is the + last protocol on ChildHandle, then ChildHandle is destroyed. + + @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. + @param ChildHandle Handle of the child to destroy + + @retval EFI_SUCCES The protocol was removed from ChildHandle. + @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed. + @retval EFI_INVALID_PARAMETER Child handle is NULL. + @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle + because its services are being used. + @retval other The child handle was not destroyed + +**/ +EFI_STATUS +EFIAPI +Dhcp4ServiceBindingDestroyChild ( + IN EFI_SERVICE_BINDING_PROTOCOL *This, + IN EFI_HANDLE ChildHandle + ); + +#endif diff --git a/NetworkPkg/Dhcp4Dxe/Dhcp4Dxe.inf b/NetworkPkg/Dhcp4Dxe/Dhcp4Dxe.inf new file mode 100644 index 0000000000..62883518b2 --- /dev/null +++ b/NetworkPkg/Dhcp4Dxe/Dhcp4Dxe.inf @@ -0,0 +1,66 @@ +## @file +# This module produces EFI DHCPv4 Protocol and EFI DHCPv4 Service Binding Protocol. +# +# This module produces EFI DHCPv4 Protocol upon EFI UDPv4 Protocol, to provide the +# capability to collect configuration information for the EFI IPv4 Protocol drivers +# and to provide DHCPv4 server and PXE boot server discovery services. +# +# Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
+# SPDX-License-Identifier: BSD-2-Clause-Patent +# +# +## + +[Defines] + INF_VERSION = 0x00010005 + BASE_NAME = Dhcp4Dxe + MODULE_UNI_FILE = Dhcp4Dxe.uni + FILE_GUID = 94734718-0BBC-47fb-96A5-EE7A5AE6A2AD + MODULE_TYPE = UEFI_DRIVER + VERSION_STRING = 1.0 + ENTRY_POINT = Dhcp4DriverEntryPoint + UNLOAD_IMAGE = NetLibDefaultUnload +# +# The following information is for reference only and not required by the build tools. +# +# VALID_ARCHITECTURES = IA32 X64 EBC +# +# DRIVER_BINDING = gDhcp4DriverBinding +# COMPONENT_NAME = gDhcp4ComponentName +# COMPONENT_NAME2 = gDhcp4ComponentName2 +# + +[Sources] + Dhcp4Impl.c + Dhcp4Io.c + Dhcp4Io.h + ComponentName.c + Dhcp4Driver.h + Dhcp4Driver.c + Dhcp4Option.c + Dhcp4Option.h + Dhcp4Impl.h + +[Packages] + MdePkg/MdePkg.dec + MdeModulePkg/MdeModulePkg.dec + + +[LibraryClasses] + BaseLib + UefiLib + UefiBootServicesTableLib + UefiDriverEntryPoint + DebugLib + NetLib + UdpIoLib + + +[Protocols] + gEfiDhcp4ServiceBindingProtocolGuid ## BY_START + gEfiUdp4ServiceBindingProtocolGuid ## TO_START + gEfiDhcp4ProtocolGuid ## BY_START + gEfiUdp4ProtocolGuid ## TO_START + +[UserExtensions.TianoCore."ExtraFiles"] + Dhcp4DxeExtra.uni diff --git a/NetworkPkg/Dhcp4Dxe/Dhcp4Dxe.uni b/NetworkPkg/Dhcp4Dxe/Dhcp4Dxe.uni new file mode 100644 index 0000000000..5405b88d25 --- /dev/null +++ b/NetworkPkg/Dhcp4Dxe/Dhcp4Dxe.uni @@ -0,0 +1,18 @@ +// /** @file +// This module produces EFI DHCPv4 Protocol and EFI DHCPv4 Service Binding Protocol. +// +// This module produces EFI DHCPv4 Protocol upon EFI UDPv4 Protocol, to provide the +// capability to collect configuration information for the EFI IPv4 Protocol drivers +// and to provide DHCPv4 server and PXE boot server discovery services. +// +// Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
+// +// SPDX-License-Identifier: BSD-2-Clause-Patent +// +// **/ + + +#string STR_MODULE_ABSTRACT #language en-US "EFI DHCPv4 Driver" + +#string STR_MODULE_DESCRIPTION #language en-US "This module produces EFI DHCPv4 Protocol using the EFI UDPv4 Protocol, providing the capability to collect configuration information for the EFI IPv4 Protocol drivers and providing DHCPv4 server and PXE boot server discovery services." + diff --git a/NetworkPkg/Dhcp4Dxe/Dhcp4DxeExtra.uni b/NetworkPkg/Dhcp4Dxe/Dhcp4DxeExtra.uni new file mode 100644 index 0000000000..ca62553f8b --- /dev/null +++ b/NetworkPkg/Dhcp4Dxe/Dhcp4DxeExtra.uni @@ -0,0 +1,14 @@ +// /** @file +// Dhcp4Dxe Localized Strings and Content +// +// Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.
+// +// SPDX-License-Identifier: BSD-2-Clause-Patent +// +// **/ + +#string STR_PROPERTIES_MODULE_NAME +#language en-US +"DHCP v4 DXE Driver" + + diff --git a/NetworkPkg/Dhcp4Dxe/Dhcp4Impl.c b/NetworkPkg/Dhcp4Dxe/Dhcp4Impl.c new file mode 100644 index 0000000000..0b35bdf4df --- /dev/null +++ b/NetworkPkg/Dhcp4Dxe/Dhcp4Impl.c @@ -0,0 +1,1802 @@ +/** @file + This file implement the EFI_DHCP4_PROTOCOL interface. + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + + +#include "Dhcp4Impl.h" + +/** + Returns the current operating mode and cached data packet for the EFI DHCPv4 Protocol driver. + + The GetModeData() function returns the current operating mode and cached data + packet for the EFI DHCPv4 Protocol driver. + + @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. + @param[out] Dhcp4ModeData Pointer to storage for the EFI_DHCP4_MODE_DATA structure. + + @retval EFI_SUCCESS The mode data was returned. + @retval EFI_INVALID_PARAMETER This is NULL. + +**/ +EFI_STATUS +EFIAPI +EfiDhcp4GetModeData ( + IN EFI_DHCP4_PROTOCOL *This, + OUT EFI_DHCP4_MODE_DATA *Dhcp4ModeData + ); + +/** + Initializes, changes, or resets the operational settings for the EFI DHCPv4 Protocol driver. + + The Configure() function is used to initialize, change, or reset the operational + settings of the EFI DHCPv4 Protocol driver for the communication device on which + the EFI DHCPv4 Service Binding Protocol is installed. This function can be + successfully called only if both of the following are true: + * This instance of the EFI DHCPv4 Protocol driver is in the Dhcp4Stopped, Dhcp4Init, + Dhcp4InitReboot, or Dhcp4Bound states. + * No other EFI DHCPv4 Protocol driver instance that is controlled by this EFI + DHCPv4 Service Binding Protocol driver instance has configured this EFI DHCPv4 + Protocol driver. + When this driver is in the Dhcp4Stopped state, it can transfer into one of the + following two possible initial states: + * Dhcp4Init + * Dhcp4InitReboot + The driver can transfer into these states by calling Configure() with a non-NULL + Dhcp4CfgData. The driver will transfer into the appropriate state based on the + supplied client network address in the ClientAddress parameter and DHCP options + in the OptionList parameter as described in RFC 2131. + When Configure() is called successfully while Dhcp4CfgData is set to NULL, the + default configuring data will be reset in the EFI DHCPv4 Protocol driver and + the state of the EFI DHCPv4 Protocol driver will not be changed. If one instance + wants to make it possible for another instance to configure the EFI DHCPv4 Protocol + driver, it must call this function with Dhcp4CfgData set to NULL. + + @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. + @param[in] Dhcp4CfgData Pointer to the EFI_DHCP4_CONFIG_DATA. + + @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Init or + Dhcp4InitReboot state, if the original state of this driver + was Dhcp4Stopped and the value of Dhcp4CfgData was + not NULL. Otherwise, the state was left unchanged. + @retval EFI_ACCESS_DENIED This instance of the EFI DHCPv4 Protocol driver was not in the + Dhcp4Stopped, Dhcp4Init, Dhcp4InitReboot, or Dhcp4Bound state; + Or onother instance of this EFI DHCPv4 Protocol driver is already + in a valid configured state. + @retval EFI_INVALID_PARAMETER Some parameter is NULL. + @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. + +**/ +EFI_STATUS +EFIAPI +EfiDhcp4Configure ( + IN EFI_DHCP4_PROTOCOL *This, + IN EFI_DHCP4_CONFIG_DATA *Dhcp4CfgData OPTIONAL + ); + +/** + Starts the DHCP configuration process. + + The Start() function starts the DHCP configuration process. This function can + be called only when the EFI DHCPv4 Protocol driver is in the Dhcp4Init or + Dhcp4InitReboot state. + If the DHCP process completes successfully, the state of the EFI DHCPv4 Protocol + driver will be transferred through Dhcp4Selecting and Dhcp4Requesting to the + Dhcp4Bound state. The CompletionEvent will then be signaled if it is not NULL. + If the process aborts, either by the user or by some unexpected network error, + the state is restored to the Dhcp4Init state. The Start() function can be called + again to restart the process. + Refer to RFC 2131 for precise state transitions during this process. At the + time when each event occurs in this process, the callback function that was set + by EFI_DHCP4_PROTOCOL.Configure() will be called and the user can take this + opportunity to control the process. + + @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. + @param[in] CompletionEvent If not NULL, indicates the event that will be signaled when the + EFI DHCPv4 Protocol driver is transferred into the + Dhcp4Bound state or when the DHCP process is aborted. + EFI_DHCP4_PROTOCOL.GetModeData() can be called to + check the completion status. If NULL, + EFI_DHCP4_PROTOCOL.Start() will wait until the driver + is transferred into the Dhcp4Bound state or the process fails. + + @retval EFI_SUCCESS The DHCP configuration process has started, or it has completed + when CompletionEvent is NULL. + @retval EFI_NOT_STARTED The EFI DHCPv4 Protocol driver is in the Dhcp4Stopped + state. EFI_DHCP4_PROTOCOL. Configure() needs to be called. + @retval EFI_INVALID_PARAMETER This is NULL. + @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. + @retval EFI_TIMEOUT The DHCP configuration process failed because no response was + received from the server within the specified timeout value. + @retval EFI_ABORTED The user aborted the DHCP process. + @retval EFI_ALREADY_STARTED Some other EFI DHCPv4 Protocol instance already started the + DHCP process. + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. + +**/ +EFI_STATUS +EFIAPI +EfiDhcp4Start ( + IN EFI_DHCP4_PROTOCOL *This, + IN EFI_EVENT CompletionEvent OPTIONAL + ); + +/** + Extends the lease time by sending a request packet. + + The RenewRebind() function is used to manually extend the lease time when the + EFI DHCPv4 Protocol driver is in the Dhcp4Bound state and the lease time has + not expired yet. This function will send a request packet to the previously + found server (or to any server when RebindRequest is TRUE) and transfer the + state into the Dhcp4Renewing state (or Dhcp4Rebinding when RebindingRequest is + TRUE). When a response is received, the state is returned to Dhcp4Bound. + If no response is received before the try count is exceeded (the RequestTryCount + field that is specified in EFI_DHCP4_CONFIG_DATA) but before the lease time that + was issued by the previous server expires, the driver will return to the Dhcp4Bound + state and the previous configuration is restored. The outgoing and incoming packets + can be captured by the EFI_DHCP4_CALLBACK function. + + @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. + @param[in] RebindRequest If TRUE, this function broadcasts the request packets and enters + the Dhcp4Rebinding state. Otherwise, it sends a unicast + request packet and enters the Dhcp4Renewing state. + @param[in] CompletionEvent If not NULL, this event is signaled when the renew/rebind phase + completes or some error occurs. + EFI_DHCP4_PROTOCOL.GetModeData() can be called to + check the completion status. If NULL, + EFI_DHCP4_PROTOCOL.RenewRebind() will busy-wait + until the DHCP process finishes. + + @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the + Dhcp4Renewing state or is back to the Dhcp4Bound state. + @retval EFI_NOT_STARTED The EFI DHCPv4 Protocol driver is in the Dhcp4Stopped + state. EFI_DHCP4_PROTOCOL.Configure() needs to + be called. + @retval EFI_INVALID_PARAMETER This is NULL. + @retval EFI_TIMEOUT There was no response from the server when the try count was + exceeded. + @retval EFI_ACCESS_DENIED The driver is not in the Dhcp4Bound state. + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. + +**/ +EFI_STATUS +EFIAPI +EfiDhcp4RenewRebind ( + IN EFI_DHCP4_PROTOCOL *This, + IN BOOLEAN RebindRequest, + IN EFI_EVENT CompletionEvent OPTIONAL + ); + +/** + Releases the current address configuration. + + The Release() function releases the current configured IP address by doing either + of the following: + * Sending a DHCPRELEASE packet when the EFI DHCPv4 Protocol driver is in the + Dhcp4Bound state + * Setting the previously assigned IP address that was provided with the + EFI_DHCP4_PROTOCOL.Configure() function to 0.0.0.0 when the driver is in + Dhcp4InitReboot state + After a successful call to this function, the EFI DHCPv4 Protocol driver returns + to the Dhcp4Init state and any subsequent incoming packets will be discarded silently. + + @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. + + @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Init phase. + @retval EFI_INVALID_PARAMETER This is NULL. + @retval EFI_ACCESS_DENIED The EFI DHCPv4 Protocol driver is not Dhcp4InitReboot state. + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. + +**/ +EFI_STATUS +EFIAPI +EfiDhcp4Release ( + IN EFI_DHCP4_PROTOCOL *This + ); + +/** + Stops the current address configuration. + + The Stop() function is used to stop the DHCP configuration process. After this + function is called successfully, the EFI DHCPv4 Protocol driver is transferred + into the Dhcp4Stopped state. EFI_DHCP4_PROTOCOL.Configure() needs to be called + before DHCP configuration process can be started again. This function can be + called when the EFI DHCPv4 Protocol driver is in any state. + + @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. + + @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Stopped phase. + @retval EFI_INVALID_PARAMETER This is NULL. + +**/ +EFI_STATUS +EFIAPI +EfiDhcp4Stop ( + IN EFI_DHCP4_PROTOCOL *This + ); + +/** + Builds a DHCP packet, given the options to be appended or deleted or replaced. + + The Build() function is used to assemble a new packet from the original packet + by replacing or deleting existing options or appending new options. This function + does not change any state of the EFI DHCPv4 Protocol driver and can be used at + any time. + + @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. + @param[in] SeedPacket Initial packet to be used as a base for building new packet. + @param[in] DeleteCount Number of opcodes in the DeleteList. + @param[in] DeleteList List of opcodes to be deleted from the seed packet. + Ignored if DeleteCount is zero. + @param[in] AppendCount Number of entries in the OptionList. + @param[in] AppendList Pointer to a DHCP option list to be appended to SeedPacket. + If SeedPacket also contains options in this list, they are + replaced by new options (except pad option). Ignored if + AppendCount is zero. Type EFI_DHCP4_PACKET_OPTION + @param[out] NewPacket Pointer to storage for the pointer to the new allocated packet. + Use the EFI Boot Service FreePool() on the resulting pointer + when done with the packet. + + @retval EFI_SUCCESS The new packet was built. + @retval EFI_OUT_OF_RESOURCES Storage for the new packet could not be allocated. + @retval EFI_INVALID_PARAMETER Some parameter is NULL. + +**/ +EFI_STATUS +EFIAPI +EfiDhcp4Build ( + IN EFI_DHCP4_PROTOCOL *This, + IN EFI_DHCP4_PACKET *SeedPacket, + IN UINT32 DeleteCount, + IN UINT8 *DeleteList OPTIONAL, + IN UINT32 AppendCount, + IN EFI_DHCP4_PACKET_OPTION *AppendList[] OPTIONAL, + OUT EFI_DHCP4_PACKET **NewPacket + ); + +/** + Transmits a DHCP formatted packet and optionally waits for responses. + + The TransmitReceive() function is used to transmit a DHCP packet and optionally + wait for the response from servers. This function does not change the state of + the EFI DHCPv4 Protocol driver and thus can be used at any time. + + @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. + @param[in] Token Pointer to the EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN structure. + + @retval EFI_SUCCESS The packet was successfully queued for transmission. + @retval EFI_INVALID_PARAMETER Some parameter is NULL. + @retval EFI_NOT_READY The previous call to this function has not finished yet. Try to call + this function after collection process completes. + @retval EFI_NO_MAPPING The default station address is not available yet. + @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. + @retval Others Some other unexpected error occurred. + +**/ +EFI_STATUS +EFIAPI +EfiDhcp4TransmitReceive ( + IN EFI_DHCP4_PROTOCOL *This, + IN EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN *Token + ); + +/** + Parses the packed DHCP option data. + + The Parse() function is used to retrieve the option list from a DHCP packet. + If *OptionCount isn't zero, and there is enough space for all the DHCP options + in the Packet, each element of PacketOptionList is set to point to somewhere in + the Packet->Dhcp4.Option where a new DHCP option begins. If RFC3396 is supported, + the caller should reassemble the parsed DHCP options to get the finial result. + If *OptionCount is zero or there isn't enough space for all of them, the number + of DHCP options in the Packet is returned in OptionCount. + + @param This Pointer to the EFI_DHCP4_PROTOCOL instance. + @param Packet Pointer to packet to be parsed. + @param OptionCount On input, the number of entries in the PacketOptionList. + On output, the number of entries that were written into the + PacketOptionList. + @param PacketOptionList List of packet option entries to be filled in. End option or pad + options are not included. + + @retval EFI_SUCCESS The packet was successfully parsed. + @retval EFI_INVALID_PARAMETER Some parameter is NULL. + @retval EFI_BUFFER_TOO_SMALL One or more of the following conditions is TRUE: + 1) *OptionCount is smaller than the number of options that + were found in the Packet. + 2) PacketOptionList is NULL. + +**/ +EFI_STATUS +EFIAPI +EfiDhcp4Parse ( + IN EFI_DHCP4_PROTOCOL *This, + IN EFI_DHCP4_PACKET *Packet, + IN OUT UINT32 *OptionCount, + OUT EFI_DHCP4_PACKET_OPTION *PacketOptionList[] OPTIONAL + ); + +EFI_DHCP4_PROTOCOL mDhcp4ProtocolTemplate = { + EfiDhcp4GetModeData, + EfiDhcp4Configure, + EfiDhcp4Start, + EfiDhcp4RenewRebind, + EfiDhcp4Release, + EfiDhcp4Stop, + EfiDhcp4Build, + EfiDhcp4TransmitReceive, + EfiDhcp4Parse +}; + +/** + Returns the current operating mode and cached data packet for the EFI DHCPv4 Protocol driver. + + The GetModeData() function returns the current operating mode and cached data + packet for the EFI DHCPv4 Protocol driver. + + @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. + @param[out] Dhcp4ModeData Pointer to storage for the EFI_DHCP4_MODE_DATA structure. + + @retval EFI_SUCCESS The mode data was returned. + @retval EFI_INVALID_PARAMETER This is NULL. + +**/ +EFI_STATUS +EFIAPI +EfiDhcp4GetModeData ( + IN EFI_DHCP4_PROTOCOL *This, + OUT EFI_DHCP4_MODE_DATA *Dhcp4ModeData + ) +{ + DHCP_PROTOCOL *Instance; + DHCP_SERVICE *DhcpSb; + DHCP_PARAMETER *Para; + EFI_TPL OldTpl; + IP4_ADDR Ip; + + // + // First validate the parameters. + // + if ((This == NULL) || (Dhcp4ModeData == NULL)) { + return EFI_INVALID_PARAMETER; + } + + Instance = DHCP_INSTANCE_FROM_THIS (This); + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + DhcpSb = Instance->Service; + + // + // Caller can use GetModeData to retrieve current DHCP states + // no matter whether it is the active child or not. + // + Dhcp4ModeData->State = (EFI_DHCP4_STATE) DhcpSb->DhcpState; + CopyMem (&Dhcp4ModeData->ConfigData, &DhcpSb->ActiveConfig, sizeof (Dhcp4ModeData->ConfigData)); + CopyMem (&Dhcp4ModeData->ClientMacAddress, &DhcpSb->Mac, sizeof (Dhcp4ModeData->ClientMacAddress)); + + Ip = HTONL (DhcpSb->ClientAddr); + CopyMem (&Dhcp4ModeData->ClientAddress, &Ip, sizeof (EFI_IPv4_ADDRESS)); + + Ip = HTONL (DhcpSb->Netmask); + CopyMem (&Dhcp4ModeData->SubnetMask, &Ip, sizeof (EFI_IPv4_ADDRESS)); + + Ip = HTONL (DhcpSb->ServerAddr); + CopyMem (&Dhcp4ModeData->ServerAddress, &Ip, sizeof (EFI_IPv4_ADDRESS)); + + Para = DhcpSb->Para; + + if (Para != NULL) { + Ip = HTONL (Para->Router); + CopyMem (&Dhcp4ModeData->RouterAddress, &Ip, sizeof (EFI_IPv4_ADDRESS)); + Dhcp4ModeData->LeaseTime = Para->Lease; + } else { + ZeroMem (&Dhcp4ModeData->RouterAddress, sizeof (EFI_IPv4_ADDRESS)); + Dhcp4ModeData->LeaseTime = 0xffffffff; + } + + Dhcp4ModeData->ReplyPacket = DhcpSb->Selected; + + gBS->RestoreTPL (OldTpl); + return EFI_SUCCESS; +} + + +/** + Free the resource related to the configure parameters. + DHCP driver will make a copy of the user's configure + such as the time out value. + + @param Config The DHCP configure data + +**/ +VOID +DhcpCleanConfigure ( + IN OUT EFI_DHCP4_CONFIG_DATA *Config + ) +{ + UINT32 Index; + + if (Config->DiscoverTimeout != NULL) { + FreePool (Config->DiscoverTimeout); + } + + if (Config->RequestTimeout != NULL) { + FreePool (Config->RequestTimeout); + } + + if (Config->OptionList != NULL) { + for (Index = 0; Index < Config->OptionCount; Index++) { + if (Config->OptionList[Index] != NULL) { + FreePool (Config->OptionList[Index]); + } + } + + FreePool (Config->OptionList); + } + + ZeroMem (Config, sizeof (EFI_DHCP4_CONFIG_DATA)); +} + + +/** + Allocate memory for configure parameter such as timeout value for Dst, + then copy the configure parameter from Src to Dst. + + @param[out] Dst The destination DHCP configure data. + @param[in] Src The source DHCP configure data. + + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory. + @retval EFI_SUCCESS The configure is copied. + +**/ +EFI_STATUS +DhcpCopyConfigure ( + OUT EFI_DHCP4_CONFIG_DATA *Dst, + IN EFI_DHCP4_CONFIG_DATA *Src + ) +{ + EFI_DHCP4_PACKET_OPTION **DstOptions; + EFI_DHCP4_PACKET_OPTION **SrcOptions; + UINTN Len; + UINT32 Index; + + CopyMem (Dst, Src, sizeof (*Dst)); + Dst->DiscoverTimeout = NULL; + Dst->RequestTimeout = NULL; + Dst->OptionList = NULL; + + // + // Allocate a memory then copy DiscoverTimeout to it + // + if (Src->DiscoverTimeout != NULL) { + Len = Src->DiscoverTryCount * sizeof (UINT32); + Dst->DiscoverTimeout = AllocatePool (Len); + + if (Dst->DiscoverTimeout == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + for (Index = 0; Index < Src->DiscoverTryCount; Index++) { + Dst->DiscoverTimeout[Index] = MAX (Src->DiscoverTimeout[Index], 1); + } + } + + // + // Allocate a memory then copy RequestTimeout to it + // + if (Src->RequestTimeout != NULL) { + Len = Src->RequestTryCount * sizeof (UINT32); + Dst->RequestTimeout = AllocatePool (Len); + + if (Dst->RequestTimeout == NULL) { + goto ON_ERROR; + } + + for (Index = 0; Index < Src->RequestTryCount; Index++) { + Dst->RequestTimeout[Index] = MAX (Src->RequestTimeout[Index], 1); + } + } + + // + // Allocate an array of dhcp option point, then allocate memory + // for each option and copy the source option to it + // + if (Src->OptionList != NULL) { + Len = Src->OptionCount * sizeof (EFI_DHCP4_PACKET_OPTION *); + Dst->OptionList = AllocateZeroPool (Len); + + if (Dst->OptionList == NULL) { + goto ON_ERROR; + } + + DstOptions = Dst->OptionList; + SrcOptions = Src->OptionList; + + for (Index = 0; Index < Src->OptionCount; Index++) { + Len = sizeof (EFI_DHCP4_PACKET_OPTION) + MAX (SrcOptions[Index]->Length - 1, 0); + + DstOptions[Index] = AllocatePool (Len); + + if (DstOptions[Index] == NULL) { + goto ON_ERROR; + } + + CopyMem (DstOptions[Index], SrcOptions[Index], Len); + } + } + + return EFI_SUCCESS; + +ON_ERROR: + DhcpCleanConfigure (Dst); + return EFI_OUT_OF_RESOURCES; +} + + +/** + Give up the control of the DHCP service to let other child + resume. Don't change the service's DHCP state and the Client + address and option list configure as required by RFC2131. + + @param DhcpSb The DHCP service instance. + +**/ +VOID +DhcpYieldControl ( + IN DHCP_SERVICE *DhcpSb + ) +{ + EFI_DHCP4_CONFIG_DATA *Config; + + Config = &DhcpSb->ActiveConfig; + + DhcpSb->ServiceState = DHCP_UNCONFIGED; + DhcpSb->ActiveChild = NULL; + + if (Config->DiscoverTimeout != NULL) { + FreePool (Config->DiscoverTimeout); + + Config->DiscoverTryCount = 0; + Config->DiscoverTimeout = NULL; + } + + if (Config->RequestTimeout != NULL) { + FreePool (Config->RequestTimeout); + + Config->RequestTryCount = 0; + Config->RequestTimeout = NULL; + } + + Config->Dhcp4Callback = NULL; + Config->CallbackContext = NULL; +} + + +/** + Initializes, changes, or resets the operational settings for the EFI DHCPv4 Protocol driver. + + The Configure() function is used to initialize, change, or reset the operational + settings of the EFI DHCPv4 Protocol driver for the communication device on which + the EFI DHCPv4 Service Binding Protocol is installed. This function can be + successfully called only if both of the following are true: + * This instance of the EFI DHCPv4 Protocol driver is in the Dhcp4Stopped, Dhcp4Init, + Dhcp4InitReboot, or Dhcp4Bound states. + * No other EFI DHCPv4 Protocol driver instance that is controlled by this EFI + DHCPv4 Service Binding Protocol driver instance has configured this EFI DHCPv4 + Protocol driver. + When this driver is in the Dhcp4Stopped state, it can transfer into one of the + following two possible initial states: + * Dhcp4Init + * Dhcp4InitReboot + The driver can transfer into these states by calling Configure() with a non-NULL + Dhcp4CfgData. The driver will transfer into the appropriate state based on the + supplied client network address in the ClientAddress parameter and DHCP options + in the OptionList parameter as described in RFC 2131. + When Configure() is called successfully while Dhcp4CfgData is set to NULL, the + default configuring data will be reset in the EFI DHCPv4 Protocol driver and + the state of the EFI DHCPv4 Protocol driver will not be changed. If one instance + wants to make it possible for another instance to configure the EFI DHCPv4 Protocol + driver, it must call this function with Dhcp4CfgData set to NULL. + + @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. + @param[in] Dhcp4CfgData Pointer to the EFI_DHCP4_CONFIG_DATA. + + @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Init or + Dhcp4InitReboot state, if the original state of this driver + was Dhcp4Stopped and the value of Dhcp4CfgData was + not NULL. Otherwise, the state was left unchanged. + @retval EFI_ACCESS_DENIED This instance of the EFI DHCPv4 Protocol driver was not in the + Dhcp4Stopped, Dhcp4Init, Dhcp4InitReboot, or Dhcp4Bound state; + Or onother instance of this EFI DHCPv4 Protocol driver is already + in a valid configured state. + @retval EFI_INVALID_PARAMETER Some parameter is NULL. + @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. + +**/ +EFI_STATUS +EFIAPI +EfiDhcp4Configure ( + IN EFI_DHCP4_PROTOCOL *This, + IN EFI_DHCP4_CONFIG_DATA *Dhcp4CfgData OPTIONAL + ) +{ + EFI_DHCP4_CONFIG_DATA *Config; + DHCP_PROTOCOL *Instance; + DHCP_SERVICE *DhcpSb; + EFI_STATUS Status; + EFI_TPL OldTpl; + UINT32 Index; + IP4_ADDR Ip; + + // + // First validate the parameters + // + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + if (Dhcp4CfgData != NULL) { + if ((Dhcp4CfgData->DiscoverTryCount != 0) && (Dhcp4CfgData->DiscoverTimeout == NULL)) { + return EFI_INVALID_PARAMETER; + } + + if ((Dhcp4CfgData->RequestTryCount != 0) && (Dhcp4CfgData->RequestTimeout == NULL)) { + return EFI_INVALID_PARAMETER; + } + + if ((Dhcp4CfgData->OptionCount != 0) && (Dhcp4CfgData->OptionList == NULL)) { + return EFI_INVALID_PARAMETER; + } + + CopyMem (&Ip, &Dhcp4CfgData->ClientAddress, sizeof (IP4_ADDR)); + if (IP4_IS_LOCAL_BROADCAST(NTOHL (Ip))) { + return EFI_INVALID_PARAMETER; + } + } + + Instance = DHCP_INSTANCE_FROM_THIS (This); + + if (Instance->Signature != DHCP_PROTOCOL_SIGNATURE) { + return EFI_INVALID_PARAMETER; + } + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + DhcpSb = Instance->Service; + Config = &DhcpSb->ActiveConfig; + + Status = EFI_ACCESS_DENIED; + + if ((DhcpSb->DhcpState != Dhcp4Stopped) && + (DhcpSb->DhcpState != Dhcp4Init) && + (DhcpSb->DhcpState != Dhcp4InitReboot) && + (DhcpSb->DhcpState != Dhcp4Bound)) { + + goto ON_EXIT; + } + + if ((DhcpSb->ActiveChild != NULL) && (DhcpSb->ActiveChild != Instance)) { + goto ON_EXIT; + } + + if (Dhcp4CfgData != NULL) { + Status = EFI_OUT_OF_RESOURCES; + DhcpCleanConfigure (Config); + + if (EFI_ERROR (DhcpCopyConfigure (Config, Dhcp4CfgData))) { + goto ON_EXIT; + } + + DhcpSb->UserOptionLen = 0; + + for (Index = 0; Index < Dhcp4CfgData->OptionCount; Index++) { + DhcpSb->UserOptionLen += Dhcp4CfgData->OptionList[Index]->Length + 2; + } + + DhcpSb->ActiveChild = Instance; + + if (DhcpSb->DhcpState == Dhcp4Stopped) { + DhcpSb->ClientAddr = EFI_NTOHL (Dhcp4CfgData->ClientAddress); + + if (DhcpSb->ClientAddr != 0) { + DhcpSb->DhcpState = Dhcp4InitReboot; + } else { + DhcpSb->DhcpState = Dhcp4Init; + } + } + + DhcpSb->ServiceState = DHCP_CONFIGED; + Status = EFI_SUCCESS; + + } else if (DhcpSb->ActiveChild == Instance) { + Status = EFI_SUCCESS; + DhcpYieldControl (DhcpSb); + } + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + return Status; +} + + +/** + Starts the DHCP configuration process. + + The Start() function starts the DHCP configuration process. This function can + be called only when the EFI DHCPv4 Protocol driver is in the Dhcp4Init or + Dhcp4InitReboot state. + If the DHCP process completes successfully, the state of the EFI DHCPv4 Protocol + driver will be transferred through Dhcp4Selecting and Dhcp4Requesting to the + Dhcp4Bound state. The CompletionEvent will then be signaled if it is not NULL. + If the process aborts, either by the user or by some unexpected network error, + the state is restored to the Dhcp4Init state. The Start() function can be called + again to restart the process. + Refer to RFC 2131 for precise state transitions during this process. At the + time when each event occurs in this process, the callback function that was set + by EFI_DHCP4_PROTOCOL.Configure() will be called and the user can take this + opportunity to control the process. + + @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. + @param[in] CompletionEvent If not NULL, indicates the event that will be signaled when the + EFI DHCPv4 Protocol driver is transferred into the + Dhcp4Bound state or when the DHCP process is aborted. + EFI_DHCP4_PROTOCOL.GetModeData() can be called to + check the completion status. If NULL, + EFI_DHCP4_PROTOCOL.Start() will wait until the driver + is transferred into the Dhcp4Bound state or the process fails. + + @retval EFI_SUCCESS The DHCP configuration process has started, or it has completed + when CompletionEvent is NULL. + @retval EFI_NOT_STARTED The EFI DHCPv4 Protocol driver is in the Dhcp4Stopped + state. EFI_DHCP4_PROTOCOL. Configure() needs to be called. + @retval EFI_INVALID_PARAMETER This is NULL. + @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. + @retval EFI_TIMEOUT The DHCP configuration process failed because no response was + received from the server within the specified timeout value. + @retval EFI_ABORTED The user aborted the DHCP process. + @retval EFI_ALREADY_STARTED Some other EFI DHCPv4 Protocol instance already started the + DHCP process. + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. + @retval EFI_NO_MEDIA There was a media error. + +**/ +EFI_STATUS +EFIAPI +EfiDhcp4Start ( + IN EFI_DHCP4_PROTOCOL *This, + IN EFI_EVENT CompletionEvent OPTIONAL + ) +{ + DHCP_PROTOCOL *Instance; + DHCP_SERVICE *DhcpSb; + EFI_STATUS Status; + EFI_TPL OldTpl; + EFI_STATUS MediaStatus; + + // + // First validate the parameters + // + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + Instance = DHCP_INSTANCE_FROM_THIS (This); + + if (Instance->Signature != DHCP_PROTOCOL_SIGNATURE) { + return EFI_INVALID_PARAMETER; + } + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + DhcpSb = Instance->Service; + + if (DhcpSb->DhcpState == Dhcp4Stopped) { + Status = EFI_NOT_STARTED; + goto ON_ERROR; + } + + if ((DhcpSb->DhcpState != Dhcp4Init) && (DhcpSb->DhcpState != Dhcp4InitReboot)) { + Status = EFI_ALREADY_STARTED; + goto ON_ERROR; + } + + // + // Check Media Satus. + // + MediaStatus = EFI_SUCCESS; + NetLibDetectMediaWaitTimeout (DhcpSb->Controller, DHCP_CHECK_MEDIA_WAITING_TIME, &MediaStatus); + if (MediaStatus != EFI_SUCCESS) { + Status = EFI_NO_MEDIA; + goto ON_ERROR; + } + + DhcpSb->IoStatus = EFI_ALREADY_STARTED; + + if (EFI_ERROR (Status = DhcpInitRequest (DhcpSb))) { + goto ON_ERROR; + } + + + Instance->CompletionEvent = CompletionEvent; + + // + // Restore the TPL now, don't call poll function at TPL_CALLBACK. + // + gBS->RestoreTPL (OldTpl); + + if (CompletionEvent == NULL) { + while (DhcpSb->IoStatus == EFI_ALREADY_STARTED) { + DhcpSb->UdpIo->Protocol.Udp4->Poll (DhcpSb->UdpIo->Protocol.Udp4); + } + + return DhcpSb->IoStatus; + } + + return EFI_SUCCESS; + +ON_ERROR: + gBS->RestoreTPL (OldTpl); + return Status; +} + + +/** + Extends the lease time by sending a request packet. + + The RenewRebind() function is used to manually extend the lease time when the + EFI DHCPv4 Protocol driver is in the Dhcp4Bound state and the lease time has + not expired yet. This function will send a request packet to the previously + found server (or to any server when RebindRequest is TRUE) and transfer the + state into the Dhcp4Renewing state (or Dhcp4Rebinding when RebindingRequest is + TRUE). When a response is received, the state is returned to Dhcp4Bound. + If no response is received before the try count is exceeded (the RequestTryCount + field that is specified in EFI_DHCP4_CONFIG_DATA) but before the lease time that + was issued by the previous server expires, the driver will return to the Dhcp4Bound + state and the previous configuration is restored. The outgoing and incoming packets + can be captured by the EFI_DHCP4_CALLBACK function. + + @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. + @param[in] RebindRequest If TRUE, this function broadcasts the request packets and enters + the Dhcp4Rebinding state. Otherwise, it sends a unicast + request packet and enters the Dhcp4Renewing state. + @param[in] CompletionEvent If not NULL, this event is signaled when the renew/rebind phase + completes or some error occurs. + EFI_DHCP4_PROTOCOL.GetModeData() can be called to + check the completion status. If NULL, + EFI_DHCP4_PROTOCOL.RenewRebind() will busy-wait + until the DHCP process finishes. + + @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the + Dhcp4Renewing state or is back to the Dhcp4Bound state. + @retval EFI_NOT_STARTED The EFI DHCPv4 Protocol driver is in the Dhcp4Stopped + state. EFI_DHCP4_PROTOCOL.Configure() needs to + be called. + @retval EFI_INVALID_PARAMETER This is NULL. + @retval EFI_TIMEOUT There was no response from the server when the try count was + exceeded. + @retval EFI_ACCESS_DENIED The driver is not in the Dhcp4Bound state. + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. + +**/ +EFI_STATUS +EFIAPI +EfiDhcp4RenewRebind ( + IN EFI_DHCP4_PROTOCOL *This, + IN BOOLEAN RebindRequest, + IN EFI_EVENT CompletionEvent OPTIONAL + ) +{ + DHCP_PROTOCOL *Instance; + DHCP_SERVICE *DhcpSb; + EFI_STATUS Status; + EFI_TPL OldTpl; + + // + // First validate the parameters + // + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + Instance = DHCP_INSTANCE_FROM_THIS (This); + + if (Instance->Signature != DHCP_PROTOCOL_SIGNATURE) { + return EFI_INVALID_PARAMETER; + } + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + DhcpSb = Instance->Service; + + if (DhcpSb->DhcpState == Dhcp4Stopped) { + Status = EFI_NOT_STARTED; + goto ON_EXIT; + } + + if (DhcpSb->DhcpState != Dhcp4Bound) { + Status = EFI_ACCESS_DENIED; + goto ON_EXIT; + } + + if (DHCP_IS_BOOTP (DhcpSb->Para)) { + Status = EFI_SUCCESS; + goto ON_EXIT; + } + + // + // Transit the states then send a extra DHCP request + // + if (!RebindRequest) { + DhcpSetState (DhcpSb, Dhcp4Renewing, FALSE); + } else { + DhcpSetState (DhcpSb, Dhcp4Rebinding, FALSE); + } + + // + // Clear initial time to make sure that elapsed-time + // is set to 0 for first REQUEST in renewal process. + // + Instance->ElaspedTime = 0; + + Status = DhcpSendMessage ( + DhcpSb, + DhcpSb->Selected, + DhcpSb->Para, + DHCP_MSG_REQUEST, + (UINT8 *) "Extra renew/rebind by the application" + ); + + if (EFI_ERROR (Status)) { + DhcpSetState (DhcpSb, Dhcp4Bound, FALSE); + goto ON_EXIT; + } + + DhcpSb->ExtraRefresh = TRUE; + DhcpSb->IoStatus = EFI_ALREADY_STARTED; + Instance->RenewRebindEvent = CompletionEvent; + + gBS->RestoreTPL (OldTpl); + + if (CompletionEvent == NULL) { + while (DhcpSb->IoStatus == EFI_ALREADY_STARTED) { + DhcpSb->UdpIo->Protocol.Udp4->Poll (DhcpSb->UdpIo->Protocol.Udp4); + + } + + return DhcpSb->IoStatus; + } + + return EFI_SUCCESS; + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + return Status; +} + + +/** + Releases the current address configuration. + + The Release() function releases the current configured IP address by doing either + of the following: + * Sending a DHCPRELEASE packet when the EFI DHCPv4 Protocol driver is in the + Dhcp4Bound state + * Setting the previously assigned IP address that was provided with the + EFI_DHCP4_PROTOCOL.Configure() function to 0.0.0.0 when the driver is in + Dhcp4InitReboot state + After a successful call to this function, the EFI DHCPv4 Protocol driver returns + to the Dhcp4Init state and any subsequent incoming packets will be discarded silently. + + @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. + + @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Init phase. + @retval EFI_INVALID_PARAMETER This is NULL. + @retval EFI_ACCESS_DENIED The EFI DHCPv4 Protocol driver is not Dhcp4InitReboot state. + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. + +**/ +EFI_STATUS +EFIAPI +EfiDhcp4Release ( + IN EFI_DHCP4_PROTOCOL *This + ) +{ + DHCP_PROTOCOL *Instance; + DHCP_SERVICE *DhcpSb; + EFI_STATUS Status; + EFI_TPL OldTpl; + + // + // First validate the parameters + // + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + Instance = DHCP_INSTANCE_FROM_THIS (This); + + if (Instance->Signature != DHCP_PROTOCOL_SIGNATURE) { + return EFI_INVALID_PARAMETER; + } + + Status = EFI_SUCCESS; + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + DhcpSb = Instance->Service; + + if ((DhcpSb->DhcpState != Dhcp4InitReboot) && (DhcpSb->DhcpState != Dhcp4Bound)) { + Status = EFI_ACCESS_DENIED; + goto ON_EXIT; + } + + if (!DHCP_IS_BOOTP (DhcpSb->Para) && (DhcpSb->DhcpState == Dhcp4Bound)) { + Status = DhcpSendMessage ( + DhcpSb, + DhcpSb->Selected, + DhcpSb->Para, + DHCP_MSG_RELEASE, + NULL + ); + + if (EFI_ERROR (Status)) { + Status = EFI_DEVICE_ERROR; + goto ON_EXIT; + } + } + + DhcpCleanLease (DhcpSb); + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + return Status; +} + + +/** + Stops the current address configuration. + + The Stop() function is used to stop the DHCP configuration process. After this + function is called successfully, the EFI DHCPv4 Protocol driver is transferred + into the Dhcp4Stopped state. EFI_DHCP4_PROTOCOL.Configure() needs to be called + before DHCP configuration process can be started again. This function can be + called when the EFI DHCPv4 Protocol driver is in any state. + + @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. + + @retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Stopped phase. + @retval EFI_INVALID_PARAMETER This is NULL. + +**/ +EFI_STATUS +EFIAPI +EfiDhcp4Stop ( + IN EFI_DHCP4_PROTOCOL *This + ) +{ + DHCP_PROTOCOL *Instance; + DHCP_SERVICE *DhcpSb; + EFI_TPL OldTpl; + + // + // First validate the parameters + // + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + Instance = DHCP_INSTANCE_FROM_THIS (This); + + if (Instance->Signature != DHCP_PROTOCOL_SIGNATURE) { + return EFI_INVALID_PARAMETER; + } + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + DhcpSb = Instance->Service; + + DhcpCleanLease (DhcpSb); + + DhcpSb->DhcpState = Dhcp4Stopped; + DhcpSb->ServiceState = DHCP_UNCONFIGED; + + gBS->RestoreTPL (OldTpl); + return EFI_SUCCESS; +} + + +/** + Builds a DHCP packet, given the options to be appended or deleted or replaced. + + The Build() function is used to assemble a new packet from the original packet + by replacing or deleting existing options or appending new options. This function + does not change any state of the EFI DHCPv4 Protocol driver and can be used at + any time. + + @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. + @param[in] SeedPacket Initial packet to be used as a base for building new packet. + @param[in] DeleteCount Number of opcodes in the DeleteList. + @param[in] DeleteList List of opcodes to be deleted from the seed packet. + Ignored if DeleteCount is zero. + @param[in] AppendCount Number of entries in the OptionList. + @param[in] AppendList Pointer to a DHCP option list to be appended to SeedPacket. + If SeedPacket also contains options in this list, they are + replaced by new options (except pad option). Ignored if + AppendCount is zero. Type EFI_DHCP4_PACKET_OPTION + @param[out] NewPacket Pointer to storage for the pointer to the new allocated packet. + Use the EFI Boot Service FreePool() on the resulting pointer + when done with the packet. + + @retval EFI_SUCCESS The new packet was built. + @retval EFI_OUT_OF_RESOURCES Storage for the new packet could not be allocated. + @retval EFI_INVALID_PARAMETER Some parameter is NULL. + +**/ +EFI_STATUS +EFIAPI +EfiDhcp4Build ( + IN EFI_DHCP4_PROTOCOL *This, + IN EFI_DHCP4_PACKET *SeedPacket, + IN UINT32 DeleteCount, + IN UINT8 *DeleteList OPTIONAL, + IN UINT32 AppendCount, + IN EFI_DHCP4_PACKET_OPTION *AppendList[] OPTIONAL, + OUT EFI_DHCP4_PACKET **NewPacket + ) +{ + // + // First validate the parameters + // + if ((This == NULL) || (NewPacket == NULL)) { + return EFI_INVALID_PARAMETER; + } + + if ((SeedPacket == NULL) || (SeedPacket->Dhcp4.Magik != DHCP_OPTION_MAGIC) || + EFI_ERROR (DhcpValidateOptions (SeedPacket, NULL))) { + + return EFI_INVALID_PARAMETER; + } + + if (((DeleteCount == 0) && (AppendCount == 0)) || + ((DeleteCount != 0) && (DeleteList == NULL)) || + ((AppendCount != 0) && (AppendList == NULL))) { + + return EFI_INVALID_PARAMETER; + } + + return DhcpBuild ( + SeedPacket, + DeleteCount, + DeleteList, + AppendCount, + AppendList, + NewPacket + ); +} + +/** + Callback by UdpIoCreatePort() when creating UdpIo for this Dhcp4 instance. + + @param[in] UdpIo The UdpIo being created. + @param[in] Context Dhcp4 instance. + + @retval EFI_SUCCESS UdpIo is configured successfully. + @retval EFI_INVALID_PARAMETER Class E IP address is not supported or other parameters + are not valid. + @retval other Other error occurs. +**/ +EFI_STATUS +EFIAPI +Dhcp4InstanceConfigUdpIo ( + IN UDP_IO *UdpIo, + IN VOID *Context + ) +{ + DHCP_PROTOCOL *Instance; + DHCP_SERVICE *DhcpSb; + EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN *Token; + EFI_UDP4_CONFIG_DATA UdpConfigData; + IP4_ADDR ClientAddr; + IP4_ADDR Ip; + INTN Class; + IP4_ADDR SubnetMask; + + Instance = (DHCP_PROTOCOL *) Context; + DhcpSb = Instance->Service; + Token = Instance->Token; + + ZeroMem (&UdpConfigData, sizeof (EFI_UDP4_CONFIG_DATA)); + + UdpConfigData.AcceptBroadcast = TRUE; + UdpConfigData.AllowDuplicatePort = TRUE; + UdpConfigData.TimeToLive = 64; + UdpConfigData.DoNotFragment = TRUE; + + ClientAddr = EFI_NTOHL (Token->Packet->Dhcp4.Header.ClientAddr); + Ip = HTONL (ClientAddr); + CopyMem (&UdpConfigData.StationAddress, &Ip, sizeof (EFI_IPv4_ADDRESS)); + + if (DhcpSb->Netmask == 0) { + // + // The Dhcp4.TransmitReceive() API should be able to used at any time according to + // UEFI spec, while in classless addressing network, the netmask must be explicitly + // provided together with the station address. + // If the DHCP instance haven't be configured with a valid netmask, we could only + // compute it according to the classful addressing rule. + // + Class = NetGetIpClass (ClientAddr); + // + // Class E IP address is not supported here! + // + ASSERT (Class < IP4_ADDR_CLASSE); + if (Class >= IP4_ADDR_CLASSE) { + return EFI_INVALID_PARAMETER; + } + + SubnetMask = gIp4AllMasks[Class << 3]; + } else { + SubnetMask = DhcpSb->Netmask; + } + + Ip = HTONL (SubnetMask); + CopyMem (&UdpConfigData.SubnetMask, &Ip, sizeof (EFI_IPv4_ADDRESS)); + + if ((Token->ListenPointCount == 0) || (Token->ListenPoints[0].ListenPort == 0)) { + UdpConfigData.StationPort = DHCP_CLIENT_PORT; + } else { + UdpConfigData.StationPort = Token->ListenPoints[0].ListenPort; + } + + return UdpIo->Protocol.Udp4->Configure (UdpIo->Protocol.Udp4, &UdpConfigData); +} + +/** + Create UdpIo for this Dhcp4 instance. + + @param Instance The Dhcp4 instance. + + @retval EFI_SUCCESS UdpIo is created successfully. + @retval EFI_OUT_OF_RESOURCES Fails to create UdpIo because of limited + resources or configuration failure. +**/ +EFI_STATUS +Dhcp4InstanceCreateUdpIo ( + IN OUT DHCP_PROTOCOL *Instance + ) +{ + DHCP_SERVICE *DhcpSb; + EFI_STATUS Status; + VOID *Udp4; + + ASSERT (Instance->Token != NULL); + + DhcpSb = Instance->Service; + Instance->UdpIo = UdpIoCreateIo ( + DhcpSb->Controller, + DhcpSb->Image, + Dhcp4InstanceConfigUdpIo, + UDP_IO_UDP4_VERSION, + Instance + ); + if (Instance->UdpIo == NULL) { + return EFI_OUT_OF_RESOURCES; + } else { + Status = gBS->OpenProtocol ( + Instance->UdpIo->UdpHandle, + &gEfiUdp4ProtocolGuid, + (VOID **) &Udp4, + Instance->Service->Image, + Instance->Handle, + EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER + ); + if (EFI_ERROR (Status)) { + UdpIoFreeIo (Instance->UdpIo); + Instance->UdpIo = NULL; + } + return Status; + } +} + +/** + Callback of Dhcp packet. Does nothing. + + @param Arg The context. + +**/ +VOID +EFIAPI +DhcpDummyExtFree ( + IN VOID *Arg + ) +{ +} + +/** + Callback of UdpIoRecvDatagram() that handles a Dhcp4 packet. + + Only BOOTP responses will be handled that correspond to the Xid of the request + sent out. The packet will be queued to the response queue. + + @param UdpPacket The Dhcp4 packet. + @param EndPoint Udp4 address pair. + @param IoStatus Status of the input. + @param Context Extra info for the input. + +**/ +VOID +EFIAPI +PxeDhcpInput ( + NET_BUF *UdpPacket, + UDP_END_POINT *EndPoint, + EFI_STATUS IoStatus, + VOID *Context + ) +{ + DHCP_PROTOCOL *Instance; + EFI_DHCP4_HEADER *Head; + NET_BUF *Wrap; + EFI_DHCP4_PACKET *Packet; + EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN *Token; + UINT32 Len; + EFI_STATUS Status; + + Wrap = NULL; + Instance = (DHCP_PROTOCOL *) Context; + Token = Instance->Token; + + // + // Don't restart receive if error occurs or DHCP is destroyed. + // + if (EFI_ERROR (IoStatus)) { + return ; + } + + ASSERT (UdpPacket != NULL); + + // + // Validate the packet received + // + if (UdpPacket->TotalSize < sizeof (EFI_DHCP4_HEADER)) { + goto RESTART; + } + + // + // Copy the DHCP message to a continuous memory block, make the buffer size + // of the EFI_DHCP4_PACKET a multiple of 4-byte. + // + Len = NET_ROUNDUP (sizeof (EFI_DHCP4_PACKET) + UdpPacket->TotalSize - sizeof (EFI_DHCP4_HEADER), 4); + Wrap = NetbufAlloc (Len); + if (Wrap == NULL) { + goto RESTART; + } + + Packet = (EFI_DHCP4_PACKET *) NetbufAllocSpace (Wrap, Len, NET_BUF_TAIL); + ASSERT (Packet != NULL); + + Packet->Size = Len; + Head = &Packet->Dhcp4.Header; + Packet->Length = NetbufCopy (UdpPacket, 0, UdpPacket->TotalSize, (UINT8 *) Head); + + if (Packet->Length != UdpPacket->TotalSize) { + goto RESTART; + } + + // + // Is this packet the answer to our packet? + // + if ((Head->OpCode != BOOTP_REPLY) || + (Head->Xid != Token->Packet->Dhcp4.Header.Xid) || + (CompareMem (&Token->Packet->Dhcp4.Header.ClientHwAddr[0], Head->ClientHwAddr, Head->HwAddrLen) != 0)) { + goto RESTART; + } + + // + // Validate the options and retrieve the interested options + // + if ((Packet->Length > sizeof (EFI_DHCP4_HEADER) + sizeof (UINT32)) && + (Packet->Dhcp4.Magik == DHCP_OPTION_MAGIC) && + EFI_ERROR (DhcpValidateOptions (Packet, NULL))) { + + goto RESTART; + } + + // + // Keep this packet in the ResponseQueue. + // + NET_GET_REF (Wrap); + NetbufQueAppend (&Instance->ResponseQueue, Wrap); + +RESTART: + + NetbufFree (UdpPacket); + + if (Wrap != NULL) { + NetbufFree (Wrap); + } + + Status = UdpIoRecvDatagram (Instance->UdpIo, PxeDhcpInput, Instance, 0); + if (EFI_ERROR (Status)) { + PxeDhcpDone (Instance); + } +} + +/** + Complete a Dhcp4 transaction and signal the upper layer. + + @param Instance Dhcp4 instance. + +**/ +VOID +PxeDhcpDone ( + IN DHCP_PROTOCOL *Instance + ) +{ + EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN *Token; + + Token = Instance->Token; + + Token->ResponseCount = Instance->ResponseQueue.BufNum; + if (Token->ResponseCount != 0) { + Token->ResponseList = (EFI_DHCP4_PACKET *) AllocatePool (Instance->ResponseQueue.BufSize); + if (Token->ResponseList == NULL) { + Token->Status = EFI_OUT_OF_RESOURCES; + goto SIGNAL_USER; + } + + // + // Copy the received DHCP responses. + // + NetbufQueCopy (&Instance->ResponseQueue, 0, Instance->ResponseQueue.BufSize, (UINT8 *) Token->ResponseList); + Token->Status = EFI_SUCCESS; + } else { + Token->ResponseList = NULL; + Token->Status = EFI_TIMEOUT; + } + +SIGNAL_USER: + // + // Clean up the resources dedicated for this transmit receive transaction. + // + NetbufQueFlush (&Instance->ResponseQueue); + UdpIoCleanIo (Instance->UdpIo); + gBS->CloseProtocol ( + Instance->UdpIo->UdpHandle, + &gEfiUdp4ProtocolGuid, + Instance->Service->Image, + Instance->Handle + ); + UdpIoFreeIo (Instance->UdpIo); + Instance->UdpIo = NULL; + Instance->Token = NULL; + + if (Token->CompletionEvent != NULL) { + gBS->SignalEvent (Token->CompletionEvent); + } +} + + +/** + Transmits a DHCP formatted packet and optionally waits for responses. + + The TransmitReceive() function is used to transmit a DHCP packet and optionally + wait for the response from servers. This function does not change the state of + the EFI DHCPv4 Protocol driver and thus can be used at any time. + + @param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance. + @param[in] Token Pointer to the EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN structure. + + @retval EFI_SUCCESS The packet was successfully queued for transmission. + @retval EFI_INVALID_PARAMETER Some parameter is NULL. + @retval EFI_NOT_READY The previous call to this function has not finished yet. Try to call + this function after collection process completes. + @retval EFI_NO_MAPPING The default station address is not available yet. + @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. + @retval Others Some other unexpected error occurred. + +**/ +EFI_STATUS +EFIAPI +EfiDhcp4TransmitReceive ( + IN EFI_DHCP4_PROTOCOL *This, + IN EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN *Token + ) +{ + DHCP_PROTOCOL *Instance; + EFI_TPL OldTpl; + EFI_STATUS Status; + NET_FRAGMENT Frag; + NET_BUF *Wrap; + UDP_END_POINT EndPoint; + IP4_ADDR Ip; + DHCP_SERVICE *DhcpSb; + EFI_IP_ADDRESS Gateway; + IP4_ADDR ClientAddr; + + if ((This == NULL) || (Token == NULL) || (Token->Packet == NULL)) { + return EFI_INVALID_PARAMETER; + } + + Instance = DHCP_INSTANCE_FROM_THIS (This); + DhcpSb = Instance->Service; + + if (Instance->Token != NULL) { + // + // The previous call to TransmitReceive is not finished. + // + return EFI_NOT_READY; + } + + if ((Token->Packet->Dhcp4.Magik != DHCP_OPTION_MAGIC) || + (NTOHL (Token->Packet->Dhcp4.Header.Xid) == Instance->Service->Xid) || + (Token->TimeoutValue == 0) || + ((Token->ListenPointCount != 0) && (Token->ListenPoints == NULL)) || + EFI_ERROR (DhcpValidateOptions (Token->Packet, NULL)) || + EFI_IP4_EQUAL (&Token->RemoteAddress, &mZeroIp4Addr) + ) { + // + // The DHCP packet isn't well-formed, the Transaction ID is already used, + // the timeout value is zero, the ListenPoint is invalid, or the + // RemoteAddress is zero. + // + return EFI_INVALID_PARAMETER; + } + + ClientAddr = EFI_NTOHL (Token->Packet->Dhcp4.Header.ClientAddr); + + if (ClientAddr == 0) { + return EFI_NO_MAPPING; + } + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + // + // Save the token and the timeout value. + // + Instance->Token = Token; + Instance->Timeout = Token->TimeoutValue; + + // + // Create a UDP IO for this transmit receive transaction. + // + Status = Dhcp4InstanceCreateUdpIo (Instance); + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + // + // Save the Client Address is sent out + // + CopyMem ( + &DhcpSb->ClientAddressSendOut[0], + &Token->Packet->Dhcp4.Header.ClientHwAddr[0], + Token->Packet->Dhcp4.Header.HwAddrLen + ); + + // + // Wrap the DHCP packet into a net buffer. + // + Frag.Bulk = (UINT8 *) &Token->Packet->Dhcp4; + Frag.Len = Token->Packet->Length; + Wrap = NetbufFromExt (&Frag, 1, 0, 0, DhcpDummyExtFree, NULL); + if (Wrap == NULL) { + Status = EFI_OUT_OF_RESOURCES; + goto ON_ERROR; + } + + // + // Set the local address and local port to ZERO. + // + ZeroMem (&EndPoint, sizeof (UDP_END_POINT)); + + // + // Set the destination address and destination port. + // + CopyMem (&Ip, &Token->RemoteAddress, sizeof (EFI_IPv4_ADDRESS)); + EndPoint.RemoteAddr.Addr[0] = NTOHL (Ip); + + if (Token->RemotePort == 0) { + EndPoint.RemotePort = DHCP_SERVER_PORT; + } else { + EndPoint.RemotePort = Token->RemotePort; + } + + // + // Get the gateway. + // + ZeroMem (&Gateway, sizeof (Gateway)); + if (!IP4_NET_EQUAL (ClientAddr, EndPoint.RemoteAddr.Addr[0], DhcpSb->Netmask)) { + CopyMem (&Gateway.v4, &Token->GatewayAddress, sizeof (EFI_IPv4_ADDRESS)); + Gateway.Addr[0] = NTOHL (Gateway.Addr[0]); + } + + // + // Transmit the DHCP packet. + // + Status = UdpIoSendDatagram (Instance->UdpIo, Wrap, &EndPoint, &Gateway, DhcpOnPacketSent, NULL); + if (EFI_ERROR (Status)) { + NetbufFree (Wrap); + goto ON_ERROR; + } + + // + // Start to receive the DHCP response. + // + Status = UdpIoRecvDatagram (Instance->UdpIo, PxeDhcpInput, Instance, 0); + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + +ON_ERROR: + + if (EFI_ERROR (Status) && (Instance->UdpIo != NULL)) { + UdpIoCleanIo (Instance->UdpIo); + gBS->CloseProtocol ( + Instance->UdpIo->UdpHandle, + &gEfiUdp4ProtocolGuid, + Instance->Service->Image, + Instance->Handle + ); + UdpIoFreeIo (Instance->UdpIo); + Instance->UdpIo = NULL; + Instance->Token = NULL; + } + + gBS->RestoreTPL (OldTpl); + + if (!EFI_ERROR (Status) && (Token->CompletionEvent == NULL)) { + // + // Keep polling until timeout if no error happens and the CompletionEvent + // is NULL. + // + while (TRUE) { + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + // + // Raise TPL to protect the UDPIO in instance, in case that DhcpOnTimerTick + // free it when timeout. + // + if (Instance->Timeout > 0) { + Instance->UdpIo->Protocol.Udp4->Poll (Instance->UdpIo->Protocol.Udp4); + gBS->RestoreTPL (OldTpl); + } else { + gBS->RestoreTPL (OldTpl); + break; + } + } + } + + return Status; +} + + +/** + Callback function for DhcpIterateOptions. This callback sets the + EFI_DHCP4_PACKET_OPTION array in the DHCP_PARSE_CONTEXT to point + the individual DHCP option in the packet. + + @param[in] Tag The DHCP option type + @param[in] Len Length of the DHCP option data + @param[in] Data The DHCP option data + @param[in] Context The context, to pass several parameters in. + + @retval EFI_SUCCESS It always returns EFI_SUCCESS + +**/ +EFI_STATUS +Dhcp4ParseCheckOption ( + IN UINT8 Tag, + IN UINT8 Len, + IN UINT8 *Data, + IN VOID *Context + ) +{ + DHCP_PARSE_CONTEXT *Parse; + + Parse = (DHCP_PARSE_CONTEXT *) Context; + Parse->Index++; + + if (Parse->Index <= Parse->OptionCount) { + // + // Use BASE_CR to get the memory position of EFI_DHCP4_PACKET_OPTION for + // the EFI_DHCP4_PACKET_OPTION->Data because DhcpIterateOptions only + // pass in the point to option data. + // + Parse->Option[Parse->Index - 1] = BASE_CR (Data, EFI_DHCP4_PACKET_OPTION, Data); + } + + return EFI_SUCCESS; +} + + +/** + Parses the packed DHCP option data. + + The Parse() function is used to retrieve the option list from a DHCP packet. + If *OptionCount isn't zero, and there is enough space for all the DHCP options + in the Packet, each element of PacketOptionList is set to point to somewhere in + the Packet->Dhcp4.Option where a new DHCP option begins. If RFC3396 is supported, + the caller should reassemble the parsed DHCP options to get the finial result. + If *OptionCount is zero or there isn't enough space for all of them, the number + of DHCP options in the Packet is returned in OptionCount. + + @param This Pointer to the EFI_DHCP4_PROTOCOL instance. + @param Packet Pointer to packet to be parsed. + @param OptionCount On input, the number of entries in the PacketOptionList. + On output, the number of entries that were written into the + PacketOptionList. + @param PacketOptionList List of packet option entries to be filled in. End option or pad + options are not included. + + @retval EFI_SUCCESS The packet was successfully parsed. + @retval EFI_INVALID_PARAMETER Some parameter is NULL. + @retval EFI_BUFFER_TOO_SMALL One or more of the following conditions is TRUE: + 1) *OptionCount is smaller than the number of options that + were found in the Packet. + 2) PacketOptionList is NULL. + +**/ +EFI_STATUS +EFIAPI +EfiDhcp4Parse ( + IN EFI_DHCP4_PROTOCOL *This, + IN EFI_DHCP4_PACKET *Packet, + IN OUT UINT32 *OptionCount, + OUT EFI_DHCP4_PACKET_OPTION *PacketOptionList[] OPTIONAL + ) +{ + DHCP_PARSE_CONTEXT Context; + EFI_STATUS Status; + + // + // First validate the parameters + // + if ((This == NULL) || (Packet == NULL) || (OptionCount == NULL)) { + return EFI_INVALID_PARAMETER; + } + + if ((Packet->Size < Packet->Length + 2 * sizeof (UINT32)) || + (Packet->Dhcp4.Magik != DHCP_OPTION_MAGIC) || + EFI_ERROR (DhcpValidateOptions (Packet, NULL))) { + + return EFI_INVALID_PARAMETER; + } + + if ((*OptionCount != 0) && (PacketOptionList == NULL)) { + return EFI_BUFFER_TOO_SMALL; + } + + ZeroMem (PacketOptionList, *OptionCount * sizeof (EFI_DHCP4_PACKET_OPTION *)); + + Context.Option = PacketOptionList; + Context.OptionCount = *OptionCount; + Context.Index = 0; + + Status = DhcpIterateOptions (Packet, Dhcp4ParseCheckOption, &Context); + + if (EFI_ERROR (Status)) { + return Status; + } + + *OptionCount = Context.Index; + + if (Context.Index > Context.OptionCount) { + return EFI_BUFFER_TOO_SMALL; + } + + return EFI_SUCCESS; +} + +/** + Set the elapsed time based on the given instance and the pointer to the + elapsed time option. + + @param[in] Elapsed The pointer to the position to append. + @param[in] Instance The pointer to the Dhcp4 instance. +**/ +VOID +SetElapsedTime ( + IN UINT16 *Elapsed, + IN DHCP_PROTOCOL *Instance + ) +{ + WriteUnaligned16 (Elapsed, HTONS(Instance->ElaspedTime)); +} diff --git a/NetworkPkg/Dhcp4Dxe/Dhcp4Impl.h b/NetworkPkg/Dhcp4Dxe/Dhcp4Impl.h new file mode 100644 index 0000000000..8c2cd3dae1 --- /dev/null +++ b/NetworkPkg/Dhcp4Dxe/Dhcp4Impl.h @@ -0,0 +1,206 @@ +/** @file + EFI DHCP protocol implementation. + RFCs supported are: + RFC 2131: Dynamic Host Configuration Protocol + RFC 2132: DHCP Options and BOOTP Vendor Extensions + RFC 1534: Interoperation Between DHCP and BOOTP + RFC 3396: Encoding Long Options in DHCP. + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef __EFI_DHCP4_IMPL_H__ +#define __EFI_DHCP4_IMPL_H__ + + + +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +typedef struct _DHCP_SERVICE DHCP_SERVICE; +typedef struct _DHCP_PROTOCOL DHCP_PROTOCOL; + +#include "Dhcp4Option.h" +#include "Dhcp4Io.h" + +#define DHCP_SERVICE_SIGNATURE SIGNATURE_32 ('D', 'H', 'C', 'P') +#define DHCP_PROTOCOL_SIGNATURE SIGNATURE_32 ('d', 'h', 'c', 'p') + +#define DHCP_CHECK_MEDIA_WAITING_TIME EFI_TIMER_PERIOD_SECONDS(20) + +// +// The state of the DHCP service. It starts as UNCONFIGED. If +// and active child configures the service successfully, it +// goes to CONFIGED. If the active child configures NULL, it +// goes back to UNCONFIGED. It becomes DESTROY if it is (partly) +// destroyed. +// +#define DHCP_UNCONFIGED 0 +#define DHCP_CONFIGED 1 +#define DHCP_DESTROY 2 + + +struct _DHCP_PROTOCOL { + UINT32 Signature; + EFI_DHCP4_PROTOCOL Dhcp4Protocol; + LIST_ENTRY Link; + EFI_HANDLE Handle; + DHCP_SERVICE *Service; + + BOOLEAN InDestroy; + + EFI_EVENT CompletionEvent; + EFI_EVENT RenewRebindEvent; + + EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN *Token; + UDP_IO *UdpIo; // The UDP IO used for TransmitReceive. + UINT32 Timeout; + UINT16 ElaspedTime; + NET_BUF_QUEUE ResponseQueue; +}; + +// +// DHCP driver is specical in that it is a singleton. Although it +// has a service binding, there can be only one active child. +// +struct _DHCP_SERVICE { + UINT32 Signature; + EFI_SERVICE_BINDING_PROTOCOL ServiceBinding; + + INTN ServiceState; // CONFIGED, UNCONFIGED, and DESTROY + + EFI_HANDLE Controller; + EFI_HANDLE Image; + + LIST_ENTRY Children; + UINTN NumChildren; + + INTN DhcpState; + EFI_STATUS IoStatus; // the result of last user operation + UINT32 Xid; + + IP4_ADDR ClientAddr; // lease IP or configured client address + IP4_ADDR Netmask; + IP4_ADDR ServerAddr; + + EFI_DHCP4_PACKET *LastOffer; // The last received offer + EFI_DHCP4_PACKET *Selected; + DHCP_PARAMETER *Para; + + UINT32 Lease; + UINT32 T1; + UINT32 T2; + INTN ExtraRefresh; // This refresh is reqested by user + + UDP_IO *UdpIo; // Udp child receiving all DHCP message + UDP_IO *LeaseIoPort; // Udp child with lease IP + EFI_DHCP4_PACKET *LastPacket; // The last sent packet for retransmission + EFI_MAC_ADDRESS Mac; + UINT8 HwType; + UINT8 HwLen; + UINT8 ClientAddressSendOut[16]; + + DHCP_PROTOCOL *ActiveChild; + EFI_DHCP4_CONFIG_DATA ActiveConfig; + UINT32 UserOptionLen; + + // + // Timer event and various timer + // + EFI_EVENT Timer; + + UINT32 PacketToLive; // Retransmission timer for our packets + UINT32 LastTimeout; // Record the init value of PacketToLive every time + INTN CurRetry; + INTN MaxRetries; + UINT32 LeaseLife; +}; + +typedef struct { + EFI_DHCP4_PACKET_OPTION **Option; + UINT32 OptionCount; + UINT32 Index; +} DHCP_PARSE_CONTEXT; + +#define DHCP_INSTANCE_FROM_THIS(Proto) \ + CR ((Proto), DHCP_PROTOCOL, Dhcp4Protocol, DHCP_PROTOCOL_SIGNATURE) + +#define DHCP_SERVICE_FROM_THIS(Sb) \ + CR ((Sb), DHCP_SERVICE, ServiceBinding, DHCP_SERVICE_SIGNATURE) + +extern EFI_DHCP4_PROTOCOL mDhcp4ProtocolTemplate; + +/** + Give up the control of the DHCP service to let other child + resume. Don't change the service's DHCP state and the Client + address and option list configure as required by RFC2131. + + @param DhcpSb The DHCP service instance. + +**/ +VOID +DhcpYieldControl ( + IN DHCP_SERVICE *DhcpSb + ); + +/** + Complete a Dhcp4 transaction and signal the upper layer. + + @param Instance Dhcp4 instance. + +**/ +VOID +PxeDhcpDone ( + IN DHCP_PROTOCOL *Instance + ); + +/** + Free the resource related to the configure parameters. + DHCP driver will make a copy of the user's configure + such as the time out value. + + @param Config The DHCP configure data + +**/ +VOID +DhcpCleanConfigure ( + IN OUT EFI_DHCP4_CONFIG_DATA *Config + ); + +/** + Callback of Dhcp packet. Does nothing. + + @param Arg The context. + +**/ +VOID +EFIAPI +DhcpDummyExtFree ( + IN VOID *Arg + ); + +/** + Set the elapsed time based on the given instance and the pointer to the + elapsed time option. + + @param[in] Elapsed The pointer to the position to append. + @param[in] Instance The pointer to the Dhcp4 instance. +**/ +VOID +SetElapsedTime ( + IN UINT16 *Elapsed, + IN DHCP_PROTOCOL *Instance + ); + +#endif diff --git a/NetworkPkg/Dhcp4Dxe/Dhcp4Io.c b/NetworkPkg/Dhcp4Dxe/Dhcp4Io.c new file mode 100644 index 0000000000..4728b94c58 --- /dev/null +++ b/NetworkPkg/Dhcp4Dxe/Dhcp4Io.c @@ -0,0 +1,1657 @@ +/** @file + EFI DHCP protocol implementation. + +Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + + +#include "Dhcp4Impl.h" + +UINT32 mDhcp4DefaultTimeout[4] = { 4, 8, 16, 32 }; + + +/** + Send an initial DISCOVER or REQUEST message according to the + DHCP service's current state. + + @param[in] DhcpSb The DHCP service instance + + @retval EFI_SUCCESS The request has been sent + @retval other Some error occurs when sending the request. + +**/ +EFI_STATUS +DhcpInitRequest ( + IN DHCP_SERVICE *DhcpSb + ) +{ + EFI_STATUS Status; + + ASSERT ((DhcpSb->DhcpState == Dhcp4Init) || (DhcpSb->DhcpState == Dhcp4InitReboot)); + + // + // Clear initial time to make sure that elapsed-time is set to 0 for first Discover or REQUEST message. + // + DhcpSb->ActiveChild->ElaspedTime= 0; + + if (DhcpSb->DhcpState == Dhcp4Init) { + DhcpSetState (DhcpSb, Dhcp4Selecting, FALSE); + Status = DhcpSendMessage (DhcpSb, NULL, NULL, DHCP_MSG_DISCOVER, NULL); + + if (EFI_ERROR (Status)) { + DhcpSb->DhcpState = Dhcp4Init; + return Status; + } + } else { + DhcpSetState (DhcpSb, Dhcp4Rebooting, FALSE); + Status = DhcpSendMessage (DhcpSb, NULL, NULL, DHCP_MSG_REQUEST, NULL); + + if (EFI_ERROR (Status)) { + DhcpSb->DhcpState = Dhcp4InitReboot; + return Status; + } + } + + return EFI_SUCCESS; +} + + +/** + Call user provided callback function, and return the value the + function returns. If the user doesn't provide a callback, a + proper return value is selected to let the caller continue the + normal process. + + @param[in] DhcpSb The DHCP service instance + @param[in] Event The event as defined in the spec + @param[in] Packet The current packet trigger the event + @param[out] NewPacket The user's return new packet + + @retval EFI_NOT_READY Direct the caller to continue collecting the offer. + @retval EFI_SUCCESS The user function returns success. + @retval EFI_ABORTED The user function ask it to abort. + +**/ +EFI_STATUS +DhcpCallUser ( + IN DHCP_SERVICE *DhcpSb, + IN EFI_DHCP4_EVENT Event, + IN EFI_DHCP4_PACKET *Packet, OPTIONAL + OUT EFI_DHCP4_PACKET **NewPacket OPTIONAL + ) +{ + EFI_DHCP4_CONFIG_DATA *Config; + EFI_STATUS Status; + + if (NewPacket != NULL) { + *NewPacket = NULL; + } + + // + // If user doesn't provide the call back function, return the value + // that directs the client to continue the normal process. + // In Dhcp4Selecting EFI_SUCCESS tells the client to stop collecting + // the offers and select a offer, EFI_NOT_READY tells the client to + // collect more offers. + // + Config = &DhcpSb->ActiveConfig; + + if (Config->Dhcp4Callback == NULL) { + if (Event == Dhcp4RcvdOffer) { + return EFI_NOT_READY; + } + + return EFI_SUCCESS; + } + + Status = Config->Dhcp4Callback ( + &DhcpSb->ActiveChild->Dhcp4Protocol, + Config->CallbackContext, + (EFI_DHCP4_STATE) DhcpSb->DhcpState, + Event, + Packet, + NewPacket + ); + + // + // User's callback should only return EFI_SUCCESS, EFI_NOT_READY, + // and EFI_ABORTED. If it returns values other than those, assume + // it to be EFI_ABORTED. + // + if ((Status == EFI_SUCCESS) || (Status == EFI_NOT_READY)) { + return Status; + } + + return EFI_ABORTED; +} + + +/** + Notify the user about the operation result. + + @param DhcpSb DHCP service instance + @param Which Which notify function to signal + +**/ +VOID +DhcpNotifyUser ( + IN DHCP_SERVICE *DhcpSb, + IN INTN Which + ) +{ + DHCP_PROTOCOL *Child; + + if ((Child = DhcpSb->ActiveChild) == NULL) { + return ; + } + + if ((Child->CompletionEvent != NULL) && + ((Which == DHCP_NOTIFY_COMPLETION) || (Which == DHCP_NOTIFY_ALL)) + ) { + + gBS->SignalEvent (Child->CompletionEvent); + Child->CompletionEvent = NULL; + } + + if ((Child->RenewRebindEvent != NULL) && + ((Which == DHCP_NOTIFY_RENEWREBIND) || (Which == DHCP_NOTIFY_ALL)) + ) { + + gBS->SignalEvent (Child->RenewRebindEvent); + Child->RenewRebindEvent = NULL; + } +} + + + +/** + Set the DHCP state. If CallUser is true, it will try to notify + the user before change the state by DhcpNotifyUser. It returns + EFI_ABORTED if the user return EFI_ABORTED, otherwise, it returns + EFI_SUCCESS. If CallUser is FALSE, it isn't necessary to test + the return value of this function. + + @param DhcpSb The DHCP service instance + @param State The new DHCP state to change to + @param CallUser Whether we need to call user + + @retval EFI_SUCCESS The state is changed + @retval EFI_ABORTED The user asks to abort the DHCP process. + +**/ +EFI_STATUS +DhcpSetState ( + IN OUT DHCP_SERVICE *DhcpSb, + IN INTN State, + IN BOOLEAN CallUser + ) +{ + EFI_STATUS Status; + + if (CallUser) { + Status = EFI_SUCCESS; + + if (State == Dhcp4Renewing) { + Status = DhcpCallUser (DhcpSb, Dhcp4EnterRenewing, NULL, NULL); + + } else if (State == Dhcp4Rebinding) { + Status = DhcpCallUser (DhcpSb, Dhcp4EnterRebinding, NULL, NULL); + + } else if (State == Dhcp4Bound) { + Status = DhcpCallUser (DhcpSb, Dhcp4BoundCompleted, NULL, NULL); + + } + + if (EFI_ERROR (Status)) { + return Status; + } + } + + // + // Update the retransmission timer during the state transition. + // This will clear the retry count. This is also why the rule + // first transit the state, then send packets. + // + if (State == Dhcp4Selecting) { + DhcpSb->MaxRetries = DhcpSb->ActiveConfig.DiscoverTryCount; + } else { + DhcpSb->MaxRetries = DhcpSb->ActiveConfig.RequestTryCount; + } + + if (DhcpSb->MaxRetries == 0) { + DhcpSb->MaxRetries = 4; + } + + DhcpSb->CurRetry = 0; + DhcpSb->PacketToLive = 0; + DhcpSb->LastTimeout = 0; + DhcpSb->DhcpState = State; + return EFI_SUCCESS; +} + + +/** + Set the retransmit timer for the packet. It will select from either + the discover timeouts/request timeouts or the default timeout values. + + @param DhcpSb The DHCP service instance. + +**/ +VOID +DhcpSetTransmitTimer ( + IN OUT DHCP_SERVICE *DhcpSb + ) +{ + UINT32 *Times; + + ASSERT (DhcpSb->MaxRetries > DhcpSb->CurRetry); + + if (DhcpSb->DhcpState == Dhcp4Selecting) { + Times = DhcpSb->ActiveConfig.DiscoverTimeout; + } else { + Times = DhcpSb->ActiveConfig.RequestTimeout; + } + + if (Times == NULL) { + Times = mDhcp4DefaultTimeout; + } + + DhcpSb->PacketToLive = Times[DhcpSb->CurRetry]; + DhcpSb->LastTimeout = DhcpSb->PacketToLive; + + return; +} + +/** + Compute the lease. If the server grants a permanent lease, just + process it as a normal timeout value since the lease will last + more than 100 years. + + @param DhcpSb The DHCP service instance + @param Para The DHCP parameter extracted from the server's + response. +**/ +VOID +DhcpComputeLease ( + IN OUT DHCP_SERVICE *DhcpSb, + IN DHCP_PARAMETER *Para + ) +{ + ASSERT (Para != NULL); + + DhcpSb->Lease = Para->Lease; + DhcpSb->T2 = Para->T2; + DhcpSb->T1 = Para->T1; + + if (DhcpSb->Lease == 0) { + DhcpSb->Lease = DHCP_DEFAULT_LEASE; + } + + if ((DhcpSb->T2 == 0) || (DhcpSb->T2 >= Para->Lease)) { + DhcpSb->T2 = Para->Lease - (Para->Lease >> 3); + } + + if ((DhcpSb->T1 == 0) || (DhcpSb->T1 >= Para->T2)) { + DhcpSb->T1 = DhcpSb->Lease >> 1; + } +} + + +/** + Configure a UDP IO port to use the acquired lease address. + DHCP driver needs this port to unicast packet to the server + such as DHCP release. + + @param[in] UdpIo The UDP IO to configure + @param[in] Context Dhcp service instance. + + @retval EFI_SUCCESS The UDP IO port is successfully configured. + @retval Others It failed to configure the port. + +**/ +EFI_STATUS +EFIAPI +DhcpConfigLeaseIoPort ( + IN UDP_IO *UdpIo, + IN VOID *Context + ) +{ + EFI_UDP4_CONFIG_DATA UdpConfigData; + EFI_IPv4_ADDRESS Subnet; + EFI_IPv4_ADDRESS Gateway; + DHCP_SERVICE *DhcpSb; + EFI_STATUS Status; + IP4_ADDR Ip; + + DhcpSb = (DHCP_SERVICE *) Context; + + UdpConfigData.AcceptBroadcast = FALSE; + UdpConfigData.AcceptPromiscuous = FALSE; + UdpConfigData.AcceptAnyPort = FALSE; + UdpConfigData.AllowDuplicatePort = TRUE; + UdpConfigData.TypeOfService = 0; + UdpConfigData.TimeToLive = 64; + UdpConfigData.DoNotFragment = FALSE; + UdpConfigData.ReceiveTimeout = 1; + UdpConfigData.TransmitTimeout = 0; + + UdpConfigData.UseDefaultAddress = FALSE; + UdpConfigData.StationPort = DHCP_CLIENT_PORT; + UdpConfigData.RemotePort = DHCP_SERVER_PORT; + + Ip = HTONL (DhcpSb->ClientAddr); + CopyMem (&UdpConfigData.StationAddress, &Ip, sizeof (EFI_IPv4_ADDRESS)); + + Ip = HTONL (DhcpSb->Netmask); + CopyMem (&UdpConfigData.SubnetMask, &Ip, sizeof (EFI_IPv4_ADDRESS)); + + ZeroMem (&UdpConfigData.RemoteAddress, sizeof (EFI_IPv4_ADDRESS)); + + Status = UdpIo->Protocol.Udp4->Configure (UdpIo->Protocol.Udp4, &UdpConfigData); + + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Add a default route if received from the server. + // + if ((DhcpSb->Para != NULL) && (DhcpSb->Para->Router != 0)) { + ZeroMem (&Subnet, sizeof (EFI_IPv4_ADDRESS)); + + Ip = HTONL (DhcpSb->Para->Router); + CopyMem (&Gateway, &Ip, sizeof (EFI_IPv4_ADDRESS)); + + UdpIo->Protocol.Udp4->Routes (UdpIo->Protocol.Udp4, FALSE, &Subnet, &Subnet, &Gateway); + } + + return EFI_SUCCESS; +} + + +/** + Update the lease states when a new lease is acquired. It will not only + save the acquired the address and lease time, it will also create a UDP + child to provide address resolution for the address. + + @param DhcpSb The DHCP service instance + + @retval EFI_OUT_OF_RESOURCES Failed to allocate resources. + @retval EFI_SUCCESS The lease is recorded. + +**/ +EFI_STATUS +DhcpLeaseAcquired ( + IN OUT DHCP_SERVICE *DhcpSb + ) +{ + DhcpSb->ClientAddr = EFI_NTOHL (DhcpSb->Selected->Dhcp4.Header.YourAddr); + + if (DhcpSb->Para != NULL) { + DhcpSb->Netmask = DhcpSb->Para->NetMask; + DhcpSb->ServerAddr = DhcpSb->Para->ServerId; + } + + if (DhcpSb->Netmask == 0) { + return EFI_ABORTED; + } + + if (DhcpSb->LeaseIoPort != NULL) { + UdpIoFreeIo (DhcpSb->LeaseIoPort); + } + + // + // Create a UDP/IP child to provide ARP service for the Leased IP, + // and transmit unicast packet with it as source address. Don't + // start receive on this port, the queued packet will be timeout. + // + DhcpSb->LeaseIoPort = UdpIoCreateIo ( + DhcpSb->Controller, + DhcpSb->Image, + DhcpConfigLeaseIoPort, + UDP_IO_UDP4_VERSION, + DhcpSb + ); + + if (DhcpSb->LeaseIoPort == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + if (!DHCP_IS_BOOTP (DhcpSb->Para)) { + DhcpComputeLease (DhcpSb, DhcpSb->Para); + } + + return DhcpSetState (DhcpSb, Dhcp4Bound, TRUE); +} + + +/** + Clean up the DHCP related states, IoStatus isn't reset. + + @param DhcpSb The DHCP instance service. + +**/ +VOID +DhcpCleanLease ( + IN DHCP_SERVICE *DhcpSb + ) +{ + DhcpSb->DhcpState = Dhcp4Init; + DhcpSb->Xid = DhcpSb->Xid + 1; + DhcpSb->ClientAddr = 0; + DhcpSb->Netmask = 0; + DhcpSb->ServerAddr = 0; + + if (DhcpSb->LastOffer != NULL) { + FreePool (DhcpSb->LastOffer); + DhcpSb->LastOffer = NULL; + } + + if (DhcpSb->Selected != NULL) { + FreePool (DhcpSb->Selected); + DhcpSb->Selected = NULL; + } + + if (DhcpSb->Para != NULL) { + FreePool (DhcpSb->Para); + DhcpSb->Para = NULL; + } + + DhcpSb->Lease = 0; + DhcpSb->T1 = 0; + DhcpSb->T2 = 0; + DhcpSb->ExtraRefresh = FALSE; + + if (DhcpSb->LeaseIoPort != NULL) { + UdpIoFreeIo (DhcpSb->LeaseIoPort); + DhcpSb->LeaseIoPort = NULL; + } + + if (DhcpSb->LastPacket != NULL) { + FreePool (DhcpSb->LastPacket); + DhcpSb->LastPacket = NULL; + } + + DhcpSb->PacketToLive = 0; + DhcpSb->LastTimeout = 0; + DhcpSb->CurRetry = 0; + DhcpSb->MaxRetries = 0; + DhcpSb->LeaseLife = 0; + + // + // Clean active config data. + // + DhcpCleanConfigure (&DhcpSb->ActiveConfig); +} + + +/** + Select a offer among all the offers collected. If the offer selected is + of BOOTP, the lease is recorded and user notified. If the offer is of + DHCP, it will request the offer from the server. + + @param[in] DhcpSb The DHCP service instance. + + @retval EFI_SUCCESS One of the offer is selected. + +**/ +EFI_STATUS +DhcpChooseOffer ( + IN DHCP_SERVICE *DhcpSb + ) +{ + EFI_DHCP4_PACKET *Selected; + EFI_DHCP4_PACKET *NewPacket; + EFI_DHCP4_PACKET *TempPacket; + EFI_STATUS Status; + + ASSERT (DhcpSb->LastOffer != NULL); + + // + // User will cache previous offers if he wants to select + // from multiple offers. If user provides an invalid packet, + // use the last offer, otherwise use the provided packet. + // + NewPacket = NULL; + Status = DhcpCallUser (DhcpSb, Dhcp4SelectOffer, DhcpSb->LastOffer, &NewPacket); + + if (EFI_ERROR (Status)) { + return Status; + } + + Selected = DhcpSb->LastOffer; + + if ((NewPacket != NULL) && !EFI_ERROR (DhcpValidateOptions (NewPacket, NULL))) { + TempPacket = (EFI_DHCP4_PACKET *) AllocatePool (NewPacket->Size); + if (TempPacket != NULL) { + CopyMem (TempPacket, NewPacket, NewPacket->Size); + FreePool (Selected); + Selected = TempPacket; + } + } + + DhcpSb->Selected = Selected; + DhcpSb->LastOffer = NULL; + DhcpSb->Para = NULL; + DhcpValidateOptions (Selected, &DhcpSb->Para); + + // + // A bootp offer has been selected, save the lease status, + // enter bound state then notify the user. + // + if (DHCP_IS_BOOTP (DhcpSb->Para)) { + Status = DhcpLeaseAcquired (DhcpSb); + + if (EFI_ERROR (Status)) { + return Status; + } + + DhcpSb->IoStatus = EFI_SUCCESS; + DhcpNotifyUser (DhcpSb, DHCP_NOTIFY_ALL); + return EFI_SUCCESS; + } + + // + // Send a DHCP requests + // + Status = DhcpSetState (DhcpSb, Dhcp4Requesting, TRUE); + + if (EFI_ERROR (Status)) { + return Status; + } + + return DhcpSendMessage (DhcpSb, Selected, DhcpSb->Para, DHCP_MSG_REQUEST, NULL); +} + + +/** + Terminate the current address acquire. All the allocated resources + are released. Be careful when calling this function. A rule related + to this is: only call DhcpEndSession at the highest level, such as + DhcpInput, DhcpOnTimerTick...At the other level, just return error. + + @param[in] DhcpSb The DHCP service instance + @param[in] Status The result of the DHCP process. + +**/ +VOID +DhcpEndSession ( + IN DHCP_SERVICE *DhcpSb, + IN EFI_STATUS Status + ) +{ + if (DHCP_CONNECTED (DhcpSb->DhcpState)) { + DhcpCallUser (DhcpSb, Dhcp4AddressLost, NULL, NULL); + } else { + DhcpCallUser (DhcpSb, Dhcp4Fail, NULL, NULL); + } + + DhcpCleanLease (DhcpSb); + + DhcpSb->IoStatus = Status; + DhcpNotifyUser (DhcpSb, DHCP_NOTIFY_ALL); +} + + +/** + Handle packets in DHCP select state. + + @param[in] DhcpSb The DHCP service instance + @param[in] Packet The DHCP packet received + @param[in] Para The DHCP parameter extracted from the packet. That + is, all the option value that we care. + + @retval EFI_SUCCESS The packet is successfully processed. + @retval Others Some error occured. + +**/ +EFI_STATUS +DhcpHandleSelect ( + IN DHCP_SERVICE *DhcpSb, + IN EFI_DHCP4_PACKET *Packet, + IN DHCP_PARAMETER *Para + ) +{ + EFI_STATUS Status; + + Status = EFI_SUCCESS; + + // + // First validate the message: + // 1. the offer is a unicast + // 2. if it is a DHCP message, it must contains a server ID. + // Don't return a error for these two case otherwise the session is ended. + // + if (!DHCP_IS_BOOTP (Para) && + ((Para->DhcpType != DHCP_MSG_OFFER) || (Para->ServerId == 0)) + ) { + goto ON_EXIT; + } + + // + // Call the user's callback. The action according to the return is as: + // 1. EFI_SUCESS: stop waiting for more offers, select the offer now + // 2. EFI_NOT_READY: wait for more offers + // 3. EFI_ABORTED: abort the address acquiring. + // + Status = DhcpCallUser (DhcpSb, Dhcp4RcvdOffer, Packet, NULL); + + if (Status == EFI_SUCCESS) { + if (DhcpSb->LastOffer != NULL) { + FreePool (DhcpSb->LastOffer); + } + + DhcpSb->LastOffer = Packet; + + return DhcpChooseOffer (DhcpSb); + + } else if (Status == EFI_NOT_READY) { + if (DhcpSb->LastOffer != NULL) { + FreePool (DhcpSb->LastOffer); + } + + DhcpSb->LastOffer = Packet; + + } else if (Status == EFI_ABORTED) { + // + // DhcpInput will end the session upon error return. Remember + // only to call DhcpEndSession at the top level call. + // + goto ON_EXIT; + } + + return EFI_SUCCESS; + +ON_EXIT: + FreePool (Packet); + return Status; +} + + +/** + Handle packets in DHCP request state. + + @param[in] DhcpSb The DHCP service instance + @param[in] Packet The DHCP packet received + @param[in] Para The DHCP parameter extracted from the packet. That + is, all the option value that we care. + + @retval EFI_SUCCESS The packet is successfully processed. + @retval Others Some error occured. + +**/ +EFI_STATUS +DhcpHandleRequest ( + IN DHCP_SERVICE *DhcpSb, + IN EFI_DHCP4_PACKET *Packet, + IN DHCP_PARAMETER *Para + ) +{ + EFI_DHCP4_HEADER *Head; + EFI_DHCP4_HEADER *Selected; + EFI_STATUS Status; + UINT8 *Message; + + ASSERT (!DHCP_IS_BOOTP (DhcpSb->Para)); + + Head = &Packet->Dhcp4.Header; + Selected = &DhcpSb->Selected->Dhcp4.Header; + + // + // Ignore the BOOTP message and DHCP messages other than DHCP ACK/NACK. + // + if (DHCP_IS_BOOTP (Para) || + (Para->ServerId != DhcpSb->Para->ServerId) || + ((Para->DhcpType != DHCP_MSG_ACK) && (Para->DhcpType != DHCP_MSG_NAK)) + ) { + + Status = EFI_SUCCESS; + goto ON_EXIT; + } + + // + // Received a NAK, end the session no matter what the user returns + // + Status = EFI_DEVICE_ERROR; + + if (Para->DhcpType == DHCP_MSG_NAK) { + DhcpCallUser (DhcpSb, Dhcp4RcvdNak, Packet, NULL); + goto ON_EXIT; + } + + // + // Check whether the ACK matches the selected offer + // + Message = NULL; + + if (!EFI_IP4_EQUAL (&Head->YourAddr, &Selected->YourAddr)) { + Message = (UINT8 *) "Lease confirmed isn't the same as that in the offer"; + goto REJECT; + } + + Status = DhcpCallUser (DhcpSb, Dhcp4RcvdAck, Packet, NULL); + + if (EFI_ERROR (Status)) { + Message = (UINT8 *) "Lease is denied upon received ACK"; + goto REJECT; + } + + // + // Record the lease, transit to BOUND state, then notify the user + // + Status = DhcpLeaseAcquired (DhcpSb); + + if (EFI_ERROR (Status)) { + Message = (UINT8 *) "Lease is denied upon entering bound"; + goto REJECT; + } + + DhcpSb->IoStatus = EFI_SUCCESS; + DhcpNotifyUser (DhcpSb, DHCP_NOTIFY_COMPLETION); + + FreePool (Packet); + return EFI_SUCCESS; + +REJECT: + DhcpSendMessage (DhcpSb, DhcpSb->Selected, DhcpSb->Para, DHCP_MSG_DECLINE, Message); + +ON_EXIT: + FreePool (Packet); + return Status; +} + + +/** + Handle packets in DHCP renew/rebound state. + + @param[in] DhcpSb The DHCP service instance + @param[in] Packet The DHCP packet received + @param[in] Para The DHCP parameter extracted from the packet. That + is, all the option value that we care. + + @retval EFI_SUCCESS The packet is successfully processed. + @retval Others Some error occured. + +**/ +EFI_STATUS +DhcpHandleRenewRebind ( + IN DHCP_SERVICE *DhcpSb, + IN EFI_DHCP4_PACKET *Packet, + IN DHCP_PARAMETER *Para + ) +{ + EFI_DHCP4_HEADER *Head; + EFI_DHCP4_HEADER *Selected; + EFI_STATUS Status; + + ASSERT (!DHCP_IS_BOOTP (DhcpSb->Para)); + + Head = &Packet->Dhcp4.Header; + Selected = &DhcpSb->Selected->Dhcp4.Header; + + // + // Ignore the BOOTP message and DHCP messages other than DHCP ACK/NACK + // + if (DHCP_IS_BOOTP (Para) || + (Para->ServerId != DhcpSb->Para->ServerId) || + ((Para->DhcpType != DHCP_MSG_ACK) && (Para->DhcpType != DHCP_MSG_NAK)) + ) { + + Status = EFI_SUCCESS; + goto ON_EXIT; + } + + // + // Received a NAK, ignore the user's return then terminate the process + // + Status = EFI_DEVICE_ERROR; + + if (Para->DhcpType == DHCP_MSG_NAK) { + DhcpCallUser (DhcpSb, Dhcp4RcvdNak, Packet, NULL); + goto ON_EXIT; + } + + // + // The lease is different from the selected. Don't send a DECLINE + // since it isn't existed in the client's FSM. + // + if (!EFI_IP4_EQUAL (&Head->YourAddr, &Selected->YourAddr)) { + goto ON_EXIT; + } + + Status = DhcpCallUser (DhcpSb, Dhcp4RcvdAck, Packet, NULL); + + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } + + // + // Record the lease, start timer for T1 and T2, + // + DhcpComputeLease (DhcpSb, Para); + DhcpSb->LeaseLife = 0; + DhcpSetState (DhcpSb, Dhcp4Bound, TRUE); + + if (DhcpSb->ExtraRefresh != 0) { + DhcpSb->ExtraRefresh = FALSE; + + DhcpSb->IoStatus = EFI_SUCCESS; + DhcpNotifyUser (DhcpSb, DHCP_NOTIFY_RENEWREBIND); + } + +ON_EXIT: + FreePool (Packet); + return Status; +} + + +/** + Handle packets in DHCP reboot state. + + @param[in] DhcpSb The DHCP service instance + @param[in] Packet The DHCP packet received + @param[in] Para The DHCP parameter extracted from the packet. That + is, all the option value that we care. + + @retval EFI_SUCCESS The packet is successfully processed. + @retval Others Some error occured. + +**/ +EFI_STATUS +DhcpHandleReboot ( + IN DHCP_SERVICE *DhcpSb, + IN EFI_DHCP4_PACKET *Packet, + IN DHCP_PARAMETER *Para + ) +{ + EFI_DHCP4_HEADER *Head; + EFI_STATUS Status; + + Head = &Packet->Dhcp4.Header; + + // + // Ignore the BOOTP message and DHCP messages other than DHCP ACK/NACK + // + if (DHCP_IS_BOOTP (Para) || + ((Para->DhcpType != DHCP_MSG_ACK) && (Para->DhcpType != DHCP_MSG_NAK)) + ) { + + Status = EFI_SUCCESS; + goto ON_EXIT; + } + + // + // If a NAK is received, transit to INIT and try again. + // + if (Para->DhcpType == DHCP_MSG_NAK) { + DhcpCallUser (DhcpSb, Dhcp4RcvdNak, Packet, NULL); + + DhcpSb->ClientAddr = 0; + DhcpSb->DhcpState = Dhcp4Init; + + Status = DhcpInitRequest (DhcpSb); + goto ON_EXIT; + } + + // + // Check whether the ACK matches the selected offer + // + if (EFI_NTOHL (Head->YourAddr) != DhcpSb->ClientAddr) { + Status = EFI_DEVICE_ERROR; + goto ON_EXIT; + } + + Status = DhcpCallUser (DhcpSb, Dhcp4RcvdAck, Packet, NULL); + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } + + // + // OK, get the parameter from server, record the lease + // + DhcpSb->Para = AllocateCopyPool (sizeof (DHCP_PARAMETER), Para); + if (DhcpSb->Para == NULL) { + Status = EFI_OUT_OF_RESOURCES; + goto ON_EXIT; + } + + DhcpSb->Selected = Packet; + Status = DhcpLeaseAcquired (DhcpSb); + if (EFI_ERROR (Status)) { + return Status; + } + + DhcpSb->IoStatus = EFI_SUCCESS; + DhcpNotifyUser (DhcpSb, DHCP_NOTIFY_COMPLETION); + return EFI_SUCCESS; + +ON_EXIT: + FreePool (Packet); + return Status; +} + + +/** + Handle the received DHCP packets. This function drives the DHCP + state machine. + + @param UdpPacket The UDP packets received. + @param EndPoint The local/remote UDP access point + @param IoStatus The status of the UDP receive + @param Context The opaque parameter to the function. + +**/ +VOID +EFIAPI +DhcpInput ( + NET_BUF *UdpPacket, + UDP_END_POINT *EndPoint, + EFI_STATUS IoStatus, + VOID *Context + ) +{ + DHCP_SERVICE *DhcpSb; + EFI_DHCP4_HEADER *Head; + EFI_DHCP4_PACKET *Packet; + DHCP_PARAMETER *Para; + EFI_STATUS Status; + UINT32 Len; + + Packet = NULL; + DhcpSb = (DHCP_SERVICE *) Context; + + // + // Don't restart receive if error occurs or DHCP is destroyed. + // + if (EFI_ERROR (IoStatus)) { + return ; + } else if (DhcpSb->ServiceState == DHCP_DESTROY) { + NetbufFree (UdpPacket); + return ; + } + + ASSERT (UdpPacket != NULL); + + if (DhcpSb->DhcpState == Dhcp4Stopped) { + goto RESTART; + } + + // + // Validate the packet received + // + if (UdpPacket->TotalSize < sizeof (EFI_DHCP4_HEADER)) { + goto RESTART; + } + + // + // Copy the DHCP message to a continuous memory block + // + Len = sizeof (EFI_DHCP4_PACKET) + UdpPacket->TotalSize - sizeof (EFI_DHCP4_HEADER); + Packet = (EFI_DHCP4_PACKET *) AllocatePool (Len); + + if (Packet == NULL) { + goto RESTART; + } + + Packet->Size = Len; + Head = &Packet->Dhcp4.Header; + Packet->Length = NetbufCopy (UdpPacket, 0, UdpPacket->TotalSize, (UINT8 *) Head); + + if (Packet->Length != UdpPacket->TotalSize) { + goto RESTART; + } + + // + // Is this packet the answer to our packet? + // + if ((Head->OpCode != BOOTP_REPLY) || + (NTOHL (Head->Xid) != DhcpSb->Xid) || + (CompareMem (DhcpSb->ClientAddressSendOut, Head->ClientHwAddr, Head->HwAddrLen) != 0)) { + goto RESTART; + } + + // + // Validate the options and retrieve the interested options + // + Para = NULL; + if ((Packet->Length > sizeof (EFI_DHCP4_HEADER) + sizeof (UINT32)) && + (Packet->Dhcp4.Magik == DHCP_OPTION_MAGIC) && + EFI_ERROR (DhcpValidateOptions (Packet, &Para))) { + + goto RESTART; + } + + // + // Call the handler for each state. The handler should return + // EFI_SUCCESS if the process can go on no matter whether the + // packet is ignored or not. If the return is EFI_ERROR, the + // session will be terminated. Packet's ownership is handled + // over to the handlers. If operation succeeds, the handler + // must notify the user. It isn't necessary to do if EFI_ERROR + // is returned because the DhcpEndSession will notify the user. + // + Status = EFI_SUCCESS; + + switch (DhcpSb->DhcpState) { + case Dhcp4Selecting: + Status = DhcpHandleSelect (DhcpSb, Packet, Para); + break; + + case Dhcp4Requesting: + Status = DhcpHandleRequest (DhcpSb, Packet, Para); + break; + + case Dhcp4InitReboot: + case Dhcp4Init: + case Dhcp4Bound: + // + // Ignore the packet in INITREBOOT, INIT and BOUND states + // + FreePool (Packet); + Status = EFI_SUCCESS; + break; + + case Dhcp4Renewing: + case Dhcp4Rebinding: + Status = DhcpHandleRenewRebind (DhcpSb, Packet, Para); + break; + + case Dhcp4Rebooting: + Status = DhcpHandleReboot (DhcpSb, Packet, Para); + break; + } + + if (Para != NULL) { + FreePool (Para); + } + + Packet = NULL; + + if (EFI_ERROR (Status)) { + NetbufFree (UdpPacket); + UdpIoRecvDatagram (DhcpSb->UdpIo, DhcpInput, DhcpSb, 0); + DhcpEndSession (DhcpSb, Status); + return ; + } + +RESTART: + NetbufFree (UdpPacket); + + if (Packet != NULL) { + FreePool (Packet); + } + + Status = UdpIoRecvDatagram (DhcpSb->UdpIo, DhcpInput, DhcpSb, 0); + + if (EFI_ERROR (Status)) { + DhcpEndSession (DhcpSb, EFI_DEVICE_ERROR); + } +} + +/** + Release the net buffer when packet is sent. + + @param UdpPacket The UDP packets received. + @param EndPoint The local/remote UDP access point + @param IoStatus The status of the UDP receive + @param Context The opaque parameter to the function. + +**/ +VOID +EFIAPI +DhcpOnPacketSent ( + NET_BUF *Packet, + UDP_END_POINT *EndPoint, + EFI_STATUS IoStatus, + VOID *Context + ) +{ + NetbufFree (Packet); +} + + + +/** + Build and transmit a DHCP message according to the current states. + This function implement the Table 5. of RFC 2131. Always transits + the state (as defined in Figure 5. of the same RFC) before sending + a DHCP message. The table is adjusted accordingly. + + @param[in] DhcpSb The DHCP service instance + @param[in] Seed The seed packet which the new packet is based on + @param[in] Para The DHCP parameter of the Seed packet + @param[in] Type The message type to send + @param[in] Msg The human readable message to include in the packet + sent. + + @retval EFI_OUT_OF_RESOURCES Failed to allocate resources for the packet + @retval EFI_ACCESS_DENIED Failed to transmit the packet through UDP + @retval EFI_SUCCESS The message is sent + @retval other Other error occurs + +**/ +EFI_STATUS +DhcpSendMessage ( + IN DHCP_SERVICE *DhcpSb, + IN EFI_DHCP4_PACKET *Seed, + IN DHCP_PARAMETER *Para, + IN UINT8 Type, + IN UINT8 *Msg + ) +{ + EFI_DHCP4_CONFIG_DATA *Config; + EFI_DHCP4_PACKET *Packet; + EFI_DHCP4_PACKET *NewPacket; + EFI_DHCP4_HEADER *Head; + EFI_DHCP4_HEADER *SeedHead; + UDP_IO *UdpIo; + UDP_END_POINT EndPoint; + NET_BUF *Wrap; + NET_FRAGMENT Frag; + EFI_STATUS Status; + IP4_ADDR IpAddr; + UINT8 *Buf; + UINT16 MaxMsg; + UINT32 Len; + UINT32 Index; + + // + // Allocate a big enough memory block to hold the DHCP packet + // + Len = sizeof (EFI_DHCP4_PACKET) + 128 + DhcpSb->UserOptionLen; + + if (Msg != NULL) { + Len += (UINT32)AsciiStrLen ((CHAR8 *) Msg); + } + + Packet = AllocatePool (Len); + + if (Packet == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + Packet->Size = Len; + Packet->Length = sizeof (EFI_DHCP4_HEADER) + sizeof (UINT32); + + // + // Fill in the DHCP header fields + // + Config = &DhcpSb->ActiveConfig; + SeedHead = NULL; + + if (Seed != NULL) { + SeedHead = &Seed->Dhcp4.Header; + } + + Head = &Packet->Dhcp4.Header; + ZeroMem (Head, sizeof (EFI_DHCP4_HEADER)); + + Head->OpCode = BOOTP_REQUEST; + Head->HwType = DhcpSb->HwType; + Head->HwAddrLen = DhcpSb->HwLen; + Head->Xid = HTONL (DhcpSb->Xid); + Head->Reserved = HTONS (0x8000); //Server, broadcast the message please. + + EFI_IP4 (Head->ClientAddr) = HTONL (DhcpSb->ClientAddr); + CopyMem (Head->ClientHwAddr, DhcpSb->Mac.Addr, DhcpSb->HwLen); + + if ((Type == DHCP_MSG_DECLINE) || (Type == DHCP_MSG_RELEASE)) { + Head->Seconds = 0; + } else if ((Type == DHCP_MSG_REQUEST) && (DhcpSb->DhcpState == Dhcp4Requesting)) { + // + // Use the same value as the original DHCPDISCOVER message. + // + Head->Seconds = DhcpSb->LastPacket->Dhcp4.Header.Seconds; + } else { + SetElapsedTime(&Head->Seconds, DhcpSb->ActiveChild); + } + + // + // Append the DHCP message type + // + Packet->Dhcp4.Magik = DHCP_OPTION_MAGIC; + Buf = Packet->Dhcp4.Option; + Buf = DhcpAppendOption (Buf, DHCP4_TAG_MSG_TYPE, 1, &Type); + + // + // Append the serverid option if necessary: + // 1. DHCP decline message + // 2. DHCP release message + // 3. DHCP request to confirm one lease. + // + if ((Type == DHCP_MSG_DECLINE) || (Type == DHCP_MSG_RELEASE) || + ((Type == DHCP_MSG_REQUEST) && (DhcpSb->DhcpState == Dhcp4Requesting)) + ) { + + ASSERT ((Para != NULL) && (Para->ServerId != 0)); + + IpAddr = HTONL (Para->ServerId); + Buf = DhcpAppendOption (Buf, DHCP4_TAG_SERVER_ID, 4, (UINT8 *) &IpAddr); + } + + // + // Append the requested IP option if necessary: + // 1. DHCP request to use the previously allocated address + // 2. DHCP request to confirm one lease + // 3. DHCP decline to decline one lease + // + IpAddr = 0; + + if (Type == DHCP_MSG_REQUEST) { + if (DhcpSb->DhcpState == Dhcp4Rebooting) { + IpAddr = EFI_IP4 (Config->ClientAddress); + + } else if (DhcpSb->DhcpState == Dhcp4Requesting) { + ASSERT (SeedHead != NULL); + IpAddr = EFI_IP4 (SeedHead->YourAddr); + } + + } else if (Type == DHCP_MSG_DECLINE) { + ASSERT (SeedHead != NULL); + IpAddr = EFI_IP4 (SeedHead->YourAddr); + } + + if (IpAddr != 0) { + Buf = DhcpAppendOption (Buf, DHCP4_TAG_REQUEST_IP, 4, (UINT8 *) &IpAddr); + } + + // + // Append the Max Message Length option if it isn't a DECLINE + // or RELEASE to direct the server use large messages instead of + // override the BOOTFILE and SERVER fields in the message head. + // + if ((Type != DHCP_MSG_DECLINE) && (Type != DHCP_MSG_RELEASE)) { + MaxMsg = HTONS (0xFF00); + Buf = DhcpAppendOption (Buf, DHCP4_TAG_MAXMSG, 2, (UINT8 *) &MaxMsg); + } + + // + // Append the user's message if it isn't NULL + // + if (Msg != NULL) { + Len = MIN ((UINT32) AsciiStrLen ((CHAR8 *) Msg), 255); + Buf = DhcpAppendOption (Buf, DHCP4_TAG_MESSAGE, (UINT16) Len, Msg); + } + + // + // Append the user configured options + // + if (DhcpSb->UserOptionLen != 0) { + for (Index = 0; Index < Config->OptionCount; Index++) { + // + // We can't use any option other than the client ID from user + // if it is a DHCP decline or DHCP release . + // + if (((Type == DHCP_MSG_DECLINE) || (Type == DHCP_MSG_RELEASE)) && + (Config->OptionList[Index]->OpCode != DHCP4_TAG_CLIENT_ID)) { + continue; + } + + Buf = DhcpAppendOption ( + Buf, + Config->OptionList[Index]->OpCode, + Config->OptionList[Index]->Length, + Config->OptionList[Index]->Data + ); + } + } + + *(Buf++) = DHCP4_TAG_EOP; + Packet->Length += (UINT32) (Buf - Packet->Dhcp4.Option); + + // + // OK, the message is built, call the user to override it. + // + Status = EFI_SUCCESS; + NewPacket = NULL; + + if (Type == DHCP_MSG_DISCOVER) { + Status = DhcpCallUser (DhcpSb, Dhcp4SendDiscover, Packet, &NewPacket); + + } else if (Type == DHCP_MSG_REQUEST) { + Status = DhcpCallUser (DhcpSb, Dhcp4SendRequest, Packet, &NewPacket); + + } else if (Type == DHCP_MSG_DECLINE) { + Status = DhcpCallUser (DhcpSb, Dhcp4SendDecline, Packet, &NewPacket); + } + + if (EFI_ERROR (Status)) { + FreePool (Packet); + return Status; + } + + if (NewPacket != NULL) { + FreePool (Packet); + Packet = NewPacket; + } + + // + // Save the Client Address will be sent out + // + CopyMem ( + &DhcpSb->ClientAddressSendOut[0], + &Packet->Dhcp4.Header.ClientHwAddr[0], + Packet->Dhcp4.Header.HwAddrLen + ); + + // + // Wrap it into a netbuf then send it. + // + Frag.Bulk = (UINT8 *) &Packet->Dhcp4.Header; + Frag.Len = Packet->Length; + Wrap = NetbufFromExt (&Frag, 1, 0, 0, DhcpDummyExtFree, NULL); + + if (Wrap == NULL) { + FreePool (Packet); + return EFI_OUT_OF_RESOURCES; + } + + // + // Save it as the last sent packet for retransmission + // + if (DhcpSb->LastPacket != NULL) { + FreePool (DhcpSb->LastPacket); + } + + DhcpSb->LastPacket = Packet; + DhcpSetTransmitTimer (DhcpSb); + + // + // Broadcast the message, unless we know the server address. + // Use the lease UdpIo port to send the unicast packet. + // + EndPoint.RemoteAddr.Addr[0] = 0xffffffff; + EndPoint.LocalAddr.Addr[0] = 0; + EndPoint.RemotePort = DHCP_SERVER_PORT; + EndPoint.LocalPort = DHCP_CLIENT_PORT; + UdpIo = DhcpSb->UdpIo; + + if ((DhcpSb->DhcpState == Dhcp4Renewing) || (Type == DHCP_MSG_RELEASE)) { + EndPoint.RemoteAddr.Addr[0] = DhcpSb->ServerAddr; + EndPoint.LocalAddr.Addr[0] = DhcpSb->ClientAddr; + UdpIo = DhcpSb->LeaseIoPort; + } + + ASSERT (UdpIo != NULL); + + Status = UdpIoSendDatagram ( + UdpIo, + Wrap, + &EndPoint, + NULL, + DhcpOnPacketSent, + DhcpSb + ); + + if (EFI_ERROR (Status)) { + NetbufFree (Wrap); + return EFI_ACCESS_DENIED; + } + + return EFI_SUCCESS; +} + + +/** + Retransmit a saved packet. Only DISCOVER and REQUEST messages + will be retransmitted. + + @param[in] DhcpSb The DHCP service instance + + @retval EFI_ACCESS_DENIED Failed to transmit packet through UDP port + @retval EFI_SUCCESS The packet is retransmitted. + +**/ +EFI_STATUS +DhcpRetransmit ( + IN DHCP_SERVICE *DhcpSb + ) +{ + UDP_IO *UdpIo; + UDP_END_POINT EndPoint; + NET_BUF *Wrap; + NET_FRAGMENT Frag; + EFI_STATUS Status; + + ASSERT (DhcpSb->LastPacket != NULL); + + // + // For REQUEST message in Dhcp4Requesting state, do not change the secs fields. + // + if (DhcpSb->DhcpState != Dhcp4Requesting) { + SetElapsedTime(&DhcpSb->LastPacket->Dhcp4.Header.Seconds, DhcpSb->ActiveChild); + } + + // + // Wrap it into a netbuf then send it. + // + Frag.Bulk = (UINT8 *) &DhcpSb->LastPacket->Dhcp4.Header; + Frag.Len = DhcpSb->LastPacket->Length; + Wrap = NetbufFromExt (&Frag, 1, 0, 0, DhcpDummyExtFree, NULL); + + if (Wrap == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + // + // Broadcast the message, unless we know the server address. + // + EndPoint.RemotePort = DHCP_SERVER_PORT; + EndPoint.LocalPort = DHCP_CLIENT_PORT; + EndPoint.RemoteAddr.Addr[0] = 0xffffffff; + EndPoint.LocalAddr.Addr[0] = 0; + UdpIo = DhcpSb->UdpIo; + + if (DhcpSb->DhcpState == Dhcp4Renewing) { + EndPoint.RemoteAddr.Addr[0] = DhcpSb->ServerAddr; + EndPoint.LocalAddr.Addr[0] = DhcpSb->ClientAddr; + UdpIo = DhcpSb->LeaseIoPort; + } + + ASSERT (UdpIo != NULL); + + Status = UdpIoSendDatagram ( + UdpIo, + Wrap, + &EndPoint, + NULL, + DhcpOnPacketSent, + DhcpSb + ); + + if (EFI_ERROR (Status)) { + NetbufFree (Wrap); + return EFI_ACCESS_DENIED; + } + + return EFI_SUCCESS; +} + + +/** + Each DHCP service has three timer. Two of them are count down timer. + One for the packet retransmission. The other is to collect the offers. + The third timer increaments the lease life which is compared to T1, T2, + and lease to determine the time to renew and rebind the lease. + DhcpOnTimerTick will be called once every second. + + @param[in] Event The timer event + @param[in] Context The context, which is the DHCP service instance. + +**/ +VOID +EFIAPI +DhcpOnTimerTick ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + LIST_ENTRY *Entry; + LIST_ENTRY *Next; + DHCP_SERVICE *DhcpSb; + DHCP_PROTOCOL *Instance; + EFI_STATUS Status; + + DhcpSb = (DHCP_SERVICE *) Context; + Instance = DhcpSb->ActiveChild; + + // + // 0xffff is the maximum supported value for elapsed time according to RFC. + // + if (Instance != NULL && Instance->ElaspedTime < 0xffff) { + Instance->ElaspedTime++; + } + + // + // Check the retransmit timer + // + if ((DhcpSb->PacketToLive > 0) && (--DhcpSb->PacketToLive == 0)) { + + // + // Select offer at each timeout if any offer received. + // + if (DhcpSb->DhcpState == Dhcp4Selecting && DhcpSb->LastOffer != NULL) { + + Status = DhcpChooseOffer (DhcpSb); + + if (EFI_ERROR(Status)) { + if (DhcpSb->LastOffer != NULL) { + FreePool (DhcpSb->LastOffer); + DhcpSb->LastOffer = NULL; + } + } else { + goto ON_EXIT; + } + } + + if (++DhcpSb->CurRetry < DhcpSb->MaxRetries) { + // + // Still has another try + // + DhcpRetransmit (DhcpSb); + DhcpSetTransmitTimer (DhcpSb); + + } else if (DHCP_CONNECTED (DhcpSb->DhcpState)) { + + // + // Retransmission failed, if the DHCP request is initiated by + // user, adjust the current state according to the lease life. + // Otherwise do nothing to wait the lease to timeout + // + if (DhcpSb->ExtraRefresh != 0) { + Status = EFI_SUCCESS; + + if (DhcpSb->LeaseLife < DhcpSb->T1) { + Status = DhcpSetState (DhcpSb, Dhcp4Bound, FALSE); + + } else if (DhcpSb->LeaseLife < DhcpSb->T2) { + Status = DhcpSetState (DhcpSb, Dhcp4Renewing, FALSE); + + } else if (DhcpSb->LeaseLife < DhcpSb->Lease) { + Status = DhcpSetState (DhcpSb, Dhcp4Rebinding, FALSE); + + } else { + goto END_SESSION; + + } + + DhcpSb->IoStatus = EFI_TIMEOUT; + DhcpNotifyUser (DhcpSb, DHCP_NOTIFY_RENEWREBIND); + } + } else { + goto END_SESSION; + } + } + + // + // If an address has been acquired, check whether need to + // refresh or whether it has expired. + // + if (DHCP_CONNECTED (DhcpSb->DhcpState)) { + DhcpSb->LeaseLife++; + + // + // Don't timeout the lease, only count the life if user is + // requesting extra renew/rebind. Adjust the state after that. + // + if (DhcpSb->ExtraRefresh != 0) { + return ; + } + + if (DhcpSb->LeaseLife == DhcpSb->Lease) { + // + // Lease expires, end the session + // + goto END_SESSION; + + } else if (DhcpSb->LeaseLife == DhcpSb->T2) { + // + // T2 expires, transit to rebinding then send a REQUEST to any server + // + if (EFI_ERROR (DhcpSetState (DhcpSb, Dhcp4Rebinding, TRUE))) { + goto END_SESSION; + } + + if (Instance != NULL) { + Instance->ElaspedTime= 0; + } + + Status = DhcpSendMessage ( + DhcpSb, + DhcpSb->Selected, + DhcpSb->Para, + DHCP_MSG_REQUEST, + NULL + ); + + if (EFI_ERROR (Status)) { + goto END_SESSION; + } + + } else if (DhcpSb->LeaseLife == DhcpSb->T1) { + // + // T1 expires, transit to renewing, then send a REQUEST to the server + // + if (EFI_ERROR (DhcpSetState (DhcpSb, Dhcp4Renewing, TRUE))) { + goto END_SESSION; + } + + if (Instance != NULL) { + Instance->ElaspedTime= 0; + } + + Status = DhcpSendMessage ( + DhcpSb, + DhcpSb->Selected, + DhcpSb->Para, + DHCP_MSG_REQUEST, + NULL + ); + + if (EFI_ERROR (Status)) { + goto END_SESSION; + } + } + } + +ON_EXIT: + // + // Iterate through all the DhcpSb Children. + // + NET_LIST_FOR_EACH_SAFE (Entry, Next, &DhcpSb->Children) { + Instance = NET_LIST_USER_STRUCT (Entry, DHCP_PROTOCOL, Link); + Instance->Timeout--; + if (Instance->Timeout == 0 && Instance->Token != NULL) { + PxeDhcpDone (Instance); + } + } + + return ; + +END_SESSION: + DhcpEndSession (DhcpSb, EFI_TIMEOUT); + + return ; +} diff --git a/NetworkPkg/Dhcp4Dxe/Dhcp4Io.h b/NetworkPkg/Dhcp4Dxe/Dhcp4Io.h new file mode 100644 index 0000000000..01283e5e17 --- /dev/null +++ b/NetworkPkg/Dhcp4Dxe/Dhcp4Io.h @@ -0,0 +1,189 @@ +/** @file + The DHCP4 protocol implementation. + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef __EFI_DHCP4_IO_H__ +#define __EFI_DHCP4_IO_H__ + +#include + +#include + +#include +#include +#include +#include + + + +#define DHCP_WAIT_OFFER 3 // Time to wait the offers +#define DHCP_DEFAULT_LEASE 7 * 24 * 60 * 60 // Seven days as default. +#define DHCP_SERVER_PORT 67 +#define DHCP_CLIENT_PORT 68 + +// +// BOOTP header "op" field +// +#define BOOTP_REQUEST 1 +#define BOOTP_REPLY 2 + +// +// DHCP message types +// +#define DHCP_MSG_DISCOVER 1 +#define DHCP_MSG_OFFER 2 +#define DHCP_MSG_REQUEST 3 +#define DHCP_MSG_DECLINE 4 +#define DHCP_MSG_ACK 5 +#define DHCP_MSG_NAK 6 +#define DHCP_MSG_RELEASE 7 +#define DHCP_MSG_INFORM 8 + +// +// DHCP notify user type +// +#define DHCP_NOTIFY_COMPLETION 1 +#define DHCP_NOTIFY_RENEWREBIND 2 +#define DHCP_NOTIFY_ALL 3 + +#define DHCP_IS_BOOTP(Parameter) (((Parameter) == NULL) || ((Parameter)->DhcpType == 0)) + +#define DHCP_CONNECTED(State) \ + (((State) == Dhcp4Bound) || ((State) == (Dhcp4Renewing)) || ((State) == Dhcp4Rebinding)) + +/** + Set the DHCP state. If CallUser is true, it will try to notify + the user before change the state by DhcpNotifyUser. It returns + EFI_ABORTED if the user return EFI_ABORTED, otherwise, it returns + EFI_SUCCESS. If CallUser is FALSE, it isn't necessary to test + the return value of this function. + + @param DhcpSb The DHCP service instance + @param State The new DHCP state to change to + @param CallUser Whether we need to call user + + @retval EFI_SUCCESS The state is changed + @retval EFI_ABORTED The user asks to abort the DHCP process. + +**/ +EFI_STATUS +DhcpSetState ( + IN OUT DHCP_SERVICE *DhcpSb, + IN INTN State, + IN BOOLEAN CallUser + ); + +/** + Build and transmit a DHCP message according to the current states. + This function implement the Table 5. of RFC 2131. Always transits + the state (as defined in Figure 5. of the same RFC) before sending + a DHCP message. The table is adjusted accordingly. + + @param[in] DhcpSb The DHCP service instance + @param[in] Seed The seed packet which the new packet is based on + @param[in] Para The DHCP parameter of the Seed packet + @param[in] Type The message type to send + @param[in] Msg The human readable message to include in the packet + sent. + + @retval EFI_OUT_OF_RESOURCES Failed to allocate resources for the packet + @retval EFI_ACCESS_DENIED Failed to transmit the packet through UDP + @retval EFI_SUCCESS The message is sent + @retval other Other error occurs + +**/ +EFI_STATUS +DhcpSendMessage ( + IN DHCP_SERVICE *DhcpSb, + IN EFI_DHCP4_PACKET *Seed, + IN DHCP_PARAMETER *Para, + IN UINT8 Type, + IN UINT8 *Msg + ); + +/** + Each DHCP service has three timer. Two of them are count down timer. + One for the packet retransmission. The other is to collect the offers. + The third timer increaments the lease life which is compared to T1, T2, + and lease to determine the time to renew and rebind the lease. + DhcpOnTimerTick will be called once every second. + + @param[in] Event The timer event + @param[in] Context The context, which is the DHCP service instance. + +**/ +VOID +EFIAPI +DhcpOnTimerTick ( + IN EFI_EVENT Event, + IN VOID *Context + ); + +/** + Handle the received DHCP packets. This function drives the DHCP + state machine. + + @param UdpPacket The UDP packets received. + @param EndPoint The local/remote UDP access point + @param IoStatus The status of the UDP receive + @param Context The opaque parameter to the function. + +**/ +VOID +EFIAPI +DhcpInput ( + NET_BUF *UdpPacket, + UDP_END_POINT *EndPoint, + EFI_STATUS IoStatus, + VOID *Context + ); + +/** + Send an initial DISCOVER or REQUEST message according to the + DHCP service's current state. + + @param[in] DhcpSb The DHCP service instance + + @retval EFI_SUCCESS The request has been sent + @retval other Some error occurs when sending the request. + +**/ +EFI_STATUS +DhcpInitRequest ( + IN DHCP_SERVICE *DhcpSb + ); + +/** + Clean up the DHCP related states, IoStatus isn't reset. + + @param DhcpSb The DHCP instance service. + +**/ +VOID +DhcpCleanLease ( + IN DHCP_SERVICE *DhcpSb + ); + +/** + Release the net buffer when packet is sent. + + @param UdpPacket The UDP packets received. + @param EndPoint The local/remote UDP access point + @param IoStatus The status of the UDP receive + @param Context The opaque parameter to the function. + +**/ +VOID +EFIAPI +DhcpOnPacketSent ( + NET_BUF *Packet, + UDP_END_POINT *EndPoint, + EFI_STATUS IoStatus, + VOID *Context + ); + +#endif diff --git a/NetworkPkg/Dhcp4Dxe/Dhcp4Option.c b/NetworkPkg/Dhcp4Dxe/Dhcp4Option.c new file mode 100644 index 0000000000..3adbf55d06 --- /dev/null +++ b/NetworkPkg/Dhcp4Dxe/Dhcp4Option.c @@ -0,0 +1,890 @@ +/** @file + Function to validate, parse, process the DHCP options. + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Dhcp4Impl.h" + +/// +/// A list of the format of DHCP Options sorted by option tag +/// to validate a dhcp message. Refere the comments of the +/// DHCP_OPTION_FORMAT structure. +/// +DHCP_OPTION_FORMAT DhcpOptionFormats[] = { + {DHCP4_TAG_NETMASK, DHCP_OPTION_IP, 1, 1 , TRUE}, + {DHCP4_TAG_TIME_OFFSET, DHCP_OPTION_INT32, 1, 1 , FALSE}, + {DHCP4_TAG_ROUTER, DHCP_OPTION_IP, 1, -1 , TRUE}, + {DHCP4_TAG_TIME_SERVER, DHCP_OPTION_IP, 1, -1 , FALSE}, + {DHCP4_TAG_NAME_SERVER, DHCP_OPTION_IP, 1, -1 , FALSE}, + {DHCP4_TAG_DNS_SERVER, DHCP_OPTION_IP, 1, -1 , FALSE}, + {DHCP4_TAG_LOG_SERVER, DHCP_OPTION_IP, 1, -1 , FALSE}, + {DHCP4_TAG_COOKIE_SERVER, DHCP_OPTION_IP, 1, -1 , FALSE}, + {DHCP4_TAG_LPR_SERVER, DHCP_OPTION_IP, 1, -1 , FALSE}, + {DHCP4_TAG_IMPRESS_SERVER, DHCP_OPTION_IP, 1, -1 , FALSE}, + {DHCP4_TAG_RL_SERVER, DHCP_OPTION_IP, 1, -1 , FALSE}, + {DHCP4_TAG_HOSTNAME, DHCP_OPTION_INT8, 1, -1 , FALSE}, + {DHCP4_TAG_BOOTFILE_LEN, DHCP_OPTION_INT16, 1, 1 , FALSE}, + {DHCP4_TAG_DUMP, DHCP_OPTION_INT8, 1, -1 , FALSE}, + {DHCP4_TAG_DOMAINNAME, DHCP_OPTION_INT8, 1, -1 , FALSE}, + {DHCP4_TAG_SWAP_SERVER, DHCP_OPTION_IP, 1, 1 , FALSE}, + {DHCP4_TAG_ROOTPATH, DHCP_OPTION_INT8, 1, -1 , FALSE}, + {DHCP4_TAG_EXTEND_PATH, DHCP_OPTION_INT8, 1, -1 , FALSE}, + + {DHCP4_TAG_IPFORWARD, DHCP_OPTION_SWITCH, 1, 1 , FALSE}, + {DHCP4_TAG_NONLOCAL_SRR, DHCP_OPTION_SWITCH, 1, 1 , FALSE}, + {DHCP4_TAG_POLICY_SRR, DHCP_OPTION_IPPAIR, 1, -1 , FALSE}, + {DHCP4_TAG_EMTU, DHCP_OPTION_INT16, 1, 1 , FALSE}, + {DHCP4_TAG_TTL, DHCP_OPTION_INT8, 1, 1 , FALSE}, + {DHCP4_TAG_PATHMTU_AGE, DHCP_OPTION_INT32, 1, 1 , FALSE}, + {DHCP4_TAG_PATHMTU_PLATEAU,DHCP_OPTION_INT16, 1, -1 , FALSE}, + + {DHCP4_TAG_IFMTU, DHCP_OPTION_INT16, 1, 1 , FALSE}, + {DHCP4_TAG_SUBNET_LOCAL, DHCP_OPTION_SWITCH, 1, 1 , FALSE}, + {DHCP4_TAG_BROADCAST, DHCP_OPTION_IP, 1, 1 , FALSE}, + {DHCP4_TAG_DISCOVER_MASK, DHCP_OPTION_SWITCH, 1, 1 , FALSE}, + {DHCP4_TAG_SUPPLY_MASK, DHCP_OPTION_SWITCH, 1, 1 , FALSE}, + {DHCP4_TAG_DISCOVER_ROUTE, DHCP_OPTION_SWITCH, 1, 1 , FALSE}, + {DHCP4_TAG_ROUTER_SOLICIT, DHCP_OPTION_IP, 1, 1 , FALSE}, + {DHCP4_TAG_STATIC_ROUTE, DHCP_OPTION_IPPAIR, 1, -1 , FALSE}, + + {DHCP4_TAG_TRAILER, DHCP_OPTION_SWITCH, 1, 1 , FALSE}, + {DHCP4_TAG_ARPAGE, DHCP_OPTION_INT32, 1, 1 , FALSE}, + {DHCP4_TAG_ETHER_ENCAP, DHCP_OPTION_SWITCH, 1, 1 , FALSE}, + + {DHCP4_TAG_TCP_TTL, DHCP_OPTION_INT8, 1, 1 , FALSE}, + {DHCP4_TAG_KEEP_INTERVAL, DHCP_OPTION_INT32, 1, 1 , FALSE}, + {DHCP4_TAG_KEEP_GARBAGE, DHCP_OPTION_SWITCH, 1, 1 , FALSE}, + + {DHCP4_TAG_NIS_DOMAIN, DHCP_OPTION_INT8, 1, -1 , FALSE}, + {DHCP4_TAG_NIS_SERVER, DHCP_OPTION_IP, 1, -1 , FALSE}, + {DHCP4_TAG_NTP_SERVER, DHCP_OPTION_IP, 1, -1 , FALSE}, + {DHCP4_TAG_VENDOR, DHCP_OPTION_INT8, 1, -1 , FALSE}, + {DHCP4_TAG_NBNS, DHCP_OPTION_IP, 1, -1 , FALSE}, + {DHCP4_TAG_NBDD, DHCP_OPTION_IP, 1, -1 , FALSE}, + {DHCP4_TAG_NBTYPE, DHCP_OPTION_INT8, 1, 1 , FALSE}, + {DHCP4_TAG_NBSCOPE, DHCP_OPTION_INT8, 1, -1 , FALSE}, + {DHCP4_TAG_XFONT, DHCP_OPTION_IP, 1, -1 , FALSE}, + {DHCP4_TAG_XDM, DHCP_OPTION_IP, 1, -1 , FALSE}, + + {DHCP4_TAG_REQUEST_IP, DHCP_OPTION_IP, 1, 1 , FALSE}, + {DHCP4_TAG_LEASE, DHCP_OPTION_INT32, 1, 1 , TRUE}, + {DHCP4_TAG_OVERLOAD, DHCP_OPTION_INT8, 1, 1 , TRUE}, + {DHCP4_TAG_MSG_TYPE, DHCP_OPTION_INT8, 1, 1 , TRUE}, + {DHCP4_TAG_SERVER_ID, DHCP_OPTION_IP, 1, 1 , TRUE}, + {DHCP4_TAG_PARA_LIST, DHCP_OPTION_INT8, 1, -1 , FALSE}, + {DHCP4_TAG_MESSAGE, DHCP_OPTION_INT8, 1, -1 , FALSE}, + {DHCP4_TAG_MAXMSG, DHCP_OPTION_INT16, 1, 1 , FALSE}, + {DHCP4_TAG_T1, DHCP_OPTION_INT32, 1, 1 , TRUE}, + {DHCP4_TAG_T2, DHCP_OPTION_INT32, 1, 1 , TRUE}, + {DHCP4_TAG_VENDOR_CLASS_ID,DHCP_OPTION_INT8, 1, -1 , FALSE}, + {DHCP4_TAG_CLIENT_ID, DHCP_OPTION_INT8, 2, -1 , FALSE}, + + {DHCP4_TAG_NISPLUS, DHCP_OPTION_INT8, 1, -1 , FALSE}, + {DHCP4_TAG_NISPLUS_SERVER, DHCP_OPTION_IP, 1, -1 , FALSE}, + + {DHCP4_TAG_TFTP, DHCP_OPTION_INT8, 1, -1 , FALSE}, + {DHCP4_TAG_BOOTFILE, DHCP_OPTION_INT8, 1, -1 , FALSE}, + + {DHCP4_TAG_MOBILEIP, DHCP_OPTION_IP, 0, -1 , FALSE}, + {DHCP4_TAG_SMTP, DHCP_OPTION_IP, 1, -1 , FALSE}, + {DHCP4_TAG_POP3, DHCP_OPTION_IP, 1, -1 , FALSE}, + {DHCP4_TAG_NNTP, DHCP_OPTION_IP, 1, -1 , FALSE}, + {DHCP4_TAG_WWW, DHCP_OPTION_IP, 1, -1 , FALSE}, + {DHCP4_TAG_FINGER, DHCP_OPTION_IP, 1, -1 , FALSE}, + {DHCP4_TAG_IRC, DHCP_OPTION_IP, 1, -1 , FALSE}, + {DHCP4_TAG_STTALK, DHCP_OPTION_IP, 1, -1 , FALSE}, + {DHCP4_TAG_STDA, DHCP_OPTION_IP, 1, -1 , FALSE}, + + {DHCP4_TAG_CLASSLESS_ROUTE,DHCP_OPTION_INT8, 5, -1 , FALSE}, +}; + + +/** + Binary search the DhcpOptionFormats array to find the format + information about a specific option. + + @param[in] Tag The option's tag. + + @return The point to the option's format, NULL if not found. + +**/ +DHCP_OPTION_FORMAT * +DhcpFindOptionFormat ( + IN UINT8 Tag + ) +{ + INTN Left; + INTN Right; + INTN Middle; + + Left = 0; + Right = sizeof (DhcpOptionFormats) / sizeof (DHCP_OPTION_FORMAT) - 1; + + while (Right >= Left) { + Middle = (Left + Right) / 2; + + if (Tag == DhcpOptionFormats[Middle].Tag) { + return &DhcpOptionFormats[Middle]; + } + + if (Tag < DhcpOptionFormats[Middle].Tag) { + Right = Middle - 1; + } else { + Left = Middle + 1; + } + } + + return NULL; +} + + +/** + Validate whether a single DHCP option is valid according to its format. + + @param[in] Format The option's format + @param[in] OptValue The value of the option + @param[in] Len The length of the option value + + @retval TRUE The option is valid. + @retval FALSE Otherwise. + +**/ +BOOLEAN +DhcpOptionIsValid ( + IN DHCP_OPTION_FORMAT *Format, + IN UINT8 *OptValue, + IN INTN Len + ) +{ + INTN Unit; + INTN Occur; + INTN Index; + + Unit = 0; + + switch (Format->Type) { + case DHCP_OPTION_SWITCH: + case DHCP_OPTION_INT8: + Unit = 1; + break; + + case DHCP_OPTION_INT16: + Unit = 2; + break; + + case DHCP_OPTION_INT32: + case DHCP_OPTION_IP: + Unit = 4; + break; + + case DHCP_OPTION_IPPAIR: + Unit = 8; + break; + } + + ASSERT (Unit != 0); + + // + // Validate that the option appears in the full units. + // + if ((Len % Unit) != 0) { + return FALSE; + } + + // + // Validate the occurance of the option unit is with in [MinOccur, MaxOccur] + // + Occur = Len / Unit; + + if (((Format->MinOccur != -1) && (Occur < Format->MinOccur)) || + ((Format->MaxOccur != -1) && (Occur > Format->MaxOccur)) + ) { + return FALSE; + } + + // + // If the option is of type switch, only 0/1 are valid values. + // + if (Format->Type == DHCP_OPTION_SWITCH) { + for (Index = 0; Index < Occur; Index++) { + if ((OptValue[Index] != 0) && (OptValue[Index] != 1)) { + return FALSE; + } + } + } + + return TRUE; +} + + +/** + Extract the client interested options, all the parameters are + converted to host byte order. + + @param[in] Tag The DHCP option tag + @param[in] Len The length of the option + @param[in] Data The value of the DHCP option + @param[out] Para The variable to save the interested parameter + + @retval EFI_SUCCESS The DHCP option is successfully extracted. + @retval EFI_INVALID_PARAMETER The DHCP option is mal-formated + +**/ +EFI_STATUS +DhcpGetParameter ( + IN UINT8 Tag, + IN INTN Len, + IN UINT8 *Data, + OUT DHCP_PARAMETER *Para + ) +{ + switch (Tag) { + case DHCP4_TAG_NETMASK: + Para->NetMask = NetGetUint32 (Data); + break; + + case DHCP4_TAG_ROUTER: + // + // Return the first router to consumer which is the preferred one + // + Para->Router = NetGetUint32 (Data); + break; + + case DHCP4_TAG_LEASE: + Para->Lease = NetGetUint32 (Data); + break; + + case DHCP4_TAG_OVERLOAD: + Para->Overload = *Data; + + if ((Para->Overload < 1) || (Para->Overload > 3)) { + return EFI_INVALID_PARAMETER; + } + break; + + case DHCP4_TAG_MSG_TYPE: + Para->DhcpType = *Data; + + if ((Para->DhcpType < 1) || (Para->DhcpType > 9)) { + return EFI_INVALID_PARAMETER; + } + break; + + case DHCP4_TAG_SERVER_ID: + Para->ServerId = NetGetUint32 (Data); + break; + + case DHCP4_TAG_T1: + Para->T1 = NetGetUint32 (Data); + break; + + case DHCP4_TAG_T2: + Para->T2 = NetGetUint32 (Data); + break; + } + + return EFI_SUCCESS; +} + + +/** + Inspect all the options in a single buffer. DHCP options may be contained + in several buffers, such as the BOOTP options filed, boot file or server + name. Each option buffer is required to end with DHCP4_TAG_EOP. + + @param[in] Buffer The buffer which contains DHCP options + @param[in] BufLen The length of the buffer + @param[in] Check The callback function for each option found + @param[in] Context The opaque parameter for the Check + @param[out] Overload Variable to save the value of DHCP4_TAG_OVERLOAD + option. + + @retval EFI_SUCCESS All the options are valid + @retval EFI_INVALID_PARAMETER The options are mal-formated. + +**/ +EFI_STATUS +DhcpIterateBufferOptions ( + IN UINT8 *Buffer, + IN INTN BufLen, + IN DHCP_CHECK_OPTION Check OPTIONAL, + IN VOID *Context, + OUT UINT8 *Overload OPTIONAL + ) +{ + INTN Cur; + UINT8 Tag; + UINT8 Len; + + Cur = 0; + + while (Cur < BufLen) { + Tag = Buffer[Cur]; + + if (Tag == DHCP4_TAG_PAD) { + Cur++; + continue; + } else if (Tag == DHCP4_TAG_EOP) { + return EFI_SUCCESS; + } + + Cur++; + + if (Cur == BufLen) { + return EFI_INVALID_PARAMETER; + } + + Len = Buffer[Cur++]; + + if (Cur + Len > BufLen) { + return EFI_INVALID_PARAMETER; + } + + if ((Tag == DHCP4_TAG_OVERLOAD) && (Overload != NULL)) { + if (Len != 1) { + return EFI_INVALID_PARAMETER; + } + + *Overload = Buffer[Cur]; + } + + if ((Check != NULL) && EFI_ERROR (Check (Tag, Len, Buffer + Cur, Context))) { + return EFI_INVALID_PARAMETER; + } + + Cur += Len; + } + + // + // Each option buffer is expected to end with an EOP + // + return EFI_INVALID_PARAMETER; +} + + +/** + Iterate through a DHCP message to visit each option. First inspect + all the options in the OPTION field. Then if overloaded, inspect + the options in FILENAME and SERVERNAME fields. One option may be + encoded in several places. See RFC 3396 Encoding Long Options in DHCP + + @param[in] Packet The DHCP packet to check the options for + @param[in] Check The callback function to be called for each option + found + @param[in] Context The opaque parameter for Check + + @retval EFI_SUCCESS The DHCP packet's options are well formated + @retval EFI_INVALID_PARAMETER The DHCP packet's options are not well formated + +**/ +EFI_STATUS +DhcpIterateOptions ( + IN EFI_DHCP4_PACKET *Packet, + IN DHCP_CHECK_OPTION Check OPTIONAL, + IN VOID *Context + ) +{ + EFI_STATUS Status; + UINT8 Overload; + + Overload = 0; + + Status = DhcpIterateBufferOptions ( + Packet->Dhcp4.Option, + Packet->Length - sizeof (EFI_DHCP4_HEADER) - sizeof (UINT32), + Check, + Context, + &Overload + ); + + if (EFI_ERROR (Status)) { + return Status; + } + + if ((Overload == DHCP_OVERLOAD_FILENAME) || (Overload == DHCP_OVERLOAD_BOTH)) { + Status = DhcpIterateBufferOptions ( + (UINT8 *) Packet->Dhcp4.Header.BootFileName, + 128, + Check, + Context, + NULL + ); + + if (EFI_ERROR (Status)) { + return Status; + } + } + + if ((Overload == DHCP_OVERLOAD_SVRNAME) || (Overload == DHCP_OVERLOAD_BOTH)) { + Status = DhcpIterateBufferOptions ( + (UINT8 *) Packet->Dhcp4.Header.ServerName, + 64, + Check, + Context, + NULL + ); + + if (EFI_ERROR (Status)) { + return Status; + } + } + + return EFI_SUCCESS; +} + + +/** + Call back function to DhcpIterateOptions to compute each option's + length. It just adds the data length of all the occurances of this + Tag. Context is an array of 256 DHCP_OPTION_COUNT. + + @param[in] Tag The current option to check + @param[in] Len The length of the option data + @param[in] Data The option data + @param[in] Context The context, which is a array of 256 + DHCP_OPTION_COUNT. + + @retval EFI_SUCCESS It always returns EFI_SUCCESS. + +**/ +EFI_STATUS +DhcpGetOptionLen ( + IN UINT8 Tag, + IN UINT8 Len, + IN UINT8 *Data, + IN VOID *Context + ) +{ + DHCP_OPTION_COUNT *OpCount; + + OpCount = (DHCP_OPTION_COUNT *) Context; + OpCount[Tag].Offset = (UINT16) (OpCount[Tag].Offset + Len); + + return EFI_SUCCESS; +} + + +/** + Call back function to DhcpIterateOptions to consolidate each option's + data. There are maybe several occurrence of the same option. + + @param[in] Tag The option to consolidate its data + @param[in] Len The length of option data + @param[in] Data The data of the option's current occurance + @param[in] Context The context, which is DHCP_OPTION_CONTEXT. This + array is just a wrap to pass THREE parameters. + + @retval EFI_SUCCESS It always returns EFI_SUCCESS + +**/ +EFI_STATUS +DhcpFillOption ( + IN UINT8 Tag, + IN UINT8 Len, + IN UINT8 *Data, + IN VOID *Context + ) +{ + DHCP_OPTION_CONTEXT *OptContext; + DHCP_OPTION_COUNT *OptCount; + DHCP_OPTION *Options; + UINT8 *Buf; + UINT8 Index; + + OptContext = (DHCP_OPTION_CONTEXT *) Context; + + OptCount = OptContext->OpCount; + Index = OptCount[Tag].Index; + Options = OptContext->Options; + Buf = OptContext->Buf; + + if (Options[Index].Data == NULL) { + Options[Index].Tag = Tag; + Options[Index].Data = Buf + OptCount[Tag].Offset; + } + + CopyMem (Buf + OptCount[Tag].Offset, Data, Len); + + OptCount[Tag].Offset = (UINT16) (OptCount[Tag].Offset + Len); + Options[Index].Len = (UINT16) (Options[Index].Len + Len); + return EFI_SUCCESS; +} + + +/** + Parse the options of a DHCP packet. It supports RFC 3396: Encoding + Long Options in DHCP. That is, it will combine all the option value + of all the occurances of each option. + A little bit of implemenation: + It adopts the "Key indexed counting" algorithm. First, it allocates + an array of 256 DHCP_OPTION_COUNTs because DHCP option tag is encoded + as a UINT8. It then iterates the DHCP packet to get data length of + each option by calling DhcpIterOptions with DhcpGetOptionLen. Now, it + knows the number of present options and their length. It allocates a + array of DHCP_OPTION and a continuous buffer after the array to put + all the options' data. Each option's data is pointed to by the Data + field in DHCP_OPTION structure. At last, it call DhcpIterateOptions + with DhcpFillOption to fill each option's data to its position in the + buffer. + + @param[in] Packet The DHCP packet to parse the options + @param[out] Count The number of valid dhcp options present in the + packet + @param[out] OptionPoint The array that contains the DHCP options. Caller + should free it. + + @retval EFI_NOT_FOUND Cannot find any option. + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory to parse the packet. + @retval EFI_INVALID_PARAMETER The options are mal-formated + @retval EFI_SUCCESS The options are parsed into OptionPoint + +**/ +EFI_STATUS +DhcpParseOption ( + IN EFI_DHCP4_PACKET *Packet, + OUT INTN *Count, + OUT DHCP_OPTION **OptionPoint + ) +{ + DHCP_OPTION_CONTEXT Context; + DHCP_OPTION *Options; + DHCP_OPTION_COUNT *OptCount; + EFI_STATUS Status; + UINT16 TotalLen; + INTN OptNum; + INTN Index; + + ASSERT ((Count != NULL) && (OptionPoint != NULL)); + + // + // First compute how many options and how long each option is + // with the "Key indexed counting" algorithms. + // + OptCount = AllocateZeroPool (DHCP_MAX_OPTIONS * sizeof (DHCP_OPTION_COUNT)); + + if (OptCount == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + Status = DhcpIterateOptions (Packet, DhcpGetOptionLen, OptCount); + + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } + + // + // Before the loop, Offset is the length of the option. After loop, + // OptCount[Index].Offset specifies the offset into the continuous + // option value buffer to put the data. + // + TotalLen = 0; + OptNum = 0; + + for (Index = 0; Index < DHCP_MAX_OPTIONS; Index++) { + if (OptCount[Index].Offset != 0) { + OptCount[Index].Index = (UINT8) OptNum; + + TotalLen = (UINT16) (TotalLen + OptCount[Index].Offset); + OptCount[Index].Offset = (UINT16) (TotalLen - OptCount[Index].Offset); + + OptNum++; + } + } + + *Count = OptNum; + *OptionPoint = NULL; + + if (OptNum == 0) { + goto ON_EXIT; + } + + // + // Allocate a buffer to hold the DHCP options, and after that, a + // continuous buffer to put all the options' data. + // + Options = AllocateZeroPool ((UINTN) (OptNum * sizeof (DHCP_OPTION)) + TotalLen); + + if (Options == NULL) { + Status = EFI_OUT_OF_RESOURCES; + goto ON_EXIT; + } + + Context.OpCount = OptCount; + Context.Options = Options; + Context.Buf = (UINT8 *) (Options + OptNum); + + Status = DhcpIterateOptions (Packet, DhcpFillOption, &Context); + + if (EFI_ERROR (Status)) { + FreePool (Options); + goto ON_EXIT; + } + + *OptionPoint = Options; + +ON_EXIT: + FreePool (OptCount); + return Status; +} + + +/** + Validate the packet's options. If necessary, allocate + and fill in the interested parameters. + + @param[in] Packet The packet to validate the options + @param[out] Para The variable to save the DHCP parameters. + + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory to validate the packet. + @retval EFI_INVALID_PARAMETER The options are mal-formated + @retval EFI_SUCCESS The options are parsed into OptionPoint + +**/ +EFI_STATUS +DhcpValidateOptions ( + IN EFI_DHCP4_PACKET *Packet, + OUT DHCP_PARAMETER **Para OPTIONAL + ) +{ + DHCP_PARAMETER Parameter; + DHCP_OPTION_FORMAT *Format; + DHCP_OPTION *AllOption; + DHCP_OPTION *Option; + EFI_STATUS Status; + BOOLEAN Updated; + INTN Count; + INTN Index; + + if (Para != NULL) { + *Para = NULL; + } + + AllOption = NULL; + + Status = DhcpParseOption (Packet, &Count, &AllOption); + if (EFI_ERROR (Status) || (Count == 0)) { + return Status; + } + ASSERT (AllOption != NULL); + + Updated = FALSE; + ZeroMem (&Parameter, sizeof (Parameter)); + + for (Index = 0; Index < Count; Index++) { + Option = &AllOption[Index]; + + // + // Find the format of the option then validate it. + // + Format = DhcpFindOptionFormat (Option->Tag); + + if (Format == NULL) { + continue; + } + + if (!DhcpOptionIsValid (Format, Option->Data, Option->Len)) { + Status = EFI_INVALID_PARAMETER; + goto ON_EXIT; + } + + // + // Get the client interested parameters + // + if (Format->Alert && (Para != NULL)) { + Updated = TRUE; + Status = DhcpGetParameter (Option->Tag, Option->Len, Option->Data, &Parameter); + + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } + } + } + + if (Updated && (Para != NULL)) { + *Para = AllocateCopyPool (sizeof (DHCP_PARAMETER), &Parameter); + if (*Para == NULL) { + Status = EFI_OUT_OF_RESOURCES; + goto ON_EXIT; + } + } + +ON_EXIT: + FreePool (AllOption); + return Status; +} + + + +/** + Append an option to the memory, if the option is longer than + 255 bytes, splits it into several options. + + @param[out] Buf The buffer to append the option to + @param[in] Tag The option's tag + @param[in] DataLen The length of the option's data + @param[in] Data The option's data + + @return The position to append the next option + +**/ +UINT8 * +DhcpAppendOption ( + OUT UINT8 *Buf, + IN UINT8 Tag, + IN UINT16 DataLen, + IN UINT8 *Data + ) +{ + INTN Index; + INTN Len; + + ASSERT (DataLen != 0); + + for (Index = 0; Index < (DataLen + 254) / 255; Index++) { + Len = MIN (255, DataLen - Index * 255); + + *(Buf++) = Tag; + *(Buf++) = (UINT8) Len; + CopyMem (Buf, Data + Index * 255, (UINTN) Len); + + Buf += Len; + } + + return Buf; +} + + +/** + Build a new DHCP packet from a seed packet. Options may be deleted or + appended. The caller should free the NewPacket when finished using it. + + @param[in] SeedPacket The seed packet to start with + @param[in] DeleteCount The number of options to delete + @param[in] DeleteList The options to delete from the packet + @param[in] AppendCount The number of options to append + @param[in] AppendList The options to append to the packet + @param[out] NewPacket The new packet, allocated and built by this + function. + + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory + @retval EFI_INVALID_PARAMETER The options in SeekPacket are mal-formated + @retval EFI_SUCCESS The packet is build. + +**/ +EFI_STATUS +DhcpBuild ( + IN EFI_DHCP4_PACKET *SeedPacket, + IN UINT32 DeleteCount, + IN UINT8 *DeleteList OPTIONAL, + IN UINT32 AppendCount, + IN EFI_DHCP4_PACKET_OPTION *AppendList[] OPTIONAL, + OUT EFI_DHCP4_PACKET **NewPacket + ) +{ + DHCP_OPTION *Mark; + DHCP_OPTION *SeedOptions; + EFI_DHCP4_PACKET *Packet; + EFI_STATUS Status; + INTN Count; + UINT32 Index; + UINT32 Len; + UINT8 *Buf; + + // + // Use an array of DHCP_OPTION to mark the existance + // and position of each valid options. + // + Mark = AllocatePool (sizeof (DHCP_OPTION) * DHCP_MAX_OPTIONS); + + if (Mark == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + for (Index = 0; Index < DHCP_MAX_OPTIONS; Index++) { + Mark[Index].Tag = (UINT8) Index; + Mark[Index].Len = 0; + } + + // + // Get list of the options from the seed packet, then put + // them to the mark array according to their tags. + // + SeedOptions = NULL; + Status = DhcpParseOption (SeedPacket, &Count, &SeedOptions); + + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + if (SeedOptions != NULL) { + for (Index = 0; Index < (UINT32) Count; Index++) { + Mark[SeedOptions[Index].Tag] = SeedOptions[Index]; + } + } + + // + // Mark the option's length is zero if it is in the DeleteList. + // + for (Index = 0; Index < DeleteCount; Index++) { + Mark[DeleteList[Index]].Len = 0; + } + + // + // Add or replace the option if it is in the append list. + // + for (Index = 0; Index < AppendCount; Index++) { + Mark[AppendList[Index]->OpCode].Len = AppendList[Index]->Length; + Mark[AppendList[Index]->OpCode].Data = AppendList[Index]->Data; + } + + // + // compute the new packet length. No need to add 1 byte for + // EOP option since EFI_DHCP4_PACKET includes one extra byte + // for option. It is necessary to split the option if it is + // longer than 255 bytes. + // + Len = sizeof (EFI_DHCP4_PACKET); + + for (Index = 0; Index < DHCP_MAX_OPTIONS; Index++) { + if (Mark[Index].Len != 0) { + Len += ((Mark[Index].Len + 254) / 255) * 2 + Mark[Index].Len; + } + } + + Status = EFI_OUT_OF_RESOURCES; + Packet = (EFI_DHCP4_PACKET *) AllocatePool (Len); + + if (Packet == NULL) { + goto ON_ERROR; + } + + Packet->Size = Len; + Packet->Length = 0; + CopyMem (&Packet->Dhcp4.Header, &SeedPacket->Dhcp4.Header, sizeof (Packet->Dhcp4.Header)); + Packet->Dhcp4.Magik = DHCP_OPTION_MAGIC; + Buf = Packet->Dhcp4.Option; + + for (Index = 0; Index < DHCP_MAX_OPTIONS; Index++) { + if (Mark[Index].Len != 0) { + Buf = DhcpAppendOption (Buf, Mark[Index].Tag, Mark[Index].Len, Mark[Index].Data); + } + } + + *(Buf++) = DHCP4_TAG_EOP; + Packet->Length = sizeof (EFI_DHCP4_HEADER) + sizeof (UINT32) + + (UINT32) (Buf - Packet->Dhcp4.Option); + + *NewPacket = Packet; + Status = EFI_SUCCESS; + +ON_ERROR: + if (SeedOptions != NULL) { + FreePool (SeedOptions); + } + + FreePool (Mark); + return Status; +} diff --git a/NetworkPkg/Dhcp4Dxe/Dhcp4Option.h b/NetworkPkg/Dhcp4Dxe/Dhcp4Option.h new file mode 100644 index 0000000000..9e25386507 --- /dev/null +++ b/NetworkPkg/Dhcp4Dxe/Dhcp4Option.h @@ -0,0 +1,228 @@ +/** @file + To validate, parse and process the DHCP options. + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef __EFI_DHCP4_OPTION_H__ +#define __EFI_DHCP4_OPTION_H__ + +/// +/// DHCP option tags (types) +/// + +#define DHCP_OPTION_MAGIC 0x63538263 // Network byte order +#define DHCP_MAX_OPTIONS 256 + + +// +// DHCP option types, this is used to validate the DHCP options. +// +#define DHCP_OPTION_SWITCH 1 +#define DHCP_OPTION_INT8 2 +#define DHCP_OPTION_INT16 3 +#define DHCP_OPTION_INT32 4 +#define DHCP_OPTION_IP 5 +#define DHCP_OPTION_IPPAIR 6 + +// +// Value of DHCP overload option +// +#define DHCP_OVERLOAD_FILENAME 1 +#define DHCP_OVERLOAD_SVRNAME 2 +#define DHCP_OVERLOAD_BOTH 3 + +/// +/// The DHCP option structure. This structure extends the EFI_DHCP_OPTION +/// structure to support options longer than 255 bytes, such as classless route. +/// +typedef struct { + UINT8 Tag; + UINT16 Len; + UINT8 *Data; +} DHCP_OPTION; + +/// +/// Structures used to parse the DHCP options with RFC3396 support. +/// +typedef struct { + UINT8 Index; + UINT16 Offset; +} DHCP_OPTION_COUNT; + +typedef struct { + DHCP_OPTION_COUNT *OpCount; + DHCP_OPTION *Options; + UINT8 *Buf; +} DHCP_OPTION_CONTEXT; + +/// +/// The options that matters to DHCP driver itself. The user of +/// DHCP clients may be interested in other options, such as +/// classless route, who can parse the DHCP offer to get them. +/// +typedef struct { + IP4_ADDR NetMask; // DHCP4_TAG_NETMASK + IP4_ADDR Router; // DHCP4_TAG_ROUTER, only the first router is used + + // + // DHCP specific options + // + UINT8 DhcpType; // DHCP4_TAG_MSG_TYPE + UINT8 Overload; // DHCP4_TAG_OVERLOAD + IP4_ADDR ServerId; // DHCP4_TAG_SERVER_ID + UINT32 Lease; // DHCP4_TAG_LEASE + UINT32 T1; // DHCP4_TAG_T1 + UINT32 T2; // DHCP4_TAG_T2 +} DHCP_PARAMETER; + +/// +/// Structure used to describe and validate the format of DHCP options. +/// Type is the options' data type, such as DHCP_OPTION_INT8. MinOccur +/// is the minium occurance of this data type. MaxOccur is defined +/// similarly. If MaxOccur is -1, it means that there is no limit on the +/// maximum occurance. Alert tells whether DHCP client should further +/// inspect the option to parse DHCP_PARAMETER. +/// +typedef struct { + UINT8 Tag; + INTN Type; + INTN MinOccur; + INTN MaxOccur; + BOOLEAN Alert; +} DHCP_OPTION_FORMAT; + +typedef +EFI_STATUS +(*DHCP_CHECK_OPTION) ( + IN UINT8 Tag, + IN UINT8 Len, + IN UINT8 *Data, + IN VOID *Context + ); + +/** + Iterate through a DHCP message to visit each option. First inspect + all the options in the OPTION field. Then if overloaded, inspect + the options in FILENAME and SERVERNAME fields. One option may be + encoded in several places. See RFC 3396 Encoding Long Options in DHCP + + @param[in] Packet The DHCP packet to check the options for + @param[in] Check The callback function to be called for each option + found + @param[in] Context The opaque parameter for Check + + @retval EFI_SUCCESS The DHCP packet's options are well formated + @retval EFI_INVALID_PARAMETER The DHCP packet's options are not well formated + +**/ +EFI_STATUS +DhcpIterateOptions ( + IN EFI_DHCP4_PACKET *Packet, + IN DHCP_CHECK_OPTION Check OPTIONAL, + IN VOID *Context + ); + +/** + Validate the packet's options. If necessary, allocate + and fill in the interested parameters. + + @param[in] Packet The packet to validate the options + @param[out] Para The variable to save the DHCP parameters. + + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory to validate the packet. + @retval EFI_INVALID_PARAMETER The options are mal-formated + @retval EFI_SUCCESS The options are parsed into OptionPoint + +**/ +EFI_STATUS +DhcpValidateOptions ( + IN EFI_DHCP4_PACKET *Packet, + OUT DHCP_PARAMETER **Para OPTIONAL + ); + +/** + Parse the options of a DHCP packet. It supports RFC 3396: Encoding + Long Options in DHCP. That is, it will combine all the option value + of all the occurances of each option. + A little bit of implemenation: + It adopts the "Key indexed counting" algorithm. First, it allocates + an array of 256 DHCP_OPTION_COUNTs because DHCP option tag is encoded + as a UINT8. It then iterates the DHCP packet to get data length of + each option by calling DhcpIterOptions with DhcpGetOptionLen. Now, it + knows the number of present options and their length. It allocates a + array of DHCP_OPTION and a continuous buffer after the array to put + all the options' data. Each option's data is pointed to by the Data + field in DHCP_OPTION structure. At last, it call DhcpIterateOptions + with DhcpFillOption to fill each option's data to its position in the + buffer. + + @param[in] Packet The DHCP packet to parse the options + @param[out] Count The number of valid dhcp options present in the + packet + @param[out] OptionPoint The array that contains the DHCP options. Caller + should free it. + + @retval EFI_NOT_FOUND Cannot find any option. + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory to parse the packet. + @retval EFI_INVALID_PARAMETER The options are mal-formated + @retval EFI_SUCCESS The options are parsed into OptionPoint + +**/ +EFI_STATUS +DhcpParseOption ( + IN EFI_DHCP4_PACKET *Packet, + OUT INTN *Count, + OUT DHCP_OPTION **OptionPoint + ); + +/** + Append an option to the memory, if the option is longer than + 255 bytes, splits it into several options. + + @param[out] Buf The buffer to append the option to + @param[in] Tag The option's tag + @param[in] DataLen The length of the option's data + @param[in] Data The option's data + + @return The position to append the next option + +**/ +UINT8 * +DhcpAppendOption ( + OUT UINT8 *Buf, + IN UINT8 Tag, + IN UINT16 DataLen, + IN UINT8 *Data + ); + +/** + Build a new DHCP packet from a seed packet. Options may be deleted or + appended. The caller should free the NewPacket when finished using it. + + @param[in] SeedPacket The seed packet to start with + @param[in] DeleteCount The number of options to delete + @param[in] DeleteList The options to delete from the packet + @param[in] AppendCount The number of options to append + @param[in] AppendList The options to append to the packet + @param[out] NewPacket The new packet, allocated and built by this + function. + + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory + @retval EFI_INVALID_PARAMETER The options in SeekPacket are mal-formated + @retval EFI_SUCCESS The packet is build. + +**/ +EFI_STATUS +DhcpBuild ( + IN EFI_DHCP4_PACKET *SeedPacket, + IN UINT32 DeleteCount, + IN UINT8 *DeleteList OPTIONAL, + IN UINT32 AppendCount, + IN EFI_DHCP4_PACKET_OPTION *AppendList[] OPTIONAL, + OUT EFI_DHCP4_PACKET **NewPacket + ); + +#endif diff --git a/NetworkPkg/DpcDxe/Dpc.c b/NetworkPkg/DpcDxe/Dpc.c new file mode 100644 index 0000000000..8a490949dc --- /dev/null +++ b/NetworkPkg/DpcDxe/Dpc.c @@ -0,0 +1,341 @@ +/** @file + +Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +Module Name: + + Dpc.c + +Abstract: + + +**/ + +#include "Dpc.h" + +// +// Handle for the EFI_DPC_PROTOCOL instance +// +EFI_HANDLE mDpcHandle = NULL; + +// +// The EFI_DPC_PROTOCOL instances that is installed onto mDpcHandle +// +EFI_DPC_PROTOCOL mDpc = { + DpcQueueDpc, + DpcDispatchDpc +}; + +// +// Global variables used to meaasure the DPC Queue Depths +// +UINTN mDpcQueueDepth = 0; +UINTN mMaxDpcQueueDepth = 0; + +// +// Free list of DPC entries. As DPCs are queued, entries are removed from this +// free list. As DPC entries are dispatched, DPC entries are added to the free list. +// If the free list is empty and a DPC is queued, the free list is grown by allocating +// an additional set of DPC entries. +// +LIST_ENTRY mDpcEntryFreeList = INITIALIZE_LIST_HEAD_VARIABLE(mDpcEntryFreeList); + +// +// An array of DPC queues. A DPC queue is allocated for every leval EFI_TPL value. +// As DPCs are queued, they are added to the end of the linked list. +// As DPCs are dispatched, they are removed from the beginning of the linked list. +// +LIST_ENTRY mDpcQueue[TPL_HIGH_LEVEL + 1]; + +/** + Add a Deferred Procedure Call to the end of the DPC queue. + + @param This Protocol instance pointer. + @param DpcTpl The EFI_TPL that the DPC should be invoked. + @param DpcProcedure Pointer to the DPC's function. + @param DpcContext Pointer to the DPC's context. Passed to DpcProcedure + when DpcProcedure is invoked. + + @retval EFI_SUCCESS The DPC was queued. + @retval EFI_INVALID_PARAMETER DpcTpl is not a valid EFI_TPL. + @retval EFI_INVALID_PARAMETER DpcProcedure is NULL. + @retval EFI_OUT_OF_RESOURCES There are not enough resources available to + add the DPC to the queue. + +**/ +EFI_STATUS +EFIAPI +DpcQueueDpc ( + IN EFI_DPC_PROTOCOL *This, + IN EFI_TPL DpcTpl, + IN EFI_DPC_PROCEDURE DpcProcedure, + IN VOID *DpcContext OPTIONAL + ) +{ + EFI_STATUS ReturnStatus; + EFI_TPL OriginalTpl; + DPC_ENTRY *DpcEntry; + UINTN Index; + + // + // Make sure DpcTpl is valid + // + if (DpcTpl < TPL_APPLICATION || DpcTpl > TPL_HIGH_LEVEL) { + return EFI_INVALID_PARAMETER; + } + + // + // Make sure DpcProcedure is valid + // + if (DpcProcedure == NULL) { + return EFI_INVALID_PARAMETER; + } + + // + // Assume this function will succeed + // + ReturnStatus = EFI_SUCCESS; + + // + // Raise the TPL level to TPL_HIGH_LEVEL for DPC list operation and save the + // current TPL value so it can be restored when this function returns. + // + OriginalTpl = gBS->RaiseTPL (TPL_HIGH_LEVEL); + + // + // Check to see if there are any entries in the DPC free list + // + if (IsListEmpty (&mDpcEntryFreeList)) { + // + // If the current TPL is greater than TPL_NOTIFY, then memory allocations + // can not be performed, so the free list can not be expanded. In this case + // return EFI_OUT_OF_RESOURCES. + // + if (OriginalTpl > TPL_NOTIFY) { + ReturnStatus = EFI_OUT_OF_RESOURCES; + goto Done; + } + + // + // Add 64 DPC entries to the free list + // + for (Index = 0; Index < 64; Index++) { + // + // Lower the TPL level to perform a memory allocation + // + gBS->RestoreTPL (OriginalTpl); + + // + // Allocate a new DPC entry + // + DpcEntry = AllocatePool (sizeof (DPC_ENTRY)); + + // + // Raise the TPL level back to TPL_HIGH_LEVEL for DPC list operations + // + gBS->RaiseTPL (TPL_HIGH_LEVEL); + + // + // If the allocation of a DPC entry fails, and the free list is empty, + // then return EFI_OUT_OF_RESOURCES. + // + if (DpcEntry == NULL) { + if (IsListEmpty (&mDpcEntryFreeList)) { + ReturnStatus = EFI_OUT_OF_RESOURCES; + goto Done; + } + } + + // + // Add the newly allocated DPC entry to the DPC free list + // + InsertTailList (&mDpcEntryFreeList, &DpcEntry->ListEntry); + } + } + + // + // Retrieve the first node from the free list of DPCs + // + DpcEntry = (DPC_ENTRY *)(GetFirstNode (&mDpcEntryFreeList)); + + // + // Remove the first node from the free list of DPCs + // + RemoveEntryList (&DpcEntry->ListEntry); + + // + // Fill in the DPC entry with the DpcProcedure and DpcContext + // + DpcEntry->DpcProcedure = DpcProcedure; + DpcEntry->DpcContext = DpcContext; + + // + // Add the DPC entry to the end of the list for the specified DplTpl. + // + InsertTailList (&mDpcQueue[DpcTpl], &DpcEntry->ListEntry); + + // + // Increment the measured DPC queue depth across all TPLs + // + mDpcQueueDepth++; + + // + // Measure the maximum DPC queue depth across all TPLs + // + if (mDpcQueueDepth > mMaxDpcQueueDepth) { + mMaxDpcQueueDepth = mDpcQueueDepth; + } + +Done: + // + // Restore the original TPL level when this function was called + // + gBS->RestoreTPL (OriginalTpl); + + return ReturnStatus; +} + +/** + Dispatch the queue of DPCs. ALL DPCs that have been queued with a DpcTpl + value greater than or equal to the current TPL are invoked in the order that + they were queued. DPCs with higher DpcTpl values are invoked before DPCs with + lower DpcTpl values. + + @param This Protocol instance pointer. + + @retval EFI_SUCCESS One or more DPCs were invoked. + @retval EFI_NOT_FOUND No DPCs were invoked. + +**/ +EFI_STATUS +EFIAPI +DpcDispatchDpc ( + IN EFI_DPC_PROTOCOL *This + ) +{ + EFI_STATUS ReturnStatus; + EFI_TPL OriginalTpl; + EFI_TPL Tpl; + DPC_ENTRY *DpcEntry; + + // + // Assume that no DPCs will be invoked + // + ReturnStatus = EFI_NOT_FOUND; + + // + // Raise the TPL level to TPL_HIGH_LEVEL for DPC list operation and save the + // current TPL value so it can be restored when this function returns. + // + OriginalTpl = gBS->RaiseTPL (TPL_HIGH_LEVEL); + + // + // Check to see if there are 1 or more DPCs currently queued + // + if (mDpcQueueDepth > 0) { + // + // Loop from TPL_HIGH_LEVEL down to the current TPL value + // + for (Tpl = TPL_HIGH_LEVEL; Tpl >= OriginalTpl; Tpl--) { + // + // Check to see if the DPC queue is empty + // + while (!IsListEmpty (&mDpcQueue[Tpl])) { + // + // Retrieve the first DPC entry from the DPC queue specified by Tpl + // + DpcEntry = (DPC_ENTRY *)(GetFirstNode (&mDpcQueue[Tpl])); + + // + // Remove the first DPC entry from the DPC queue specified by Tpl + // + RemoveEntryList (&DpcEntry->ListEntry); + + // + // Decrement the measured DPC Queue Depth across all TPLs + // + mDpcQueueDepth--; + + // + // Lower the TPL to TPL value of the current DPC queue + // + gBS->RestoreTPL (Tpl); + + // + // Invoke the DPC passing in its context + // + (DpcEntry->DpcProcedure) (DpcEntry->DpcContext); + + // + // At least one DPC has been invoked, so set the return status to EFI_SUCCESS + // + ReturnStatus = EFI_SUCCESS; + + // + // Raise the TPL level back to TPL_HIGH_LEVEL for DPC list operations + // + gBS->RaiseTPL (TPL_HIGH_LEVEL); + + // + // Add the invoked DPC entry to the DPC free list + // + InsertTailList (&mDpcEntryFreeList, &DpcEntry->ListEntry); + } + } + } + + // + // Restore the original TPL level when this function was called + // + gBS->RestoreTPL (OriginalTpl); + + return ReturnStatus; +} + +/** + The entry point for DPC driver which installs the EFI_DPC_PROTOCOL onto a new handle. + + @param ImageHandle The image handle of the driver. + @param SystemTable The system table. + + @retval EFI_SUCCES The DPC queues were initialized and the EFI_DPC_PROTOCOL was + installed onto a new handle. + @retval Others Failed to install EFI_DPC_PROTOCOL. + +**/ +EFI_STATUS +EFIAPI +DpcDriverEntryPoint ( + IN EFI_HANDLE ImageHandle, + IN EFI_SYSTEM_TABLE *SystemTable + ) +{ + EFI_STATUS Status; + UINTN Index; + + // + // ASSERT() if the EFI_DPC_PROTOCOL is already present in the handle database + // + ASSERT_PROTOCOL_ALREADY_INSTALLED (NULL, &gEfiDpcProtocolGuid); + + // + // Initialize the DPC queue for all possible TPL values + // + for (Index = 0; Index <= TPL_HIGH_LEVEL; Index++) { + InitializeListHead (&mDpcQueue[Index]); + } + + // + // Install the EFI_DPC_PROTOCOL instance onto a new handle + // + Status = gBS->InstallMultipleProtocolInterfaces ( + &mDpcHandle, + &gEfiDpcProtocolGuid, + &mDpc, + NULL + ); + ASSERT_EFI_ERROR (Status); + + return Status; +} diff --git a/NetworkPkg/DpcDxe/Dpc.h b/NetworkPkg/DpcDxe/Dpc.h new file mode 100644 index 0000000000..2017a215e3 --- /dev/null +++ b/NetworkPkg/DpcDxe/Dpc.h @@ -0,0 +1,80 @@ +/** @file + +Copyright (c) 2007, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +Module Name: + + Dpc.h + +Abstract: + + +**/ + +#ifndef _DPC_H_ +#define _DPC_H_ + +#include +#include +#include +#include +#include +#include +#include + +// +// Internal data struture for managing DPCs. A DPC entry is either on the free +// list or on a DPC queue at a specific EFI_TPL. +// +typedef struct { + LIST_ENTRY ListEntry; + EFI_DPC_PROCEDURE DpcProcedure; + VOID *DpcContext; +} DPC_ENTRY; + +/** + Add a Deferred Procedure Call to the end of the DPC queue. + + @param This Protocol instance pointer. + @param DpcTpl The EFI_TPL that the DPC should be invoked. + @param DpcProcedure Pointer to the DPC's function. + @param DpcContext Pointer to the DPC's context. Passed to DpcProcedure + when DpcProcedure is invoked. + + @retval EFI_SUCCESS The DPC was queued. + @retval EFI_INVALID_PARAMETER DpcTpl is not a valid EFI_TPL. + @retval EFI_INVALID_PARAMETER DpcProcedure is NULL. + @retval EFI_OUT_OF_RESOURCES There are not enough resources available to + add the DPC to the queue. + +**/ +EFI_STATUS +EFIAPI +DpcQueueDpc ( + IN EFI_DPC_PROTOCOL *This, + IN EFI_TPL DpcTpl, + IN EFI_DPC_PROCEDURE DpcProcedure, + IN VOID *DpcContext OPTIONAL + ); + +/** + Dispatch the queue of DPCs. ALL DPCs that have been queued with a DpcTpl + value greater than or equal to the current TPL are invoked in the order that + they were queued. DPCs with higher DpcTpl values are invoked before DPCs with + lower DpcTpl values. + + @param This Protocol instance pointer. + + @retval EFI_SUCCESS One or more DPCs were invoked. + @retval EFI_NOT_FOUND No DPCs were invoked. + +**/ +EFI_STATUS +EFIAPI +DpcDispatchDpc ( + IN EFI_DPC_PROTOCOL *This + ); + +#endif + diff --git a/NetworkPkg/DpcDxe/DpcDxe.inf b/NetworkPkg/DpcDxe/DpcDxe.inf new file mode 100644 index 0000000000..8c241d7f46 --- /dev/null +++ b/NetworkPkg/DpcDxe/DpcDxe.inf @@ -0,0 +1,46 @@ +## @file +# This module produces Deferred Procedure Call Protocol. +# +# Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
+# SPDX-License-Identifier: BSD-2-Clause-Patent +# +# +## + +[Defines] + INF_VERSION = 0x00010005 + BASE_NAME = DpcDxe + MODULE_UNI_FILE = DpcDxe.uni + FILE_GUID = A210F973-229D-4f4d-AA37-9895E6C9EABA + MODULE_TYPE = DXE_DRIVER + VERSION_STRING = 1.0 + ENTRY_POINT = DpcDriverEntryPoint + +# +# The following information is for reference only and not required by the build tools. +# +# VALID_ARCHITECTURES = IA32 X64 EBC +# + +[Sources] + Dpc.c + Dpc.h + +[Packages] + MdePkg/MdePkg.dec + MdeModulePkg/MdeModulePkg.dec + +[LibraryClasses] + UefiDriverEntryPoint + BaseLib + DebugLib + UefiBootServicesTableLib + MemoryAllocationLib + +[Protocols] + gEfiDpcProtocolGuid ## PRODUCES + +[Depex] + TRUE +[UserExtensions.TianoCore."ExtraFiles"] + DpcDxeExtra.uni diff --git a/NetworkPkg/DpcDxe/DpcDxe.uni b/NetworkPkg/DpcDxe/DpcDxe.uni new file mode 100644 index 0000000000..34ad24b255 --- /dev/null +++ b/NetworkPkg/DpcDxe/DpcDxe.uni @@ -0,0 +1,16 @@ +// /** @file +// This module produces Deferred Procedure Call Protocol. +// +// This module produces Deferred Procedure Call Protocol. +// +// Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
+// +// SPDX-License-Identifier: BSD-2-Clause-Patent +// +// **/ + + +#string STR_MODULE_ABSTRACT #language en-US "Produces Deferred Procedure Call Protocol" + +#string STR_MODULE_DESCRIPTION #language en-US "This module produces Deferred Procedure Call Protocol." + diff --git a/NetworkPkg/DpcDxe/DpcDxeExtra.uni b/NetworkPkg/DpcDxe/DpcDxeExtra.uni new file mode 100644 index 0000000000..82a93190d6 --- /dev/null +++ b/NetworkPkg/DpcDxe/DpcDxeExtra.uni @@ -0,0 +1,14 @@ +// /** @file +// DpcDxe Localized Strings and Content +// +// Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.
+// +// SPDX-License-Identifier: BSD-2-Clause-Patent +// +// **/ + +#string STR_PROPERTIES_MODULE_NAME +#language en-US +"Deferred Procedure Call DXE Driver" + + diff --git a/NetworkPkg/Ip4Dxe/ComponentName.c b/NetworkPkg/Ip4Dxe/ComponentName.c new file mode 100644 index 0000000000..3461ab2a89 --- /dev/null +++ b/NetworkPkg/Ip4Dxe/ComponentName.c @@ -0,0 +1,428 @@ +/** @file + +Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Ip4Impl.h" + +// +// EFI Component Name Functions +// +/** + Retrieves a Unicode string that is the user readable name of the driver. + + This function retrieves the user readable name of a driver in the form of a + Unicode string. If the driver specified by This has a user readable name in + the language specified by Language, then a pointer to the driver name is + returned in DriverName, and EFI_SUCCESS is returned. If the driver specified + by This does not support the language specified by Language, + then EFI_UNSUPPORTED is returned. + + @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param[in] Language A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified + in RFC 4646 or ISO 639-2 language code format. + + @param[out] DriverName A pointer to the Unicode string to return. + This Unicode string is the name of the + driver specified by This in the language + specified by Language. + + @retval EFI_SUCCESS The Unicode string for the Driver specified by + This and the language specified by Language was + returned in DriverName. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER DriverName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +Ip4ComponentNameGetDriverName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN CHAR8 *Language, + OUT CHAR16 **DriverName + ); + + +/** + Retrieves a Unicode string that is the user readable name of the controller + that is being managed by a driver. + + This function retrieves the user readable name of the controller specified by + ControllerHandle and ChildHandle in the form of a Unicode string. If the + driver specified by This has a user readable name in the language specified by + Language, then a pointer to the controller name is returned in ControllerName, + and EFI_SUCCESS is returned. If the driver specified by This is not currently + managing the controller specified by ControllerHandle and ChildHandle, + then EFI_UNSUPPORTED is returned. If the driver specified by This does not + support the language specified by Language, then EFI_UNSUPPORTED is returned. + + @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param[in] ControllerHandle The handle of a controller that the driver + specified by This is managing. This handle + specifies the controller whose name is to be + returned. + + @param[in] ChildHandle The handle of the child controller to retrieve + the name of. This is an optional parameter that + may be NULL. It will be NULL for device + drivers. It will also be NULL for a bus drivers + that wish to retrieve the name of the bus + controller. It will not be NULL for a bus + driver that wishes to retrieve the name of a + child controller. + + @param[in] Language A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified in + RFC 4646 or ISO 639-2 language code format. + + @param[out] ControllerName A pointer to the Unicode string to return. + This Unicode string is the name of the + controller specified by ControllerHandle and + ChildHandle in the language specified by + Language from the point of view of the driver + specified by This. + + @retval EFI_SUCCESS The Unicode string for the user readable name in + the language specified by Language for the + driver specified by This was returned in + DriverName. + + @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. + + @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid + EFI_HANDLE. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER ControllerName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This is not currently + managing the controller specified by + ControllerHandle and ChildHandle. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +Ip4ComponentNameGetControllerName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_HANDLE ChildHandle OPTIONAL, + IN CHAR8 *Language, + OUT CHAR16 **ControllerName + ); + + +// +// EFI Component Name Protocol +// +GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gIp4ComponentName = { + Ip4ComponentNameGetDriverName, + Ip4ComponentNameGetControllerName, + "eng" +}; + +// +// EFI Component Name 2 Protocol +// +GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gIp4ComponentName2 = { + (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) Ip4ComponentNameGetDriverName, + (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) Ip4ComponentNameGetControllerName, + "en" +}; + + +GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mIp4DriverNameTable[] = { + { + "eng;en", + L"IP4 Network Service Driver" + }, + { + NULL, + NULL + } +}; + +GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE *gIp4ControllerNameTable = NULL; + +/** + Retrieves a Unicode string that is the user readable name of the driver. + + This function retrieves the user readable name of a driver in the form of a + Unicode string. If the driver specified by This has a user readable name in + the language specified by Language, then a pointer to the driver name is + returned in DriverName, and EFI_SUCCESS is returned. If the driver specified + by This does not support the language specified by Language, + then EFI_UNSUPPORTED is returned. + + @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param[in] Language A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified + in RFC 4646 or ISO 639-2 language code format. + + @param[out] DriverName A pointer to the Unicode string to return. + This Unicode string is the name of the + driver specified by This in the language + specified by Language. + + @retval EFI_SUCCESS The Unicode string for the Driver specified by + This and the language specified by Language was + returned in DriverName. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER DriverName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +Ip4ComponentNameGetDriverName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN CHAR8 *Language, + OUT CHAR16 **DriverName + ) +{ + return LookupUnicodeString2 ( + Language, + This->SupportedLanguages, + mIp4DriverNameTable, + DriverName, + (BOOLEAN)(This == &gIp4ComponentName) + ); + +} + +/** + Update the component name for the IP4 child handle. + + @param Ip4[in] A pointer to the EFI_IP4_PROTOCOL. + + + @retval EFI_SUCCESS Update the ControllerNameTable of this instance successfully. + @retval EFI_INVALID_PARAMETER The input parameter is invalid. + +**/ +EFI_STATUS +UpdateName ( + IN EFI_IP4_PROTOCOL *Ip4 + ) +{ + EFI_STATUS Status; + CHAR16 HandleName[80]; + EFI_IP4_MODE_DATA Ip4ModeData; + + if (Ip4 == NULL) { + return EFI_INVALID_PARAMETER; + } + + // + // Format the child name into the string buffer as: + // IPv4 (SrcIP=127.0.0.1, DestIP=127.0.0.1) + // + Status = Ip4->GetModeData (Ip4, &Ip4ModeData, NULL, NULL); + if (EFI_ERROR (Status)) { + return Status; + } + + if (!Ip4ModeData.IsStarted || !Ip4ModeData.IsConfigured) { + UnicodeSPrint (HandleName, sizeof (HandleName), L"IPv4 (Not started)"); + } else { + UnicodeSPrint (HandleName, sizeof (HandleName), + L"IPv4 (SrcIP=%d.%d.%d.%d)", + Ip4ModeData.ConfigData.StationAddress.Addr[0], + Ip4ModeData.ConfigData.StationAddress.Addr[1], + Ip4ModeData.ConfigData.StationAddress.Addr[2], + Ip4ModeData.ConfigData.StationAddress.Addr[3] + ); + } + + if (gIp4ControllerNameTable != NULL) { + FreeUnicodeStringTable (gIp4ControllerNameTable); + gIp4ControllerNameTable = NULL; + } + Status = AddUnicodeString2 ( + "eng", + gIp4ComponentName.SupportedLanguages, + &gIp4ControllerNameTable, + HandleName, + TRUE + ); + if (EFI_ERROR (Status)) { + return Status; + } + + return AddUnicodeString2 ( + "en", + gIp4ComponentName2.SupportedLanguages, + &gIp4ControllerNameTable, + HandleName, + FALSE + ); +} + +/** + Retrieves a Unicode string that is the user readable name of the controller + that is being managed by a driver. + + This function retrieves the user readable name of the controller specified by + ControllerHandle and ChildHandle in the form of a Unicode string. If the + driver specified by This has a user readable name in the language specified by + Language, then a pointer to the controller name is returned in ControllerName, + and EFI_SUCCESS is returned. If the driver specified by This is not currently + managing the controller specified by ControllerHandle and ChildHandle, + then EFI_UNSUPPORTED is returned. If the driver specified by This does not + support the language specified by Language, then EFI_UNSUPPORTED is returned. + + @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param[in] ControllerHandle The handle of a controller that the driver + specified by This is managing. This handle + specifies the controller whose name is to be + returned. + + @param[in] ChildHandle The handle of the child controller to retrieve + the name of. This is an optional parameter that + may be NULL. It will be NULL for device + drivers. It will also be NULL for a bus drivers + that wish to retrieve the name of the bus + controller. It will not be NULL for a bus + driver that wishes to retrieve the name of a + child controller. + + @param[in] Language A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified in + RFC 4646 or ISO 639-2 language code format. + + @param[out] ControllerName A pointer to the Unicode string to return. + This Unicode string is the name of the + controller specified by ControllerHandle and + ChildHandle in the language specified by + Language from the point of view of the driver + specified by This. + + @retval EFI_SUCCESS The Unicode string for the user readable name in + the language specified by Language for the + driver specified by This was returned in + DriverName. + + @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. + + @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid + EFI_HANDLE. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER ControllerName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This is not currently + managing the controller specified by + ControllerHandle and ChildHandle. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +Ip4ComponentNameGetControllerName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_HANDLE ChildHandle OPTIONAL, + IN CHAR8 *Language, + OUT CHAR16 **ControllerName + ) +{ + EFI_STATUS Status; + EFI_IP4_PROTOCOL *Ip4; + + // + // Only provide names for child handles. + // + if (ChildHandle == NULL) { + return EFI_UNSUPPORTED; + } + + // + // Make sure this driver produced ChildHandle + // + Status = EfiTestChildHandle ( + ControllerHandle, + ChildHandle, + &gEfiManagedNetworkProtocolGuid + ); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Retrieve an instance of a produced protocol from ChildHandle + // + Status = gBS->OpenProtocol ( + ChildHandle, + &gEfiIp4ProtocolGuid, + (VOID **)&Ip4, + NULL, + NULL, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Update the component name for this child handle. + // + Status = UpdateName (Ip4); + if (EFI_ERROR (Status)) { + return Status; + } + + return LookupUnicodeString2 ( + Language, + This->SupportedLanguages, + gIp4ControllerNameTable, + ControllerName, + (BOOLEAN)(This == &gIp4ComponentName) + ); +} + diff --git a/NetworkPkg/Ip4Dxe/Ip4Common.c b/NetworkPkg/Ip4Dxe/Ip4Common.c new file mode 100644 index 0000000000..c756a2dbf7 --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4Common.c @@ -0,0 +1,306 @@ +/** @file + +Copyright (c) 2005 - 2017, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Ip4Impl.h" + + +/** + Return the cast type (Unicast/Boradcast) specific to an + interface. All the addresses are host byte ordered. + + @param[in] IpAddr The IP address to classify in host byte order + @param[in] IpIf The interface that IpAddr received from + + @return The cast type of this IP address specific to the interface. + @retval IP4_LOCAL_HOST The IpAddr equals to the interface's address + @retval IP4_SUBNET_BROADCAST The IpAddr is a directed subnet boradcast to the + interface + @retval IP4_NET_BROADCAST The IpAddr is a network broadcast to the interface + @retval 0 Otherwise. + +**/ +INTN +Ip4GetNetCast ( + IN IP4_ADDR IpAddr, + IN IP4_INTERFACE *IpIf + ) +{ + if (IpAddr == IpIf->Ip) { + return IP4_LOCAL_HOST; + + } else if (IpAddr == IpIf->SubnetBrdcast) { + return IP4_SUBNET_BROADCAST; + + } else if (IpAddr == IpIf->NetBrdcast) { + return IP4_NET_BROADCAST; + + } + + return 0; +} + + +/** + Find the cast type of the packet related to the local host. + This isn't the same as link layer cast type. For example, DHCP + server may send local broadcast to the local unicast MAC. + + @param[in] IpSb The IP4 service binding instance that received the + packet + @param[in] Dst The destination address in the packet (host byte + order) + @param[in] Src The source address in the packet (host byte order) + + @return The cast type for the Dst, it will return on the first non-promiscuous + cast type to a configured interface. If the packet doesn't match any of + the interface, multicast address and local broadcast address are checked. + +**/ +INTN +Ip4GetHostCast ( + IN IP4_SERVICE *IpSb, + IN IP4_ADDR Dst, + IN IP4_ADDR Src + ) +{ + LIST_ENTRY *Entry; + IP4_INTERFACE *IpIf; + INTN Type; + INTN Class; + + Type = 0; + + if (IpSb->MnpConfigData.EnablePromiscuousReceive) { + Type = IP4_PROMISCUOUS; + } + + // + // Go through the interface list of the IP service, most likely. + // + NET_LIST_FOR_EACH (Entry, &IpSb->Interfaces) { + IpIf = NET_LIST_USER_STRUCT (Entry, IP4_INTERFACE, Link); + + // + // Skip the unconfigured interface and invalid source address: + // source address can't be broadcast. + // + if (!IpIf->Configured || IP4_IS_BROADCAST (Ip4GetNetCast (Src, IpIf))) { + continue; + } + + if ((Class = Ip4GetNetCast (Dst, IpIf)) > Type) { + return Class; + } + } + + // + // If it is local broadcast address. The source address must + // be a unicast address on one of the direct connected network. + // If it is a multicast address, accept it only if we are in + // the group. + // + if (Dst == IP4_ALLONE_ADDRESS) { + IpIf = Ip4FindNet (IpSb, Src); + + if (IpIf != NULL && !IP4_IS_BROADCAST (Ip4GetNetCast (Src, IpIf))) { + return IP4_LOCAL_BROADCAST; + } + + } else if (IP4_IS_MULTICAST (Dst) && Ip4FindGroup (&IpSb->IgmpCtrl, Dst) != NULL) { + return IP4_MULTICAST; + } + + return Type; +} + + +/** + Find an interface whose configured IP address is Ip. + + @param[in] IpSb The IP4 service binding instance + @param[in] Ip The Ip address (host byte order) to find + + @return The IP4_INTERFACE point if found, otherwise NULL + +**/ +IP4_INTERFACE * +Ip4FindInterface ( + IN IP4_SERVICE *IpSb, + IN IP4_ADDR Ip + ) +{ + LIST_ENTRY *Entry; + IP4_INTERFACE *IpIf; + + NET_LIST_FOR_EACH (Entry, &IpSb->Interfaces) { + IpIf = NET_LIST_USER_STRUCT (Entry, IP4_INTERFACE, Link); + + if (IpIf->Configured && (IpIf->Ip == Ip)) { + return IpIf; + } + } + + return NULL; +} + + +/** + Find an interface that Ip is on that connected network. + + @param[in] IpSb The IP4 service binding instance + @param[in] Ip The Ip address (host byte order) to find + + @return The IP4_INTERFACE point if found, otherwise NULL + +**/ +IP4_INTERFACE * +Ip4FindNet ( + IN IP4_SERVICE *IpSb, + IN IP4_ADDR Ip + ) +{ + LIST_ENTRY *Entry; + IP4_INTERFACE *IpIf; + + NET_LIST_FOR_EACH (Entry, &IpSb->Interfaces) { + IpIf = NET_LIST_USER_STRUCT (Entry, IP4_INTERFACE, Link); + + if (IpIf->Configured && IP4_NET_EQUAL (Ip, IpIf->Ip, IpIf->SubnetMask)) { + return IpIf; + } + } + + return NULL; +} + + +/** + Find an interface of the service with the same Ip/Netmask pair. + + @param[in] IpSb Ip4 service binding instance + @param[in] Ip The Ip adress to find (host byte order) + @param[in] Netmask The network to find (host byte order) + + @return The IP4_INTERFACE point if found, otherwise NULL + +**/ +IP4_INTERFACE * +Ip4FindStationAddress ( + IN IP4_SERVICE *IpSb, + IN IP4_ADDR Ip, + IN IP4_ADDR Netmask + ) +{ + LIST_ENTRY *Entry; + IP4_INTERFACE *IpIf; + + NET_LIST_FOR_EACH (Entry, &IpSb->Interfaces) { + IpIf = NET_LIST_USER_STRUCT (Entry, IP4_INTERFACE, Link); + + if (IpIf->Configured && (IpIf->Ip == Ip) && (IpIf->SubnetMask == Netmask)) { + return IpIf; + } + } + + return NULL; +} + + +/** + Get the MAC address for a multicast IP address. Call + Mnp's McastIpToMac to find the MAC address in stead of + hard code the NIC to be Ethernet. + + @param[in] Mnp The Mnp instance to get the MAC address. + @param[in] Multicast The multicast IP address to translate. + @param[out] Mac The buffer to hold the translated address. + + @retval EFI_SUCCESS if the multicast IP is successfully translated to a + multicast MAC address. + @retval other Otherwise some error. + +**/ +EFI_STATUS +Ip4GetMulticastMac ( + IN EFI_MANAGED_NETWORK_PROTOCOL *Mnp, + IN IP4_ADDR Multicast, + OUT EFI_MAC_ADDRESS *Mac + ) +{ + EFI_IP_ADDRESS EfiIp; + + EFI_IP4 (EfiIp.v4) = HTONL (Multicast); + return Mnp->McastIpToMac (Mnp, FALSE, &EfiIp, Mac); +} + + +/** + Convert the multibyte field in IP header's byter order. + In spite of its name, it can also be used to convert from + host to network byte order. + + @param[in] Head The IP head to convert + + @return Point to the converted IP head + +**/ +IP4_HEAD * +Ip4NtohHead ( + IN IP4_HEAD *Head + ) +{ + Head->TotalLen = NTOHS (Head->TotalLen); + Head->Id = NTOHS (Head->Id); + Head->Fragment = NTOHS (Head->Fragment); + Head->Src = NTOHL (Head->Src); + Head->Dst = NTOHL (Head->Dst); + + return Head; +} + + +/** + Validate that Ip/Netmask pair is OK to be used as station + address. Only continuous netmasks are supported. and check + that StationAddress is a unicast address on the newtwork. + + @param[in] Ip The IP address to validate. + @param[in] Netmask The netmaks of the IP. + + @retval TRUE The Ip/Netmask pair is valid. + @retval FALSE The Ip/Netmask pair is invalid. + +**/ +BOOLEAN +Ip4StationAddressValid ( + IN IP4_ADDR Ip, + IN IP4_ADDR Netmask + ) +{ + // + // Only support the station address with 0.0.0.0/0 to enable DHCP client. + // + if (Netmask == IP4_ALLZERO_ADDRESS) { + return (BOOLEAN) (Ip == IP4_ALLZERO_ADDRESS); + } + + // + // Only support the continuous net masks + // + if (NetGetMaskLength (Netmask) == (IP4_MASK_MAX + 1)) { + return FALSE; + } + + // + // Station address can't be class D or class E address + // + if (NetGetIpClass (Ip) > IP4_ADDR_CLASSC) { + return FALSE; + } + + return NetIp4IsUnicast (Ip, Netmask); +} diff --git a/NetworkPkg/Ip4Dxe/Ip4Common.h b/NetworkPkg/Ip4Dxe/Ip4Common.h new file mode 100644 index 0000000000..8fbfd54872 --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4Common.h @@ -0,0 +1,217 @@ +/** @file + Common definition for IP4. + +Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef __EFI_IP4_COMMON_H__ +#define __EFI_IP4_COMMON_H__ + +typedef struct _IP4_INTERFACE IP4_INTERFACE; +typedef struct _IP4_PROTOCOL IP4_PROTOCOL; +typedef struct _IP4_SERVICE IP4_SERVICE; + +#define IP4_ETHER_PROTO 0x0800 + +// +// The packet is received as link level broadcast/multicast/promiscuous. +// +#define IP4_LINK_BROADCAST 0x00000001 +#define IP4_LINK_MULTICAST 0x00000002 +#define IP4_LINK_PROMISC 0x00000004 + +// +// IP4 address cast type classfication. Keep it true that any +// type bigger than or equal to LOCAL_BROADCAST is broadcast. +// +#define IP4_PROMISCUOUS 1 +#define IP4_LOCAL_HOST 2 +#define IP4_MULTICAST 3 +#define IP4_LOCAL_BROADCAST 4 // Destination is 255.255.255.255 +#define IP4_SUBNET_BROADCAST 5 +#define IP4_NET_BROADCAST 6 + +// +// IP4 header flags +// +#define IP4_HEAD_DF_MASK 0x4000 +#define IP4_HEAD_MF_MASK 0x2000 +#define IP4_HEAD_OFFSET_MASK 0x1fff + +#define IP4_ALLZERO_ADDRESS 0x00000000u +#define IP4_ALLONE_ADDRESS 0xFFFFFFFFu +#define IP4_ALLSYSTEM_ADDRESS 0xE0000001u +#define IP4_ALLROUTER_ADDRESS 0xE0000002u + +/// +/// Compose the fragment field to be used in the IP4 header. +/// +#define IP4_HEAD_FRAGMENT_FIELD(Df, Mf, Offset) \ + ((UINT16)(((Df) ? IP4_HEAD_DF_MASK : 0) | ((Mf) ? IP4_HEAD_MF_MASK : 0) | (((Offset) >> 3) & IP4_HEAD_OFFSET_MASK))) + +#define IP4_LAST_FRAGMENT(FragmentField) \ + (((FragmentField) & IP4_HEAD_MF_MASK) == 0) + +#define IP4_FIRST_FRAGMENT(FragmentField) \ + ((BOOLEAN)(((FragmentField) & IP4_HEAD_OFFSET_MASK) == 0)) + +#define IP4_DO_NOT_FRAGMENT(FragmentField) \ + ((BOOLEAN)(((FragmentField) & IP4_HEAD_DF_MASK) == IP4_HEAD_DF_MASK)) + +#define IP4_IS_BROADCAST(CastType) ((CastType) >= IP4_LOCAL_BROADCAST) + +/// +/// Conver the Microsecond to second. IP transmit/receive time is +/// in the unit of microsecond. IP ticks once per second. +/// +#define IP4_US_TO_SEC(Us) (((Us) + 999999) / 1000000) + +/** + Return the cast type (Unicast/Boradcast) specific to an + interface. All the addresses are host byte ordered. + + @param[in] IpAddr The IP address to classify in host byte order + @param[in] IpIf The interface that IpAddr received from + + @return The cast type of this IP address specific to the interface. + @retval IP4_LOCAL_HOST The IpAddr equals to the interface's address + @retval IP4_SUBNET_BROADCAST The IpAddr is a directed subnet boradcast to the + interface + @retval IP4_NET_BROADCAST The IpAddr is a network broadcast to the interface + @retval 0 Otherwise. + +**/ +INTN +Ip4GetNetCast ( + IN IP4_ADDR IpAddr, + IN IP4_INTERFACE *IpIf + ); + +/** + Find the cast type of the packet related to the local host. + This isn't the same as link layer cast type. For example, DHCP + server may send local broadcast to the local unicast MAC. + + @param[in] IpSb The IP4 service binding instance that received the + packet + @param[in] Dst The destination address in the packet (host byte + order) + @param[in] Src The source address in the packet (host byte order) + + @return The cast type for the Dst, it will return on the first non-promiscuous + cast type to a configured interface. If the packet doesn't match any of + the interface, multicast address and local broadcast address are checked. + +**/ +INTN +Ip4GetHostCast ( + IN IP4_SERVICE *IpSb, + IN IP4_ADDR Dst, + IN IP4_ADDR Src + ); + +/** + Find an interface whose configured IP address is Ip. + + @param[in] IpSb The IP4 service binding instance + @param[in] Ip The Ip address (host byte order) to find + + @return The IP4_INTERFACE point if found, otherwise NULL + +**/ +IP4_INTERFACE * +Ip4FindInterface ( + IN IP4_SERVICE *IpSb, + IN IP4_ADDR Ip + ); + +/** + Find an interface that Ip is on that connected network. + + @param[in] IpSb The IP4 service binding instance + @param[in] Ip The Ip address (host byte order) to find + + @return The IP4_INTERFACE point if found, otherwise NULL + +**/ +IP4_INTERFACE * +Ip4FindNet ( + IN IP4_SERVICE *IpSb, + IN IP4_ADDR Ip + ); + +/** + Find an interface of the service with the same Ip/Netmask pair. + + @param[in] IpSb Ip4 service binding instance + @param[in] Ip The Ip adress to find (host byte order) + @param[in] Netmask The network to find (host byte order) + + @return The IP4_INTERFACE point if found, otherwise NULL + +**/ +IP4_INTERFACE * +Ip4FindStationAddress ( + IN IP4_SERVICE *IpSb, + IN IP4_ADDR Ip, + IN IP4_ADDR Netmask + ); + +/** + Get the MAC address for a multicast IP address. Call + Mnp's McastIpToMac to find the MAC address in stead of + hard code the NIC to be Ethernet. + + @param[in] Mnp The Mnp instance to get the MAC address. + @param[in] Multicast The multicast IP address to translate. + @param[out] Mac The buffer to hold the translated address. + + @retval EFI_SUCCESS if the multicast IP is successfully translated to a + multicast MAC address. + @retval other Otherwise some error. + +**/ +EFI_STATUS +Ip4GetMulticastMac ( + IN EFI_MANAGED_NETWORK_PROTOCOL *Mnp, + IN IP4_ADDR Multicast, + OUT EFI_MAC_ADDRESS *Mac + ); + +/** + Convert the multibyte field in IP header's byter order. + In spite of its name, it can also be used to convert from + host to network byte order. + + @param[in] Head The IP head to convert + + @return Point to the converted IP head + +**/ +IP4_HEAD * +Ip4NtohHead ( + IN IP4_HEAD *Head + ); + + +/** + Validate that Ip/Netmask pair is OK to be used as station + address. Only continuous netmasks are supported. and check + that StationAddress is a unicast address on the newtwork. + + @param[in] Ip The IP address to validate. + @param[in] Netmask The netmaks of the IP. + + @retval TRUE The Ip/Netmask pair is valid. + @retval FALSE The Ip/Netmask pair is invalid. + +**/ +BOOLEAN +Ip4StationAddressValid ( + IN IP4_ADDR Ip, + IN IP4_ADDR Netmask + ); + +#endif diff --git a/NetworkPkg/Ip4Dxe/Ip4Config2.vfr b/NetworkPkg/Ip4Dxe/Ip4Config2.vfr new file mode 100644 index 0000000000..d85a99180e --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4Config2.vfr @@ -0,0 +1,94 @@ +/** @file + Vfr file for IP4Dxe. + +Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ +#include "Ip4NvData.h" + +#define EFI_NETWORK_DEVICE_CLASS 0x04 + +formset + guid = IP4_CONFIG2_NVDATA_GUID, + title = STRING_TOKEN(STR_IP4_CONFIG2_FORM_TITLE), + help = STRING_TOKEN(STR_IP4_CONFIG2_FORM_HELP), + class = EFI_NETWORK_DEVICE_CLASS, + subclass = 0x03, + + varstore IP4_CONFIG2_IFR_NVDATA, + name = IP4_CONFIG2_IFR_NVDATA, + guid = IP4_CONFIG2_NVDATA_GUID; + + form formid = FORMID_MAIN_FORM, + title = STRING_TOKEN(STR_IP4_DEVICE_FORM_TITLE); + + checkbox varid = IP4_CONFIG2_IFR_NVDATA.Configure, + prompt = STRING_TOKEN(STR_IP4_CONFIGURE), + help = STRING_TOKEN(STR_IP4_CONFIGURE_HELP), + flags = INTERACTIVE, + key = KEY_ENABLE, + endcheckbox; + + suppressif ideqval IP4_CONFIG2_IFR_NVDATA.Configure == 0x00; + + checkbox varid = IP4_CONFIG2_IFR_NVDATA.DhcpEnable, + prompt = STRING_TOKEN(STR_IP4_ENABLE_DHCP), + help = STRING_TOKEN(STR_IP4_ENABLE_DHCP), + flags = INTERACTIVE, + key = KEY_DHCP_ENABLE, + endcheckbox; + endif; + + suppressif ideqval IP4_CONFIG2_IFR_NVDATA.DhcpEnable == 0x01 OR ideqval IP4_CONFIG2_IFR_NVDATA.Configure == 0x00; + + string varid = IP4_CONFIG2_IFR_NVDATA.StationAddress, + prompt = STRING_TOKEN(STR_IP4_LOCAL_IP_ADDRESS), + help = STRING_TOKEN(STR_IP4_IP_ADDRESS_HELP), + flags = INTERACTIVE, + key = KEY_LOCAL_IP, + minsize = IP_MIN_SIZE, + maxsize = IP_MAX_SIZE, + endstring; + + string varid = IP4_CONFIG2_IFR_NVDATA.SubnetMask, + prompt = STRING_TOKEN(STR_IP4_LOCAL_MASK), + help = STRING_TOKEN(STR_IP4_MASK_HELP), + flags = INTERACTIVE, + key = KEY_SUBNET_MASK, + minsize = IP_MIN_SIZE, + maxsize = IP_MAX_SIZE, + endstring; + + string varid = IP4_CONFIG2_IFR_NVDATA.GatewayAddress, + prompt = STRING_TOKEN(STR_IP4_LOCAL_GATEWAY), + help = STRING_TOKEN(STR_IP4_GATEWAY_HELP), + flags = INTERACTIVE, + key = KEY_GATE_WAY, + minsize = IP_MIN_SIZE, + maxsize = IP_MAX_SIZE, + endstring; + + string varid = IP4_CONFIG2_IFR_NVDATA.DnsAddress, + prompt = STRING_TOKEN(STR_IP4_LOCAL_DNS), + help = STRING_TOKEN(STR_IP4_DNS_HELP), + flags = INTERACTIVE, + key = KEY_DNS, + minsize = IP_MIN_SIZE, + maxsize = ADDRESS_STR_MAX_SIZE, + endstring; + + endif; + + subtitle text = STRING_TOKEN(STR_NULL); + + text + help = STRING_TOKEN(STR_SAVE_CHANGES), + text = STRING_TOKEN(STR_SAVE_CHANGES), + flags = INTERACTIVE, + key = KEY_SAVE_CHANGES; + + endform; + +endformset; + diff --git a/NetworkPkg/Ip4Dxe/Ip4Config2Impl.c b/NetworkPkg/Ip4Dxe/Ip4Config2Impl.c new file mode 100644 index 0000000000..9dca48ddd6 --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4Config2Impl.c @@ -0,0 +1,2168 @@ +/** @file + The implementation of EFI IPv4 Configuration II Protocol. + + Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.
+ (C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Ip4Impl.h" + +LIST_ENTRY mIp4Config2InstanceList = {&mIp4Config2InstanceList, &mIp4Config2InstanceList}; + +/** + The event process routine when the DHCPv4 service binding protocol is installed + in the system. + + @param[in] Event Not used. + @param[in] Context Pointer to the IP4 config2 instance data. + +**/ +VOID +EFIAPI +Ip4Config2OnDhcp4SbInstalled ( + IN EFI_EVENT Event, + IN VOID *Context + ); + +/** + Destroy the Dhcp4 child in IP4_CONFIG2_INSTANCE and release the resources. + + @param[in, out] Instance The buffer of IP4 config2 instance to be freed. + + @retval EFI_SUCCESS The child was successfully destroyed. + @retval Others Failed to destroy the child. + +**/ +EFI_STATUS +Ip4Config2DestroyDhcp4 ( + IN OUT IP4_CONFIG2_INSTANCE *Instance + ) +{ + IP4_SERVICE *IpSb; + EFI_STATUS Status; + EFI_DHCP4_PROTOCOL *Dhcp4; + + Dhcp4 = Instance->Dhcp4; + ASSERT (Dhcp4 != NULL); + + Dhcp4->Stop (Dhcp4); + Dhcp4->Configure (Dhcp4, NULL); + Instance->Dhcp4 = NULL; + + IpSb = IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance); + + // + // Close DHCPv4 protocol and destroy the child. + // + Status = gBS->CloseProtocol ( + Instance->Dhcp4Handle, + &gEfiDhcp4ProtocolGuid, + IpSb->Image, + IpSb->Controller + ); + if (EFI_ERROR (Status)) { + return Status; + } + + Status = NetLibDestroyServiceChild ( + IpSb->Controller, + IpSb->Image, + &gEfiDhcp4ServiceBindingProtocolGuid, + Instance->Dhcp4Handle + ); + + Instance->Dhcp4Handle = NULL; + + return Status; +} + +/** + Update the current policy to NewPolicy. During the transition + period, the default router list + and address list in all interfaces will be released. + + @param[in] IpSb The IP4 service binding instance. + @param[in] NewPolicy The new policy to be updated to. + +**/ +VOID +Ip4Config2OnPolicyChanged ( + IN IP4_SERVICE *IpSb, + IN EFI_IP4_CONFIG2_POLICY NewPolicy + ) +{ + IP4_INTERFACE *IpIf; + IP4_ROUTE_TABLE *RouteTable; + + // + // Currently there are only two policies: static and dhcp. Regardless of + // what transition is going on, i.e., static -> dhcp and dhcp -> + // static, we have to free default router table and all addresses. + // + + if (IpSb->DefaultInterface != NULL) { + if (IpSb->DefaultRouteTable != NULL) { + Ip4FreeRouteTable (IpSb->DefaultRouteTable); + IpSb->DefaultRouteTable = NULL; + } + + Ip4CancelReceive (IpSb->DefaultInterface); + + Ip4FreeInterface (IpSb->DefaultInterface, NULL); + IpSb->DefaultInterface = NULL; + } + + Ip4CleanAssembleTable (&IpSb->Assemble); + + // + // Create new default interface and route table. + // + IpIf = Ip4CreateInterface (IpSb->Mnp, IpSb->Controller, IpSb->Image); + if (IpIf == NULL) { + return ; + } + + RouteTable = Ip4CreateRouteTable (); + if (RouteTable == NULL) { + Ip4FreeInterface (IpIf, NULL); + return ; + } + + IpSb->DefaultInterface = IpIf; + InsertHeadList (&IpSb->Interfaces, &IpIf->Link); + IpSb->DefaultRouteTable = RouteTable; + Ip4ReceiveFrame (IpIf, NULL, Ip4AccpetFrame, IpSb); + + if (IpSb->State == IP4_SERVICE_CONFIGED || IpSb->State == IP4_SERVICE_STARTED) { + IpSb->State = IP4_SERVICE_UNSTARTED; + } + + // + // Start the dhcp configuration. + // + if (NewPolicy == Ip4Config2PolicyDhcp) { + Ip4StartAutoConfig (&IpSb->Ip4Config2Instance); + } + +} + +/** + Signal the registered event. It is the callback routine for NetMapIterate. + + @param[in] Map Points to the list of registered event. + @param[in] Item The registered event. + @param[in] Arg Not used. + + @retval EFI_SUCCESS The event was signaled successfully. +**/ +EFI_STATUS +EFIAPI +Ip4Config2SignalEvent ( + IN NET_MAP *Map, + IN NET_MAP_ITEM *Item, + IN VOID *Arg + ) +{ + gBS->SignalEvent ((EFI_EVENT) Item->Key); + + return EFI_SUCCESS; +} + +/** + Read the configuration data from variable storage according to the VarName and + gEfiIp4Config2ProtocolGuid. It checks the integrity of variable data. If the + data is corrupted, it clears the variable data to ZERO. Othewise, it outputs the + configuration data to IP4_CONFIG2_INSTANCE. + + @param[in] VarName The pointer to the variable name + @param[in, out] Instance The pointer to the IP4 config2 instance data. + + @retval EFI_NOT_FOUND The variable can not be found or already corrupted. + @retval EFI_OUT_OF_RESOURCES Fail to allocate resource to complete the operation. + @retval EFI_SUCCESS The configuration data was retrieved successfully. + +**/ +EFI_STATUS +Ip4Config2ReadConfigData ( + IN CHAR16 *VarName, + IN OUT IP4_CONFIG2_INSTANCE *Instance + ) +{ + EFI_STATUS Status; + UINTN VarSize; + IP4_CONFIG2_VARIABLE *Variable; + IP4_CONFIG2_DATA_ITEM *DataItem; + UINTN Index; + IP4_CONFIG2_DATA_RECORD DataRecord; + CHAR8 *Data; + + // + // Try to read the configuration variable. + // + VarSize = 0; + Status = gRT->GetVariable ( + VarName, + &gEfiIp4Config2ProtocolGuid, + NULL, + &VarSize, + NULL + ); + + if (Status == EFI_BUFFER_TOO_SMALL) { + // + // Allocate buffer and read the config variable. + // + Variable = AllocatePool (VarSize); + if (Variable == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + Status = gRT->GetVariable ( + VarName, + &gEfiIp4Config2ProtocolGuid, + NULL, + &VarSize, + Variable + ); + if (EFI_ERROR (Status) || (UINT16) (~NetblockChecksum ((UINT8 *) Variable, (UINT32) VarSize)) != 0) { + // + // GetVariable still error or the variable is corrupted. + // Fall back to the default value. + // + FreePool (Variable); + + // + // Remove the problematic variable and return EFI_NOT_FOUND, a new + // variable will be set again. + // + gRT->SetVariable ( + VarName, + &gEfiIp4Config2ProtocolGuid, + IP4_CONFIG2_VARIABLE_ATTRIBUTE, + 0, + NULL + ); + + return EFI_NOT_FOUND; + } + + + for (Index = 0; Index < Variable->DataRecordCount; Index++) { + + CopyMem (&DataRecord, &Variable->DataRecord[Index], sizeof (DataRecord)); + + DataItem = &Instance->DataItem[DataRecord.DataType]; + if (DATA_ATTRIB_SET (DataItem->Attribute, DATA_ATTRIB_SIZE_FIXED) && + (DataItem->DataSize != DataRecord.DataSize) + ) { + // + // Perhaps a corrupted data record... + // + continue; + } + + if (!DATA_ATTRIB_SET (DataItem->Attribute, DATA_ATTRIB_SIZE_FIXED)) { + // + // This data item has variable length data. + // + DataItem->Data.Ptr = AllocatePool (DataRecord.DataSize); + if (DataItem->Data.Ptr == NULL) { + // + // no memory resource + // + continue; + } + } + + Data = (CHAR8 *) Variable + DataRecord.Offset; + CopyMem (DataItem->Data.Ptr, Data, DataRecord.DataSize); + + DataItem->DataSize = DataRecord.DataSize; + DataItem->Status = EFI_SUCCESS; + } + + FreePool (Variable); + return EFI_SUCCESS; + } + + return Status; +} + +/** + Write the configuration data from IP4_CONFIG2_INSTANCE to variable storage. + + @param[in] VarName The pointer to the variable name. + @param[in] Instance The pointer to the IP4 config2 instance data. + + @retval EFI_OUT_OF_RESOURCES Fail to allocate resource to complete the operation. + @retval EFI_SUCCESS The configuration data is written successfully. + +**/ +EFI_STATUS +Ip4Config2WriteConfigData ( + IN CHAR16 *VarName, + IN IP4_CONFIG2_INSTANCE *Instance + ) +{ + UINTN Index; + UINTN VarSize; + IP4_CONFIG2_DATA_ITEM *DataItem; + IP4_CONFIG2_VARIABLE *Variable; + IP4_CONFIG2_DATA_RECORD *DataRecord; + CHAR8 *Heap; + EFI_STATUS Status; + + VarSize = sizeof (IP4_CONFIG2_VARIABLE) - sizeof (IP4_CONFIG2_DATA_RECORD); + + for (Index = 0; Index < Ip4Config2DataTypeMaximum; Index++) { + + DataItem = &Instance->DataItem[Index]; + if (!DATA_ATTRIB_SET (DataItem->Attribute, DATA_ATTRIB_VOLATILE) && !EFI_ERROR (DataItem->Status)) { + + VarSize += sizeof (IP4_CONFIG2_DATA_RECORD) + DataItem->DataSize; + } + } + + Variable = AllocatePool (VarSize); + if (Variable == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + Heap = (CHAR8 *) Variable + VarSize; + Variable->DataRecordCount = 0; + + for (Index = 0; Index < Ip4Config2DataTypeMaximum; Index++) { + + DataItem = &Instance->DataItem[Index]; + if (!DATA_ATTRIB_SET (DataItem->Attribute, DATA_ATTRIB_VOLATILE) && !EFI_ERROR (DataItem->Status)) { + + Heap -= DataItem->DataSize; + CopyMem (Heap, DataItem->Data.Ptr, DataItem->DataSize); + + DataRecord = &Variable->DataRecord[Variable->DataRecordCount]; + DataRecord->DataType = (EFI_IP4_CONFIG2_DATA_TYPE) Index; + DataRecord->DataSize = (UINT32) DataItem->DataSize; + DataRecord->Offset = (UINT16) (Heap - (CHAR8 *) Variable); + + Variable->DataRecordCount++; + } + } + + Variable->Checksum = 0; + Variable->Checksum = (UINT16) ~NetblockChecksum ((UINT8 *) Variable, (UINT32) VarSize); + + Status = gRT->SetVariable ( + VarName, + &gEfiIp4Config2ProtocolGuid, + IP4_CONFIG2_VARIABLE_ATTRIBUTE, + VarSize, + Variable + ); + + FreePool (Variable); + + return Status; +} + + +/** + Build a EFI_IP4_ROUTE_TABLE to be returned to the caller of GetModeData. + The EFI_IP4_ROUTE_TABLE is clumsy to use in the internal operation of the + IP4 driver. + + @param[in] IpSb The IP4 service binding instance. + @param[out] Table The built IP4 route table. + + @retval EFI_SUCCESS The route table is successfully build + @retval EFI_NOT_FOUND Failed to allocate the memory for the rotue table. + +**/ +EFI_STATUS +Ip4Config2BuildDefaultRouteTable ( + IN IP4_SERVICE *IpSb, + OUT EFI_IP4_ROUTE_TABLE *Table + ) +{ + LIST_ENTRY *Entry; + IP4_ROUTE_ENTRY *RtEntry; + UINT32 Count; + INT32 Index; + + if (IpSb->DefaultRouteTable == NULL) { + return EFI_NOT_FOUND; + } + + Count = IpSb->DefaultRouteTable->TotalNum; + + if (Count == 0) { + return EFI_NOT_FOUND; + } + + // + // Copy the route entry to EFI route table. Keep the order of + // route entry copied from most specific to default route. That + // is, interlevel the route entry from the instance's route area + // and those from the default route table's route area. + // + Count = 0; + + for (Index = IP4_MASK_MAX; Index >= 0; Index--) { + + NET_LIST_FOR_EACH (Entry, &(IpSb->DefaultRouteTable->RouteArea[Index])) { + RtEntry = NET_LIST_USER_STRUCT (Entry, IP4_ROUTE_ENTRY, Link); + + EFI_IP4 (Table[Count].SubnetAddress) = HTONL (RtEntry->Dest & RtEntry->Netmask); + EFI_IP4 (Table[Count].SubnetMask) = HTONL (RtEntry->Netmask); + EFI_IP4 (Table[Count].GatewayAddress) = HTONL (RtEntry->NextHop); + + Count++; + } + + } + + return EFI_SUCCESS; +} + +/** + The event process routine when the DHCPv4 service binding protocol is installed + in the system. + + @param[in] Event Not used. + @param[in] Context The pointer to the IP4 config2 instance data. + +**/ +VOID +EFIAPI +Ip4Config2OnDhcp4SbInstalled ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + IP4_CONFIG2_INSTANCE *Instance; + + Instance = (IP4_CONFIG2_INSTANCE *) Context; + + if ((Instance->Dhcp4Handle != NULL) || (Instance->Policy != Ip4Config2PolicyDhcp)) { + // + // The DHCP4 child is already created or the policy is no longer DHCP. + // + return ; + } + + Ip4StartAutoConfig (Instance); +} + +/** + Set the station address and subnetmask for the default interface. + + @param[in] IpSb The pointer to the IP4 service binding instance. + @param[in] StationAddress Ip address to be set. + @param[in] SubnetMask Subnet to be set. + + @retval EFI_SUCCESS Set default address successful. + @retval Others Some errors occur in setting. + +**/ +EFI_STATUS +Ip4Config2SetDefaultAddr ( + IN IP4_SERVICE *IpSb, + IN IP4_ADDR StationAddress, + IN IP4_ADDR SubnetMask + ) +{ + EFI_STATUS Status; + IP4_INTERFACE *IpIf; + IP4_PROTOCOL *Ip4Instance; + EFI_ARP_PROTOCOL *Arp; + LIST_ENTRY *Entry; + IP4_ADDR Subnet; + IP4_ROUTE_TABLE *RouteTable; + + IpIf = IpSb->DefaultInterface; + ASSERT (IpIf != NULL); + + if ((IpIf->Ip == StationAddress) && (IpIf->SubnetMask == SubnetMask)) { + IpSb->State = IP4_SERVICE_CONFIGED; + return EFI_SUCCESS; + } + + if (IpSb->Reconfig) { + // + // The default address is changed, free the previous interface first. + // + if (IpSb->DefaultRouteTable != NULL) { + Ip4FreeRouteTable (IpSb->DefaultRouteTable); + IpSb->DefaultRouteTable = NULL; + } + + Ip4CancelReceive (IpSb->DefaultInterface); + Ip4FreeInterface (IpSb->DefaultInterface, NULL); + IpSb->DefaultInterface = NULL; + // + // Create new default interface and route table. + // + IpIf = Ip4CreateInterface (IpSb->Mnp, IpSb->Controller, IpSb->Image); + if (IpIf == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + RouteTable = Ip4CreateRouteTable (); + if (RouteTable == NULL) { + Ip4FreeInterface (IpIf, NULL); + return EFI_OUT_OF_RESOURCES; + } + + IpSb->DefaultInterface = IpIf; + InsertHeadList (&IpSb->Interfaces, &IpIf->Link); + IpSb->DefaultRouteTable = RouteTable; + Ip4ReceiveFrame (IpIf, NULL, Ip4AccpetFrame, IpSb); + } + + if (IpSb->State == IP4_SERVICE_CONFIGED) { + IpSb->State = IP4_SERVICE_UNSTARTED; + } + + Status = Ip4SetAddress (IpIf, StationAddress, SubnetMask); + if (EFI_ERROR (Status)) { + return Status; + } + + if (IpIf->Arp != NULL) { + // + // A non-NULL IpIf->Arp here means a new ARP child is created when setting default address, + // but some IP children may have referenced the default interface before it is configured, + // these IP instances also consume this ARP protocol so they need to open it BY_CHILD_CONTROLLER. + // + Arp = NULL; + NET_LIST_FOR_EACH (Entry, &IpIf->IpInstances) { + Ip4Instance = NET_LIST_USER_STRUCT_S (Entry, IP4_PROTOCOL, AddrLink, IP4_PROTOCOL_SIGNATURE); + Status = gBS->OpenProtocol ( + IpIf->ArpHandle, + &gEfiArpProtocolGuid, + (VOID **) &Arp, + gIp4DriverBinding.DriverBindingHandle, + Ip4Instance->Handle, + EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER + ); + if (EFI_ERROR (Status)) { + return Status; + } + } + } + + // + // Add a route for the connected network. + // + Subnet = StationAddress & SubnetMask; + + Ip4AddRoute ( + IpSb->DefaultRouteTable, + Subnet, + SubnetMask, + IP4_ALLZERO_ADDRESS + ); + + IpSb->State = IP4_SERVICE_CONFIGED; + IpSb->Reconfig = FALSE; + + return EFI_SUCCESS; +} + +/** + Set the station address, subnetmask and gateway address for the default interface. + + @param[in] Instance The pointer to the IP4 config2 instance data. + @param[in] StationAddress Ip address to be set. + @param[in] SubnetMask Subnet to be set. + @param[in] GatewayAddress Gateway to be set. + + @retval EFI_SUCCESS Set default If successful. + @retval Others Errors occur as indicated. + +**/ +EFI_STATUS +Ip4Config2SetDefaultIf ( + IN IP4_CONFIG2_INSTANCE *Instance, + IN IP4_ADDR StationAddress, + IN IP4_ADDR SubnetMask, + IN IP4_ADDR GatewayAddress + ) +{ + EFI_STATUS Status; + IP4_SERVICE *IpSb; + + IpSb = IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance); + + // + // Check whether the StationAddress/SubnetMask pair is valid. + // + if (!Ip4StationAddressValid (StationAddress, SubnetMask)) { + return EFI_INVALID_PARAMETER; + } + + Status = Ip4Config2SetDefaultAddr (IpSb, StationAddress, SubnetMask); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Create a route if there is a default router. + // + if (GatewayAddress != IP4_ALLZERO_ADDRESS) { + Ip4AddRoute ( + IpSb->DefaultRouteTable, + IP4_ALLZERO_ADDRESS, + IP4_ALLZERO_ADDRESS, + GatewayAddress + ); + } + + return EFI_SUCCESS; +} + + +/** + Release all the DHCP related resources. + + @param Instance The IP4 config2 instance. + + @return None + +**/ +VOID +Ip4Config2CleanDhcp4 ( + IN IP4_CONFIG2_INSTANCE *Instance + ) +{ + IP4_SERVICE *IpSb; + + IpSb = IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance); + + if (Instance->Dhcp4 != NULL) { + Instance->Dhcp4->Stop (Instance->Dhcp4); + + gBS->CloseProtocol ( + Instance->Dhcp4Handle, + &gEfiDhcp4ProtocolGuid, + IpSb->Image, + IpSb->Controller + ); + + Instance->Dhcp4 = NULL; + } + + if (Instance->Dhcp4Handle != NULL) { + NetLibDestroyServiceChild ( + IpSb->Controller, + IpSb->Image, + &gEfiDhcp4ServiceBindingProtocolGuid, + Instance->Dhcp4Handle + ); + + Instance->Dhcp4Handle = NULL; + } + + if (Instance->Dhcp4Event != NULL) { + gBS->CloseEvent (Instance->Dhcp4Event); + Instance->Dhcp4Event = NULL; + } +} + +/** + This worker function sets the DNS server list for the EFI IPv4 network + stack running on the communication device that this EFI_IP4_CONFIG2_PROTOCOL + manages. The DNS server addresses must be unicast IPv4 addresses. + + @param[in] Instance The pointer to the IP4 config2 instance data. + @param[in] DataSize The size of the buffer pointed to by Data in bytes. + @param[in] Data The data buffer to set, points to an array of + EFI_IPv4_ADDRESS instances. + + @retval EFI_BAD_BUFFER_SIZE The DataSize does not match the size of the type. + @retval EFI_INVALID_PARAMETER One or more fields in Data is invalid. + @retval EFI_OUT_OF_RESOURCES Failed to allocate resources to complete the operation. + @retval EFI_ABORTED The DNS server addresses to be set equal the current + configuration. + @retval EFI_SUCCESS The specified configuration data for the EFI IPv4 + network stack was set. + +**/ +EFI_STATUS +Ip4Config2SetDnsServerWorker ( + IN IP4_CONFIG2_INSTANCE *Instance, + IN UINTN DataSize, + IN VOID *Data + ) +{ + UINTN OldIndex; + UINTN NewIndex; + EFI_IPv4_ADDRESS *OldDns; + EFI_IPv4_ADDRESS *NewDns; + UINTN OldDnsCount; + UINTN NewDnsCount; + IP4_CONFIG2_DATA_ITEM *Item; + BOOLEAN OneAdded; + VOID *Tmp; + IP4_ADDR DnsAddress; + + if ((DataSize % sizeof (EFI_IPv4_ADDRESS) != 0) || (DataSize == 0)) { + return EFI_BAD_BUFFER_SIZE; + } + + Item = &Instance->DataItem[Ip4Config2DataTypeDnsServer]; + NewDns = (EFI_IPv4_ADDRESS *) Data; + OldDns = Item->Data.DnsServers; + NewDnsCount = DataSize / sizeof (EFI_IPv4_ADDRESS); + OldDnsCount = Item->DataSize / sizeof (EFI_IPv4_ADDRESS); + OneAdded = FALSE; + + if (NewDnsCount != OldDnsCount) { + Tmp = AllocatePool (DataSize); + if (Tmp == NULL) { + return EFI_OUT_OF_RESOURCES; + } + } else { + Tmp = NULL; + } + + for (NewIndex = 0; NewIndex < NewDnsCount; NewIndex++) { + CopyMem (&DnsAddress, NewDns + NewIndex, sizeof (IP4_ADDR)); + if (IP4_IS_UNSPECIFIED (NTOHL (DnsAddress)) || IP4_IS_LOCAL_BROADCAST (NTOHL (DnsAddress))) { + // + // The dns server address must be unicast. + // + if (Tmp != NULL) { + FreePool (Tmp); + } + return EFI_INVALID_PARAMETER; + } + + if (OneAdded) { + // + // If any address in the new setting is not in the old settings, skip the + // comparision below. + // + continue; + } + + for (OldIndex = 0; OldIndex < OldDnsCount; OldIndex++) { + if (EFI_IP4_EQUAL (NewDns + NewIndex, OldDns + OldIndex)) { + // + // If found break out. + // + break; + } + } + + if (OldIndex == OldDnsCount) { + OneAdded = TRUE; + } + } + + if (!OneAdded && (DataSize == Item->DataSize)) { + // + // No new item is added and the size is the same. + // + Item->Status = EFI_SUCCESS; + return EFI_ABORTED; + } else { + if (Tmp != NULL) { + if (Item->Data.Ptr != NULL) { + FreePool (Item->Data.Ptr); + } + Item->Data.Ptr = Tmp; + } + + CopyMem (Item->Data.Ptr, Data, DataSize); + Item->DataSize = DataSize; + Item->Status = EFI_SUCCESS; + return EFI_SUCCESS; + } +} + + + +/** + Callback function when DHCP process finished. It will save the + retrieved IP configure parameter from DHCP to the NVRam. + + @param Event The callback event + @param Context Opaque context to the callback + + @return None + +**/ +VOID +EFIAPI +Ip4Config2OnDhcp4Complete ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + IP4_CONFIG2_INSTANCE *Instance; + EFI_DHCP4_MODE_DATA Dhcp4Mode; + EFI_STATUS Status; + IP4_ADDR StationAddress; + IP4_ADDR SubnetMask; + IP4_ADDR GatewayAddress; + UINT32 Index; + UINT32 OptionCount; + EFI_DHCP4_PACKET_OPTION **OptionList; + + Instance = (IP4_CONFIG2_INSTANCE *) Context; + ASSERT (Instance->Dhcp4 != NULL); + + // + // Get the DHCP retrieved parameters + // + Status = Instance->Dhcp4->GetModeData (Instance->Dhcp4, &Dhcp4Mode); + + if (EFI_ERROR (Status)) { + goto Exit; + } + + if (Dhcp4Mode.State == Dhcp4Bound) { + StationAddress = EFI_NTOHL (Dhcp4Mode.ClientAddress); + SubnetMask = EFI_NTOHL (Dhcp4Mode.SubnetMask); + GatewayAddress = EFI_NTOHL (Dhcp4Mode.RouterAddress); + + Status = Ip4Config2SetDefaultIf (Instance, StationAddress, SubnetMask, GatewayAddress); + if (EFI_ERROR (Status)) { + goto Exit; + } + + // + // Parse the ACK to get required DNS server information. + // + OptionCount = 0; + OptionList = NULL; + + Status = Instance->Dhcp4->Parse (Instance->Dhcp4, Dhcp4Mode.ReplyPacket, &OptionCount, OptionList); + if (Status != EFI_BUFFER_TOO_SMALL) { + goto Exit; + } + + OptionList = AllocateZeroPool (OptionCount * sizeof (EFI_DHCP4_PACKET_OPTION *)); + if (OptionList == NULL) { + goto Exit; + } + + Status = Instance->Dhcp4->Parse (Instance->Dhcp4, Dhcp4Mode.ReplyPacket, &OptionCount, OptionList); + if (EFI_ERROR (Status)) { + FreePool (OptionList); + goto Exit; + } + + for (Index = 0; Index < OptionCount; Index++) { + // + // Look for DNS Server opcode (6). + // + if (OptionList[Index]->OpCode == DHCP4_TAG_DNS_SERVER) { + if (((OptionList[Index]->Length & 0x3) != 0) || (OptionList[Index]->Length == 0)) { + break; + } + + Ip4Config2SetDnsServerWorker (Instance, OptionList[Index]->Length, &OptionList[Index]->Data[0]); + break; + } + } + + FreePool (OptionList); + + Instance->DhcpSuccess = TRUE; + } + +Exit: + Ip4Config2CleanDhcp4 (Instance); + DispatchDpc (); +} + + +/** + Start the DHCP configuration for this IP service instance. + It will locates the EFI_IP4_CONFIG2_PROTOCOL, then start the + DHCP configuration. + + @param[in] Instance The IP4 config2 instance to configure + + @retval EFI_SUCCESS The auto configuration is successfully started + @retval Others Failed to start auto configuration. + +**/ +EFI_STATUS +Ip4StartAutoConfig ( + IN IP4_CONFIG2_INSTANCE *Instance + ) +{ + IP4_SERVICE *IpSb; + EFI_DHCP4_PROTOCOL *Dhcp4; + EFI_DHCP4_MODE_DATA Dhcp4Mode; + EFI_DHCP4_PACKET_OPTION *OptionList[1]; + IP4_CONFIG2_DHCP4_OPTION ParaList; + EFI_STATUS Status; + + IpSb = IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance); + + if (IpSb->State > IP4_SERVICE_UNSTARTED) { + return EFI_SUCCESS; + } + + // + // A host must not invoke DHCP configuration if it is already + // participating in the DHCP configuraiton process. + // + if (Instance->Dhcp4Handle != NULL) { + return EFI_SUCCESS; + } + + Status = NetLibCreateServiceChild ( + IpSb->Controller, + IpSb->Image, + &gEfiDhcp4ServiceBindingProtocolGuid, + &Instance->Dhcp4Handle + ); + + if (Status == EFI_UNSUPPORTED) { + // + // No DHCPv4 Service Binding protocol, register a notify. + // + if (Instance->Dhcp4SbNotifyEvent == NULL) { + Instance->Dhcp4SbNotifyEvent = EfiCreateProtocolNotifyEvent ( + &gEfiDhcp4ServiceBindingProtocolGuid, + TPL_CALLBACK, + Ip4Config2OnDhcp4SbInstalled, + (VOID *) Instance, + &Instance->Registration + ); + } + } + + if (EFI_ERROR (Status)) { + return Status; + } + + if (Instance->Dhcp4SbNotifyEvent != NULL) { + gBS->CloseEvent (Instance->Dhcp4SbNotifyEvent); + } + + Status = gBS->OpenProtocol ( + Instance->Dhcp4Handle, + &gEfiDhcp4ProtocolGuid, + (VOID **) &Instance->Dhcp4, + IpSb->Image, + IpSb->Controller, + EFI_OPEN_PROTOCOL_BY_DRIVER + ); + if (EFI_ERROR (Status)) { + NetLibDestroyServiceChild ( + IpSb->Controller, + IpSb->Image, + &gEfiDhcp4ServiceBindingProtocolGuid, + Instance->Dhcp4Handle + ); + + Instance->Dhcp4Handle = NULL; + + return Status; + } + + // + // Check the current DHCP status, if the DHCP process has + // already finished, return now. + // + Dhcp4 = Instance->Dhcp4; + Status = Dhcp4->GetModeData (Dhcp4, &Dhcp4Mode); + if (Dhcp4Mode.State == Dhcp4Bound) { + Ip4Config2OnDhcp4Complete (NULL, Instance); + + return EFI_SUCCESS; + } + + // + // Try to start the DHCP process. Use most of the current + // DHCP configuration to avoid problems if some DHCP client + // yields the control of this DHCP service to us. + // + ParaList.Head.OpCode = DHCP4_TAG_PARA_LIST; + ParaList.Head.Length = 3; + ParaList.Head.Data[0] = DHCP4_TAG_NETMASK; + ParaList.Route = DHCP4_TAG_ROUTER; + ParaList.Dns = DHCP4_TAG_DNS_SERVER; + OptionList[0] = &ParaList.Head; + Dhcp4Mode.ConfigData.OptionCount = 1; + Dhcp4Mode.ConfigData.OptionList = OptionList; + + Status = Dhcp4->Configure (Dhcp4, &Dhcp4Mode.ConfigData); + if (EFI_ERROR (Status)) { + gBS->CloseProtocol ( + Instance->Dhcp4Handle, + &gEfiDhcp4ProtocolGuid, + IpSb->Image, + IpSb->Controller + ); + + NetLibDestroyServiceChild ( + IpSb->Controller, + IpSb->Image, + &gEfiDhcp4ServiceBindingProtocolGuid, + Instance->Dhcp4Handle + ); + + Instance->Dhcp4 = NULL; + + Instance->Dhcp4Handle = NULL; + + return Status; + } + + // + // Start the DHCP process + // + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL, + TPL_CALLBACK, + Ip4Config2OnDhcp4Complete, + Instance, + &Instance->Dhcp4Event + ); + if (EFI_ERROR (Status)) { + Ip4Config2DestroyDhcp4 (Instance); + return Status; + } + + Status = Dhcp4->Start (Dhcp4, Instance->Dhcp4Event); + if (EFI_ERROR (Status)) { + Ip4Config2DestroyDhcp4 (Instance); + gBS->CloseEvent (Instance->Dhcp4Event); + Instance->Dhcp4Event = NULL; + + return Status; + } + + IpSb->State = IP4_SERVICE_STARTED; + DispatchDpc (); + + return EFI_SUCCESS; +} + + + +/** + The work function is to get the interface information of the communication + device this IP4_CONFIG2_INSTANCE manages. + + @param[in] Instance Pointer to the IP4 config2 instance data. + @param[in, out] DataSize On input, in bytes, the size of Data. On output, in + bytes, the size of buffer required to store the specified + configuration data. + @param[in] Data The data buffer in which the configuration data is returned. + Ignored if DataSize is ZERO. + + @retval EFI_BUFFER_TOO_SMALL The size of Data is too small for the specified + configuration data, and the required size is + returned in DataSize. + @retval EFI_SUCCESS The specified configuration data was obtained. + +**/ +EFI_STATUS +Ip4Config2GetIfInfo ( + IN IP4_CONFIG2_INSTANCE *Instance, + IN OUT UINTN *DataSize, + IN VOID *Data OPTIONAL + ) +{ + IP4_SERVICE *IpSb; + UINTN Length; + IP4_CONFIG2_DATA_ITEM *Item; + EFI_IP4_CONFIG2_INTERFACE_INFO *IfInfo; + IP4_ADDR Address; + + IpSb = IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance); + Length = sizeof (EFI_IP4_CONFIG2_INTERFACE_INFO); + + if (IpSb->DefaultRouteTable != NULL) { + Length += IpSb->DefaultRouteTable->TotalNum * sizeof (EFI_IP4_ROUTE_TABLE); + } + + if (*DataSize < Length) { + *DataSize = Length; + return EFI_BUFFER_TOO_SMALL; + } + + // + // Copy the fixed size part of the interface info. + // + Item = &Instance->DataItem[Ip4Config2DataTypeInterfaceInfo]; + IfInfo = (EFI_IP4_CONFIG2_INTERFACE_INFO *) Data; + CopyMem (IfInfo, Item->Data.Ptr, sizeof (EFI_IP4_CONFIG2_INTERFACE_INFO)); + + // + // Update the address info. + // + if (IpSb->DefaultInterface != NULL) { + Address = HTONL (IpSb->DefaultInterface->Ip); + CopyMem (&IfInfo->StationAddress, &Address, sizeof (EFI_IPv4_ADDRESS)); + Address = HTONL (IpSb->DefaultInterface->SubnetMask); + CopyMem (&IfInfo->SubnetMask, &Address, sizeof (EFI_IPv4_ADDRESS)); + } + + if (IpSb->DefaultRouteTable != NULL) { + IfInfo->RouteTableSize = IpSb->DefaultRouteTable->TotalNum; + IfInfo->RouteTable = (EFI_IP4_ROUTE_TABLE *) ((UINT8 *) Data + sizeof (EFI_IP4_CONFIG2_INTERFACE_INFO)); + + Ip4Config2BuildDefaultRouteTable (IpSb, IfInfo->RouteTable); + } + + return EFI_SUCCESS; +} + +/** + The work function is to set the general configuration policy for the EFI IPv4 network + stack that is running on the communication device managed by this IP4_CONFIG2_INSTANCE. + The policy will affect other configuration settings. + + @param[in] Instance Pointer to the IP4 config2 instance data. + @param[in] DataSize Size of the buffer pointed to by Data in bytes. + @param[in] Data The data buffer to set. + + @retval EFI_INVALID_PARAMETER The to be set policy is invalid. + @retval EFI_BAD_BUFFER_SIZE The DataSize does not match the size of the type. + @retval EFI_ABORTED The new policy equals the current policy. + @retval EFI_SUCCESS The specified configuration data for the EFI IPv6 + network stack was set. + +**/ +EFI_STATUS +Ip4Config2SetPolicy ( + IN IP4_CONFIG2_INSTANCE *Instance, + IN UINTN DataSize, + IN VOID *Data + ) +{ + EFI_IP4_CONFIG2_POLICY NewPolicy; + IP4_CONFIG2_DATA_ITEM *DataItem; + IP4_SERVICE *IpSb; + + if (DataSize != sizeof (EFI_IP4_CONFIG2_POLICY)) { + return EFI_BAD_BUFFER_SIZE; + } + + NewPolicy = *((EFI_IP4_CONFIG2_POLICY *) Data); + + if (NewPolicy >= Ip4Config2PolicyMax) { + return EFI_INVALID_PARAMETER; + } + + if (NewPolicy == Instance->Policy) { + if (NewPolicy != Ip4Config2PolicyDhcp || Instance->DhcpSuccess) { + return EFI_ABORTED; + } + } else { + // + // The policy is changed. Clean the ManualAddress, Gateway and DnsServers, + // shrink the variable data size, and fire up all the related events. + // + DataItem = &Instance->DataItem[Ip4Config2DataTypeManualAddress]; + if (DataItem->Data.Ptr != NULL) { + FreePool (DataItem->Data.Ptr); + } + DataItem->Data.Ptr = NULL; + DataItem->DataSize = 0; + DataItem->Status = EFI_NOT_FOUND; + NetMapIterate (&DataItem->EventMap, Ip4Config2SignalEvent, NULL); + + DataItem = &Instance->DataItem[Ip4Config2DataTypeGateway]; + if (DataItem->Data.Ptr != NULL) { + FreePool (DataItem->Data.Ptr); + } + DataItem->Data.Ptr = NULL; + DataItem->DataSize = 0; + DataItem->Status = EFI_NOT_FOUND; + NetMapIterate (&DataItem->EventMap, Ip4Config2SignalEvent, NULL); + + DataItem = &Instance->DataItem[Ip4Config2DataTypeDnsServer]; + if (DataItem->Data.Ptr != NULL) { + FreePool (DataItem->Data.Ptr); + } + DataItem->Data.Ptr = NULL; + DataItem->DataSize = 0; + DataItem->Status = EFI_NOT_FOUND; + NetMapIterate (&DataItem->EventMap, Ip4Config2SignalEvent, NULL); + + if (NewPolicy == Ip4Config2PolicyDhcp) { + SET_DATA_ATTRIB (DataItem->Attribute, DATA_ATTRIB_VOLATILE); + } else { + // + // The policy is changed from dhcp to static. Stop the DHCPv4 process + // and destroy the DHCPv4 child. + // + if (Instance->Dhcp4Handle != NULL) { + Ip4Config2DestroyDhcp4 (Instance); + } + + // + // Close the event. + // + if (Instance->Dhcp4Event != NULL) { + gBS->CloseEvent (Instance->Dhcp4Event); + Instance->Dhcp4Event = NULL; + } + } + } + + IpSb = IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance); + Ip4Config2OnPolicyChanged (IpSb, NewPolicy); + + Instance->Policy = NewPolicy; + + return EFI_SUCCESS; +} + +/** + The work function is to set the station addresses manually for the EFI IPv4 + network stack. It is only configurable when the policy is Ip4Config2PolicyStatic. + + @param[in] Instance Pointer to the IP4 config2 instance data. + @param[in] DataSize Size of the buffer pointed to by Data in bytes. + @param[in] Data The data buffer to set. + + @retval EFI_BAD_BUFFER_SIZE The DataSize does not match the size of the type. + @retval EFI_WRITE_PROTECTED The specified configuration data cannot be set + under the current policy. + @retval EFI_INVALID_PARAMETER One or more fields in Data is invalid. + @retval EFI_OUT_OF_RESOURCES Fail to allocate resource to complete the operation. + @retval EFI_NOT_READY An asynchrous process is invoked to set the specified + configuration data, and the process is not finished. + @retval EFI_ABORTED The manual addresses to be set equal current + configuration. + @retval EFI_SUCCESS The specified configuration data for the EFI IPv6 + network stack was set. + +**/ +EFI_STATUS +Ip4Config2SetManualAddress ( + IN IP4_CONFIG2_INSTANCE *Instance, + IN UINTN DataSize, + IN VOID *Data + ) +{ + EFI_IP4_CONFIG2_MANUAL_ADDRESS NewAddress; + IP4_CONFIG2_DATA_ITEM *DataItem; + EFI_STATUS Status; + IP4_ADDR StationAddress; + IP4_ADDR SubnetMask; + VOID *Ptr; + IP4_SERVICE *IpSb; + IP4_INTERFACE *IpIf; + IP4_ROUTE_TABLE *RouteTable; + + DataItem = NULL; + Status = EFI_SUCCESS; + Ptr = NULL; + IpIf = NULL; + RouteTable = NULL; + + IpSb = IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance); + + ASSERT (Instance->DataItem[Ip4Config2DataTypeManualAddress].Status != EFI_NOT_READY); + + if ((DataSize != 0) && ((DataSize % sizeof (EFI_IP4_CONFIG2_MANUAL_ADDRESS)) != 0)) { + return EFI_BAD_BUFFER_SIZE; + } + + if (Instance->Policy != Ip4Config2PolicyStatic) { + return EFI_WRITE_PROTECTED; + } + + DataItem = &Instance->DataItem[Ip4Config2DataTypeManualAddress]; + + if (Data != NULL && DataSize != 0) { + NewAddress = *((EFI_IP4_CONFIG2_MANUAL_ADDRESS *) Data); + + StationAddress = EFI_NTOHL (NewAddress.Address); + SubnetMask = EFI_NTOHL (NewAddress.SubnetMask); + + // + // Check whether the StationAddress/SubnetMask pair is valid. + // + if (!Ip4StationAddressValid (StationAddress, SubnetMask)) { + return EFI_INVALID_PARAMETER; + } + + // + // Store the new data, and init the DataItem status to EFI_NOT_READY because + // we may have an asynchronous configuration process. + // + Ptr = AllocateCopyPool (DataSize, Data); + if (Ptr == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + if (DataItem->Data.Ptr != NULL) { + FreePool (DataItem->Data.Ptr); + } + + DataItem->Data.Ptr = Ptr; + DataItem->DataSize = DataSize; + DataItem->Status = EFI_NOT_READY; + + IpSb->Reconfig = TRUE; + Status = Ip4Config2SetDefaultAddr (IpSb, StationAddress, SubnetMask); + + DataItem->Status = Status; + + if (EFI_ERROR (DataItem->Status) && DataItem->Status != EFI_NOT_READY) { + if (Ptr != NULL) { + FreePool (Ptr); + } + DataItem->Data.Ptr = NULL; + } + } else { + // + // DataSize is 0 and Data is NULL, clean up the manual address. + // + if (DataItem->Data.Ptr != NULL) { + FreePool (DataItem->Data.Ptr); + } + DataItem->Data.Ptr = NULL; + DataItem->DataSize = 0; + DataItem->Status = EFI_NOT_FOUND; + + // + // Free the default router table and Interface, clean up the assemble table. + // + if (IpSb->DefaultInterface != NULL) { + if (IpSb->DefaultRouteTable != NULL) { + Ip4FreeRouteTable (IpSb->DefaultRouteTable); + IpSb->DefaultRouteTable = NULL; + } + + Ip4CancelReceive (IpSb->DefaultInterface); + + Ip4FreeInterface (IpSb->DefaultInterface, NULL); + IpSb->DefaultInterface = NULL; + } + + Ip4CleanAssembleTable (&IpSb->Assemble); + + // + // Create new default interface and route table. + // + IpIf = Ip4CreateInterface (IpSb->Mnp, IpSb->Controller, IpSb->Image); + if (IpIf == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + RouteTable = Ip4CreateRouteTable (); + if (RouteTable == NULL) { + Ip4FreeInterface (IpIf, NULL); + return EFI_OUT_OF_RESOURCES; + } + + IpSb->DefaultInterface = IpIf; + InsertHeadList (&IpSb->Interfaces, &IpIf->Link); + IpSb->DefaultRouteTable = RouteTable; + Ip4ReceiveFrame (IpIf, NULL, Ip4AccpetFrame, IpSb); + + // + // Reset the State to unstarted. + // + if (IpSb->State == IP4_SERVICE_CONFIGED || IpSb->State == IP4_SERVICE_STARTED) { + IpSb->State = IP4_SERVICE_UNSTARTED; + } + } + + return Status; +} + +/** + The work function is to set the gateway addresses manually for the EFI IPv4 + network stack that is running on the communication device that this EFI IPv4 + Configuration Protocol manages. It is not configurable when the policy is + Ip4Config2PolicyDhcp. The gateway addresses must be unicast IPv4 addresses. + + @param[in] Instance The pointer to the IP4 config2 instance data. + @param[in] DataSize The size of the buffer pointed to by Data in bytes. + @param[in] Data The data buffer to set. This points to an array of + EFI_IPv6_ADDRESS instances. + + @retval EFI_BAD_BUFFER_SIZE The DataSize does not match the size of the type. + @retval EFI_WRITE_PROTECTED The specified configuration data cannot be set + under the current policy. + @retval EFI_INVALID_PARAMETER One or more fields in Data is invalid. + @retval EFI_OUT_OF_RESOURCES Failed to allocate resource to complete the operation. + @retval EFI_ABORTED The manual gateway addresses to be set equal the + current configuration. + @retval EFI_SUCCESS The specified configuration data for the EFI IPv6 + network stack was set. + +**/ +EFI_STATUS +Ip4Config2SetGateway ( + IN IP4_CONFIG2_INSTANCE *Instance, + IN UINTN DataSize, + IN VOID *Data + ) +{ + IP4_SERVICE *IpSb; + IP4_CONFIG2_DATA_ITEM *DataItem; + IP4_ADDR Gateway; + + UINTN Index1; + UINTN Index2; + EFI_IPv4_ADDRESS *OldGateway; + EFI_IPv4_ADDRESS *NewGateway; + UINTN OldGatewayCount; + UINTN NewGatewayCount; + BOOLEAN OneRemoved; + BOOLEAN OneAdded; + VOID *Tmp; + + OldGateway = NULL; + NewGateway = NULL; + OneRemoved = FALSE; + OneAdded = FALSE; + Tmp = NULL; + + if ((DataSize != 0) && (DataSize % sizeof (EFI_IPv4_ADDRESS) != 0)) { + return EFI_BAD_BUFFER_SIZE; + } + + if (Instance->Policy != Ip4Config2PolicyStatic) { + return EFI_WRITE_PROTECTED; + } + + IpSb = IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance); + + DataItem = &Instance->DataItem[Ip4Config2DataTypeGateway]; + OldGateway = DataItem->Data.Gateway; + OldGatewayCount = DataItem->DataSize / sizeof (EFI_IPv4_ADDRESS); + + for (Index1 = 0; Index1 < OldGatewayCount; Index1++) { + // + // Remove the old route entry. + // + CopyMem (&Gateway, OldGateway + Index1, sizeof (IP4_ADDR)); + Ip4DelRoute ( + IpSb->DefaultRouteTable, + IP4_ALLZERO_ADDRESS, + IP4_ALLZERO_ADDRESS, + NTOHL (Gateway) + ); + OneRemoved = TRUE; + } + + if (Data != NULL && DataSize != 0) { + NewGateway = (EFI_IPv4_ADDRESS *) Data; + NewGatewayCount = DataSize / sizeof (EFI_IPv4_ADDRESS); + for (Index1 = 0; Index1 < NewGatewayCount; Index1++) { + CopyMem (&Gateway, NewGateway + Index1, sizeof (IP4_ADDR)); + + if ((IpSb->DefaultInterface->SubnetMask != 0) && + !NetIp4IsUnicast (NTOHL (Gateway), IpSb->DefaultInterface->SubnetMask)) { + return EFI_INVALID_PARAMETER; + } + + for (Index2 = Index1 + 1; Index2 < NewGatewayCount; Index2++) { + if (EFI_IP4_EQUAL (NewGateway + Index1, NewGateway + Index2)) { + return EFI_INVALID_PARAMETER; + } + } + } + + if (NewGatewayCount != OldGatewayCount) { + Tmp = AllocatePool (DataSize); + if (Tmp == NULL) { + return EFI_OUT_OF_RESOURCES; + } + } else { + Tmp = NULL; + } + + for (Index1 = 0; Index1 < NewGatewayCount; Index1++) { + // + // Add the new route entry. + // + CopyMem (&Gateway, NewGateway + Index1, sizeof (IP4_ADDR)); + Ip4AddRoute ( + IpSb->DefaultRouteTable, + IP4_ALLZERO_ADDRESS, + IP4_ALLZERO_ADDRESS, + NTOHL (Gateway) + ); + + OneAdded = TRUE; + } + + if (!OneRemoved && !OneAdded) { + DataItem->Status = EFI_SUCCESS; + return EFI_ABORTED; + } else { + if (Tmp != NULL) { + if (DataItem->Data.Ptr != NULL) { + FreePool (DataItem->Data.Ptr); + } + DataItem->Data.Ptr = Tmp; + } + + CopyMem (DataItem->Data.Ptr, Data, DataSize); + DataItem->DataSize = DataSize; + DataItem->Status = EFI_SUCCESS; + } + } else { + // + // DataSize is 0 and Data is NULL, clean up the Gateway address. + // + if (DataItem->Data.Ptr != NULL) { + FreePool (DataItem->Data.Ptr); + } + DataItem->Data.Ptr = NULL; + DataItem->DataSize = 0; + DataItem->Status = EFI_NOT_FOUND; + } + + return EFI_SUCCESS; +} + +/** + The work function is to set the DNS server list for the EFI IPv4 network + stack running on the communication device that this EFI_IP4_CONFIG2_PROTOCOL + manages. It is not configurable when the policy is Ip4Config2PolicyDhcp. + The DNS server addresses must be unicast IPv4 addresses. + + @param[in] Instance The pointer to the IP4 config2 instance data. + @param[in] DataSize The size of the buffer pointed to by Data in bytes. + @param[in] Data The data buffer to set, points to an array of + EFI_IPv4_ADDRESS instances. + + @retval EFI_BAD_BUFFER_SIZE The DataSize does not match the size of the type. + @retval EFI_WRITE_PROTECTED The specified configuration data cannot be set + under the current policy. + @retval EFI_INVALID_PARAMETER One or more fields in Data is invalid. + @retval EFI_OUT_OF_RESOURCES Failed to allocate resources to complete the operation. + @retval EFI_ABORTED The DNS server addresses to be set equal the current + configuration. + @retval EFI_SUCCESS The specified configuration data for the EFI IPv4 + network stack was set. + +**/ +EFI_STATUS +Ip4Config2SetDnsServer ( + IN IP4_CONFIG2_INSTANCE *Instance, + IN UINTN DataSize, + IN VOID *Data + ) +{ + EFI_STATUS Status; + IP4_CONFIG2_DATA_ITEM *Item; + + Status = EFI_SUCCESS; + Item = NULL; + + if (Instance->Policy != Ip4Config2PolicyStatic) { + return EFI_WRITE_PROTECTED; + } + + Item = &Instance->DataItem[Ip4Config2DataTypeDnsServer]; + + if (DATA_ATTRIB_SET (Item->Attribute, DATA_ATTRIB_VOLATILE)) { + REMOVE_DATA_ATTRIB (Item->Attribute, DATA_ATTRIB_VOLATILE); + } + + if (Data != NULL && DataSize != 0) { + Status = Ip4Config2SetDnsServerWorker (Instance, DataSize, Data); + } else { + // + // DataSize is 0 and Data is NULL, clean up the DnsServer address. + // + if (Item->Data.Ptr != NULL) { + FreePool (Item->Data.Ptr); + } + Item->Data.Ptr = NULL; + Item->DataSize = 0; + Item->Status = EFI_NOT_FOUND; + } + + return Status; +} + +/** + Generate the operational state of the interface this IP4 config2 instance manages + and output in EFI_IP4_CONFIG2_INTERFACE_INFO. + + @param[in] IpSb The pointer to the IP4 service binding instance. + @param[out] IfInfo The pointer to the IP4 config2 interface information structure. + +**/ +VOID +Ip4Config2InitIfInfo ( + IN IP4_SERVICE *IpSb, + OUT EFI_IP4_CONFIG2_INTERFACE_INFO *IfInfo + ) +{ + UnicodeSPrint ( + IfInfo->Name, + EFI_IP4_CONFIG2_INTERFACE_INFO_NAME_SIZE, + L"eth%d", + IpSb->Ip4Config2Instance.IfIndex + ); + + IfInfo->IfType = IpSb->SnpMode.IfType; + IfInfo->HwAddressSize = IpSb->SnpMode.HwAddressSize; + CopyMem (&IfInfo->HwAddress, &IpSb->SnpMode.CurrentAddress, IfInfo->HwAddressSize); +} + + + +/** + Set the configuration for the EFI IPv4 network stack running on the communication + device this EFI_IP4_CONFIG2_PROTOCOL instance manages. + + This function is used to set the configuration data of type DataType for the EFI + IPv4 network stack that is running on the communication device that this EFI IPv4 + Configuration Protocol instance manages. + + DataSize is used to calculate the count of structure instances in the Data for + a DataType in which multiple structure instances are allowed. + + This function is always non-blocking. When setting some type of configuration data, + an asynchronous process is invoked to check the correctness of the data, such as + performing Duplicate Address Detection on the manually set local IPv4 addresses. + EFI_NOT_READY is returned immediately to indicate that such an asynchronous process + is invoked, and the process is not finished yet. The caller wanting to get the result + of the asynchronous process is required to call RegisterDataNotify() to register an + event on the specified configuration data. Once the event is signaled, the caller + can call GetData() to obtain the configuration data and know the result. + For other types of configuration data that do not require an asynchronous configuration + process, the result of the operation is immediately returned. + + @param[in] This The pointer to the EFI_IP4_CONFIG2_PROTOCOL instance. + @param[in] DataType The type of data to set. + @param[in] DataSize Size of the buffer pointed to by Data in bytes. + @param[in] Data The data buffer to set. The type of the data buffer is + associated with the DataType. + + @retval EFI_SUCCESS The specified configuration data for the EFI IPv6 + network stack was set successfully. + @retval EFI_INVALID_PARAMETER One or more of the following are TRUE: + - This is NULL. + - One or more fields in Data and DataSize do not match the + requirement of the data type indicated by DataType. + @retval EFI_WRITE_PROTECTED The specified configuration data is read-only or the specified + configuration data cannot be set under the current policy. + @retval EFI_ACCESS_DENIED Another set operation on the specified configuration + data is already in process. + @retval EFI_NOT_READY An asynchronous process was invoked to set the specified + configuration data, and the process is not finished yet. + @retval EFI_BAD_BUFFER_SIZE The DataSize does not match the size of the type + indicated by DataType. + @retval EFI_UNSUPPORTED This DataType is not supported. + @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. + @retval EFI_DEVICE_ERROR An unexpected system error or network error occurred. + +**/ +EFI_STATUS +EFIAPI +EfiIp4Config2SetData ( + IN EFI_IP4_CONFIG2_PROTOCOL *This, + IN EFI_IP4_CONFIG2_DATA_TYPE DataType, + IN UINTN DataSize, + IN VOID *Data + ) +{ + EFI_TPL OldTpl; + EFI_STATUS Status; + IP4_CONFIG2_INSTANCE *Instance; + IP4_SERVICE *IpSb; + + if ((This == NULL) || (Data == NULL && DataSize != 0) || (Data != NULL && DataSize == 0)) { + return EFI_INVALID_PARAMETER; + } + + if (DataType >= Ip4Config2DataTypeMaximum) { + return EFI_UNSUPPORTED; + } + + Instance = IP4_CONFIG2_INSTANCE_FROM_PROTOCOL (This); + IpSb = IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance); + NET_CHECK_SIGNATURE (IpSb, IP4_SERVICE_SIGNATURE); + + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + Status = Instance->DataItem[DataType].Status; + if (Status != EFI_NOT_READY) { + + if (Instance->DataItem[DataType].SetData == NULL) { + // + // This type of data is readonly. + // + Status = EFI_WRITE_PROTECTED; + } else { + + Status = Instance->DataItem[DataType].SetData (Instance, DataSize, Data); + if (!EFI_ERROR (Status)) { + // + // Fire up the events registered with this type of data. + // + NetMapIterate (&Instance->DataItem[DataType].EventMap, Ip4Config2SignalEvent, NULL); + Ip4Config2WriteConfigData (IpSb->MacString, Instance); + } else if (Status == EFI_ABORTED) { + // + // The SetData is aborted because the data to set is the same with + // the one maintained. + // + Status = EFI_SUCCESS; + NetMapIterate (&Instance->DataItem[DataType].EventMap, Ip4Config2SignalEvent, NULL); + } + } + } else { + // + // Another asynchornous process is on the way. + // + Status = EFI_ACCESS_DENIED; + } + + gBS->RestoreTPL (OldTpl); + + return Status; +} + +/** + Get the configuration data for the EFI IPv4 network stack running on the communication + device that this EFI_IP4_CONFIG2_PROTOCOL instance manages. + + This function returns the configuration data of type DataType for the EFI IPv4 network + stack running on the communication device that this EFI IPv4 Configuration Protocol instance + manages. + + The caller is responsible for allocating the buffer used to return the specified + configuration data. The required size will be returned to the caller if the size of + the buffer is too small. + + EFI_NOT_READY is returned if the specified configuration data is not ready due to an + asynchronous configuration process already in progress. The caller can call RegisterDataNotify() + to register an event on the specified configuration data. Once the asynchronous configuration + process is finished, the event will be signaled, and a subsequent GetData() call will return + the specified configuration data. + + @param[in] This Pointer to the EFI_IP4_CONFIG2_PROTOCOL instance. + @param[in] DataType The type of data to get. + @param[in, out] DataSize On input, in bytes, the size of Data. On output, in bytes, the + size of buffer required to store the specified configuration data. + @param[in] Data The data buffer in which the configuration data is returned. The + type of the data buffer is associated with the DataType. + This is an optional parameter that may be NULL. + + @retval EFI_SUCCESS The specified configuration data was obtained successfully. + @retval EFI_INVALID_PARAMETER One or more of the followings are TRUE: + - This is NULL. + - DataSize is NULL. + - Data is NULL if *DataSize is not zero. + @retval EFI_BUFFER_TOO_SMALL The size of Data is too small for the specified configuration data, + and the required size is returned in DataSize. + @retval EFI_NOT_READY The specified configuration data is not ready due to an + asynchronous configuration process already in progress. + @retval EFI_NOT_FOUND The specified configuration data is not found. + +**/ +EFI_STATUS +EFIAPI +EfiIp4Config2GetData ( + IN EFI_IP4_CONFIG2_PROTOCOL *This, + IN EFI_IP4_CONFIG2_DATA_TYPE DataType, + IN OUT UINTN *DataSize, + IN VOID *Data OPTIONAL + ) +{ + EFI_TPL OldTpl; + EFI_STATUS Status; + IP4_CONFIG2_INSTANCE *Instance; + IP4_CONFIG2_DATA_ITEM *DataItem; + + if ((This == NULL) || (DataSize == NULL) || ((*DataSize != 0) && (Data == NULL))) { + return EFI_INVALID_PARAMETER; + } + + if (DataType >= Ip4Config2DataTypeMaximum) { + return EFI_NOT_FOUND; + } + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + Instance = IP4_CONFIG2_INSTANCE_FROM_PROTOCOL (This); + DataItem = &Instance->DataItem[DataType]; + + Status = Instance->DataItem[DataType].Status; + if (!EFI_ERROR (Status)) { + + if (DataItem->GetData != NULL) { + + Status = DataItem->GetData (Instance, DataSize, Data); + } else if (*DataSize < Instance->DataItem[DataType].DataSize) { + // + // Update the buffer length. + // + *DataSize = Instance->DataItem[DataType].DataSize; + Status = EFI_BUFFER_TOO_SMALL; + } else { + + *DataSize = Instance->DataItem[DataType].DataSize; + CopyMem (Data, Instance->DataItem[DataType].Data.Ptr, *DataSize); + } + } + + gBS->RestoreTPL (OldTpl); + + return Status; +} + +/** + Register an event that is signaled whenever a configuration process on the specified + configuration data is done. + + This function registers an event that is to be signaled whenever a configuration + process on the specified configuration data is performed. An event can be registered + for a different DataType simultaneously. The caller is responsible for determining + which type of configuration data causes the signaling of the event in such an event. + + @param[in] This Pointer to the EFI_IP4_CONFIG2_PROTOCOL instance. + @param[in] DataType The type of data to unregister the event for. + @param[in] Event The event to register. + + @retval EFI_SUCCESS The notification event for the specified configuration data is + registered. + @retval EFI_INVALID_PARAMETER This is NULL or Event is NULL. + @retval EFI_UNSUPPORTED The configuration data type specified by DataType is not + supported. + @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. + @retval EFI_ACCESS_DENIED The Event is already registered for the DataType. + +**/ +EFI_STATUS +EFIAPI +EfiIp4Config2RegisterDataNotify ( + IN EFI_IP4_CONFIG2_PROTOCOL *This, + IN EFI_IP4_CONFIG2_DATA_TYPE DataType, + IN EFI_EVENT Event + ) +{ + EFI_TPL OldTpl; + EFI_STATUS Status; + IP4_CONFIG2_INSTANCE *Instance; + NET_MAP *EventMap; + NET_MAP_ITEM *Item; + + if ((This == NULL) || (Event == NULL)) { + return EFI_INVALID_PARAMETER; + } + + if (DataType >= Ip4Config2DataTypeMaximum) { + return EFI_UNSUPPORTED; + } + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + Instance = IP4_CONFIG2_INSTANCE_FROM_PROTOCOL (This); + EventMap = &Instance->DataItem[DataType].EventMap; + + // + // Check whether this event is already registered for this DataType. + // + Item = NetMapFindKey (EventMap, Event); + if (Item == NULL) { + + Status = NetMapInsertTail (EventMap, Event, NULL); + + if (EFI_ERROR (Status)) { + + Status = EFI_OUT_OF_RESOURCES; + } + + } else { + + Status = EFI_ACCESS_DENIED; + } + + gBS->RestoreTPL (OldTpl); + + return Status; +} + +/** + Remove a previously registered event for the specified configuration data. + + @param This The pointer to the EFI_IP4_CONFIG2_PROTOCOL instance. + @param DataType The type of data to remove from the previously + registered event. + @param Event The event to be unregistered. + + @retval EFI_SUCCESS The event registered for the specified + configuration data was removed. + @retval EFI_INVALID_PARAMETER This is NULL or Event is NULL. + @retval EFI_NOT_FOUND The Event has not been registered for the + specified DataType. + +**/ +EFI_STATUS +EFIAPI +EfiIp4Config2UnregisterDataNotify ( + IN EFI_IP4_CONFIG2_PROTOCOL *This, + IN EFI_IP4_CONFIG2_DATA_TYPE DataType, + IN EFI_EVENT Event + ) +{ + EFI_TPL OldTpl; + EFI_STATUS Status; + IP4_CONFIG2_INSTANCE *Instance; + NET_MAP_ITEM *Item; + + if ((This == NULL) || (Event == NULL)) { + return EFI_INVALID_PARAMETER; + } + + if (DataType >= Ip4Config2DataTypeMaximum) { + return EFI_NOT_FOUND; + } + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + Instance = IP4_CONFIG2_INSTANCE_FROM_PROTOCOL (This); + + Item = NetMapFindKey (&Instance->DataItem[DataType].EventMap, Event); + if (Item != NULL) { + + NetMapRemoveItem (&Instance->DataItem[DataType].EventMap, Item, NULL); + Status = EFI_SUCCESS; + } else { + + Status = EFI_NOT_FOUND; + } + + gBS->RestoreTPL (OldTpl); + + return Status; +} + +/** + Initialize an IP4_CONFIG2_INSTANCE. + + @param[out] Instance The buffer of IP4_CONFIG2_INSTANCE to be initialized. + + @retval EFI_OUT_OF_RESOURCES Failed to allocate resources to complete the operation. + @retval EFI_SUCCESS The IP4_CONFIG2_INSTANCE initialized successfully. + +**/ +EFI_STATUS +Ip4Config2InitInstance ( + OUT IP4_CONFIG2_INSTANCE *Instance + ) +{ + IP4_SERVICE *IpSb; + IP4_CONFIG2_INSTANCE *TmpInstance; + LIST_ENTRY *Entry; + EFI_STATUS Status; + UINTN Index; + UINT16 IfIndex; + IP4_CONFIG2_DATA_ITEM *DataItem; + + + IpSb = IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance); + + Instance->Signature = IP4_CONFIG2_INSTANCE_SIGNATURE; + + + // + // Determine the index of this interface. + // + IfIndex = 0; + NET_LIST_FOR_EACH (Entry, &mIp4Config2InstanceList) { + TmpInstance = NET_LIST_USER_STRUCT_S (Entry, IP4_CONFIG2_INSTANCE, Link, IP4_CONFIG2_INSTANCE_SIGNATURE); + + if (TmpInstance->IfIndex > IfIndex) { + // + // There is a sequence hole because some interface is down. + // + break; + } + + IfIndex++; + } + + Instance->IfIndex = IfIndex; + NetListInsertBefore (Entry, &Instance->Link); + + for (Index = 0; Index < Ip4Config2DataTypeMaximum; Index++) { + // + // Initialize the event map for each data item. + // + NetMapInit (&Instance->DataItem[Index].EventMap); + } + + + // + // Initialize each data type: associate storage and set data size for the + // fixed size data types, hook the SetData function, set the data attribute. + // + DataItem = &Instance->DataItem[Ip4Config2DataTypeInterfaceInfo]; + DataItem->GetData = Ip4Config2GetIfInfo; + DataItem->Data.Ptr = &Instance->InterfaceInfo; + DataItem->DataSize = sizeof (Instance->InterfaceInfo); + SET_DATA_ATTRIB (DataItem->Attribute, DATA_ATTRIB_SIZE_FIXED | DATA_ATTRIB_VOLATILE); + Ip4Config2InitIfInfo (IpSb, &Instance->InterfaceInfo); + + DataItem = &Instance->DataItem[Ip4Config2DataTypePolicy]; + DataItem->SetData = Ip4Config2SetPolicy; + DataItem->Data.Ptr = &Instance->Policy; + DataItem->DataSize = sizeof (Instance->Policy); + Instance->Policy = Ip4Config2PolicyStatic; + SET_DATA_ATTRIB (DataItem->Attribute, DATA_ATTRIB_SIZE_FIXED); + + DataItem = &Instance->DataItem[Ip4Config2DataTypeManualAddress]; + DataItem->SetData = Ip4Config2SetManualAddress; + DataItem->Status = EFI_NOT_FOUND; + + DataItem = &Instance->DataItem[Ip4Config2DataTypeGateway]; + DataItem->SetData = Ip4Config2SetGateway; + DataItem->Status = EFI_NOT_FOUND; + + DataItem = &Instance->DataItem[Ip4Config2DataTypeDnsServer]; + DataItem->SetData = Ip4Config2SetDnsServer; + DataItem->Status = EFI_NOT_FOUND; + + Instance->Configured = TRUE; + + // + // Try to read the config data from NV variable. + // If not found, write initialized config data into NV variable + // as a default config data. + // + Status = Ip4Config2ReadConfigData (IpSb->MacString, Instance); + if (Status == EFI_NOT_FOUND) { + Status = Ip4Config2WriteConfigData (IpSb->MacString, Instance); + } + + if (EFI_ERROR (Status)) { + return Status; + } + + Instance->Ip4Config2.SetData = EfiIp4Config2SetData; + Instance->Ip4Config2.GetData = EfiIp4Config2GetData; + Instance->Ip4Config2.RegisterDataNotify = EfiIp4Config2RegisterDataNotify; + Instance->Ip4Config2.UnregisterDataNotify = EfiIp4Config2UnregisterDataNotify; + + // + // Publish the IP4 configuration form + // + return Ip4Config2FormInit (Instance); +} + + +/** + Release an IP4_CONFIG2_INSTANCE. + + @param[in, out] Instance The buffer of IP4_CONFIG2_INSTANCE to be freed. + +**/ +VOID +Ip4Config2CleanInstance ( + IN OUT IP4_CONFIG2_INSTANCE *Instance + ) +{ + UINTN Index; + IP4_CONFIG2_DATA_ITEM *DataItem; + + if (Instance->DeclineAddress != NULL) { + FreePool (Instance->DeclineAddress); + } + + if (!Instance->Configured) { + return ; + } + + if (Instance->Dhcp4Handle != NULL) { + + Ip4Config2DestroyDhcp4 (Instance); + } + + // + // Close the event. + // + if (Instance->Dhcp4Event != NULL) { + gBS->CloseEvent (Instance->Dhcp4Event); + Instance->Dhcp4Event = NULL; + } + + for (Index = 0; Index < Ip4Config2DataTypeMaximum; Index++) { + + DataItem = &Instance->DataItem[Index]; + + if (!DATA_ATTRIB_SET (DataItem->Attribute, DATA_ATTRIB_SIZE_FIXED)) { + if (DataItem->Data.Ptr != NULL) { + FreePool (DataItem->Data.Ptr); + } + DataItem->Data.Ptr = NULL; + DataItem->DataSize = 0; + } + + NetMapClean (&Instance->DataItem[Index].EventMap); + } + + Ip4Config2FormUnload (Instance); + + RemoveEntryList (&Instance->Link); +} + +/** + The event handle for IP4 auto reconfiguration. The original default + interface and route table will be removed as the default. + + @param[in] Context The IP4 service binding instance. + +**/ +VOID +EFIAPI +Ip4AutoReconfigCallBackDpc ( + IN VOID *Context + ) +{ + IP4_SERVICE *IpSb; + + IpSb = (IP4_SERVICE *) Context; + NET_CHECK_SIGNATURE (IpSb, IP4_SERVICE_SIGNATURE); + + if (IpSb->State > IP4_SERVICE_UNSTARTED) { + IpSb->State = IP4_SERVICE_UNSTARTED; + } + + IpSb->Reconfig = TRUE; + + Ip4StartAutoConfig (&IpSb->Ip4Config2Instance); + + return ; +} + + +/** + Request Ip4AutoReconfigCallBackDpc as a DPC at TPL_CALLBACK. + + @param Event The event that is signalled. + @param Context The IP4 service binding instance. + +**/ +VOID +EFIAPI +Ip4AutoReconfigCallBack ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + // + // Request Ip4AutoReconfigCallBackDpc as a DPC at TPL_CALLBACK + // + QueueDpc (TPL_CALLBACK, Ip4AutoReconfigCallBackDpc, Context); +} + diff --git a/NetworkPkg/Ip4Dxe/Ip4Config2Impl.h b/NetworkPkg/Ip4Dxe/Ip4Config2Impl.h new file mode 100644 index 0000000000..1716dde399 --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4Config2Impl.h @@ -0,0 +1,294 @@ +/** @file + Definitions for EFI IPv4 Configuration II Protocol implementation. + + Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.
+ (C) Copyright 2015 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef __IP4_CONFIG2_IMPL_H__ +#define __IP4_CONFIG2_IMPL_H__ + +#define IP4_CONFIG2_INSTANCE_SIGNATURE SIGNATURE_32 ('I', 'P', 'C', '2') +#define IP4_FORM_CALLBACK_INFO_SIGNATURE SIGNATURE_32 ('I', 'F', 'C', 'I') + +#define IP4_CONFIG2_VARIABLE_ATTRIBUTE (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS) + +#define DATA_ATTRIB_SIZE_FIXED 0x1 +#define DATA_ATTRIB_VOLATILE 0x2 + +#define DATA_ATTRIB_SET(Attrib, Bits) (BOOLEAN)((Attrib) & (Bits)) +#define SET_DATA_ATTRIB(Attrib, Bits) ((Attrib) |= (Bits)) +#define REMOVE_DATA_ATTRIB(Attrib, Bits) ((Attrib) &= (~Bits)) + +typedef struct _IP4_CONFIG2_INSTANCE IP4_CONFIG2_INSTANCE; + +#define IP4_CONFIG2_INSTANCE_FROM_PROTOCOL(Proto) \ + CR ((Proto), \ + IP4_CONFIG2_INSTANCE, \ + Ip4Config2, \ + IP4_CONFIG2_INSTANCE_SIGNATURE \ + ) + +#define IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE(Instance) \ + CR ((Instance), \ + IP4_SERVICE, \ + Ip4Config2Instance, \ + IP4_SERVICE_SIGNATURE \ + ) + +#define IP4_CONFIG2_INSTANCE_FROM_FORM_CALLBACK(Callback) \ + CR ((Callback), \ + IP4_CONFIG2_INSTANCE, \ + CallbackInfo, \ + IP4_CONFIG2_INSTANCE_SIGNATURE \ + ) + +#define IP4_FORM_CALLBACK_INFO_FROM_CONFIG_ACCESS(ConfigAccess) \ + CR ((ConfigAccess), \ + IP4_FORM_CALLBACK_INFO, \ + HiiConfigAccessProtocol, \ + IP4_FORM_CALLBACK_INFO_SIGNATURE \ + ) + +/** + The prototype of work function for EfiIp4Config2SetData(). + + @param[in] Instance The pointer to the IP4 config2 instance data. + @param[in] DataSize In bytes, the size of the buffer pointed to by Data. + @param[in] Data The data buffer to set. + + @retval EFI_BAD_BUFFER_SIZE The DataSize does not match the size of the type, + 8 bytes. + @retval EFI_SUCCESS The specified configuration data for the EFI IPv4 + network stack was set successfully. + +**/ +typedef +EFI_STATUS +(*IP4_CONFIG2_SET_DATA) ( + IN IP4_CONFIG2_INSTANCE *Instance, + IN UINTN DataSize, + IN VOID *Data + ); + +/** + The prototype of work function for EfiIp4Config2GetData(). + + @param[in] Instance The pointer to the IP4 config2 instance data. + @param[in, out] DataSize On input, in bytes, the size of Data. On output, in + bytes, the size of buffer required to store the specified + configuration data. + @param[in] Data The data buffer in which the configuration data is returned. + Ignored if DataSize is ZERO. + + @retval EFI_BUFFER_TOO_SMALL The size of Data is too small for the specified + configuration data, and the required size is + returned in DataSize. + @retval EFI_SUCCESS The specified configuration data was obtained successfully. + +**/ +typedef +EFI_STATUS +(*IP4_CONFIG2_GET_DATA) ( + IN IP4_CONFIG2_INSTANCE *Instance, + IN OUT UINTN *DataSize, + IN VOID *Data OPTIONAL + ); + +typedef union { + VOID *Ptr; + EFI_IP4_CONFIG2_INTERFACE_INFO *IfInfo; + EFI_IP4_CONFIG2_POLICY *Policy; + EFI_IP4_CONFIG2_MANUAL_ADDRESS *ManualAddress; + EFI_IPv4_ADDRESS *Gateway; + EFI_IPv4_ADDRESS *DnsServers; +} IP4_CONFIG2_DATA; + +typedef struct { + IP4_CONFIG2_SET_DATA SetData; + IP4_CONFIG2_GET_DATA GetData; + EFI_STATUS Status; + UINT8 Attribute; + NET_MAP EventMap; + IP4_CONFIG2_DATA Data; + UINTN DataSize; +} IP4_CONFIG2_DATA_ITEM; + +typedef struct { + UINT16 Offset; + UINT32 DataSize; + EFI_IP4_CONFIG2_DATA_TYPE DataType; +} IP4_CONFIG2_DATA_RECORD; + +#pragma pack(1) + +// +// heap data that contains the data for each data record. +// +// EFI_IP4_CONFIG2_POLICY Policy; +// UINT32 ManualaddressCount; +// UINT32 GatewayCount; +// UINT32 DnsServersCount; +// EFI_IP4_CONFIG2_MANUAL_ADDRESS ManualAddress[]; +// EFI_IPv4_ADDRESS Gateway[]; +// EFI_IPv4_ADDRESS DnsServers[]; +// +typedef struct { + UINT16 Checksum; + UINT16 DataRecordCount; + IP4_CONFIG2_DATA_RECORD DataRecord[1]; +} IP4_CONFIG2_VARIABLE; + +#pragma pack() + +typedef struct { + EFI_IP4_CONFIG2_POLICY Policy; ///< manual or automatic + EFI_IP4_CONFIG2_MANUAL_ADDRESS *ManualAddress; ///< IP addresses + UINT32 ManualAddressCount; ///< IP addresses count + EFI_IPv4_ADDRESS *GatewayAddress; ///< Gateway address + UINT32 GatewayAddressCount; ///< Gateway address count + EFI_IPv4_ADDRESS *DnsAddress; ///< DNS server address + UINT32 DnsAddressCount; ///< DNS server address count +} IP4_CONFIG2_NVDATA; + +typedef struct _IP4_FORM_CALLBACK_INFO { + UINT32 Signature; + EFI_HANDLE ChildHandle; + EFI_HII_CONFIG_ACCESS_PROTOCOL HiiConfigAccessProtocol; + EFI_DEVICE_PATH_PROTOCOL *HiiVendorDevicePath; + EFI_HII_HANDLE RegisteredHandle; +} IP4_FORM_CALLBACK_INFO; + +struct _IP4_CONFIG2_INSTANCE { + UINT32 Signature; + BOOLEAN Configured; + LIST_ENTRY Link; + UINT16 IfIndex; + + EFI_IP4_CONFIG2_PROTOCOL Ip4Config2; + + EFI_IP4_CONFIG2_INTERFACE_INFO InterfaceInfo; + EFI_IP4_CONFIG2_POLICY Policy; + IP4_CONFIG2_DATA_ITEM DataItem[Ip4Config2DataTypeMaximum]; + + EFI_EVENT Dhcp4SbNotifyEvent; + VOID *Registration; + EFI_HANDLE Dhcp4Handle; + EFI_DHCP4_PROTOCOL *Dhcp4; + BOOLEAN DhcpSuccess; + BOOLEAN OtherInfoOnly; + EFI_EVENT Dhcp4Event; + UINT32 FailedIaAddressCount; + EFI_IPv4_ADDRESS *DeclineAddress; + UINT32 DeclineAddressCount; + + IP4_FORM_CALLBACK_INFO CallbackInfo; + + IP4_CONFIG2_NVDATA Ip4NvData; +}; + +// +// Configure the DHCP to request the routers and netmask +// from server. The DHCP4_TAG_NETMASK is included in Head. +// +#pragma pack(1) +typedef struct { + EFI_DHCP4_PACKET_OPTION Head; + UINT8 Route; + UINT8 Dns; +} IP4_CONFIG2_DHCP4_OPTION; +#pragma pack() + +/** + Read the configuration data from variable storage according to the VarName and + gEfiIp4Config2ProtocolGuid. It checks the integrity of variable data. If the + data is corrupted, it clears the variable data to ZERO. Othewise, it outputs the + configuration data to IP4_CONFIG2_INSTANCE. + + @param[in] VarName The pointer to the variable name + @param[in, out] Instance The pointer to the IP4 config2 instance data. + + @retval EFI_NOT_FOUND The variable can not be found or already corrupted. + @retval EFI_OUT_OF_RESOURCES Fail to allocate resource to complete the operation. + @retval EFI_SUCCESS The configuration data was retrieved successfully. + +**/ +EFI_STATUS +Ip4Config2ReadConfigData ( + IN CHAR16 *VarName, + IN OUT IP4_CONFIG2_INSTANCE *Instance + ); + +/** + Start the DHCP configuration for this IP service instance. + It will locates the EFI_IP4_CONFIG2_PROTOCOL, then start the + DHCP configuration. + + @param[in] Instance The IP4 config2 instance to configure. + + @retval EFI_SUCCESS The auto configuration is successfully started. + @retval Others Failed to start auto configuration. + +**/ +EFI_STATUS +Ip4StartAutoConfig ( + IN IP4_CONFIG2_INSTANCE *Instance + ); + +/** + Initialize an IP4_CONFIG2_INSTANCE. + + @param[out] Instance The buffer of IP4_CONFIG2_INSTANCE to be initialized. + + @retval EFI_OUT_OF_RESOURCES Failed to allocate resources to complete the operation. + @retval EFI_SUCCESS The IP4_CONFIG2_INSTANCE initialized successfully. + +**/ +EFI_STATUS +Ip4Config2InitInstance ( + OUT IP4_CONFIG2_INSTANCE *Instance + ); + +/** + Release an IP4_CONFIG2_INSTANCE. + + @param[in, out] Instance The buffer of IP4_CONFIG2_INSTANCE to be freed. + +**/ +VOID +Ip4Config2CleanInstance ( + IN OUT IP4_CONFIG2_INSTANCE *Instance + ); + +/** + Request Ip4AutoReconfigCallBackDpc as a DPC at TPL_CALLBACK. + + @param Event The event that is signalled. + @param Context The IP4 service binding instance. + +**/ +VOID +EFIAPI +Ip4AutoReconfigCallBack ( + IN EFI_EVENT Event, + IN VOID *Context + ); + +/** + Destroy the Dhcp4 child in IP4_CONFIG2_INSTANCE and release the resources. + + @param[in, out] Instance The buffer of IP4 config2 instance to be freed. + + @retval EFI_SUCCESS The child was successfully destroyed. + @retval Others Failed to destroy the child. + +**/ +EFI_STATUS +Ip4Config2DestroyDhcp4 ( + IN OUT IP4_CONFIG2_INSTANCE *Instance + ); + +#endif diff --git a/NetworkPkg/Ip4Dxe/Ip4Config2Nv.c b/NetworkPkg/Ip4Dxe/Ip4Config2Nv.c new file mode 100644 index 0000000000..a4d2996a60 --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4Config2Nv.c @@ -0,0 +1,1444 @@ +/** @file + Helper functions for configuring or getting the parameters relating to Ip4. + +Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Ip4Impl.h" + +CHAR16 mIp4Config2StorageName[] = L"IP4_CONFIG2_IFR_NVDATA"; + +/** + Calculate the prefix length of the IPv4 subnet mask. + + @param[in] SubnetMask The IPv4 subnet mask. + + @return The prefix length of the subnet mask. + @retval 0 Other errors as indicated. + +**/ +UINT8 +GetSubnetMaskPrefixLength ( + IN EFI_IPv4_ADDRESS *SubnetMask + ) +{ + UINT8 Len; + UINT32 ReverseMask; + + // + // The SubnetMask is in network byte order. + // + ReverseMask = SwapBytes32 (*(UINT32 *)&SubnetMask[0]); + + // + // Reverse it. + // + ReverseMask = ~ReverseMask; + + if ((ReverseMask & (ReverseMask + 1)) != 0) { + return 0; + } + + Len = 0; + + while (ReverseMask != 0) { + ReverseMask = ReverseMask >> 1; + Len++; + } + + return (UINT8) (32 - Len); +} + +/** + Convert the decimal dotted IPv4 address into the binary IPv4 address. + + @param[in] Str The UNICODE string. + @param[out] Ip The storage to return the IPv4 address. + + @retval EFI_SUCCESS The binary IP address is returned in Ip. + @retval EFI_INVALID_PARAMETER The IP string is malformatted. + +**/ +EFI_STATUS +Ip4Config2StrToIp ( + IN CHAR16 *Str, + OUT EFI_IPv4_ADDRESS *Ip + ) +{ + UINTN Index; + UINTN Number; + + Index = 0; + + while (*Str != L'\0') { + + if (Index > 3) { + return EFI_INVALID_PARAMETER; + } + + Number = 0; + while ((*Str >= L'0') && (*Str <= L'9')) { + Number = Number * 10 + (*Str - L'0'); + Str++; + } + + if (Number > 0xFF) { + return EFI_INVALID_PARAMETER; + } + + Ip->Addr[Index] = (UINT8) Number; + + if ((*Str != L'\0') && (*Str != L'.')) { + // + // The current character should be either the NULL terminator or + // the dot delimiter. + // + return EFI_INVALID_PARAMETER; + } + + if (*Str == L'.') { + // + // Skip the delimiter. + // + Str++; + } + + Index++; + } + + if (Index != 4) { + return EFI_INVALID_PARAMETER; + } + + return EFI_SUCCESS; +} + +/** + Convert the decimal dotted IPv4 addresses separated by space into the binary IPv4 address list. + + @param[in] Str The UNICODE string contains IPv4 addresses. + @param[out] PtrIpList The storage to return the IPv4 address list. + @param[out] IpCount The size of the IPv4 address list. + + @retval EFI_SUCCESS The binary IP address list is returned in PtrIpList. + @retval EFI_OUT_OF_RESOURCES Error occurs in allocating memory. + @retval EFI_INVALID_PARAMETER The IP string is malformatted. + +**/ +EFI_STATUS +Ip4Config2StrToIpList ( + IN CHAR16 *Str, + OUT EFI_IPv4_ADDRESS **PtrIpList, + OUT UINTN *IpCount + ) +{ + UINTN BeginIndex; + UINTN EndIndex; + UINTN Index; + UINTN IpIndex; + CHAR16 *StrTemp; + BOOLEAN SpaceTag; + + BeginIndex = 0; + EndIndex = BeginIndex; + Index = 0; + IpIndex = 0; + StrTemp = NULL; + SpaceTag = TRUE; + + *PtrIpList = NULL; + *IpCount = 0; + + if (Str == NULL) { + return EFI_SUCCESS; + } + + // + // Get the number of Ip. + // + while (*(Str + Index) != L'\0') { + if (*(Str + Index) == L' ') { + SpaceTag = TRUE; + } else { + if (SpaceTag) { + (*IpCount)++; + SpaceTag = FALSE; + } + } + + Index++; + } + + if (*IpCount == 0) { + return EFI_SUCCESS; + } + + // + // Allocate buffer for IpList. + // + *PtrIpList = AllocateZeroPool(*IpCount * sizeof(EFI_IPv4_ADDRESS)); + if (*PtrIpList == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + // + // Get IpList from Str. + // + Index = 0; + while (*(Str + Index) != L'\0') { + if (*(Str + Index) == L' ') { + if(!SpaceTag) { + StrTemp = AllocateZeroPool((EndIndex - BeginIndex + 1) * sizeof(CHAR16)); + if (StrTemp == NULL) { + FreePool(*PtrIpList); + *PtrIpList = NULL; + *IpCount = 0; + return EFI_OUT_OF_RESOURCES; + } + + CopyMem (StrTemp, Str + BeginIndex, (EndIndex - BeginIndex) * sizeof(CHAR16)); + *(StrTemp + (EndIndex - BeginIndex)) = L'\0'; + + if (Ip4Config2StrToIp (StrTemp, &((*PtrIpList)[IpIndex])) != EFI_SUCCESS) { + FreePool(StrTemp); + FreePool(*PtrIpList); + *PtrIpList = NULL; + *IpCount = 0; + return EFI_INVALID_PARAMETER; + } + + BeginIndex = EndIndex; + IpIndex++; + + FreePool(StrTemp); + } + + BeginIndex++; + EndIndex++; + SpaceTag = TRUE; + } else { + EndIndex++; + SpaceTag = FALSE; + } + + Index++; + + if (*(Str + Index) == L'\0') { + if (!SpaceTag) { + StrTemp = AllocateZeroPool((EndIndex - BeginIndex + 1) * sizeof(CHAR16)); + if (StrTemp == NULL) { + FreePool(*PtrIpList); + *PtrIpList = NULL; + *IpCount = 0; + return EFI_OUT_OF_RESOURCES; + } + + CopyMem (StrTemp, Str + BeginIndex, (EndIndex - BeginIndex) * sizeof(CHAR16)); + *(StrTemp + (EndIndex - BeginIndex)) = L'\0'; + + if (Ip4Config2StrToIp (StrTemp, &((*PtrIpList)[IpIndex])) != EFI_SUCCESS) { + FreePool(StrTemp); + FreePool(*PtrIpList); + *PtrIpList = NULL; + *IpCount = 0; + return EFI_INVALID_PARAMETER; + } + + FreePool(StrTemp); + } + } + } + + return EFI_SUCCESS; +} + +/** + Convert the IPv4 address into a dotted string. + + @param[in] Ip The IPv4 address. + @param[out] Str The dotted IP string. + +**/ +VOID +Ip4Config2IpToStr ( + IN EFI_IPv4_ADDRESS *Ip, + OUT CHAR16 *Str + ) +{ + UnicodeSPrint ( + Str, + 2 * IP4_STR_MAX_SIZE, + L"%d.%d.%d.%d", + Ip->Addr[0], + Ip->Addr[1], + Ip->Addr[2], + Ip->Addr[3] + ); +} + + +/** + Convert the IPv4 address list into string consists of several decimal + dotted IPv4 addresses separated by space. + + @param[in] Ip The IPv4 address list. + @param[in] IpCount The size of IPv4 address list. + @param[out] Str The string contains several decimal dotted + IPv4 addresses separated by space. + + @retval EFI_SUCCESS Operation is success. + @retval EFI_OUT_OF_RESOURCES Error occurs in allocating memory. + +**/ +EFI_STATUS +Ip4Config2IpListToStr ( + IN EFI_IPv4_ADDRESS *Ip, + IN UINTN IpCount, + OUT CHAR16 *Str + ) +{ + UINTN Index; + UINTN TemIndex; + UINTN StrIndex; + CHAR16 *TempStr; + EFI_IPv4_ADDRESS *TempIp; + + Index = 0; + TemIndex = 0; + StrIndex = 0; + TempStr = NULL; + TempIp = NULL; + + for (Index = 0; Index < IpCount; Index ++) { + TempIp = Ip + Index; + if (TempStr == NULL) { + TempStr = AllocateZeroPool(2 * IP4_STR_MAX_SIZE); + if (TempStr == NULL) { + return EFI_OUT_OF_RESOURCES; + } + } + + UnicodeSPrint ( + TempStr, + 2 * IP4_STR_MAX_SIZE, + L"%d.%d.%d.%d", + TempIp->Addr[0], + TempIp->Addr[1], + TempIp->Addr[2], + TempIp->Addr[3] + ); + + for (TemIndex = 0; TemIndex < IP4_STR_MAX_SIZE; TemIndex ++) { + if (*(TempStr + TemIndex) == L'\0') { + if (Index == IpCount - 1) { + Str[StrIndex++] = L'\0'; + } else { + Str[StrIndex++] = L' '; + } + break; + } else { + Str[StrIndex++] = *(TempStr + TemIndex); + } + } + } + + if (TempStr != NULL) { + FreePool(TempStr); + } + + return EFI_SUCCESS; +} + +/** + The notify function of create event when performing a manual configuration. + + @param[in] Event The pointer of Event. + @param[in] Context The pointer of Context. + +**/ +VOID +EFIAPI +Ip4Config2ManualAddressNotify ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + *((BOOLEAN *) Context) = TRUE; +} + +/** + Convert the network configuration data into the IFR data. + + @param[in] Instance The IP4 config2 instance. + @param[in, out] IfrNvData The IFR nv data. + + @retval EFI_SUCCESS The configure parameter to IFR data was + set successfully. + @retval EFI_INVALID_PARAMETER Source instance or target IFR data is not available. + @retval Others Other errors as indicated. + +**/ +EFI_STATUS +Ip4Config2ConvertConfigNvDataToIfrNvData ( + IN IP4_CONFIG2_INSTANCE *Instance, + IN OUT IP4_CONFIG2_IFR_NVDATA *IfrNvData + ) +{ + IP4_SERVICE *IpSb; + EFI_IP4_CONFIG2_PROTOCOL *Ip4Config2; + EFI_IP4_CONFIG2_INTERFACE_INFO *Ip4Info; + EFI_IP4_CONFIG2_POLICY Policy; + UINTN DataSize; + UINTN GatewaySize; + EFI_IPv4_ADDRESS GatewayAddress; + EFI_STATUS Status; + UINTN DnsSize; + UINTN DnsCount; + EFI_IPv4_ADDRESS *DnsAddress; + + Status = EFI_SUCCESS; + Ip4Config2 = &Instance->Ip4Config2; + Ip4Info = NULL; + DnsAddress = NULL; + GatewaySize = sizeof (EFI_IPv4_ADDRESS); + + if ((IfrNvData == NULL) || (Instance == NULL)) { + return EFI_INVALID_PARAMETER; + } + + NET_CHECK_SIGNATURE (Instance, IP4_CONFIG2_INSTANCE_SIGNATURE); + + IpSb = IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance); + + if (IpSb->DefaultInterface->Configured) { + IfrNvData->Configure = 1; + } else { + IfrNvData->Configure = 0; + goto Exit; + } + + // + // Get the Policy info. + // + DataSize = sizeof (EFI_IP4_CONFIG2_POLICY); + Status = Ip4Config2->GetData ( + Ip4Config2, + Ip4Config2DataTypePolicy, + &DataSize, + &Policy + ); + if (EFI_ERROR (Status)) { + goto Exit; + } + + if (Policy == Ip4Config2PolicyStatic) { + IfrNvData->DhcpEnable = FALSE; + } else if (Policy == Ip4Config2PolicyDhcp) { + IfrNvData->DhcpEnable = TRUE; + goto Exit; + } + + // + // Get the interface info. + // + DataSize = 0; + Status = Ip4Config2->GetData ( + Ip4Config2, + Ip4Config2DataTypeInterfaceInfo, + &DataSize, + NULL + ); + if (Status != EFI_BUFFER_TOO_SMALL) { + return Status; + } + + Ip4Info = AllocateZeroPool (DataSize); + if (Ip4Info == NULL) { + Status = EFI_OUT_OF_RESOURCES; + return Status; + } + + Status = Ip4Config2->GetData ( + Ip4Config2, + Ip4Config2DataTypeInterfaceInfo, + &DataSize, + Ip4Info + ); + if (EFI_ERROR (Status)) { + goto Exit; + } + + // + // Get the Gateway info. + // + Status = Ip4Config2->GetData ( + Ip4Config2, + Ip4Config2DataTypeGateway, + &GatewaySize, + &GatewayAddress + ); + if (EFI_ERROR (Status)) { + goto Exit; + } + + // + // Get the Dns info. + // + DnsSize = 0; + Status = Ip4Config2->GetData ( + Ip4Config2, + Ip4Config2DataTypeDnsServer, + &DnsSize, + NULL + ); + if ((Status != EFI_BUFFER_TOO_SMALL) && (Status != EFI_NOT_FOUND)) { + goto Exit; + } + + DnsCount = (UINT32) (DnsSize / sizeof (EFI_IPv4_ADDRESS)); + + if (DnsSize > 0) { + DnsAddress = AllocateZeroPool(DnsSize); + if (DnsAddress == NULL) { + Status = EFI_OUT_OF_RESOURCES; + goto Exit; + } + + Status = Ip4Config2->GetData ( + Ip4Config2, + Ip4Config2DataTypeDnsServer, + &DnsSize, + DnsAddress + ); + if (EFI_ERROR (Status)) { + goto Exit; + } + } + + Ip4Config2IpToStr (&Ip4Info->StationAddress, IfrNvData->StationAddress); + Ip4Config2IpToStr (&Ip4Info->SubnetMask, IfrNvData->SubnetMask); + Ip4Config2IpToStr (&GatewayAddress, IfrNvData->GatewayAddress); + Status = Ip4Config2IpListToStr (DnsAddress, DnsCount, IfrNvData->DnsAddress); + +Exit: + + if (DnsAddress != NULL) { + FreePool(DnsAddress); + } + + if (Ip4Info != NULL) { + FreePool(Ip4Info); + } + + return Status; +} + +/** + Convert the IFR data into the network configuration data and set the IP + configure parameters for the NIC. + + @param[in] IfrFormNvData The IFR NV data. + @param[in, out] Instance The IP4 config2 instance. + + @retval EFI_SUCCESS The configure parameter for this NIC was + set successfully. + @retval EFI_INVALID_PARAMETER The address information for setting is invalid. + @retval Others Other errors as indicated. + +**/ +EFI_STATUS +Ip4Config2ConvertIfrNvDataToConfigNvData ( + IN IP4_CONFIG2_IFR_NVDATA *IfrFormNvData, + IN OUT IP4_CONFIG2_INSTANCE *Instance + ) +{ + EFI_STATUS Status; + EFI_IP4_CONFIG2_PROTOCOL *Ip4Cfg2; + IP4_CONFIG2_NVDATA *Ip4NvData; + + EFI_IP_ADDRESS StationAddress; + EFI_IP_ADDRESS SubnetMask; + EFI_IP_ADDRESS Gateway; + IP4_ADDR Ip; + EFI_IPv4_ADDRESS *DnsAddress; + UINTN DnsCount; + UINTN Index; + + EFI_EVENT TimeoutEvent; + EFI_EVENT SetAddressEvent; + BOOLEAN IsAddressOk; + UINTN DataSize; + EFI_INPUT_KEY Key; + + Status = EFI_SUCCESS; + Ip4Cfg2 = &Instance->Ip4Config2; + Ip4NvData = &Instance->Ip4NvData; + + DnsCount = 0; + DnsAddress = NULL; + + TimeoutEvent = NULL; + SetAddressEvent = NULL; + + + + if (Instance == NULL || IfrFormNvData == NULL) { + return EFI_INVALID_PARAMETER; + } + + if (IfrFormNvData->Configure != TRUE) { + return EFI_SUCCESS; + } + + if (IfrFormNvData->DhcpEnable == TRUE) { + Ip4NvData->Policy = Ip4Config2PolicyDhcp; + + Status = Ip4Cfg2->SetData ( + Ip4Cfg2, + Ip4Config2DataTypePolicy, + sizeof (EFI_IP4_CONFIG2_POLICY), + &Ip4NvData->Policy + ); + if (EFI_ERROR(Status)) { + return Status; + } + } else { + // + // Get Ip4NvData from IfrFormNvData if it is valid. + // + Ip4NvData->Policy = Ip4Config2PolicyStatic; + + Status = Ip4Config2StrToIp (IfrFormNvData->SubnetMask, &SubnetMask.v4); + if (EFI_ERROR (Status) || ((SubnetMask.Addr[0] != 0) && (GetSubnetMaskPrefixLength (&SubnetMask.v4) == 0))) { + CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid Subnet Mask!", NULL); + return EFI_INVALID_PARAMETER; + } + + Status = Ip4Config2StrToIp (IfrFormNvData->StationAddress, &StationAddress.v4); + if (EFI_ERROR (Status) || + (SubnetMask.Addr[0] != 0 && !NetIp4IsUnicast (NTOHL (StationAddress.Addr[0]), NTOHL (SubnetMask.Addr[0]))) || + !Ip4StationAddressValid (NTOHL (StationAddress.Addr[0]), NTOHL (SubnetMask.Addr[0]))) { + CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid IP address!", NULL); + return EFI_INVALID_PARAMETER; + } + + Status = Ip4Config2StrToIp (IfrFormNvData->GatewayAddress, &Gateway.v4); + if (EFI_ERROR (Status) || + (Gateway.Addr[0] != 0 && SubnetMask.Addr[0] != 0 && !NetIp4IsUnicast (NTOHL (Gateway.Addr[0]), NTOHL (SubnetMask.Addr[0])))) { + CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid Gateway!", NULL); + return EFI_INVALID_PARAMETER; + } + + Status = Ip4Config2StrToIpList (IfrFormNvData->DnsAddress, &DnsAddress, &DnsCount); + if (!EFI_ERROR (Status) && DnsCount > 0) { + for (Index = 0; Index < DnsCount; Index ++) { + CopyMem (&Ip, &DnsAddress[Index], sizeof (IP4_ADDR)); + if (IP4_IS_UNSPECIFIED (NTOHL (Ip)) || IP4_IS_LOCAL_BROADCAST (NTOHL (Ip))) { + CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid Dns Server!", NULL); + FreePool(DnsAddress); + return EFI_INVALID_PARAMETER; + } + } + } else { + if (EFI_ERROR (Status)) { + CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid Dns Server!", NULL); + } + } + + if (Ip4NvData->ManualAddress != NULL) { + FreePool(Ip4NvData->ManualAddress); + } + Ip4NvData->ManualAddressCount = 1; + Ip4NvData->ManualAddress = AllocateZeroPool(sizeof(EFI_IP4_CONFIG2_MANUAL_ADDRESS)); + if (Ip4NvData->ManualAddress == NULL) { + if (DnsAddress != NULL) { + FreePool(DnsAddress); + } + + return EFI_OUT_OF_RESOURCES; + } + CopyMem(&Ip4NvData->ManualAddress->Address, &StationAddress.v4, sizeof(EFI_IPv4_ADDRESS)); + CopyMem(&Ip4NvData->ManualAddress->SubnetMask, &SubnetMask.v4, sizeof(EFI_IPv4_ADDRESS)); + + if (Ip4NvData->GatewayAddress != NULL) { + FreePool(Ip4NvData->GatewayAddress); + } + Ip4NvData->GatewayAddressCount = 1; + Ip4NvData->GatewayAddress = AllocateZeroPool(sizeof(EFI_IPv4_ADDRESS)); + if (Ip4NvData->GatewayAddress == NULL) { + if (DnsAddress != NULL) { + FreePool(DnsAddress); + } + return EFI_OUT_OF_RESOURCES; + } + CopyMem(Ip4NvData->GatewayAddress, &Gateway.v4, sizeof(EFI_IPv4_ADDRESS)); + + if (Ip4NvData->DnsAddress != NULL) { + FreePool(Ip4NvData->DnsAddress); + } + Ip4NvData->DnsAddressCount = (UINT32) DnsCount; + Ip4NvData->DnsAddress = DnsAddress; + + // + // Setting Ip4NvData. + // + Status = Ip4Cfg2->SetData ( + Ip4Cfg2, + Ip4Config2DataTypePolicy, + sizeof (EFI_IP4_CONFIG2_POLICY), + &Ip4NvData->Policy + ); + if (EFI_ERROR(Status)) { + return Status; + } + + // + // Create events & timers for asynchronous settings. + // + Status = gBS->CreateEvent ( + EVT_TIMER, + TPL_CALLBACK, + NULL, + NULL, + &TimeoutEvent + ); + if (EFI_ERROR (Status)) { + return EFI_OUT_OF_RESOURCES; + } + + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, + Ip4Config2ManualAddressNotify, + &IsAddressOk, + &SetAddressEvent + ); + if (EFI_ERROR (Status)) { + goto Exit; + } + + IsAddressOk = FALSE; + + Status = Ip4Cfg2->RegisterDataNotify ( + Ip4Cfg2, + Ip4Config2DataTypeManualAddress, + SetAddressEvent + ); + if (EFI_ERROR (Status)) { + goto Exit; + } + + // + // Set ManualAddress. + // + DataSize = Ip4NvData->ManualAddressCount * sizeof (EFI_IP4_CONFIG2_MANUAL_ADDRESS); + Status = Ip4Cfg2->SetData ( + Ip4Cfg2, + Ip4Config2DataTypeManualAddress, + DataSize, + (VOID *) Ip4NvData->ManualAddress + ); + + if (Status == EFI_NOT_READY) { + gBS->SetTimer (TimeoutEvent, TimerRelative, 50000000); + while (EFI_ERROR (gBS->CheckEvent (TimeoutEvent))) { + if (IsAddressOk) { + Status = EFI_SUCCESS; + break; + } + } + } + + Ip4Cfg2->UnregisterDataNotify ( + Ip4Cfg2, + Ip4Config2DataTypeManualAddress, + SetAddressEvent + ); + if (EFI_ERROR (Status)) { + goto Exit; + } + + // + // Set gateway. + // + DataSize = Ip4NvData->GatewayAddressCount * sizeof (EFI_IPv4_ADDRESS); + Status = Ip4Cfg2->SetData ( + Ip4Cfg2, + Ip4Config2DataTypeGateway, + DataSize, + Ip4NvData->GatewayAddress + ); + if (EFI_ERROR (Status)) { + goto Exit; + } + + // + // Set DNS addresses. + // + if (Ip4NvData->DnsAddressCount > 0 && Ip4NvData->DnsAddress != NULL) { + DataSize = Ip4NvData->DnsAddressCount * sizeof (EFI_IPv4_ADDRESS); + Status = Ip4Cfg2->SetData ( + Ip4Cfg2, + Ip4Config2DataTypeDnsServer, + DataSize, + Ip4NvData->DnsAddress + ); + + if (EFI_ERROR (Status)) { + goto Exit; + } + } + } + +Exit: + if (SetAddressEvent != NULL) { + gBS->CloseEvent (SetAddressEvent); + } + + if (TimeoutEvent != NULL) { + gBS->CloseEvent (TimeoutEvent); + } + + return Status; +} + +/** + This function allows the caller to request the current + configuration for one or more named elements. The resulting + string is in format. Any and all alternative + configuration strings shall also be appended to the end of the + current configuration string. If they are, they must appear + after the current configuration. They must contain the same + routing (GUID, NAME, PATH) as the current configuration string. + They must have an additional description indicating the type of + alternative configuration the string represents, + "ALTCFG=". That (when + converted from Hex UNICODE to binary) is a reference to a + string in the associated string pack. + + @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL. + @param[in] Request A null-terminated Unicode string in + format. Note that this + includes the routing information as well as + the configurable name / value pairs. It is + invalid for this string to be in + format. + @param[out] Progress On return, points to a character in the + Request string. Points to the string's null + terminator if request was successful. Points + to the most recent "&" before the first + failing name / value pair (or the beginning + of the string if the failure is in the first + name / value pair) if the request was not + successful. + @param[out] Results A null-terminated Unicode string in + format which has all values + filled in for the names in the Request string. + String to be allocated by the called function. + + @retval EFI_SUCCESS The Results string is filled with the + values corresponding to all requested + names. + @retval EFI_OUT_OF_RESOURCES Not enough memory to store the + parts of the results that must be + stored awaiting possible future + protocols. + @retval EFI_NOT_FOUND Routing data doesn't match any + known driver. Progress set to the + first character in the routing header. + Note: There is no requirement that the + driver validate the routing data. It + must skip the in order to + process the names. + @retval EFI_INVALID_PARAMETER Illegal syntax. Progress set + to most recent & before the + error or the beginning of the + string. + @retval EFI_INVALID_PARAMETER Unknown name. Progress points + to the & before the name in + question.Currently not implemented. +**/ +EFI_STATUS +EFIAPI +Ip4FormExtractConfig ( + IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This, + IN CONST EFI_STRING Request, + OUT EFI_STRING *Progress, + OUT EFI_STRING *Results + ) +{ + EFI_STATUS Status; + IP4_CONFIG2_INSTANCE *Ip4Config2Instance; + IP4_FORM_CALLBACK_INFO *Private; + IP4_CONFIG2_IFR_NVDATA *IfrFormNvData; + EFI_STRING ConfigRequestHdr; + EFI_STRING ConfigRequest; + BOOLEAN AllocatedRequest; + EFI_STRING FormResult; + UINTN Size; + UINTN BufferSize; + + if (Progress == NULL || Results == NULL) { + return EFI_INVALID_PARAMETER; + } + + Status = EFI_SUCCESS; + IfrFormNvData = NULL; + ConfigRequest = NULL; + FormResult = NULL; + Size = 0; + AllocatedRequest = FALSE; + ConfigRequest = Request; + Private = IP4_FORM_CALLBACK_INFO_FROM_CONFIG_ACCESS(This); + Ip4Config2Instance = IP4_CONFIG2_INSTANCE_FROM_FORM_CALLBACK(Private); + BufferSize = sizeof (IP4_CONFIG2_IFR_NVDATA); + *Progress = Request; + + // + // Check Request data in . + // + if ((Request == NULL) || HiiIsConfigHdrMatch (Request, &gIp4Config2NvDataGuid, mIp4Config2StorageName)) { + IfrFormNvData = AllocateZeroPool (sizeof (IP4_CONFIG2_IFR_NVDATA)); + if (IfrFormNvData == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + Ip4Config2ConvertConfigNvDataToIfrNvData (Ip4Config2Instance, IfrFormNvData); + + if ((Request == NULL) || (StrStr (Request, L"OFFSET") == NULL)) { + // + // Request has no request element, construct full request string. + // Allocate and fill a buffer large enough to hold the template + // followed by "&OFFSET=0&WIDTH=WWWWWWWWWWWWWWWW" followed by a Null-terminator + // + ConfigRequestHdr = HiiConstructConfigHdr (&gIp4Config2NvDataGuid, mIp4Config2StorageName, Private->ChildHandle); + Size = (StrLen (ConfigRequestHdr) + 32 + 1) * sizeof (CHAR16); + ConfigRequest = AllocateZeroPool (Size); + if (ConfigRequest == NULL) { + Status = EFI_OUT_OF_RESOURCES; + goto Failure; + } + AllocatedRequest = TRUE; + + UnicodeSPrint (ConfigRequest, Size, L"%s&OFFSET=0&WIDTH=%016LX", ConfigRequestHdr, (UINT64)BufferSize); + FreePool (ConfigRequestHdr); + } + + // + // Convert buffer data to by helper function BlockToConfig() + // + Status = gHiiConfigRouting->BlockToConfig ( + gHiiConfigRouting, + ConfigRequest, + (UINT8 *) IfrFormNvData, + BufferSize, + &FormResult, + Progress + ); + + FreePool (IfrFormNvData); + + // + // Free the allocated config request string. + // + if (AllocatedRequest) { + FreePool (ConfigRequest); + ConfigRequest = NULL; + } + + if (EFI_ERROR (Status)) { + goto Failure; + } + } + + if (Request == NULL || HiiIsConfigHdrMatch (Request, &gIp4Config2NvDataGuid, mIp4Config2StorageName)) { + *Results = FormResult; + } else { + return EFI_NOT_FOUND; + } + +Failure: + // + // Set Progress string to the original request string. + // + if (Request == NULL) { + *Progress = NULL; + } else if (StrStr (Request, L"OFFSET") == NULL) { + *Progress = Request + StrLen (Request); + } + + return Status; +} + +/** + This function applies changes in a driver's configuration. + Input is a Configuration, which has the routing data for this + driver followed by name / value configuration pairs. The driver + must apply those pairs to its configurable storage. If the + driver's configuration is stored in a linear block of data + and the driver's name / value pairs are in + format, it may use the ConfigToBlock helper function (above) to + simplify the job. Currently not implemented. + + @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL. + @param[in] Configuration A null-terminated Unicode string in + format. + @param[out] Progress A pointer to a string filled in with the + offset of the most recent '&' before the + first failing name / value pair (or the + beginn ing of the string if the failure + is in the first name / value pair) or + the terminating NULL if all was + successful. + + @retval EFI_SUCCESS The results have been distributed or are + awaiting distribution. + @retval EFI_OUT_OF_MEMORY Not enough memory to store the + parts of the results that must be + stored awaiting possible future + protocols. + @retval EFI_INVALID_PARAMETERS Passing in a NULL for the + Results parameter would result + in this type of error. + @retval EFI_NOT_FOUND Target for the specified routing data + was not found. +**/ +EFI_STATUS +EFIAPI +Ip4FormRouteConfig ( + IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This, + IN CONST EFI_STRING Configuration, + OUT EFI_STRING *Progress + ) +{ + EFI_STATUS Status; + UINTN BufferSize; + IP4_CONFIG2_IFR_NVDATA *IfrFormNvData; + IP4_CONFIG2_INSTANCE *Ip4Config2Instance; + IP4_FORM_CALLBACK_INFO *Private; + + Status = EFI_SUCCESS; + IfrFormNvData = NULL; + + if (Configuration == NULL || Progress == NULL) { + return EFI_INVALID_PARAMETER; + } + + *Progress = Configuration; + + Private = IP4_FORM_CALLBACK_INFO_FROM_CONFIG_ACCESS(This); + Ip4Config2Instance = IP4_CONFIG2_INSTANCE_FROM_FORM_CALLBACK(Private); + + // + // Check Routing data in . + // + if (HiiIsConfigHdrMatch (Configuration, &gIp4Config2NvDataGuid, mIp4Config2StorageName)) { + // + // Convert buffer data to by helper function BlockToConfig() + // + IfrFormNvData = AllocateZeroPool (sizeof (IP4_CONFIG2_IFR_NVDATA)); + if (IfrFormNvData == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + BufferSize = 0; + + Status = gHiiConfigRouting->ConfigToBlock ( + gHiiConfigRouting, + Configuration, + (UINT8 *) IfrFormNvData, + &BufferSize, + Progress + ); + if (Status != EFI_BUFFER_TOO_SMALL) { + return Status; + } + + Status = gHiiConfigRouting->ConfigToBlock ( + gHiiConfigRouting, + Configuration, + (UINT8 *) IfrFormNvData, + &BufferSize, + Progress + ); + if (!EFI_ERROR (Status)) { + Status = Ip4Config2ConvertIfrNvDataToConfigNvData (IfrFormNvData, Ip4Config2Instance); + } + + FreePool (IfrFormNvData); + } else { + return EFI_NOT_FOUND; + } + + return Status; + +} + +/** + This function is called to provide results data to the driver. + This data consists of a unique key that is used to identify + which data is either being passed back or being asked for. + + @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL. + @param[in] Action Specifies the type of action taken by the browser. + @param[in] QuestionId A unique value which is sent to the original + exporting driver so that it can identify the type + of data to expect. The format of the data tends to + vary based on the opcode that enerated the callback. + @param[in] Type The type of value for the question. + @param[in] Value A pointer to the data being sent to the original + exporting driver. + @param[out] ActionRequest On return, points to the action requested by the + callback function. + + @retval EFI_SUCCESS The callback successfully handled the action. + @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the + variable and its data. + @retval EFI_DEVICE_ERROR The variable could not be saved. + @retval EFI_UNSUPPORTED The specified Action is not supported by the + callback.Currently not implemented. + @retval EFI_INVALID_PARAMETERS Passing in wrong parameter. + @retval Others Other errors as indicated. + +**/ +EFI_STATUS +EFIAPI +Ip4FormCallback ( + IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This, + IN EFI_BROWSER_ACTION Action, + IN EFI_QUESTION_ID QuestionId, + IN UINT8 Type, + IN EFI_IFR_TYPE_VALUE *Value, + OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest + ) +{ + EFI_STATUS Status; + IP4_CONFIG2_INSTANCE *Instance; + IP4_CONFIG2_IFR_NVDATA *IfrFormNvData; + IP4_FORM_CALLBACK_INFO *Private; + + EFI_IP_ADDRESS StationAddress; + EFI_IP_ADDRESS SubnetMask; + EFI_IP_ADDRESS Gateway; + IP4_ADDR Ip; + EFI_IPv4_ADDRESS *DnsAddress; + UINTN DnsCount; + UINTN Index; + EFI_INPUT_KEY Key; + + IfrFormNvData = NULL; + DnsCount = 0; + DnsAddress = NULL; + + if (Action == EFI_BROWSER_ACTION_CHANGED) { + Private = IP4_FORM_CALLBACK_INFO_FROM_CONFIG_ACCESS(This); + Instance = IP4_CONFIG2_INSTANCE_FROM_FORM_CALLBACK(Private); + + IfrFormNvData = AllocateZeroPool (sizeof (IP4_CONFIG2_IFR_NVDATA)); + if (IfrFormNvData == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + // + // Retrieve uncommitted data from Browser + // + if (!HiiGetBrowserData (&gIp4Config2NvDataGuid, mIp4Config2StorageName, sizeof (IP4_CONFIG2_IFR_NVDATA), (UINT8 *) IfrFormNvData)) { + FreePool (IfrFormNvData); + return EFI_NOT_FOUND; + } + + Status = EFI_SUCCESS; + + switch (QuestionId) { + case KEY_LOCAL_IP: + Status = Ip4Config2StrToIp (IfrFormNvData->StationAddress, &StationAddress.v4); + if (EFI_ERROR (Status) || IP4_IS_UNSPECIFIED (NTOHL (StationAddress.Addr[0])) || IP4_IS_LOCAL_BROADCAST (NTOHL (StationAddress.Addr[0]))) { + CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid IP address!", NULL); + Status = EFI_INVALID_PARAMETER; + } + break; + + case KEY_SUBNET_MASK: + Status = Ip4Config2StrToIp (IfrFormNvData->SubnetMask, &SubnetMask.v4); + if (EFI_ERROR (Status) || ((SubnetMask.Addr[0] != 0) && (GetSubnetMaskPrefixLength (&SubnetMask.v4) == 0))) { + CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid Subnet Mask!", NULL); + Status = EFI_INVALID_PARAMETER; + } + break; + + case KEY_GATE_WAY: + Status = Ip4Config2StrToIp (IfrFormNvData->GatewayAddress, &Gateway.v4); + if (EFI_ERROR (Status) || IP4_IS_LOCAL_BROADCAST(NTOHL(Gateway.Addr[0]))) { + CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid Gateway!", NULL); + Status = EFI_INVALID_PARAMETER; + } + break; + + case KEY_DNS: + Status = Ip4Config2StrToIpList (IfrFormNvData->DnsAddress, &DnsAddress, &DnsCount); + if (!EFI_ERROR (Status) && DnsCount > 0) { + for (Index = 0; Index < DnsCount; Index ++) { + CopyMem (&Ip, &DnsAddress[Index], sizeof (IP4_ADDR)); + if (IP4_IS_UNSPECIFIED (NTOHL (Ip)) || IP4_IS_LOCAL_BROADCAST (NTOHL (Ip))) { + CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid Dns Server!", NULL); + Status = EFI_INVALID_PARAMETER; + break; + } + } + } else { + if (EFI_ERROR (Status)) { + CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid Dns Server!", NULL); + } + } + + if(DnsAddress != NULL) { + FreePool(DnsAddress); + } + break; + + case KEY_SAVE_CHANGES: + Status = Ip4Config2ConvertIfrNvDataToConfigNvData (IfrFormNvData, Instance); + *ActionRequest = EFI_BROWSER_ACTION_REQUEST_SUBMIT; + break; + + default: + break; + } + + FreePool (IfrFormNvData); + + return Status; + } + + // + // All other action return unsupported. + // + return EFI_UNSUPPORTED; +} + +/** + Install HII Config Access protocol for network device and allocate resource. + + @param[in, out] Instance The IP4 config2 Instance. + + @retval EFI_SUCCESS The HII Config Access protocol is installed. + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory. + @retval Others Other errors as indicated. + +**/ +EFI_STATUS +Ip4Config2FormInit ( + IN OUT IP4_CONFIG2_INSTANCE *Instance + ) +{ + EFI_STATUS Status; + IP4_SERVICE *IpSb; + IP4_FORM_CALLBACK_INFO *CallbackInfo; + EFI_HII_CONFIG_ACCESS_PROTOCOL *ConfigAccess; + VENDOR_DEVICE_PATH VendorDeviceNode; + EFI_SERVICE_BINDING_PROTOCOL *MnpSb; + CHAR16 *MacString; + CHAR16 MenuString[128]; + CHAR16 PortString[128]; + CHAR16 *OldMenuString; + EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath; + + IpSb = IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance); + ASSERT (IpSb != NULL); + + CallbackInfo = &Instance->CallbackInfo; + + CallbackInfo->Signature = IP4_FORM_CALLBACK_INFO_SIGNATURE; + + Status = gBS->HandleProtocol ( + IpSb->Controller, + &gEfiDevicePathProtocolGuid, + (VOID **) &ParentDevicePath + ); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Construct device path node for EFI HII Config Access protocol, + // which consists of controller physical device path and one hardware + // vendor guid node. + // + ZeroMem (&VendorDeviceNode, sizeof (VENDOR_DEVICE_PATH)); + VendorDeviceNode.Header.Type = HARDWARE_DEVICE_PATH; + VendorDeviceNode.Header.SubType = HW_VENDOR_DP; + + CopyGuid (&VendorDeviceNode.Guid, &gEfiCallerIdGuid); + + SetDevicePathNodeLength (&VendorDeviceNode.Header, sizeof (VENDOR_DEVICE_PATH)); + CallbackInfo->HiiVendorDevicePath = AppendDevicePathNode ( + ParentDevicePath, + (EFI_DEVICE_PATH_PROTOCOL *) &VendorDeviceNode + ); + if (CallbackInfo->HiiVendorDevicePath == NULL) { + Status = EFI_OUT_OF_RESOURCES; + goto Error; + } + + ConfigAccess = &CallbackInfo->HiiConfigAccessProtocol; + ConfigAccess->ExtractConfig = Ip4FormExtractConfig; + ConfigAccess->RouteConfig = Ip4FormRouteConfig; + ConfigAccess->Callback = Ip4FormCallback; + + // + // Install Device Path Protocol and Config Access protocol on new handle + // + Status = gBS->InstallMultipleProtocolInterfaces ( + &CallbackInfo->ChildHandle, + &gEfiDevicePathProtocolGuid, + CallbackInfo->HiiVendorDevicePath, + &gEfiHiiConfigAccessProtocolGuid, + ConfigAccess, + NULL + ); + + if (!EFI_ERROR (Status)) { + // + // Open the Parent Handle for the child + // + Status = gBS->OpenProtocol ( + IpSb->Controller, + &gEfiManagedNetworkServiceBindingProtocolGuid, + (VOID **) &MnpSb, + IpSb->Image, + CallbackInfo->ChildHandle, + EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER + ); + } + + if (EFI_ERROR (Status)) { + goto Error; + } + + // + // Publish our HII data + // + CallbackInfo->RegisteredHandle = HiiAddPackages ( + &gIp4Config2NvDataGuid, + CallbackInfo->ChildHandle, + Ip4DxeStrings, + Ip4Config2Bin, + NULL + ); + if (CallbackInfo->RegisteredHandle == NULL) { + Status = EFI_OUT_OF_RESOURCES; + goto Error; + } + + // + // Append MAC string in the menu help string and tile help string + // + Status = NetLibGetMacString (IpSb->Controller, IpSb->Image, &MacString); + if (!EFI_ERROR (Status)) { + OldMenuString = HiiGetString ( + CallbackInfo->RegisteredHandle, + STRING_TOKEN (STR_IP4_CONFIG2_FORM_HELP), + NULL + ); + UnicodeSPrint (MenuString, 128, L"%s (MAC:%s)", OldMenuString, MacString); + HiiSetString ( + CallbackInfo->RegisteredHandle, + STRING_TOKEN (STR_IP4_CONFIG2_FORM_HELP), + MenuString, + NULL + ); + + UnicodeSPrint (PortString, 128, L"MAC:%s", MacString); + HiiSetString ( + CallbackInfo->RegisteredHandle, + STRING_TOKEN (STR_IP4_DEVICE_FORM_HELP), + PortString, + NULL + ); + + FreePool (MacString); + FreePool (OldMenuString); + + return EFI_SUCCESS; + } + +Error: + Ip4Config2FormUnload (Instance); + return Status; +} + +/** + Uninstall the HII Config Access protocol for network devices and free up the resources. + + @param[in, out] Instance The IP4 config2 instance to unload a form. + +**/ +VOID +Ip4Config2FormUnload ( + IN OUT IP4_CONFIG2_INSTANCE *Instance + ) +{ + IP4_SERVICE *IpSb; + IP4_FORM_CALLBACK_INFO *CallbackInfo; + IP4_CONFIG2_NVDATA *Ip4NvData; + + IpSb = IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance); + ASSERT (IpSb != NULL); + + CallbackInfo = &Instance->CallbackInfo; + + if (CallbackInfo->ChildHandle != NULL) { + // + // Close the child handle + // + gBS->CloseProtocol ( + IpSb->Controller, + &gEfiManagedNetworkServiceBindingProtocolGuid, + IpSb->Image, + CallbackInfo->ChildHandle + ); + + // + // Uninstall EFI_HII_CONFIG_ACCESS_PROTOCOL + // + gBS->UninstallMultipleProtocolInterfaces ( + CallbackInfo->ChildHandle, + &gEfiDevicePathProtocolGuid, + CallbackInfo->HiiVendorDevicePath, + &gEfiHiiConfigAccessProtocolGuid, + &CallbackInfo->HiiConfigAccessProtocol, + NULL + ); + } + + if (CallbackInfo->HiiVendorDevicePath != NULL) { + FreePool (CallbackInfo->HiiVendorDevicePath); + } + + if (CallbackInfo->RegisteredHandle != NULL) { + // + // Remove HII package list + // + HiiRemovePackages (CallbackInfo->RegisteredHandle); + } + + Ip4NvData = &Instance->Ip4NvData; + + if(Ip4NvData->ManualAddress != NULL) { + FreePool(Ip4NvData->ManualAddress); + } + + if(Ip4NvData->GatewayAddress != NULL) { + FreePool(Ip4NvData->GatewayAddress); + } + + if(Ip4NvData->DnsAddress != NULL) { + FreePool(Ip4NvData->DnsAddress); + } + + Ip4NvData->ManualAddressCount = 0; + Ip4NvData->GatewayAddressCount = 0; + Ip4NvData->DnsAddressCount = 0; +} diff --git a/NetworkPkg/Ip4Dxe/Ip4Config2Nv.h b/NetworkPkg/Ip4Dxe/Ip4Config2Nv.h new file mode 100644 index 0000000000..f453e19e9b --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4Config2Nv.h @@ -0,0 +1,45 @@ +/** @file + The header file of IP4Config2Nv.c + +Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef _IP4_CONFIG2NV_H_ +#define _IP4_CONFIG2NV_H_ + +#include "Ip4Impl.h" + +extern UINT8 Ip4Config2Bin[]; +extern UINT8 Ip4DxeStrings[]; + +#define NIC_ITEM_CONFIG_SIZE (sizeof (IP4_CONFIG2_INSTANCE) + (sizeof (EFI_IPv4_ADDRESS) * MAX_IP4_CONFIG_DNS)) + +/** + Install HII Config Access protocol for network device and allocate resource. + + @param[in, out] Instance The IP4 config2 Instance. + + @retval EFI_SUCCESS The HII Config Access protocol is installed. + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory. + @retval Others Other errors as indicated. + +**/ +EFI_STATUS +Ip4Config2FormInit ( + IN OUT IP4_CONFIG2_INSTANCE *Instance + ); + +/** + Uninstall the HII Config Access protocol for network devices and free up the resources. + + @param[in, out] Instance The IP4 config2 instance to unload a form. + +**/ +VOID +Ip4Config2FormUnload ( + IN OUT IP4_CONFIG2_INSTANCE *Instance + ); + +#endif diff --git a/NetworkPkg/Ip4Dxe/Ip4Driver.c b/NetworkPkg/Ip4Dxe/Ip4Driver.c new file mode 100644 index 0000000000..ebd4dec1df --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4Driver.c @@ -0,0 +1,1069 @@ +/** @file + The driver binding and service binding protocol for IP4 driver. + +Copyright (c) 2005 - 2019, Intel Corporation. All rights reserved.
+(C) Copyright 2015 Hewlett-Packard Development Company, L.P.
+ +SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Ip4Impl.h" + +EFI_DRIVER_BINDING_PROTOCOL gIp4DriverBinding = { + Ip4DriverBindingSupported, + Ip4DriverBindingStart, + Ip4DriverBindingStop, + 0xa, + NULL, + NULL +}; + +BOOLEAN mIpSec2Installed = FALSE; + +/** + Callback function for IpSec2 Protocol install. + + @param[in] Event Event whose notification function is being invoked + @param[in] Context Pointer to the notification function's context + +**/ +VOID +EFIAPI +IpSec2InstalledCallback ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + EFI_STATUS Status; + // + // Test if protocol was even found. + // Notification function will be called at least once. + // + Status = gBS->LocateProtocol (&gEfiIpSec2ProtocolGuid, NULL, (VOID **)&mIpSec); + if (Status == EFI_SUCCESS && mIpSec != NULL) { + // + // Close the event so it does not get called again. + // + gBS->CloseEvent (Event); + + mIpSec2Installed = TRUE; + } +} + +/** + This is the declaration of an EFI image entry point. This entry point is + the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including + both device drivers and bus drivers. + + The entry point for IP4 driver which install the driver + binding and component name protocol on its image. + + @param[in] ImageHandle The firmware allocated handle for the UEFI image. + @param[in] SystemTable A pointer to the EFI System Table. + + @retval EFI_SUCCESS The operation completed successfully. + @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. + +**/ +EFI_STATUS +EFIAPI +Ip4DriverEntryPoint ( + IN EFI_HANDLE ImageHandle, + IN EFI_SYSTEM_TABLE *SystemTable + ) +{ + VOID *Registration; + + EfiCreateProtocolNotifyEvent ( + &gEfiIpSec2ProtocolGuid, + TPL_CALLBACK, + IpSec2InstalledCallback, + NULL, + &Registration + ); + + return EfiLibInstallDriverBindingComponentName2 ( + ImageHandle, + SystemTable, + &gIp4DriverBinding, + ImageHandle, + &gIp4ComponentName, + &gIp4ComponentName2 + ); +} + +/** + Test to see if this driver supports ControllerHandle. This service + is called by the EFI boot service ConnectController(). In + order to make drivers as small as possible, there are a few calling + restrictions for this service. ConnectController() must + follow these calling restrictions. If any other agent wishes to call + Supported() it must also follow these calling restrictions. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to test + @param[in] RemainingDevicePath Optional parameter use to pick a specific child + device to start. + + @retval EFI_SUCCESS This driver supports this device + @retval EFI_ALREADY_STARTED This driver is already running on this device + @retval other This driver does not support this device + +**/ +EFI_STATUS +EFIAPI +Ip4DriverBindingSupported ( + IN EFI_DRIVER_BINDING_PROTOCOL * This, + IN EFI_HANDLE ControllerHandle, + IN EFI_DEVICE_PATH_PROTOCOL * RemainingDevicePath OPTIONAL + ) +{ + EFI_STATUS Status; + + // + // Test for the MNP service binding Protocol + // + Status = gBS->OpenProtocol ( + ControllerHandle, + &gEfiManagedNetworkServiceBindingProtocolGuid, + NULL, + This->DriverBindingHandle, + ControllerHandle, + EFI_OPEN_PROTOCOL_TEST_PROTOCOL + ); + + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Test for the Arp service binding Protocol + // + Status = gBS->OpenProtocol ( + ControllerHandle, + &gEfiArpServiceBindingProtocolGuid, + NULL, + This->DriverBindingHandle, + ControllerHandle, + EFI_OPEN_PROTOCOL_TEST_PROTOCOL + ); + + return Status; +} + +/** + Clean up a IP4 service binding instance. It will release all + the resource allocated by the instance. The instance may be + partly initialized, or partly destroyed. If a resource is + destroyed, it is marked as that in case the destroy failed and + being called again later. + + @param[in] IpSb The IP4 service binding instance to clean up + + @retval EFI_SUCCESS The resource used by the instance are cleaned up + @retval other Failed to clean up some of the resources. + +**/ +EFI_STATUS +Ip4CleanService ( + IN IP4_SERVICE *IpSb + ); + + +/** + Create a new IP4 driver service binding private instance. + + @param Controller The controller that has MNP service binding + installed + @param ImageHandle The IP4 driver's image handle + @param Service The variable to receive the newly created IP4 + service. + + @retval EFI_OUT_OF_RESOURCES Failed to allocate some resource + @retval EFI_SUCCESS A new IP4 service binding private is created. + @retval other Other error occurs. + +**/ +EFI_STATUS +Ip4CreateService ( + IN EFI_HANDLE Controller, + IN EFI_HANDLE ImageHandle, + OUT IP4_SERVICE **Service + ) +{ + IP4_SERVICE *IpSb; + EFI_STATUS Status; + + ASSERT (Service != NULL); + + *Service = NULL; + + // + // allocate a service private data then initialize all the filed to + // empty resources, so if any thing goes wrong when allocating + // resources, Ip4CleanService can be called to clean it up. + // + IpSb = AllocateZeroPool (sizeof (IP4_SERVICE)); + + if (IpSb == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + IpSb->Signature = IP4_SERVICE_SIGNATURE; + IpSb->ServiceBinding.CreateChild = Ip4ServiceBindingCreateChild; + IpSb->ServiceBinding.DestroyChild = Ip4ServiceBindingDestroyChild; + IpSb->State = IP4_SERVICE_UNSTARTED; + + IpSb->NumChildren = 0; + InitializeListHead (&IpSb->Children); + + InitializeListHead (&IpSb->Interfaces); + IpSb->DefaultInterface = NULL; + IpSb->DefaultRouteTable = NULL; + + Ip4InitAssembleTable (&IpSb->Assemble); + + IpSb->IgmpCtrl.Igmpv1QuerySeen = 0; + InitializeListHead (&IpSb->IgmpCtrl.Groups); + + IpSb->Image = ImageHandle; + IpSb->Controller = Controller; + + IpSb->MnpChildHandle = NULL; + IpSb->Mnp = NULL; + + IpSb->MnpConfigData.ReceivedQueueTimeoutValue = 0; + IpSb->MnpConfigData.TransmitQueueTimeoutValue = 0; + IpSb->MnpConfigData.ProtocolTypeFilter = IP4_ETHER_PROTO; + IpSb->MnpConfigData.EnableUnicastReceive = TRUE; + IpSb->MnpConfigData.EnableMulticastReceive = TRUE; + IpSb->MnpConfigData.EnableBroadcastReceive = TRUE; + IpSb->MnpConfigData.EnablePromiscuousReceive = FALSE; + IpSb->MnpConfigData.FlushQueuesOnReset = TRUE; + IpSb->MnpConfigData.EnableReceiveTimestamps = FALSE; + IpSb->MnpConfigData.DisableBackgroundPolling = FALSE; + + ZeroMem (&IpSb->SnpMode, sizeof (EFI_SIMPLE_NETWORK_MODE)); + + IpSb->Timer = NULL; + IpSb->ReconfigCheckTimer = NULL; + + IpSb->ReconfigEvent = NULL; + + IpSb->Reconfig = FALSE; + + IpSb->MediaPresent = TRUE; + + // + // Create various resources. First create the route table, timer + // event, ReconfigEvent and MNP child. IGMP, interface's initialization depend + // on the MNP child. + // + IpSb->DefaultRouteTable = Ip4CreateRouteTable (); + + if (IpSb->DefaultRouteTable == NULL) { + Status = EFI_OUT_OF_RESOURCES; + goto ON_ERROR; + } + + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL | EVT_TIMER, + TPL_CALLBACK, + Ip4TimerTicking, + IpSb, + &IpSb->Timer + ); + + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL | EVT_TIMER, + TPL_CALLBACK, + Ip4TimerReconfigChecking, + IpSb, + &IpSb->ReconfigCheckTimer + ); + + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, + Ip4AutoReconfigCallBack, + IpSb, + &IpSb->ReconfigEvent + ); + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + Status = NetLibCreateServiceChild ( + Controller, + ImageHandle, + &gEfiManagedNetworkServiceBindingProtocolGuid, + &IpSb->MnpChildHandle + ); + + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + Status = gBS->OpenProtocol ( + IpSb->MnpChildHandle, + &gEfiManagedNetworkProtocolGuid, + (VOID **) &IpSb->Mnp, + ImageHandle, + Controller, + EFI_OPEN_PROTOCOL_BY_DRIVER + ); + + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + Status = Ip4ServiceConfigMnp (IpSb, TRUE); + + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + Status = IpSb->Mnp->GetModeData (IpSb->Mnp, NULL, &IpSb->SnpMode); + + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + Status = Ip4InitIgmp (IpSb); + + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + IpSb->MacString = NULL; + Status = NetLibGetMacString (IpSb->Controller, IpSb->Image, &IpSb->MacString); + + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + IpSb->DefaultInterface = Ip4CreateInterface (IpSb->Mnp, Controller, ImageHandle); + + if (IpSb->DefaultInterface == NULL) { + Status = EFI_OUT_OF_RESOURCES; + goto ON_ERROR; + } + + InsertHeadList (&IpSb->Interfaces, &IpSb->DefaultInterface->Link); + + ZeroMem (&IpSb->Ip4Config2Instance, sizeof (IP4_CONFIG2_INSTANCE)); + + Status = Ip4Config2InitInstance (&IpSb->Ip4Config2Instance); + + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + IpSb->MaxPacketSize = IpSb->SnpMode.MaxPacketSize - sizeof (IP4_HEAD); + if (NetLibGetVlanId (IpSb->Controller) != 0) { + // + // This is a VLAN device, reduce MTU by VLAN tag length + // + IpSb->MaxPacketSize -= NET_VLAN_TAG_LEN; + } + IpSb->OldMaxPacketSize = IpSb->MaxPacketSize; + *Service = IpSb; + + return EFI_SUCCESS; + +ON_ERROR: + Ip4CleanService (IpSb); + FreePool (IpSb); + + return Status; +} + + +/** + Clean up a IP4 service binding instance. It will release all + the resource allocated by the instance. The instance may be + partly initialized, or partly destroyed. If a resource is + destroyed, it is marked as that in case the destroy failed and + being called again later. + + @param[in] IpSb The IP4 service binding instance to clean up + + @retval EFI_SUCCESS The resource used by the instance are cleaned up + @retval other Failed to clean up some of the resources. + +**/ +EFI_STATUS +Ip4CleanService ( + IN IP4_SERVICE *IpSb + ) +{ + EFI_STATUS Status; + + IpSb->State = IP4_SERVICE_DESTROY; + + if (IpSb->Timer != NULL) { + gBS->SetTimer (IpSb->Timer, TimerCancel, 0); + gBS->CloseEvent (IpSb->Timer); + + IpSb->Timer = NULL; + } + + if (IpSb->ReconfigCheckTimer != NULL) { + gBS->SetTimer (IpSb->ReconfigCheckTimer, TimerCancel, 0); + gBS->CloseEvent (IpSb->ReconfigCheckTimer); + + IpSb->ReconfigCheckTimer = NULL; + } + + if (IpSb->DefaultInterface != NULL) { + Status = Ip4FreeInterface (IpSb->DefaultInterface, NULL); + + if (EFI_ERROR (Status)) { + return Status; + } + + IpSb->DefaultInterface = NULL; + } + + if (IpSb->DefaultRouteTable != NULL) { + Ip4FreeRouteTable (IpSb->DefaultRouteTable); + IpSb->DefaultRouteTable = NULL; + } + + Ip4CleanAssembleTable (&IpSb->Assemble); + + if (IpSb->MnpChildHandle != NULL) { + if (IpSb->Mnp != NULL) { + gBS->CloseProtocol ( + IpSb->MnpChildHandle, + &gEfiManagedNetworkProtocolGuid, + IpSb->Image, + IpSb->Controller + ); + + IpSb->Mnp = NULL; + } + + NetLibDestroyServiceChild ( + IpSb->Controller, + IpSb->Image, + &gEfiManagedNetworkServiceBindingProtocolGuid, + IpSb->MnpChildHandle + ); + + IpSb->MnpChildHandle = NULL; + } + + if (IpSb->ReconfigEvent != NULL) { + gBS->CloseEvent (IpSb->ReconfigEvent); + + IpSb->ReconfigEvent = NULL; + } + + IpSb->Reconfig = FALSE; + + if (IpSb->MacString != NULL) { + FreePool (IpSb->MacString); + } + + Ip4Config2CleanInstance (&IpSb->Ip4Config2Instance); + + return EFI_SUCCESS; +} + +/** + Callback function which provided by user to remove one node in NetDestroyLinkList process. + + @param[in] Entry The entry to be removed. + @param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList. + + @retval EFI_SUCCESS The entry has been removed successfully. + @retval Others Fail to remove the entry. + +**/ +EFI_STATUS +EFIAPI +Ip4DestroyChildEntryInHandleBuffer ( + IN LIST_ENTRY *Entry, + IN VOID *Context + ) +{ + IP4_PROTOCOL *IpInstance; + EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; + UINTN NumberOfChildren; + EFI_HANDLE *ChildHandleBuffer; + + if (Entry == NULL || Context == NULL) { + return EFI_INVALID_PARAMETER; + } + + IpInstance = NET_LIST_USER_STRUCT_S (Entry, IP4_PROTOCOL, Link, IP4_PROTOCOL_SIGNATURE); + ServiceBinding = ((IP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *) Context)->ServiceBinding; + NumberOfChildren = ((IP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *) Context)->NumberOfChildren; + ChildHandleBuffer = ((IP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *) Context)->ChildHandleBuffer; + + if (!NetIsInHandleBuffer (IpInstance->Handle, NumberOfChildren, ChildHandleBuffer)) { + return EFI_SUCCESS; + } + + return ServiceBinding->DestroyChild (ServiceBinding, IpInstance->Handle); +} + +/** + Start this driver on ControllerHandle. This service is called by the + EFI boot service ConnectController(). In order to make + drivers as small as possible, there are a few calling restrictions for + this service. ConnectController() must follow these + calling restrictions. If any other agent wishes to call Start() it + must also follow these calling restrictions. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to bind driver to + @param[in] RemainingDevicePath Optional parameter use to pick a specific child + device to start. + + @retval EFI_SUCCESS This driver is added to ControllerHandle + @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle + @retval other This driver does not support this device + +**/ +EFI_STATUS +EFIAPI +Ip4DriverBindingStart ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL + ) +{ + EFI_STATUS Status; + IP4_SERVICE *IpSb; + EFI_IP4_CONFIG2_PROTOCOL *Ip4Cfg2; + UINTN Index; + IP4_CONFIG2_DATA_ITEM *DataItem; + + IpSb = NULL; + Ip4Cfg2 = NULL; + DataItem = NULL; + + // + // Test for the Ip4 service binding protocol + // + Status = gBS->OpenProtocol ( + ControllerHandle, + &gEfiIp4ServiceBindingProtocolGuid, + NULL, + This->DriverBindingHandle, + ControllerHandle, + EFI_OPEN_PROTOCOL_TEST_PROTOCOL + ); + + if (Status == EFI_SUCCESS) { + return EFI_ALREADY_STARTED; + } + + Status = Ip4CreateService (ControllerHandle, This->DriverBindingHandle, &IpSb); + + if (EFI_ERROR (Status)) { + return Status; + } + + ASSERT (IpSb != NULL); + + Ip4Cfg2 = &IpSb->Ip4Config2Instance.Ip4Config2; + + // + // Install the Ip4ServiceBinding Protocol onto ControlerHandle + // + Status = gBS->InstallMultipleProtocolInterfaces ( + &ControllerHandle, + &gEfiIp4ServiceBindingProtocolGuid, + &IpSb->ServiceBinding, + &gEfiIp4Config2ProtocolGuid, + Ip4Cfg2, + NULL + ); + + if (EFI_ERROR (Status)) { + goto FREE_SERVICE; + } + + // + // Read the config data from NV variable again. + // The default data can be changed by other drivers. + // + Status = Ip4Config2ReadConfigData (IpSb->MacString, &IpSb->Ip4Config2Instance); + if (EFI_ERROR (Status)) { + goto UNINSTALL_PROTOCOL; + } + + // + // Consume the installed EFI_IP4_CONFIG2_PROTOCOL to set the default data items. + // + for (Index = Ip4Config2DataTypePolicy; Index < Ip4Config2DataTypeMaximum; Index++) { + DataItem = &IpSb->Ip4Config2Instance.DataItem[Index]; + if (DataItem->Data.Ptr != NULL) { + Status = Ip4Cfg2->SetData ( + Ip4Cfg2, + Index, + DataItem->DataSize, + DataItem->Data.Ptr + ); + if (EFI_ERROR(Status)) { + goto UNINSTALL_PROTOCOL; + } + + if (Index == Ip4Config2DataTypePolicy && (*(DataItem->Data.Policy) == Ip4Config2PolicyDhcp)) { + break; + } + } + } + + // + // Ready to go: start the receiving and timer. + // Ip4Config2SetPolicy maybe call Ip4ReceiveFrame() to set the default interface's RecvRequest first after + // Ip4Config2 instance is initialized. So, EFI_ALREADY_STARTED is the allowed return status. + // + Status = Ip4ReceiveFrame (IpSb->DefaultInterface, NULL, Ip4AccpetFrame, IpSb); + + if (EFI_ERROR (Status) && Status != EFI_ALREADY_STARTED) { + goto UNINSTALL_PROTOCOL; + } + + Status = gBS->SetTimer (IpSb->Timer, TimerPeriodic, TICKS_PER_SECOND); + + if (EFI_ERROR (Status)) { + goto UNINSTALL_PROTOCOL; + } + + Status = gBS->SetTimer (IpSb->ReconfigCheckTimer, TimerPeriodic, 500 * TICKS_PER_MS); + + if (EFI_ERROR (Status)) { + goto UNINSTALL_PROTOCOL; + } + + // + // Initialize the IP4 ID + // + mIp4Id = (UINT16)NET_RANDOM (NetRandomInitSeed ()); + + return Status; + +UNINSTALL_PROTOCOL: + gBS->UninstallMultipleProtocolInterfaces ( + ControllerHandle, + &gEfiIp4ServiceBindingProtocolGuid, + &IpSb->ServiceBinding, + &gEfiIp4Config2ProtocolGuid, + Ip4Cfg2, + NULL + ); + +FREE_SERVICE: + Ip4CleanService (IpSb); + FreePool (IpSb); + return Status; +} + + +/** + Stop this driver on ControllerHandle. This service is called by the + EFI boot service DisconnectController(). In order to + make drivers as small as possible, there are a few calling + restrictions for this service. DisconnectController() + must follow these calling restrictions. If any other agent wishes + to call Stop() it must also follow these calling restrictions. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to stop driver on + @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number + of children is zero stop the entire bus driver. + @param[in] ChildHandleBuffer List of Child Handles to Stop. + + @retval EFI_SUCCESS This driver is removed ControllerHandle + @retval other This driver was not removed from this device + +**/ +EFI_STATUS +EFIAPI +Ip4DriverBindingStop ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN UINTN NumberOfChildren, + IN EFI_HANDLE *ChildHandleBuffer + ) +{ + EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; + IP4_SERVICE *IpSb; + EFI_HANDLE NicHandle; + EFI_STATUS Status; + INTN State; + LIST_ENTRY *List; + IP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT Context; + IP4_INTERFACE *IpIf; + IP4_ROUTE_TABLE *RouteTable; + + BOOLEAN IsDhcp4; + + IsDhcp4 = FALSE; + + NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiManagedNetworkProtocolGuid); + if (NicHandle == NULL) { + NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiArpProtocolGuid); + if (NicHandle == NULL) { + NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiDhcp4ProtocolGuid); + if (NicHandle != NULL) { + IsDhcp4 = TRUE; + } else { + return EFI_SUCCESS; + } + } + } + + Status = gBS->OpenProtocol ( + NicHandle, + &gEfiIp4ServiceBindingProtocolGuid, + (VOID **) &ServiceBinding, + This->DriverBindingHandle, + NicHandle, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + if (EFI_ERROR (Status)) { + return EFI_DEVICE_ERROR; + } + + IpSb = IP4_SERVICE_FROM_PROTOCOL (ServiceBinding); + + if (IsDhcp4) { + Status = Ip4Config2DestroyDhcp4 (&IpSb->Ip4Config2Instance); + gBS->CloseEvent (IpSb->Ip4Config2Instance.Dhcp4Event); + IpSb->Ip4Config2Instance.Dhcp4Event = NULL; + } else if (NumberOfChildren != 0) { + List = &IpSb->Children; + Context.ServiceBinding = ServiceBinding; + Context.NumberOfChildren = NumberOfChildren; + Context.ChildHandleBuffer = ChildHandleBuffer; + Status = NetDestroyLinkList ( + List, + Ip4DestroyChildEntryInHandleBuffer, + &Context, + NULL + ); + } else if (IpSb->DefaultInterface->ArpHandle == ControllerHandle) { + + // + // The ARP protocol for the default interface is being uninstalled and all + // its IP child handles should have been destroyed before. So, release the + // default interface and route table, create a new one and mark it as not started. + // + Ip4CancelReceive (IpSb->DefaultInterface); + Ip4FreeInterface (IpSb->DefaultInterface, NULL); + Ip4FreeRouteTable (IpSb->DefaultRouteTable); + + IpIf = Ip4CreateInterface (IpSb->Mnp, IpSb->Controller, IpSb->Image); + if (IpIf == NULL) { + goto ON_ERROR; + } + RouteTable = Ip4CreateRouteTable (); + if (RouteTable == NULL) { + Ip4FreeInterface (IpIf, NULL); + goto ON_ERROR;; + } + + IpSb->DefaultInterface = IpIf; + InsertHeadList (&IpSb->Interfaces, &IpIf->Link); + IpSb->DefaultRouteTable = RouteTable; + Ip4ReceiveFrame (IpIf, NULL, Ip4AccpetFrame, IpSb); + + IpSb->State = IP4_SERVICE_UNSTARTED; + + } else if (IsListEmpty (&IpSb->Children)) { + State = IpSb->State; + // + // OK, clean other resources then uninstall the service binding protocol. + // + Status = Ip4CleanService (IpSb); + if (EFI_ERROR (Status)) { + IpSb->State = State; + goto ON_ERROR; + } + + gBS->UninstallMultipleProtocolInterfaces ( + NicHandle, + &gEfiIp4ServiceBindingProtocolGuid, + ServiceBinding, + &gEfiIp4Config2ProtocolGuid, + &IpSb->Ip4Config2Instance.Ip4Config2, + NULL + ); + + if (gIp4ControllerNameTable != NULL) { + FreeUnicodeStringTable (gIp4ControllerNameTable); + gIp4ControllerNameTable = NULL; + } + FreePool (IpSb); + } + +ON_ERROR: + return Status; +} + + +/** + Creates a child handle and installs a protocol. + + The CreateChild() function installs a protocol on ChildHandle. + If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. + If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle. + + @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. + @param ChildHandle Pointer to the handle of the child to create. If it is NULL, + then a new handle is created. If it is a pointer to an existing UEFI handle, + then the protocol is added to the existing UEFI handle. + + @retval EFI_SUCCES The protocol was added to ChildHandle. + @retval EFI_INVALID_PARAMETER ChildHandle is NULL. + @retval EFI_OUT_OF_RESOURCES There are not enough resources available to create + the child + @retval other The child handle was not created + +**/ +EFI_STATUS +EFIAPI +Ip4ServiceBindingCreateChild ( + IN EFI_SERVICE_BINDING_PROTOCOL *This, + IN OUT EFI_HANDLE *ChildHandle + ) +{ + IP4_SERVICE *IpSb; + IP4_PROTOCOL *IpInstance; + EFI_TPL OldTpl; + EFI_STATUS Status; + VOID *Mnp; + + if ((This == NULL) || (ChildHandle == NULL)) { + return EFI_INVALID_PARAMETER; + } + + IpSb = IP4_SERVICE_FROM_PROTOCOL (This); + IpInstance = AllocatePool (sizeof (IP4_PROTOCOL)); + + if (IpInstance == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + Ip4InitProtocol (IpSb, IpInstance); + + // + // Install Ip4 onto ChildHandle + // + Status = gBS->InstallMultipleProtocolInterfaces ( + ChildHandle, + &gEfiIp4ProtocolGuid, + &IpInstance->Ip4Proto, + NULL + ); + + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + IpInstance->Handle = *ChildHandle; + + // + // Open the Managed Network protocol BY_CHILD. + // + Status = gBS->OpenProtocol ( + IpSb->MnpChildHandle, + &gEfiManagedNetworkProtocolGuid, + (VOID **) &Mnp, + gIp4DriverBinding.DriverBindingHandle, + IpInstance->Handle, + EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER + ); + if (EFI_ERROR (Status)) { + gBS->UninstallMultipleProtocolInterfaces ( + ChildHandle, + &gEfiIp4ProtocolGuid, + &IpInstance->Ip4Proto, + NULL + ); + + goto ON_ERROR; + } + + // + // Insert it into the service binding instance. + // + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + InsertTailList (&IpSb->Children, &IpInstance->Link); + IpSb->NumChildren++; + + gBS->RestoreTPL (OldTpl); + +ON_ERROR: + + if (EFI_ERROR (Status)) { + + Ip4CleanProtocol (IpInstance); + + FreePool (IpInstance); + } + + return Status; +} + + +/** + Destroys a child handle with a protocol installed on it. + + The DestroyChild() function does the opposite of CreateChild(). It removes a protocol + that was installed by CreateChild() from ChildHandle. If the removed protocol is the + last protocol on ChildHandle, then ChildHandle is destroyed. + + @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. + @param ChildHandle Handle of the child to destroy + + @retval EFI_SUCCES The protocol was removed from ChildHandle. + @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed. + @retval EFI_INVALID_PARAMETER Child handle is NULL. + @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle + because its services are being used. + @retval other The child handle was not destroyed + +**/ +EFI_STATUS +EFIAPI +Ip4ServiceBindingDestroyChild ( + IN EFI_SERVICE_BINDING_PROTOCOL *This, + IN EFI_HANDLE ChildHandle + ) +{ + EFI_STATUS Status; + IP4_SERVICE *IpSb; + IP4_PROTOCOL *IpInstance; + EFI_IP4_PROTOCOL *Ip4; + EFI_TPL OldTpl; + + if ((This == NULL) || (ChildHandle == NULL)) { + return EFI_INVALID_PARAMETER; + } + + // + // Retrieve the private context data structures + // + IpSb = IP4_SERVICE_FROM_PROTOCOL (This); + + Status = gBS->OpenProtocol ( + ChildHandle, + &gEfiIp4ProtocolGuid, + (VOID **) &Ip4, + gIp4DriverBinding.DriverBindingHandle, + ChildHandle, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + + if (EFI_ERROR (Status)) { + return EFI_UNSUPPORTED; + } + + IpInstance = IP4_INSTANCE_FROM_PROTOCOL (Ip4); + + if (IpInstance->Service != IpSb) { + return EFI_INVALID_PARAMETER; + } + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + // + // A child can be destroyed more than once. For example, + // Ip4DriverBindingStop will destroy all of its children. + // when UDP driver is being stopped, it will destroy all + // the IP child it opens. + // + if (IpInstance->InDestroy) { + gBS->RestoreTPL (OldTpl); + return EFI_SUCCESS; + } + + IpInstance->InDestroy = TRUE; + + // + // Close the Managed Network protocol. + // + gBS->CloseProtocol ( + IpSb->MnpChildHandle, + &gEfiManagedNetworkProtocolGuid, + gIp4DriverBinding.DriverBindingHandle, + ChildHandle + ); + + if (IpInstance->Interface != NULL && IpInstance->Interface->Arp != NULL) { + gBS->CloseProtocol ( + IpInstance->Interface->ArpHandle, + &gEfiArpProtocolGuid, + gIp4DriverBinding.DriverBindingHandle, + ChildHandle + ); + } + + // + // Uninstall the IP4 protocol first. Many thing happens during + // this: + // 1. The consumer of the IP4 protocol will be stopped if it + // opens the protocol BY_DRIVER. For eaxmple, if MNP driver is + // stopped, IP driver's stop function will be called, and uninstall + // EFI_IP4_PROTOCOL will trigger the UDP's stop function. This + // makes it possible to create the network stack bottom up, and + // stop it top down. + // 2. the upper layer will recycle the received packet. The recycle + // event's TPL is higher than this function. The recycle events + // will be called back before preceeding. If any packets not recycled, + // that means there is a resource leak. + // + gBS->RestoreTPL (OldTpl); + Status = gBS->UninstallProtocolInterface ( + ChildHandle, + &gEfiIp4ProtocolGuid, + &IpInstance->Ip4Proto + ); + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + if (EFI_ERROR (Status)) { + IpInstance->InDestroy = FALSE; + goto ON_ERROR; + } + + Status = Ip4CleanProtocol (IpInstance); + if (EFI_ERROR (Status)) { + gBS->InstallMultipleProtocolInterfaces ( + &ChildHandle, + &gEfiIp4ProtocolGuid, + Ip4, + NULL + ); + + goto ON_ERROR; + } + + RemoveEntryList (&IpInstance->Link); + IpSb->NumChildren--; + + gBS->RestoreTPL (OldTpl); + + FreePool (IpInstance); + return EFI_SUCCESS; + +ON_ERROR: + gBS->RestoreTPL (OldTpl); + + return Status; +} diff --git a/NetworkPkg/Ip4Dxe/Ip4Driver.h b/NetworkPkg/Ip4Dxe/Ip4Driver.h new file mode 100644 index 0000000000..be37471570 --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4Driver.h @@ -0,0 +1,184 @@ +/** @file + +Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef __EFI_IP4_DRIVER_H__ +#define __EFI_IP4_DRIVER_H__ + +#include + +extern EFI_DRIVER_BINDING_PROTOCOL gIp4DriverBinding; +extern EFI_COMPONENT_NAME_PROTOCOL gIp4ComponentName; +extern EFI_COMPONENT_NAME2_PROTOCOL gIp4ComponentName2; +extern EFI_UNICODE_STRING_TABLE *gIp4ControllerNameTable; + +typedef struct { + EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; + UINTN NumberOfChildren; + EFI_HANDLE *ChildHandleBuffer; +} IP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT; + +// +// Function prototype for the driver's entry point +// +/** + This is the declaration of an EFI image entry point. This entry point is + the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including + both device drivers and bus drivers. + + The entry point for IP4 driver which install the driver + binding and component name protocol on its image. + + @param[in] ImageHandle The firmware allocated handle for the UEFI image. + @param[in] SystemTable A pointer to the EFI System Table. + + @retval EFI_SUCCESS The operation completed successfully. + @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. + +**/ +EFI_STATUS +EFIAPI +Ip4DriverEntryPoint ( + IN EFI_HANDLE ImageHandle, + IN EFI_SYSTEM_TABLE *SystemTable + ); + +// +// Function prototypes for the Drivr Binding Protocol +// +/** + Test to see if this driver supports ControllerHandle. This service + is called by the EFI boot service ConnectController(). In + order to make drivers as small as possible, there are a few calling + restrictions for this service. ConnectController() must + follow these calling restrictions. If any other agent wishes to call + Supported() it must also follow these calling restrictions. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to test + @param[in] RemainingDevicePath Optional parameter use to pick a specific child + device to start. + + @retval EFI_SUCCESS This driver supports this device + @retval EFI_ALREADY_STARTED This driver is already running on this device + @retval other This driver does not support this device + +**/ +EFI_STATUS +EFIAPI +Ip4DriverBindingSupported ( + IN EFI_DRIVER_BINDING_PROTOCOL * This, + IN EFI_HANDLE ControllerHandle, + IN EFI_DEVICE_PATH_PROTOCOL * RemainingDevicePath OPTIONAL + ); + +/** + Start this driver on ControllerHandle. This service is called by the + EFI boot service ConnectController(). In order to make + drivers as small as possible, there are a few calling restrictions for + this service. ConnectController() must follow these + calling restrictions. If any other agent wishes to call Start() it + must also follow these calling restrictions. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to bind driver to + @param[in] RemainingDevicePath Optional parameter use to pick a specific child + device to start. + + @retval EFI_SUCCESS This driver is added to ControllerHandle + @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle + @retval other This driver does not support this device + +**/ +EFI_STATUS +EFIAPI +Ip4DriverBindingStart ( + IN EFI_DRIVER_BINDING_PROTOCOL * This, + IN EFI_HANDLE ControllerHandle, + IN EFI_DEVICE_PATH_PROTOCOL * RemainingDevicePath OPTIONAL + ); + +/** + Stop this driver on ControllerHandle. This service is called by the + EFI boot service DisconnectController(). In order to + make drivers as small as possible, there are a few calling + restrictions for this service. DisconnectController() + must follow these calling restrictions. If any other agent wishes + to call Stop() it must also follow these calling restrictions. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to stop driver on + @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number + of children is zero stop the entire bus driver. + @param[in] ChildHandleBuffer List of Child Handles to Stop. + + @retval EFI_SUCCESS This driver is removed ControllerHandle + @retval other This driver was not removed from this device + +**/ +EFI_STATUS +EFIAPI +Ip4DriverBindingStop ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN UINTN NumberOfChildren, + IN EFI_HANDLE *ChildHandleBuffer + ); + +// +// Function prototypes for the ServiceBinding Protocol +// +/** + Creates a child handle and installs a protocol. + + The CreateChild() function installs a protocol on ChildHandle. + If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. + If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle. + + @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. + @param ChildHandle Pointer to the handle of the child to create. If it is NULL, + then a new handle is created. If it is a pointer to an existing UEFI handle, + then the protocol is added to the existing UEFI handle. + + @retval EFI_SUCCES The protocol was added to ChildHandle. + @retval EFI_INVALID_PARAMETER ChildHandle is NULL. + @retval EFI_OUT_OF_RESOURCES There are not enough resources available to create + the child + @retval other The child handle was not created + +**/ +EFI_STATUS +EFIAPI +Ip4ServiceBindingCreateChild ( + IN EFI_SERVICE_BINDING_PROTOCOL *This, + IN OUT EFI_HANDLE *ChildHandle + ); + +/** + Destroys a child handle with a protocol installed on it. + + The DestroyChild() function does the opposite of CreateChild(). It removes a protocol + that was installed by CreateChild() from ChildHandle. If the removed protocol is the + last protocol on ChildHandle, then ChildHandle is destroyed. + + @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. + @param ChildHandle Handle of the child to destroy + + @retval EFI_SUCCES The protocol was removed from ChildHandle. + @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed. + @retval EFI_INVALID_PARAMETER Child handle is NULL. + @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle + because its services are being used. + @retval other The child handle was not destroyed + +**/ +EFI_STATUS +EFIAPI +Ip4ServiceBindingDestroyChild ( + IN EFI_SERVICE_BINDING_PROTOCOL *This, + IN EFI_HANDLE ChildHandle + ); +#endif diff --git a/NetworkPkg/Ip4Dxe/Ip4Dxe.inf b/NetworkPkg/Ip4Dxe/Ip4Dxe.inf new file mode 100644 index 0000000000..ff9f32174e --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4Dxe.inf @@ -0,0 +1,109 @@ +## @file +# This module produces EFI IPv4 Protocol and EFI IPv4 Service Binding Protocol. +# +# This module produces EFI IPv4 Protocol upon EFI MNP Protocol and EFI ARP Protocol, +# to provide basic network IPv4 packet I/O services, which includes support for a +# subset of the Internet Control Message Protocol (ICMP) and may include support for +# the Internet Group Management Protocol (IGMP). +# +# Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
+# SPDX-License-Identifier: BSD-2-Clause-Patent +# +# +## + +[Defines] + INF_VERSION = 0x00010005 + BASE_NAME = Ip4Dxe + MODULE_UNI_FILE = Ip4Dxe.uni + FILE_GUID = 9FB1A1F3-3B71-4324-B39A-745CBB015FFF + MODULE_TYPE = UEFI_DRIVER + VERSION_STRING = 1.0 + ENTRY_POINT = Ip4DriverEntryPoint + UNLOAD_IMAGE = NetLibDefaultUnload + +# +# The following information is for reference only and not required by the build tools. +# +# VALID_ARCHITECTURES = IA32 X64 EBC +# +# DRIVER_BINDING = gIp4DriverBinding +# COMPONENT_NAME = gIp4ComponentName +# COMPONENT_NAME2 = gIp4ComponentName2 +# + +[Sources] + Ip4Driver.c + Ip4Option.h + Ip4Route.h + Ip4If.c + Ip4Igmp.h + Ip4Output.c + Ip4Icmp.c + Ip4Igmp.c + Ip4Impl.c + Ip4Common.h + Ip4Impl.h + Ip4Driver.h + Ip4Common.c + Ip4If.h + Ip4Option.c + Ip4Output.h + ComponentName.c + Ip4Input.h + Ip4Route.c + Ip4Icmp.h + Ip4Input.c + Ip4Config2Impl.c + Ip4Config2Impl.h + Ip4Config2.vfr + Ip4DxeStrings.uni + Ip4NvData.h + Ip4Config2Nv.h + Ip4Config2Nv.c + + +[Packages] + MdePkg/MdePkg.dec + MdeModulePkg/MdeModulePkg.dec + +[LibraryClasses] + UefiLib + BaseLib + UefiBootServicesTableLib + UefiDriverEntryPoint + UefiRuntimeServicesTableLib + DebugLib + NetLib + DpcLib + HiiLib + PrintLib + DevicePathLib + UefiHiiServicesLib + +[Protocols] + ## BY_START + ## UNDEFINED # variable + gEfiIp4ServiceBindingProtocolGuid + gEfiIp4ProtocolGuid ## BY_START + gEfiManagedNetworkServiceBindingProtocolGuid ## TO_START + gEfiManagedNetworkProtocolGuid ## TO_START + gEfiArpServiceBindingProtocolGuid ## TO_START + gEfiIp4Config2ProtocolGuid ## BY_START + gEfiArpProtocolGuid ## TO_START + gEfiDhcp4ServiceBindingProtocolGuid ## TO_START + gEfiDhcp4ProtocolGuid ## TO_START + gEfiIpSec2ProtocolGuid ## SOMETIMES_CONSUMES + gEfiHiiConfigAccessProtocolGuid ## BY_START + gEfiDevicePathProtocolGuid ## TO_START + +[Guids] + ## SOMETIMES_CONSUMES ## GUID # HiiIsConfigHdrMatch EFI_NIC_IP4_CONFIG_VARIABLE + ## SOMETIMES_PRODUCES ## GUID # HiiConstructConfigHdr EFI_NIC_IP4_CONFIG_VARIABLE + ## SOMETIMES_PRODUCES ## GUID # HiiGetBrowserData EFI_NIC_IP4_CONFIG_VARIABLE + ## SOMETIMES_CONSUMES ## HII + gIp4Config2NvDataGuid + +[UserExtensions.TianoCore."ExtraFiles"] + Ip4DxeExtra.uni + diff --git a/NetworkPkg/Ip4Dxe/Ip4Dxe.uni b/NetworkPkg/Ip4Dxe/Ip4Dxe.uni new file mode 100644 index 0000000000..380d07da0f --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4Dxe.uni @@ -0,0 +1,19 @@ +// /** @file +// This module produces EFI IPv4 Protocol and EFI IPv4 Service Binding Protocol. +// +// This module produces EFI IPv4 Protocol upon EFI MNP Protocol and EFI ARP Protocol, +// to provide basic network IPv4 packet I/O services, which includes support for a +// subset of the Internet Control Message Protocol (ICMP) and may include support for +// the Internet Group Management Protocol (IGMP). +// +// Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
+// +// SPDX-License-Identifier: BSD-2-Clause-Patent +// +// **/ + + +#string STR_MODULE_ABSTRACT #language en-US "Produces EFI IPv4 Protocol and EFI IPv4 Service Binding Protocol" + +#string STR_MODULE_DESCRIPTION #language en-US "This module produces EFI IPv4 Protocol upon EFI MNP Protocol and EFI ARP Protocol to provide basic network IPv4 packet I/O services, which includes support for a subset of the Internet Control Message Protocol (ICMP), and may include support for the Internet Group Management Protocol (IGMP)." + diff --git a/NetworkPkg/Ip4Dxe/Ip4DxeExtra.uni b/NetworkPkg/Ip4Dxe/Ip4DxeExtra.uni new file mode 100644 index 0000000000..dbbf9d5f90 --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4DxeExtra.uni @@ -0,0 +1,14 @@ +// /** @file +// Ip4Dxe Localized Strings and Content +// +// Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.
+// +// SPDX-License-Identifier: BSD-2-Clause-Patent +// +// **/ + +#string STR_PROPERTIES_MODULE_NAME +#language en-US +"IP v4 DXE Driver" + + diff --git a/NetworkPkg/Ip4Dxe/Ip4DxeStrings.uni b/NetworkPkg/Ip4Dxe/Ip4DxeStrings.uni new file mode 100644 index 0000000000..c262298f00 --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4DxeStrings.uni @@ -0,0 +1,30 @@ +// /** @file +// String definitions for Ip4Config2 formset + +// Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.
+// SPDX-License-Identifier: BSD-2-Clause-Patent +// +//**/ + + +/=# + +#langdef en-US "English" + +#string STR_IP4_CONFIG2_FORM_TITLE #language en-US "IPv4 Network Configuration" +#string STR_IP4_CONFIG2_FORM_HELP #language en-US "Configure network parameters." +#string STR_IP4_DEVICE_FORM_TITLE #language en-US "" +#string STR_IP4_DEVICE_FORM_HELP #language en-US "" +#string STR_IP4_CONFIGURE #language en-US "Configured" +#string STR_IP4_CONFIGURE_HELP #language en-US "Indicate whether network address configured successfully or not." +#string STR_IP4_ENABLE_DHCP #language en-US "Enable DHCP" +#string STR_IP4_LOCAL_IP_ADDRESS #language en-US "Local IP Address" +#string STR_IP4_IP_ADDRESS_HELP #language en-US "Enter IP address in dotted-decimal notation. Example: 192.168.10.12\r\n" +#string STR_IP4_LOCAL_MASK #language en-US "Local NetMask" +#string STR_IP4_MASK_HELP #language en-US "Enter NetMask in dotted-decimal notation. Example: 255.255.255.0\r\n" +#string STR_IP4_LOCAL_GATEWAY #language en-US "Local Gateway" +#string STR_IP4_GATEWAY_HELP #language en-US "Enter Gateway in dotted-decimal notation. Example: 192.168.10.1\r\n" +#string STR_IP4_LOCAL_DNS #language en-US "Local DNS Servers" +#string STR_IP4_DNS_HELP #language en-US "Enter DNS Servers in dotted-decimal notation. Example: 192.168.10.8 192.168.10.9\r\n" +#string STR_SAVE_CHANGES #language en-US "Save Changes and Exit" +#string STR_NULL #language en-US "" diff --git a/NetworkPkg/Ip4Dxe/Ip4Icmp.c b/NetworkPkg/Ip4Dxe/Ip4Icmp.c new file mode 100644 index 0000000000..052d6b77f7 --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4Icmp.c @@ -0,0 +1,363 @@ +/** @file + +Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Ip4Impl.h" + +IP4_ICMP_CLASS +mIcmpClass[] = { + {ICMP_ECHO_REPLY, ICMP_QUERY_MESSAGE }, + {1, ICMP_INVALID_MESSAGE}, + {2, ICMP_INVALID_MESSAGE}, + {ICMP_DEST_UNREACHABLE, ICMP_ERROR_MESSAGE }, + {ICMP_SOURCE_QUENCH, ICMP_ERROR_MESSAGE }, + {ICMP_REDIRECT, ICMP_ERROR_MESSAGE }, + {6, ICMP_INVALID_MESSAGE}, + {7, ICMP_INVALID_MESSAGE}, + {ICMP_ECHO_REQUEST, ICMP_QUERY_MESSAGE }, + {9, ICMP_INVALID_MESSAGE}, + {10, ICMP_INVALID_MESSAGE}, + {ICMP_TIME_EXCEEDED, ICMP_ERROR_MESSAGE }, + {ICMP_PARAMETER_PROBLEM, ICMP_ERROR_MESSAGE }, + {ICMP_TIMESTAMP , ICMP_QUERY_MESSAGE }, + {14, ICMP_INVALID_MESSAGE}, + {ICMP_INFO_REQUEST , ICMP_QUERY_MESSAGE }, + {ICMP_INFO_REPLY , ICMP_QUERY_MESSAGE }, +}; + +EFI_IP4_ICMP_TYPE +mIp4SupportedIcmp[23] = { + {ICMP_ECHO_REPLY, ICMP_DEFAULT_CODE }, + + {ICMP_DEST_UNREACHABLE, ICMP_NET_UNREACHABLE }, + {ICMP_DEST_UNREACHABLE, ICMP_HOST_UNREACHABLE }, + {ICMP_DEST_UNREACHABLE, ICMP_PROTO_UNREACHABLE }, + {ICMP_DEST_UNREACHABLE, ICMP_PORT_UNREACHABLE }, + {ICMP_DEST_UNREACHABLE, ICMP_FRAGMENT_FAILED }, + {ICMP_DEST_UNREACHABLE, ICMP_SOURCEROUTE_FAILED }, + {ICMP_DEST_UNREACHABLE, ICMP_NET_UNKNOWN }, + {ICMP_DEST_UNREACHABLE, ICMP_HOST_UNKNOWN }, + {ICMP_DEST_UNREACHABLE, ICMP_SOURCE_ISOLATED }, + {ICMP_DEST_UNREACHABLE, ICMP_NET_PROHIBITED }, + {ICMP_DEST_UNREACHABLE, ICMP_HOST_PROHIBITED }, + {ICMP_DEST_UNREACHABLE, ICMP_NET_UNREACHABLE_TOS }, + {ICMP_DEST_UNREACHABLE, ICMP_HOST_UNREACHABLE_TOS}, + + {ICMP_SOURCE_QUENCH, ICMP_DEFAULT_CODE }, + + {ICMP_REDIRECT, ICMP_NET_REDIRECT }, + {ICMP_REDIRECT, ICMP_HOST_REDIRECT }, + {ICMP_REDIRECT, ICMP_NET_TOS_REDIRECT }, + {ICMP_REDIRECT, ICMP_HOST_TOS_REDIRECT }, + + {ICMP_ECHO_REQUEST, ICMP_DEFAULT_CODE }, + + {ICMP_TIME_EXCEEDED, ICMP_TIMEOUT_IN_TRANSIT }, + {ICMP_TIME_EXCEEDED, ICMP_TIMEOUT_REASSEMBLE }, + + {ICMP_PARAMETER_PROBLEM, ICMP_DEFAULT_CODE }, +}; + + + +/** + Process the ICMP redirect. Find the instance then update + its route cache. + + All kinds of redirect is treated as host redirect as + specified by RFC1122 3.3.1.2: + "Since the subnet mask appropriate to the destination + address is generally not known, a Network Redirect + message SHOULD be treated identically to a Host Redirect + message;" + + @param[in] IpSb The IP4 service binding instance that received + the packet. + @param[in] Head The IP head of the received ICMPpacket. + @param[in] Packet The content of the ICMP redirect packet with IP + head removed. + @param[in] Icmp The buffer to store the ICMP error message if + something is wrong. + + @retval EFI_INVALID_PARAMETER The parameter is invalid + @retval EFI_SUCCESS Successfully updated the route caches + +**/ +EFI_STATUS +Ip4ProcessIcmpRedirect ( + IN IP4_SERVICE *IpSb, + IN IP4_HEAD *Head, + IN NET_BUF *Packet, + IN IP4_ICMP_ERROR_HEAD *Icmp + ) +{ + LIST_ENTRY *Entry; + IP4_PROTOCOL *Ip4Instance; + IP4_ROUTE_CACHE_ENTRY *CacheEntry; + IP4_INTERFACE *IpIf; + IP4_ADDR Gateway; + IP4_ADDR Src; + IP4_ADDR Dst; + + // + // Find the interface whose IP address is the source of the + // orgianl IP packet. + // + IpIf = Ip4FindInterface (IpSb, NTOHL (Icmp->IpHead.Src)); + Gateway = NTOHL (Icmp->Fourth); + + // + // discard the packet if the new gateway address it specifies + // is not on the same connected net through which the Redirect + // arrived. (RFC1122 3.2.2.2). + // + if ((IpIf == NULL) || !IP4_NET_EQUAL (Gateway, IpIf->Ip, IpIf->SubnetMask)) { + NetbufFree (Packet); + return EFI_INVALID_PARAMETER; + } + + // + // Update each IP child's route cache on the interface. + // + NET_LIST_FOR_EACH (Entry, &IpIf->IpInstances) { + Ip4Instance = NET_LIST_USER_STRUCT (Entry, IP4_PROTOCOL, AddrLink); + + if (Ip4Instance->RouteTable == NULL) { + continue; + } + + Dst = NTOHL (Icmp->IpHead.Dst); + Src = NTOHL (Icmp->IpHead.Src); + CacheEntry = Ip4FindRouteCache (Ip4Instance->RouteTable, Dst, Src); + + // + // Only update the route cache's gateway if the source of the + // Redirect is the current first-hop gateway + // + if ((CacheEntry != NULL) && (NTOHL (Head->Src) == CacheEntry->NextHop)) { + CacheEntry->NextHop = Gateway; + } + } + + NetbufFree (Packet); + return EFI_SUCCESS; +} + + +/** + Process the ICMP error packet. If it is an ICMP redirect packet, + update call Ip4ProcessIcmpRedirect to update the IP instance's + route cache, otherwise, deliver the packet to upper layer. + + @param[in] IpSb The IP4 service that received the packet. + @param[in] Head The IP4 head of the ICMP error packet + @param[in] Packet The content of the ICMP error with IP4 head + removed. + + @retval EFI_SUCCESS The ICMP error is processed successfully. + @retval EFI_INVALID_PARAMETER The packet is invalid + @retval Others Failed to process the packet. + +**/ +EFI_STATUS +Ip4ProcessIcmpError ( + IN IP4_SERVICE *IpSb, + IN IP4_HEAD *Head, + IN NET_BUF *Packet + ) +{ + IP4_ICMP_ERROR_HEAD Icmp; + + if (Packet->TotalSize < sizeof (Icmp)) { + NetbufFree (Packet); + return EFI_INVALID_PARAMETER; + } + + NetbufCopy (Packet, 0, sizeof (Icmp), (UINT8 *) &Icmp); + + // + // If it is an ICMP redirect error, update the route cache + // as RFC1122. Otherwise, demultiplex it to IP instances. + // + if (Icmp.Head.Type == ICMP_REDIRECT) { + return Ip4ProcessIcmpRedirect (IpSb, Head, Packet, &Icmp); + } + + IP4_GET_CLIP_INFO (Packet)->Status = EFI_ICMP_ERROR; + return Ip4Demultiplex (IpSb, Head, Packet, NULL, 0); +} + + +/** + Replay an ICMP echo request. + + @param[in] IpSb The IP4 service that receivd the packet + @param[in] Head The IP4 head of the ICMP error packet + @param[in] Packet The content of the ICMP error with IP4 head + removed. + + @retval EFI_OUT_OF_RESOURCES Failed to allocate resource. + @retval EFI_SUCCESS The ICMP Echo request is successfully answered. + @retval Others Failed to answer the ICMP echo request. + +**/ +EFI_STATUS +Ip4IcmpReplyEcho ( + IN IP4_SERVICE *IpSb, + IN IP4_HEAD *Head, + IN NET_BUF *Packet + ) +{ + IP4_ICMP_QUERY_HEAD *Icmp; + NET_BUF *Data; + EFI_STATUS Status; + IP4_HEAD ReplyHead; + + // + // make a copy the packet, it is really a bad idea to + // send the MNP's buffer back to MNP. + // + Data = NetbufDuplicate (Packet, NULL, IP4_MAX_HEADLEN); + + if (Data == NULL) { + Status = EFI_OUT_OF_RESOURCES; + goto ON_EXIT; + } + + // + // Change the ICMP type to echo reply, exchange the source + // and destination, then send it. The source is updated to + // use specific destination. See RFC1122. SRR/RR option + // update is omitted. + // + Icmp = (IP4_ICMP_QUERY_HEAD *) NetbufGetByte (Data, 0, NULL); + ASSERT (Icmp != NULL); + Icmp->Head.Type = ICMP_ECHO_REPLY; + Icmp->Head.Checksum = 0; + Icmp->Head.Checksum = (UINT16) (~NetblockChecksum ((UINT8 *) Icmp, Data->TotalSize)); + + ReplyHead.Tos = 0; + ReplyHead.Fragment = 0; + ReplyHead.Ttl = 64; + ReplyHead.Protocol = EFI_IP_PROTO_ICMP; + ReplyHead.Src = 0; + + // + // Ip4Output will select a source for us + // + ReplyHead.Dst = Head->Src; + + Status = Ip4Output ( + IpSb, + NULL, + Data, + &ReplyHead, + NULL, + 0, + IP4_ALLZERO_ADDRESS, + Ip4SysPacketSent, + NULL + ); + if (EFI_ERROR (Status)) { + NetbufFree (Data); + } + +ON_EXIT: + NetbufFree (Packet); + return Status; +} + + +/** + Process the ICMP query message. If it is an ICMP echo + request, answer it. Otherwise deliver it to upper layer. + + @param[in] IpSb The IP4 service that receivd the packet + @param[in] Head The IP4 head of the ICMP query packet + @param[in] Packet The content of the ICMP query with IP4 head + removed. + + @retval EFI_INVALID_PARAMETER The packet is invalid + @retval EFI_SUCCESS The ICMP query message is processed + @retval Others Failed to process ICMP query. + +**/ +EFI_STATUS +Ip4ProcessIcmpQuery ( + IN IP4_SERVICE *IpSb, + IN IP4_HEAD *Head, + IN NET_BUF *Packet + ) +{ + IP4_ICMP_QUERY_HEAD Icmp; + + if (Packet->TotalSize < sizeof (Icmp)) { + NetbufFree (Packet); + return EFI_INVALID_PARAMETER; + } + + NetbufCopy (Packet, 0, sizeof (Icmp), (UINT8 *) &Icmp); + + if (Icmp.Head.Type == ICMP_ECHO_REQUEST) { + return Ip4IcmpReplyEcho (IpSb, Head, Packet); + } + + return Ip4Demultiplex (IpSb, Head, Packet, NULL, 0); +} + + +/** + Handle the ICMP packet. First validate the message format, + then according to the message types, process it as query or + error packet. + + @param[in] IpSb The IP4 service that receivd the packet. + @param[in] Head The IP4 head of the ICMP query packet. + @param[in] Packet The content of the ICMP query with IP4 head + removed. + + @retval EFI_INVALID_PARAMETER The packet is malformated. + @retval EFI_SUCCESS The ICMP message is successfully processed. + @retval Others Failed to handle ICMP packet. + +**/ +EFI_STATUS +Ip4IcmpHandle ( + IN IP4_SERVICE *IpSb, + IN IP4_HEAD *Head, + IN NET_BUF *Packet + ) +{ + IP4_ICMP_HEAD Icmp; + UINT16 Checksum; + + if (Packet->TotalSize < sizeof (Icmp)) { + goto DROP; + } + + NetbufCopy (Packet, 0, sizeof (Icmp), (UINT8 *) &Icmp); + + if (Icmp.Type > ICMP_TYPE_MAX) { + goto DROP; + } + + Checksum = (UINT16) (~NetbufChecksum (Packet)); + if ((Icmp.Checksum != 0) && (Checksum != 0)) { + goto DROP; + } + + if (mIcmpClass[Icmp.Type].IcmpClass == ICMP_ERROR_MESSAGE) { + return Ip4ProcessIcmpError (IpSb, Head, Packet); + + } else if (mIcmpClass[Icmp.Type].IcmpClass == ICMP_QUERY_MESSAGE) { + return Ip4ProcessIcmpQuery (IpSb, Head, Packet); + + } + +DROP: + NetbufFree (Packet); + return EFI_INVALID_PARAMETER; +} diff --git a/NetworkPkg/Ip4Dxe/Ip4Icmp.h b/NetworkPkg/Ip4Dxe/Ip4Icmp.h new file mode 100644 index 0000000000..922886a96e --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4Icmp.h @@ -0,0 +1,97 @@ +/** @file + Header file for ICMP protocol. + +Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef __EFI_IP4_ICMP_H__ +#define __EFI_IP4_ICMP_H__ + + // + // ICMP type definations + // +#define ICMP_ECHO_REPLY 0 +#define ICMP_DEST_UNREACHABLE 3 +#define ICMP_SOURCE_QUENCH 4 +#define ICMP_REDIRECT 5 +#define ICMP_ECHO_REQUEST 8 +#define ICMP_TIME_EXCEEDED 11 +#define ICMP_PARAMETER_PROBLEM 12 +#define ICMP_TIMESTAMP 13 +#define ICMP_INFO_REQUEST 15 +#define ICMP_INFO_REPLY 16 +#define ICMP_TYPE_MAX ICMP_INFO_REPLY + +#define ICMP_DEFAULT_CODE 0 + + // + // ICMP code definations for ICMP_DEST_UNREACHABLE + // +#define ICMP_NET_UNREACHABLE 0 +#define ICMP_HOST_UNREACHABLE 1 +#define ICMP_PROTO_UNREACHABLE 2 // Host may generate +#define ICMP_PORT_UNREACHABLE 3 // Host may generate +#define ICMP_FRAGMENT_FAILED 4 +#define ICMP_SOURCEROUTE_FAILED 5 // Host may generate +#define ICMP_NET_UNKNOWN 6 +#define ICMP_HOST_UNKNOWN 7 +#define ICMP_SOURCE_ISOLATED 8 +#define ICMP_NET_PROHIBITED 9 +#define ICMP_HOST_PROHIBITED 10 +#define ICMP_NET_UNREACHABLE_TOS 11 +#define ICMP_HOST_UNREACHABLE_TOS 12 + + // + // ICMP code definations for ICMP_TIME_EXCEEDED + // +#define ICMP_TIMEOUT_IN_TRANSIT 0 +#define ICMP_TIMEOUT_REASSEMBLE 1 // Host may generate + + // + // ICMP code definations for ICMP_TIME_EXCEEDED + // +#define ICMP_NET_REDIRECT 0 +#define ICMP_HOST_REDIRECT 1 +#define ICMP_NET_TOS_REDIRECT 2 +#define ICMP_HOST_TOS_REDIRECT 3 + + // + // ICMP message classes, each class of ICMP message shares + // a common message format. INVALID_MESSAGE is only a flag. + // +#define ICMP_INVALID_MESSAGE 0 +#define ICMP_ERROR_MESSAGE 1 +#define ICMP_QUERY_MESSAGE 2 + +typedef struct { + UINT8 IcmpType; + UINT8 IcmpClass; +} IP4_ICMP_CLASS; + +extern IP4_ICMP_CLASS mIcmpClass[]; +extern EFI_IP4_ICMP_TYPE mIp4SupportedIcmp[]; + +/** + Handle the ICMP packet. First validate the message format, + then according to the message types, process it as query or + error packet. + + @param[in] IpSb The IP4 service that receivd the packet. + @param[in] Head The IP4 head of the ICMP query packet. + @param[in] Packet The content of the ICMP query with IP4 head + removed. + + @retval EFI_INVALID_PARAMETER The packet is malformated. + @retval EFI_SUCCESS The ICMP message is successfully processed. + @retval Others Failed to handle ICMP packet. + +**/ +EFI_STATUS +Ip4IcmpHandle ( + IN IP4_SERVICE *IpSb, + IN IP4_HEAD *Head, + IN NET_BUF *Packet + ); +#endif diff --git a/NetworkPkg/Ip4Dxe/Ip4If.c b/NetworkPkg/Ip4Dxe/Ip4If.c new file mode 100644 index 0000000000..44b8d9fc8f --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4If.c @@ -0,0 +1,1345 @@ +/** @file + Implement IP4 pesudo interface. + +Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Ip4Impl.h" + +// +// Mac address with all zero, used to determine whethter the ARP +// resolve succeeded. Failed ARP requests zero the MAC address buffer. +// +EFI_MAC_ADDRESS mZeroMacAddress; + +/** + Callback funtion when frame transmission is finished. It will + call the frame owner's callback function to tell it the result. + + @param[in] Context Context which is point to the token. + +**/ +VOID +EFIAPI +Ip4OnFrameSentDpc ( + IN VOID *Context + ); + +/** + Request Ip4OnFrameSentDpc as a DPC at TPL_CALLBACK. + + @param[in] Event The transmit token's event. + @param[in] Context Context which is point to the token. + +**/ +VOID +EFIAPI +Ip4OnFrameSent ( + IN EFI_EVENT Event, + IN VOID *Context + ); + +/** + Callback function when ARP request are finished. It will cancelled + all the queued frame if the ARP requests failed. Or transmit them + if the request succeed. + + @param[in] Context The context of the callback, a point to the ARP + queue + +**/ +VOID +EFIAPI +Ip4OnArpResolvedDpc ( + IN VOID *Context + ); + +/** + Request Ip4OnArpResolvedDpc as a DPC at TPL_CALLBACK. + + @param Event The Arp request event. + @param Context The context of the callback, a point to the ARP + queue. + +**/ +VOID +EFIAPI +Ip4OnArpResolved ( + IN EFI_EVENT Event, + IN VOID *Context + ); + +/** + Received a frame from MNP, wrap it in net buffer then deliver + it to IP's input function. The ownship of the packet also + transferred to IP. When Ip is finished with this packet, it + will call NetbufFree to release the packet, NetbufFree will + again call the Ip4RecycleFrame to signal MNP's event and free + the token used. + + @param Context Context for the callback. + +**/ +VOID +EFIAPI +Ip4OnFrameReceivedDpc ( + IN VOID *Context + ); + +/** + Request Ip4OnFrameReceivedDpc as a DPC at TPL_CALLBACK. + + @param Event The receive event delivered to MNP for receive. + @param Context Context for the callback. + +**/ +VOID +EFIAPI +Ip4OnFrameReceived ( + IN EFI_EVENT Event, + IN VOID *Context + ); + +/** + Remove all the frames on the ARP queue that pass the FrameToCancel, + that is, either FrameToCancel is NULL or it returns true for the frame. + + @param[in] ArpQue ARP frame to remove the frames from. + @param[in] IoStatus The status returned to the cancelled frames' + callback function. + @param[in] FrameToCancel Function to select which frame to cancel. + @param[in] Context Opaque parameter to the FrameToCancel. + +**/ +VOID +Ip4CancelFrameArp ( + IN IP4_ARP_QUE *ArpQue, + IN EFI_STATUS IoStatus, + IN IP4_FRAME_TO_CANCEL FrameToCancel OPTIONAL, + IN VOID *Context + ); + + +/** + Wrap a transmit request into a newly allocated IP4_LINK_TX_TOKEN. + + @param[in] Interface The interface to send out to. + @param[in] IpInstance The IpInstance that transmit the packet. NULL if + the packet is sent by the IP4 driver itself. + @param[in] Packet The packet to transmit + @param[in] CallBack Call back function to execute if transmission + finished. + @param[in] Context Opaque parameter to the call back. + @param[in] IpSb The pointer to the IP4 service binding instance. + + @retval Token The wrapped token if succeed + @retval NULL The wrapped token if NULL + +**/ +IP4_LINK_TX_TOKEN * +Ip4WrapLinkTxToken ( + IN IP4_INTERFACE *Interface, + IN IP4_PROTOCOL *IpInstance OPTIONAL, + IN NET_BUF *Packet, + IN IP4_FRAME_CALLBACK CallBack, + IN VOID *Context, + IN IP4_SERVICE *IpSb + ) +{ + EFI_MANAGED_NETWORK_COMPLETION_TOKEN *MnpToken; + EFI_MANAGED_NETWORK_TRANSMIT_DATA *MnpTxData; + IP4_LINK_TX_TOKEN *Token; + EFI_STATUS Status; + UINT32 Count; + + Token = AllocatePool (sizeof (IP4_LINK_TX_TOKEN) + \ + (Packet->BlockOpNum - 1) * sizeof (EFI_MANAGED_NETWORK_FRAGMENT_DATA)); + + if (Token == NULL) { + return NULL; + } + + Token->Signature = IP4_FRAME_TX_SIGNATURE; + InitializeListHead (&Token->Link); + + Token->Interface = Interface; + Token->IpInstance = IpInstance; + Token->IpSb = IpSb; + Token->CallBack = CallBack; + Token->Packet = Packet; + Token->Context = Context; + CopyMem (&Token->DstMac, &mZeroMacAddress, sizeof (Token->DstMac)); + CopyMem (&Token->SrcMac, &Interface->Mac, sizeof (Token->SrcMac)); + + MnpToken = &(Token->MnpToken); + MnpToken->Status = EFI_NOT_READY; + + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, + Ip4OnFrameSent, + Token, + &MnpToken->Event + ); + + if (EFI_ERROR (Status)) { + FreePool (Token); + return NULL; + } + + MnpTxData = &Token->MnpTxData; + MnpToken->Packet.TxData = MnpTxData; + + MnpTxData->DestinationAddress = &Token->DstMac; + MnpTxData->SourceAddress = &Token->SrcMac; + MnpTxData->ProtocolType = IP4_ETHER_PROTO; + MnpTxData->DataLength = Packet->TotalSize; + MnpTxData->HeaderLength = 0; + + Count = Packet->BlockOpNum; + + NetbufBuildExt (Packet, (NET_FRAGMENT *) MnpTxData->FragmentTable, &Count); + MnpTxData->FragmentCount = (UINT16)Count; + + return Token; +} + + +/** + Free the link layer transmit token. It will close the event + then free the memory used. + + @param[in] Token Token to free + +**/ +VOID +Ip4FreeLinkTxToken ( + IN IP4_LINK_TX_TOKEN *Token + ) +{ + NET_CHECK_SIGNATURE (Token, IP4_FRAME_TX_SIGNATURE); + + gBS->CloseEvent (Token->MnpToken.Event); + FreePool (Token); +} + + +/** + Create an IP_ARP_QUE structure to request ARP service. + + @param[in] Interface The interface to send ARP from. + @param[in] DestIp The destination IP (host byte order) to request MAC + for + + @return Point to newly created IP4_ARP_QUE if succeed, otherwise NULL. + +**/ +IP4_ARP_QUE * +Ip4CreateArpQue ( + IN IP4_INTERFACE *Interface, + IN IP4_ADDR DestIp + ) +{ + IP4_ARP_QUE *ArpQue; + EFI_STATUS Status; + + ArpQue = AllocatePool (sizeof (IP4_ARP_QUE)); + + if (ArpQue == NULL) { + return NULL; + } + + ArpQue->Signature = IP4_FRAME_ARP_SIGNATURE; + InitializeListHead (&ArpQue->Link); + + InitializeListHead (&ArpQue->Frames); + ArpQue->Interface = Interface; + + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, + Ip4OnArpResolved, + ArpQue, + &ArpQue->OnResolved + ); + + if (EFI_ERROR (Status)) { + FreePool (ArpQue); + return NULL; + } + + ArpQue->Ip = DestIp; + CopyMem (&ArpQue->Mac, &mZeroMacAddress, sizeof (ArpQue->Mac)); + + return ArpQue; +} + + +/** + Remove all the transmit requests queued on the ARP queue, then free it. + + @param[in] ArpQue Arp queue to free + @param[in] IoStatus The transmit status returned to transmit requests' + callback. + +**/ +VOID +Ip4FreeArpQue ( + IN IP4_ARP_QUE *ArpQue, + IN EFI_STATUS IoStatus + ) +{ + NET_CHECK_SIGNATURE (ArpQue, IP4_FRAME_ARP_SIGNATURE); + + // + // Remove all the frame waiting the ARP response + // + Ip4CancelFrameArp (ArpQue, IoStatus, NULL, NULL); + + gBS->CloseEvent (ArpQue->OnResolved); + FreePool (ArpQue); +} + + +/** + Create a link layer receive token to wrap the receive request + + @param[in] Interface The interface to receive from + @param[in] IpInstance The instance that request the receive (NULL for IP4 + driver itself) + @param[in] CallBack Call back function to execute when finished. + @param[in] Context Opaque parameters to the callback + + @return Point to created IP4_LINK_RX_TOKEN if succeed, otherwise NULL. + +**/ +IP4_LINK_RX_TOKEN * +Ip4CreateLinkRxToken ( + IN IP4_INTERFACE *Interface, + IN IP4_PROTOCOL *IpInstance, + IN IP4_FRAME_CALLBACK CallBack, + IN VOID *Context + ) +{ + EFI_MANAGED_NETWORK_COMPLETION_TOKEN *MnpToken; + IP4_LINK_RX_TOKEN *Token; + EFI_STATUS Status; + + Token = AllocatePool (sizeof (IP4_LINK_RX_TOKEN)); + if (Token == NULL) { + return NULL; + } + + Token->Signature = IP4_FRAME_RX_SIGNATURE; + Token->Interface = Interface; + Token->IpInstance = IpInstance; + Token->CallBack = CallBack; + Token->Context = Context; + + MnpToken = &Token->MnpToken; + MnpToken->Status = EFI_NOT_READY; + + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, + Ip4OnFrameReceived, + Token, + &MnpToken->Event + ); + + if (EFI_ERROR (Status)) { + FreePool (Token); + return NULL; + } + + MnpToken->Packet.RxData = NULL; + return Token; +} + + +/** + Free the link layer request token. It will close the event + then free the memory used. + + @param[in] Token Request token to free. + +**/ +VOID +Ip4FreeFrameRxToken ( + IN IP4_LINK_RX_TOKEN *Token + ) +{ + + NET_CHECK_SIGNATURE (Token, IP4_FRAME_RX_SIGNATURE); + + gBS->CloseEvent (Token->MnpToken.Event); + FreePool (Token); +} + + +/** + Remove all the frames on the ARP queue that pass the FrameToCancel, + that is, either FrameToCancel is NULL or it returns true for the frame. + + @param[in] ArpQue ARP frame to remove the frames from. + @param[in] IoStatus The status returned to the cancelled frames' + callback function. + @param[in] FrameToCancel Function to select which frame to cancel. + @param[in] Context Opaque parameter to the FrameToCancel. + +**/ +VOID +Ip4CancelFrameArp ( + IN IP4_ARP_QUE *ArpQue, + IN EFI_STATUS IoStatus, + IN IP4_FRAME_TO_CANCEL FrameToCancel OPTIONAL, + IN VOID *Context + ) +{ + LIST_ENTRY *Entry; + LIST_ENTRY *Next; + IP4_LINK_TX_TOKEN *Token; + + NET_LIST_FOR_EACH_SAFE (Entry, Next, &ArpQue->Frames) { + Token = NET_LIST_USER_STRUCT (Entry, IP4_LINK_TX_TOKEN, Link); + + if ((FrameToCancel == NULL) || FrameToCancel (Token, Context)) { + RemoveEntryList (Entry); + + Token->CallBack (Token->IpInstance, Token->Packet, IoStatus, 0, Token->Context); + Ip4FreeLinkTxToken (Token); + } + } +} + + +/** + Remove all the frames on the interface that pass the FrameToCancel, + either queued on ARP queues or that have already been delivered to + MNP and not yet recycled. + + @param[in] Interface Interface to remove the frames from. + @param[in] IoStatus The transmit status returned to the frames' + callback. + @param[in] FrameToCancel Function to select the frame to cancel, NULL to + select all. + @param[in] Context Opaque parameters passed to FrameToCancel. + +**/ +VOID +Ip4CancelFrames ( + IN IP4_INTERFACE *Interface, + IN EFI_STATUS IoStatus, + IN IP4_FRAME_TO_CANCEL FrameToCancel OPTIONAL, + IN VOID *Context + ) +{ + LIST_ENTRY *Entry; + LIST_ENTRY *Next; + IP4_ARP_QUE *ArpQue; + IP4_LINK_TX_TOKEN *Token; + + // + // Cancel all the pending frames on ARP requests + // + NET_LIST_FOR_EACH_SAFE (Entry, Next, &Interface->ArpQues) { + ArpQue = NET_LIST_USER_STRUCT (Entry, IP4_ARP_QUE, Link); + + Ip4CancelFrameArp (ArpQue, IoStatus, FrameToCancel, Context); + + if (IsListEmpty (&ArpQue->Frames)) { + Interface->Arp->Cancel (Interface->Arp, &ArpQue->Ip, ArpQue->OnResolved); + } + } + + // + // Cancel all the frames that have been delivered to MNP + // but not yet recycled. + // + NET_LIST_FOR_EACH_SAFE (Entry, Next, &Interface->SentFrames) { + Token = NET_LIST_USER_STRUCT (Entry, IP4_LINK_TX_TOKEN, Link); + + if ((FrameToCancel == NULL) || FrameToCancel (Token, Context)) { + Interface->Mnp->Cancel (Interface->Mnp, &Token->MnpToken); + } + } +} + + +/** + Create an IP4_INTERFACE. Delay the creation of ARP instance until + the interface is configured. + + @param[in] Mnp The shared MNP child of this IP4 service binding + instance. + @param[in] Controller The controller this IP4 service binding instance + is installed. Most like the UNDI handle. + @param[in] ImageHandle This driver's image handle. + + @return Point to the created IP4_INTERFACE, otherwise NULL. + +**/ +IP4_INTERFACE * +Ip4CreateInterface ( + IN EFI_MANAGED_NETWORK_PROTOCOL *Mnp, + IN EFI_HANDLE Controller, + IN EFI_HANDLE ImageHandle + ) +{ + IP4_INTERFACE *Interface; + EFI_SIMPLE_NETWORK_MODE SnpMode; + + Interface = AllocatePool (sizeof (IP4_INTERFACE)); + + if ((Interface == NULL) || (Mnp == NULL)) { + return NULL; + } + + Interface->Signature = IP4_INTERFACE_SIGNATURE; + InitializeListHead (&Interface->Link); + Interface->RefCnt = 1; + + Interface->Ip = IP4_ALLZERO_ADDRESS; + Interface->SubnetMask = IP4_ALLZERO_ADDRESS; + Interface->Configured = FALSE; + + Interface->Controller = Controller; + Interface->Image = ImageHandle; + Interface->Mnp = Mnp; + Interface->Arp = NULL; + Interface->ArpHandle = NULL; + + InitializeListHead (&Interface->ArpQues); + InitializeListHead (&Interface->SentFrames); + + Interface->RecvRequest = NULL; + + // + // Get the interface's Mac address and broadcast mac address from SNP + // + if (EFI_ERROR (Mnp->GetModeData (Mnp, NULL, &SnpMode))) { + FreePool (Interface); + return NULL; + } + + CopyMem (&Interface->Mac, &SnpMode.CurrentAddress, sizeof (Interface->Mac)); + CopyMem (&Interface->BroadcastMac, &SnpMode.BroadcastAddress, sizeof (Interface->BroadcastMac)); + Interface->HwaddrLen = SnpMode.HwAddressSize; + + InitializeListHead (&Interface->IpInstances); + Interface->PromiscRecv = FALSE; + + return Interface; +} + + +/** + Set the interface's address, create and configure + the ARP child if necessary. + + @param Interface The interface to set the address. + @param IpAddr The interface's IP address. + @param SubnetMask The interface's netmask. + + @retval EFI_SUCCESS The interface is configured with Ip/netmask pair, + and a ARP is created for it. + @retval Others Failed to set the interface's address. + +**/ +EFI_STATUS +Ip4SetAddress ( + IN OUT IP4_INTERFACE *Interface, + IN IP4_ADDR IpAddr, + IN IP4_ADDR SubnetMask + ) +{ + EFI_ARP_CONFIG_DATA ArpConfig; + EFI_STATUS Status; + + NET_CHECK_SIGNATURE (Interface, IP4_INTERFACE_SIGNATURE); + + // + // Set the ip/netmask, then compute the subnet broadcast + // and network broadcast for easy access. When computing + // nework broadcast, the subnet mask is most like longer + // than the default netmask (not subneted) as defined in + // RFC793. If that isn't the case, we are aggregating the + // networks, use the subnet's mask instead. + // + Interface->Ip = IpAddr; + Interface->SubnetMask = SubnetMask; + Interface->SubnetBrdcast = (IpAddr | ~SubnetMask); + Interface->NetBrdcast = (IpAddr | ~SubnetMask); + + // + // Do clean up for Arp child + // + if (Interface->ArpHandle != NULL) { + if (Interface->Arp != NULL) { + gBS->CloseProtocol ( + Interface->ArpHandle, + &gEfiArpProtocolGuid, + Interface->Image, + Interface->Controller + ); + + Interface->Arp = NULL; + } + + NetLibDestroyServiceChild ( + Interface->Controller, + Interface->Image, + &gEfiArpServiceBindingProtocolGuid, + &Interface->ArpHandle + ); + + Interface->ArpHandle = NULL; + } + + // + // If the address is NOT all zero, create then configure an ARP child. + // Pay attention: DHCP configures its station address as 0.0.0.0/0 + // + if (IpAddr != IP4_ALLZERO_ADDRESS) { + Status = NetLibCreateServiceChild ( + Interface->Controller, + Interface->Image, + &gEfiArpServiceBindingProtocolGuid, + &Interface->ArpHandle + ); + + if (EFI_ERROR (Status)) { + return Status; + } + + Status = gBS->OpenProtocol ( + Interface->ArpHandle, + &gEfiArpProtocolGuid, + (VOID **) &Interface->Arp, + Interface->Image, + Interface->Controller, + EFI_OPEN_PROTOCOL_BY_DRIVER + ); + + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + IpAddr = HTONL (IpAddr); + ArpConfig.SwAddressType = IP4_ETHER_PROTO; + ArpConfig.SwAddressLength = 4; + ArpConfig.StationAddress = &IpAddr; + ArpConfig.EntryTimeOut = 0; + ArpConfig.RetryCount = 0; + ArpConfig.RetryTimeOut = 0; + + Status = Interface->Arp->Configure (Interface->Arp, &ArpConfig); + + if (EFI_ERROR (Status)) { + gBS->CloseProtocol ( + Interface->ArpHandle, + &gEfiArpProtocolGuid, + Interface->Image, + Interface->Controller + ); + + goto ON_ERROR; + } + } + + Interface->Configured = TRUE; + return EFI_SUCCESS; + +ON_ERROR: + NetLibDestroyServiceChild ( + Interface->Controller, + Interface->Image, + &gEfiArpServiceBindingProtocolGuid, + &Interface->ArpHandle + ); + + return Status; +} + + +/** + Filter function to cancel all the frame related to an IP instance. + + @param[in] Frame The transmit request to test whether to cancel + @param[in] Context The context which is the Ip instance that issued + the transmit. + + @retval TRUE The frame belongs to this instance and is to be + removed + @retval FALSE The frame doesn't belong to this instance. + +**/ +BOOLEAN +Ip4CancelInstanceFrame ( + IN IP4_LINK_TX_TOKEN *Frame, + IN VOID *Context + ) +{ + if (Frame->IpInstance == (IP4_PROTOCOL *) Context) { + return TRUE; + } + + return FALSE; +} + + + +/** + If there is a pending receive request, cancel it. Don't call + the receive request's callback because this function can be only + called if the instance or driver is tearing itself down. It + doesn't make sense to call it back. But it is necessary to call + the transmit token's callback to give it a chance to free the + packet and update the upper layer's transmit request status, say + that from the UDP. + + @param[in] Interface The interface used by the IpInstance + +**/ +VOID +Ip4CancelReceive ( + IN IP4_INTERFACE *Interface + ) +{ + EFI_TPL OldTpl; + IP4_LINK_RX_TOKEN *Token; + + if ((Token = Interface->RecvRequest) != NULL) { + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + Interface->RecvRequest = NULL; + Interface->Mnp->Cancel (Interface->Mnp, &Token->MnpToken); + + gBS->RestoreTPL (OldTpl); + } +} + + +/** + Free the interface used by IpInstance. All the IP instance with + the same Ip/Netmask pair share the same interface. It is reference + counted. All the frames haven't been sent will be cancelled. + Because the IpInstance is optional, the caller must remove + IpInstance from the interface's instance list itself. + + @param[in] Interface The interface used by the IpInstance. + @param[in] IpInstance The Ip instance that free the interface. NULL if + the Ip driver is releasing the default interface. + + @retval EFI_SUCCESS The interface use IpInstance is freed. + +**/ +EFI_STATUS +Ip4FreeInterface ( + IN IP4_INTERFACE *Interface, + IN IP4_PROTOCOL *IpInstance OPTIONAL + ) +{ + NET_CHECK_SIGNATURE (Interface, IP4_INTERFACE_SIGNATURE); + ASSERT (Interface->RefCnt > 0); + + // + // Remove all the pending transmit token related to this IP instance. + // + Ip4CancelFrames (Interface, EFI_ABORTED, Ip4CancelInstanceFrame, IpInstance); + + if (--Interface->RefCnt > 0) { + return EFI_SUCCESS; + } + + // + // Destroy the interface if this is the last IP instance that + // has the address. Remove all the system transmitted packets + // from this interface, cancel the receive request if there is + // one, and destroy the ARP requests. + // + Ip4CancelFrames (Interface, EFI_ABORTED, Ip4CancelInstanceFrame, NULL); + Ip4CancelReceive (Interface); + + ASSERT (IsListEmpty (&Interface->IpInstances)); + ASSERT (IsListEmpty (&Interface->ArpQues)); + ASSERT (IsListEmpty (&Interface->SentFrames)); + + if (Interface->Arp != NULL) { + gBS->CloseProtocol ( + Interface->ArpHandle, + &gEfiArpProtocolGuid, + Interface->Image, + Interface->Controller + ); + + NetLibDestroyServiceChild ( + Interface->Controller, + Interface->Image, + &gEfiArpServiceBindingProtocolGuid, + Interface->ArpHandle + ); + } + + RemoveEntryList (&Interface->Link); + FreePool (Interface); + + return EFI_SUCCESS; +} + +/** + This function tries to send all the queued frames in ArpQue to the default gateway if + the ARP resolve for direct destination address is failed when using /32 subnet mask. + + @param[in] ArpQue The ARP queue of a failed request. + + @retval EFI_SUCCESS All the queued frames have been send to the default route. + @retval Others Failed to send the queued frames. + +**/ +EFI_STATUS +Ip4SendFrameToDefaultRoute ( + IN IP4_ARP_QUE *ArpQue + ) +{ + LIST_ENTRY *Entry; + LIST_ENTRY *Next; + IP4_ROUTE_CACHE_ENTRY *RtCacheEntry; + IP4_LINK_TX_TOKEN *Token; + IP4_ADDR Gateway; + EFI_STATUS Status; + IP4_ROUTE_ENTRY *DefaultRoute; + + // + // ARP resolve failed when using /32 subnet mask. + // + NET_LIST_FOR_EACH_SAFE (Entry, Next, &ArpQue->Frames) { + RemoveEntryList (Entry); + Token = NET_LIST_USER_STRUCT (Entry, IP4_LINK_TX_TOKEN, Link); + ASSERT (Token->Interface->SubnetMask == IP4_ALLONE_ADDRESS); + // + // Find the default gateway IP address. The default route was saved to the RtCacheEntry->Tag in Ip4Route(). + // + RtCacheEntry = NULL; + if (Token->IpInstance != NULL) { + RtCacheEntry = Ip4FindRouteCache (Token->IpInstance->RouteTable, NTOHL (ArpQue->Ip), Token->Interface->Ip); + } + if (RtCacheEntry == NULL) { + RtCacheEntry = Ip4FindRouteCache (Token->IpSb->DefaultRouteTable, NTOHL (ArpQue->Ip), Token->Interface->Ip); + } + if (RtCacheEntry == NULL) { + Status= EFI_NO_MAPPING; + goto ON_ERROR; + } + DefaultRoute = (IP4_ROUTE_ENTRY*)RtCacheEntry->Tag; + if (DefaultRoute == NULL) { + Status= EFI_NO_MAPPING; + goto ON_ERROR; + } + // + // Try to send the frame to the default route. + // + Gateway = DefaultRoute->NextHop; + if (ArpQue->Ip == Gateway) { + // + // ARP resolve for the default route is failed, return error to caller. + // + Status= EFI_NO_MAPPING; + goto ON_ERROR; + } + RtCacheEntry->NextHop = Gateway; + Status = Ip4SendFrame (Token->Interface,Token->IpInstance,Token->Packet,Gateway,Token->CallBack,Token->Context,Token->IpSb); + if (EFI_ERROR (Status)) { + Status= EFI_NO_MAPPING; + goto ON_ERROR; + } + Ip4FreeRouteCacheEntry (RtCacheEntry); + } + + return EFI_SUCCESS; + +ON_ERROR: + if (RtCacheEntry != NULL) { + Ip4FreeRouteCacheEntry (RtCacheEntry); + } + Token->CallBack (Token->IpInstance, Token->Packet, Status, 0, Token->Context); + Ip4FreeLinkTxToken (Token); + return Status; +} + + +/** + Callback function when ARP request are finished. It will cancel + all the queued frame if the ARP requests failed. Or transmit them + if the request succeed. + + @param[in] Context The context of the callback, a point to the ARP + queue + +**/ +VOID +EFIAPI +Ip4OnArpResolvedDpc ( + IN VOID *Context + ) +{ + LIST_ENTRY *Entry; + LIST_ENTRY *Next; + IP4_ARP_QUE *ArpQue; + IP4_INTERFACE *Interface; + IP4_LINK_TX_TOKEN *Token; + EFI_STATUS Status; + EFI_STATUS IoStatus; + + ArpQue = (IP4_ARP_QUE *) Context; + NET_CHECK_SIGNATURE (ArpQue, IP4_FRAME_ARP_SIGNATURE); + + RemoveEntryList (&ArpQue->Link); + + // + // ARP resolve failed for some reason. + // + if (NET_MAC_EQUAL (&ArpQue->Mac, &mZeroMacAddress, ArpQue->Interface->HwaddrLen)) { + if (ArpQue->Interface->SubnetMask != IP4_ALLONE_ADDRESS) { + // + // Release all the frame and ARP queue itself. Ip4FreeArpQue will call the frame's + // owner back. + // + IoStatus = EFI_NO_MAPPING; + } else { + // + // ARP resolve failed when using 32bit subnet mask, try to send the packets to the + // default route. + // + IoStatus = Ip4SendFrameToDefaultRoute (ArpQue); + } + goto ON_EXIT; + } + + // + // ARP resolve succeeded, Transmit all the frame. Release the ARP + // queue. It isn't necessary for us to cache the ARP binding because + // we always check the ARP cache first before transmit. + // + IoStatus = EFI_SUCCESS; + Interface = ArpQue->Interface; + + NET_LIST_FOR_EACH_SAFE (Entry, Next, &ArpQue->Frames) { + RemoveEntryList (Entry); + + Token = NET_LIST_USER_STRUCT (Entry, IP4_LINK_TX_TOKEN, Link); + CopyMem (&Token->DstMac, &ArpQue->Mac, sizeof (Token->DstMac)); + + // + // Insert the tx token before transmitting it via MNP as the FrameSentDpc + // may be called before Mnp->Transmit returns which will remove this tx + // token from the SentFrames list. Remove it from the list if the returned + // Status of Mnp->Transmit is not EFI_SUCCESS as in this case the + // FrameSentDpc won't be queued. + // + InsertTailList (&Interface->SentFrames, &Token->Link); + + Status = Interface->Mnp->Transmit (Interface->Mnp, &Token->MnpToken); + if (EFI_ERROR (Status)) { + RemoveEntryList (&Token->Link); + Token->CallBack (Token->IpInstance, Token->Packet, Status, 0, Token->Context); + + Ip4FreeLinkTxToken (Token); + continue; + } + } + +ON_EXIT: + Ip4FreeArpQue (ArpQue, IoStatus); +} + +/** + Request Ip4OnArpResolvedDpc as a DPC at TPL_CALLBACK. + + @param Event The Arp request event. + @param Context The context of the callback, a point to the ARP + queue. + +**/ +VOID +EFIAPI +Ip4OnArpResolved ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + // + // Request Ip4OnArpResolvedDpc as a DPC at TPL_CALLBACK + // + QueueDpc (TPL_CALLBACK, Ip4OnArpResolvedDpc, Context); +} + + + +/** + Callback funtion when frame transmission is finished. It will + call the frame owner's callback function to tell it the result. + + @param[in] Context Context which is point to the token. + +**/ +VOID +EFIAPI +Ip4OnFrameSentDpc ( + IN VOID *Context + ) +{ + IP4_LINK_TX_TOKEN *Token; + + Token = (IP4_LINK_TX_TOKEN *) Context; + NET_CHECK_SIGNATURE (Token, IP4_FRAME_TX_SIGNATURE); + + RemoveEntryList (&Token->Link); + + Token->CallBack ( + Token->IpInstance, + Token->Packet, + Token->MnpToken.Status, + 0, + Token->Context + ); + + Ip4FreeLinkTxToken (Token); +} + +/** + Request Ip4OnFrameSentDpc as a DPC at TPL_CALLBACK. + + @param[in] Event The transmit token's event. + @param[in] Context Context which is point to the token. + +**/ +VOID +EFIAPI +Ip4OnFrameSent ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + // + // Request Ip4OnFrameSentDpc as a DPC at TPL_CALLBACK + // + QueueDpc (TPL_CALLBACK, Ip4OnFrameSentDpc, Context); +} + + + +/** + Send a frame from the interface. If the next hop is broadcast or + multicast address, it is transmitted immediately. If the next hop + is a unicast, it will consult ARP to resolve the NextHop's MAC. + If some error happened, the CallBack won't be called. So, the caller + must test the return value, and take action when there is an error. + + @param[in] Interface The interface to send the frame from + @param[in] IpInstance The IP child that request the transmission. NULL + if it is the IP4 driver itself. + @param[in] Packet The packet to transmit. + @param[in] NextHop The immediate destination to transmit the packet + to. + @param[in] CallBack Function to call back when transmit finished. + @param[in] Context Opaque parameter to the call back. + @param[in] IpSb The pointer to the IP4 service binding instance. + + @retval EFI_OUT_OF_RESOURCES Failed to allocate resource to send the frame + @retval EFI_NO_MAPPING Can't resolve the MAC for the nexthop + @retval EFI_SUCCESS The packet is successfully transmitted. + @retval other Other error occurs. + +**/ +EFI_STATUS +Ip4SendFrame ( + IN IP4_INTERFACE *Interface, + IN IP4_PROTOCOL *IpInstance OPTIONAL, + IN NET_BUF *Packet, + IN IP4_ADDR NextHop, + IN IP4_FRAME_CALLBACK CallBack, + IN VOID *Context, + IN IP4_SERVICE *IpSb + ) +{ + IP4_LINK_TX_TOKEN *Token; + LIST_ENTRY *Entry; + IP4_ARP_QUE *ArpQue; + EFI_ARP_PROTOCOL *Arp; + EFI_STATUS Status; + + ASSERT (Interface->Configured); + + Token = Ip4WrapLinkTxToken (Interface, IpInstance, Packet, CallBack, Context, IpSb); + + if (Token == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + // + // Get the destination MAC address for multicast and broadcasts. + // Don't depend on ARP to solve the address since there maybe no + // ARP at all. Ip4Output has set NextHop to 255.255.255.255 for + // all the broadcasts. + // + if (NextHop == IP4_ALLONE_ADDRESS) { + CopyMem (&Token->DstMac, &Interface->BroadcastMac, sizeof (Token->DstMac)); + goto SEND_NOW; + + } else if (IP4_IS_MULTICAST (NextHop)) { + + Status = Ip4GetMulticastMac (Interface->Mnp, NextHop, &Token->DstMac); + + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + goto SEND_NOW; + } + + // + // Can only send out multicast/broadcast if the IP address is zero + // + if ((Arp = Interface->Arp) == NULL) { + Status = EFI_NO_MAPPING; + goto ON_ERROR; + } + + // + // First check whether this binding is in the ARP cache. + // + NextHop = HTONL (NextHop); + Status = Arp->Request (Arp, &NextHop, NULL, &Token->DstMac); + + if (Status == EFI_SUCCESS) { + goto SEND_NOW; + + } else if (Status != EFI_NOT_READY) { + goto ON_ERROR; + } + + // + // Have to do asynchronous ARP resolution. First check + // whether there is already a pending request. + // + ArpQue = NULL; + + NET_LIST_FOR_EACH (Entry, &Interface->ArpQues) { + ArpQue = NET_LIST_USER_STRUCT (Entry, IP4_ARP_QUE, Link); + + if (ArpQue->Ip == NextHop) { + break; + } + } + + // + // Found a pending ARP request, enqueue the frame then return + // + if (Entry != &Interface->ArpQues) { + InsertTailList (&ArpQue->Frames, &Token->Link); + return EFI_SUCCESS; + } + + // + // First frame to NextHop, issue an asynchronous ARP requests + // + ArpQue = Ip4CreateArpQue (Interface, NextHop); + + if (ArpQue == NULL) { + Status = EFI_OUT_OF_RESOURCES; + goto ON_ERROR; + } + + Status = Arp->Request (Arp, &ArpQue->Ip, ArpQue->OnResolved, ArpQue->Mac.Addr); + + if (EFI_ERROR (Status) && (Status != EFI_NOT_READY)) { + Ip4FreeArpQue (ArpQue, EFI_NO_MAPPING); + goto ON_ERROR; + } + + InsertHeadList (&ArpQue->Frames, &Token->Link); + InsertHeadList (&Interface->ArpQues, &ArpQue->Link); + return EFI_SUCCESS; + +SEND_NOW: + // + // Insert the tx token into the SentFrames list before calling Mnp->Transmit. + // Remove it if the returned status is not EFI_SUCCESS. + // + InsertTailList (&Interface->SentFrames, &Token->Link); + Status = Interface->Mnp->Transmit (Interface->Mnp, &Token->MnpToken); + if (EFI_ERROR (Status)) { + RemoveEntryList (&Token->Link); + goto ON_ERROR; + } + + return EFI_SUCCESS; + +ON_ERROR: + Ip4FreeLinkTxToken (Token); + return Status; +} + + +/** + Call back function when the received packet is freed. + Check Ip4OnFrameReceived for information. + + @param Context Context, which is the IP4_LINK_RX_TOKEN. + +**/ +VOID +EFIAPI +Ip4RecycleFrame ( + IN VOID *Context + ) +{ + IP4_LINK_RX_TOKEN *Frame; + + Frame = (IP4_LINK_RX_TOKEN *) Context; + NET_CHECK_SIGNATURE (Frame, IP4_FRAME_RX_SIGNATURE); + + gBS->SignalEvent (Frame->MnpToken.Packet.RxData->RecycleEvent); + Ip4FreeFrameRxToken (Frame); +} + + +/** + Received a frame from MNP, wrap it in net buffer then deliver + it to IP's input function. The ownship of the packet also + transferred to IP. When Ip is finished with this packet, it + will call NetbufFree to release the packet, NetbufFree will + again call the Ip4RecycleFrame to signal MNP's event and free + the token used. + + @param Context Context for the callback. + +**/ +VOID +EFIAPI +Ip4OnFrameReceivedDpc ( + IN VOID *Context + ) +{ + EFI_MANAGED_NETWORK_COMPLETION_TOKEN *MnpToken; + EFI_MANAGED_NETWORK_RECEIVE_DATA *MnpRxData; + IP4_LINK_RX_TOKEN *Token; + NET_FRAGMENT Netfrag; + NET_BUF *Packet; + UINT32 Flag; + + Token = (IP4_LINK_RX_TOKEN *) Context; + NET_CHECK_SIGNATURE (Token, IP4_FRAME_RX_SIGNATURE); + + // + // First clear the interface's receive request in case the + // caller wants to call Ip4ReceiveFrame in the callback. + // + Token->Interface->RecvRequest = NULL; + + MnpToken = &Token->MnpToken; + MnpRxData = MnpToken->Packet.RxData; + + if (EFI_ERROR (MnpToken->Status) || (MnpRxData == NULL)) { + Token->CallBack (Token->IpInstance, NULL, MnpToken->Status, 0, Token->Context); + Ip4FreeFrameRxToken (Token); + + return ; + } + + // + // Wrap the frame in a net buffer then deliever it to IP input. + // IP will reassemble the packet, and deliver it to upper layer + // + Netfrag.Len = MnpRxData->DataLength; + Netfrag.Bulk = MnpRxData->PacketData; + + Packet = NetbufFromExt (&Netfrag, 1, 0, IP4_MAX_HEADLEN, Ip4RecycleFrame, Token); + + if (Packet == NULL) { + gBS->SignalEvent (MnpRxData->RecycleEvent); + + Token->CallBack (Token->IpInstance, NULL, EFI_OUT_OF_RESOURCES, 0, Token->Context); + Ip4FreeFrameRxToken (Token); + + return ; + } + + Flag = (MnpRxData->BroadcastFlag ? IP4_LINK_BROADCAST : 0); + Flag |= (MnpRxData->MulticastFlag ? IP4_LINK_MULTICAST : 0); + Flag |= (MnpRxData->PromiscuousFlag ? IP4_LINK_PROMISC : 0); + + Token->CallBack (Token->IpInstance, Packet, EFI_SUCCESS, Flag, Token->Context); +} + +/** + Request Ip4OnFrameReceivedDpc as a DPC at TPL_CALLBACK. + + @param Event The receive event delivered to MNP for receive. + @param Context Context for the callback. + +**/ +VOID +EFIAPI +Ip4OnFrameReceived ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + // + // Request Ip4OnFrameReceivedDpc as a DPC at TPL_CALLBACK + // + QueueDpc (TPL_CALLBACK, Ip4OnFrameReceivedDpc, Context); +} + + +/** + Request to receive the packet from the interface. + + @param[in] Interface The interface to receive the frames from. + @param[in] IpInstance The instance that requests the receive. NULL for + the driver itself. + @param[in] CallBack Function to call when receive finished. + @param[in] Context Opaque parameter to the callback. + + @retval EFI_ALREADY_STARTED There is already a pending receive request. + @retval EFI_OUT_OF_RESOURCES Failed to allocate resource to receive. + @retval EFI_SUCCESS The recieve request has been started. + @retval other Other error occurs. + +**/ +EFI_STATUS +Ip4ReceiveFrame ( + IN IP4_INTERFACE *Interface, + IN IP4_PROTOCOL *IpInstance OPTIONAL, + IN IP4_FRAME_CALLBACK CallBack, + IN VOID *Context + ) +{ + IP4_LINK_RX_TOKEN *Token; + EFI_STATUS Status; + + NET_CHECK_SIGNATURE (Interface, IP4_INTERFACE_SIGNATURE); + + if (Interface->RecvRequest != NULL) { + return EFI_ALREADY_STARTED; + } + + Token = Ip4CreateLinkRxToken (Interface, IpInstance, CallBack, Context); + + if (Token == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + Interface->RecvRequest = Token; + Status = Interface->Mnp->Receive (Interface->Mnp, &Token->MnpToken); + if (EFI_ERROR (Status)) { + Interface->RecvRequest = NULL; + Ip4FreeFrameRxToken (Token); + return Status; + } + return EFI_SUCCESS; +} diff --git a/NetworkPkg/Ip4Dxe/Ip4If.h b/NetworkPkg/Ip4Dxe/Ip4If.h new file mode 100644 index 0000000000..d73bb5285f --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4If.h @@ -0,0 +1,340 @@ +/** @file + Definition for IP4 pesudo interface structure. + +Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef __EFI_IP4_IF_H__ +#define __EFI_IP4_IF_H__ + +#define IP4_FRAME_RX_SIGNATURE SIGNATURE_32 ('I', 'P', 'F', 'R') +#define IP4_FRAME_TX_SIGNATURE SIGNATURE_32 ('I', 'P', 'F', 'T') +#define IP4_FRAME_ARP_SIGNATURE SIGNATURE_32 ('I', 'P', 'F', 'A') +#define IP4_INTERFACE_SIGNATURE SIGNATURE_32 ('I', 'P', 'I', 'F') + +/** + This prototype is used by both receive and transmission. + When receiving Netbuf is allocated by IP4_INTERFACE, and + released by IP4. Flag shows whether the frame is received + as link broadcast/multicast... + + When transmitting, the Netbuf is from IP4, and provided + to the callback as a reference. Flag isn't used. + + @param[in] IpInstance The instance that sent or received the packet. + IpInstance can be NULL which means that it is the IP4 driver + itself sending the packets. IP4 driver may send packets that + don't belong to any instance, such as ICMP errors, ICMP echo + responses, or IGMP packets. IpInstance is used as a tag in + this module. + @param[in] Packet The sent or received packet. + @param[in] IoStatus Status of sending or receiving. + @param[in] LinkFlag Indicate if the frame is received as link broadcast/multicast. + When transmitting, it is not used. + @param[in] Context Additional data for callback. + + @retval None. +**/ +typedef +VOID +(*IP4_FRAME_CALLBACK)( + IN IP4_PROTOCOL *IpInstance OPTIONAL, + IN NET_BUF *Packet, + IN EFI_STATUS IoStatus, + IN UINT32 LinkFlag, + IN VOID *Context + ); + +/// +/// Each receive request is wrapped in an IP4_LINK_RX_TOKEN. +/// Upon completion, the Callback will be called. Only one +/// receive request is send to MNP. IpInstance is always NULL. +/// Reference MNP's spec for information. +/// +typedef struct { + UINT32 Signature; + IP4_INTERFACE *Interface; + + IP4_PROTOCOL *IpInstance; + IP4_FRAME_CALLBACK CallBack; + VOID *Context; + + EFI_MANAGED_NETWORK_COMPLETION_TOKEN MnpToken; +} IP4_LINK_RX_TOKEN; + +/// +/// Each transmit request is wrapped in an IP4_LINK_TX_TOKEN. +/// Upon completion, the Callback will be called. +/// +typedef struct { + UINT32 Signature; + LIST_ENTRY Link; + + IP4_INTERFACE *Interface; + IP4_SERVICE *IpSb; + + IP4_PROTOCOL *IpInstance; + IP4_FRAME_CALLBACK CallBack; + NET_BUF *Packet; + VOID *Context; + + EFI_MAC_ADDRESS DstMac; + EFI_MAC_ADDRESS SrcMac; + + EFI_MANAGED_NETWORK_COMPLETION_TOKEN MnpToken; + EFI_MANAGED_NETWORK_TRANSMIT_DATA MnpTxData; +} IP4_LINK_TX_TOKEN; + +/// +/// Only one ARP request is requested for all the frames in +/// a time. It is started for the first frames to the Ip. Any +/// subsequent transmission frame will be linked to Frames, and +/// be sent all at once the ARP requests succeed. +/// +typedef struct { + UINT32 Signature; + LIST_ENTRY Link; + + LIST_ENTRY Frames; + IP4_INTERFACE *Interface; + + // + // ARP requesting staffs + // + EFI_EVENT OnResolved; + IP4_ADDR Ip; + EFI_MAC_ADDRESS Mac; +} IP4_ARP_QUE; + +/** + Callback to select which frame to cancel. Caller can cancel a + single frame, or all the frame from an IP instance. + + @param Frame The sending frame to check for cancellation. + @param Context Additional data for callback. + + @retval TRUE The sending of the frame should be cancelled. + @retval FALSE Do not cancel the frame sending. +**/ +typedef +BOOLEAN +(*IP4_FRAME_TO_CANCEL)( + IP4_LINK_TX_TOKEN *Frame, + VOID *Context + ); + +// +// Each IP4 instance has its own station address. All the instances +// with the same station address share a single interface structure. +// Each interface has its own ARP child, and shares one MNP child. +// Notice the special cases that DHCP can configure the interface +// with 0.0.0.0/0.0.0.0. +// +struct _IP4_INTERFACE { + UINT32 Signature; + LIST_ENTRY Link; + INTN RefCnt; + + // + // IP address and subnet mask of the interface. It also contains + // the subnet/net broadcast address for quick access. The fields + // are invalid if (Configured == FALSE) + // + IP4_ADDR Ip; + IP4_ADDR SubnetMask; + IP4_ADDR SubnetBrdcast; + IP4_ADDR NetBrdcast; + BOOLEAN Configured; + + // + // Handle used to create/destroy ARP child. All the IP children + // share one MNP which is owned by IP service binding. + // + EFI_HANDLE Controller; + EFI_HANDLE Image; + + EFI_MANAGED_NETWORK_PROTOCOL *Mnp; + EFI_ARP_PROTOCOL *Arp; + EFI_HANDLE ArpHandle; + + // + // Queues to keep the frames sent and waiting ARP request. + // + LIST_ENTRY ArpQues; + LIST_ENTRY SentFrames; + IP4_LINK_RX_TOKEN *RecvRequest; + + // + // The interface's MAC and broadcast MAC address. + // + EFI_MAC_ADDRESS Mac; + EFI_MAC_ADDRESS BroadcastMac; + UINT32 HwaddrLen; + + // + // All the IP instances that have the same IP/SubnetMask are linked + // together through IpInstances. If any of the instance enables + // promiscuous receive, PromiscRecv is true. + // + LIST_ENTRY IpInstances; + BOOLEAN PromiscRecv; +}; + +/** + Create an IP4_INTERFACE. Delay the creation of ARP instance until + the interface is configured. + + @param[in] Mnp The shared MNP child of this IP4 service binding + instance. + @param[in] Controller The controller this IP4 service binding instance + is installed. Most like the UNDI handle. + @param[in] ImageHandle This driver's image handle. + + @return Point to the created IP4_INTERFACE, otherwise NULL. + +**/ +IP4_INTERFACE * +Ip4CreateInterface ( + IN EFI_MANAGED_NETWORK_PROTOCOL *Mnp, + IN EFI_HANDLE Controller, + IN EFI_HANDLE ImageHandle + ); + +/** + Set the interface's address, create and configure + the ARP child if necessary. + + @param Interface The interface to set the address. + @param IpAddr The interface's IP address. + @param SubnetMask The interface's netmask. + + @retval EFI_SUCCESS The interface is configured with Ip/netmask pair, + and a ARP is created for it. + @retval Others Failed to set the interface's address. + +**/ +EFI_STATUS +Ip4SetAddress ( + IN OUT IP4_INTERFACE *Interface, + IN IP4_ADDR IpAddr, + IN IP4_ADDR SubnetMask + ); + +/** + Free the interface used by IpInstance. All the IP instance with + the same Ip/Netmask pair share the same interface. It is reference + counted. All the frames haven't been sent will be cancelled. + Because the IpInstance is optional, the caller must remove + IpInstance from the interface's instance list itself. + + @param[in] Interface The interface used by the IpInstance. + @param[in] IpInstance The Ip instance that free the interface. NULL if + the Ip driver is releasing the default interface. + + @retval EFI_SUCCESS The interface use IpInstance is freed. + +**/ +EFI_STATUS +Ip4FreeInterface ( + IN IP4_INTERFACE *Interface, + IN IP4_PROTOCOL *IpInstance OPTIONAL + ); + +/** + Send a frame from the interface. If the next hop is broadcast or + multicast address, it is transmitted immediately. If the next hop + is a unicast, it will consult ARP to resolve the NextHop's MAC. + If some error happened, the CallBack won't be called. So, the caller + must test the return value, and take action when there is an error. + + @param[in] Interface The interface to send the frame from + @param[in] IpInstance The IP child that request the transmission. NULL + if it is the IP4 driver itself. + @param[in] Packet The packet to transmit. + @param[in] NextHop The immediate destination to transmit the packet + to. + @param[in] CallBack Function to call back when transmit finished. + @param[in] Context Opaque parameter to the call back. + @param[in] IpSb The pointer to the IP4 service binding instance. + + @retval EFI_OUT_OF_RESOURCES Failed to allocate resource to send the frame + @retval EFI_NO_MAPPING Can't resolve the MAC for the nexthop + @retval EFI_SUCCESS The packet is successfully transmitted. + @retval other Other error occurs. + +**/ +EFI_STATUS +Ip4SendFrame ( + IN IP4_INTERFACE *Interface, + IN IP4_PROTOCOL *IpInstance OPTIONAL, + IN NET_BUF *Packet, + IN IP4_ADDR NextHop, + IN IP4_FRAME_CALLBACK CallBack, + IN VOID *Context, + IN IP4_SERVICE *IpSb + ); + +/** + Remove all the frames on the interface that pass the FrameToCancel, + either queued on ARP queues or that have already been delivered to + MNP and not yet recycled. + + @param[in] Interface Interface to remove the frames from. + @param[in] IoStatus The transmit status returned to the frames' + callback. + @param[in] FrameToCancel Function to select the frame to cancel, NULL to + select all. + @param[in] Context Opaque parameters passed to FrameToCancel. + +**/ +VOID +Ip4CancelFrames ( + IN IP4_INTERFACE *Interface, + IN EFI_STATUS IoStatus, + IN IP4_FRAME_TO_CANCEL FrameToCancel OPTIONAL, + IN VOID *Context + ); + +/** + If there is a pending receive request, cancel it. Don't call + the receive request's callback because this function can be only + called if the instance or driver is tearing itself down. It + doesn't make sense to call it back. But it is necessary to call + the transmit token's callback to give it a chance to free the + packet and update the upper layer's transmit request status, say + that from the UDP. + + @param[in] Interface The interface used by the IpInstance + +**/ +VOID +Ip4CancelReceive ( + IN IP4_INTERFACE *Interface + ); + +/** + Request to receive the packet from the interface. + + @param[in] Interface The interface to receive the frames from. + @param[in] IpInstance The instance that requests the receive. NULL for + the driver itself. + @param[in] CallBack Function to call when receive finished. + @param[in] Context Opaque parameter to the callback. + + @retval EFI_ALREADY_STARTED There is already a pending receive request. + @retval EFI_OUT_OF_RESOURCES Failed to allocate resource to receive. + @retval EFI_SUCCESS The recieve request has been started. + @retval other Other error occurs. + +**/ +EFI_STATUS +Ip4ReceiveFrame ( + IN IP4_INTERFACE *Interface, + IN IP4_PROTOCOL *IpInstance OPTIONAL, + IN IP4_FRAME_CALLBACK CallBack, + IN VOID *Context + ); + +#endif diff --git a/NetworkPkg/Ip4Dxe/Ip4Igmp.c b/NetworkPkg/Ip4Dxe/Ip4Igmp.c new file mode 100644 index 0000000000..41d9bce971 --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4Igmp.c @@ -0,0 +1,615 @@ +/** @file + This file implements the RFC2236: IGMP v2. + +Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Ip4Impl.h" + +// +// Route Alert option in IGMP report to direct routers to +// examine the packet more closely. +// +UINT32 mRouteAlertOption = 0x00000494; + + +/** + Init the IGMP control data of the IP4 service instance, configure + MNP to receive ALL SYSTEM multicast. + + @param[in, out] IpSb The IP4 service whose IGMP is to be initialized. + + @retval EFI_SUCCESS IGMP of the IpSb is successfully initialized. + @retval EFI_OUT_OF_RESOURCES Failed to allocate resource to initialize IGMP. + @retval Others Failed to initialize the IGMP of IpSb. + +**/ +EFI_STATUS +Ip4InitIgmp ( + IN OUT IP4_SERVICE *IpSb + ) +{ + IGMP_SERVICE_DATA *IgmpCtrl; + EFI_MANAGED_NETWORK_PROTOCOL *Mnp; + IGMP_GROUP *Group; + EFI_STATUS Status; + + IgmpCtrl = &IpSb->IgmpCtrl; + + // + // Configure MNP to receive ALL_SYSTEM multicast + // + Group = AllocatePool (sizeof (IGMP_GROUP)); + + if (Group == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + Mnp = IpSb->Mnp; + + Group->Address = IP4_ALLSYSTEM_ADDRESS; + Group->RefCnt = 1; + Group->DelayTime = 0; + Group->ReportByUs = FALSE; + + Status = Ip4GetMulticastMac (Mnp, IP4_ALLSYSTEM_ADDRESS, &Group->Mac); + + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + Status = Mnp->Groups (Mnp, TRUE, &Group->Mac); + + if (EFI_ERROR (Status) && (Status != EFI_ALREADY_STARTED)) { + goto ON_ERROR; + } + + InsertHeadList (&IgmpCtrl->Groups, &Group->Link); + return EFI_SUCCESS; + +ON_ERROR: + FreePool (Group); + return Status; +} + + +/** + Find the IGMP_GROUP structure which contains the status of multicast + group Address in this IGMP control block + + @param[in] IgmpCtrl The IGMP control block to search from. + @param[in] Address The multicast address to search. + + @return NULL if the multicast address isn't in the IGMP control block. Otherwise + the point to the IGMP_GROUP which contains the status of multicast group + for Address. + +**/ +IGMP_GROUP * +Ip4FindGroup ( + IN IGMP_SERVICE_DATA *IgmpCtrl, + IN IP4_ADDR Address + ) +{ + LIST_ENTRY *Entry; + IGMP_GROUP *Group; + + NET_LIST_FOR_EACH (Entry, &IgmpCtrl->Groups) { + Group = NET_LIST_USER_STRUCT (Entry, IGMP_GROUP, Link); + + if (Group->Address == Address) { + return Group; + } + } + + return NULL; +} + + +/** + Count the number of IP4 multicast groups that are mapped to the + same MAC address. Several IP4 multicast address may be mapped to + the same MAC address. + + @param[in] IgmpCtrl The IGMP control block to search in. + @param[in] Mac The MAC address to search. + + @return The number of the IP4 multicast group that mapped to the same + multicast group Mac. + +**/ +INTN +Ip4FindMac ( + IN IGMP_SERVICE_DATA *IgmpCtrl, + IN EFI_MAC_ADDRESS *Mac + ) +{ + LIST_ENTRY *Entry; + IGMP_GROUP *Group; + INTN Count; + + Count = 0; + + NET_LIST_FOR_EACH (Entry, &IgmpCtrl->Groups) { + Group = NET_LIST_USER_STRUCT (Entry, IGMP_GROUP, Link); + + if (NET_MAC_EQUAL (&Group->Mac, Mac, sizeof (EFI_MAC_ADDRESS))) { + Count++; + } + } + + return Count; +} + + +/** + Send an IGMP protocol message to the Dst, such as IGMP v1 membership report. + + @param[in] IpSb The IP4 service instance that requests the + transmission. + @param[in] Dst The destinaton to send to. + @param[in] Type The IGMP message type, such as IGMP v1 membership + report. + @param[in] Group The group address in the IGMP message head. + + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory to build the message. + @retval EFI_SUCCESS The IGMP message is successfully send. + @retval Others Failed to send the IGMP message. + +**/ +EFI_STATUS +Ip4SendIgmpMessage ( + IN IP4_SERVICE *IpSb, + IN IP4_ADDR Dst, + IN UINT8 Type, + IN IP4_ADDR Group + ) +{ + IP4_HEAD Head; + NET_BUF *Packet; + IGMP_HEAD *Igmp; + + // + // Allocate a net buffer to hold the message + // + Packet = NetbufAlloc (IP4_MAX_HEADLEN + sizeof (IGMP_HEAD)); + + if (Packet == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + // + // Fill in the IGMP and IP header, then transmit the message + // + NetbufReserve (Packet, IP4_MAX_HEADLEN); + + Igmp = (IGMP_HEAD *) NetbufAllocSpace (Packet, sizeof (IGMP_HEAD), FALSE); + if (Igmp == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + Igmp->Type = Type; + Igmp->MaxRespTime = 0; + Igmp->Checksum = 0; + Igmp->Group = HTONL (Group); + Igmp->Checksum = (UINT16) (~NetblockChecksum ((UINT8 *) Igmp, sizeof (IGMP_HEAD))); + + Head.Tos = 0; + Head.Protocol = IP4_PROTO_IGMP; + Head.Ttl = 1; + Head.Fragment = 0; + Head.Dst = Dst; + Head.Src = IP4_ALLZERO_ADDRESS; + + return Ip4Output ( + IpSb, + NULL, + Packet, + &Head, + (UINT8 *) &mRouteAlertOption, + sizeof (UINT32), + IP4_ALLZERO_ADDRESS, + Ip4SysPacketSent, + NULL + ); +} + + +/** + Send an IGMP membership report. Depends on whether the server is + v1 or v2, it will send either a V1 or V2 membership report. + + @param[in] IpSb The IP4 service instance that requests the + transmission. + @param[in] Group The group address to report. + + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory to build the message. + @retval EFI_SUCCESS The IGMP report message is successfully send. + @retval Others Failed to send the report. + +**/ +EFI_STATUS +Ip4SendIgmpReport ( + IN IP4_SERVICE *IpSb, + IN IP4_ADDR Group + ) +{ + if (IpSb->IgmpCtrl.Igmpv1QuerySeen != 0) { + return Ip4SendIgmpMessage (IpSb, Group, IGMP_V1_MEMBERSHIP_REPORT, Group); + } else { + return Ip4SendIgmpMessage (IpSb, Group, IGMP_V2_MEMBERSHIP_REPORT, Group); + } +} + + +/** + Join the multicast group on behalf of this IP4 child + + @param[in] IpInstance The IP4 child that wants to join the group. + @param[in] Address The group to join. + + @retval EFI_SUCCESS Successfully join the multicast group. + @retval EFI_OUT_OF_RESOURCES Failed to allocate resources. + @retval Others Failed to join the multicast group. + +**/ +EFI_STATUS +Ip4JoinGroup ( + IN IP4_PROTOCOL *IpInstance, + IN IP4_ADDR Address + ) +{ + EFI_MANAGED_NETWORK_PROTOCOL *Mnp; + IP4_SERVICE *IpSb; + IGMP_SERVICE_DATA *IgmpCtrl; + IGMP_GROUP *Group; + EFI_STATUS Status; + + IpSb = IpInstance->Service; + IgmpCtrl = &IpSb->IgmpCtrl; + Mnp = IpSb->Mnp; + + // + // If the IP service already is a member in the group, just + // increase the refernce count and return. + // + Group = Ip4FindGroup (IgmpCtrl, Address); + + if (Group != NULL) { + Group->RefCnt++; + return EFI_SUCCESS; + } + + // + // Otherwise, create a new IGMP_GROUP, Get the multicast's MAC address, + // send a report, then direct MNP to receive the multicast. + // + Group = AllocatePool (sizeof (IGMP_GROUP)); + + if (Group == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + Group->Address = Address; + Group->RefCnt = 1; + Group->DelayTime = IGMP_UNSOLICIATED_REPORT; + Group->ReportByUs = TRUE; + + Status = Ip4GetMulticastMac (Mnp, Address, &Group->Mac); + + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + Status = Ip4SendIgmpReport (IpSb, Address); + + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + Status = Mnp->Groups (Mnp, TRUE, &Group->Mac); + + if (EFI_ERROR (Status) && (Status != EFI_ALREADY_STARTED)) { + goto ON_ERROR; + } + + InsertHeadList (&IgmpCtrl->Groups, &Group->Link); + return EFI_SUCCESS; + +ON_ERROR: + FreePool (Group); + return Status; +} + + +/** + Leave the IP4 multicast group on behalf of IpInstance. + + @param[in] IpInstance The IP4 child that wants to leave the group + address. + @param[in] Address The group address to leave. + + @retval EFI_NOT_FOUND The IP4 service instance isn't in the group. + @retval EFI_SUCCESS Successfully leave the multicast group. + @retval Others Failed to leave the multicast group. + +**/ +EFI_STATUS +Ip4LeaveGroup ( + IN IP4_PROTOCOL *IpInstance, + IN IP4_ADDR Address + ) +{ + EFI_MANAGED_NETWORK_PROTOCOL *Mnp; + IP4_SERVICE *IpSb; + IGMP_SERVICE_DATA *IgmpCtrl; + IGMP_GROUP *Group; + EFI_STATUS Status; + + IpSb = IpInstance->Service; + IgmpCtrl = &IpSb->IgmpCtrl; + Mnp = IpSb->Mnp; + + Group = Ip4FindGroup (IgmpCtrl, Address); + + if (Group == NULL) { + return EFI_NOT_FOUND; + } + + // + // If more than one instance is in the group, decrease + // the RefCnt then return. + // + if (--Group->RefCnt > 0) { + return EFI_SUCCESS; + } + + // + // If multiple IP4 group addresses are mapped to the same + // multicast MAC address, don't configure the MNP to leave + // the MAC. + // + if (Ip4FindMac (IgmpCtrl, &Group->Mac) == 1) { + Status = Mnp->Groups (Mnp, FALSE, &Group->Mac); + + if (EFI_ERROR (Status) && (Status != EFI_NOT_FOUND)) { + return Status; + } + } + + // + // Send a leave report if the membership is reported by us + // and we are talking IGMPv2. + // + if (Group->ReportByUs && IgmpCtrl->Igmpv1QuerySeen == 0) { + Ip4SendIgmpMessage (IpSb, IP4_ALLROUTER_ADDRESS, IGMP_LEAVE_GROUP, Group->Address); + } + + RemoveEntryList (&Group->Link); + FreePool (Group); + + return EFI_SUCCESS; +} + + +/** + Handle the received IGMP message for the IP4 service instance. + + @param[in] IpSb The IP4 service instance that received the message. + @param[in] Head The IP4 header of the received message. + @param[in] Packet The IGMP message, without IP4 header. + + @retval EFI_INVALID_PARAMETER The IGMP message is malformated. + @retval EFI_SUCCESS The IGMP message is successfully processed. + +**/ +EFI_STATUS +Ip4IgmpHandle ( + IN IP4_SERVICE *IpSb, + IN IP4_HEAD *Head, + IN NET_BUF *Packet + ) +{ + IGMP_SERVICE_DATA *IgmpCtrl; + IGMP_HEAD Igmp; + IGMP_GROUP *Group; + IP4_ADDR Address; + LIST_ENTRY *Entry; + + IgmpCtrl = &IpSb->IgmpCtrl; + + // + // Must checksum over the whole packet, later IGMP version + // may employ message longer than 8 bytes. IP's header has + // already been trimmed off. + // + if ((Packet->TotalSize < sizeof (Igmp)) || (NetbufChecksum (Packet) != 0)) { + NetbufFree (Packet); + return EFI_INVALID_PARAMETER; + } + + // + // Copy the packet in case it is fragmented + // + NetbufCopy (Packet, 0, sizeof (IGMP_HEAD), (UINT8 *)&Igmp); + + switch (Igmp.Type) { + case IGMP_MEMBERSHIP_QUERY: + // + // If MaxRespTime is zero, it is most likely that we are + // talking to a V1 router + // + if (Igmp.MaxRespTime == 0) { + IgmpCtrl->Igmpv1QuerySeen = IGMP_V1ROUTER_PRESENT; + Igmp.MaxRespTime = 100; + } + + // + // Igmp is ticking once per second but MaxRespTime is in + // the unit of 100ms. + // + Igmp.MaxRespTime /= 10; + Address = NTOHL (Igmp.Group); + + if (Address == IP4_ALLSYSTEM_ADDRESS) { + break; + } + + NET_LIST_FOR_EACH (Entry, &IgmpCtrl->Groups) { + Group = NET_LIST_USER_STRUCT (Entry, IGMP_GROUP, Link); + + // + // If address is all zero, all the memberships will be reported. + // otherwise only one is reported. + // + if ((Address == IP4_ALLZERO_ADDRESS) || (Address == Group->Address)) { + // + // If the timer is pending, only update it if the time left + // is longer than the MaxRespTime. TODO: randomize the DelayTime. + // + if ((Group->DelayTime == 0) || (Group->DelayTime > Igmp.MaxRespTime)) { + Group->DelayTime = MAX (1, Igmp.MaxRespTime); + } + } + } + + break; + + case IGMP_V1_MEMBERSHIP_REPORT: + case IGMP_V2_MEMBERSHIP_REPORT: + Address = NTOHL (Igmp.Group); + Group = Ip4FindGroup (IgmpCtrl, Address); + + if ((Group != NULL) && (Group->DelayTime > 0)) { + Group->DelayTime = 0; + Group->ReportByUs = FALSE; + } + + break; + } + + NetbufFree (Packet); + return EFI_SUCCESS; +} + + +/** + The periodical timer function for IGMP. It does the following + things: + 1. Decrease the Igmpv1QuerySeen to make it possible to refresh + the IGMP server type. + 2. Decrease the report timer for each IGMP group in "delaying + member" state. + + @param[in] IpSb The IP4 service instance that is ticking. + +**/ +VOID +Ip4IgmpTicking ( + IN IP4_SERVICE *IpSb + ) +{ + IGMP_SERVICE_DATA *IgmpCtrl; + LIST_ENTRY *Entry; + IGMP_GROUP *Group; + + IgmpCtrl = &IpSb->IgmpCtrl; + + if (IgmpCtrl->Igmpv1QuerySeen > 0) { + IgmpCtrl->Igmpv1QuerySeen--; + } + + // + // Decrease the report timer for each IGMP group in "delaying member" + // + NET_LIST_FOR_EACH (Entry, &IgmpCtrl->Groups) { + Group = NET_LIST_USER_STRUCT (Entry, IGMP_GROUP, Link); + ASSERT (Group->DelayTime >= 0); + + if (Group->DelayTime > 0) { + Group->DelayTime--; + + if (Group->DelayTime == 0) { + Ip4SendIgmpReport (IpSb, Group->Address); + Group->ReportByUs = TRUE; + } + } + } +} + + +/** + Add a group address to the array of group addresses. + The caller should make sure that no duplicated address + existed in the array. Although the function doesn't + assume the byte order of the both Source and Addr, the + network byte order is used by the caller. + + @param[in] Source The array of group addresses to add to. + @param[in] Count The number of group addresses in the Source. + @param[in] Addr The IP4 multicast address to add. + + @return NULL if failed to allocate memory for the new groups, + otherwise the new combined group addresses. + +**/ +IP4_ADDR * +Ip4CombineGroups ( + IN IP4_ADDR *Source, + IN UINT32 Count, + IN IP4_ADDR Addr + ) +{ + IP4_ADDR *Groups; + + Groups = AllocatePool (sizeof (IP4_ADDR) * (Count + 1)); + + if (Groups == NULL) { + return NULL; + } + + CopyMem (Groups, Source, Count * sizeof (IP4_ADDR)); + Groups[Count] = Addr; + + return Groups; +} + + +/** + Remove a group address from the array of group addresses. + Although the function doesn't assume the byte order of the + both Groups and Addr, the network byte order is used by + the caller. + + @param Groups The array of group addresses to remove from. + @param Count The number of group addresses in the Groups. + @param Addr The IP4 multicast address to remove. + + @return The nubmer of group addresses in the Groups after remove. + It is Count if the Addr isn't in the Groups. + +**/ +INTN +Ip4RemoveGroupAddr ( + IN OUT IP4_ADDR *Groups, + IN UINT32 Count, + IN IP4_ADDR Addr + ) +{ + UINT32 Index; + + for (Index = 0; Index < Count; Index++) { + if (Groups[Index] == Addr) { + break; + } + } + + while (Index < Count - 1) { + Groups[Index] = Groups[Index + 1]; + Index++; + } + + return Index; +} diff --git a/NetworkPkg/Ip4Dxe/Ip4Igmp.h b/NetworkPkg/Ip4Dxe/Ip4Igmp.h new file mode 100644 index 0000000000..0cc9445944 --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4Igmp.h @@ -0,0 +1,201 @@ +/** @file + +Copyright (c) 2005 - 2015, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef __EFI_IP4_IGMP_H__ +#define __EFI_IP4_IGMP_H__ + +// +// IGMP message type +// +#define IGMP_MEMBERSHIP_QUERY 0x11 +#define IGMP_V1_MEMBERSHIP_REPORT 0x12 +#define IGMP_V2_MEMBERSHIP_REPORT 0x16 +#define IGMP_LEAVE_GROUP 0x17 + +#define IGMP_V1ROUTER_PRESENT 400 +#define IGMP_UNSOLICIATED_REPORT 10 + +#pragma pack(1) +typedef struct { + UINT8 Type; + UINT8 MaxRespTime; + UINT16 Checksum; + IP4_ADDR Group; +} IGMP_HEAD; +#pragma pack() + +/// +/// The status of multicast group. It isn't necessary to maintain +/// explicit state of host state diagram. A group with non-zero +/// DelayTime is in "delaying member" state. otherwise, it is in +/// "idle member" state. +/// +typedef struct { + LIST_ENTRY Link; + INTN RefCnt; + IP4_ADDR Address; + INTN DelayTime; + BOOLEAN ReportByUs; + EFI_MAC_ADDRESS Mac; +} IGMP_GROUP; + +/// +/// The IGMP status. Each IP4 service instance has a IGMP_SERVICE_DATA +/// attached. The Igmpv1QuerySeen remember whether the server on this +/// connected network is v1 or v2. +/// +typedef struct { + INTN Igmpv1QuerySeen; + LIST_ENTRY Groups; +} IGMP_SERVICE_DATA; + +/** + Init the IGMP control data of the IP4 service instance, configure + MNP to receive ALL SYSTEM multicast. + + @param[in, out] IpSb The IP4 service whose IGMP is to be initialized. + + @retval EFI_SUCCESS IGMP of the IpSb is successfully initialized. + @retval EFI_OUT_OF_RESOURCES Failed to allocate resource to initialize IGMP. + @retval Others Failed to initialize the IGMP of IpSb. + +**/ +EFI_STATUS +Ip4InitIgmp ( + IN OUT IP4_SERVICE *IpSb + ); + +/** + Join the multicast group on behalf of this IP4 child + + @param[in] IpInstance The IP4 child that wants to join the group. + @param[in] Address The group to join. + + @retval EFI_SUCCESS Successfully join the multicast group. + @retval EFI_OUT_OF_RESOURCES Failed to allocate resources. + @retval Others Failed to join the multicast group. + +**/ +EFI_STATUS +Ip4JoinGroup ( + IN IP4_PROTOCOL *IpInstance, + IN IP4_ADDR Address + ); + +/** + Leave the IP4 multicast group on behalf of IpInstance. + + @param[in] IpInstance The IP4 child that wants to leave the group + address. + @param[in] Address The group address to leave. + + @retval EFI_NOT_FOUND The IP4 service instance isn't in the group. + @retval EFI_SUCCESS Successfully leave the multicast group. + @retval Others Failed to leave the multicast group. + +**/ +EFI_STATUS +Ip4LeaveGroup ( + IN IP4_PROTOCOL *IpInstance, + IN IP4_ADDR Address + ); + +/** + Handle the received IGMP message for the IP4 service instance. + + @param[in] IpSb The IP4 service instance that received the message. + @param[in] Head The IP4 header of the received message. + @param[in] Packet The IGMP message, without IP4 header. + + @retval EFI_INVALID_PARAMETER The IGMP message is malformated. + @retval EFI_SUCCESS The IGMP message is successfully processed. + +**/ +EFI_STATUS +Ip4IgmpHandle ( + IN IP4_SERVICE *IpSb, + IN IP4_HEAD *Head, + IN NET_BUF *Packet + ); + +/** + The periodical timer function for IGMP. It does the following + things: + 1. Decrease the Igmpv1QuerySeen to make it possible to refresh + the IGMP server type. + 2. Decrease the report timer for each IGMP group in "delaying + member" state. + + @param[in] IpSb The IP4 service instance that is ticking. + +**/ +VOID +Ip4IgmpTicking ( + IN IP4_SERVICE *IpSb + ); + +/** + Add a group address to the array of group addresses. + The caller should make sure that no duplicated address + existed in the array. Although the function doesn't + assume the byte order of the both Source and Addr, the + network byte order is used by the caller. + + @param[in] Source The array of group addresses to add to. + @param[in] Count The number of group addresses in the Source. + @param[in] Addr The IP4 multicast address to add. + + @return NULL if failed to allocate memory for the new groups, + otherwise the new combined group addresses. + +**/ +IP4_ADDR * +Ip4CombineGroups ( + IN IP4_ADDR *Source, + IN UINT32 Count, + IN IP4_ADDR Addr + ); + +/** + Remove a group address from the array of group addresses. + Although the function doesn't assume the byte order of the + both Groups and Addr, the network byte order is used by + the caller. + + @param Groups The array of group addresses to remove from. + @param Count The number of group addresses in the Groups. + @param Addr The IP4 multicast address to remove. + + @return The nubmer of group addresses in the Groups after remove. + It is Count if the Addr isn't in the Groups. + +**/ +INTN +Ip4RemoveGroupAddr ( + IN OUT IP4_ADDR *Groups, + IN UINT32 Count, + IN IP4_ADDR Addr + ); + +/** + Find the IGMP_GROUP structure which contains the status of multicast + group Address in this IGMP control block + + @param[in] IgmpCtrl The IGMP control block to search from. + @param[in] Address The multicast address to search. + + @return NULL if the multicast address isn't in the IGMP control block. Otherwise + the point to the IGMP_GROUP which contains the status of multicast group + for Address. + +**/ +IGMP_GROUP * +Ip4FindGroup ( + IN IGMP_SERVICE_DATA *IgmpCtrl, + IN IP4_ADDR Address + ); +#endif diff --git a/NetworkPkg/Ip4Dxe/Ip4Impl.c b/NetworkPkg/Ip4Dxe/Ip4Impl.c new file mode 100644 index 0000000000..ec6f037077 --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4Impl.c @@ -0,0 +1,2330 @@ +/** @file + +Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Ip4Impl.h" + +EFI_IPSEC2_PROTOCOL *mIpSec = NULL; + +/** + Gets the current operational settings for this instance of the EFI IPv4 Protocol driver. + + The GetModeData() function returns the current operational mode data for this + driver instance. The data fields in EFI_IP4_MODE_DATA are read only. This + function is used optionally to retrieve the operational mode data of underlying + networks or drivers. + + @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. + @param[out] Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure. + @param[out] MnpConfigData Pointer to the managed network configuration data structure. + @param[out] SnpModeData Pointer to the simple network mode data structure. + + @retval EFI_SUCCESS The operation completed successfully. + @retval EFI_INVALID_PARAMETER This is NULL. + @retval EFI_OUT_OF_RESOURCES The required mode data could not be allocated. + +**/ +EFI_STATUS +EFIAPI +EfiIp4GetModeData ( + IN CONST EFI_IP4_PROTOCOL *This, + OUT EFI_IP4_MODE_DATA *Ip4ModeData OPTIONAL, + OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL, + OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL + ); + +/** + Assigns an IPv4 address and subnet mask to this EFI IPv4 Protocol driver instance. + + The Configure() function is used to set, change, or reset the operational + parameters and filter settings for this EFI IPv4 Protocol instance. Until these + parameters have been set, no network traffic can be sent or received by this + instance. Once the parameters have been reset (by calling this function with + IpConfigData set to NULL), no more traffic can be sent or received until these + parameters have been set again. Each EFI IPv4 Protocol instance can be started + and stopped independently of each other by enabling or disabling their receive + filter settings with the Configure() function. + + When IpConfigData.UseDefaultAddress is set to FALSE, the new station address will + be appended as an alias address into the addresses list in the EFI IPv4 Protocol + driver. While set to TRUE, Configure() will trigger the EFI_IP4_CONFIG_PROTOCOL + to retrieve the default IPv4 address if it is not available yet. Clients could + frequently call GetModeData() to check the status to ensure that the default IPv4 + address is ready. + + If operational parameters are reset or changed, any pending transmit and receive + requests will be cancelled. Their completion token status will be set to EFI_ABORTED + and their events will be signaled. + + @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. + @param[in] IpConfigData Pointer to the EFI IPv4 Protocol configuration data structure. + + @retval EFI_SUCCESS The driver instance was successfully opened. + @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, + RARP, etc.) is not finished yet. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + @retval EFI_UNSUPPORTED One or more of the following conditions is TRUE: + A configuration protocol (DHCP, BOOTP, RARP, etc.) could + not be located when clients choose to use the default IPv4 + address. This EFI IPv4 Protocol implementation does not + support this requested filter or timeout setting. + @retval EFI_OUT_OF_RESOURCES The EFI IPv4 Protocol driver instance data could not be allocated. + @retval EFI_ALREADY_STARTED The interface is already open and must be stopped before the + IPv4 address or subnet mask can be changed. The interface must + also be stopped when switching to/from raw packet mode. + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI IPv4 + Protocol driver instance is not opened. + +**/ +EFI_STATUS +EFIAPI +EfiIp4Configure ( + IN EFI_IP4_PROTOCOL *This, + IN EFI_IP4_CONFIG_DATA *IpConfigData OPTIONAL + ); + +/** + Joins and leaves multicast groups. + + The Groups() function is used to join and leave multicast group sessions. Joining + a group will enable reception of matching multicast packets. Leaving a group will + disable the multicast packet reception. + + If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left. + + @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. + @param[in] JoinFlag Set to TRUE to join the multicast group session and FALSE to leave. + @param[in] GroupAddress Pointer to the IPv4 multicast address. + + @retval EFI_SUCCESS The operation completed successfully. + @retval EFI_INVALID_PARAMETER One or more of the following is TRUE: + - This is NULL. + - JoinFlag is TRUE and GroupAddress is NULL. + - GroupAddress is not NULL and *GroupAddress is + not a multicast IPv4 address. + @retval EFI_NOT_STARTED This instance has not been started. + @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, + RARP, etc.) is not finished yet. + @retval EFI_OUT_OF_RESOURCES System resources could not be allocated. + @retval EFI_UNSUPPORTED This EFI IPv4 Protocol implementation does not support multicast groups. + @retval EFI_ALREADY_STARTED The group address is already in the group table (when + JoinFlag is TRUE). + @retval EFI_NOT_FOUND The group address is not in the group table (when JoinFlag is FALSE). + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. + +**/ +EFI_STATUS +EFIAPI +EfiIp4Groups ( + IN EFI_IP4_PROTOCOL *This, + IN BOOLEAN JoinFlag, + IN EFI_IPv4_ADDRESS *GroupAddress OPTIONAL + ); + +/** + Adds and deletes routing table entries. + + The Routes() function adds a route to or deletes a route from the routing table. + + Routes are determined by comparing the SubnetAddress with the destination IPv4 + address arithmetically AND-ed with the SubnetMask. The gateway address must be + on the same subnet as the configured station address. + + The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0. + The default route matches all destination IPv4 addresses that do not match any + other routes. + + A GatewayAddress that is zero is a nonroute. Packets are sent to the destination + IP address if it can be found in the ARP cache or on the local subnet. One automatic + nonroute entry will be inserted into the routing table for outgoing packets that + are addressed to a local subnet (gateway address of 0.0.0.0). + + Each EFI IPv4 Protocol instance has its own independent routing table. Those EFI + IPv4 Protocol instances that use the default IPv4 address will also have copies + of the routing table that was provided by the EFI_IP4_CONFIG_PROTOCOL, and these + copies will be updated whenever the EIF IPv4 Protocol driver reconfigures its + instances. As a result, client modification to the routing table will be lost. + + @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. + @param[in] DeleteRoute Set to TRUE to delete this route from the routing table. Set to + FALSE to add this route to the routing table. SubnetAddress + and SubnetMask are used as the key to each route entry. + @param[in] SubnetAddress The address of the subnet that needs to be routed. + @param[in] SubnetMask The subnet mask of SubnetAddress. + @param[in] GatewayAddress The unicast gateway IPv4 address for this route. + + @retval EFI_SUCCESS The operation completed successfully. + @retval EFI_NOT_STARTED The driver instance has not been started. + @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, + RARP, etc.) is not finished yet. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + - This is NULL. + - SubnetAddress is NULL. + - SubnetMask is NULL. + - GatewayAddress is NULL. + - *SubnetAddress is not a valid subnet address. + - *SubnetMask is not a valid subnet mask. + - *GatewayAddress is not a valid unicast IPv4 address. + @retval EFI_OUT_OF_RESOURCES Could not add the entry to the routing table. + @retval EFI_NOT_FOUND This route is not in the routing table (when DeleteRoute is TRUE). + @retval EFI_ACCESS_DENIED The route is already defined in the routing table (when + DeleteRoute is FALSE). + +**/ +EFI_STATUS +EFIAPI +EfiIp4Routes ( + IN EFI_IP4_PROTOCOL *This, + IN BOOLEAN DeleteRoute, + IN EFI_IPv4_ADDRESS *SubnetAddress, + IN EFI_IPv4_ADDRESS *SubnetMask, + IN EFI_IPv4_ADDRESS *GatewayAddress + ); + +/** + Places outgoing data packets into the transmit queue. + + The Transmit() function places a sending request in the transmit queue of this + EFI IPv4 Protocol instance. Whenever the packet in the token is sent out or some + errors occur, the event in the token will be signaled and the status is updated. + + @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. + @param[in] Token Pointer to the transmit token. + + @retval EFI_SUCCESS The data has been queued for transmission. + @retval EFI_NOT_STARTED This instance has not been started. + @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, + RARP, etc.) is not finished yet. + @retval EFI_INVALID_PARAMETER One or more pameters are invalid. + @retval EFI_ACCESS_DENIED The transmit completion token with the same Token.Event + was already in the transmit queue. + @retval EFI_NOT_READY The completion token could not be queued because the transmit + queue is full. + @retval EFI_NOT_FOUND Not route is found to destination address. + @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data. + @retval EFI_BUFFER_TOO_SMALL Token.Packet.TxData.TotalDataLength is too + short to transmit. + @retval EFI_BAD_BUFFER_SIZE The length of the IPv4 header + option length + total data length is + greater than MTU (or greater than the maximum packet size if + Token.Packet.TxData.OverrideData. + DoNotFragment is TRUE.) + +**/ +EFI_STATUS +EFIAPI +EfiIp4Transmit ( + IN EFI_IP4_PROTOCOL *This, + IN EFI_IP4_COMPLETION_TOKEN *Token + ); + +/** + Places a receiving request into the receiving queue. + + The Receive() function places a completion token into the receive packet queue. + This function is always asynchronous. + + The Token.Event field in the completion token must be filled in by the caller + and cannot be NULL. When the receive operation completes, the EFI IPv4 Protocol + driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event + is signaled. + + @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. + @param[in] Token Pointer to a token that is associated with the receive data descriptor. + + @retval EFI_SUCCESS The receive completion token was cached. + @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started. + @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, RARP, etc.) + is not finished yet. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + - This is NULL. + - Token is NULL. + - Token.Event is NULL. + @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system + resources (usually memory). + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. + The EFI IPv4 Protocol instance has been reset to startup defaults. + EFI_ACCESS_DENIED The receive completion token with the same Token.Event was already + in the receive queue. + @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full. + @retval EFI_ICMP_ERROR An ICMP error packet was received. + +**/ +EFI_STATUS +EFIAPI +EfiIp4Receive ( + IN EFI_IP4_PROTOCOL *This, + IN EFI_IP4_COMPLETION_TOKEN *Token + ); + +/** + Abort an asynchronous transmit or receive request. + + The Cancel() function is used to abort a pending transmit or receive request. + If the token is in the transmit or receive request queues, after calling this + function, Token->Status will be set to EFI_ABORTED and then Token->Event will + be signaled. If the token is not in one of the queues, which usually means the + asynchronous operation has completed, this function will not signal the token + and EFI_NOT_FOUND is returned. + + @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. + @param[in] Token Pointer to a token that has been issued by + EFI_IP4_PROTOCOL.Transmit() or + EFI_IP4_PROTOCOL.Receive(). If NULL, all pending + tokens are aborted. Type EFI_IP4_COMPLETION_TOKEN is + defined in EFI_IP4_PROTOCOL.Transmit(). + + @retval EFI_SUCCESS The asynchronous I/O request was aborted and + Token.->Event was signaled. When Token is NULL, all + pending requests were aborted and their events were signaled. + @retval EFI_INVALID_PARAMETER This is NULL. + @retval EFI_NOT_STARTED This instance has not been started. + @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, + RARP, etc.) is not finished yet. + @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O request was + not found in the transmit or receive queue. It has either completed + or was not issued by Transmit() and Receive(). + +**/ +EFI_STATUS +EFIAPI +EfiIp4Cancel ( + IN EFI_IP4_PROTOCOL *This, + IN EFI_IP4_COMPLETION_TOKEN *Token OPTIONAL + ); + +/** + Polls for incoming data packets and processes outgoing data packets. + + The Poll() function polls for incoming data packets and processes outgoing data + packets. Network drivers and applications can call the EFI_IP4_PROTOCOL.Poll() + function to increase the rate that data packets are moved between the communications + device and the transmit and receive queues. + + In some systems the periodic timer event may not poll the underlying communications + device fast enough to transmit and/or receive all data packets without missing + incoming packets or dropping outgoing packets. Drivers and applications that are + experiencing packet loss should try calling the EFI_IP4_PROTOCOL.Poll() function + more often. + + @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. + + @retval EFI_SUCCESS Incoming or outgoing data was processed. + @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started. + @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, + RARP, etc.) is not finished yet. + @retval EFI_INVALID_PARAMETER This is NULL. + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. + @retval EFI_NOT_READY No incoming or outgoing data is processed. + @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue. + Consider increasing the polling rate. + +**/ +EFI_STATUS +EFIAPI +EfiIp4Poll ( + IN EFI_IP4_PROTOCOL *This + ); + +EFI_IP4_PROTOCOL +mEfiIp4ProtocolTemplete = { + EfiIp4GetModeData, + EfiIp4Configure, + EfiIp4Groups, + EfiIp4Routes, + EfiIp4Transmit, + EfiIp4Receive, + EfiIp4Cancel, + EfiIp4Poll +}; + +/** + Gets the current operational settings for this instance of the EFI IPv4 Protocol driver. + + The GetModeData() function returns the current operational mode data for this + driver instance. The data fields in EFI_IP4_MODE_DATA are read only. This + function is used optionally to retrieve the operational mode data of underlying + networks or drivers. + + @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. + @param[out] Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure. + @param[out] MnpConfigData Pointer to the managed network configuration data structure. + @param[out] SnpModeData Pointer to the simple network mode data structure. + + @retval EFI_SUCCESS The operation completed successfully. + @retval EFI_INVALID_PARAMETER This is NULL. + @retval EFI_OUT_OF_RESOURCES The required mode data could not be allocated. + +**/ +EFI_STATUS +EFIAPI +EfiIp4GetModeData ( + IN CONST EFI_IP4_PROTOCOL *This, + OUT EFI_IP4_MODE_DATA *Ip4ModeData OPTIONAL, + OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL, + OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL + ) +{ + IP4_PROTOCOL *IpInstance; + IP4_SERVICE *IpSb; + EFI_IP4_CONFIG_DATA *Config; + EFI_STATUS Status; + EFI_TPL OldTpl; + IP4_ADDR Ip; + + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This); + IpSb = IpInstance->Service; + + if (Ip4ModeData != NULL) { + // + // IsStarted is "whether the EfiIp4Configure has been called". + // IsConfigured is "whether the station address has been configured" + // + Ip4ModeData->IsStarted = (BOOLEAN)(IpInstance->State == IP4_STATE_CONFIGED); + CopyMem (&Ip4ModeData->ConfigData, &IpInstance->ConfigData, sizeof (Ip4ModeData->ConfigData)); + Ip4ModeData->IsConfigured = FALSE; + + Ip4ModeData->GroupCount = IpInstance->GroupCount; + Ip4ModeData->GroupTable = (EFI_IPv4_ADDRESS *) IpInstance->Groups; + + Ip4ModeData->IcmpTypeCount = 23; + Ip4ModeData->IcmpTypeList = mIp4SupportedIcmp; + + Ip4ModeData->RouteTable = NULL; + Ip4ModeData->RouteCount = 0; + + Ip4ModeData->MaxPacketSize = IpSb->MaxPacketSize; + + // + // return the current station address for this IP child. So, + // the user can get the default address through this. Some + // application wants to know it station address even it is + // using the default one, such as a ftp server. + // + if (Ip4ModeData->IsStarted) { + Config = &Ip4ModeData->ConfigData; + + Ip = HTONL (IpInstance->Interface->Ip); + CopyMem (&Config->StationAddress, &Ip, sizeof (EFI_IPv4_ADDRESS)); + + Ip = HTONL (IpInstance->Interface->SubnetMask); + CopyMem (&Config->SubnetMask, &Ip, sizeof (EFI_IPv4_ADDRESS)); + + Ip4ModeData->IsConfigured = IpInstance->Interface->Configured; + + // + // Build a EFI route table for user from the internal route table. + // + Status = Ip4BuildEfiRouteTable (IpInstance); + + if (EFI_ERROR (Status)) { + gBS->RestoreTPL (OldTpl); + return Status; + } + + Ip4ModeData->RouteTable = IpInstance->EfiRouteTable; + Ip4ModeData->RouteCount = IpInstance->EfiRouteCount; + } + } + + // + // Get fresh mode data from MNP, since underlying media status may change + // + Status = IpSb->Mnp->GetModeData (IpSb->Mnp, MnpConfigData, SnpModeData); + + gBS->RestoreTPL (OldTpl); + return Status; +} + + +/** + Config the MNP parameter used by IP. The IP driver use one MNP + child to transmit/receive frames. By default, it configures MNP + to receive unicast/multicast/broadcast. And it will enable/disable + the promiscous receive according to whether there is IP child + enable that or not. If Force is FALSE, it will iterate through + all the IP children to check whether the promiscuous receive + setting has been changed. If it hasn't been changed, it won't + reconfigure the MNP. If Force is TRUE, the MNP is configured no + matter whether that is changed or not. + + @param[in] IpSb The IP4 service instance that is to be changed. + @param[in] Force Force the configuration or not. + + @retval EFI_SUCCESS The MNP is successfully configured/reconfigured. + @retval Others Configuration failed. + +**/ +EFI_STATUS +Ip4ServiceConfigMnp ( + IN IP4_SERVICE *IpSb, + IN BOOLEAN Force + ) +{ + LIST_ENTRY *Entry; + LIST_ENTRY *ProtoEntry; + IP4_INTERFACE *IpIf; + IP4_PROTOCOL *IpInstance; + BOOLEAN Reconfig; + BOOLEAN PromiscReceive; + EFI_STATUS Status; + + Reconfig = FALSE; + PromiscReceive = FALSE; + + if (!Force) { + // + // Iterate through the IP children to check whether promiscuous + // receive setting has been changed. Update the interface's receive + // filter also. + // + NET_LIST_FOR_EACH (Entry, &IpSb->Interfaces) { + + IpIf = NET_LIST_USER_STRUCT (Entry, IP4_INTERFACE, Link); + IpIf->PromiscRecv = FALSE; + + NET_LIST_FOR_EACH (ProtoEntry, &IpIf->IpInstances) { + IpInstance = NET_LIST_USER_STRUCT (ProtoEntry, IP4_PROTOCOL, AddrLink); + + if (IpInstance->ConfigData.AcceptPromiscuous) { + IpIf->PromiscRecv = TRUE; + PromiscReceive = TRUE; + } + } + } + + // + // If promiscuous receive isn't changed, it isn't necessary to reconfigure. + // + if (PromiscReceive == IpSb->MnpConfigData.EnablePromiscuousReceive) { + return EFI_SUCCESS; + } + + Reconfig = TRUE; + IpSb->MnpConfigData.EnablePromiscuousReceive = PromiscReceive; + } + + Status = IpSb->Mnp->Configure (IpSb->Mnp, &IpSb->MnpConfigData); + + // + // recover the original configuration if failed to set the configure. + // + if (EFI_ERROR (Status) && Reconfig) { + IpSb->MnpConfigData.EnablePromiscuousReceive = (BOOLEAN) !PromiscReceive; + } + + return Status; +} + + +/** + Intiialize the IP4_PROTOCOL structure to the unconfigured states. + + @param IpSb The IP4 service instance. + @param IpInstance The IP4 child instance. + +**/ +VOID +Ip4InitProtocol ( + IN IP4_SERVICE *IpSb, + IN OUT IP4_PROTOCOL *IpInstance + ) +{ + ASSERT ((IpSb != NULL) && (IpInstance != NULL)); + + ZeroMem (IpInstance, sizeof (IP4_PROTOCOL)); + + IpInstance->Signature = IP4_PROTOCOL_SIGNATURE; + CopyMem (&IpInstance->Ip4Proto, &mEfiIp4ProtocolTemplete, sizeof (IpInstance->Ip4Proto)); + IpInstance->State = IP4_STATE_UNCONFIGED; + IpInstance->InDestroy = FALSE; + IpInstance->Service = IpSb; + + InitializeListHead (&IpInstance->Link); + NetMapInit (&IpInstance->RxTokens); + NetMapInit (&IpInstance->TxTokens); + InitializeListHead (&IpInstance->Received); + InitializeListHead (&IpInstance->Delivered); + InitializeListHead (&IpInstance->AddrLink); + + EfiInitializeLock (&IpInstance->RecycleLock, TPL_NOTIFY); +} + + +/** + Configure the IP4 child. If the child is already configured, + change the configuration parameter. Otherwise configure it + for the first time. The caller should validate the configuration + before deliver them to it. It also don't do configure NULL. + + @param[in, out] IpInstance The IP4 child to configure. + @param[in] Config The configure data. + + @retval EFI_SUCCESS The IP4 child is successfully configured. + @retval EFI_DEVICE_ERROR Failed to free the pending transive or to + configure underlying MNP or other errors. + @retval EFI_NO_MAPPING The IP4 child is configured to use default + address, but the default address hasn't been + configured. The IP4 child doesn't need to be + reconfigured when default address is configured. + @retval EFI_OUT_OF_RESOURCES No more memory space is available. + @retval other Other error occurs. + +**/ +EFI_STATUS +Ip4ConfigProtocol ( + IN OUT IP4_PROTOCOL *IpInstance, + IN EFI_IP4_CONFIG_DATA *Config + ) +{ + IP4_SERVICE *IpSb; + IP4_INTERFACE *IpIf; + EFI_STATUS Status; + IP4_ADDR Ip; + IP4_ADDR Netmask; + EFI_ARP_PROTOCOL *Arp; + EFI_IP4_CONFIG2_PROTOCOL *Ip4Config2; + EFI_IP4_CONFIG2_POLICY Policy; + + IpSb = IpInstance->Service; + + Ip4Config2 = NULL; + + // + // User is changing packet filters. It must be stopped + // before the station address can be changed. + // + if (IpInstance->State == IP4_STATE_CONFIGED) { + // + // Cancel all the pending transmit/receive from upper layer + // + Status = Ip4Cancel (IpInstance, NULL); + + if (EFI_ERROR (Status)) { + return EFI_DEVICE_ERROR; + } + + CopyMem (&IpInstance->ConfigData, Config, sizeof (IpInstance->ConfigData)); + return EFI_SUCCESS; + } + + // + // Configure a fresh IP4 protocol instance. Create a route table. + // Each IP child has its own route table, which may point to the + // default table if it is using default address. + // + Status = EFI_OUT_OF_RESOURCES; + IpInstance->RouteTable = Ip4CreateRouteTable (); + + if (IpInstance->RouteTable == NULL) { + return Status; + } + + // + // Set up the interface. + // + CopyMem (&Ip, &Config->StationAddress, sizeof (IP4_ADDR)); + CopyMem (&Netmask, &Config->SubnetMask, sizeof (IP4_ADDR)); + + Ip = NTOHL (Ip); + Netmask = NTOHL (Netmask); + + if (!Config->UseDefaultAddress) { + // + // Find whether there is already an interface with the same + // station address. All the instances with the same station + // address shares one interface. + // + IpIf = Ip4FindStationAddress (IpSb, Ip, Netmask); + + if (IpIf != NULL) { + NET_GET_REF (IpIf); + + } else { + IpIf = Ip4CreateInterface (IpSb->Mnp, IpSb->Controller, IpSb->Image); + + if (IpIf == NULL) { + goto ON_ERROR; + } + + Status = Ip4SetAddress (IpIf, Ip, Netmask); + + if (EFI_ERROR (Status)) { + Status = EFI_DEVICE_ERROR; + Ip4FreeInterface (IpIf, IpInstance); + goto ON_ERROR; + } + + InsertTailList (&IpSb->Interfaces, &IpIf->Link); + } + + // + // Add a route to this connected network in the instance route table. + // + Ip4AddRoute ( + IpInstance->RouteTable, + Ip & Netmask, + Netmask, + IP4_ALLZERO_ADDRESS + ); + } else { + // + // Use the default address. Check the state. + // + if (IpSb->State == IP4_SERVICE_UNSTARTED) { + // + // Trigger the EFI_IP4_CONFIG2_PROTOCOL to retrieve the + // default IPv4 address if it is not available yet. + // + Policy = IpSb->Ip4Config2Instance.Policy; + if (Policy != Ip4Config2PolicyDhcp) { + Ip4Config2 = &IpSb->Ip4Config2Instance.Ip4Config2; + Policy = Ip4Config2PolicyDhcp; + Status= Ip4Config2->SetData ( + Ip4Config2, + Ip4Config2DataTypePolicy, + sizeof (EFI_IP4_CONFIG2_POLICY), + &Policy + ); + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + } + } + + IpIf = IpSb->DefaultInterface; + NET_GET_REF (IpSb->DefaultInterface); + + // + // If default address is used, so is the default route table. + // Any route set by the instance has the precedence over the + // routes in the default route table. Link the default table + // after the instance's table. Routing will search the local + // table first. + // + NET_GET_REF (IpSb->DefaultRouteTable); + IpInstance->RouteTable->Next = IpSb->DefaultRouteTable; + } + + IpInstance->Interface = IpIf; + if (IpIf->Arp != NULL) { + Arp = NULL; + Status = gBS->OpenProtocol ( + IpIf->ArpHandle, + &gEfiArpProtocolGuid, + (VOID **) &Arp, + gIp4DriverBinding.DriverBindingHandle, + IpInstance->Handle, + EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER + ); + if (EFI_ERROR (Status)) { + Ip4FreeInterface (IpIf, IpInstance); + goto ON_ERROR; + } + } + InsertTailList (&IpIf->IpInstances, &IpInstance->AddrLink); + + CopyMem (&IpInstance->ConfigData, Config, sizeof (IpInstance->ConfigData)); + IpInstance->State = IP4_STATE_CONFIGED; + + // + // Although EFI_NO_MAPPING is an error code, the IP child has been + // successfully configured and doesn't need reconfiguration when + // default address is acquired. + // + if (Config->UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) { + return EFI_NO_MAPPING; + } + + return EFI_SUCCESS; + +ON_ERROR: + Ip4FreeRouteTable (IpInstance->RouteTable); + IpInstance->RouteTable = NULL; + return Status; +} + + +/** + Clean up the IP4 child, release all the resources used by it. + + @param[in] IpInstance The IP4 child to clean up. + + @retval EFI_SUCCESS The IP4 child is cleaned up. + @retval EFI_DEVICE_ERROR Some resources failed to be released. + +**/ +EFI_STATUS +Ip4CleanProtocol ( + IN IP4_PROTOCOL *IpInstance + ) +{ + if (EFI_ERROR (Ip4Cancel (IpInstance, NULL))) { + return EFI_DEVICE_ERROR; + } + + if (EFI_ERROR (Ip4Groups (IpInstance, FALSE, NULL))) { + return EFI_DEVICE_ERROR; + } + + // + // Some packets haven't been recycled. It is because either the + // user forgets to recycle the packets, or because the callback + // hasn't been called. Just leave it alone. + // + if (!IsListEmpty (&IpInstance->Delivered)) { + ; + } + + if (IpInstance->Interface != NULL) { + RemoveEntryList (&IpInstance->AddrLink); + if (IpInstance->Interface->Arp != NULL) { + gBS->CloseProtocol ( + IpInstance->Interface->ArpHandle, + &gEfiArpProtocolGuid, + gIp4DriverBinding.DriverBindingHandle, + IpInstance->Handle + ); + } + Ip4FreeInterface (IpInstance->Interface, IpInstance); + IpInstance->Interface = NULL; + } + + if (IpInstance->RouteTable != NULL) { + if (IpInstance->RouteTable->Next != NULL) { + Ip4FreeRouteTable (IpInstance->RouteTable->Next); + } + + Ip4FreeRouteTable (IpInstance->RouteTable); + IpInstance->RouteTable = NULL; + } + + if (IpInstance->EfiRouteTable != NULL) { + FreePool (IpInstance->EfiRouteTable); + IpInstance->EfiRouteTable = NULL; + IpInstance->EfiRouteCount = 0; + } + + if (IpInstance->Groups != NULL) { + FreePool (IpInstance->Groups); + IpInstance->Groups = NULL; + IpInstance->GroupCount = 0; + } + + NetMapClean (&IpInstance->TxTokens); + + NetMapClean (&IpInstance->RxTokens); + + return EFI_SUCCESS; +} + + +/** + Assigns an IPv4 address and subnet mask to this EFI IPv4 Protocol driver instance. + + The Configure() function is used to set, change, or reset the operational + parameters and filter settings for this EFI IPv4 Protocol instance. Until these + parameters have been set, no network traffic can be sent or received by this + instance. Once the parameters have been reset (by calling this function with + IpConfigData set to NULL), no more traffic can be sent or received until these + parameters have been set again. Each EFI IPv4 Protocol instance can be started + and stopped independently of each other by enabling or disabling their receive + filter settings with the Configure() function. + + When IpConfigData.UseDefaultAddress is set to FALSE, the new station address will + be appended as an alias address into the addresses list in the EFI IPv4 Protocol + driver. While set to TRUE, Configure() will trigger the EFI_IP4_CONFIG_PROTOCOL + to retrieve the default IPv4 address if it is not available yet. Clients could + frequently call GetModeData() to check the status to ensure that the default IPv4 + address is ready. + + If operational parameters are reset or changed, any pending transmit and receive + requests will be cancelled. Their completion token status will be set to EFI_ABORTED + and their events will be signaled. + + @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. + @param[in] IpConfigData Pointer to the EFI IPv4 Protocol configuration data structure. + + @retval EFI_SUCCESS The driver instance was successfully opened. + @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, + RARP, etc.) is not finished yet. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + @retval EFI_UNSUPPORTED One or more of the following conditions is TRUE: + A configuration protocol (DHCP, BOOTP, RARP, etc.) could + not be located when clients choose to use the default IPv4 + address. This EFI IPv4 Protocol implementation does not + support this requested filter or timeout setting. + @retval EFI_OUT_OF_RESOURCES The EFI IPv4 Protocol driver instance data could not be allocated. + @retval EFI_ALREADY_STARTED The interface is already open and must be stopped before the + IPv4 address or subnet mask can be changed. The interface must + also be stopped when switching to/from raw packet mode. + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI IPv4 + Protocol driver instance is not opened. + +**/ +EFI_STATUS +EFIAPI +EfiIp4Configure ( + IN EFI_IP4_PROTOCOL *This, + IN EFI_IP4_CONFIG_DATA *IpConfigData OPTIONAL + ) +{ + IP4_PROTOCOL *IpInstance; + EFI_IP4_CONFIG_DATA *Current; + EFI_TPL OldTpl; + EFI_STATUS Status; + BOOLEAN AddrOk; + IP4_ADDR IpAddress; + IP4_ADDR SubnetMask; + + // + // First, validate the parameters + // + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This); + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + // + // Validate the configuration first. + // + if (IpConfigData != NULL) { + + CopyMem (&IpAddress, &IpConfigData->StationAddress, sizeof (IP4_ADDR)); + CopyMem (&SubnetMask, &IpConfigData->SubnetMask, sizeof (IP4_ADDR)); + + IpAddress = NTOHL (IpAddress); + SubnetMask = NTOHL (SubnetMask); + + // + // Check whether the station address is a valid unicast address + // + if (!IpConfigData->UseDefaultAddress) { + AddrOk = Ip4StationAddressValid (IpAddress, SubnetMask); + + if (!AddrOk) { + Status = EFI_INVALID_PARAMETER; + goto ON_EXIT; + } + } + + // + // User can only update packet filters when already configured. + // If it wants to change the station address, it must configure(NULL) + // the instance first. + // + if (IpInstance->State == IP4_STATE_CONFIGED) { + Current = &IpInstance->ConfigData; + + if (Current->UseDefaultAddress != IpConfigData->UseDefaultAddress) { + Status = EFI_ALREADY_STARTED; + goto ON_EXIT; + } + + if (!Current->UseDefaultAddress && + (!EFI_IP4_EQUAL (&Current->StationAddress, &IpConfigData->StationAddress) || + !EFI_IP4_EQUAL (&Current->SubnetMask, &IpConfigData->SubnetMask))) { + Status = EFI_ALREADY_STARTED; + goto ON_EXIT; + } + + if (Current->UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) { + Status = EFI_NO_MAPPING; + goto ON_EXIT; + } + } + } + + // + // Configure the instance or clean it up. + // + if (IpConfigData != NULL) { + Status = Ip4ConfigProtocol (IpInstance, IpConfigData); + } else { + Status = Ip4CleanProtocol (IpInstance); + + // + // Consider the following valid sequence: Mnp is unloaded-->Ip Stopped-->Udp Stopped, + // Configure (ThisIp, NULL). If the state is changed to UNCONFIGED, + // the unload fails miserably. + // + if (IpInstance->State == IP4_STATE_CONFIGED) { + IpInstance->State = IP4_STATE_UNCONFIGED; + } + } + + // + // Update the MNP's configure data. Ip4ServiceConfigMnp will check + // whether it is necessary to reconfigure the MNP. + // + Ip4ServiceConfigMnp (IpInstance->Service, FALSE); + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + return Status; + +} + + +/** + Change the IP4 child's multicast setting. The caller + should make sure that the parameters is valid. + + @param[in] IpInstance The IP4 child to change the setting. + @param[in] JoinFlag TRUE to join the group, otherwise leave it. + @param[in] GroupAddress The target group address. + + @retval EFI_ALREADY_STARTED Want to join the group, but already a member of it. + @retval EFI_OUT_OF_RESOURCES Failed to allocate some resources. + @retval EFI_DEVICE_ERROR Failed to set the group configuraton. + @retval EFI_SUCCESS Successfully updated the group setting. + @retval EFI_NOT_FOUND Try to leave the group which it isn't a member. + +**/ +EFI_STATUS +Ip4Groups ( + IN IP4_PROTOCOL *IpInstance, + IN BOOLEAN JoinFlag, + IN EFI_IPv4_ADDRESS *GroupAddress OPTIONAL + ) +{ + IP4_ADDR *Members; + IP4_ADDR Group; + UINT32 Index; + + // + // Add it to the instance's Groups, and join the group by IGMP. + // IpInstance->Groups is in network byte order. IGMP operates in + // host byte order + // + if (JoinFlag) { + // + // When JoinFlag is TRUE, GroupAddress shouldn't be NULL. + // + ASSERT (GroupAddress != NULL); + CopyMem (&Group, GroupAddress, sizeof (IP4_ADDR)); + + for (Index = 0; Index < IpInstance->GroupCount; Index++) { + if (IpInstance->Groups[Index] == Group) { + return EFI_ALREADY_STARTED; + } + } + + Members = Ip4CombineGroups (IpInstance->Groups, IpInstance->GroupCount, Group); + + if (Members == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + if (EFI_ERROR (Ip4JoinGroup (IpInstance, NTOHL (Group)))) { + FreePool (Members); + return EFI_DEVICE_ERROR; + } + + if (IpInstance->Groups != NULL) { + FreePool (IpInstance->Groups); + } + + IpInstance->Groups = Members; + IpInstance->GroupCount++; + + return EFI_SUCCESS; + } + + // + // Leave the group. Leave all the groups if GroupAddress is NULL. + // Must iterate from the end to the beginning because the GroupCount + // is decreamented each time an address is removed.. + // + for (Index = IpInstance->GroupCount; Index > 0 ; Index--) { + ASSERT (IpInstance->Groups != NULL); + Group = IpInstance->Groups[Index - 1]; + if ((GroupAddress == NULL) || EFI_IP4_EQUAL (&Group, GroupAddress)) { + if (EFI_ERROR (Ip4LeaveGroup (IpInstance, NTOHL (Group)))) { + return EFI_DEVICE_ERROR; + } + + Ip4RemoveGroupAddr (IpInstance->Groups, IpInstance->GroupCount, Group); + IpInstance->GroupCount--; + + if (IpInstance->GroupCount == 0) { + ASSERT (Index == 1); + + FreePool (IpInstance->Groups); + IpInstance->Groups = NULL; + } + + if (GroupAddress != NULL) { + return EFI_SUCCESS; + } + } + } + + return ((GroupAddress != NULL) ? EFI_NOT_FOUND : EFI_SUCCESS); +} + + +/** + Joins and leaves multicast groups. + + The Groups() function is used to join and leave multicast group sessions. Joining + a group will enable reception of matching multicast packets. Leaving a group will + disable the multicast packet reception. + + If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left. + + @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. + @param[in] JoinFlag Set to TRUE to join the multicast group session and FALSE to leave. + @param[in] GroupAddress Pointer to the IPv4 multicast address. + + @retval EFI_SUCCESS The operation completed successfully. + @retval EFI_INVALID_PARAMETER One or more of the following is TRUE: + - This is NULL. + - JoinFlag is TRUE and GroupAddress is NULL. + - GroupAddress is not NULL and *GroupAddress is + not a multicast IPv4 address. + @retval EFI_NOT_STARTED This instance has not been started. + @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, + RARP, etc.) is not finished yet. + @retval EFI_OUT_OF_RESOURCES System resources could not be allocated. + @retval EFI_UNSUPPORTED This EFI IPv4 Protocol implementation does not support multicast groups. + @retval EFI_ALREADY_STARTED The group address is already in the group table (when + JoinFlag is TRUE). + @retval EFI_NOT_FOUND The group address is not in the group table (when JoinFlag is FALSE). + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. + +**/ +EFI_STATUS +EFIAPI +EfiIp4Groups ( + IN EFI_IP4_PROTOCOL *This, + IN BOOLEAN JoinFlag, + IN EFI_IPv4_ADDRESS *GroupAddress OPTIONAL + ) +{ + IP4_PROTOCOL *IpInstance; + EFI_STATUS Status; + EFI_TPL OldTpl; + IP4_ADDR McastIp; + + if ((This == NULL) || (JoinFlag && (GroupAddress == NULL))) { + return EFI_INVALID_PARAMETER; + } + + if (GroupAddress != NULL) { + CopyMem (&McastIp, GroupAddress, sizeof (IP4_ADDR)); + + if (!IP4_IS_MULTICAST (NTOHL (McastIp))) { + return EFI_INVALID_PARAMETER; + } + } + + IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This); + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + if (IpInstance->State != IP4_STATE_CONFIGED) { + Status = EFI_NOT_STARTED; + goto ON_EXIT; + } + + if (IpInstance->ConfigData.UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) { + Status = EFI_NO_MAPPING; + goto ON_EXIT; + } + + Status = Ip4Groups (IpInstance, JoinFlag, GroupAddress); + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + return Status; +} + + +/** + Adds and deletes routing table entries. + + The Routes() function adds a route to or deletes a route from the routing table. + + Routes are determined by comparing the SubnetAddress with the destination IPv4 + address arithmetically AND-ed with the SubnetMask. The gateway address must be + on the same subnet as the configured station address. + + The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0. + The default route matches all destination IPv4 addresses that do not match any + other routes. + + A GatewayAddress that is zero is a nonroute. Packets are sent to the destination + IP address if it can be found in the ARP cache or on the local subnet. One automatic + nonroute entry will be inserted into the routing table for outgoing packets that + are addressed to a local subnet (gateway address of 0.0.0.0). + + Each EFI IPv4 Protocol instance has its own independent routing table. Those EFI + IPv4 Protocol instances that use the default IPv4 address will also have copies + of the routing table that was provided by the EFI_IP4_CONFIG_PROTOCOL, and these + copies will be updated whenever the EIF IPv4 Protocol driver reconfigures its + instances. As a result, client modification to the routing table will be lost. + + @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. + @param[in] DeleteRoute Set to TRUE to delete this route from the routing table. Set to + FALSE to add this route to the routing table. SubnetAddress + and SubnetMask are used as the key to each route entry. + @param[in] SubnetAddress The address of the subnet that needs to be routed. + @param[in] SubnetMask The subnet mask of SubnetAddress. + @param[in] GatewayAddress The unicast gateway IPv4 address for this route. + + @retval EFI_SUCCESS The operation completed successfully. + @retval EFI_NOT_STARTED The driver instance has not been started. + @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, + RARP, etc.) is not finished yet. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + - This is NULL. + - SubnetAddress is NULL. + - SubnetMask is NULL. + - GatewayAddress is NULL. + - *SubnetAddress is not a valid subnet address. + - *SubnetMask is not a valid subnet mask. + - *GatewayAddress is not a valid unicast IPv4 address. + @retval EFI_OUT_OF_RESOURCES Could not add the entry to the routing table. + @retval EFI_NOT_FOUND This route is not in the routing table (when DeleteRoute is TRUE). + @retval EFI_ACCESS_DENIED The route is already defined in the routing table (when + DeleteRoute is FALSE). + +**/ +EFI_STATUS +EFIAPI +EfiIp4Routes ( + IN EFI_IP4_PROTOCOL *This, + IN BOOLEAN DeleteRoute, + IN EFI_IPv4_ADDRESS *SubnetAddress, + IN EFI_IPv4_ADDRESS *SubnetMask, + IN EFI_IPv4_ADDRESS *GatewayAddress + ) +{ + IP4_PROTOCOL *IpInstance; + IP4_INTERFACE *IpIf; + IP4_ADDR Dest; + IP4_ADDR Netmask; + IP4_ADDR Nexthop; + EFI_STATUS Status; + EFI_TPL OldTpl; + + // + // First, validate the parameters + // + if ((This == NULL) || (SubnetAddress == NULL) || + (SubnetMask == NULL) || (GatewayAddress == NULL)) { + return EFI_INVALID_PARAMETER; + } + + IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This); + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + if (IpInstance->State != IP4_STATE_CONFIGED) { + Status = EFI_NOT_STARTED; + goto ON_EXIT; + } + + if (IpInstance->ConfigData.UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) { + Status = EFI_NO_MAPPING; + goto ON_EXIT; + } + + CopyMem (&Dest, SubnetAddress, sizeof (IP4_ADDR)); + CopyMem (&Netmask, SubnetMask, sizeof (IP4_ADDR)); + CopyMem (&Nexthop, GatewayAddress, sizeof (IP4_ADDR)); + + Dest = NTOHL (Dest); + Netmask = NTOHL (Netmask); + Nexthop = NTOHL (Nexthop); + + IpIf = IpInstance->Interface; + + if (!IP4_IS_VALID_NETMASK (Netmask)) { + Status = EFI_INVALID_PARAMETER; + goto ON_EXIT; + } + + // + // the gateway address must be a unicast on the connected network if not zero. + // + if ((Nexthop != IP4_ALLZERO_ADDRESS) && + ((IpIf->SubnetMask != IP4_ALLONE_ADDRESS && !IP4_NET_EQUAL (Nexthop, IpIf->Ip, IpIf->SubnetMask)) || + IP4_IS_BROADCAST (Ip4GetNetCast (Nexthop, IpIf)))) { + + Status = EFI_INVALID_PARAMETER; + goto ON_EXIT; + } + + if (DeleteRoute) { + Status = Ip4DelRoute (IpInstance->RouteTable, Dest, Netmask, Nexthop); + } else { + Status = Ip4AddRoute (IpInstance->RouteTable, Dest, Netmask, Nexthop); + } + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + return Status; +} + + +/** + Check whether the user's token or event has already + been enqueued on IP4's list. + + @param[in] Map The container of either user's transmit or receive + token. + @param[in] Item Current item to check against. + @param[in] Context The Token to check againist. + + @retval EFI_ACCESS_DENIED The token or event has already been enqueued in IP. + @retval EFI_SUCCESS The current item isn't the same token/event as the + context. + +**/ +EFI_STATUS +EFIAPI +Ip4TokenExist ( + IN NET_MAP *Map, + IN NET_MAP_ITEM *Item, + IN VOID *Context + ) +{ + EFI_IP4_COMPLETION_TOKEN *Token; + EFI_IP4_COMPLETION_TOKEN *TokenInItem; + + Token = (EFI_IP4_COMPLETION_TOKEN *) Context; + TokenInItem = (EFI_IP4_COMPLETION_TOKEN *) Item->Key; + + if ((Token == TokenInItem) || (Token->Event == TokenInItem->Event)) { + return EFI_ACCESS_DENIED; + } + + return EFI_SUCCESS; +} + +/** + Validate the user's token against current station address. + + @param[in] Token User's token to validate. + @param[in] IpIf The IP4 child's interface. + @param[in] RawData Set to TRUE to send unformatted packets. + + @retval EFI_INVALID_PARAMETER Some parameters are invalid. + @retval EFI_BAD_BUFFER_SIZE The user's option/data is too long. + @retval EFI_SUCCESS The token is valid. + +**/ +EFI_STATUS +Ip4TxTokenValid ( + IN EFI_IP4_COMPLETION_TOKEN *Token, + IN IP4_INTERFACE *IpIf, + IN BOOLEAN RawData + ) +{ + EFI_IP4_TRANSMIT_DATA *TxData; + EFI_IP4_OVERRIDE_DATA *Override; + IP4_ADDR Src; + IP4_ADDR Gateway; + UINT32 Offset; + UINT32 Index; + UINT32 HeadLen; + + if ((Token == NULL) || (Token->Event == NULL) || (Token->Packet.TxData == NULL)) { + return EFI_INVALID_PARAMETER; + } + + TxData = Token->Packet.TxData; + + // + // Check the fragment table: no empty fragment, and length isn't bogus. + // + if ((TxData->TotalDataLength == 0) || (TxData->FragmentCount == 0)) { + return EFI_INVALID_PARAMETER; + } + + Offset = TxData->TotalDataLength; + + if (Offset > IP4_MAX_PACKET_SIZE) { + return EFI_BAD_BUFFER_SIZE; + } + + for (Index = 0; Index < TxData->FragmentCount; Index++) { + if ((TxData->FragmentTable[Index].FragmentBuffer == NULL) || + (TxData->FragmentTable[Index].FragmentLength == 0)) { + + return EFI_INVALID_PARAMETER; + } + + Offset -= TxData->FragmentTable[Index].FragmentLength; + } + + if (Offset != 0) { + return EFI_INVALID_PARAMETER; + } + + // + // NOTE that OptionsLength/OptionsBuffer/OverrideData are ignored if RawData + // is TRUE. + // + if (RawData) { + return EFI_SUCCESS; + } + + // + // Check the IP options: no more than 40 bytes and format is OK + // + if (TxData->OptionsLength != 0) { + if ((TxData->OptionsLength > 40) || (TxData->OptionsBuffer == NULL)) { + return EFI_INVALID_PARAMETER; + } + + if (!Ip4OptionIsValid (TxData->OptionsBuffer, TxData->OptionsLength, FALSE)) { + return EFI_INVALID_PARAMETER; + } + } + + // + // Check the source and gateway: they must be a valid unicast. + // Gateway must also be on the connected network. + // + if (TxData->OverrideData != NULL) { + Override = TxData->OverrideData; + + CopyMem (&Src, &Override->SourceAddress, sizeof (IP4_ADDR)); + CopyMem (&Gateway, &Override->GatewayAddress, sizeof (IP4_ADDR)); + + Src = NTOHL (Src); + Gateway = NTOHL (Gateway); + + if ((NetGetIpClass (Src) > IP4_ADDR_CLASSC) || + (Src == IP4_ALLONE_ADDRESS) || + IP4_IS_BROADCAST (Ip4GetNetCast (Src, IpIf))) { + + return EFI_INVALID_PARAMETER; + } + + // + // If gateway isn't zero, it must be a unicast address, and + // on the connected network. + // + if ((Gateway != IP4_ALLZERO_ADDRESS) && + ((NetGetIpClass (Gateway) > IP4_ADDR_CLASSC) || + !IP4_NET_EQUAL (Gateway, IpIf->Ip, IpIf->SubnetMask) || + IP4_IS_BROADCAST (Ip4GetNetCast (Gateway, IpIf)))) { + + return EFI_INVALID_PARAMETER; + } + } + + // + // Check the packet length: Head length and packet length all has a limit + // + HeadLen = sizeof (IP4_HEAD) + ((TxData->OptionsLength + 3) &~0x03); + + if ((HeadLen > IP4_MAX_HEADLEN) || + (TxData->TotalDataLength + HeadLen > IP4_MAX_PACKET_SIZE)) { + + return EFI_BAD_BUFFER_SIZE; + } + + return EFI_SUCCESS; +} + + +/** + The callback function for the net buffer which wraps the user's + transmit token. Although it seems this function is pretty simple, + there are some subtle things. + When user requests the IP to transmit a packet by passing it a + token, the token is wrapped in an IP4_TXTOKEN_WRAP and the data + is wrapped in an net buffer. the net buffer's Free function is + set to Ip4FreeTxToken. The Token and token wrap are added to the + IP child's TxToken map. Then the buffer is passed to Ip4Output for + transmission. If something error happened before that, the buffer + is freed, which in turn will free the token wrap. The wrap may + have been added to the TxToken map or not, and the user's event + shouldn't be fired because we are still in the EfiIp4Transmit. If + the buffer has been sent by Ip4Output, it should be removed from + the TxToken map and user's event signaled. The token wrap and buffer + are bound together. Check the comments in Ip4Output for information + about IP fragmentation. + + @param[in] Context The token's wrap. + +**/ +VOID +EFIAPI +Ip4FreeTxToken ( + IN VOID *Context + ) +{ + IP4_TXTOKEN_WRAP *Wrap; + NET_MAP_ITEM *Item; + + Wrap = (IP4_TXTOKEN_WRAP *) Context; + + // + // Signal IpSecRecycleEvent to inform IPsec free the memory + // + if (Wrap->IpSecRecycleSignal != NULL) { + gBS->SignalEvent (Wrap->IpSecRecycleSignal); + } + + // + // Find the token in the instance's map. EfiIp4Transmit put the + // token to the map. If that failed, NetMapFindKey will return NULL. + // + Item = NetMapFindKey (&Wrap->IpInstance->TxTokens, Wrap->Token); + + if (Item != NULL) { + NetMapRemoveItem (&Wrap->IpInstance->TxTokens, Item, NULL); + } + + if (Wrap->Sent) { + gBS->SignalEvent (Wrap->Token->Event); + + // + // Dispatch the DPC queued by the NotifyFunction of Token->Event. + // + DispatchDpc (); + } + + FreePool (Wrap); +} + + +/** + The callback function to Ip4Output to update the transmit status. + + @param Ip4Instance The Ip4Instance that request the transmit. + @param Packet The user's transmit request. + @param IoStatus The result of the transmission. + @param Flag Not used during transmission. + @param Context The token's wrap. + +**/ +VOID +Ip4OnPacketSent ( + IP4_PROTOCOL *Ip4Instance, + NET_BUF *Packet, + EFI_STATUS IoStatus, + UINT32 Flag, + VOID *Context + ) +{ + IP4_TXTOKEN_WRAP *Wrap; + + // + // This is the transmission request from upper layer, + // not the IP4 driver itself. + // + ASSERT (Ip4Instance != NULL); + + // + // The first fragment of the packet has been sent. Update + // the token's status. That is, if fragmented, the transmit's + // status is the first fragment's status. The Wrap will be + // release when all the fragments are release. Check the comments + // in Ip4FreeTxToken and Ip4Output for information. + // + Wrap = (IP4_TXTOKEN_WRAP *) Context; + Wrap->Token->Status = IoStatus; + + NetbufFree (Wrap->Packet); +} + + +/** + Places outgoing data packets into the transmit queue. + + The Transmit() function places a sending request in the transmit queue of this + EFI IPv4 Protocol instance. Whenever the packet in the token is sent out or some + errors occur, the event in the token will be signaled and the status is updated. + + @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. + @param[in] Token Pointer to the transmit token. + + @retval EFI_SUCCESS The data has been queued for transmission. + @retval EFI_NOT_STARTED This instance has not been started. + @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, + RARP, etc.) is not finished yet. + @retval EFI_INVALID_PARAMETER One or more pameters are invalid. + @retval EFI_ACCESS_DENIED The transmit completion token with the same Token.Event + was already in the transmit queue. + @retval EFI_NOT_READY The completion token could not be queued because the transmit + queue is full. + @retval EFI_NOT_FOUND Not route is found to destination address. + @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data. + @retval EFI_BUFFER_TOO_SMALL Token.Packet.TxData.TotalDataLength is too + short to transmit. + @retval EFI_BAD_BUFFER_SIZE The length of the IPv4 header + option length + total data length is + greater than MTU (or greater than the maximum packet size if + Token.Packet.TxData.OverrideData. + DoNotFragment is TRUE). + +**/ +EFI_STATUS +EFIAPI +EfiIp4Transmit ( + IN EFI_IP4_PROTOCOL *This, + IN EFI_IP4_COMPLETION_TOKEN *Token + ) +{ + IP4_SERVICE *IpSb; + IP4_PROTOCOL *IpInstance; + IP4_INTERFACE *IpIf; + IP4_TXTOKEN_WRAP *Wrap; + EFI_IP4_TRANSMIT_DATA *TxData; + EFI_IP4_CONFIG_DATA *Config; + EFI_IP4_OVERRIDE_DATA *Override; + IP4_HEAD Head; + IP4_ADDR GateWay; + EFI_STATUS Status; + EFI_TPL OldTpl; + BOOLEAN DontFragment; + UINT32 HeadLen; + UINT8 RawHdrLen; + UINT32 OptionsLength; + UINT8 *OptionsBuffer; + VOID *FirstFragment; + + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This); + + if (IpInstance->State != IP4_STATE_CONFIGED) { + return EFI_NOT_STARTED; + } + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + IpSb = IpInstance->Service; + IpIf = IpInstance->Interface; + Config = &IpInstance->ConfigData; + + if (Config->UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) { + Status = EFI_NO_MAPPING; + goto ON_EXIT; + } + + // + // make sure that token is properly formated + // + Status = Ip4TxTokenValid (Token, IpIf, Config->RawData); + + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } + + // + // Check whether the token or signal already existed. + // + if (EFI_ERROR (NetMapIterate (&IpInstance->TxTokens, Ip4TokenExist, Token))) { + Status = EFI_ACCESS_DENIED; + goto ON_EXIT; + } + + // + // Build the IP header, need to fill in the Tos, TotalLen, Id, + // fragment, Ttl, protocol, Src, and Dst. + // + TxData = Token->Packet.TxData; + + FirstFragment = NULL; + + if (Config->RawData) { + // + // When RawData is TRUE, first buffer in FragmentTable points to a raw + // IPv4 fragment including IPv4 header and options. + // + FirstFragment = TxData->FragmentTable[0].FragmentBuffer; + CopyMem (&RawHdrLen, FirstFragment, sizeof (UINT8)); + + RawHdrLen = (UINT8) (RawHdrLen & 0x0f); + if (RawHdrLen < 5) { + Status = EFI_INVALID_PARAMETER; + goto ON_EXIT; + } + + RawHdrLen = (UINT8) (RawHdrLen << 2); + + CopyMem (&Head, FirstFragment, IP4_MIN_HEADLEN); + + Ip4NtohHead (&Head); + HeadLen = 0; + DontFragment = IP4_DO_NOT_FRAGMENT (Head.Fragment); + + if (!DontFragment) { + Status = EFI_INVALID_PARAMETER; + goto ON_EXIT; + } + + GateWay = IP4_ALLZERO_ADDRESS; + + // + // Get IPv4 options from first fragment. + // + if (RawHdrLen == IP4_MIN_HEADLEN) { + OptionsLength = 0; + OptionsBuffer = NULL; + } else { + OptionsLength = RawHdrLen - IP4_MIN_HEADLEN; + OptionsBuffer = (UINT8 *) FirstFragment + IP4_MIN_HEADLEN; + } + + // + // Trim off IPv4 header and options from first fragment. + // + TxData->FragmentTable[0].FragmentBuffer = (UINT8 *) FirstFragment + RawHdrLen; + TxData->FragmentTable[0].FragmentLength = TxData->FragmentTable[0].FragmentLength - RawHdrLen; + } else { + CopyMem (&Head.Dst, &TxData->DestinationAddress, sizeof (IP4_ADDR)); + Head.Dst = NTOHL (Head.Dst); + + if (TxData->OverrideData != NULL) { + Override = TxData->OverrideData; + Head.Protocol = Override->Protocol; + Head.Tos = Override->TypeOfService; + Head.Ttl = Override->TimeToLive; + DontFragment = Override->DoNotFragment; + + CopyMem (&Head.Src, &Override->SourceAddress, sizeof (IP4_ADDR)); + CopyMem (&GateWay, &Override->GatewayAddress, sizeof (IP4_ADDR)); + + Head.Src = NTOHL (Head.Src); + GateWay = NTOHL (GateWay); + } else { + Head.Src = IpIf->Ip; + GateWay = IP4_ALLZERO_ADDRESS; + Head.Protocol = Config->DefaultProtocol; + Head.Tos = Config->TypeOfService; + Head.Ttl = Config->TimeToLive; + DontFragment = Config->DoNotFragment; + } + + Head.Fragment = IP4_HEAD_FRAGMENT_FIELD (DontFragment, FALSE, 0); + HeadLen = (TxData->OptionsLength + 3) & (~0x03); + + OptionsLength = TxData->OptionsLength; + OptionsBuffer = (UINT8 *) (TxData->OptionsBuffer); + } + + // + // If don't fragment and fragment needed, return error + // + if (DontFragment && (TxData->TotalDataLength + HeadLen > IpSb->MaxPacketSize)) { + Status = EFI_BAD_BUFFER_SIZE; + goto ON_EXIT; + } + + // + // OK, it survives all the validation check. Wrap the token in + // a IP4_TXTOKEN_WRAP and the data in a netbuf + // + Status = EFI_OUT_OF_RESOURCES; + Wrap = AllocateZeroPool (sizeof (IP4_TXTOKEN_WRAP)); + if (Wrap == NULL) { + goto ON_EXIT; + } + + Wrap->IpInstance = IpInstance; + Wrap->Token = Token; + Wrap->Sent = FALSE; + Wrap->Life = IP4_US_TO_SEC (Config->TransmitTimeout); + Wrap->Packet = NetbufFromExt ( + (NET_FRAGMENT *) TxData->FragmentTable, + TxData->FragmentCount, + IP4_MAX_HEADLEN, + 0, + Ip4FreeTxToken, + Wrap + ); + + if (Wrap->Packet == NULL) { + FreePool (Wrap); + goto ON_EXIT; + } + + Token->Status = EFI_NOT_READY; + + if (EFI_ERROR (NetMapInsertTail (&IpInstance->TxTokens, Token, Wrap))) { + // + // NetbufFree will call Ip4FreeTxToken, which in turn will + // free the IP4_TXTOKEN_WRAP. Now, the token wrap hasn't been + // enqueued. + // + if (Config->RawData) { + // + // Restore pointer of first fragment in RawData mode. + // + TxData->FragmentTable[0].FragmentBuffer = (UINT8 *) FirstFragment; + } + + NetbufFree (Wrap->Packet); + goto ON_EXIT; + } + + // + // Mark the packet sent before output it. Mark it not sent again if the + // returned status is not EFI_SUCCESS; + // + Wrap->Sent = TRUE; + + Status = Ip4Output ( + IpSb, + IpInstance, + Wrap->Packet, + &Head, + OptionsBuffer, + OptionsLength, + GateWay, + Ip4OnPacketSent, + Wrap + ); + + if (EFI_ERROR (Status)) { + Wrap->Sent = FALSE; + + if (Config->RawData) { + // + // Restore pointer of first fragment in RawData mode. + // + TxData->FragmentTable[0].FragmentBuffer = (UINT8 *) FirstFragment; + } + + NetbufFree (Wrap->Packet); + } + + if (Config->RawData) { + // + // Restore pointer of first fragment in RawData mode. + // + TxData->FragmentTable[0].FragmentBuffer = (UINT8 *) FirstFragment; + } + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + return Status; +} + + +/** + Places a receiving request into the receiving queue. + + The Receive() function places a completion token into the receive packet queue. + This function is always asynchronous. + + The Token.Event field in the completion token must be filled in by the caller + and cannot be NULL. When the receive operation completes, the EFI IPv4 Protocol + driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event + is signaled. + + @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. + @param[in] Token Pointer to a token that is associated with the receive data descriptor. + + @retval EFI_SUCCESS The receive completion token was cached. + @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started. + @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, RARP, etc.) + is not finished yet. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + - This is NULL. + - Token is NULL. + - Token.Event is NULL. + @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system + resources (usually memory). + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. + The EFI IPv4 Protocol instance has been reset to startup defaults. + EFI_ACCESS_DENIED The receive completion token with the same Token.Event was already + in the receive queue. + @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full. + @retval EFI_ICMP_ERROR An ICMP error packet was received. + +**/ +EFI_STATUS +EFIAPI +EfiIp4Receive ( + IN EFI_IP4_PROTOCOL *This, + IN EFI_IP4_COMPLETION_TOKEN *Token + ) +{ + IP4_PROTOCOL *IpInstance; + EFI_STATUS Status; + EFI_TPL OldTpl; + + // + // First validate the parameters + // + if ((This == NULL) || (Token == NULL) || (Token->Event == NULL)) { + return EFI_INVALID_PARAMETER; + } + + IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This); + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + if (IpInstance->State != IP4_STATE_CONFIGED) { + Status = EFI_NOT_STARTED; + goto ON_EXIT; + } + + // + // Check whether the toke is already on the receive queue. + // + Status = NetMapIterate (&IpInstance->RxTokens, Ip4TokenExist, Token); + + if (EFI_ERROR (Status)) { + Status = EFI_ACCESS_DENIED; + goto ON_EXIT; + } + + // + // Queue the token then check whether there is pending received packet. + // + Status = NetMapInsertTail (&IpInstance->RxTokens, Token, NULL); + + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } + + Status = Ip4InstanceDeliverPacket (IpInstance); + + // + // Dispatch the DPC queued by the NotifyFunction of this instane's receive + // event. + // + DispatchDpc (); + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + return Status; +} + + +/** + Cancel the transmitted but not recycled packet. If a matching + token is found, it will call Ip4CancelPacket to cancel the + packet. Ip4CancelPacket will cancel all the fragments of the + packet. When all the fragments are freed, the IP4_TXTOKEN_WRAP + will be deleted from the Map, and user's event signalled. + Because Ip4CancelPacket and other functions are all called in + line, so, after Ip4CancelPacket returns, the Item has been freed. + + @param[in] Map The IP4 child's transmit queue. + @param[in] Item The current transmitted packet to test. + @param[in] Context The user's token to cancel. + + @retval EFI_SUCCESS Continue to check the next Item. + @retval EFI_ABORTED The user's Token (Token != NULL) is cancelled. + +**/ +EFI_STATUS +EFIAPI +Ip4CancelTxTokens ( + IN NET_MAP *Map, + IN NET_MAP_ITEM *Item, + IN VOID *Context + ) +{ + EFI_IP4_COMPLETION_TOKEN *Token; + IP4_TXTOKEN_WRAP *Wrap; + + Token = (EFI_IP4_COMPLETION_TOKEN *) Context; + + // + // Return EFI_SUCCESS to check the next item in the map if + // this one doesn't match. + // + if ((Token != NULL) && (Token != Item->Key)) { + return EFI_SUCCESS; + } + + Wrap = (IP4_TXTOKEN_WRAP *) Item->Value; + ASSERT (Wrap != NULL); + + // + // Don't access the Item, Wrap and Token's members after this point. + // Item and wrap has been freed. And we no longer own the Token. + // + Ip4CancelPacket (Wrap->IpInstance->Interface, Wrap->Packet, EFI_ABORTED); + + // + // If only one item is to be cancel, return EFI_ABORTED to stop + // iterating the map any more. + // + if (Token != NULL) { + return EFI_ABORTED; + } + + return EFI_SUCCESS; +} + + +/** + Cancel the receive request. This is quiet simple, because + it is only enqueued in our local receive map. + + @param[in] Map The IP4 child's receive queue. + @param[in] Item Current receive request to cancel. + @param[in] Context The user's token to cancel. + + @retval EFI_SUCCESS Continue to check the next receive request on the + queue. + @retval EFI_ABORTED The user's token (token != NULL) has been + cancelled. + +**/ +EFI_STATUS +EFIAPI +Ip4CancelRxTokens ( + IN NET_MAP *Map, + IN NET_MAP_ITEM *Item, + IN VOID *Context + ) +{ + EFI_IP4_COMPLETION_TOKEN *Token; + EFI_IP4_COMPLETION_TOKEN *This; + + Token = (EFI_IP4_COMPLETION_TOKEN *) Context; + This = Item->Key; + + if ((Token != NULL) && (Token != This)) { + return EFI_SUCCESS; + } + + NetMapRemoveItem (Map, Item, NULL); + + This->Status = EFI_ABORTED; + This->Packet.RxData = NULL; + gBS->SignalEvent (This->Event); + + if (Token != NULL) { + return EFI_ABORTED; + } + + return EFI_SUCCESS; +} + + +/** + Cancel the user's receive/transmit request. + + @param[in] IpInstance The IP4 child. + @param[in] Token The token to cancel. If NULL, all token will be + cancelled. + + @retval EFI_SUCCESS The token is cancelled. + @retval EFI_NOT_FOUND The token isn't found on either the + transmit/receive queue. + @retval EFI_DEVICE_ERROR Not all token is cancelled when Token is NULL. + +**/ +EFI_STATUS +Ip4Cancel ( + IN IP4_PROTOCOL *IpInstance, + IN EFI_IP4_COMPLETION_TOKEN *Token OPTIONAL + ) +{ + EFI_STATUS Status; + + // + // First check the transmitted packet. Ip4CancelTxTokens returns + // EFI_ABORTED to mean that the token has been cancelled when + // token != NULL. So, return EFI_SUCCESS for this condition. + // + Status = NetMapIterate (&IpInstance->TxTokens, Ip4CancelTxTokens, Token); + + if (EFI_ERROR (Status)) { + if ((Token != NULL) && (Status == EFI_ABORTED)) { + return EFI_SUCCESS; + } + + return Status; + } + + // + // Check the receive queue. Ip4CancelRxTokens also returns EFI_ABORT + // for Token!=NULL and it is cancelled. + // + Status = NetMapIterate (&IpInstance->RxTokens, Ip4CancelRxTokens, Token); + // + // Dispatch the DPCs queued by the NotifyFunction of the canceled rx token's + // events. + // + DispatchDpc (); + if (EFI_ERROR (Status)) { + if ((Token != NULL) && (Status == EFI_ABORTED)) { + return EFI_SUCCESS; + } + + return Status; + } + + // + // OK, if the Token is found when Token != NULL, the NetMapIterate + // will return EFI_ABORTED, which has been interrupted as EFI_SUCCESS. + // + if (Token != NULL) { + return EFI_NOT_FOUND; + } + + // + // If Token == NULL, cancel all the tokens. return error if no + // all of them are cancelled. + // + if (!NetMapIsEmpty (&IpInstance->TxTokens) || + !NetMapIsEmpty (&IpInstance->RxTokens)) { + + return EFI_DEVICE_ERROR; + } + + return EFI_SUCCESS; +} + + +/** + Abort an asynchronous transmit or receive request. + + The Cancel() function is used to abort a pending transmit or receive request. + If the token is in the transmit or receive request queues, after calling this + function, Token->Status will be set to EFI_ABORTED and then Token->Event will + be signaled. If the token is not in one of the queues, which usually means the + asynchronous operation has completed, this function will not signal the token + and EFI_NOT_FOUND is returned. + + @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. + @param[in] Token Pointer to a token that has been issued by + EFI_IP4_PROTOCOL.Transmit() or + EFI_IP4_PROTOCOL.Receive(). If NULL, all pending + tokens are aborted. Type EFI_IP4_COMPLETION_TOKEN is + defined in EFI_IP4_PROTOCOL.Transmit(). + + @retval EFI_SUCCESS The asynchronous I/O request was aborted and + Token.->Event was signaled. When Token is NULL, all + pending requests were aborted and their events were signaled. + @retval EFI_INVALID_PARAMETER This is NULL. + @retval EFI_NOT_STARTED This instance has not been started. + @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, + RARP, etc.) is not finished yet. + @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O request was + not found in the transmit or receive queue. It has either completed + or was not issued by Transmit() and Receive(). + +**/ +EFI_STATUS +EFIAPI +EfiIp4Cancel ( + IN EFI_IP4_PROTOCOL *This, + IN EFI_IP4_COMPLETION_TOKEN *Token OPTIONAL + ) +{ + IP4_PROTOCOL *IpInstance; + EFI_STATUS Status; + EFI_TPL OldTpl; + + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This); + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + if (IpInstance->State != IP4_STATE_CONFIGED) { + Status = EFI_NOT_STARTED; + goto ON_EXIT; + } + + if (IpInstance->ConfigData.UseDefaultAddress && IP4_NO_MAPPING (IpInstance)) { + Status = EFI_NO_MAPPING; + goto ON_EXIT; + } + + Status = Ip4Cancel (IpInstance, Token); + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + return Status; +} + + +/** + Polls for incoming data packets and processes outgoing data packets. + + The Poll() function polls for incoming data packets and processes outgoing data + packets. Network drivers and applications can call the EFI_IP4_PROTOCOL.Poll() + function to increase the rate that data packets are moved between the communications + device and the transmit and receive queues. + + In some systems the periodic timer event may not poll the underlying communications + device fast enough to transmit and/or receive all data packets without missing + incoming packets or dropping outgoing packets. Drivers and applications that are + experiencing packet loss should try calling the EFI_IP4_PROTOCOL.Poll() function + more often. + + @param[in] This Pointer to the EFI_IP4_PROTOCOL instance. + + @retval EFI_SUCCESS Incoming or outgoing data was processed. + @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started. + @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, + RARP, etc.) is not finished yet. + @retval EFI_INVALID_PARAMETER This is NULL. + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. + @retval EFI_NOT_READY No incoming or outgoing data is processed. + @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue. + Consider increasing the polling rate. + +**/ +EFI_STATUS +EFIAPI +EfiIp4Poll ( + IN EFI_IP4_PROTOCOL *This + ) +{ + IP4_PROTOCOL *IpInstance; + EFI_MANAGED_NETWORK_PROTOCOL *Mnp; + + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + IpInstance = IP4_INSTANCE_FROM_PROTOCOL (This); + + if (IpInstance->State == IP4_STATE_UNCONFIGED) { + return EFI_NOT_STARTED; + } + + Mnp = IpInstance->Service->Mnp; + + // + // Don't lock the Poll function to enable the deliver of + // the packet polled up. + // + return Mnp->Poll (Mnp); +} + +/** + Decrease the life of the transmitted packets. If it is + decreased to zero, cancel the packet. This function is + called by Ip4PacketTimerTicking which time out both the + received-but-not-delivered and transmitted-but-not-recycle + packets. + + @param[in] Map The IP4 child's transmit map. + @param[in] Item Current transmitted packet. + @param[in] Context Not used. + + @retval EFI_SUCCESS Always returns EFI_SUCCESS. + +**/ +EFI_STATUS +EFIAPI +Ip4SentPacketTicking ( + IN NET_MAP *Map, + IN NET_MAP_ITEM *Item, + IN VOID *Context + ) +{ + IP4_TXTOKEN_WRAP *Wrap; + + Wrap = (IP4_TXTOKEN_WRAP *) Item->Value; + ASSERT (Wrap != NULL); + + if ((Wrap->Life > 0) && (--Wrap->Life == 0)) { + Ip4CancelPacket (Wrap->IpInstance->Interface, Wrap->Packet, EFI_ABORTED); + } + + return EFI_SUCCESS; +} + +/** + This heart beat timer of IP4 service instance times out all of its IP4 children's + received-but-not-delivered and transmitted-but-not-recycle packets, and provides + time input for its IGMP protocol. + + @param[in] Event The IP4 service instance's heart beat timer. + @param[in] Context The IP4 service instance. + +**/ +VOID +EFIAPI +Ip4TimerTicking ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + IP4_SERVICE *IpSb; + + IpSb = (IP4_SERVICE *) Context; + NET_CHECK_SIGNATURE (IpSb, IP4_SERVICE_SIGNATURE); + + Ip4PacketTimerTicking (IpSb); + Ip4IgmpTicking (IpSb); +} + +/** + This dedicated timer is used to poll underlying network media status. In case + of cable swap or wireless network switch, a new round auto configuration will + be initiated. The timer will signal the IP4 to run DHCP configuration again. + IP4 driver will free old IP address related resource, such as route table and + Interface, then initiate a DHCP process to acquire new IP, eventually create + route table for new IP address. + + @param[in] Event The IP4 service instance's heart beat timer. + @param[in] Context The IP4 service instance. + +**/ +VOID +EFIAPI +Ip4TimerReconfigChecking ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + IP4_SERVICE *IpSb; + BOOLEAN OldMediaPresent; + EFI_STATUS Status; + EFI_SIMPLE_NETWORK_MODE SnpModeData; + + IpSb = (IP4_SERVICE *) Context; + NET_CHECK_SIGNATURE (IpSb, IP4_SERVICE_SIGNATURE); + + OldMediaPresent = IpSb->MediaPresent; + + // + // Get fresh mode data from MNP, since underlying media status may change. + // Here, it needs to mention that the MediaPresent can also be checked even if + // EFI_NOT_STARTED returned while this MNP child driver instance isn't configured. + // + Status = IpSb->Mnp->GetModeData (IpSb->Mnp, NULL, &SnpModeData); + if (EFI_ERROR (Status) && (Status != EFI_NOT_STARTED)) { + return; + } + + IpSb->MediaPresent = SnpModeData.MediaPresent; + // + // Media transimit Unpresent to Present means new link movement is detected. + // + if (!OldMediaPresent && IpSb->MediaPresent && (IpSb->Ip4Config2Instance.Policy == Ip4Config2PolicyDhcp)) { + // + // Signal the IP4 to run the dhcp configuration again. IP4 driver will free + // old IP address related resource, such as route table and Interface, then + // initiate a DHCP round to acquire new IP, eventually + // create route table for new IP address. + // + if (IpSb->ReconfigEvent != NULL) { + Status = gBS->SignalEvent (IpSb->ReconfigEvent); + DispatchDpc (); + } + } +} diff --git a/NetworkPkg/Ip4Dxe/Ip4Impl.h b/NetworkPkg/Ip4Dxe/Ip4Impl.h new file mode 100644 index 0000000000..a322a85981 --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4Impl.h @@ -0,0 +1,417 @@ +/** @file + Ip4 internal functions and type defintions. + +Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
+(C) Copyright 2015 Hewlett-Packard Development Company, L.P.
+ +SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef __EFI_IP4_IMPL_H__ +#define __EFI_IP4_IMPL_H__ + +#include + +#include +#include +#include +#include +#include +#include +#include +#include + +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "Ip4Common.h" +#include "Ip4Driver.h" +#include "Ip4If.h" +#include "Ip4Icmp.h" +#include "Ip4Option.h" +#include "Ip4Igmp.h" +#include "Ip4Route.h" +#include "Ip4Input.h" +#include "Ip4Output.h" +#include "Ip4Config2Impl.h" +#include "Ip4Config2Nv.h" +#include "Ip4NvData.h" + +#define IP4_PROTOCOL_SIGNATURE SIGNATURE_32 ('I', 'P', '4', 'P') +#define IP4_SERVICE_SIGNATURE SIGNATURE_32 ('I', 'P', '4', 'S') + +// +// The state of IP4 protocol. It starts from UNCONFIGED. if it is +// successfully configured, it goes to CONFIGED. if configure NULL +// is called, it becomes UNCONFIGED again. +// +#define IP4_STATE_UNCONFIGED 0 +#define IP4_STATE_CONFIGED 1 + +// +// The state of IP4 service. It starts from UNSTARTED. It transits +// to STARTED if autoconfigure is started. If default address is +// configured, it becomes CONFIGED. and if partly destroyed, it goes +// to DESTROY. +// +#define IP4_SERVICE_UNSTARTED 0 +#define IP4_SERVICE_STARTED 1 +#define IP4_SERVICE_CONFIGED 2 +#define IP4_SERVICE_DESTROY 3 + + +/// +/// IP4_TXTOKEN_WRAP wraps the upper layer's transmit token. +/// The user's data is kept in the Packet. When fragment is +/// needed, each fragment of the Packet has a reference to the +/// Packet, no data is actually copied. The Packet will be +/// released when all the fragments of it have been recycled by +/// MNP. Upon then, the IP4_TXTOKEN_WRAP will be released, and +/// user's event signalled. +/// +typedef struct { + IP4_PROTOCOL *IpInstance; + EFI_IP4_COMPLETION_TOKEN *Token; + EFI_EVENT IpSecRecycleSignal; + NET_BUF *Packet; + BOOLEAN Sent; + INTN Life; +} IP4_TXTOKEN_WRAP; + +/// +/// IP4_IPSEC_WRAP wraps the packet received from MNP layer. The packet +/// will be released after it has been processed by the receiver. Upon then, +/// the IP4_IPSEC_WRAP will be released, and the IpSecRecycleSignal will be signaled +/// to notice IPsec to free the resources. +/// +typedef struct { + EFI_EVENT IpSecRecycleSignal; + NET_BUF *Packet; +} IP4_IPSEC_WRAP; + +/// +/// IP4_RXDATA_WRAP wraps the data IP4 child delivers to the +/// upper layers. The received packet is kept in the Packet. +/// The Packet itself may be constructured from some fragments. +/// All the fragments of the Packet is organized by a +/// IP4_ASSEMBLE_ENTRY structure. If the Packet is recycled by +/// the upper layer, the assemble entry and its associated +/// fragments will be freed at last. +/// +typedef struct { + LIST_ENTRY Link; + IP4_PROTOCOL *IpInstance; + NET_BUF *Packet; + EFI_IP4_RECEIVE_DATA RxData; +} IP4_RXDATA_WRAP; + + +struct _IP4_PROTOCOL { + UINT32 Signature; + + EFI_IP4_PROTOCOL Ip4Proto; + EFI_HANDLE Handle; + INTN State; + + BOOLEAN InDestroy; + + IP4_SERVICE *Service; + LIST_ENTRY Link; // Link to all the IP protocol from the service + + // + // User's transmit/receive tokens, and received/deliverd packets + // + NET_MAP RxTokens; + NET_MAP TxTokens; // map between (User's Token, IP4_TXTOKE_WRAP) + LIST_ENTRY Received; // Received but not delivered packet + LIST_ENTRY Delivered; // Delivered and to be recycled packets + EFI_LOCK RecycleLock; + + // + // Instance's address and route tables. There are two route tables. + // RouteTable is used by the IP4 driver to route packet. EfiRouteTable + // is used to communicate the current route info to the upper layer. + // + IP4_INTERFACE *Interface; + LIST_ENTRY AddrLink; // Ip instances with the same IP address. + IP4_ROUTE_TABLE *RouteTable; + + EFI_IP4_ROUTE_TABLE *EfiRouteTable; + UINT32 EfiRouteCount; + + // + // IGMP data for this instance + // + IP4_ADDR *Groups; // stored in network byte order + UINT32 GroupCount; + + EFI_IP4_CONFIG_DATA ConfigData; + +}; + +struct _IP4_SERVICE { + UINT32 Signature; + EFI_SERVICE_BINDING_PROTOCOL ServiceBinding; + INTN State; + + // + // List of all the IP instances and interfaces, and default + // interface and route table and caches. + // + UINTN NumChildren; + LIST_ENTRY Children; + + LIST_ENTRY Interfaces; + + IP4_INTERFACE *DefaultInterface; + IP4_ROUTE_TABLE *DefaultRouteTable; + + // + // Ip reassemble utilities, and IGMP data + // + IP4_ASSEMBLE_TABLE Assemble; + IGMP_SERVICE_DATA IgmpCtrl; + + // + // Low level protocol used by this service instance + // + EFI_HANDLE Image; + EFI_HANDLE Controller; + + EFI_HANDLE MnpChildHandle; + EFI_MANAGED_NETWORK_PROTOCOL *Mnp; + + EFI_MANAGED_NETWORK_CONFIG_DATA MnpConfigData; + EFI_SIMPLE_NETWORK_MODE SnpMode; + + EFI_EVENT Timer; + EFI_EVENT ReconfigCheckTimer; + EFI_EVENT ReconfigEvent; + + BOOLEAN Reconfig; + + // + // Underlying media present status. + // + BOOLEAN MediaPresent; + + // + // IPv4 Configuration II Protocol instance + // + IP4_CONFIG2_INSTANCE Ip4Config2Instance; + + CHAR16 *MacString; + + UINT32 MaxPacketSize; + UINT32 OldMaxPacketSize; ///< The MTU before IPsec enable. +}; + +#define IP4_INSTANCE_FROM_PROTOCOL(Ip4) \ + CR ((Ip4), IP4_PROTOCOL, Ip4Proto, IP4_PROTOCOL_SIGNATURE) + +#define IP4_SERVICE_FROM_PROTOCOL(Sb) \ + CR ((Sb), IP4_SERVICE, ServiceBinding, IP4_SERVICE_SIGNATURE) + +#define IP4_SERVICE_FROM_CONFIG2_INSTANCE(This) \ + CR (This, IP4_SERVICE, Ip4Config2Instance, IP4_SERVICE_SIGNATURE) + + +#define IP4_NO_MAPPING(IpInstance) (!(IpInstance)->Interface->Configured) + +extern EFI_IP4_PROTOCOL mEfiIp4ProtocolTemplete; + +/** + Config the MNP parameter used by IP. The IP driver use one MNP + child to transmit/receive frames. By default, it configures MNP + to receive unicast/multicast/broadcast. And it will enable/disable + the promiscous receive according to whether there is IP child + enable that or not. If Force is FALSE, it will iterate through + all the IP children to check whether the promiscuous receive + setting has been changed. If it hasn't been changed, it won't + reconfigure the MNP. If Force is TRUE, the MNP is configured no + matter whether that is changed or not. + + @param[in] IpSb The IP4 service instance that is to be changed. + @param[in] Force Force the configuration or not. + + @retval EFI_SUCCESS The MNP is successfully configured/reconfigured. + @retval Others Configuration failed. + +**/ +EFI_STATUS +Ip4ServiceConfigMnp ( + IN IP4_SERVICE *IpSb, + IN BOOLEAN Force + ); + +/** + Intiialize the IP4_PROTOCOL structure to the unconfigured states. + + @param IpSb The IP4 service instance. + @param IpInstance The IP4 child instance. + +**/ +VOID +Ip4InitProtocol ( + IN IP4_SERVICE *IpSb, + IN OUT IP4_PROTOCOL *IpInstance + ); + +/** + Clean up the IP4 child, release all the resources used by it. + + @param[in] IpInstance The IP4 child to clean up. + + @retval EFI_SUCCESS The IP4 child is cleaned up. + @retval EFI_DEVICE_ERROR Some resources failed to be released. + +**/ +EFI_STATUS +Ip4CleanProtocol ( + IN IP4_PROTOCOL *IpInstance + ); + +/** + Cancel the user's receive/transmit request. + + @param[in] IpInstance The IP4 child. + @param[in] Token The token to cancel. If NULL, all token will be + cancelled. + + @retval EFI_SUCCESS The token is cancelled. + @retval EFI_NOT_FOUND The token isn't found on either the + transmit/receive queue. + @retval EFI_DEVICE_ERROR Not all token is cancelled when Token is NULL. + +**/ +EFI_STATUS +Ip4Cancel ( + IN IP4_PROTOCOL *IpInstance, + IN EFI_IP4_COMPLETION_TOKEN *Token OPTIONAL + ); + +/** + Change the IP4 child's multicast setting. The caller + should make sure that the parameters is valid. + + @param[in] IpInstance The IP4 child to change the setting. + @param[in] JoinFlag TRUE to join the group, otherwise leave it + @param[in] GroupAddress The target group address + + @retval EFI_ALREADY_STARTED Want to join the group, but already a member of it + @retval EFI_OUT_OF_RESOURCES Failed to allocate some resources. + @retval EFI_DEVICE_ERROR Failed to set the group configuraton + @retval EFI_SUCCESS Successfully updated the group setting. + @retval EFI_NOT_FOUND Try to leave the group which it isn't a member. + +**/ +EFI_STATUS +Ip4Groups ( + IN IP4_PROTOCOL *IpInstance, + IN BOOLEAN JoinFlag, + IN EFI_IPv4_ADDRESS *GroupAddress OPTIONAL + ); + +/** + This heart beat timer of IP4 service instance times out all of its IP4 children's + received-but-not-delivered and transmitted-but-not-recycle packets, and provides + time input for its IGMP protocol. + + @param[in] Event The IP4 service instance's heart beat timer. + @param[in] Context The IP4 service instance. + +**/ +VOID +EFIAPI +Ip4TimerTicking ( + IN EFI_EVENT Event, + IN VOID *Context + ); + +/** + This dedicated timer is used to poll underlying network media status. In case + of cable swap or wireless network switch, a new round auto configuration will + be initiated. The timer will signal the IP4 to run DHCP configuration again. + IP4 driver will free old IP address related resource, such as route table and + Interface, then initiate a DHCP process to acquire new IP, eventually create + route table for new IP address. + + @param[in] Event The IP4 service instance's heart beat timer. + @param[in] Context The IP4 service instance. + +**/ +VOID +EFIAPI +Ip4TimerReconfigChecking ( + IN EFI_EVENT Event, + IN VOID *Context + ); + +/** + Decrease the life of the transmitted packets. If it is + decreased to zero, cancel the packet. This function is + called by Ip4PacketTimerTicking which time out both the + received-but-not-delivered and transmitted-but-not-recycle + packets. + + @param[in] Map The IP4 child's transmit map. + @param[in] Item Current transmitted packet. + @param[in] Context Not used. + + @retval EFI_SUCCESS Always returns EFI_SUCCESS. + +**/ +EFI_STATUS +EFIAPI +Ip4SentPacketTicking ( + IN NET_MAP *Map, + IN NET_MAP_ITEM *Item, + IN VOID *Context + ); + +/** + The callback function for the net buffer which wraps the user's + transmit token. Although it seems this function is pretty simple, + there are some subtle things. + When user requests the IP to transmit a packet by passing it a + token, the token is wrapped in an IP4_TXTOKEN_WRAP and the data + is wrapped in an net buffer. the net buffer's Free function is + set to Ip4FreeTxToken. The Token and token wrap are added to the + IP child's TxToken map. Then the buffer is passed to Ip4Output for + transmission. If something error happened before that, the buffer + is freed, which in turn will free the token wrap. The wrap may + have been added to the TxToken map or not, and the user's event + shouldn't be fired because we are still in the EfiIp4Transmit. If + the buffer has been sent by Ip4Output, it should be removed from + the TxToken map and user's event signaled. The token wrap and buffer + are bound together. Check the comments in Ip4Output for information + about IP fragmentation. + + @param[in] Context The token's wrap. + +**/ +VOID +EFIAPI +Ip4FreeTxToken ( + IN VOID *Context + ); + +extern EFI_IPSEC2_PROTOCOL *mIpSec; +extern BOOLEAN mIpSec2Installed; + +#endif diff --git a/NetworkPkg/Ip4Dxe/Ip4Input.c b/NetworkPkg/Ip4Dxe/Ip4Input.c new file mode 100644 index 0000000000..24c5846588 --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4Input.c @@ -0,0 +1,1597 @@ +/** @file + IP4 input process. + +Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
+(C) Copyright 2015 Hewlett-Packard Development Company, L.P.
+ +SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Ip4Impl.h" + + +/** + Create an empty assemble entry for the packet identified by + (Dst, Src, Id, Protocol). The default life for the packet is + 120 seconds. + + @param[in] Dst The destination address + @param[in] Src The source address + @param[in] Id The ID field in IP header + @param[in] Protocol The protocol field in IP header + + @return NULL if failed to allocate memory for the entry, otherwise + the point to just created reassemble entry. + +**/ +IP4_ASSEMBLE_ENTRY * +Ip4CreateAssembleEntry ( + IN IP4_ADDR Dst, + IN IP4_ADDR Src, + IN UINT16 Id, + IN UINT8 Protocol + ) +{ + + IP4_ASSEMBLE_ENTRY *Assemble; + + Assemble = AllocatePool (sizeof (IP4_ASSEMBLE_ENTRY)); + + if (Assemble == NULL) { + return NULL; + } + + InitializeListHead (&Assemble->Link); + InitializeListHead (&Assemble->Fragments); + + Assemble->Dst = Dst; + Assemble->Src = Src; + Assemble->Id = Id; + Assemble->Protocol = Protocol; + Assemble->TotalLen = 0; + Assemble->CurLen = 0; + Assemble->Head = NULL; + Assemble->Info = NULL; + Assemble->Life = IP4_FRAGMENT_LIFE; + + return Assemble; +} + + +/** + Release all the fragments of a packet, then free the assemble entry. + + @param[in] Assemble The assemble entry to free + +**/ +VOID +Ip4FreeAssembleEntry ( + IN IP4_ASSEMBLE_ENTRY *Assemble + ) +{ + LIST_ENTRY *Entry; + LIST_ENTRY *Next; + NET_BUF *Fragment; + + NET_LIST_FOR_EACH_SAFE (Entry, Next, &Assemble->Fragments) { + Fragment = NET_LIST_USER_STRUCT (Entry, NET_BUF, List); + + RemoveEntryList (Entry); + NetbufFree (Fragment); + } + + FreePool (Assemble); +} + + +/** + Initialize an already allocated assemble table. This is generally + the assemble table embedded in the IP4 service instance. + + @param[in, out] Table The assemble table to initialize. + +**/ +VOID +Ip4InitAssembleTable ( + IN OUT IP4_ASSEMBLE_TABLE *Table + ) +{ + UINT32 Index; + + for (Index = 0; Index < IP4_ASSEMLE_HASH_SIZE; Index++) { + InitializeListHead (&Table->Bucket[Index]); + } +} + + +/** + Clean up the assemble table: remove all the fragments + and assemble entries. + + @param[in] Table The assemble table to clean up + +**/ +VOID +Ip4CleanAssembleTable ( + IN IP4_ASSEMBLE_TABLE *Table + ) +{ + LIST_ENTRY *Entry; + LIST_ENTRY *Next; + IP4_ASSEMBLE_ENTRY *Assemble; + UINT32 Index; + + for (Index = 0; Index < IP4_ASSEMLE_HASH_SIZE; Index++) { + NET_LIST_FOR_EACH_SAFE (Entry, Next, &Table->Bucket[Index]) { + Assemble = NET_LIST_USER_STRUCT (Entry, IP4_ASSEMBLE_ENTRY, Link); + + RemoveEntryList (Entry); + Ip4FreeAssembleEntry (Assemble); + } + } +} + + +/** + Trim the packet to fit in [Start, End), and update the per + packet information. + + @param Packet Packet to trim + @param Start The sequence of the first byte to fit in + @param End One beyond the sequence of last byte to fit in. + +**/ +VOID +Ip4TrimPacket ( + IN OUT NET_BUF *Packet, + IN INTN Start, + IN INTN End + ) +{ + IP4_CLIP_INFO *Info; + INTN Len; + + Info = IP4_GET_CLIP_INFO (Packet); + + ASSERT (Info->Start + Info->Length == Info->End); + ASSERT ((Info->Start < End) && (Start < Info->End)); + + if (Info->Start < Start) { + Len = Start - Info->Start; + + NetbufTrim (Packet, (UINT32) Len, NET_BUF_HEAD); + Info->Start = Start; + Info->Length -= Len; + } + + if (End < Info->End) { + Len = End - Info->End; + + NetbufTrim (Packet, (UINT32) Len, NET_BUF_TAIL); + Info->End = End; + Info->Length -= Len; + } +} + + +/** + Release all the fragments of the packet. This is the callback for + the assembled packet's OnFree. It will free the assemble entry, + which in turn will free all the fragments of the packet. + + @param[in] Arg The assemble entry to free + +**/ +VOID +EFIAPI +Ip4OnFreeFragments ( + IN VOID *Arg + ) +{ + Ip4FreeAssembleEntry ((IP4_ASSEMBLE_ENTRY *) Arg); +} + + +/** + Reassemble the IP fragments. If all the fragments of the packet + have been received, it will wrap the packet in a net buffer then + return it to caller. If the packet can't be assembled, NULL is + return. + + @param Table The assemble table used. New assemble entry will be created + if the Packet is from a new chain of fragments. + @param Packet The fragment to assemble. It might be freed if the fragment + can't be re-assembled. + + @return NULL if the packet can't be reassemble. The point to just assembled + packet if all the fragments of the packet have arrived. + +**/ +NET_BUF * +Ip4Reassemble ( + IN OUT IP4_ASSEMBLE_TABLE *Table, + IN OUT NET_BUF *Packet + ) +{ + IP4_HEAD *IpHead; + IP4_CLIP_INFO *This; + IP4_CLIP_INFO *Node; + IP4_ASSEMBLE_ENTRY *Assemble; + LIST_ENTRY *Head; + LIST_ENTRY *Prev; + LIST_ENTRY *Cur; + NET_BUF *Fragment; + NET_BUF *NewPacket; + INTN Index; + + IpHead = Packet->Ip.Ip4; + This = IP4_GET_CLIP_INFO (Packet); + + ASSERT (IpHead != NULL); + + // + // First: find the related assemble entry + // + Assemble = NULL; + Index = IP4_ASSEMBLE_HASH (IpHead->Dst, IpHead->Src, IpHead->Id, IpHead->Protocol); + + NET_LIST_FOR_EACH (Cur, &Table->Bucket[Index]) { + Assemble = NET_LIST_USER_STRUCT (Cur, IP4_ASSEMBLE_ENTRY, Link); + + if ((Assemble->Dst == IpHead->Dst) && (Assemble->Src == IpHead->Src) && + (Assemble->Id == IpHead->Id) && (Assemble->Protocol == IpHead->Protocol)) { + break; + } + } + + // + // Create a new assemble entry if no assemble entry is related to this packet + // + if (Cur == &Table->Bucket[Index]) { + Assemble = Ip4CreateAssembleEntry ( + IpHead->Dst, + IpHead->Src, + IpHead->Id, + IpHead->Protocol + ); + + if (Assemble == NULL) { + goto DROP; + } + + InsertHeadList (&Table->Bucket[Index], &Assemble->Link); + } + // + // Assemble shouldn't be NULL here + // + ASSERT (Assemble != NULL); + + // + // Find the point to insert the packet: before the first + // fragment with THIS.Start < CUR.Start. the previous one + // has PREV.Start <= THIS.Start < CUR.Start. + // + Head = &Assemble->Fragments; + + NET_LIST_FOR_EACH (Cur, Head) { + Fragment = NET_LIST_USER_STRUCT (Cur, NET_BUF, List); + + if (This->Start < IP4_GET_CLIP_INFO (Fragment)->Start) { + break; + } + } + + // + // Check whether the current fragment overlaps with the previous one. + // It holds that: PREV.Start <= THIS.Start < THIS.End. Only need to + // check whether THIS.Start < PREV.End for overlap. If two fragments + // overlaps, trim the overlapped part off THIS fragment. + // + if ((Prev = Cur->BackLink) != Head) { + Fragment = NET_LIST_USER_STRUCT (Prev, NET_BUF, List); + Node = IP4_GET_CLIP_INFO (Fragment); + + if (This->Start < Node->End) { + if (This->End <= Node->End) { + NetbufFree (Packet); + return NULL; + } + + Ip4TrimPacket (Packet, Node->End, This->End); + } + } + + // + // Insert the fragment into the packet. The fragment may be removed + // from the list by the following checks. + // + NetListInsertBefore (Cur, &Packet->List); + + // + // Check the packets after the insert point. It holds that: + // THIS.Start <= NODE.Start < NODE.End. The equality holds + // if PREV and NEXT are continuous. THIS fragment may fill + // several holes. Remove the completely overlapped fragments + // + while (Cur != Head) { + Fragment = NET_LIST_USER_STRUCT (Cur, NET_BUF, List); + Node = IP4_GET_CLIP_INFO (Fragment); + + // + // Remove fragments completely overlapped by this fragment + // + if (Node->End <= This->End) { + Cur = Cur->ForwardLink; + + RemoveEntryList (&Fragment->List); + Assemble->CurLen -= Node->Length; + + NetbufFree (Fragment); + continue; + } + + // + // The conditions are: THIS.Start <= NODE.Start, and THIS.End < + // NODE.End. Two fragments overlaps if NODE.Start < THIS.End. + // If two fragments start at the same offset, remove THIS fragment + // because ((THIS.Start == NODE.Start) && (THIS.End < NODE.End)). + // + if (Node->Start < This->End) { + if (This->Start == Node->Start) { + RemoveEntryList (&Packet->List); + goto DROP; + } + + Ip4TrimPacket (Packet, This->Start, Node->Start); + } + + break; + } + + // + // Update the assemble info: increase the current length. If it is + // the frist fragment, update the packet's IP head and per packet + // info. If it is the last fragment, update the total length. + // + Assemble->CurLen += This->Length; + + if (This->Start == 0) { + // + // Once the first fragment is enqueued, it can't be removed + // from the fragment list. So, Assemble->Head always point + // to valid memory area. + // + ASSERT (Assemble->Head == NULL); + + Assemble->Head = IpHead; + Assemble->Info = IP4_GET_CLIP_INFO (Packet); + } + + // + // Don't update the length more than once. + // + if (IP4_LAST_FRAGMENT (IpHead->Fragment) && (Assemble->TotalLen == 0)) { + Assemble->TotalLen = This->End; + } + + // + // Deliver the whole packet if all the fragments received. + // All fragments received if: + // 1. received the last one, so, the total length is know + // 2. received all the data. If the last fragment on the + // queue ends at the total length, all data is received. + // + if ((Assemble->TotalLen != 0) && (Assemble->CurLen >= Assemble->TotalLen)) { + + RemoveEntryList (&Assemble->Link); + + // + // If the packet is properly formated, the last fragment's End + // equals to the packet's total length. Otherwise, the packet + // is a fake, drop it now. + // + Fragment = NET_LIST_USER_STRUCT (Head->BackLink, NET_BUF, List); + + if (IP4_GET_CLIP_INFO (Fragment)->End != Assemble->TotalLen) { + Ip4FreeAssembleEntry (Assemble); + return NULL; + } + + // + // Wrap the packet in a net buffer then deliver it up + // + NewPacket = NetbufFromBufList ( + &Assemble->Fragments, + 0, + 0, + Ip4OnFreeFragments, + Assemble + ); + + if (NewPacket == NULL) { + Ip4FreeAssembleEntry (Assemble); + return NULL; + } + + NewPacket->Ip.Ip4 = Assemble->Head; + + ASSERT (Assemble->Info != NULL); + + CopyMem ( + IP4_GET_CLIP_INFO (NewPacket), + Assemble->Info, + sizeof (*IP4_GET_CLIP_INFO (NewPacket)) + ); + + return NewPacket; + } + + return NULL; + +DROP: + NetbufFree (Packet); + return NULL; +} + +/** + The callback function for the net buffer which wraps the packet processed by + IPsec. It releases the wrap packet and also signals IPsec to free the resources. + + @param[in] Arg The wrap context + +**/ +VOID +EFIAPI +Ip4IpSecFree ( + IN VOID *Arg + ) +{ + IP4_IPSEC_WRAP *Wrap; + + Wrap = (IP4_IPSEC_WRAP *) Arg; + + if (Wrap->IpSecRecycleSignal != NULL) { + gBS->SignalEvent (Wrap->IpSecRecycleSignal); + } + + NetbufFree (Wrap->Packet); + + FreePool (Wrap); + + return; +} + +/** + The work function to locate IPsec protocol to process the inbound or + outbound IP packets. The process routine handls the packet with following + actions: bypass the packet, discard the packet, or protect the packet. + + @param[in] IpSb The IP4 service instance. + @param[in, out] Head The The caller supplied IP4 header. + @param[in, out] Netbuf The IP4 packet to be processed by IPsec. + @param[in, out] Options The caller supplied options. + @param[in, out] OptionsLen The length of the option. + @param[in] Direction The directionality in an SPD entry, + EfiIPsecInBound or EfiIPsecOutBound. + @param[in] Context The token's wrap. + + @retval EFI_SUCCESS The IPsec protocol is not available or disabled. + @retval EFI_SUCCESS The packet was bypassed and all buffers remain the same. + @retval EFI_SUCCESS The packet was protected. + @retval EFI_ACCESS_DENIED The packet was discarded. + @retval EFI_OUT_OF_RESOURCES There is no suffcient resource to complete the operation. + @retval EFI_BUFFER_TOO_SMALL The number of non-empty block is bigger than the + number of input data blocks when build a fragment table. + +**/ +EFI_STATUS +Ip4IpSecProcessPacket ( + IN IP4_SERVICE *IpSb, + IN OUT IP4_HEAD **Head, + IN OUT NET_BUF **Netbuf, + IN OUT UINT8 **Options, + IN OUT UINT32 *OptionsLen, + IN EFI_IPSEC_TRAFFIC_DIR Direction, + IN VOID *Context + ) +{ + NET_FRAGMENT *FragmentTable; + NET_FRAGMENT *OriginalFragmentTable; + UINT32 FragmentCount; + UINT32 OriginalFragmentCount; + EFI_EVENT RecycleEvent; + NET_BUF *Packet; + IP4_TXTOKEN_WRAP *TxWrap; + IP4_IPSEC_WRAP *IpSecWrap; + EFI_STATUS Status; + IP4_HEAD ZeroHead; + + Status = EFI_SUCCESS; + + if (!mIpSec2Installed) { + goto ON_EXIT; + } + ASSERT (mIpSec != NULL); + + Packet = *Netbuf; + RecycleEvent = NULL; + IpSecWrap = NULL; + FragmentTable = NULL; + TxWrap = (IP4_TXTOKEN_WRAP *) Context; + FragmentCount = Packet->BlockOpNum; + + ZeroMem (&ZeroHead, sizeof (IP4_HEAD)); + + // + // Check whether the IPsec enable variable is set. + // + if (mIpSec->DisabledFlag) { + // + // If IPsec is disabled, restore the original MTU + // + IpSb->MaxPacketSize = IpSb->OldMaxPacketSize; + goto ON_EXIT; + } else { + // + // If IPsec is enabled, use the MTU which reduce the IPsec header length. + // + IpSb->MaxPacketSize = IpSb->OldMaxPacketSize - IP4_MAX_IPSEC_HEADLEN; + } + + // + // Rebuild fragment table from netbuf to ease IPsec process. + // + FragmentTable = AllocateZeroPool (FragmentCount * sizeof (NET_FRAGMENT)); + + if (FragmentTable == NULL) { + Status = EFI_OUT_OF_RESOURCES; + goto ON_EXIT; + } + + Status = NetbufBuildExt (Packet, FragmentTable, &FragmentCount); + + // + // Record the original FragmentTable and count. + // + OriginalFragmentTable = FragmentTable; + OriginalFragmentCount = FragmentCount; + + if (EFI_ERROR (Status)) { + FreePool (FragmentTable); + goto ON_EXIT; + } + + // + // Convert host byte order to network byte order + // + Ip4NtohHead (*Head); + + Status = mIpSec->ProcessExt ( + mIpSec, + IpSb->Controller, + IP_VERSION_4, + (VOID *) (*Head), + &(*Head)->Protocol, + (VOID **) Options, + OptionsLen, + (EFI_IPSEC_FRAGMENT_DATA **) (&FragmentTable), + &FragmentCount, + Direction, + &RecycleEvent + ); + // + // Convert back to host byte order + // + Ip4NtohHead (*Head); + + if (EFI_ERROR (Status)) { + FreePool (OriginalFragmentTable); + goto ON_EXIT; + } + + if (OriginalFragmentTable == FragmentTable && OriginalFragmentCount == FragmentCount) { + // + // For ByPass Packet + // + FreePool (FragmentTable); + goto ON_EXIT; + } else { + // + // Free the FragmentTable which allocated before calling the IPsec. + // + FreePool (OriginalFragmentTable); + } + + if (Direction == EfiIPsecOutBound && TxWrap != NULL) { + + TxWrap->IpSecRecycleSignal = RecycleEvent; + TxWrap->Packet = NetbufFromExt ( + FragmentTable, + FragmentCount, + IP4_MAX_HEADLEN, + 0, + Ip4FreeTxToken, + TxWrap + ); + if (TxWrap->Packet == NULL) { + // + // Recover the TxWrap->Packet, if meet a error, and the caller will free + // the TxWrap. + // + TxWrap->Packet = *Netbuf; + Status = EFI_OUT_OF_RESOURCES; + goto ON_EXIT; + } + + // + // Free orginal Netbuf. + // + NetIpSecNetbufFree (*Netbuf); + *Netbuf = TxWrap->Packet; + + } else { + + IpSecWrap = AllocateZeroPool (sizeof (IP4_IPSEC_WRAP)); + + if (IpSecWrap == NULL) { + Status = EFI_OUT_OF_RESOURCES; + gBS->SignalEvent (RecycleEvent); + goto ON_EXIT; + } + + IpSecWrap->IpSecRecycleSignal = RecycleEvent; + IpSecWrap->Packet = Packet; + Packet = NetbufFromExt ( + FragmentTable, + FragmentCount, + IP4_MAX_HEADLEN, + 0, + Ip4IpSecFree, + IpSecWrap + ); + + if (Packet == NULL) { + Packet = IpSecWrap->Packet; + gBS->SignalEvent (RecycleEvent); + FreePool (IpSecWrap); + Status = EFI_OUT_OF_RESOURCES; + goto ON_EXIT; + } + + if (Direction == EfiIPsecInBound && 0 != CompareMem (*Head, &ZeroHead, sizeof (IP4_HEAD))) { + Ip4PrependHead (Packet, *Head, *Options, *OptionsLen); + Ip4NtohHead (Packet->Ip.Ip4); + NetbufTrim (Packet, ((*Head)->HeadLen << 2), TRUE); + + CopyMem ( + IP4_GET_CLIP_INFO (Packet), + IP4_GET_CLIP_INFO (IpSecWrap->Packet), + sizeof (IP4_CLIP_INFO) + ); + } + *Netbuf = Packet; + } + +ON_EXIT: + return Status; +} + +/** + Pre-process the IPv4 packet. First validates the IPv4 packet, and + then reassembles packet if it is necessary. + + @param[in] IpSb Pointer to IP4_SERVICE. + @param[in, out] Packet Pointer to the Packet to be processed. + @param[in] Head Pointer to the IP4_HEAD. + @param[in] Option Pointer to a buffer which contains the IPv4 option. + @param[in] OptionLen The length of Option in bytes. + @param[in] Flag The link layer flag for the packet received, such + as multicast. + + @retval EFI_SEUCCESS The recieved packet is in well form. + @retval EFI_INVAILD_PARAMETER The recieved packet is malformed. + +**/ +EFI_STATUS +Ip4PreProcessPacket ( + IN IP4_SERVICE *IpSb, + IN OUT NET_BUF **Packet, + IN IP4_HEAD *Head, + IN UINT8 *Option, + IN UINT32 OptionLen, + IN UINT32 Flag + ) +{ + IP4_CLIP_INFO *Info; + UINT32 HeadLen; + UINT32 TotalLen; + UINT16 Checksum; + + // + // Check if the IP4 header is correctly formatted. + // + if ((*Packet)->TotalSize < IP4_MIN_HEADLEN) { + return EFI_INVALID_PARAMETER; + } + + HeadLen = (Head->HeadLen << 2); + TotalLen = NTOHS (Head->TotalLen); + + // + // Mnp may deliver frame trailer sequence up, trim it off. + // + if (TotalLen < (*Packet)->TotalSize) { + NetbufTrim (*Packet, (*Packet)->TotalSize - TotalLen, FALSE); + } + + if ((Head->Ver != 4) || (HeadLen < IP4_MIN_HEADLEN) || + (TotalLen < HeadLen) || (TotalLen != (*Packet)->TotalSize)) { + return EFI_INVALID_PARAMETER; + } + + // + // Some OS may send IP packets without checksum. + // + Checksum = (UINT16) (~NetblockChecksum ((UINT8 *) Head, HeadLen)); + + if ((Head->Checksum != 0) && (Checksum != 0)) { + return EFI_INVALID_PARAMETER; + } + + // + // Convert the IP header to host byte order, then get the per packet info. + // + (*Packet)->Ip.Ip4 = Ip4NtohHead (Head); + + Info = IP4_GET_CLIP_INFO (*Packet); + Info->LinkFlag = Flag; + Info->CastType = Ip4GetHostCast (IpSb, Head->Dst, Head->Src); + Info->Start = (Head->Fragment & IP4_HEAD_OFFSET_MASK) << 3; + Info->Length = Head->TotalLen - HeadLen; + Info->End = Info->Start + Info->Length; + Info->Status = EFI_SUCCESS; + + // + // The packet is destinated to us if the CastType is non-zero. + // + if ((Info->CastType == 0) || (Info->End > IP4_MAX_PACKET_SIZE)) { + return EFI_INVALID_PARAMETER; + } + + // + // Validate the options. Don't call the Ip4OptionIsValid if + // there is no option to save some CPU process. + // + + if ((OptionLen > 0) && !Ip4OptionIsValid (Option, OptionLen, TRUE)) { + return EFI_INVALID_PARAMETER; + } + + // + // Trim the head off, after this point, the packet is headless, + // and Packet->TotalLen == Info->Length. + // + NetbufTrim (*Packet, HeadLen, TRUE); + + // + // Reassemble the packet if this is a fragment. The packet is a + // fragment if its head has MF (more fragment) set, or it starts + // at non-zero byte. + // + if (((Head->Fragment & IP4_HEAD_MF_MASK) != 0) || (Info->Start != 0)) { + // + // Drop the fragment if DF is set but it is fragmented. Gateway + // need to send a type 4 destination unreache ICMP message here. + // + if ((Head->Fragment & IP4_HEAD_DF_MASK) != 0) { + return EFI_INVALID_PARAMETER; + } + + // + // The length of all but the last fragments is in the unit of 8 bytes. + // + if (((Head->Fragment & IP4_HEAD_MF_MASK) != 0) && (Info->Length % 8 != 0)) { + return EFI_INVALID_PARAMETER; + } + + *Packet = Ip4Reassemble (&IpSb->Assemble, *Packet); + + // + // Packet assembly isn't complete, start receive more packet. + // + if (*Packet == NULL) { + return EFI_INVALID_PARAMETER; + } + } + + return EFI_SUCCESS; +} + +/** + The IP4 input routine. It is called by the IP4_INTERFACE when a + IP4 fragment is received from MNP. + + @param[in] Ip4Instance The IP4 child that request the receive, most like + it is NULL. + @param[in] Packet The IP4 packet received. + @param[in] IoStatus The return status of receive request. + @param[in] Flag The link layer flag for the packet received, such + as multicast. + @param[in] Context The IP4 service instance that own the MNP. + +**/ +VOID +Ip4AccpetFrame ( + IN IP4_PROTOCOL *Ip4Instance, + IN NET_BUF *Packet, + IN EFI_STATUS IoStatus, + IN UINT32 Flag, + IN VOID *Context + ) +{ + IP4_SERVICE *IpSb; + IP4_HEAD *Head; + EFI_STATUS Status; + IP4_HEAD ZeroHead; + UINT8 *Option; + UINT32 OptionLen; + + IpSb = (IP4_SERVICE *) Context; + Option = NULL; + + if (EFI_ERROR (IoStatus) || (IpSb->State == IP4_SERVICE_DESTROY)) { + goto DROP; + } + + Head = (IP4_HEAD *) NetbufGetByte (Packet, 0, NULL); + ASSERT (Head != NULL); + OptionLen = (Head->HeadLen << 2) - IP4_MIN_HEADLEN; + if (OptionLen > 0) { + Option = (UINT8 *) (Head + 1); + } + + // + // Validate packet format and reassemble packet if it is necessary. + // + Status = Ip4PreProcessPacket ( + IpSb, + &Packet, + Head, + Option, + OptionLen, + Flag + ); + + if (EFI_ERROR (Status)) { + goto RESTART; + } + + // + // After trim off, the packet is a esp/ah/udp/tcp/icmp6 net buffer, + // and no need consider any other ahead ext headers. + // + Status = Ip4IpSecProcessPacket ( + IpSb, + &Head, + &Packet, + &Option, + &OptionLen, + EfiIPsecInBound, + NULL + ); + + if (EFI_ERROR (Status)) { + goto RESTART; + } + + // + // If the packet is protected by tunnel mode, parse the inner Ip Packet. + // + ZeroMem (&ZeroHead, sizeof (IP4_HEAD)); + if (0 == CompareMem (Head, &ZeroHead, sizeof (IP4_HEAD))) { + // Packet may have been changed. Head, HeadLen, TotalLen, and + // info must be reloaded bofore use. The ownership of the packet + // is transfered to the packet process logic. + // + Head = (IP4_HEAD *) NetbufGetByte (Packet, 0, NULL); + ASSERT (Head != NULL); + Status = Ip4PreProcessPacket ( + IpSb, + &Packet, + Head, + Option, + OptionLen, + Flag + ); + if (EFI_ERROR (Status)) { + goto RESTART; + } + } + + ASSERT (Packet != NULL); + Head = Packet->Ip.Ip4; + IP4_GET_CLIP_INFO (Packet)->Status = EFI_SUCCESS; + + switch (Head->Protocol) { + case EFI_IP_PROTO_ICMP: + Ip4IcmpHandle (IpSb, Head, Packet); + break; + + case IP4_PROTO_IGMP: + Ip4IgmpHandle (IpSb, Head, Packet); + break; + + default: + Ip4Demultiplex (IpSb, Head, Packet, Option, OptionLen); + } + + Packet = NULL; + + // + // Dispatch the DPCs queued by the NotifyFunction of the rx token's events + // which are signaled with received data. + // + DispatchDpc (); + +RESTART: + Ip4ReceiveFrame (IpSb->DefaultInterface, NULL, Ip4AccpetFrame, IpSb); + +DROP: + if (Packet != NULL) { + NetbufFree (Packet); + } + + return ; +} + + +/** + Check whether this IP child accepts the packet. + + @param[in] IpInstance The IP child to check + @param[in] Head The IP header of the packet + @param[in] Packet The data of the packet + + @retval TRUE If the child wants to receive the packet. + @retval FALSE Otherwise. + +**/ +BOOLEAN +Ip4InstanceFrameAcceptable ( + IN IP4_PROTOCOL *IpInstance, + IN IP4_HEAD *Head, + IN NET_BUF *Packet + ) +{ + IP4_ICMP_ERROR_HEAD Icmp; + EFI_IP4_CONFIG_DATA *Config; + IP4_CLIP_INFO *Info; + UINT16 Proto; + UINT32 Index; + + Config = &IpInstance->ConfigData; + + // + // Dirty trick for the Tiano UEFI network stack implmentation. If + // ReceiveTimeout == -1, the receive of the packet for this instance + // is disabled. The UEFI spec don't have such capability. We add + // this to improve the performance because IP will make a copy of + // the received packet for each accepting instance. Some IP instances + // used by UDP/TCP only send packets, they don't wants to receive. + // + if (Config->ReceiveTimeout == (UINT32)(-1)) { + return FALSE; + } + + if (Config->AcceptPromiscuous) { + return TRUE; + } + + // + // Use protocol from the IP header embedded in the ICMP error + // message to filter, instead of ICMP itself. ICMP handle will + // call Ip4Demultiplex to deliver ICMP errors. + // + Proto = Head->Protocol; + + if ((Proto == EFI_IP_PROTO_ICMP) && (!Config->AcceptAnyProtocol) && (Proto != Config->DefaultProtocol)) { + NetbufCopy (Packet, 0, sizeof (Icmp.Head), (UINT8 *) &Icmp.Head); + + if (mIcmpClass[Icmp.Head.Type].IcmpClass == ICMP_ERROR_MESSAGE) { + if (!Config->AcceptIcmpErrors) { + return FALSE; + } + + NetbufCopy (Packet, 0, sizeof (Icmp), (UINT8 *) &Icmp); + Proto = Icmp.IpHead.Protocol; + } + } + + // + // Match the protocol + // + if (!Config->AcceptAnyProtocol && (Proto != Config->DefaultProtocol)) { + return FALSE; + } + + // + // Check for broadcast, the caller has computed the packet's + // cast type for this child's interface. + // + Info = IP4_GET_CLIP_INFO (Packet); + + if (IP4_IS_BROADCAST (Info->CastType)) { + return Config->AcceptBroadcast; + } + + // + // If it is a multicast packet, check whether we are in the group. + // + if (Info->CastType == IP4_MULTICAST) { + // + // Receive the multicast if the instance wants to receive all packets. + // + if (!IpInstance->ConfigData.UseDefaultAddress && (IpInstance->Interface->Ip == 0)) { + return TRUE; + } + + for (Index = 0; Index < IpInstance->GroupCount; Index++) { + if (IpInstance->Groups[Index] == HTONL (Head->Dst)) { + break; + } + } + + return (BOOLEAN)(Index < IpInstance->GroupCount); + } + + return TRUE; +} + + +/** + Enqueue a shared copy of the packet to the IP4 child if the + packet is acceptable to it. Here the data of the packet is + shared, but the net buffer isn't. + + @param[in] IpInstance The IP4 child to enqueue the packet to + @param[in] Head The IP header of the received packet + @param[in] Packet The data of the received packet + + @retval EFI_NOT_STARTED The IP child hasn't been configured. + @retval EFI_INVALID_PARAMETER The child doesn't want to receive the packet + @retval EFI_OUT_OF_RESOURCES Failed to allocate some resource + @retval EFI_SUCCESS A shared copy the packet is enqueued to the child. + +**/ +EFI_STATUS +Ip4InstanceEnquePacket ( + IN IP4_PROTOCOL *IpInstance, + IN IP4_HEAD *Head, + IN NET_BUF *Packet + ) +{ + IP4_CLIP_INFO *Info; + NET_BUF *Clone; + + // + // Check whether the packet is acceptable to this instance. + // + if (IpInstance->State != IP4_STATE_CONFIGED) { + return EFI_NOT_STARTED; + } + + if (!Ip4InstanceFrameAcceptable (IpInstance, Head, Packet)) { + return EFI_INVALID_PARAMETER; + } + + // + // Enque a shared copy of the packet. + // + Clone = NetbufClone (Packet); + + if (Clone == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + // + // Set the receive time out for the assembled packet. If it expires, + // packet will be removed from the queue. + // + Info = IP4_GET_CLIP_INFO (Clone); + Info->Life = IP4_US_TO_SEC (IpInstance->ConfigData.ReceiveTimeout); + + InsertTailList (&IpInstance->Received, &Clone->List); + return EFI_SUCCESS; +} + + +/** + The signal handle of IP4's recycle event. It is called back + when the upper layer release the packet. + + @param Event The IP4's recycle event. + @param Context The context of the handle, which is a + IP4_RXDATA_WRAP + +**/ +VOID +EFIAPI +Ip4OnRecyclePacket ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + IP4_RXDATA_WRAP *Wrap; + + Wrap = (IP4_RXDATA_WRAP *) Context; + + EfiAcquireLockOrFail (&Wrap->IpInstance->RecycleLock); + RemoveEntryList (&Wrap->Link); + EfiReleaseLock (&Wrap->IpInstance->RecycleLock); + + ASSERT (!NET_BUF_SHARED (Wrap->Packet)); + NetbufFree (Wrap->Packet); + + gBS->CloseEvent (Wrap->RxData.RecycleSignal); + FreePool (Wrap); +} + + +/** + Wrap the received packet to a IP4_RXDATA_WRAP, which will be + delivered to the upper layer. Each IP4 child that accepts the + packet will get a not-shared copy of the packet which is wrapped + in the IP4_RXDATA_WRAP. The IP4_RXDATA_WRAP->RxData is passed + to the upper layer. Upper layer will signal the recycle event in + it when it is done with the packet. + + @param[in] IpInstance The IP4 child to receive the packet. + @param[in] Packet The packet to deliver up. + + @retval Wrap if warp the packet succeed. + @retval NULL failed to wrap the packet . + +**/ +IP4_RXDATA_WRAP * +Ip4WrapRxData ( + IN IP4_PROTOCOL *IpInstance, + IN NET_BUF *Packet + ) +{ + IP4_RXDATA_WRAP *Wrap; + EFI_IP4_RECEIVE_DATA *RxData; + EFI_STATUS Status; + BOOLEAN RawData; + + Wrap = AllocatePool (IP4_RXDATA_WRAP_SIZE (Packet->BlockOpNum)); + + if (Wrap == NULL) { + return NULL; + } + + InitializeListHead (&Wrap->Link); + + Wrap->IpInstance = IpInstance; + Wrap->Packet = Packet; + RxData = &Wrap->RxData; + + ZeroMem (RxData, sizeof (EFI_IP4_RECEIVE_DATA)); + + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, + Ip4OnRecyclePacket, + Wrap, + &RxData->RecycleSignal + ); + + if (EFI_ERROR (Status)) { + FreePool (Wrap); + return NULL; + } + + ASSERT (Packet->Ip.Ip4 != NULL); + + ASSERT (IpInstance != NULL); + RawData = IpInstance->ConfigData.RawData; + + // + // The application expects a network byte order header. + // + if (!RawData) { + RxData->HeaderLength = (Packet->Ip.Ip4->HeadLen << 2); + RxData->Header = (EFI_IP4_HEADER *) Ip4NtohHead (Packet->Ip.Ip4); + RxData->OptionsLength = RxData->HeaderLength - IP4_MIN_HEADLEN; + RxData->Options = NULL; + + if (RxData->OptionsLength != 0) { + RxData->Options = (VOID *) (RxData->Header + 1); + } + } + + RxData->DataLength = Packet->TotalSize; + + // + // Build the fragment table to be delivered up. + // + RxData->FragmentCount = Packet->BlockOpNum; + NetbufBuildExt (Packet, (NET_FRAGMENT *) RxData->FragmentTable, &RxData->FragmentCount); + + return Wrap; +} + + +/** + Deliver the received packets to upper layer if there are both received + requests and enqueued packets. If the enqueued packet is shared, it will + duplicate it to a non-shared packet, release the shared packet, then + deliver the non-shared packet up. + + @param[in] IpInstance The IP child to deliver the packet up. + + @retval EFI_OUT_OF_RESOURCES Failed to allocate resources to deliver the + packets. + @retval EFI_SUCCESS All the enqueued packets that can be delivered + are delivered up. + +**/ +EFI_STATUS +Ip4InstanceDeliverPacket ( + IN IP4_PROTOCOL *IpInstance + ) +{ + EFI_IP4_COMPLETION_TOKEN *Token; + IP4_RXDATA_WRAP *Wrap; + NET_BUF *Packet; + NET_BUF *Dup; + UINT8 *Head; + UINT32 HeadLen; + + // + // Deliver a packet if there are both a packet and a receive token. + // + while (!IsListEmpty (&IpInstance->Received) && + !NetMapIsEmpty (&IpInstance->RxTokens)) { + + Packet = NET_LIST_HEAD (&IpInstance->Received, NET_BUF, List); + + if (!NET_BUF_SHARED (Packet)) { + // + // If this is the only instance that wants the packet, wrap it up. + // + Wrap = Ip4WrapRxData (IpInstance, Packet); + + if (Wrap == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + RemoveEntryList (&Packet->List); + + } else { + // + // Create a duplicated packet if this packet is shared + // + if (IpInstance->ConfigData.RawData) { + HeadLen = 0; + } else { + HeadLen = IP4_MAX_HEADLEN; + } + + Dup = NetbufDuplicate (Packet, NULL, HeadLen); + + if (Dup == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + if (!IpInstance->ConfigData.RawData) { + // + // Copy the IP head over. The packet to deliver up is + // headless. Trim the head off after copy. The IP head + // may be not continuous before the data. + // + Head = NetbufAllocSpace (Dup, IP4_MAX_HEADLEN, NET_BUF_HEAD); + ASSERT (Head != NULL); + + Dup->Ip.Ip4 = (IP4_HEAD *) Head; + + CopyMem (Head, Packet->Ip.Ip4, Packet->Ip.Ip4->HeadLen << 2); + NetbufTrim (Dup, IP4_MAX_HEADLEN, TRUE); + } + + Wrap = Ip4WrapRxData (IpInstance, Dup); + + if (Wrap == NULL) { + NetbufFree (Dup); + return EFI_OUT_OF_RESOURCES; + } + + RemoveEntryList (&Packet->List); + NetbufFree (Packet); + + Packet = Dup; + } + + // + // Insert it into the delivered packet, then get a user's + // receive token, pass the wrapped packet up. + // + EfiAcquireLockOrFail (&IpInstance->RecycleLock); + InsertHeadList (&IpInstance->Delivered, &Wrap->Link); + EfiReleaseLock (&IpInstance->RecycleLock); + + Token = NetMapRemoveHead (&IpInstance->RxTokens, NULL); + Token->Status = IP4_GET_CLIP_INFO (Packet)->Status; + Token->Packet.RxData = &Wrap->RxData; + + gBS->SignalEvent (Token->Event); + } + + return EFI_SUCCESS; +} + + +/** + Enqueue a received packet to all the IP children that share + the same interface. + + @param[in] IpSb The IP4 service instance that receive the packet. + @param[in] Head The header of the received packet. + @param[in] Packet The data of the received packet. + @param[in] Option Point to the IP4 packet header options. + @param[in] OptionLen Length of the IP4 packet header options. + @param[in] IpIf The interface to enqueue the packet to. + + @return The number of the IP4 children that accepts the packet + +**/ +INTN +Ip4InterfaceEnquePacket ( + IN IP4_SERVICE *IpSb, + IN IP4_HEAD *Head, + IN NET_BUF *Packet, + IN UINT8 *Option, + IN UINT32 OptionLen, + IN IP4_INTERFACE *IpIf + ) +{ + IP4_PROTOCOL *IpInstance; + IP4_CLIP_INFO *Info; + LIST_ENTRY *Entry; + INTN Enqueued; + INTN LocalType; + INTN SavedType; + + // + // First, check that the packet is acceptable to this interface + // and find the local cast type for the interface. A packet sent + // to say 192.168.1.1 should NOT be delliever to 10.0.0.1 unless + // promiscuous receiving. + // + LocalType = 0; + Info = IP4_GET_CLIP_INFO (Packet); + + if ((Info->CastType == IP4_MULTICAST) || (Info->CastType == IP4_LOCAL_BROADCAST)) { + // + // If the CastType is multicast, don't need to filter against + // the group address here, Ip4InstanceFrameAcceptable will do + // that later. + // + LocalType = Info->CastType; + + } else { + // + // Check the destination againist local IP. If the station + // address is 0.0.0.0, it means receiving all the IP destined + // to local non-zero IP. Otherwise, it is necessary to compare + // the destination to the interface's IP address. + // + if (IpIf->Ip == IP4_ALLZERO_ADDRESS) { + LocalType = IP4_LOCAL_HOST; + + } else { + LocalType = Ip4GetNetCast (Head->Dst, IpIf); + + if ((LocalType == 0) && IpIf->PromiscRecv) { + LocalType = IP4_PROMISCUOUS; + } + } + } + + if (LocalType == 0) { + return 0; + } + + // + // Iterate through the ip instances on the interface, enqueue + // the packet if filter passed. Save the original cast type, + // and pass the local cast type to the IP children on the + // interface. The global cast type will be restored later. + // + SavedType = Info->CastType; + Info->CastType = LocalType; + + Enqueued = 0; + + NET_LIST_FOR_EACH (Entry, &IpIf->IpInstances) { + IpInstance = NET_LIST_USER_STRUCT (Entry, IP4_PROTOCOL, AddrLink); + NET_CHECK_SIGNATURE (IpInstance, IP4_PROTOCOL_SIGNATURE); + + // + // In RawData mode, add IPv4 headers and options back to packet. + // + if ((IpInstance->ConfigData.RawData) && (Option != NULL) && (OptionLen != 0)){ + Ip4PrependHead (Packet, Head, Option, OptionLen); + } + + if (Ip4InstanceEnquePacket (IpInstance, Head, Packet) == EFI_SUCCESS) { + Enqueued++; + } + } + + Info->CastType = SavedType; + return Enqueued; +} + + +/** + Deliver the packet for each IP4 child on the interface. + + @param[in] IpSb The IP4 service instance that received the packet + @param[in] IpIf The IP4 interface to deliver the packet. + + @retval EFI_SUCCESS It always returns EFI_SUCCESS now + +**/ +EFI_STATUS +Ip4InterfaceDeliverPacket ( + IN IP4_SERVICE *IpSb, + IN IP4_INTERFACE *IpIf + ) +{ + IP4_PROTOCOL *Ip4Instance; + LIST_ENTRY *Entry; + + NET_LIST_FOR_EACH (Entry, &IpIf->IpInstances) { + Ip4Instance = NET_LIST_USER_STRUCT (Entry, IP4_PROTOCOL, AddrLink); + Ip4InstanceDeliverPacket (Ip4Instance); + } + + return EFI_SUCCESS; +} + + +/** + Demultiple the packet. the packet delivery is processed in two + passes. The first pass will enque a shared copy of the packet + to each IP4 child that accepts the packet. The second pass will + deliver a non-shared copy of the packet to each IP4 child that + has pending receive requests. Data is copied if more than one + child wants to consume the packet because each IP child needs + its own copy of the packet to make changes. + + @param[in] IpSb The IP4 service instance that received the packet. + @param[in] Head The header of the received packet. + @param[in] Packet The data of the received packet. + @param[in] Option Point to the IP4 packet header options. + @param[in] OptionLen Length of the IP4 packet header options. + + @retval EFI_NOT_FOUND No IP child accepts the packet. + @retval EFI_SUCCESS The packet is enqueued or delivered to some IP + children. + +**/ +EFI_STATUS +Ip4Demultiplex ( + IN IP4_SERVICE *IpSb, + IN IP4_HEAD *Head, + IN NET_BUF *Packet, + IN UINT8 *Option, + IN UINT32 OptionLen + ) +{ + LIST_ENTRY *Entry; + IP4_INTERFACE *IpIf; + INTN Enqueued; + + // + // Two pass delivery: first, enque a shared copy of the packet + // to each instance that accept the packet. + // + Enqueued = 0; + + NET_LIST_FOR_EACH (Entry, &IpSb->Interfaces) { + IpIf = NET_LIST_USER_STRUCT (Entry, IP4_INTERFACE, Link); + + if (IpIf->Configured) { + Enqueued += Ip4InterfaceEnquePacket ( + IpSb, + Head, + Packet, + Option, + OptionLen, + IpIf + ); + } + } + + // + // Second: deliver a duplicate of the packet to each instance. + // Release the local reference first, so that the last instance + // getting the packet will not copy the data. + // + NetbufFree (Packet); + + if (Enqueued == 0) { + return EFI_NOT_FOUND; + } + + NET_LIST_FOR_EACH (Entry, &IpSb->Interfaces) { + IpIf = NET_LIST_USER_STRUCT (Entry, IP4_INTERFACE, Link); + + if (IpIf->Configured) { + Ip4InterfaceDeliverPacket (IpSb, IpIf); + } + } + + return EFI_SUCCESS; +} + + +/** + Timeout the fragment and enqueued packets. + + @param[in] IpSb The IP4 service instance to timeout + +**/ +VOID +Ip4PacketTimerTicking ( + IN IP4_SERVICE *IpSb + ) +{ + LIST_ENTRY *InstanceEntry; + LIST_ENTRY *Entry; + LIST_ENTRY *Next; + IP4_PROTOCOL *IpInstance; + IP4_ASSEMBLE_ENTRY *Assemble; + NET_BUF *Packet; + IP4_CLIP_INFO *Info; + UINT32 Index; + + // + // First, time out the fragments. The packet's life is counting down + // once the first-arrived fragment was received. + // + for (Index = 0; Index < IP4_ASSEMLE_HASH_SIZE; Index++) { + NET_LIST_FOR_EACH_SAFE (Entry, Next, &IpSb->Assemble.Bucket[Index]) { + Assemble = NET_LIST_USER_STRUCT (Entry, IP4_ASSEMBLE_ENTRY, Link); + + if ((Assemble->Life > 0) && (--Assemble->Life == 0)) { + RemoveEntryList (Entry); + Ip4FreeAssembleEntry (Assemble); + } + } + } + + NET_LIST_FOR_EACH (InstanceEntry, &IpSb->Children) { + IpInstance = NET_LIST_USER_STRUCT (InstanceEntry, IP4_PROTOCOL, Link); + + // + // Second, time out the assembled packets enqueued on each IP child. + // + NET_LIST_FOR_EACH_SAFE (Entry, Next, &IpInstance->Received) { + Packet = NET_LIST_USER_STRUCT (Entry, NET_BUF, List); + Info = IP4_GET_CLIP_INFO (Packet); + + if ((Info->Life > 0) && (--Info->Life == 0)) { + RemoveEntryList (Entry); + NetbufFree (Packet); + } + } + + // + // Third: time out the transmitted packets. + // + NetMapIterate (&IpInstance->TxTokens, Ip4SentPacketTicking, NULL); + } +} diff --git a/NetworkPkg/Ip4Dxe/Ip4Input.h b/NetworkPkg/Ip4Dxe/Ip4Input.h new file mode 100644 index 0000000000..f4d45d1613 --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4Input.h @@ -0,0 +1,246 @@ +/** @file + +Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef __EFI_IP4_INPUT_H__ +#define __EFI_IP4_INPUT_H__ + +#define IP4_MIN_HEADLEN 20 +#define IP4_MAX_HEADLEN 60 +/// +/// 8(ESP header) + 16(max IV) + 16(max padding) + 2(ESP tail) + 12(max ICV) = 54 +/// +#define IP4_MAX_IPSEC_HEADLEN 54 + +#define IP4_ASSEMLE_HASH_SIZE 31 +#define IP4_FRAGMENT_LIFE 120 +#define IP4_MAX_PACKET_SIZE 65535 + +/// +/// Per packet information for input process. LinkFlag specifies whether +/// the packet is received as Link layer unicast, multicast or broadcast. +/// The CastType is the IP layer cast type, such as IP multicast or unicast. +/// Start, End and Length are staffs used to assemble the packets. Start +/// is the sequence number of the first byte of data in the packet. Length +/// is the number of bytes of data. End = Start + Length, that is, the +/// sequence number of last byte + 1. Each assembled packet has a count down +/// life. If it isn't consumed before Life reaches zero, the packet is released. +/// +typedef struct { + UINTN LinkFlag; + INTN CastType; + INTN Start; + INTN End; + INTN Length; + UINT32 Life; + EFI_STATUS Status; +} IP4_CLIP_INFO; + +/// +/// Structure used to assemble IP packets. +/// +typedef struct { + LIST_ENTRY Link; + + // + // Identity of one IP4 packet. Each fragment of a packet has + // the same (Dst, Src, Id, Protocol). + // + IP4_ADDR Dst; + IP4_ADDR Src; + UINT16 Id; + UINT8 Protocol; + + INTN TotalLen; + INTN CurLen; + LIST_ENTRY Fragments; // List of all the fragments of this packet + + IP4_HEAD *Head; // IP head of the first fragment + IP4_CLIP_INFO *Info; // Per packet info of the first fragment + INTN Life; // Count down life for the packet. +} IP4_ASSEMBLE_ENTRY; + +/// +/// Each Ip service instance has an assemble table to reassemble +/// the packets before delivery to its children. It is organized +/// as hash table. +/// +typedef struct { + LIST_ENTRY Bucket[IP4_ASSEMLE_HASH_SIZE]; +} IP4_ASSEMBLE_TABLE; + +#define IP4_GET_CLIP_INFO(Packet) ((IP4_CLIP_INFO *) ((Packet)->ProtoData)) + +#define IP4_ASSEMBLE_HASH(Dst, Src, Id, Proto) \ + (((Dst) + (Src) + ((Id) << 16) + (Proto)) % IP4_ASSEMLE_HASH_SIZE) + +#define IP4_RXDATA_WRAP_SIZE(NumFrag) \ + (sizeof (IP4_RXDATA_WRAP) + sizeof (EFI_IP4_FRAGMENT_DATA) * ((NumFrag) - 1)) + +/** + Initialize an already allocated assemble table. This is generally + the assemble table embedded in the IP4 service instance. + + @param[in, out] Table The assemble table to initialize. + +**/ +VOID +Ip4InitAssembleTable ( + IN OUT IP4_ASSEMBLE_TABLE *Table + ); + +/** + Clean up the assemble table: remove all the fragments + and assemble entries. + + @param[in] Table The assemble table to clean up + +**/ +VOID +Ip4CleanAssembleTable ( + IN IP4_ASSEMBLE_TABLE *Table + ); + +/** + The IP4 input routine. It is called by the IP4_INTERFACE when a + IP4 fragment is received from MNP. + + @param[in] Ip4Instance The IP4 child that request the receive, most like + it is NULL. + @param[in] Packet The IP4 packet received. + @param[in] IoStatus The return status of receive request. + @param[in] Flag The link layer flag for the packet received, such + as multicast. + @param[in] Context The IP4 service instance that own the MNP. + +**/ +VOID +Ip4AccpetFrame ( + IN IP4_PROTOCOL *Ip4Instance, + IN NET_BUF *Packet, + IN EFI_STATUS IoStatus, + IN UINT32 Flag, + IN VOID *Context + ); + +/** + Demultiple the packet. the packet delivery is processed in two + passes. The first pass will enque a shared copy of the packet + to each IP4 child that accepts the packet. The second pass will + deliver a non-shared copy of the packet to each IP4 child that + has pending receive requests. Data is copied if more than one + child wants to consume the packet because each IP child needs + its own copy of the packet to make changes. + + @param[in] IpSb The IP4 service instance that received the packet. + @param[in] Head The header of the received packet. + @param[in] Packet The data of the received packet. + @param[in] Option Point to the IP4 packet header options. + @param[in] OptionLen Length of the IP4 packet header options. + + @retval EFI_NOT_FOUND No IP child accepts the packet. + @retval EFI_SUCCESS The packet is enqueued or delivered to some IP + children. + +**/ +EFI_STATUS +Ip4Demultiplex ( + IN IP4_SERVICE *IpSb, + IN IP4_HEAD *Head, + IN NET_BUF *Packet, + IN UINT8 *Option, + IN UINT32 OptionLen + ); + +/** + Enqueue a received packet to all the IP children that share + the same interface. + + @param[in] IpSb The IP4 service instance that receive the packet. + @param[in] Head The header of the received packet. + @param[in] Packet The data of the received packet. + @param[in] Option Point to the IP4 packet header options. + @param[in] OptionLen Length of the IP4 packet header options. + @param[in] IpIf The interface to enqueue the packet to. + + @return The number of the IP4 children that accepts the packet + +**/ +INTN +Ip4InterfaceEnquePacket ( + IN IP4_SERVICE *IpSb, + IN IP4_HEAD *Head, + IN NET_BUF *Packet, + IN UINT8 *Option, + IN UINT32 OptionLen, + IN IP4_INTERFACE *IpIf + ); + +/** + Deliver the received packets to upper layer if there are both received + requests and enqueued packets. If the enqueued packet is shared, it will + duplicate it to a non-shared packet, release the shared packet, then + deliver the non-shared packet up. + + @param[in] IpInstance The IP child to deliver the packet up. + + @retval EFI_OUT_OF_RESOURCES Failed to allocate resources to deliver the + packets. + @retval EFI_SUCCESS All the enqueued packets that can be delivered + are delivered up. + +**/ +EFI_STATUS +Ip4InstanceDeliverPacket ( + IN IP4_PROTOCOL *IpInstance + ); + +/** + Timeout the fragment and enqueued packets. + + @param[in] IpSb The IP4 service instance to timeout + +**/ +VOID +Ip4PacketTimerTicking ( + IN IP4_SERVICE *IpSb + ); + +/** + The work function to locate IPsec protocol to process the inbound or + outbound IP packets. The process routine handls the packet with following + actions: bypass the packet, discard the packet, or protect the packet. + + @param[in] IpSb The IP4 service instance. + @param[in, out] Head The The caller supplied IP4 header. + @param[in, out] Netbuf The IP4 packet to be processed by IPsec. + @param[in, out] Options The caller supplied options. + @param[in, out] OptionsLen The length of the option. + @param[in] Direction The directionality in an SPD entry, + EfiIPsecInBound or EfiIPsecOutBound. + @param[in] Context The token's wrap. + + @retval EFI_SUCCESS The IPsec protocol is not available or disabled. + @retval EFI_SUCCESS The packet was bypassed and all buffers remain the same. + @retval EFI_SUCCESS The packet was protected. + @retval EFI_ACCESS_DENIED The packet was discarded. + @retval EFI_OUT_OF_RESOURCES There is no suffcient resource to complete the operation. + @retval EFI_BUFFER_TOO_SMALL The number of non-empty block is bigger than the + number of input data blocks when build a fragment table. + +**/ +EFI_STATUS +Ip4IpSecProcessPacket ( + IN IP4_SERVICE *IpSb, + IN OUT IP4_HEAD **Head, + IN OUT NET_BUF **Netbuf, + IN OUT UINT8 **Options, + IN OUT UINT32 *OptionsLen, + IN EFI_IPSEC_TRAFFIC_DIR Direction, + IN VOID *Context + ); + +#endif diff --git a/NetworkPkg/Ip4Dxe/Ip4NvData.h b/NetworkPkg/Ip4Dxe/Ip4NvData.h new file mode 100644 index 0000000000..d161c1c8c5 --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4NvData.h @@ -0,0 +1,45 @@ +/** @file + Routines used to operate the Ip4Dxe. + +Copyright (c) 2015, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef _IP4_NV_DATA_H_ +#define _IP4_NV_DATA_H_ + +#include + +#define FORMID_MAIN_FORM 1 +#define FORMID_DEVICE_FORM 2 + +#define KEY_ENABLE 0x100 +#define KEY_DHCP_ENABLE 0x101 +#define KEY_LOCAL_IP 0x102 +#define KEY_SUBNET_MASK 0x103 +#define KEY_GATE_WAY 0x104 +#define KEY_DNS 0x105 +#define KEY_SAVE_CHANGES 0x106 + +#define IP_MIN_SIZE 7 +#define IP_MAX_SIZE 15 +#define IP4_STR_MAX_SIZE 16 +#define ADDRESS_STR_MAX_SIZE 255 +#define MAX_IP4_CONFIG_DNS 16 + +/// +/// IP4_CONFIG2_IFR_NVDATA contains the IP4 configure +/// parameters for that NIC. +/// +typedef struct { + UINT8 Configure; ///< NIC configure status + UINT8 DhcpEnable; ///< Static or DHCP + CHAR16 StationAddress[IP4_STR_MAX_SIZE]; ///< IP addresses + CHAR16 SubnetMask[IP4_STR_MAX_SIZE]; ///< Subnet address + CHAR16 GatewayAddress[IP4_STR_MAX_SIZE]; ///< Gateway address + CHAR16 DnsAddress[ADDRESS_STR_MAX_SIZE]; ///< DNS server address +} IP4_CONFIG2_IFR_NVDATA; + +#endif + diff --git a/NetworkPkg/Ip4Dxe/Ip4Option.c b/NetworkPkg/Ip4Dxe/Ip4Option.c new file mode 100644 index 0000000000..f1c10014e8 --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4Option.c @@ -0,0 +1,204 @@ +/** @file + IP4 option support functions. + +Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Ip4Impl.h" + + +/** + Validate the IP4 option format for both the packets we received + and will transmit. + + @param[in] Option The first byte of the option + @param[in] OptionLen The length of the whole option + @param[in] Rcvd The option is from the packet we received if TRUE, + otherwise the option we wants to transmit. + + @retval TRUE The option is properly formatted + @retval FALSE The option is mal-formated + +**/ +BOOLEAN +Ip4OptionIsValid ( + IN UINT8 *Option, + IN UINT32 OptionLen, + IN BOOLEAN Rcvd + ) +{ + UINT32 Cur; + UINT32 Len; + UINT32 Point; + + Cur = 0; + + while (Cur < OptionLen) { + switch (Option[Cur]) { + case IP4_OPTION_NOP: + Cur++; + break; + + case IP4_OPTION_EOP: + Cur = OptionLen; + break; + + case IP4_OPTION_LSRR: + case IP4_OPTION_SSRR: + case IP4_OPTION_RR: + Len = Option[Cur + 1]; + Point = Option[Cur + 2]; + + // + // SRR/RR options are formatted as |Type|Len|Point|Ip1|Ip2|... + // + if ((OptionLen - Cur < Len) || (Len < 3) || ((Len - 3) % 4 != 0)) { + return FALSE; + } + + if ((Point > Len + 1) || (Point % 4 != 0)) { + return FALSE; + } + + // + // The Point must point pass the last entry if the packet is received + // by us. It must point to 4 if the packet is to be sent by us for + // source route option. + // + if ((Option[Cur] != IP4_OPTION_RR) && + ((Rcvd && (Point != Len + 1)) || (!Rcvd && (Point != 4)))) { + + return FALSE; + } + + Cur += Len; + break; + + default: + Len = Option[Cur + 1]; + + if ((OptionLen - Cur < Len) || (Len < 2)) { + return FALSE; + } + + Cur = Cur + Len; + break; + } + + } + + return TRUE; +} + + +/** + Copy the option from the original option to buffer. It + handles the details such as: + 1. whether copy the single IP4 option to the first/non-first + fragments. + 2. Pad the options copied over to aligned to 4 bytes. + + @param[in] Option The original option to copy from + @param[in] OptionLen The length of the original option + @param[in] FirstFragment Whether it is the first fragment + @param[in, out] Buf The buffer to copy options to. NULL + @param[in, out] BufLen The length of the buffer + + @retval EFI_SUCCESS The options are copied over + @retval EFI_BUFFER_TOO_SMALL Buf is NULL or BufLen provided is too small. + +**/ +EFI_STATUS +Ip4CopyOption ( + IN UINT8 *Option, + IN UINT32 OptionLen, + IN BOOLEAN FirstFragment, + IN OUT UINT8 *Buf, OPTIONAL + IN OUT UINT32 *BufLen + ) +{ + UINT8 OptBuf[40]; + UINT32 Cur; + UINT32 Next; + UINT8 Type; + UINT32 Len; + + ASSERT ((BufLen != NULL) && (OptionLen <= 40)); + + Cur = 0; + Next = 0; + + while (Cur < OptionLen) { + Type = Option[Cur]; + Len = Option[Cur + 1]; + + if (Type == IP4_OPTION_NOP) { + // + // Keep the padding, in case that the sender wants to align + // the option, say, to 4 bytes + // + OptBuf[Next] = IP4_OPTION_NOP; + Next++; + Cur++; + + } else if (Type == IP4_OPTION_EOP) { + // + // Don't append the EOP to avoid including only a EOP option + // + break; + + } else { + // + // don't copy options that is only valid for the first fragment + // + if (FirstFragment || (Type & IP4_OPTION_COPY_MASK) != 0) { + CopyMem (OptBuf + Next, Option + Cur, Len); + Next += Len; + } + + Cur += Len; + } + } + + // + // Don't append an EOP only option. + // + if (Next == 0) { + *BufLen = 0; + return EFI_SUCCESS; + } + + // + // Append an EOP if the end of option doesn't coincide with the + // end of the IP header, that is, isn't aligned to 4 bytes.. + // + if ((Next % 4) != 0) { + OptBuf[Next] = IP4_OPTION_EOP; + Next++; + } + + // + // Head length is in the unit of 4 bytes. Now, Len is the + // acutal option length to appear in the IP header. + // + Len = ((Next + 3) &~0x03); + + // + // If the buffer is too small, set the BufLen then return + // + if ((Buf == NULL) || (*BufLen < Len)) { + *BufLen = Len; + return EFI_BUFFER_TOO_SMALL; + } + + // + // Copy the option to the Buf, zero the buffer first to pad + // the options with NOP to align to 4 bytes. + // + ZeroMem (Buf, Len); + CopyMem (Buf, OptBuf, Next); + *BufLen = Len; + return EFI_SUCCESS; +} diff --git a/NetworkPkg/Ip4Dxe/Ip4Option.h b/NetworkPkg/Ip4Dxe/Ip4Option.h new file mode 100644 index 0000000000..57a5a58725 --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4Option.h @@ -0,0 +1,66 @@ +/** @file + IP4 option support routines. + +Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef __EFI_IP4_OPTION_H__ +#define __EFI_IP4_OPTION_H__ + +#define IP4_OPTION_EOP 0 +#define IP4_OPTION_NOP 1 +#define IP4_OPTION_LSRR 131 // Loss source and record routing, 10000011 +#define IP4_OPTION_SSRR 137 // Strict source and record routing, 10001001 +#define IP4_OPTION_RR 7 // Record routing, 00000111 + +#define IP4_OPTION_COPY_MASK 0x80 + +/** + Validate the IP4 option format for both the packets we received + and will transmit. It will compute the ICMP error message fields + if the option is mal-formated. But this information isn't used. + + @param[in] Option The first byte of the option + @param[in] OptionLen The length of the whole option + @param[in] Rcvd The option is from the packet we received if TRUE, + otherwise the option we wants to transmit. + + @retval TRUE The option is properly formatted + @retval FALSE The option is mal-formated + +**/ +BOOLEAN +Ip4OptionIsValid ( + IN UINT8 *Option, + IN UINT32 OptionLen, + IN BOOLEAN Rcvd + ); + +/** + Copy the option from the original option to buffer. It + handles the details such as: + 1. whether copy the single IP4 option to the first/non-first + fragments. + 2. Pad the options copied over to aligned to 4 bytes. + + @param[in] Option The original option to copy from + @param[in] OptionLen The length of the original option + @param[in] FirstFragment Whether it is the first fragment + @param[in, out] Buf The buffer to copy options to. NULL + @param[in, out] BufLen The length of the buffer + + @retval EFI_SUCCESS The options are copied over + @retval EFI_BUFFER_TOO_SMALL Buf is NULL or BufLen provided is too small. + +**/ +EFI_STATUS +Ip4CopyOption ( + IN UINT8 *Option, + IN UINT32 OptionLen, + IN BOOLEAN FirstFragment, + IN OUT UINT8 *Buf, OPTIONAL + IN OUT UINT32 *BufLen + ); +#endif diff --git a/NetworkPkg/Ip4Dxe/Ip4Output.c b/NetworkPkg/Ip4Dxe/Ip4Output.c new file mode 100644 index 0000000000..5eb3814089 --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4Output.c @@ -0,0 +1,482 @@ +/** @file + Transmit the IP4 packet. + +Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Ip4Impl.h" + +UINT16 mIp4Id; + + +/** + Prepend an IP4 head to the Packet. It will copy the options and + build the IP4 header fields. Used for IP4 fragmentation. + + @param Packet The packet to prepend IP4 header to + @param Head The caller supplied header. The caller should set + the following header fields: Tos, TotalLen, Id, + Fragment, Ttl, Protocol, Src and Dst. All the fields + are in host byte order. This function will fill in + the Ver, HeadLen, and checksum. + @param Option The orginal IP4 option to copy from + @param OptLen The length of the IP4 option + + @retval EFI_BAD_BUFFER_SIZE There is no enought room in the head space of + Packet. + @retval EFI_SUCCESS The IP4 header is successfully added to the packet. + +**/ +EFI_STATUS +Ip4PrependHead ( + IN OUT NET_BUF *Packet, + IN IP4_HEAD *Head, + IN UINT8 *Option, + IN UINT32 OptLen + ) +{ + UINT32 HeadLen; + UINT32 Len; + IP4_HEAD *PacketHead; + BOOLEAN FirstFragment; + + // + // Prepend the options: first get the option length, then copy it over. + // + HeadLen = 0; + FirstFragment = IP4_FIRST_FRAGMENT (Head->Fragment); + + Ip4CopyOption (Option, OptLen, FirstFragment, NULL, &Len); + + HeadLen = IP4_MIN_HEADLEN + Len; + ASSERT (((Len % 4) == 0) && (HeadLen <= IP4_MAX_HEADLEN)); + + PacketHead = (IP4_HEAD *) NetbufAllocSpace (Packet, HeadLen, NET_BUF_HEAD); + + if (PacketHead == NULL) { + return EFI_BAD_BUFFER_SIZE; + } + + Ip4CopyOption (Option, OptLen, FirstFragment, (UINT8 *) (PacketHead + 1), &Len); + + // + // Set the head up, convert the host byte order to network byte order + // + PacketHead->Ver = 4; + PacketHead->HeadLen = (UINT8) (HeadLen >> 2); + PacketHead->Tos = Head->Tos; + PacketHead->TotalLen = HTONS ((UINT16) Packet->TotalSize); + PacketHead->Id = HTONS (Head->Id); + PacketHead->Fragment = HTONS (Head->Fragment); + PacketHead->Checksum = 0; + PacketHead->Ttl = Head->Ttl; + PacketHead->Protocol = Head->Protocol; + PacketHead->Src = HTONL (Head->Src); + PacketHead->Dst = HTONL (Head->Dst); + PacketHead->Checksum = (UINT16) (~NetblockChecksum ((UINT8 *) PacketHead, HeadLen)); + + Packet->Ip.Ip4 = PacketHead; + return EFI_SUCCESS; +} + + +/** + Select an interface to send the packet generated in the IP4 driver + itself, that is, not by the requests of IP4 child's consumer. Such + packets include the ICMP echo replies, and other ICMP error packets. + + @param[in] IpSb The IP4 service that wants to send the packets. + @param[in] Dst The destination of the packet + @param[in] Src The source of the packet + + @return NULL if no proper interface is found, otherwise the interface that + can be used to send the system packet from. + +**/ +IP4_INTERFACE * +Ip4SelectInterface ( + IN IP4_SERVICE *IpSb, + IN IP4_ADDR Dst, + IN IP4_ADDR Src + ) +{ + IP4_INTERFACE *IpIf; + IP4_INTERFACE *Selected; + LIST_ENTRY *Entry; + + // + // Select the interface the Dst is on if one of the connected + // network. Some IP instance may be configured with 0.0.0.0/0, + // don't select that interface now. + // + IpIf = Ip4FindNet (IpSb, Dst); + + if ((IpIf != NULL) && (IpIf->Ip != IP4_ALLZERO_ADDRESS)) { + return IpIf; + } + + // + // If source is one of the interface address, select it. + // + IpIf = Ip4FindInterface (IpSb, Src); + + if ((IpIf != NULL) && (IpIf->Ip != IP4_ALLZERO_ADDRESS)) { + return IpIf; + } + + // + // Select a configured interface as the fall back. Always prefer + // an interface with non-zero address. + // + Selected = NULL; + + NET_LIST_FOR_EACH (Entry, &IpSb->Interfaces) { + IpIf = NET_LIST_USER_STRUCT (Entry, IP4_INTERFACE, Link); + + if (IpIf->Configured && ((Selected == NULL) || (Selected->Ip == 0))) { + Selected = IpIf; + } + } + + return Selected; +} + + +/** + The default callback function for system generated packet. + It will free the packet. + + @param Ip4Instance The IP4 child that issued the transmission. It most + like is NULL. + @param Packet The packet that transmitted. + @param IoStatus The result of the transmission, succeeded or failed. + @param LinkFlag Not used when transmission. check IP4_FRAME_CALLBACK + for reference. + @param Context The context provided by us + +**/ +VOID +Ip4SysPacketSent ( + IP4_PROTOCOL *Ip4Instance, + NET_BUF *Packet, + EFI_STATUS IoStatus, + UINT32 LinkFlag, + VOID *Context + ) +{ + NetbufFree (Packet); +} + + +/** + Transmit an IP4 packet. The packet comes either from the IP4 + child's consumer (IpInstance != NULL) or the IP4 driver itself + (IpInstance == NULL). It will route the packet, fragment it, + then transmit all the fragments through some interface. + + @param[in] IpSb The IP4 service instance to transmit the packet + @param[in] IpInstance The IP4 child that issues the transmission. It is + NULL if the packet is from the system. + @param[in] Packet The user data to send, excluding the IP header. + @param[in] Head The caller supplied header. The caller should set + the following header fields: Tos, TotalLen, Id, tl, + Fragment, Protocol, Src and Dst. All the fields are + in host byte order. This function will fill in the + Ver, HeadLen, Fragment, and checksum. The Fragment + only need to include the DF flag. Ip4Output will + compute the MF and offset for you. + @param[in] Option The original option to append to the IP headers + @param[in] OptLen The length of the option + @param[in] GateWay The next hop address to transmit packet to. + 255.255.255.255 means broadcast. + @param[in] Callback The callback function to issue when transmission + completed. + @param[in] Context The opaque context for the callback + + @retval EFI_NO_MAPPING There is no interface to the destination. + @retval EFI_NOT_FOUND There is no route to the destination + @retval EFI_SUCCESS The packet is successfully transmitted. + @retval EFI_BAD_BUFFER_SIZE The length of the IPv4 header + option length + + total data length is greater than MTU (or greater + than the maximum packet size if Token.Packet.TxData. + OverrideData.DoNotFragment is TRUE.) + @retval Others Failed to transmit the packet. + +**/ +EFI_STATUS +Ip4Output ( + IN IP4_SERVICE *IpSb, + IN IP4_PROTOCOL *IpInstance OPTIONAL, + IN NET_BUF *Packet, + IN IP4_HEAD *Head, + IN UINT8 *Option, + IN UINT32 OptLen, + IN IP4_ADDR GateWay, + IN IP4_FRAME_CALLBACK Callback, + IN VOID *Context + ) +{ + IP4_INTERFACE *IpIf; + IP4_ROUTE_CACHE_ENTRY *CacheEntry; + IP4_ADDR Dest; + EFI_STATUS Status; + NET_BUF *Fragment; + UINT32 Index; + UINT32 HeadLen; + UINT32 PacketLen; + UINT32 Offset; + UINT32 Mtu; + UINT32 Num; + BOOLEAN RawData; + + // + // Select an interface/source for system packet, application + // should select them itself. + // + if (IpInstance == NULL) { + IpIf = Ip4SelectInterface (IpSb, Head->Dst, Head->Src); + } else { + IpIf = IpInstance->Interface; + } + + if (IpIf == NULL) { + return EFI_NO_MAPPING; + } + + if ((Head->Src == IP4_ALLZERO_ADDRESS) && (IpInstance == NULL)) { + Head->Src = IpIf->Ip; + } + + // + // Before IPsec process, prepared the IP head. + // If Ip4Output is transmitting RawData, don't update IPv4 header. + // + HeadLen = sizeof (IP4_HEAD) + ((OptLen + 3) & (~0x03)); + + if ((IpInstance != NULL) && IpInstance->ConfigData.RawData) { + RawData = TRUE; + } else { + Head->HeadLen = (UINT8) (HeadLen >> 2); + Head->Id = mIp4Id++; + Head->Ver = 4; + RawData = FALSE; + } + + // + // Call IPsec process. + // + Status = Ip4IpSecProcessPacket ( + IpSb, + &Head, + &Packet, + &Option, + &OptLen, + EfiIPsecOutBound, + Context + ); + + if (EFI_ERROR(Status)) { + return Status; + } + + Dest = Head->Dst; + if (IP4_IS_BROADCAST (Ip4GetNetCast (Dest, IpIf)) || (Dest == IP4_ALLONE_ADDRESS)) { + // + // Set the gateway to local broadcast if the Dest is + // the broadcast address for the connected network or + // it is local broadcast. + // + GateWay = IP4_ALLONE_ADDRESS; + + } else if (IP4_IS_MULTICAST (Dest)) { + // + // Set the gateway to the destination if it is an multicast + // address. The IP4_INTERFACE won't consult ARP to send local + // broadcast and multicast. + // + GateWay = Head->Dst; + + } else if (GateWay == IP4_ALLZERO_ADDRESS) { + // + // Route the packet unless overrided, that is, GateWay isn't zero. + // + if (IpInstance == NULL) { + CacheEntry = Ip4Route (IpSb->DefaultRouteTable, Head->Dst, Head->Src, IpIf->SubnetMask, TRUE); + } else { + CacheEntry = Ip4Route (IpInstance->RouteTable, Head->Dst, Head->Src, IpIf->SubnetMask, FALSE); + // + // If failed to route the packet by using the instance's route table, + // try to use the default route table. + // + if (CacheEntry == NULL) { + CacheEntry = Ip4Route (IpSb->DefaultRouteTable, Head->Dst, Head->Src, IpIf->SubnetMask, TRUE); + } + } + + if (CacheEntry == NULL) { + return EFI_NOT_FOUND; + } + + GateWay = CacheEntry->NextHop; + Ip4FreeRouteCacheEntry (CacheEntry); + } + + // + // OK, selected the source and route, fragment the packet then send + // them. Tag each fragment other than the first one as spawn from it. + // + Mtu = IpSb->MaxPacketSize + sizeof (IP4_HEAD); + + if (Packet->TotalSize + HeadLen > Mtu) { + // + // Fragmentation is diabled for RawData mode. + // + if (RawData) { + return EFI_BAD_BUFFER_SIZE; + } + + // + // Packet is fragmented from the tail to the head, that is, the + // first frame sent is the last fragment of the packet. The first + // fragment is NOT sent in this loop. First compute how many + // fragments there are. + // + Mtu = (Mtu - HeadLen) & (~0x07); + Num = (Packet->TotalSize + Mtu - 1) / Mtu; + + // + // Initialize the packet length and Offset. Other than the last + // fragment, the packet length equals to MTU. The offset is always + // aligned to MTU. + // + PacketLen = Packet->TotalSize - (Num - 1) * Mtu; + Offset = Mtu * (Num - 1); + + for (Index = 0; Index < Num - 1; Index++, Offset -= Mtu) { + Fragment = NetbufGetFragment (Packet, Offset, PacketLen, IP4_MAX_HEADLEN); + + if (Fragment == NULL) { + Status = EFI_OUT_OF_RESOURCES; + goto ON_ERROR; + } + + // + // Update the header's fragment. The caller fills the IP4 header + // fields that are required by Ip4PrependHead except the fragment. + // + Head->Fragment = IP4_HEAD_FRAGMENT_FIELD (FALSE, (Index != 0), Offset); + Ip4PrependHead (Fragment, Head, Option, OptLen); + + // + // Transmit the fragments, pass the Packet address as the context. + // So, we can find all the fragments spawned from the Packet by + // compare the NetBuf and Context to the Packet. + // + Status = Ip4SendFrame ( + IpIf, + IpInstance, + Fragment, + GateWay, + Ip4SysPacketSent, + Packet, + IpSb + ); + + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + PacketLen = Mtu; + } + + // + // Trim the already sent data, then adjust the head's fragment field. + // + NetbufTrim (Packet, Packet->TotalSize - Mtu, FALSE); + Head->Fragment = IP4_HEAD_FRAGMENT_FIELD (FALSE, TRUE, 0); + } + + // + // Send the first fragment, it is either the orginal packet, or the + // first fragment of a fragmented packet. It seems that there is a subtle + // bug here: what if the caller free the packet in Callback and IpIf (or + // MNP child used by that interface) still holds the fragments and try + // to access the data? The caller can free the packet if it recycles the + // consumer's (such as UDP) data in the Callback. But this can't happen. + // The detailed sequence is: + // 1. for the packets generated by IP4 driver itself: + // The Callback is Ip4SysPacketSent, which is the same as the + // fragments' callback. Ip4SysPacketSent simply calls NetbufFree + // to release its reference to the packet. So, no problem for + // system packets. + // + // 2. for the upper layer's packets (use UDP as an example): + // UDP requests the IP layer to transmit some data which is + // wrapped in an asynchronous token, the token is wrapped + // in IP4_TXTOKEN_WRAP by IP4. IP4 also wrap the user's data + // in a net buffer, which is Packet we get here. IP4_TXTOKEN_WRAP + // is bound with the Packet. It will only be freed when all + // the references to Packet have been released. Upon then, the + // Packet's OnFree callback will release the IP4_TXTOKEN_WRAP, + // and singal the user's recycle event. So, also no problem for + // upper layer's packets. + // + Ip4PrependHead (Packet, Head, Option, OptLen); + Status = Ip4SendFrame (IpIf, IpInstance, Packet, GateWay, Callback, Context, IpSb); + + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + return EFI_SUCCESS; + +ON_ERROR: + Ip4CancelPacket (IpIf, Packet, Status); + return Status; +} + + +/** + The filter function to find a packet and all its fragments. + The packet's fragments have their Context set to the packet. + + @param[in] Frame The frames hold by the low level interface + @param[in] Context Context to the function, which is the packet. + + @retval TRUE This is the packet to cancel or its fragments. + @retval FALSE This is unrelated packet. + +**/ +BOOLEAN +Ip4CancelPacketFragments ( + IN IP4_LINK_TX_TOKEN *Frame, + IN VOID *Context + ) +{ + if ((Frame->Packet == (NET_BUF *) Context) || (Frame->Context == Context)) { + return TRUE; + } + + return FALSE; +} + + +/** + Cancel the Packet and all its fragments. + + @param IpIf The interface from which the Packet is sent + @param Packet The Packet to cancel + @param IoStatus The status returns to the sender. + +**/ +VOID +Ip4CancelPacket ( + IN IP4_INTERFACE *IpIf, + IN NET_BUF *Packet, + IN EFI_STATUS IoStatus + ) +{ + Ip4CancelFrames (IpIf, IoStatus, Ip4CancelPacketFragments, Packet); +} diff --git a/NetworkPkg/Ip4Dxe/Ip4Output.h b/NetworkPkg/Ip4Dxe/Ip4Output.h new file mode 100644 index 0000000000..ae54f8b485 --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4Output.h @@ -0,0 +1,120 @@ +/** @file + +Copyright (c) 2005 - 2006, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef __EFI_IP4_OUTPUT_H__ +#define __EFI_IP4_OUTPUT_H__ + +/** + The default callback function for system generated packet. + It will free the packet. + + @param Ip4Instance The IP4 child that issued the transmission. It most + like is NULL. + @param Packet The packet that transmitted. + @param IoStatus The result of the transmission, succeeded or failed. + @param LinkFlag Not used when transmission. check IP4_FRAME_CALLBACK + for reference. + @param Context The context provided by us + +**/ +VOID +Ip4SysPacketSent ( + IP4_PROTOCOL *Ip4Instance, + NET_BUF *Packet, + EFI_STATUS IoStatus, + UINT32 LinkFlag, + VOID *Context + ); + +/** + Transmit an IP4 packet. The packet comes either from the IP4 + child's consumer (IpInstance != NULL) or the IP4 driver itself + (IpInstance == NULL). It will route the packet, fragment it, + then transmit all the fragments through some interface. + + @param[in] IpSb The IP4 service instance to transmit the packet + @param[in] IpInstance The IP4 child that issues the transmission. It is + NULL if the packet is from the system. + @param[in] Packet The user data to send, excluding the IP header. + @param[in] Head The caller supplied header. The caller should set + the following header fields: Tos, TotalLen, Id, tl, + Fragment, Protocol, Src and Dst. All the fields are + in host byte order. This function will fill in the + Ver, HeadLen, Fragment, and checksum. The Fragment + only need to include the DF flag. Ip4Output will + compute the MF and offset for you. + @param[in] Option The original option to append to the IP headers + @param[in] OptLen The length of the option + @param[in] GateWay The next hop address to transmit packet to. + 255.255.255.255 means broadcast. + @param[in] Callback The callback function to issue when transmission + completed. + @param[in] Context The opaque context for the callback + + @retval EFI_NO_MAPPING There is no interface to the destination. + @retval EFI_NOT_FOUND There is no route to the destination + @retval EFI_SUCCESS The packet is successfully transmitted. + @retval Others Failed to transmit the packet. + +**/ +EFI_STATUS +Ip4Output ( + IN IP4_SERVICE *IpSb, + IN IP4_PROTOCOL *IpInstance OPTIONAL, + IN NET_BUF *Packet, + IN IP4_HEAD *Head, + IN UINT8 *Option, + IN UINT32 OptLen, + IN IP4_ADDR GateWay, + IN IP4_FRAME_CALLBACK Callback, + IN VOID *Context + ); + +/** + Cancel the Packet and all its fragments. + + @param IpIf The interface from which the Packet is sent + @param Packet The Packet to cancel + @param IoStatus The status returns to the sender. + +**/ +VOID +Ip4CancelPacket ( + IN IP4_INTERFACE *IpIf, + IN NET_BUF *Packet, + IN EFI_STATUS IoStatus + ); + +/** + Prepend an IP4 head to the Packet. It will copy the options and + build the IP4 header fields. Used for IP4 fragmentation. + + @param Packet The packet to prepend IP4 header to + @param Head The caller supplied header. The caller should set + the following header fields: Tos, TotalLen, Id, + Fragment, Ttl, Protocol, Src and Dst. All the fields + are in host byte order. This function will fill in + the Ver, HeadLen, and checksum. + @param Option The orginal IP4 option to copy from + @param OptLen The length of the IP4 option + + @retval EFI_BAD_BUFFER_SIZE There is no enought room in the head space of + Packet. + @retval EFI_SUCCESS The IP4 header is successfully added to the packet. + +**/ +EFI_STATUS +Ip4PrependHead ( + IN OUT NET_BUF *Packet, + IN IP4_HEAD *Head, + IN UINT8 *Option, + IN UINT32 OptLen + ); + +extern UINT16 mIp4Id; + +#endif diff --git a/NetworkPkg/Ip4Dxe/Ip4Route.c b/NetworkPkg/Ip4Dxe/Ip4Route.c new file mode 100644 index 0000000000..124c0730ad --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4Route.c @@ -0,0 +1,673 @@ +/** @file + +Copyright (c) 2005 - 2016, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Ip4Impl.h" + + +/** + Allocate a route entry then initialize it with the Dest/Netmaks + and Gateway. + + @param[in] Dest The destination network + @param[in] Netmask The destination network mask + @param[in] GateWay The nexthop address + + @return NULL if failed to allocate memeory, otherwise the newly created + route entry. + +**/ +IP4_ROUTE_ENTRY * +Ip4CreateRouteEntry ( + IN IP4_ADDR Dest, + IN IP4_ADDR Netmask, + IN IP4_ADDR GateWay + ) +{ + IP4_ROUTE_ENTRY *RtEntry; + + RtEntry = AllocatePool (sizeof (IP4_ROUTE_ENTRY)); + + if (RtEntry == NULL) { + return NULL; + } + + InitializeListHead (&RtEntry->Link); + + RtEntry->RefCnt = 1; + RtEntry->Dest = Dest; + RtEntry->Netmask = Netmask; + RtEntry->NextHop = GateWay; + RtEntry->Flag = 0; + + return RtEntry; +} + + +/** + Free the route table entry. It is reference counted. + + @param RtEntry The route entry to free. + +**/ +VOID +Ip4FreeRouteEntry ( + IN IP4_ROUTE_ENTRY *RtEntry + ) +{ + ASSERT (RtEntry->RefCnt > 0); + + if (--RtEntry->RefCnt == 0) { + FreePool (RtEntry); + } +} + + +/** + Allocate and initialize an IP4 route cache entry. + + @param[in] Dst The destination address + @param[in] Src The source address + @param[in] GateWay The next hop address + @param[in] Tag The tag from the caller. This marks all the cache + entries spawned from one route table entry. + + @return NULL if failed to allocate memory for the cache, other point + to the created route cache entry. + +**/ +IP4_ROUTE_CACHE_ENTRY * +Ip4CreateRouteCacheEntry ( + IN IP4_ADDR Dst, + IN IP4_ADDR Src, + IN IP4_ADDR GateWay, + IN UINTN Tag + ) +{ + IP4_ROUTE_CACHE_ENTRY *RtCacheEntry; + + RtCacheEntry = AllocatePool (sizeof (IP4_ROUTE_CACHE_ENTRY)); + + if (RtCacheEntry == NULL) { + return NULL; + } + + InitializeListHead (&RtCacheEntry->Link); + + RtCacheEntry->RefCnt = 1; + RtCacheEntry->Dest = Dst; + RtCacheEntry->Src = Src; + RtCacheEntry->NextHop = GateWay; + RtCacheEntry->Tag = Tag; + + return RtCacheEntry; +} + + +/** + Free the route cache entry. It is reference counted. + + @param RtCacheEntry The route cache entry to free. + +**/ +VOID +Ip4FreeRouteCacheEntry ( + IN IP4_ROUTE_CACHE_ENTRY *RtCacheEntry + ) +{ + ASSERT (RtCacheEntry->RefCnt > 0); + + if (--RtCacheEntry->RefCnt == 0) { + FreePool (RtCacheEntry); + } +} + + +/** + Initialize an empty route cache table. + + @param[in, out] RtCache The rotue cache table to initialize. + +**/ +VOID +Ip4InitRouteCache ( + IN OUT IP4_ROUTE_CACHE *RtCache + ) +{ + UINT32 Index; + + for (Index = 0; Index < IP4_ROUTE_CACHE_HASH_VALUE; Index++) { + InitializeListHead (&(RtCache->CacheBucket[Index])); + } +} + + +/** + Clean up a route cache, that is free all the route cache + entries enqueued in the cache. + + @param[in] RtCache The route cache table to clean up + +**/ +VOID +Ip4CleanRouteCache ( + IN IP4_ROUTE_CACHE *RtCache + ) +{ + LIST_ENTRY *Entry; + LIST_ENTRY *Next; + IP4_ROUTE_CACHE_ENTRY *RtCacheEntry; + UINT32 Index; + + for (Index = 0; Index < IP4_ROUTE_CACHE_HASH_VALUE; Index++) { + NET_LIST_FOR_EACH_SAFE (Entry, Next, &(RtCache->CacheBucket[Index])) { + RtCacheEntry = NET_LIST_USER_STRUCT (Entry, IP4_ROUTE_CACHE_ENTRY, Link); + + RemoveEntryList (Entry); + Ip4FreeRouteCacheEntry (RtCacheEntry); + } + } +} + + + +/** + Create an empty route table, includes its internal route cache + + @return NULL if failed to allocate memory for the route table, otherwise + the point to newly created route table. + +**/ +IP4_ROUTE_TABLE * +Ip4CreateRouteTable ( + VOID + ) +{ + IP4_ROUTE_TABLE *RtTable; + UINT32 Index; + + RtTable = AllocatePool (sizeof (IP4_ROUTE_TABLE)); + + if (RtTable == NULL) { + return NULL; + } + + RtTable->RefCnt = 1; + RtTable->TotalNum = 0; + + for (Index = 0; Index <= IP4_MASK_MAX; Index++) { + InitializeListHead (&(RtTable->RouteArea[Index])); + } + + RtTable->Next = NULL; + + Ip4InitRouteCache (&RtTable->Cache); + return RtTable; +} + + +/** + Free the route table and its associated route cache. Route + table is reference counted. + + @param[in] RtTable The route table to free. + +**/ +VOID +Ip4FreeRouteTable ( + IN IP4_ROUTE_TABLE *RtTable + ) +{ + LIST_ENTRY *Entry; + LIST_ENTRY *Next; + IP4_ROUTE_ENTRY *RtEntry; + UINT32 Index; + + ASSERT (RtTable->RefCnt > 0); + + if (--RtTable->RefCnt > 0) { + return ; + } + + // + // Free all the route table entry and its route cache. + // + for (Index = 0; Index <= IP4_MASK_MAX; Index++) { + NET_LIST_FOR_EACH_SAFE (Entry, Next, &(RtTable->RouteArea[Index])) { + RtEntry = NET_LIST_USER_STRUCT (Entry, IP4_ROUTE_ENTRY, Link); + + RemoveEntryList (Entry); + Ip4FreeRouteEntry (RtEntry); + } + } + + Ip4CleanRouteCache (&RtTable->Cache); + + FreePool (RtTable); +} + + + +/** + Remove all the cache entries bearing the Tag. When a route cache + entry is created, it is tagged with the address of route entry + from which it is spawned. When a route entry is deleted, the cache + entries spawned from it are also deleted. + + @param RtCache Route cache to remove the entries from + @param Tag The Tag of the entries to remove + +**/ +VOID +Ip4PurgeRouteCache ( + IN OUT IP4_ROUTE_CACHE *RtCache, + IN UINTN Tag + ) +{ + LIST_ENTRY *Entry; + LIST_ENTRY *Next; + IP4_ROUTE_CACHE_ENTRY *RtCacheEntry; + UINT32 Index; + + for (Index = 0; Index < IP4_ROUTE_CACHE_HASH_VALUE; Index++) { + NET_LIST_FOR_EACH_SAFE (Entry, Next, &RtCache->CacheBucket[Index]) { + + RtCacheEntry = NET_LIST_USER_STRUCT (Entry, IP4_ROUTE_CACHE_ENTRY, Link); + + if (RtCacheEntry->Tag == Tag) { + RemoveEntryList (Entry); + Ip4FreeRouteCacheEntry (RtCacheEntry); + } + } + } +} + + +/** + Add a route entry to the route table. All the IP4_ADDRs are in + host byte order. + + @param[in, out] RtTable Route table to add route to + @param[in] Dest The destination of the network + @param[in] Netmask The netmask of the destination + @param[in] Gateway The next hop address + + @retval EFI_ACCESS_DENIED The same route already exists + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the entry + @retval EFI_SUCCESS The route is added successfully. + +**/ +EFI_STATUS +Ip4AddRoute ( + IN OUT IP4_ROUTE_TABLE *RtTable, + IN IP4_ADDR Dest, + IN IP4_ADDR Netmask, + IN IP4_ADDR Gateway + ) +{ + LIST_ENTRY *Head; + LIST_ENTRY *Entry; + IP4_ROUTE_ENTRY *RtEntry; + + // + // All the route entries with the same netmask length are + // linke to the same route area + // + Head = &(RtTable->RouteArea[NetGetMaskLength (Netmask)]); + + // + // First check whether the route exists + // + NET_LIST_FOR_EACH (Entry, Head) { + RtEntry = NET_LIST_USER_STRUCT (Entry, IP4_ROUTE_ENTRY, Link); + + if (IP4_NET_EQUAL (RtEntry->Dest, Dest, Netmask) && (RtEntry->NextHop == Gateway)) { + return EFI_ACCESS_DENIED; + } + } + + // + // Create a route entry and insert it to the route area. + // + RtEntry = Ip4CreateRouteEntry (Dest, Netmask, Gateway); + + if (RtEntry == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + if (Gateway == IP4_ALLZERO_ADDRESS) { + RtEntry->Flag = IP4_DIRECT_ROUTE; + } + + InsertHeadList (Head, &RtEntry->Link); + RtTable->TotalNum++; + + return EFI_SUCCESS; +} + + +/** + Remove a route entry and all the route caches spawn from it. + + @param RtTable The route table to remove the route from + @param Dest The destination network + @param Netmask The netmask of the Dest + @param Gateway The next hop address + + @retval EFI_SUCCESS The route entry is successfully removed + @retval EFI_NOT_FOUND There is no route entry in the table with that + properity. + +**/ +EFI_STATUS +Ip4DelRoute ( + IN OUT IP4_ROUTE_TABLE *RtTable, + IN IP4_ADDR Dest, + IN IP4_ADDR Netmask, + IN IP4_ADDR Gateway + ) +{ + LIST_ENTRY *Head; + LIST_ENTRY *Entry; + LIST_ENTRY *Next; + IP4_ROUTE_ENTRY *RtEntry; + + Head = &(RtTable->RouteArea[NetGetMaskLength (Netmask)]); + + NET_LIST_FOR_EACH_SAFE (Entry, Next, Head) { + RtEntry = NET_LIST_USER_STRUCT (Entry, IP4_ROUTE_ENTRY, Link); + + if (IP4_NET_EQUAL (RtEntry->Dest, Dest, Netmask) && (RtEntry->NextHop == Gateway)) { + Ip4PurgeRouteCache (&RtTable->Cache, (UINTN) RtEntry); + RemoveEntryList (Entry); + Ip4FreeRouteEntry (RtEntry); + + RtTable->TotalNum--; + return EFI_SUCCESS; + } + } + + return EFI_NOT_FOUND; +} + + +/** + Find a route cache with the dst and src. This is used by ICMP + redirect messasge process. All kinds of redirect is treated as + host redirect according to RFC1122. So, only route cache entries + are modified according to the ICMP redirect message. + + @param[in] RtTable The route table to search the cache for + @param[in] Dest The destination address + @param[in] Src The source address + + @return NULL if no route entry to the (Dest, Src). Otherwise the point + to the correct route cache entry. + +**/ +IP4_ROUTE_CACHE_ENTRY * +Ip4FindRouteCache ( + IN IP4_ROUTE_TABLE *RtTable, + IN IP4_ADDR Dest, + IN IP4_ADDR Src + ) +{ + LIST_ENTRY *Entry; + IP4_ROUTE_CACHE_ENTRY *RtCacheEntry; + UINT32 Index; + + Index = IP4_ROUTE_CACHE_HASH (Dest, Src); + + NET_LIST_FOR_EACH (Entry, &RtTable->Cache.CacheBucket[Index]) { + RtCacheEntry = NET_LIST_USER_STRUCT (Entry, IP4_ROUTE_CACHE_ENTRY, Link); + + if ((RtCacheEntry->Dest == Dest) && (RtCacheEntry->Src == Src)) { + NET_GET_REF (RtCacheEntry); + return RtCacheEntry; + } + } + + return NULL; +} + + +/** + Search the route table for a most specific match to the Dst. It searches + from the longest route area (mask length == 32) to the shortest route area + (default routes). In each route area, it will first search the instance's + route table, then the default route table. This is required by the following + requirements: + 1. IP search the route table for a most specific match + 2. The local route entries have precedence over the default route entry. + + @param[in] RtTable The route table to search from + @param[in] Dst The destionation address to search + + @return NULL if no route matches the Dst, otherwise the point to the + most specific route to the Dst. + +**/ +IP4_ROUTE_ENTRY * +Ip4FindRouteEntry ( + IN IP4_ROUTE_TABLE *RtTable, + IN IP4_ADDR Dst + ) +{ + LIST_ENTRY *Entry; + IP4_ROUTE_ENTRY *RtEntry; + IP4_ROUTE_TABLE *Table; + INTN Index; + + RtEntry = NULL; + + for (Index = IP4_MASK_MAX; Index >= 0; Index--) { + for (Table = RtTable; Table != NULL; Table = Table->Next) { + NET_LIST_FOR_EACH (Entry, &Table->RouteArea[Index]) { + RtEntry = NET_LIST_USER_STRUCT (Entry, IP4_ROUTE_ENTRY, Link); + + if (IP4_NET_EQUAL (RtEntry->Dest, Dst, RtEntry->Netmask)) { + NET_GET_REF (RtEntry); + return RtEntry; + } + } + } + } + + + return NULL; +} + + +/** + Search the route table to route the packet. Return/create a route + cache if there is a route to the destination. + + @param[in] RtTable The route table to search from + @param[in] Dest The destination address to search for + @param[in] Src The source address to search for + @param[in] SubnetMask The subnet mask of the Src address, this field is + used to check if the station is using /32 subnet. + @param[in] AlwaysTryDestAddr Always try to use the dest address as next hop even + though we can't find a matching route entry. This + field is only valid when using /32 subnet. + + @return NULL if failed to route packet, otherwise a route cache + entry that can be used to route packet. + +**/ +IP4_ROUTE_CACHE_ENTRY * +Ip4Route ( + IN IP4_ROUTE_TABLE *RtTable, + IN IP4_ADDR Dest, + IN IP4_ADDR Src, + IN IP4_ADDR SubnetMask, + IN BOOLEAN AlwaysTryDestAddr + ) +{ + LIST_ENTRY *Head; + LIST_ENTRY *Entry; + LIST_ENTRY *Next; + IP4_ROUTE_CACHE_ENTRY *RtCacheEntry; + IP4_ROUTE_CACHE_ENTRY *Cache; + IP4_ROUTE_ENTRY *RtEntry; + IP4_ADDR NextHop; + UINT32 Count; + + ASSERT (RtTable != NULL); + + Head = &RtTable->Cache.CacheBucket[IP4_ROUTE_CACHE_HASH (Dest, Src)]; + RtCacheEntry = Ip4FindRouteCache (RtTable, Dest, Src); + + // + // If found, promote the cache entry to the head of the hash bucket. LRU + // + if (RtCacheEntry != NULL) { + RemoveEntryList (&RtCacheEntry->Link); + InsertHeadList (Head, &RtCacheEntry->Link); + return RtCacheEntry; + } + + // + // Search the route table for the most specific route + // + RtEntry = Ip4FindRouteEntry (RtTable, Dest); + + if (RtEntry == NULL) { + if (SubnetMask != IP4_ALLONE_ADDRESS) { + return NULL; + } else if (!AlwaysTryDestAddr) { + return NULL; + } + } + + // + // Found a route to the Dest, if it is a direct route, the packet + // will be sent directly to the destination, such as for connected + // network. Otherwise, it is an indirect route, the packet will be + // sent to the next hop router. + // + // When using /32 subnet mask, the packet will always be sent to the direct + // destination first, if we can't find a matching route cache. + // + if (SubnetMask == IP4_ALLONE_ADDRESS || ((RtEntry->Flag & IP4_DIRECT_ROUTE) != 0)) { + NextHop = Dest; + } else { + NextHop = RtEntry->NextHop; + } + + if (RtEntry != NULL) { + Ip4FreeRouteEntry (RtEntry); + } + + // + // Create a route cache entry, and tag it as spawned from this route entry + // For /32 subnet mask, the default route in RtEntry will be used if failed + // to send the packet to driect destination address. + // + RtCacheEntry = Ip4CreateRouteCacheEntry (Dest, Src, NextHop, (UINTN) RtEntry); + + if (RtCacheEntry == NULL) { + return NULL; + } + + InsertHeadList (Head, &RtCacheEntry->Link); + NET_GET_REF (RtCacheEntry); + + // + // Each bucket of route cache can contain at most 64 entries. + // Remove the entries at the tail of the bucket. These entries + // are likely to be used least. + // + Count = 0; + NET_LIST_FOR_EACH_SAFE (Entry, Next, Head) { + if (++Count < IP4_ROUTE_CACHE_MAX) { + continue; + } + + Cache = NET_LIST_USER_STRUCT (Entry, IP4_ROUTE_CACHE_ENTRY, Link); + + RemoveEntryList (Entry); + Ip4FreeRouteCacheEntry (Cache); + } + + return RtCacheEntry; +} + + +/** + Build a EFI_IP4_ROUTE_TABLE to be returned to the caller of + GetModeData. The EFI_IP4_ROUTE_TABLE is clumsy to use in the + internal operation of the IP4 driver. + + @param[in] IpInstance The IP4 child that requests the route table. + + @retval EFI_SUCCESS The route table is successfully build + @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the rotue table. + +**/ +EFI_STATUS +Ip4BuildEfiRouteTable ( + IN IP4_PROTOCOL *IpInstance + ) +{ + LIST_ENTRY *Entry; + IP4_ROUTE_TABLE *RtTable; + IP4_ROUTE_ENTRY *RtEntry; + EFI_IP4_ROUTE_TABLE *Table; + UINT32 Count; + INT32 Index; + + RtTable = IpInstance->RouteTable; + + if (IpInstance->EfiRouteTable != NULL) { + FreePool (IpInstance->EfiRouteTable); + + IpInstance->EfiRouteTable = NULL; + IpInstance->EfiRouteCount = 0; + } + + Count = RtTable->TotalNum; + + if (RtTable->Next != NULL) { + Count += RtTable->Next->TotalNum; + } + + if (Count == 0) { + return EFI_SUCCESS; + } + + Table = AllocatePool (sizeof (EFI_IP4_ROUTE_TABLE) * Count); + + if (Table == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + // + // Copy the route entry to EFI route table. Keep the order of + // route entry copied from most specific to default route. That + // is, interlevel the route entry from the instance's route area + // and those from the default route table's route area. + // + Count = 0; + + for (Index = IP4_MASK_MAX; Index >= 0; Index--) { + for (RtTable = IpInstance->RouteTable; RtTable != NULL; RtTable = RtTable->Next) { + NET_LIST_FOR_EACH (Entry, &(RtTable->RouteArea[Index])) { + RtEntry = NET_LIST_USER_STRUCT (Entry, IP4_ROUTE_ENTRY, Link); + + EFI_IP4 (Table[Count].SubnetAddress) = HTONL (RtEntry->Dest & RtEntry->Netmask); + EFI_IP4 (Table[Count].SubnetMask) = HTONL (RtEntry->Netmask); + EFI_IP4 (Table[Count].GatewayAddress) = HTONL (RtEntry->NextHop); + + Count++; + } + } + } + + IpInstance->EfiRouteTable = Table; + IpInstance->EfiRouteCount = Count; + return EFI_SUCCESS; +} diff --git a/NetworkPkg/Ip4Dxe/Ip4Route.h b/NetworkPkg/Ip4Dxe/Ip4Route.h new file mode 100644 index 0000000000..4b0b5282ab --- /dev/null +++ b/NetworkPkg/Ip4Dxe/Ip4Route.h @@ -0,0 +1,225 @@ +/** @file + EFI IP4 route table and route cache table defintions. + +Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef __EFI_IP4_ROUTE_H__ +#define __EFI_IP4_ROUTE_H__ + +#include "Ip4Common.h" + +#define IP4_DIRECT_ROUTE 0x00000001 + +#define IP4_ROUTE_CACHE_HASH_VALUE 31 +#define IP4_ROUTE_CACHE_MAX 64 // Max NO. of cache entry per hash bucket + +#define IP4_ROUTE_CACHE_HASH(Dst, Src) (((Dst) ^ (Src)) % IP4_ROUTE_CACHE_HASH_VALUE) + +/// +/// The route entry in the route table. Dest/Netmask is the destion +/// network. The nexthop is the gateway to send the packet to in +/// order to reach the Dest/Netmask. If the Flag has IP4_DIRECT_ROUTE +/// on, the gateway is the destination of the IP packet itself. Route +/// enties of the connected network have the flag on. +/// +typedef struct { + LIST_ENTRY Link; + INTN RefCnt; + IP4_ADDR Dest; + IP4_ADDR Netmask; + IP4_ADDR NextHop; + UINT32 Flag; +} IP4_ROUTE_ENTRY; + +/// +/// The route cache entry. The route cache entry is optional. +/// But it is necessary to support the ICMP redirect message. +/// Check Ip4ProcessIcmpRedirect for information. +/// +/// The cache entry field Tag is used to tag all the route +/// cache entry spawned from a route table entry. This makes +/// it simple to delete all the route cache entries from a +/// to-be-deleted route entry. +/// +typedef struct { + LIST_ENTRY Link; + INTN RefCnt; + IP4_ADDR Dest; + IP4_ADDR Src; + IP4_ADDR NextHop; + UINTN Tag; +} IP4_ROUTE_CACHE_ENTRY; + +/// +/// The route cache table is organized as a hash table. Each +/// IP4 route table has a embedded route cache. For now the +/// route cache and route table are binded togehter. But keep +/// the route cache a seperated structure in case we want to +/// detach them later. +/// +typedef struct { + LIST_ENTRY CacheBucket[IP4_ROUTE_CACHE_HASH_VALUE]; +} IP4_ROUTE_CACHE; + +/// +/// Each IP4 instance has its own route table. Each ServiceBinding +/// instance has a default route table and default address. +/// +/// All the route table entries with the same mask are linked +/// together in one route area. For example, RouteArea[0] contains +/// the default routes. A route table also contains a route cache. +/// +typedef struct _IP4_ROUTE_TABLE IP4_ROUTE_TABLE; + +struct _IP4_ROUTE_TABLE { + INTN RefCnt; + UINT32 TotalNum; + LIST_ENTRY RouteArea[IP4_MASK_NUM]; + IP4_ROUTE_TABLE *Next; + IP4_ROUTE_CACHE Cache; +}; + +/** + Create an empty route table, includes its internal route cache + + @return NULL if failed to allocate memory for the route table, otherwise + the point to newly created route table. + +**/ +IP4_ROUTE_TABLE * +Ip4CreateRouteTable ( + VOID + ); + +/** + Free the route table and its associated route cache. Route + table is reference counted. + + @param[in] RtTable The route table to free. + +**/ +VOID +Ip4FreeRouteTable ( + IN IP4_ROUTE_TABLE *RtTable + ); + +/** + Add a route entry to the route table. All the IP4_ADDRs are in + host byte order. + + @param[in, out] RtTable Route table to add route to + @param[in] Dest The destination of the network + @param[in] Netmask The netmask of the destination + @param[in] Gateway The next hop address + + @retval EFI_ACCESS_DENIED The same route already exists + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the entry + @retval EFI_SUCCESS The route is added successfully. + +**/ +EFI_STATUS +Ip4AddRoute ( + IN OUT IP4_ROUTE_TABLE *RtTable, + IN IP4_ADDR Dest, + IN IP4_ADDR Netmask, + IN IP4_ADDR Gateway + ); + +/** + Remove a route entry and all the route caches spawn from it. + + @param RtTable The route table to remove the route from + @param Dest The destination network + @param Netmask The netmask of the Dest + @param Gateway The next hop address + + @retval EFI_SUCCESS The route entry is successfully removed + @retval EFI_NOT_FOUND There is no route entry in the table with that + properity. + +**/ +EFI_STATUS +Ip4DelRoute ( + IN OUT IP4_ROUTE_TABLE *RtTable, + IN IP4_ADDR Dest, + IN IP4_ADDR Netmask, + IN IP4_ADDR Gateway + ); + +/** + Find a route cache with the dst and src. This is used by ICMP + redirect messasge process. All kinds of redirect is treated as + host redirect according to RFC1122. So, only route cache entries + are modified according to the ICMP redirect message. + + @param[in] RtTable The route table to search the cache for + @param[in] Dest The destination address + @param[in] Src The source address + + @return NULL if no route entry to the (Dest, Src). Otherwise the point + to the correct route cache entry. + +**/ +IP4_ROUTE_CACHE_ENTRY * +Ip4FindRouteCache ( + IN IP4_ROUTE_TABLE *RtTable, + IN IP4_ADDR Dest, + IN IP4_ADDR Src + ); + +/** + Free the route cache entry. It is reference counted. + + @param RtCacheEntry The route cache entry to free. + +**/ +VOID +Ip4FreeRouteCacheEntry ( + IN IP4_ROUTE_CACHE_ENTRY *RtCacheEntry + ); + +/** + Search the route table to route the packet. Return/create a route + cache if there is a route to the destination. + + @param[in] RtTable The route table to search from + @param[in] Dest The destination address to search for + @param[in] Src The source address to search for + @param[in] SubnetMask The subnet mask of the Src address, this field is + used to check if the station is using /32 subnet. + @param[in] AlwaysTryDestAddr Always try to use the dest address as next hop even + though we can't find a matching route entry. This + field is only valid when using /32 subnet. + + @return NULL if failed to route packet, otherwise a route cache + entry that can be used to route packet. + +**/ +IP4_ROUTE_CACHE_ENTRY * +Ip4Route ( + IN IP4_ROUTE_TABLE *RtTable, + IN IP4_ADDR Dest, + IN IP4_ADDR Src, + IN IP4_ADDR SubnetMask, + IN BOOLEAN AlwaysTryDestAddr + ); + +/** + Build a EFI_IP4_ROUTE_TABLE to be returned to the caller of + GetModeData. The EFI_IP4_ROUTE_TABLE is clumsy to use in the + internal operation of the IP4 driver. + + @param[in] IpInstance The IP4 child that requests the route table. + + @retval EFI_SUCCESS The route table is successfully build + @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the rotue table. + +**/ +EFI_STATUS +Ip4BuildEfiRouteTable ( + IN IP4_PROTOCOL *IpInstance + ); +#endif diff --git a/NetworkPkg/Library/DxeDpcLib/DpcLib.c b/NetworkPkg/Library/DxeDpcLib/DpcLib.c new file mode 100644 index 0000000000..29d810776e --- /dev/null +++ b/NetworkPkg/Library/DxeDpcLib/DpcLib.c @@ -0,0 +1,94 @@ +/** @file + Help functions to access UDP service. + +Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent +**/ + +#include +#include +#include +#include + +// +// Pointer to the DPC Protocol +// +EFI_DPC_PROTOCOL *mDpc; + +/** + This constructor function caches the EFI_DPC_PROTOCOL pointer. + + @param[in] ImageHandle The firmware allocated handle for the EFI image. + @param[in] SystemTable A pointer to the EFI System Table. + + @retval EFI_SUCCESS The constructor always return EFI_SUCCESS. + +**/ +EFI_STATUS +EFIAPI +DpcLibConstructor ( + IN EFI_HANDLE ImageHandle, + IN EFI_SYSTEM_TABLE *SystemTable + ) +{ + EFI_STATUS Status; + + // + // Locate the EFI_DPC_PROTOCOL in the handle database + // + Status = gBS->LocateProtocol (&gEfiDpcProtocolGuid, NULL, (VOID **)&mDpc); + ASSERT_EFI_ERROR (Status); + + return Status; +} + +/** + Add a Deferred Procedure Call to the end of the DPC queue. + + @param[in] DpcTpl The EFI_TPL that the DPC should be invoked. + @param[in] DpcProcedure Pointer to the DPC's function. + @param[in] DpcContext Pointer to the DPC's context. Passed to DpcProcedure + when DpcProcedure is invoked. + + @retval EFI_SUCCESS The DPC was queued. + @retval EFI_INVALID_PARAMETER DpcTpl is not a valid EFI_TPL. + @retval EFI_INVALID_PARAMETER DpcProcedure is NULL. + @retval EFI_OUT_OF_RESOURCES There are not enough resources available to + add the DPC to the queue. + +**/ +EFI_STATUS +EFIAPI +QueueDpc ( + IN EFI_TPL DpcTpl, + IN EFI_DPC_PROCEDURE DpcProcedure, + IN VOID *DpcContext OPTIONAL + ) +{ + // + // Call the EFI_DPC_PROTOCOL to queue the DPC + // + return mDpc->QueueDpc (mDpc, DpcTpl, DpcProcedure, DpcContext); +} + +/** + Dispatch the queue of DPCs. ALL DPCs that have been queued with a DpcTpl + value greater than or equal to the current TPL are invoked in the order that + they were queued. DPCs with higher DpcTpl values are invoked before DPCs with + lower DpcTpl values. + + @retval EFI_SUCCESS One or more DPCs were invoked. + @retval EFI_NOT_FOUND No DPCs were invoked. + +**/ +EFI_STATUS +EFIAPI +DispatchDpc ( + VOID + ) +{ + // + // Call the EFI_DPC_PROTOCOL to dispatch previously queued DPCs + // + return mDpc->DispatchDpc (mDpc); +} diff --git a/NetworkPkg/Library/DxeDpcLib/DxeDpcLib.inf b/NetworkPkg/Library/DxeDpcLib/DxeDpcLib.inf new file mode 100644 index 0000000000..1c23729ce3 --- /dev/null +++ b/NetworkPkg/Library/DxeDpcLib/DxeDpcLib.inf @@ -0,0 +1,40 @@ +## @file +# This library instance provides DPC service by consuming EFI DPC Protocol. +# +# Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
+# SPDX-License-Identifier: BSD-2-Clause-Patent +# +## + +[Defines] + INF_VERSION = 0x00010005 + BASE_NAME = DxeDpcLib + MODULE_UNI_FILE = DxeDpcLib.uni + FILE_GUID = 38897D86-FF36-4472-AE64-1DB9AE715C81 + MODULE_TYPE = DXE_DRIVER + VERSION_STRING = 1.0 + LIBRARY_CLASS = DpcLib|DXE_CORE DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER + CONSTRUCTOR = DpcLibConstructor + +# +# The following information is for reference only and not required by the build tools. +# +# VALID_ARCHITECTURES = IA32 X64 EBC +# + +[Sources] + DpcLib.c + +[Packages] + MdePkg/MdePkg.dec + MdeModulePkg/MdeModulePkg.dec + +[LibraryClasses] + DebugLib + UefiBootServicesTableLib + +[Protocols] + gEfiDpcProtocolGuid ## CONSUMES + +[Depex.common.DXE_DRIVER, Depex.common.DXE_RUNTIME_DRIVER, Depex.common.DXE_SAL_DRIVER, Depex.common.DXE_SMM_DRIVER] + gEfiDpcProtocolGuid diff --git a/NetworkPkg/Library/DxeDpcLib/DxeDpcLib.uni b/NetworkPkg/Library/DxeDpcLib/DxeDpcLib.uni new file mode 100644 index 0000000000..3105bbcfe0 --- /dev/null +++ b/NetworkPkg/Library/DxeDpcLib/DxeDpcLib.uni @@ -0,0 +1,16 @@ +// /** @file +// This library instance provides DPC service by consuming EFI DPC Protocol. +// +// This library instance provides the DPC service by consuming EFI DPC Protocol. +// +// Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
+// +// SPDX-License-Identifier: BSD-2-Clause-Patent +// +// **/ + + +#string STR_MODULE_ABSTRACT #language en-US "Provides the DPC service by consuming EFI DPC Protocol" + +#string STR_MODULE_DESCRIPTION #language en-US "This library instance provides the DPC service by consuming EFI DPC Protocol." + diff --git a/NetworkPkg/Library/DxeHttpLib/DxeHttpLib.c b/NetworkPkg/Library/DxeHttpLib/DxeHttpLib.c new file mode 100644 index 0000000000..8b74554cd9 --- /dev/null +++ b/NetworkPkg/Library/DxeHttpLib/DxeHttpLib.c @@ -0,0 +1,2084 @@ +/** @file + This library is used to share code between UEFI network stack modules. + It provides the helper routines to parse the HTTP message byte stream. + +Copyright (c) 2015 - 2019, Intel Corporation. All rights reserved.
+(C) Copyright 2016 Hewlett Packard Enterprise Development LP
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "DxeHttpLib.h" + + + +/** + Decode a percent-encoded URI component to the ASCII character. + + Decode the input component in Buffer according to RFC 3986. The caller is responsible to make + sure ResultBuffer points to a buffer with size equal or greater than ((AsciiStrSize (Buffer)) + in bytes. + + @param[in] Buffer The pointer to a percent-encoded URI component. + @param[in] BufferLength Length of Buffer in bytes. + @param[out] ResultBuffer Point to the buffer to store the decode result. + @param[out] ResultLength Length of decoded string in ResultBuffer in bytes. + + @retval EFI_SUCCESS Successfully decoded the URI. + @retval EFI_INVALID_PARAMETER Buffer is not a valid percent-encoded string. + +**/ +EFI_STATUS +EFIAPI +UriPercentDecode ( + IN CHAR8 *Buffer, + IN UINT32 BufferLength, + OUT CHAR8 *ResultBuffer, + OUT UINT32 *ResultLength + ) +{ + UINTN Index; + UINTN Offset; + CHAR8 HexStr[3]; + + if (Buffer == NULL || BufferLength == 0 || ResultBuffer == NULL) { + return EFI_INVALID_PARAMETER; + } + + Index = 0; + Offset = 0; + HexStr[2] = '\0'; + while (Index < BufferLength) { + if (Buffer[Index] == '%') { + if (Index + 1 >= BufferLength || Index + 2 >= BufferLength || + !NET_IS_HEX_CHAR (Buffer[Index+1]) || !NET_IS_HEX_CHAR (Buffer[Index+2])) { + return EFI_INVALID_PARAMETER; + } + HexStr[0] = Buffer[Index+1]; + HexStr[1] = Buffer[Index+2]; + ResultBuffer[Offset] = (CHAR8) AsciiStrHexToUintn (HexStr); + Index += 3; + } else { + ResultBuffer[Offset] = Buffer[Index]; + Index++; + } + Offset++; + } + + *ResultLength = (UINT32) Offset; + + return EFI_SUCCESS; +} + +/** + This function return the updated state according to the input state and next character of + the authority. + + @param[in] Char Next character. + @param[in] State Current value of the parser state machine. + @param[in] IsRightBracket TRUE if there is an sign ']' in the authority component and + indicates the next part is ':' before Port. + + @return Updated state value. +**/ +HTTP_URL_PARSE_STATE +NetHttpParseAuthorityChar ( + IN CHAR8 Char, + IN HTTP_URL_PARSE_STATE State, + IN BOOLEAN *IsRightBracket + ) +{ + + // + // RFC 3986: + // The authority component is preceded by a double slash ("//") and is + // terminated by the next slash ("/"), question mark ("?"), or number + // sign ("#") character, or by the end of the URI. + // + if (Char == ' ' || Char == '\r' || Char == '\n') { + return UrlParserStateMax; + } + + // + // authority = [ userinfo "@" ] host [ ":" port ] + // + switch (State) { + case UrlParserUserInfo: + if (Char == '@') { + return UrlParserHostStart; + } + break; + + case UrlParserHost: + case UrlParserHostStart: + if (Char == '[') { + return UrlParserHostIpv6; + } + + if (Char == ':') { + return UrlParserPortStart; + } + + return UrlParserHost; + + case UrlParserHostIpv6: + if (Char == ']') { + *IsRightBracket = TRUE; + } + + if (Char == ':' && *IsRightBracket) { + return UrlParserPortStart; + } + return UrlParserHostIpv6; + + case UrlParserPort: + case UrlParserPortStart: + return UrlParserPort; + + default: + break; + } + + return State; +} + +/** + This function parse the authority component of the input URL and update the parser. + + @param[in] Url The pointer to a HTTP URL string. + @param[in] FoundAt TRUE if there is an at sign ('@') in the authority component. + @param[in, out] UrlParser Pointer to the buffer of the parse result. + + @retval EFI_SUCCESS Successfully parse the authority. + @retval EFI_INVALID_PARAMETER The Url is invalid to parse the authority component. + +**/ +EFI_STATUS +NetHttpParseAuthority ( + IN CHAR8 *Url, + IN BOOLEAN FoundAt, + IN OUT HTTP_URL_PARSER *UrlParser + ) +{ + CHAR8 *Char; + CHAR8 *Authority; + UINT32 Length; + HTTP_URL_PARSE_STATE State; + UINT32 Field; + UINT32 OldField; + BOOLEAN IsrightBracket; + + ASSERT ((UrlParser->FieldBitMap & BIT (HTTP_URI_FIELD_AUTHORITY)) != 0); + + // + // authority = [ userinfo "@" ] host [ ":" port ] + // + if (FoundAt) { + State = UrlParserUserInfo; + } else { + State = UrlParserHost; + } + + IsrightBracket = FALSE; + Field = HTTP_URI_FIELD_MAX; + OldField = Field; + Authority = Url + UrlParser->FieldData[HTTP_URI_FIELD_AUTHORITY].Offset; + Length = UrlParser->FieldData[HTTP_URI_FIELD_AUTHORITY].Length; + for (Char = Authority; Char < Authority + Length; Char++) { + State = NetHttpParseAuthorityChar (*Char, State, &IsrightBracket); + switch (State) { + case UrlParserStateMax: + return EFI_INVALID_PARAMETER; + + case UrlParserHostStart: + case UrlParserPortStart: + continue; + + case UrlParserUserInfo: + Field = HTTP_URI_FIELD_USERINFO; + break; + + case UrlParserHost: + Field = HTTP_URI_FIELD_HOST; + break; + + case UrlParserHostIpv6: + Field = HTTP_URI_FIELD_HOST; + break; + + case UrlParserPort: + Field = HTTP_URI_FIELD_PORT; + break; + + default: + ASSERT (FALSE); + } + + // + // Field not changed, count the length. + // + ASSERT (Field < HTTP_URI_FIELD_MAX); + if (Field == OldField) { + UrlParser->FieldData[Field].Length++; + continue; + } + + // + // New field start + // + UrlParser->FieldBitMap |= BIT (Field); + UrlParser->FieldData[Field].Offset = (UINT32) (Char - Url); + UrlParser->FieldData[Field].Length = 1; + OldField = Field; + } + + return EFI_SUCCESS; +} + +/** + This function return the updated state according to the input state and next character of a URL. + + @param[in] Char Next character. + @param[in] State Current value of the parser state machine. + + @return Updated state value. + +**/ +HTTP_URL_PARSE_STATE +NetHttpParseUrlChar ( + IN CHAR8 Char, + IN HTTP_URL_PARSE_STATE State + ) +{ + if (Char == ' ' || Char == '\r' || Char == '\n') { + return UrlParserStateMax; + } + + // + // http_URL = "http:" "//" host [ ":" port ] [ abs_path [ "?" query ]] + // + // Request-URI = "*" | absolute-URI | path-absolute | authority + // + // absolute-URI = scheme ":" hier-part [ "?" query ] + // path-absolute = "/" [ segment-nz *( "/" segment ) ] + // authority = [ userinfo "@" ] host [ ":" port ] + // + switch (State) { + case UrlParserUrlStart: + if (Char == '*' || Char == '/') { + return UrlParserPath; + } + return UrlParserScheme; + + case UrlParserScheme: + if (Char == ':') { + return UrlParserSchemeColon; + } + break; + + case UrlParserSchemeColon: + if (Char == '/') { + return UrlParserSchemeColonSlash; + } + break; + + case UrlParserSchemeColonSlash: + if (Char == '/') { + return UrlParserSchemeColonSlashSlash; + } + break; + + case UrlParserAtInAuthority: + if (Char == '@') { + return UrlParserStateMax; + } + + case UrlParserAuthority: + case UrlParserSchemeColonSlashSlash: + if (Char == '@') { + return UrlParserAtInAuthority; + } + if (Char == '/') { + return UrlParserPath; + } + if (Char == '?') { + return UrlParserQueryStart; + } + if (Char == '#') { + return UrlParserFragmentStart; + } + return UrlParserAuthority; + + case UrlParserPath: + if (Char == '?') { + return UrlParserQueryStart; + } + if (Char == '#') { + return UrlParserFragmentStart; + } + break; + + case UrlParserQuery: + case UrlParserQueryStart: + if (Char == '#') { + return UrlParserFragmentStart; + } + return UrlParserQuery; + + case UrlParserFragmentStart: + return UrlParserFragment; + + default: + break; + } + + return State; +} +/** + Create a URL parser for the input URL string. + + This function will parse and dereference the input HTTP URL into it components. The original + content of the URL won't be modified and the result will be returned in UrlParser, which can + be used in other functions like NetHttpUrlGetHostName(). + + @param[in] Url The pointer to a HTTP URL string. + @param[in] Length Length of Url in bytes. + @param[in] IsConnectMethod Whether the Url is used in HTTP CONNECT method or not. + @param[out] UrlParser Pointer to the returned buffer to store the parse result. + + @retval EFI_SUCCESS Successfully dereferenced the HTTP URL. + @retval EFI_INVALID_PARAMETER UrlParser is NULL or Url is not a valid HTTP URL. + @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources. + +**/ +EFI_STATUS +EFIAPI +HttpParseUrl ( + IN CHAR8 *Url, + IN UINT32 Length, + IN BOOLEAN IsConnectMethod, + OUT VOID **UrlParser + ) +{ + HTTP_URL_PARSE_STATE State; + CHAR8 *Char; + UINT32 Field; + UINT32 OldField; + BOOLEAN FoundAt; + EFI_STATUS Status; + HTTP_URL_PARSER *Parser; + + Parser = NULL; + + if (Url == NULL || Length == 0 || UrlParser == NULL) { + return EFI_INVALID_PARAMETER; + } + + Parser = AllocateZeroPool (sizeof (HTTP_URL_PARSER)); + if (Parser == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + if (IsConnectMethod) { + // + // According to RFC 2616, the authority form is only used by the CONNECT method. + // + State = UrlParserAuthority; + } else { + State = UrlParserUrlStart; + } + + Field = HTTP_URI_FIELD_MAX; + OldField = Field; + FoundAt = FALSE; + for (Char = Url; Char < Url + Length; Char++) { + // + // Update state machine according to next char. + // + State = NetHttpParseUrlChar (*Char, State); + + switch (State) { + case UrlParserStateMax: + FreePool (Parser); + return EFI_INVALID_PARAMETER; + + case UrlParserSchemeColon: + case UrlParserSchemeColonSlash: + case UrlParserSchemeColonSlashSlash: + case UrlParserQueryStart: + case UrlParserFragmentStart: + // + // Skip all the delimiting char: "://" "?" "@" + // + continue; + + case UrlParserScheme: + Field = HTTP_URI_FIELD_SCHEME; + break; + + case UrlParserAtInAuthority: + FoundAt = TRUE; + case UrlParserAuthority: + Field = HTTP_URI_FIELD_AUTHORITY; + break; + + case UrlParserPath: + Field = HTTP_URI_FIELD_PATH; + break; + + case UrlParserQuery: + Field = HTTP_URI_FIELD_QUERY; + break; + + case UrlParserFragment: + Field = HTTP_URI_FIELD_FRAGMENT; + break; + + default: + ASSERT (FALSE); + } + + // + // Field not changed, count the length. + // + ASSERT (Field < HTTP_URI_FIELD_MAX); + if (Field == OldField) { + Parser->FieldData[Field].Length++; + continue; + } + + // + // New field start + // + Parser->FieldBitMap |= BIT (Field); + Parser->FieldData[Field].Offset = (UINT32) (Char - Url); + Parser->FieldData[Field].Length = 1; + OldField = Field; + } + + // + // If has authority component, continue to parse the username, host and port. + // + if ((Parser->FieldBitMap & BIT (HTTP_URI_FIELD_AUTHORITY)) != 0) { + Status = NetHttpParseAuthority (Url, FoundAt, Parser); + if (EFI_ERROR (Status)) { + FreePool (Parser); + return Status; + } + } + + *UrlParser = Parser; + return EFI_SUCCESS; +} + +/** + Get the Hostname from a HTTP URL. + + This function will return the HostName according to the Url and previous parse result ,and + it is the caller's responsibility to free the buffer returned in *HostName. + + @param[in] Url The pointer to a HTTP URL string. + @param[in] UrlParser URL Parse result returned by NetHttpParseUrl(). + @param[out] HostName Pointer to a buffer to store the HostName. + + @retval EFI_SUCCESS Successfully get the required component. + @retval EFI_INVALID_PARAMETER Uri is NULL or HostName is NULL or UrlParser is invalid. + @retval EFI_NOT_FOUND No hostName component in the URL. + @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources. + +**/ +EFI_STATUS +EFIAPI +HttpUrlGetHostName ( + IN CHAR8 *Url, + IN VOID *UrlParser, + OUT CHAR8 **HostName + ) +{ + CHAR8 *Name; + EFI_STATUS Status; + UINT32 ResultLength; + HTTP_URL_PARSER *Parser; + + if (Url == NULL || UrlParser == NULL || HostName == NULL) { + return EFI_INVALID_PARAMETER; + } + + Parser = (HTTP_URL_PARSER *) UrlParser; + + if ((Parser->FieldBitMap & BIT (HTTP_URI_FIELD_HOST)) == 0) { + return EFI_NOT_FOUND; + } + + Name = AllocatePool (Parser->FieldData[HTTP_URI_FIELD_HOST].Length + 1); + if (Name == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + Status = UriPercentDecode ( + Url + Parser->FieldData[HTTP_URI_FIELD_HOST].Offset, + Parser->FieldData[HTTP_URI_FIELD_HOST].Length, + Name, + &ResultLength + ); + if (EFI_ERROR (Status)) { + FreePool (Name); + return Status; + } + + Name[ResultLength] = '\0'; + *HostName = Name; + return EFI_SUCCESS; +} + + +/** + Get the IPv4 address from a HTTP URL. + + This function will return the IPv4 address according to the Url and previous parse result. + + @param[in] Url The pointer to a HTTP URL string. + @param[in] UrlParser URL Parse result returned by NetHttpParseUrl(). + @param[out] Ip4Address Pointer to a buffer to store the IP address. + + @retval EFI_SUCCESS Successfully get the required component. + @retval EFI_INVALID_PARAMETER Uri is NULL or Ip4Address is NULL or UrlParser is invalid. + @retval EFI_NOT_FOUND No IPv4 address component in the URL. + @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources. + +**/ +EFI_STATUS +EFIAPI +HttpUrlGetIp4 ( + IN CHAR8 *Url, + IN VOID *UrlParser, + OUT EFI_IPv4_ADDRESS *Ip4Address + ) +{ + CHAR8 *Ip4String; + EFI_STATUS Status; + UINT32 ResultLength; + HTTP_URL_PARSER *Parser; + + if (Url == NULL || UrlParser == NULL || Ip4Address == NULL) { + return EFI_INVALID_PARAMETER; + } + + Parser = (HTTP_URL_PARSER *) UrlParser; + + if ((Parser->FieldBitMap & BIT (HTTP_URI_FIELD_HOST)) == 0) { + return EFI_NOT_FOUND; + } + + Ip4String = AllocatePool (Parser->FieldData[HTTP_URI_FIELD_HOST].Length + 1); + if (Ip4String == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + Status = UriPercentDecode ( + Url + Parser->FieldData[HTTP_URI_FIELD_HOST].Offset, + Parser->FieldData[HTTP_URI_FIELD_HOST].Length, + Ip4String, + &ResultLength + ); + if (EFI_ERROR (Status)) { + FreePool (Ip4String); + return Status; + } + + Ip4String[ResultLength] = '\0'; + Status = NetLibAsciiStrToIp4 (Ip4String, Ip4Address); + FreePool (Ip4String); + + return Status; +} + +/** + Get the IPv6 address from a HTTP URL. + + This function will return the IPv6 address according to the Url and previous parse result. + + @param[in] Url The pointer to a HTTP URL string. + @param[in] UrlParser URL Parse result returned by NetHttpParseUrl(). + @param[out] Ip6Address Pointer to a buffer to store the IP address. + + @retval EFI_SUCCESS Successfully get the required component. + @retval EFI_INVALID_PARAMETER Uri is NULL or Ip6Address is NULL or UrlParser is invalid. + @retval EFI_NOT_FOUND No IPv6 address component in the URL. + @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources. + +**/ +EFI_STATUS +EFIAPI +HttpUrlGetIp6 ( + IN CHAR8 *Url, + IN VOID *UrlParser, + OUT EFI_IPv6_ADDRESS *Ip6Address + ) +{ + CHAR8 *Ip6String; + CHAR8 *Ptr; + UINT32 Length; + EFI_STATUS Status; + UINT32 ResultLength; + HTTP_URL_PARSER *Parser; + + if (Url == NULL || UrlParser == NULL || Ip6Address == NULL) { + return EFI_INVALID_PARAMETER; + } + + Parser = (HTTP_URL_PARSER *) UrlParser; + + if ((Parser->FieldBitMap & BIT (HTTP_URI_FIELD_HOST)) == 0) { + return EFI_NOT_FOUND; + } + + // + // IP-literal = "[" ( IPv6address / IPvFuture ) "]" + // + Length = Parser->FieldData[HTTP_URI_FIELD_HOST].Length; + if (Length < 2) { + return EFI_INVALID_PARAMETER; + } + + Ptr = Url + Parser->FieldData[HTTP_URI_FIELD_HOST].Offset; + if ((Ptr[0] != '[') || (Ptr[Length - 1] != ']')) { + return EFI_INVALID_PARAMETER; + } + + Ip6String = AllocatePool (Length); + if (Ip6String == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + Status = UriPercentDecode ( + Ptr + 1, + Length - 2, + Ip6String, + &ResultLength + ); + if (EFI_ERROR (Status)) { + FreePool (Ip6String); + return Status; + } + + Ip6String[ResultLength] = '\0'; + Status = NetLibAsciiStrToIp6 (Ip6String, Ip6Address); + FreePool (Ip6String); + + return Status; +} + +/** + Get the port number from a HTTP URL. + + This function will return the port number according to the Url and previous parse result. + + @param[in] Url The pointer to a HTTP URL string. + @param[in] UrlParser URL Parse result returned by NetHttpParseUrl(). + @param[out] Port Pointer to a buffer to store the port number. + + @retval EFI_SUCCESS Successfully get the required component. + @retval EFI_INVALID_PARAMETER Uri is NULL or Port is NULL or UrlParser is invalid. + @retval EFI_NOT_FOUND No port number in the URL. + @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources. + +**/ +EFI_STATUS +EFIAPI +HttpUrlGetPort ( + IN CHAR8 *Url, + IN VOID *UrlParser, + OUT UINT16 *Port + ) +{ + CHAR8 *PortString; + EFI_STATUS Status; + UINTN Index; + UINTN Data; + UINT32 ResultLength; + HTTP_URL_PARSER *Parser; + + if (Url == NULL || UrlParser == NULL || Port == NULL) { + return EFI_INVALID_PARAMETER; + } + + *Port = 0; + Index = 0; + + Parser = (HTTP_URL_PARSER *) UrlParser; + + if ((Parser->FieldBitMap & BIT (HTTP_URI_FIELD_PORT)) == 0) { + return EFI_NOT_FOUND; + } + + PortString = AllocatePool (Parser->FieldData[HTTP_URI_FIELD_PORT].Length + 1); + if (PortString == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + Status = UriPercentDecode ( + Url + Parser->FieldData[HTTP_URI_FIELD_PORT].Offset, + Parser->FieldData[HTTP_URI_FIELD_PORT].Length, + PortString, + &ResultLength + ); + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } + + PortString[ResultLength] = '\0'; + + while (Index < ResultLength) { + if (!NET_IS_DIGIT (PortString[Index])) { + Status = EFI_INVALID_PARAMETER; + goto ON_EXIT; + } + Index ++; + } + + Status = AsciiStrDecimalToUintnS (Url + Parser->FieldData[HTTP_URI_FIELD_PORT].Offset, (CHAR8 **) NULL, &Data); + + if (Data > HTTP_URI_PORT_MAX_NUM) { + Status = EFI_INVALID_PARAMETER; + goto ON_EXIT; + } + + *Port = (UINT16) Data; + +ON_EXIT: + FreePool (PortString); + return Status; +} + +/** + Get the Path from a HTTP URL. + + This function will return the Path according to the Url and previous parse result,and + it is the caller's responsibility to free the buffer returned in *Path. + + @param[in] Url The pointer to a HTTP URL string. + @param[in] UrlParser URL Parse result returned by NetHttpParseUrl(). + @param[out] Path Pointer to a buffer to store the Path. + + @retval EFI_SUCCESS Successfully get the required component. + @retval EFI_INVALID_PARAMETER Uri is NULL or HostName is NULL or UrlParser is invalid. + @retval EFI_NOT_FOUND No hostName component in the URL. + @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources. + +**/ +EFI_STATUS +EFIAPI +HttpUrlGetPath ( + IN CHAR8 *Url, + IN VOID *UrlParser, + OUT CHAR8 **Path + ) +{ + CHAR8 *PathStr; + EFI_STATUS Status; + UINT32 ResultLength; + HTTP_URL_PARSER *Parser; + + if (Url == NULL || UrlParser == NULL || Path == NULL) { + return EFI_INVALID_PARAMETER; + } + + Parser = (HTTP_URL_PARSER *) UrlParser; + + if ((Parser->FieldBitMap & BIT (HTTP_URI_FIELD_PATH)) == 0) { + return EFI_NOT_FOUND; + } + + PathStr = AllocatePool (Parser->FieldData[HTTP_URI_FIELD_PATH].Length + 1); + if (PathStr == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + Status = UriPercentDecode ( + Url + Parser->FieldData[HTTP_URI_FIELD_PATH].Offset, + Parser->FieldData[HTTP_URI_FIELD_PATH].Length, + PathStr, + &ResultLength + ); + if (EFI_ERROR (Status)) { + FreePool (PathStr); + return Status; + } + + PathStr[ResultLength] = '\0'; + *Path = PathStr; + return EFI_SUCCESS; +} + +/** + Release the resource of the URL parser. + + @param[in] UrlParser Pointer to the parser. + +**/ +VOID +EFIAPI +HttpUrlFreeParser ( + IN VOID *UrlParser + ) +{ + FreePool (UrlParser); +} + +/** + Find a specified header field according to the field name. + + @param[in] HeaderCount Number of HTTP header structures in Headers list. + @param[in] Headers Array containing list of HTTP headers. + @param[in] FieldName Null terminated string which describes a field name. + + @return Pointer to the found header or NULL. + +**/ +EFI_HTTP_HEADER * +EFIAPI +HttpFindHeader ( + IN UINTN HeaderCount, + IN EFI_HTTP_HEADER *Headers, + IN CHAR8 *FieldName + ) +{ + UINTN Index; + + if (HeaderCount == 0 || Headers == NULL || FieldName == NULL) { + return NULL; + } + + for (Index = 0; Index < HeaderCount; Index++){ + // + // Field names are case-insensitive (RFC 2616). + // + if (AsciiStriCmp (Headers[Index].FieldName, FieldName) == 0) { + return &Headers[Index]; + } + } + return NULL; +} + +typedef enum { + BodyParserBodyStart, + BodyParserBodyIdentity, + BodyParserChunkSizeStart, + BodyParserChunkSize, + BodyParserChunkSizeEndCR, + BodyParserChunkExtStart, + BodyParserChunkDataStart, + BodyParserChunkDataEnd, + BodyParserChunkDataEndCR, + BodyParserTrailer, + BodyParserLastCRLF, + BodyParserLastCRLFEnd, + BodyParserComplete, + BodyParserStateMax +} HTTP_BODY_PARSE_STATE; + +typedef struct { + BOOLEAN IgnoreBody; // "MUST NOT" include a message-body + BOOLEAN IsChunked; // "chunked" transfer-coding. + BOOLEAN ContentLengthIsValid; + UINTN ContentLength; // Entity length (not the message-body length), invalid until ContentLengthIsValid is TRUE + + HTTP_BODY_PARSER_CALLBACK Callback; + VOID *Context; + UINTN ParsedBodyLength; + HTTP_BODY_PARSE_STATE State; + UINTN CurrentChunkSize; + UINTN CurrentChunkParsedSize; +} HTTP_BODY_PARSER; + +/** + Convert an hexadecimal char to a value of type UINTN. + + @param[in] Char Ascii character. + + @return Value translated from Char. + +**/ +UINTN +HttpIoHexCharToUintn ( + IN CHAR8 Char + ) +{ + if (Char >= '0' && Char <= '9') { + return Char - '0'; + } + + return (10 + AsciiCharToUpper (Char) - 'A'); +} + +/** + Get the value of the content length if there is a "Content-Length" header. + + @param[in] HeaderCount Number of HTTP header structures in Headers. + @param[in] Headers Array containing list of HTTP headers. + @param[out] ContentLength Pointer to save the value of the content length. + + @retval EFI_SUCCESS Successfully get the content length. + @retval EFI_NOT_FOUND No "Content-Length" header in the Headers. + +**/ +EFI_STATUS +HttpIoParseContentLengthHeader ( + IN UINTN HeaderCount, + IN EFI_HTTP_HEADER *Headers, + OUT UINTN *ContentLength + ) +{ + EFI_HTTP_HEADER *Header; + + Header = HttpFindHeader (HeaderCount, Headers, HTTP_HEADER_CONTENT_LENGTH); + if (Header == NULL) { + return EFI_NOT_FOUND; + } + + return AsciiStrDecimalToUintnS (Header->FieldValue, (CHAR8 **) NULL, ContentLength); +} + +/** + + Check whether the HTTP message is using the "chunked" transfer-coding. + + @param[in] HeaderCount Number of HTTP header structures in Headers. + @param[in] Headers Array containing list of HTTP headers. + + @return The message is "chunked" transfer-coding (TRUE) or not (FALSE). + +**/ +BOOLEAN +HttpIoIsChunked ( + IN UINTN HeaderCount, + IN EFI_HTTP_HEADER *Headers + ) +{ + EFI_HTTP_HEADER *Header; + + + Header = HttpFindHeader (HeaderCount, Headers, HTTP_HEADER_TRANSFER_ENCODING); + if (Header == NULL) { + return FALSE; + } + + if (AsciiStriCmp (Header->FieldValue, "identity") != 0) { + return TRUE; + } + + return FALSE; +} + +/** + Check whether the HTTP message should have a message-body. + + @param[in] Method The HTTP method (e.g. GET, POST) for this HTTP message. + @param[in] StatusCode Response status code returned by the remote host. + + @return The message should have a message-body (FALSE) or not (TRUE). + +**/ +BOOLEAN +HttpIoNoMessageBody ( + IN EFI_HTTP_METHOD Method, + IN EFI_HTTP_STATUS_CODE StatusCode + ) +{ + // + // RFC 2616: + // All responses to the HEAD request method + // MUST NOT include a message-body, even though the presence of entity- + // header fields might lead one to believe they do. All 1xx + // (informational), 204 (no content), and 304 (not modified) responses + // MUST NOT include a message-body. All other responses do include a + // message-body, although it MAY be of zero length. + // + if (Method == HttpMethodHead) { + return TRUE; + } + + if ((StatusCode == HTTP_STATUS_100_CONTINUE) || + (StatusCode == HTTP_STATUS_101_SWITCHING_PROTOCOLS) || + (StatusCode == HTTP_STATUS_204_NO_CONTENT) || + (StatusCode == HTTP_STATUS_304_NOT_MODIFIED)) + { + return TRUE; + } + + return FALSE; +} + +/** + Initialize a HTTP message-body parser. + + This function will create and initialize a HTTP message parser according to caller provided HTTP message + header information. It is the caller's responsibility to free the buffer returned in *UrlParser by HttpFreeMsgParser(). + + @param[in] Method The HTTP method (e.g. GET, POST) for this HTTP message. + @param[in] StatusCode Response status code returned by the remote host. + @param[in] HeaderCount Number of HTTP header structures in Headers. + @param[in] Headers Array containing list of HTTP headers. + @param[in] Callback Callback function that is invoked when parsing the HTTP message-body, + set to NULL to ignore all events. + @param[in] Context Pointer to the context that will be passed to Callback. + @param[out] MsgParser Pointer to the returned buffer to store the message parser. + + @retval EFI_SUCCESS Successfully initialized the parser. + @retval EFI_OUT_OF_RESOURCES Could not allocate needed resources. + @retval EFI_INVALID_PARAMETER MsgParser is NULL or HeaderCount is not NULL but Headers is NULL. + @retval Others Failed to initialize the parser. + +**/ +EFI_STATUS +EFIAPI +HttpInitMsgParser ( + IN EFI_HTTP_METHOD Method, + IN EFI_HTTP_STATUS_CODE StatusCode, + IN UINTN HeaderCount, + IN EFI_HTTP_HEADER *Headers, + IN HTTP_BODY_PARSER_CALLBACK Callback, + IN VOID *Context, + OUT VOID **MsgParser + ) +{ + EFI_STATUS Status; + HTTP_BODY_PARSER *Parser; + + if (HeaderCount != 0 && Headers == NULL) { + return EFI_INVALID_PARAMETER; + } + + if (MsgParser == NULL) { + return EFI_INVALID_PARAMETER; + } + + Parser = AllocateZeroPool (sizeof (HTTP_BODY_PARSER)); + if (Parser == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + Parser->State = BodyParserBodyStart; + + // + // Determine the message length according to RFC 2616. + // 1. Check whether the message "MUST NOT" have a message-body. + // + Parser->IgnoreBody = HttpIoNoMessageBody (Method, StatusCode); + // + // 2. Check whether the message using "chunked" transfer-coding. + // + Parser->IsChunked = HttpIoIsChunked (HeaderCount, Headers); + // + // 3. Check whether the message has a Content-Length header field. + // + Status = HttpIoParseContentLengthHeader (HeaderCount, Headers, &Parser->ContentLength); + if (!EFI_ERROR (Status)) { + Parser->ContentLengthIsValid = TRUE; + } + // + // 4. Range header is not supported now, so we won't meet media type "multipart/byteranges". + // 5. By server closing the connection + // + + // + // Set state to skip body parser if the message shouldn't have a message body. + // + if (Parser->IgnoreBody) { + Parser->State = BodyParserComplete; + } else { + Parser->Callback = Callback; + Parser->Context = Context; + } + + *MsgParser = Parser; + return EFI_SUCCESS; +} + +/** + Parse message body. + + Parse BodyLength of message-body. This function can be called repeatedly to parse the message-body partially. + + @param[in, out] MsgParser Pointer to the message parser. + @param[in] BodyLength Length in bytes of the Body. + @param[in] Body Pointer to the buffer of the message-body to be parsed. + + @retval EFI_SUCCESS Successfully parse the message-body. + @retval EFI_INVALID_PARAMETER MsgParser is NULL or Body is NULL or BodyLength is 0. + @retval EFI_ABORTED Operation aborted. + @retval Other Error happened while parsing message body. + +**/ +EFI_STATUS +EFIAPI +HttpParseMessageBody ( + IN OUT VOID *MsgParser, + IN UINTN BodyLength, + IN CHAR8 *Body + ) +{ + CHAR8 *Char; + UINTN RemainderLengthInThis; + UINTN LengthForCallback; + EFI_STATUS Status; + HTTP_BODY_PARSER *Parser; + + if (BodyLength == 0 || Body == NULL) { + return EFI_INVALID_PARAMETER; + } + + if (MsgParser == NULL) { + return EFI_INVALID_PARAMETER; + } + + Parser = (HTTP_BODY_PARSER *) MsgParser; + + if (Parser->IgnoreBody) { + Parser->State = BodyParserComplete; + if (Parser->Callback != NULL) { + Status = Parser->Callback ( + BodyParseEventOnComplete, + Body, + 0, + Parser->Context + ); + if (EFI_ERROR (Status)) { + return Status; + } + } + return EFI_SUCCESS; + } + + if (Parser->State == BodyParserBodyStart) { + Parser->ParsedBodyLength = 0; + if (Parser->IsChunked) { + Parser->State = BodyParserChunkSizeStart; + } else { + Parser->State = BodyParserBodyIdentity; + } + } + + // + // The message body might be truncated in anywhere, so we need to parse is byte-by-byte. + // + for (Char = Body; Char < Body + BodyLength; ) { + + switch (Parser->State) { + case BodyParserStateMax: + return EFI_ABORTED; + + case BodyParserBodyIdentity: + // + // Identity transfer-coding, just notify user to save the body data. + // + if (Parser->Callback != NULL) { + Status = Parser->Callback ( + BodyParseEventOnData, + Char, + MIN (BodyLength, Parser->ContentLength - Parser->ParsedBodyLength), + Parser->Context + ); + if (EFI_ERROR (Status)) { + return Status; + } + } + Char += MIN (BodyLength, Parser->ContentLength - Parser->ParsedBodyLength); + Parser->ParsedBodyLength += MIN (BodyLength, Parser->ContentLength - Parser->ParsedBodyLength); + if (Parser->ParsedBodyLength == Parser->ContentLength) { + Parser->State = BodyParserComplete; + if (Parser->Callback != NULL) { + Status = Parser->Callback ( + BodyParseEventOnComplete, + Char, + 0, + Parser->Context + ); + if (EFI_ERROR (Status)) { + return Status; + } + } + } + break; + + case BodyParserChunkSizeStart: + // + // First byte of chunk-size, the chunk-size might be truncated. + // + Parser->CurrentChunkSize = 0; + Parser->State = BodyParserChunkSize; + case BodyParserChunkSize: + if (!NET_IS_HEX_CHAR (*Char)) { + if (*Char == ';') { + Parser->State = BodyParserChunkExtStart; + Char++; + } else if (*Char == '\r') { + Parser->State = BodyParserChunkSizeEndCR; + Char++; + } else { + Parser->State = BodyParserStateMax; + } + break; + } + + if (Parser->CurrentChunkSize > (((~((UINTN) 0)) - 16) / 16)) { + return EFI_INVALID_PARAMETER; + } + Parser->CurrentChunkSize = Parser->CurrentChunkSize * 16 + HttpIoHexCharToUintn (*Char); + Char++; + break; + + case BodyParserChunkExtStart: + // + // Ignore all the chunk extensions. + // + if (*Char == '\r') { + Parser->State = BodyParserChunkSizeEndCR; + } + Char++; + break; + + case BodyParserChunkSizeEndCR: + if (*Char != '\n') { + Parser->State = BodyParserStateMax; + break; + } + Char++; + if (Parser->CurrentChunkSize == 0) { + // + // The last chunk has been parsed and now assumed the state + // of HttpBodyParse is ParserLastCRLF. So it need to decide + // whether the rest message is trailer or last CRLF in the next round. + // + Parser->ContentLengthIsValid = TRUE; + Parser->State = BodyParserLastCRLF; + break; + } + Parser->State = BodyParserChunkDataStart; + Parser->CurrentChunkParsedSize = 0; + break; + + case BodyParserLastCRLF: + // + // Judge the byte is belong to the Last CRLF or trailer, and then + // configure the state of HttpBodyParse to corresponding state. + // + if (*Char == '\r') { + Char++; + Parser->State = BodyParserLastCRLFEnd; + break; + } else { + Parser->State = BodyParserTrailer; + break; + } + + case BodyParserLastCRLFEnd: + if (*Char == '\n') { + Parser->State = BodyParserComplete; + Char++; + if (Parser->Callback != NULL) { + Status = Parser->Callback ( + BodyParseEventOnComplete, + Char, + 0, + Parser->Context + ); + if (EFI_ERROR (Status)) { + return Status; + } + } + break; + } else { + Parser->State = BodyParserStateMax; + break; + } + + case BodyParserTrailer: + if (*Char == '\r') { + Parser->State = BodyParserChunkSizeEndCR; + } + Char++; + break; + + case BodyParserChunkDataStart: + // + // First byte of chunk-data, the chunk data also might be truncated. + // + RemainderLengthInThis = BodyLength - (Char - Body); + LengthForCallback = MIN (Parser->CurrentChunkSize - Parser->CurrentChunkParsedSize, RemainderLengthInThis); + if (Parser->Callback != NULL) { + Status = Parser->Callback ( + BodyParseEventOnData, + Char, + LengthForCallback, + Parser->Context + ); + if (EFI_ERROR (Status)) { + return Status; + } + } + Char += LengthForCallback; + Parser->ContentLength += LengthForCallback; + Parser->CurrentChunkParsedSize += LengthForCallback; + if (Parser->CurrentChunkParsedSize == Parser->CurrentChunkSize) { + Parser->State = BodyParserChunkDataEnd; + } + break; + + case BodyParserChunkDataEnd: + if (*Char == '\r') { + Parser->State = BodyParserChunkDataEndCR; + } else { + Parser->State = BodyParserStateMax; + } + Char++; + break; + + case BodyParserChunkDataEndCR: + if (*Char != '\n') { + Parser->State = BodyParserStateMax; + break; + } + Char++; + Parser->State = BodyParserChunkSizeStart; + break; + + default: + break; + } + + } + + if (Parser->State == BodyParserStateMax) { + return EFI_ABORTED; + } + + return EFI_SUCCESS; +} + +/** + Check whether the message-body is complete or not. + + @param[in] MsgParser Pointer to the message parser. + + @retval TRUE Message-body is complete. + @retval FALSE Message-body is not complete. + +**/ +BOOLEAN +EFIAPI +HttpIsMessageComplete ( + IN VOID *MsgParser + ) +{ + HTTP_BODY_PARSER *Parser; + + if (MsgParser == NULL) { + return FALSE; + } + + Parser = (HTTP_BODY_PARSER *) MsgParser; + + if (Parser->State == BodyParserComplete) { + return TRUE; + } + return FALSE; +} + +/** + Get the content length of the entity. + + Note that in trunk transfer, the entity length is not valid until the whole message body is received. + + @param[in] MsgParser Pointer to the message parser. + @param[out] ContentLength Pointer to store the length of the entity. + + @retval EFI_SUCCESS Successfully to get the entity length. + @retval EFI_NOT_READY Entity length is not valid yet. + @retval EFI_INVALID_PARAMETER MsgParser is NULL or ContentLength is NULL. + +**/ +EFI_STATUS +EFIAPI +HttpGetEntityLength ( + IN VOID *MsgParser, + OUT UINTN *ContentLength + ) +{ + HTTP_BODY_PARSER *Parser; + + if (MsgParser == NULL || ContentLength == NULL) { + return EFI_INVALID_PARAMETER; + } + + Parser = (HTTP_BODY_PARSER *) MsgParser; + + if (!Parser->ContentLengthIsValid) { + return EFI_NOT_READY; + } + + *ContentLength = Parser->ContentLength; + return EFI_SUCCESS; +} + +/** + Release the resource of the message parser. + + @param[in] MsgParser Pointer to the message parser. + +**/ +VOID +EFIAPI +HttpFreeMsgParser ( + IN VOID *MsgParser + ) +{ + FreePool (MsgParser); +} + + +/** + Get the next string, which is distinguished by specified separator. + + @param[in] String Pointer to the string. + @param[in] Separator Specified separator used to distinguish where is the beginning + of next string. + + @return Pointer to the next string. + @return NULL if not find or String is NULL. + +**/ +CHAR8 * +AsciiStrGetNextToken ( + IN CONST CHAR8 *String, + IN CHAR8 Separator + ) +{ + CONST CHAR8 *Token; + + Token = String; + while (TRUE) { + if (*Token == 0) { + return NULL; + } + if (*Token == Separator) { + return (CHAR8 *)(Token + 1); + } + Token++; + } +} + +/** + Set FieldName and FieldValue into specified HttpHeader. + + @param[in,out] HttpHeader Specified HttpHeader. + @param[in] FieldName FieldName of this HttpHeader, a NULL terminated ASCII string. + @param[in] FieldValue FieldValue of this HttpHeader, a NULL terminated ASCII string. + + + @retval EFI_SUCCESS The FieldName and FieldValue are set into HttpHeader successfully. + @retval EFI_INVALID_PARAMETER The parameter is invalid. + @retval EFI_OUT_OF_RESOURCES Failed to allocate resources. + +**/ +EFI_STATUS +EFIAPI +HttpSetFieldNameAndValue ( + IN OUT EFI_HTTP_HEADER *HttpHeader, + IN CONST CHAR8 *FieldName, + IN CONST CHAR8 *FieldValue + ) +{ + UINTN FieldNameSize; + UINTN FieldValueSize; + + if (HttpHeader == NULL || FieldName == NULL || FieldValue == NULL) { + return EFI_INVALID_PARAMETER; + } + + if (HttpHeader->FieldName != NULL) { + FreePool (HttpHeader->FieldName); + } + if (HttpHeader->FieldValue != NULL) { + FreePool (HttpHeader->FieldValue); + } + + FieldNameSize = AsciiStrSize (FieldName); + HttpHeader->FieldName = AllocateZeroPool (FieldNameSize); + if (HttpHeader->FieldName == NULL) { + return EFI_OUT_OF_RESOURCES; + } + CopyMem (HttpHeader->FieldName, FieldName, FieldNameSize); + HttpHeader->FieldName[FieldNameSize - 1] = 0; + + FieldValueSize = AsciiStrSize (FieldValue); + HttpHeader->FieldValue = AllocateZeroPool (FieldValueSize); + if (HttpHeader->FieldValue == NULL) { + FreePool (HttpHeader->FieldName); + return EFI_OUT_OF_RESOURCES; + } + CopyMem (HttpHeader->FieldValue, FieldValue, FieldValueSize); + HttpHeader->FieldValue[FieldValueSize - 1] = 0; + + return EFI_SUCCESS; +} + +/** + Get one key/value header pair from the raw string. + + @param[in] String Pointer to the raw string. + @param[out] FieldName Points directly to field name within 'HttpHeader'. + @param[out] FieldValue Points directly to field value within 'HttpHeader'. + + @return Pointer to the next raw string. + @return NULL if no key/value header pair from this raw string. + +**/ +CHAR8 * +EFIAPI +HttpGetFieldNameAndValue ( + IN CHAR8 *String, + OUT CHAR8 **FieldName, + OUT CHAR8 **FieldValue + ) +{ + CHAR8 *FieldNameStr; + CHAR8 *FieldValueStr; + CHAR8 *StrPtr; + CHAR8 *EndofHeader; + + if (String == NULL || FieldName == NULL || FieldValue == NULL) { + return NULL; + } + + *FieldName = NULL; + *FieldValue = NULL; + FieldNameStr = NULL; + FieldValueStr = NULL; + StrPtr = NULL; + EndofHeader = NULL; + + + // + // Check whether the raw HTTP header string is valid or not. + // + EndofHeader = AsciiStrStr (String, "\r\n\r\n"); + if (EndofHeader == NULL) { + return NULL; + } + + // + // Each header field consists of a name followed by a colon (":") and the field value. + // The field value MAY be preceded by any amount of LWS, though a single SP is preferred. + // + // message-header = field-name ":" [ field-value ] + // field-name = token + // field-value = *( field-content | LWS ) + // + // Note: "*(element)" allows any number element, including zero; "1*(element)" requires at least one element. + // [element] means element is optional. + // LWS = [CRLF] 1*(SP|HT), it can be ' ' or '\t' or '\r\n ' or '\r\n\t'. + // CRLF = '\r\n'. + // SP = ' '. + // HT = '\t' (Tab). + // + FieldNameStr = String; + FieldValueStr = AsciiStrGetNextToken (FieldNameStr, ':'); + if (FieldValueStr == NULL) { + return NULL; + } + + // + // Replace ':' with 0, then FieldName has been retrived from String. + // + *(FieldValueStr - 1) = 0; + + // + // Handle FieldValueStr, skip all the preceded LWS. + // + while (TRUE) { + if (*FieldValueStr == ' ' || *FieldValueStr == '\t') { + // + // Boundary condition check. + // + if ((UINTN) EndofHeader - (UINTN) FieldValueStr < 1) { + // + // Wrong String format! + // + return NULL; + } + + FieldValueStr ++; + } else if (*FieldValueStr == '\r') { + // + // Boundary condition check. + // + if ((UINTN) EndofHeader - (UINTN) FieldValueStr < 3) { + // + // No more preceded LWS, so break here. + // + break; + } + + if (*(FieldValueStr + 1) == '\n' ) { + if (*(FieldValueStr + 2) == ' ' || *(FieldValueStr + 2) == '\t') { + FieldValueStr = FieldValueStr + 3; + } else { + // + // No more preceded LWS, so break here. + // + break; + } + } else { + // + // Wrong String format! + // + return NULL; + } + } else { + // + // No more preceded LWS, so break here. + // + break; + } + } + + StrPtr = FieldValueStr; + do { + // + // Handle the LWS within the field value. + // + StrPtr = AsciiStrGetNextToken (StrPtr, '\r'); + if (StrPtr == NULL || *StrPtr != '\n') { + // + // Wrong String format! + // + return NULL; + } + + StrPtr++; + } while (*StrPtr == ' ' || *StrPtr == '\t'); + + // + // Replace '\r' with 0 + // + *(StrPtr - 2) = 0; + + // + // Get FieldName and FieldValue. + // + *FieldName = FieldNameStr; + *FieldValue = FieldValueStr; + + return StrPtr; +} + +/** + Free existing HeaderFields. + + @param[in] HeaderFields Pointer to array of key/value header pairs waitting for free. + @param[in] FieldCount The number of header pairs in HeaderFields. + +**/ +VOID +EFIAPI +HttpFreeHeaderFields ( + IN EFI_HTTP_HEADER *HeaderFields, + IN UINTN FieldCount + ) +{ + UINTN Index; + + if (HeaderFields != NULL) { + for (Index = 0; Index < FieldCount; Index++) { + if (HeaderFields[Index].FieldName != NULL) { + FreePool (HeaderFields[Index].FieldName); + } + if (HeaderFields[Index].FieldValue != NULL) { + FreePool (HeaderFields[Index].FieldValue); + } + } + + FreePool (HeaderFields); + } +} + +/** + Generate HTTP request message. + + This function will allocate memory for the whole HTTP message and generate a + well formatted HTTP Request message in it, include the Request-Line, header + fields and also the message body. It is the caller's responsibility to free + the buffer returned in *RequestMsg. + + @param[in] Message Pointer to the EFI_HTTP_MESSAGE structure which + contains the required information to generate + the HTTP request message. + @param[in] Url The URL of a remote host. + @param[out] RequestMsg Pointer to the created HTTP request message. + NULL if any error occured. + @param[out] RequestMsgSize Size of the RequestMsg (in bytes). + + @retval EFI_SUCCESS If HTTP request string was created successfully. + @retval EFI_OUT_OF_RESOURCES Failed to allocate resources. + @retval EFI_INVALID_PARAMETER The input arguments are invalid. + +**/ +EFI_STATUS +EFIAPI +HttpGenRequestMessage ( + IN CONST EFI_HTTP_MESSAGE *Message, + IN CONST CHAR8 *Url, + OUT CHAR8 **RequestMsg, + OUT UINTN *RequestMsgSize + ) +{ + EFI_STATUS Status; + UINTN StrLength; + CHAR8 *RequestPtr; + UINTN HttpHdrSize; + UINTN MsgSize; + BOOLEAN Success; + VOID *HttpHdr; + EFI_HTTP_HEADER **AppendList; + UINTN Index; + EFI_HTTP_UTILITIES_PROTOCOL *HttpUtilitiesProtocol; + + Status = EFI_SUCCESS; + HttpHdrSize = 0; + MsgSize = 0; + Success = FALSE; + HttpHdr = NULL; + AppendList = NULL; + HttpUtilitiesProtocol = NULL; + + // + // 1. If we have a Request, we cannot have a NULL Url + // 2. If we have a Request, HeaderCount can not be non-zero + // 3. If we do not have a Request, HeaderCount should be zero + // 4. If we do not have Request and Headers, we need at least a message-body + // + if ((Message == NULL || RequestMsg == NULL || RequestMsgSize == NULL) || + (Message->Data.Request != NULL && Url == NULL) || + (Message->Data.Request != NULL && Message->HeaderCount == 0) || + (Message->Data.Request == NULL && Message->HeaderCount != 0) || + (Message->Data.Request == NULL && Message->HeaderCount == 0 && Message->BodyLength == 0)) { + return EFI_INVALID_PARAMETER; + } + + if (Message->HeaderCount != 0) { + // + // Locate the HTTP_UTILITIES protocol. + // + Status = gBS->LocateProtocol ( + &gEfiHttpUtilitiesProtocolGuid, + NULL, + (VOID **) &HttpUtilitiesProtocol + ); + + if (EFI_ERROR (Status)) { + DEBUG ((DEBUG_ERROR,"Failed to locate Http Utilities protocol. Status = %r.\n", Status)); + return Status; + } + + // + // Build AppendList to send into HttpUtilitiesBuild + // + AppendList = AllocateZeroPool (sizeof (EFI_HTTP_HEADER *) * (Message->HeaderCount)); + if (AppendList == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + for(Index = 0; Index < Message->HeaderCount; Index++){ + AppendList[Index] = &Message->Headers[Index]; + } + + // + // Build raw HTTP Headers + // + Status = HttpUtilitiesProtocol->Build ( + HttpUtilitiesProtocol, + 0, + NULL, + 0, + NULL, + Message->HeaderCount, + AppendList, + &HttpHdrSize, + &HttpHdr + ); + + FreePool (AppendList); + + if (EFI_ERROR (Status) || HttpHdr == NULL){ + return Status; + } + } + + // + // If we have headers to be sent, account for it. + // + if (Message->HeaderCount != 0) { + MsgSize = HttpHdrSize; + } + + // + // If we have a request line, account for the fields. + // + if (Message->Data.Request != NULL) { + MsgSize += HTTP_METHOD_MAXIMUM_LEN + AsciiStrLen (HTTP_VERSION_CRLF_STR) + AsciiStrLen (Url); + } + + + // + // If we have a message body to be sent, account for it. + // + MsgSize += Message->BodyLength; + + // + // memory for the string that needs to be sent to TCP + // + *RequestMsg = NULL; + *RequestMsg = AllocateZeroPool (MsgSize); + if (*RequestMsg == NULL) { + Status = EFI_OUT_OF_RESOURCES; + goto Exit; + } + + RequestPtr = *RequestMsg; + // + // Construct header request + // + if (Message->Data.Request != NULL) { + switch (Message->Data.Request->Method) { + case HttpMethodGet: + StrLength = sizeof (HTTP_METHOD_GET) - 1; + CopyMem (RequestPtr, HTTP_METHOD_GET, StrLength); + RequestPtr += StrLength; + break; + case HttpMethodPut: + StrLength = sizeof (HTTP_METHOD_PUT) - 1; + CopyMem (RequestPtr, HTTP_METHOD_PUT, StrLength); + RequestPtr += StrLength; + break; + case HttpMethodPatch: + StrLength = sizeof (HTTP_METHOD_PATCH) - 1; + CopyMem (RequestPtr, HTTP_METHOD_PATCH, StrLength); + RequestPtr += StrLength; + break; + case HttpMethodPost: + StrLength = sizeof (HTTP_METHOD_POST) - 1; + CopyMem (RequestPtr, HTTP_METHOD_POST, StrLength); + RequestPtr += StrLength; + break; + case HttpMethodHead: + StrLength = sizeof (HTTP_METHOD_HEAD) - 1; + CopyMem (RequestPtr, HTTP_METHOD_HEAD, StrLength); + RequestPtr += StrLength; + break; + case HttpMethodDelete: + StrLength = sizeof (HTTP_METHOD_DELETE) - 1; + CopyMem (RequestPtr, HTTP_METHOD_DELETE, StrLength); + RequestPtr += StrLength; + break; + default: + ASSERT (FALSE); + Status = EFI_INVALID_PARAMETER; + goto Exit; + } + + StrLength = AsciiStrLen(EMPTY_SPACE); + CopyMem (RequestPtr, EMPTY_SPACE, StrLength); + RequestPtr += StrLength; + + StrLength = AsciiStrLen (Url); + CopyMem (RequestPtr, Url, StrLength); + RequestPtr += StrLength; + + StrLength = sizeof (HTTP_VERSION_CRLF_STR) - 1; + CopyMem (RequestPtr, HTTP_VERSION_CRLF_STR, StrLength); + RequestPtr += StrLength; + + if (HttpHdr != NULL) { + // + // Construct header + // + CopyMem (RequestPtr, HttpHdr, HttpHdrSize); + RequestPtr += HttpHdrSize; + } + } + + // + // Construct body + // + if (Message->Body != NULL) { + CopyMem (RequestPtr, Message->Body, Message->BodyLength); + RequestPtr += Message->BodyLength; + } + + // + // Done + // + (*RequestMsgSize) = (UINTN)(RequestPtr) - (UINTN)(*RequestMsg); + Success = TRUE; + +Exit: + + if (!Success) { + if (*RequestMsg != NULL) { + FreePool (*RequestMsg); + } + *RequestMsg = NULL; + return Status; + } + + if (HttpHdr != NULL) { + FreePool (HttpHdr); + } + + return EFI_SUCCESS; +} + +/** + Translate the status code in HTTP message to EFI_HTTP_STATUS_CODE defined + in UEFI 2.5 specification. + + @param[in] StatusCode The status code value in HTTP message. + + @return Value defined in EFI_HTTP_STATUS_CODE . + +**/ +EFI_HTTP_STATUS_CODE +EFIAPI +HttpMappingToStatusCode ( + IN UINTN StatusCode + ) +{ + switch (StatusCode) { + case 100: + return HTTP_STATUS_100_CONTINUE; + case 101: + return HTTP_STATUS_101_SWITCHING_PROTOCOLS; + case 200: + return HTTP_STATUS_200_OK; + case 201: + return HTTP_STATUS_201_CREATED; + case 202: + return HTTP_STATUS_202_ACCEPTED; + case 203: + return HTTP_STATUS_203_NON_AUTHORITATIVE_INFORMATION; + case 204: + return HTTP_STATUS_204_NO_CONTENT; + case 205: + return HTTP_STATUS_205_RESET_CONTENT; + case 206: + return HTTP_STATUS_206_PARTIAL_CONTENT; + case 300: + return HTTP_STATUS_300_MULTIPLE_CHOICES; + case 301: + return HTTP_STATUS_301_MOVED_PERMANENTLY; + case 302: + return HTTP_STATUS_302_FOUND; + case 303: + return HTTP_STATUS_303_SEE_OTHER; + case 304: + return HTTP_STATUS_304_NOT_MODIFIED; + case 305: + return HTTP_STATUS_305_USE_PROXY; + case 307: + return HTTP_STATUS_307_TEMPORARY_REDIRECT; + case 308: + return HTTP_STATUS_308_PERMANENT_REDIRECT; + case 400: + return HTTP_STATUS_400_BAD_REQUEST; + case 401: + return HTTP_STATUS_401_UNAUTHORIZED; + case 402: + return HTTP_STATUS_402_PAYMENT_REQUIRED; + case 403: + return HTTP_STATUS_403_FORBIDDEN; + case 404: + return HTTP_STATUS_404_NOT_FOUND; + case 405: + return HTTP_STATUS_405_METHOD_NOT_ALLOWED; + case 406: + return HTTP_STATUS_406_NOT_ACCEPTABLE; + case 407: + return HTTP_STATUS_407_PROXY_AUTHENTICATION_REQUIRED; + case 408: + return HTTP_STATUS_408_REQUEST_TIME_OUT; + case 409: + return HTTP_STATUS_409_CONFLICT; + case 410: + return HTTP_STATUS_410_GONE; + case 411: + return HTTP_STATUS_411_LENGTH_REQUIRED; + case 412: + return HTTP_STATUS_412_PRECONDITION_FAILED; + case 413: + return HTTP_STATUS_413_REQUEST_ENTITY_TOO_LARGE; + case 414: + return HTTP_STATUS_414_REQUEST_URI_TOO_LARGE; + case 415: + return HTTP_STATUS_415_UNSUPPORTED_MEDIA_TYPE; + case 416: + return HTTP_STATUS_416_REQUESTED_RANGE_NOT_SATISFIED; + case 417: + return HTTP_STATUS_417_EXPECTATION_FAILED; + case 500: + return HTTP_STATUS_500_INTERNAL_SERVER_ERROR; + case 501: + return HTTP_STATUS_501_NOT_IMPLEMENTED; + case 502: + return HTTP_STATUS_502_BAD_GATEWAY; + case 503: + return HTTP_STATUS_503_SERVICE_UNAVAILABLE; + case 504: + return HTTP_STATUS_504_GATEWAY_TIME_OUT; + case 505: + return HTTP_STATUS_505_HTTP_VERSION_NOT_SUPPORTED; + + default: + return HTTP_STATUS_UNSUPPORTED_STATUS; + } +} + +/** + Check whether header field called FieldName is in DeleteList. + + @param[in] DeleteList Pointer to array of key/value header pairs. + @param[in] DeleteCount The number of header pairs. + @param[in] FieldName Pointer to header field's name. + + @return TRUE if FieldName is not in DeleteList, that means this header field is valid. + @return FALSE if FieldName is in DeleteList, that means this header field is invalid. + +**/ +BOOLEAN +EFIAPI +HttpIsValidHttpHeader ( + IN CHAR8 *DeleteList[], + IN UINTN DeleteCount, + IN CHAR8 *FieldName + ) +{ + UINTN Index; + + if (FieldName == NULL) { + return FALSE; + } + + for (Index = 0; Index < DeleteCount; Index++) { + if (DeleteList[Index] == NULL) { + continue; + } + + if (AsciiStrCmp (FieldName, DeleteList[Index]) == 0) { + return FALSE; + } + } + + return TRUE; +} + diff --git a/NetworkPkg/Library/DxeHttpLib/DxeHttpLib.h b/NetworkPkg/Library/DxeHttpLib/DxeHttpLib.h new file mode 100644 index 0000000000..d064a98438 --- /dev/null +++ b/NetworkPkg/Library/DxeHttpLib/DxeHttpLib.h @@ -0,0 +1,85 @@ +/** @file +Header file for HttpLib. + + Copyright (c) 2016 - 2017, Intel Corporation. All rights reserved.
+ (C) Copyright 2016 Hewlett Packard Enterprise Development LP
+ + SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef _DXE_HTTP_LIB_H_ +#define _DXE_HTTP_LIB_H_ + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#define BIT(x) (1 << x) + +#define HTTP_VERSION_CRLF_STR " HTTP/1.1\r\n" +#define EMPTY_SPACE " " + +#define NET_IS_HEX_CHAR(Ch) \ + ((('0' <= (Ch)) && ((Ch) <= '9')) || \ + (('A' <= (Ch)) && ((Ch) <= 'F')) || \ + (('a' <= (Ch)) && ((Ch) <= 'f'))) + +// +// Field index of the HTTP URL parse result. +// +#define HTTP_URI_FIELD_SCHEME 0 +#define HTTP_URI_FIELD_AUTHORITY 1 +#define HTTP_URI_FIELD_PATH 2 +#define HTTP_URI_FIELD_QUERY 3 +#define HTTP_URI_FIELD_FRAGMENT 4 +#define HTTP_URI_FIELD_USERINFO 5 +#define HTTP_URI_FIELD_HOST 6 +#define HTTP_URI_FIELD_PORT 7 +#define HTTP_URI_FIELD_MAX 8 + +#define HTTP_URI_PORT_MAX_NUM 65535 + +// +// Structure to store the parse result of a HTTP URL. +// +typedef struct { + UINT32 Offset; + UINT32 Length; +} HTTP_URL_FILED_DATA; + +typedef struct { + UINT16 FieldBitMap; + HTTP_URL_FILED_DATA FieldData[HTTP_URI_FIELD_MAX]; +} HTTP_URL_PARSER; + +typedef enum { + UrlParserUrlStart, + UrlParserScheme, + UrlParserSchemeColon, // ":" + UrlParserSchemeColonSlash, // ":/" + UrlParserSchemeColonSlashSlash, // "://" + UrlParserAuthority, + UrlParserAtInAuthority, + UrlParserPath, + UrlParserQueryStart, // "?" + UrlParserQuery, + UrlParserFragmentStart, // "#" + UrlParserFragment, + UrlParserUserInfo, + UrlParserHostStart, // "@" + UrlParserHost, + UrlParserHostIpv6, // "["(Ipv6 address) "]" + UrlParserPortStart, // ":" + UrlParserPort, + UrlParserStateMax +} HTTP_URL_PARSE_STATE; + +#endif + diff --git a/NetworkPkg/Library/DxeHttpLib/DxeHttpLib.inf b/NetworkPkg/Library/DxeHttpLib/DxeHttpLib.inf new file mode 100644 index 0000000000..c613dc1718 --- /dev/null +++ b/NetworkPkg/Library/DxeHttpLib/DxeHttpLib.inf @@ -0,0 +1,42 @@ +## @file +# It provides the helper routines to parse the HTTP message byte stream. +# +# Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.
+# (C) Copyright 2016 Hewlett Packard Enterprise Development LP
+# SPDX-License-Identifier: BSD-2-Clause-Patent +# +## + + +[Defines] + INF_VERSION = 0x00010005 + BASE_NAME = DxeHttpLib + MODULE_UNI_FILE = DxeHttpLib.uni + FILE_GUID = ABBAB4CD-EA88-45b9-8234-C8A7450531FC + MODULE_TYPE = DXE_DRIVER + VERSION_STRING = 1.0 + LIBRARY_CLASS = HttpLib|DXE_CORE DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER + +# +# The following information is for reference only and not required by the build tools. +# +# VALID_ARCHITECTURES = IA32 X64 EBC +# + +[Sources] + DxeHttpLib.c + DxeHttpLib.h + +[Packages] + MdePkg/MdePkg.dec + MdeModulePkg/MdeModulePkg.dec + +[LibraryClasses] + BaseLib + DebugLib + UefiBootServicesTableLib + MemoryAllocationLib + NetLib + +[Protocols] + gEfiHttpUtilitiesProtocolGuid ## SOMETIMES_CONSUMES diff --git a/NetworkPkg/Library/DxeHttpLib/DxeHttpLib.uni b/NetworkPkg/Library/DxeHttpLib/DxeHttpLib.uni new file mode 100644 index 0000000000..a2954c023e --- /dev/null +++ b/NetworkPkg/Library/DxeHttpLib/DxeHttpLib.uni @@ -0,0 +1,16 @@ +// /** @file +// Provides the helper routines for HTTP. +// +// This library instance provides the helper routines to parse the HTTP message byte stream. +// +// Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.
+// +// SPDX-License-Identifier: BSD-2-Clause-Patent +// +// **/ + + +#string STR_MODULE_ABSTRACT #language en-US "Provides the helper routines for HTTP" + +#string STR_MODULE_DESCRIPTION #language en-US "This library instance provides the helper routines to parse the HTTP message byte stream." + diff --git a/NetworkPkg/Library/DxeIpIoLib/DxeIpIoLib.c b/NetworkPkg/Library/DxeIpIoLib/DxeIpIoLib.c new file mode 100644 index 0000000000..d45f0070b3 --- /dev/null +++ b/NetworkPkg/Library/DxeIpIoLib/DxeIpIoLib.c @@ -0,0 +1,2291 @@ +/** @file + IpIo Library. + +(C) Copyright 2014 Hewlett-Packard Development Company, L.P.
+Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent +**/ + +#include + +#include + +#include +#include +#include +#include +#include +#include +#include + + +GLOBAL_REMOVE_IF_UNREFERENCED LIST_ENTRY mActiveIpIoList = { + &mActiveIpIoList, + &mActiveIpIoList +}; + +GLOBAL_REMOVE_IF_UNREFERENCED EFI_IP4_CONFIG_DATA mIp4IoDefaultIpConfigData = { + EFI_IP_PROTO_UDP, + FALSE, + TRUE, + FALSE, + FALSE, + FALSE, + {{0, 0, 0, 0}}, + {{0, 0, 0, 0}}, + 0, + 255, + FALSE, + FALSE, + 0, + 0 +}; + +GLOBAL_REMOVE_IF_UNREFERENCED EFI_IP6_CONFIG_DATA mIp6IoDefaultIpConfigData = { + EFI_IP_PROTO_UDP, + FALSE, + TRUE, + FALSE, + {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}}, + {{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}}, + 0, + 255, + 0, + 0, + 0 +}; + +GLOBAL_REMOVE_IF_UNREFERENCED ICMP_ERROR_INFO mIcmpErrMap[10] = { + {FALSE, TRUE }, // ICMP_ERR_UNREACH_NET + {FALSE, TRUE }, // ICMP_ERR_UNREACH_HOST + {TRUE, TRUE }, // ICMP_ERR_UNREACH_PROTOCOL + {TRUE, TRUE }, // ICMP_ERR_UNREACH_PORT + {TRUE, TRUE }, // ICMP_ERR_MSGSIZE + {FALSE, TRUE }, // ICMP_ERR_UNREACH_SRCFAIL + {FALSE, TRUE }, // ICMP_ERR_TIMXCEED_INTRANS + {FALSE, TRUE }, // ICMP_ERR_TIMEXCEED_REASS + {FALSE, FALSE}, // ICMP_ERR_QUENCH + {FALSE, TRUE } // ICMP_ERR_PARAMPROB +}; + +GLOBAL_REMOVE_IF_UNREFERENCED ICMP_ERROR_INFO mIcmp6ErrMap[10] = { + {FALSE, TRUE}, // ICMP6_ERR_UNREACH_NET + {FALSE, TRUE}, // ICMP6_ERR_UNREACH_HOST + {TRUE, TRUE}, // ICMP6_ERR_UNREACH_PROTOCOL + {TRUE, TRUE}, // ICMP6_ERR_UNREACH_PORT + {TRUE, TRUE}, // ICMP6_ERR_PACKAGE_TOOBIG + {FALSE, TRUE}, // ICMP6_ERR_TIMXCEED_HOPLIMIT + {FALSE, TRUE}, // ICMP6_ERR_TIMXCEED_REASS + {FALSE, TRUE}, // ICMP6_ERR_PARAMPROB_HEADER + {FALSE, TRUE}, // ICMP6_ERR_PARAMPROB_NEXHEADER + {FALSE, TRUE} // ICMP6_ERR_PARAMPROB_IPV6OPTION +}; + + +/** + Notify function for IP transmit token. + + @param[in] Context The context passed in by the event notifier. + +**/ +VOID +EFIAPI +IpIoTransmitHandlerDpc ( + IN VOID *Context + ); + + +/** + Notify function for IP transmit token. + + @param[in] Event The event signaled. + @param[in] Context The context passed in by the event notifier. + +**/ +VOID +EFIAPI +IpIoTransmitHandler ( + IN EFI_EVENT Event, + IN VOID *Context + ); + + +/** + This function create an IP child ,open the IP protocol, and return the opened + IP protocol as Interface. + + @param[in] ControllerHandle The controller handle. + @param[in] ImageHandle The image handle. + @param[in] ChildHandle Pointer to the buffer to save the IP child handle. + @param[in] IpVersion The version of the IP protocol to use, either + IPv4 or IPv6. + @param[out] Interface Pointer used to get the IP protocol interface. + + @retval EFI_SUCCESS The IP child is created and the IP protocol + interface is retrieved. + @retval EFI_UNSUPPORTED Upsupported IpVersion. + @retval Others The required operation failed. + +**/ +EFI_STATUS +IpIoCreateIpChildOpenProtocol ( + IN EFI_HANDLE ControllerHandle, + IN EFI_HANDLE ImageHandle, + IN EFI_HANDLE *ChildHandle, + IN UINT8 IpVersion, + OUT VOID **Interface + ) +{ + EFI_STATUS Status; + EFI_GUID *ServiceBindingGuid; + EFI_GUID *IpProtocolGuid; + + if (IpVersion == IP_VERSION_4) { + ServiceBindingGuid = &gEfiIp4ServiceBindingProtocolGuid; + IpProtocolGuid = &gEfiIp4ProtocolGuid; + } else if (IpVersion == IP_VERSION_6){ + ServiceBindingGuid = &gEfiIp6ServiceBindingProtocolGuid; + IpProtocolGuid = &gEfiIp6ProtocolGuid; + } else { + return EFI_UNSUPPORTED; + } + + // + // Create an IP child. + // + Status = NetLibCreateServiceChild ( + ControllerHandle, + ImageHandle, + ServiceBindingGuid, + ChildHandle + ); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Open the IP protocol installed on the *ChildHandle. + // + Status = gBS->OpenProtocol ( + *ChildHandle, + IpProtocolGuid, + Interface, + ImageHandle, + ControllerHandle, + EFI_OPEN_PROTOCOL_BY_DRIVER + ); + if (EFI_ERROR (Status)) { + // + // On failure, destroy the IP child. + // + NetLibDestroyServiceChild ( + ControllerHandle, + ImageHandle, + ServiceBindingGuid, + *ChildHandle + ); + } + + return Status; +} + + +/** + This function close the previously openned IP protocol and destroy the IP child. + + @param[in] ControllerHandle The controller handle. + @param[in] ImageHandle The image handle. + @param[in] ChildHandle The child handle of the IP child. + @param[in] IpVersion The version of the IP protocol to use, either + IPv4 or IPv6. + + @retval EFI_SUCCESS The IP protocol is closed and the relevant IP child + is destroyed. + @retval EFI_UNSUPPORTED Upsupported IpVersion. + @retval Others The required operation failed. + +**/ +EFI_STATUS +IpIoCloseProtocolDestroyIpChild ( + IN EFI_HANDLE ControllerHandle, + IN EFI_HANDLE ImageHandle, + IN EFI_HANDLE ChildHandle, + IN UINT8 IpVersion + ) +{ + EFI_STATUS Status; + EFI_GUID *ServiceBindingGuid; + EFI_GUID *IpProtocolGuid; + + if (IpVersion == IP_VERSION_4) { + ServiceBindingGuid = &gEfiIp4ServiceBindingProtocolGuid; + IpProtocolGuid = &gEfiIp4ProtocolGuid; + } else if (IpVersion == IP_VERSION_6) { + ServiceBindingGuid = &gEfiIp6ServiceBindingProtocolGuid; + IpProtocolGuid = &gEfiIp6ProtocolGuid; + } else { + return EFI_UNSUPPORTED; + } + + // + // Close the previously openned IP protocol. + // + Status = gBS->CloseProtocol ( + ChildHandle, + IpProtocolGuid, + ImageHandle, + ControllerHandle + ); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Destroy the IP child. + // + return NetLibDestroyServiceChild ( + ControllerHandle, + ImageHandle, + ServiceBindingGuid, + ChildHandle + ); +} + +/** + This function handles ICMPv4 packets. It is the worker function of + IpIoIcmpHandler. + + @param[in] IpIo Pointer to the IP_IO instance. + @param[in, out] Pkt Pointer to the ICMPv4 packet. + @param[in] Session Pointer to the net session of this ICMPv4 packet. + + @retval EFI_SUCCESS The ICMPv4 packet is handled successfully. + @retval EFI_ABORTED This type of ICMPv4 packet is not supported. + +**/ +EFI_STATUS +IpIoIcmpv4Handler ( + IN IP_IO *IpIo, + IN OUT NET_BUF *Pkt, + IN EFI_NET_SESSION_DATA *Session + ) +{ + IP4_ICMP_ERROR_HEAD *IcmpHdr; + EFI_IP4_HEADER *IpHdr; + UINT8 IcmpErr; + UINT8 *PayLoadHdr; + UINT8 Type; + UINT8 Code; + UINT32 TrimBytes; + + ASSERT (IpIo != NULL); + ASSERT (Pkt != NULL); + ASSERT (Session != NULL); + ASSERT (IpIo->IpVersion == IP_VERSION_4); + + // + // Check the ICMP packet length. + // + if (Pkt->TotalSize < sizeof (IP4_ICMP_ERROR_HEAD)) { + return EFI_ABORTED; + } + + IcmpHdr = NET_PROTO_HDR (Pkt, IP4_ICMP_ERROR_HEAD); + IpHdr = (EFI_IP4_HEADER *) (&IcmpHdr->IpHead); + + if (Pkt->TotalSize < ICMP_ERRLEN (IpHdr)) { + + return EFI_ABORTED; + } + + Type = IcmpHdr->Head.Type; + Code = IcmpHdr->Head.Code; + + // + // Analyze the ICMP Error in this ICMP pkt + // + switch (Type) { + case ICMP_TYPE_UNREACH: + switch (Code) { + case ICMP_CODE_UNREACH_NET: + case ICMP_CODE_UNREACH_HOST: + case ICMP_CODE_UNREACH_PROTOCOL: + case ICMP_CODE_UNREACH_PORT: + case ICMP_CODE_UNREACH_SRCFAIL: + IcmpErr = (UINT8) (ICMP_ERR_UNREACH_NET + Code); + + break; + + case ICMP_CODE_UNREACH_NEEDFRAG: + IcmpErr = ICMP_ERR_MSGSIZE; + + break; + + case ICMP_CODE_UNREACH_NET_UNKNOWN: + case ICMP_CODE_UNREACH_NET_PROHIB: + case ICMP_CODE_UNREACH_TOSNET: + IcmpErr = ICMP_ERR_UNREACH_NET; + + break; + + case ICMP_CODE_UNREACH_HOST_UNKNOWN: + case ICMP_CODE_UNREACH_ISOLATED: + case ICMP_CODE_UNREACH_HOST_PROHIB: + case ICMP_CODE_UNREACH_TOSHOST: + IcmpErr = ICMP_ERR_UNREACH_HOST; + + break; + + default: + return EFI_ABORTED; + } + + break; + + case ICMP_TYPE_TIMXCEED: + if (Code > 1) { + return EFI_ABORTED; + } + + IcmpErr = (UINT8) (Code + ICMP_ERR_TIMXCEED_INTRANS); + + break; + + case ICMP_TYPE_PARAMPROB: + if (Code > 1) { + return EFI_ABORTED; + } + + IcmpErr = ICMP_ERR_PARAMPROB; + + break; + + case ICMP_TYPE_SOURCEQUENCH: + if (Code != 0) { + return EFI_ABORTED; + } + + IcmpErr = ICMP_ERR_QUENCH; + + break; + + default: + return EFI_ABORTED; + } + + // + // Notify user the ICMP pkt only containing payload except + // IP and ICMP header + // + PayLoadHdr = (UINT8 *) ((UINT8 *) IpHdr + EFI_IP4_HEADER_LEN (IpHdr)); + TrimBytes = (UINT32) (PayLoadHdr - (UINT8 *) IcmpHdr); + + NetbufTrim (Pkt, TrimBytes, TRUE); + + // + // If the input packet has invalid format, and TrimBytes is larger than + // the packet size, the NetbufTrim might trim the packet to zero. + // + if (Pkt->TotalSize != 0) { + IpIo->PktRcvdNotify (EFI_ICMP_ERROR, IcmpErr, Session, Pkt, IpIo->RcvdContext); + } + + return EFI_SUCCESS; +} + +/** + This function handles ICMPv6 packets. It is the worker function of + IpIoIcmpHandler. + + @param[in] IpIo Pointer to the IP_IO instance. + @param[in, out] Pkt Pointer to the ICMPv6 packet. + @param[in] Session Pointer to the net session of this ICMPv6 packet. + + @retval EFI_SUCCESS The ICMPv6 packet is handled successfully. + @retval EFI_ABORTED This type of ICMPv6 packet is not supported. + +**/ +EFI_STATUS +IpIoIcmpv6Handler ( + IN IP_IO *IpIo, + IN OUT NET_BUF *Pkt, + IN EFI_NET_SESSION_DATA *Session + ) +{ + IP6_ICMP_ERROR_HEAD *IcmpHdr; + EFI_IP6_HEADER *IpHdr; + UINT8 IcmpErr; + UINT8 *PayLoadHdr; + UINT8 Type; + UINT8 Code; + UINT8 NextHeader; + UINT32 TrimBytes; + BOOLEAN Flag; + + ASSERT (IpIo != NULL); + ASSERT (Pkt != NULL); + ASSERT (Session != NULL); + ASSERT (IpIo->IpVersion == IP_VERSION_6); + + // + // Check the ICMPv6 packet length. + // + if (Pkt->TotalSize < sizeof (IP6_ICMP_ERROR_HEAD)) { + + return EFI_ABORTED; + } + + IcmpHdr = NET_PROTO_HDR (Pkt, IP6_ICMP_ERROR_HEAD); + Type = IcmpHdr->Head.Type; + Code = IcmpHdr->Head.Code; + + // + // Analyze the ICMPv6 Error in this ICMPv6 packet + // + switch (Type) { + case ICMP_V6_DEST_UNREACHABLE: + switch (Code) { + case ICMP_V6_NO_ROUTE_TO_DEST: + case ICMP_V6_BEYOND_SCOPE: + case ICMP_V6_ROUTE_REJECTED: + IcmpErr = ICMP6_ERR_UNREACH_NET; + + break; + + case ICMP_V6_COMM_PROHIBITED: + case ICMP_V6_ADDR_UNREACHABLE: + case ICMP_V6_SOURCE_ADDR_FAILED: + IcmpErr = ICMP6_ERR_UNREACH_HOST; + + break; + + case ICMP_V6_PORT_UNREACHABLE: + IcmpErr = ICMP6_ERR_UNREACH_PORT; + + break; + + default: + return EFI_ABORTED; + } + + break; + + case ICMP_V6_PACKET_TOO_BIG: + if (Code >= 1) { + return EFI_ABORTED; + } + + IcmpErr = ICMP6_ERR_PACKAGE_TOOBIG; + + break; + + case ICMP_V6_TIME_EXCEEDED: + if (Code > 1) { + return EFI_ABORTED; + } + + IcmpErr = (UINT8) (ICMP6_ERR_TIMXCEED_HOPLIMIT + Code); + + break; + + case ICMP_V6_PARAMETER_PROBLEM: + if (Code > 3) { + return EFI_ABORTED; + } + + IcmpErr = (UINT8) (ICMP6_ERR_PARAMPROB_HEADER + Code); + + break; + + default: + + return EFI_ABORTED; + } + + // + // Notify user the ICMPv6 packet only containing payload except + // IPv6 basic header, extension header and ICMP header + // + + IpHdr = (EFI_IP6_HEADER *) (&IcmpHdr->IpHead); + NextHeader = IpHdr->NextHeader; + PayLoadHdr = (UINT8 *) ((UINT8 *) IcmpHdr + sizeof (IP6_ICMP_ERROR_HEAD)); + Flag = TRUE; + + do { + switch (NextHeader) { + case EFI_IP_PROTO_UDP: + case EFI_IP_PROTO_TCP: + case EFI_IP_PROTO_ICMP: + case IP6_NO_NEXT_HEADER: + Flag = FALSE; + + break; + + case IP6_HOP_BY_HOP: + case IP6_DESTINATION: + // + // The Hdr Ext Len is 8-bit unsigned integer in 8-octet units, not including + // the first 8 octets. + // + NextHeader = *(PayLoadHdr); + PayLoadHdr = (UINT8 *) (PayLoadHdr + (*(PayLoadHdr + 1) + 1) * 8); + + break; + + case IP6_FRAGMENT: + // + // The Fragment Header Length is 8 octets. + // + NextHeader = *(PayLoadHdr); + PayLoadHdr = (UINT8 *) (PayLoadHdr + 8); + + break; + + default: + + return EFI_ABORTED; + } + } while (Flag); + + TrimBytes = (UINT32) (PayLoadHdr - (UINT8 *) IcmpHdr); + + NetbufTrim (Pkt, TrimBytes, TRUE); + + // + // If the input packet has invalid format, and TrimBytes is larger than + // the packet size, the NetbufTrim might trim the packet to zero. + // + if (Pkt->TotalSize != 0) { + IpIo->PktRcvdNotify (EFI_ICMP_ERROR, IcmpErr, Session, Pkt, IpIo->RcvdContext); + } + + return EFI_SUCCESS; +} + +/** + This function handles ICMP packets. + + @param[in] IpIo Pointer to the IP_IO instance. + @param[in, out] Pkt Pointer to the ICMP packet. + @param[in] Session Pointer to the net session of this ICMP packet. + + @retval EFI_SUCCESS The ICMP packet is handled successfully. + @retval EFI_ABORTED This type of ICMP packet is not supported. + @retval EFI_UNSUPPORTED The IP protocol version in IP_IO is not supported. + +**/ +EFI_STATUS +IpIoIcmpHandler ( + IN IP_IO *IpIo, + IN OUT NET_BUF *Pkt, + IN EFI_NET_SESSION_DATA *Session + ) +{ + + if (IpIo->IpVersion == IP_VERSION_4) { + + return IpIoIcmpv4Handler (IpIo, Pkt, Session); + + } else if (IpIo->IpVersion == IP_VERSION_6) { + + return IpIoIcmpv6Handler (IpIo, Pkt, Session); + + } else { + + return EFI_UNSUPPORTED; + } +} + + +/** + Free function for receive token of IP_IO. It is used to + signal the recycle event to notify IP to recycle the + data buffer. + + @param[in] Event The event to be signaled. + +**/ +VOID +EFIAPI +IpIoExtFree ( + IN VOID *Event + ) +{ + gBS->SignalEvent ((EFI_EVENT) Event); +} + + +/** + Create a send entry to wrap a packet before sending + out it through IP. + + @param[in, out] IpIo Pointer to the IP_IO instance. + @param[in, out] Pkt Pointer to the packet. + @param[in] Sender Pointer to the IP sender. + @param[in] Context Pointer to the context. + @param[in] NotifyData Pointer to the notify data. + @param[in] Dest Pointer to the destination IP address. + @param[in] Override Pointer to the overriden IP_IO data. + + @return Pointer to the data structure created to wrap the packet. If any error occurs, + then return NULL. + +**/ +IP_IO_SEND_ENTRY * +IpIoCreateSndEntry ( + IN OUT IP_IO *IpIo, + IN OUT NET_BUF *Pkt, + IN IP_IO_IP_PROTOCOL Sender, + IN VOID *Context OPTIONAL, + IN VOID *NotifyData OPTIONAL, + IN EFI_IP_ADDRESS *Dest OPTIONAL, + IN IP_IO_OVERRIDE *Override + ) +{ + IP_IO_SEND_ENTRY *SndEntry; + EFI_EVENT Event; + EFI_STATUS Status; + NET_FRAGMENT *ExtFragment; + UINT32 FragmentCount; + IP_IO_OVERRIDE *OverrideData; + IP_IO_IP_TX_DATA *TxData; + EFI_IP4_TRANSMIT_DATA *Ip4TxData; + EFI_IP6_TRANSMIT_DATA *Ip6TxData; + + if ((IpIo->IpVersion != IP_VERSION_4) && (IpIo->IpVersion != IP_VERSION_6)) { + return NULL; + } + + Event = NULL; + TxData = NULL; + OverrideData = NULL; + + // + // Allocate resource for SndEntry + // + SndEntry = AllocatePool (sizeof (IP_IO_SEND_ENTRY)); + if (NULL == SndEntry) { + return NULL; + } + + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, + IpIoTransmitHandler, + SndEntry, + &Event + ); + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + FragmentCount = Pkt->BlockOpNum; + + // + // Allocate resource for TxData + // + TxData = (IP_IO_IP_TX_DATA *) AllocatePool ( + sizeof (IP_IO_IP_TX_DATA) + sizeof (NET_FRAGMENT) * (FragmentCount - 1) + ); + + if (NULL == TxData) { + goto ON_ERROR; + } + + // + // Build a fragment table to contain the fragments in the packet. + // + if (IpIo->IpVersion == IP_VERSION_4) { + ExtFragment = (NET_FRAGMENT *) TxData->Ip4TxData.FragmentTable; + } else { + ExtFragment = (NET_FRAGMENT *) TxData->Ip6TxData.FragmentTable; + } + + NetbufBuildExt (Pkt, ExtFragment, &FragmentCount); + + + // + // Allocate resource for OverrideData if needed + // + if (NULL != Override) { + + OverrideData = AllocateCopyPool (sizeof (IP_IO_OVERRIDE), Override); + if (NULL == OverrideData) { + goto ON_ERROR; + } + } + + // + // Set other fields of TxData except the fragment table + // + if (IpIo->IpVersion == IP_VERSION_4) { + + Ip4TxData = &TxData->Ip4TxData; + + IP4_COPY_ADDRESS (&Ip4TxData->DestinationAddress, Dest); + + Ip4TxData->OverrideData = &OverrideData->Ip4OverrideData; + Ip4TxData->OptionsLength = 0; + Ip4TxData->OptionsBuffer = NULL; + Ip4TxData->TotalDataLength = Pkt->TotalSize; + Ip4TxData->FragmentCount = FragmentCount; + + // + // Set the fields of SndToken + // + SndEntry->SndToken.Ip4Token.Event = Event; + SndEntry->SndToken.Ip4Token.Packet.TxData = Ip4TxData; + } else { + + Ip6TxData = &TxData->Ip6TxData; + + if (Dest != NULL) { + CopyMem (&Ip6TxData->DestinationAddress, Dest, sizeof (EFI_IPv6_ADDRESS)); + } else { + ZeroMem (&Ip6TxData->DestinationAddress, sizeof (EFI_IPv6_ADDRESS)); + } + + Ip6TxData->OverrideData = &OverrideData->Ip6OverrideData; + Ip6TxData->DataLength = Pkt->TotalSize; + Ip6TxData->FragmentCount = FragmentCount; + Ip6TxData->ExtHdrsLength = 0; + Ip6TxData->ExtHdrs = NULL; + + // + // Set the fields of SndToken + // + SndEntry->SndToken.Ip6Token.Event = Event; + SndEntry->SndToken.Ip6Token.Packet.TxData = Ip6TxData; + } + + // + // Set the fields of SndEntry + // + SndEntry->IpIo = IpIo; + SndEntry->Ip = Sender; + SndEntry->Context = Context; + SndEntry->NotifyData = NotifyData; + + SndEntry->Pkt = Pkt; + NET_GET_REF (Pkt); + + InsertTailList (&IpIo->PendingSndList, &SndEntry->Entry); + + return SndEntry; + +ON_ERROR: + + if (OverrideData != NULL) { + FreePool (OverrideData); + } + + if (TxData != NULL) { + FreePool (TxData); + } + + if (SndEntry != NULL) { + FreePool (SndEntry); + } + + if (Event != NULL) { + gBS->CloseEvent (Event); + } + + return NULL; +} + + +/** + Destroy the SndEntry. + + This function pairs with IpIoCreateSndEntry(). + + @param[in] SndEntry Pointer to the send entry to be destroyed. + +**/ +VOID +IpIoDestroySndEntry ( + IN IP_IO_SEND_ENTRY *SndEntry + ) +{ + EFI_EVENT Event; + IP_IO_IP_TX_DATA *TxData; + IP_IO_OVERRIDE *Override; + + if (SndEntry->IpIo->IpVersion == IP_VERSION_4) { + Event = SndEntry->SndToken.Ip4Token.Event; + TxData = (IP_IO_IP_TX_DATA *) SndEntry->SndToken.Ip4Token.Packet.TxData; + Override = (IP_IO_OVERRIDE *) TxData->Ip4TxData.OverrideData; + } else if (SndEntry->IpIo->IpVersion == IP_VERSION_6) { + Event = SndEntry->SndToken.Ip6Token.Event; + TxData = (IP_IO_IP_TX_DATA *) SndEntry->SndToken.Ip6Token.Packet.TxData; + Override = (IP_IO_OVERRIDE *) TxData->Ip6TxData.OverrideData; + } else { + return ; + } + + gBS->CloseEvent (Event); + + FreePool (TxData); + + if (NULL != Override) { + FreePool (Override); + } + + NetbufFree (SndEntry->Pkt); + + RemoveEntryList (&SndEntry->Entry); + + FreePool (SndEntry); +} + + +/** + Notify function for IP transmit token. + + @param[in] Context The context passed in by the event notifier. + +**/ +VOID +EFIAPI +IpIoTransmitHandlerDpc ( + IN VOID *Context + ) +{ + IP_IO *IpIo; + IP_IO_SEND_ENTRY *SndEntry; + EFI_STATUS Status; + + SndEntry = (IP_IO_SEND_ENTRY *) Context; + + IpIo = SndEntry->IpIo; + + if (IpIo->IpVersion == IP_VERSION_4) { + Status = SndEntry->SndToken.Ip4Token.Status; + } else if (IpIo->IpVersion == IP_VERSION_6){ + Status = SndEntry->SndToken.Ip6Token.Status; + } else { + return ; + } + + if ((IpIo->PktSentNotify != NULL) && (SndEntry->NotifyData != NULL)) { + IpIo->PktSentNotify ( + Status, + SndEntry->Context, + SndEntry->Ip, + SndEntry->NotifyData + ); + } + + IpIoDestroySndEntry (SndEntry); +} + + +/** + Notify function for IP transmit token. + + @param[in] Event The event signaled. + @param[in] Context The context passed in by the event notifier. + +**/ +VOID +EFIAPI +IpIoTransmitHandler ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + // + // Request IpIoTransmitHandlerDpc as a DPC at TPL_CALLBACK + // + QueueDpc (TPL_CALLBACK, IpIoTransmitHandlerDpc, Context); +} + + +/** + The dummy handler for the dummy IP receive token. + + @param[in] Context The context passed in by the event notifier. + +**/ +VOID +EFIAPI +IpIoDummyHandlerDpc ( + IN VOID *Context + ) +{ + IP_IO_IP_INFO *IpInfo; + EFI_STATUS Status; + EFI_EVENT RecycleEvent; + + IpInfo = (IP_IO_IP_INFO *) Context; + + if ((IpInfo->IpVersion != IP_VERSION_4) && (IpInfo->IpVersion != IP_VERSION_6)) { + return ; + } + + RecycleEvent = NULL; + + if (IpInfo->IpVersion == IP_VERSION_4) { + Status = IpInfo->DummyRcvToken.Ip4Token.Status; + + if (IpInfo->DummyRcvToken.Ip4Token.Packet.RxData != NULL) { + RecycleEvent = IpInfo->DummyRcvToken.Ip4Token.Packet.RxData->RecycleSignal; + } + } else { + Status = IpInfo->DummyRcvToken.Ip6Token.Status; + + if (IpInfo->DummyRcvToken.Ip6Token.Packet.RxData != NULL) { + RecycleEvent = IpInfo->DummyRcvToken.Ip6Token.Packet.RxData->RecycleSignal; + } + } + + + + if (EFI_ABORTED == Status) { + // + // The reception is actively aborted by the consumer, directly return. + // + return; + } else if (EFI_SUCCESS == Status) { + // + // Recycle the RxData. + // + ASSERT (RecycleEvent != NULL); + + gBS->SignalEvent (RecycleEvent); + } + + // + // Continue the receive. + // + if (IpInfo->IpVersion == IP_VERSION_4) { + IpInfo->Ip.Ip4->Receive ( + IpInfo->Ip.Ip4, + &IpInfo->DummyRcvToken.Ip4Token + ); + } else { + IpInfo->Ip.Ip6->Receive ( + IpInfo->Ip.Ip6, + &IpInfo->DummyRcvToken.Ip6Token + ); + } +} + + +/** + This function add IpIoDummyHandlerDpc to the end of the DPC queue. + + @param[in] Event The event signaled. + @param[in] Context The context passed in by the event notifier. + +**/ +VOID +EFIAPI +IpIoDummyHandler ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + // + // Request IpIoDummyHandlerDpc as a DPC at TPL_CALLBACK + // + QueueDpc (TPL_CALLBACK, IpIoDummyHandlerDpc, Context); +} + + +/** + Notify function for the IP receive token, used to process + the received IP packets. + + @param[in] Context The context passed in by the event notifier. + +**/ +VOID +EFIAPI +IpIoListenHandlerDpc ( + IN VOID *Context + ) +{ + IP_IO *IpIo; + EFI_STATUS Status; + IP_IO_IP_RX_DATA *RxData; + EFI_NET_SESSION_DATA Session; + NET_BUF *Pkt; + + IpIo = (IP_IO *) Context; + + if (IpIo->IpVersion == IP_VERSION_4) { + Status = IpIo->RcvToken.Ip4Token.Status; + RxData = (IP_IO_IP_RX_DATA *) IpIo->RcvToken.Ip4Token.Packet.RxData; + } else if (IpIo->IpVersion == IP_VERSION_6) { + Status = IpIo->RcvToken.Ip6Token.Status; + RxData = (IP_IO_IP_RX_DATA *) IpIo->RcvToken.Ip6Token.Packet.RxData; + } else { + return; + } + + if (EFI_ABORTED == Status) { + // + // The reception is actively aborted by the consumer, directly return. + // + return; + } + + if ((EFI_SUCCESS != Status) && (EFI_ICMP_ERROR != Status)) { + // + // Only process the normal packets and the icmp error packets. + // + if (RxData != NULL) { + goto CleanUp; + } else { + goto Resume; + } + } + + // + // if RxData is NULL with Status == EFI_SUCCESS or EFI_ICMP_ERROR, this should be a code issue in the low layer (IP). + // + ASSERT (RxData != NULL); + if (RxData == NULL) { + goto Resume; + } + + if (NULL == IpIo->PktRcvdNotify) { + goto CleanUp; + } + + if (IpIo->IpVersion == IP_VERSION_4) { + ASSERT (RxData->Ip4RxData.Header != NULL); + if (IP4_IS_LOCAL_BROADCAST (EFI_IP4 (RxData->Ip4RxData.Header->SourceAddress))) { + // + // The source address is a broadcast address, discard it. + // + goto CleanUp; + } + if ((EFI_IP4 (RxData->Ip4RxData.Header->SourceAddress) != 0) && + (IpIo->SubnetMask != 0) && + IP4_NET_EQUAL (IpIo->StationIp, EFI_NTOHL (((EFI_IP4_RECEIVE_DATA *) RxData)->Header->SourceAddress), IpIo->SubnetMask) && + !NetIp4IsUnicast (EFI_NTOHL (((EFI_IP4_RECEIVE_DATA *) RxData)->Header->SourceAddress), IpIo->SubnetMask)) { + // + // The source address doesn't match StationIp and it's not a unicast IP address, discard it. + // + goto CleanUp; + } + + if (RxData->Ip4RxData.DataLength == 0) { + // + // Discard zero length data payload packet. + // + goto CleanUp; + } + + // + // The fragment should always be valid for non-zero length packet. + // + ASSERT (RxData->Ip4RxData.FragmentCount != 0); + + // + // Create a netbuffer representing IPv4 packet + // + Pkt = NetbufFromExt ( + (NET_FRAGMENT *) RxData->Ip4RxData.FragmentTable, + RxData->Ip4RxData.FragmentCount, + 0, + 0, + IpIoExtFree, + RxData->Ip4RxData.RecycleSignal + ); + if (NULL == Pkt) { + goto CleanUp; + } + + // + // Create a net session + // + Session.Source.Addr[0] = EFI_IP4 (RxData->Ip4RxData.Header->SourceAddress); + Session.Dest.Addr[0] = EFI_IP4 (RxData->Ip4RxData.Header->DestinationAddress); + Session.IpHdr.Ip4Hdr = RxData->Ip4RxData.Header; + Session.IpHdrLen = RxData->Ip4RxData.HeaderLength; + Session.IpVersion = IP_VERSION_4; + } else { + ASSERT (RxData->Ip6RxData.Header != NULL); + if (!NetIp6IsValidUnicast(&RxData->Ip6RxData.Header->SourceAddress)) { + goto CleanUp; + } + + if (RxData->Ip6RxData.DataLength == 0) { + // + // Discard zero length data payload packet. + // + goto CleanUp; + } + + // + // The fragment should always be valid for non-zero length packet. + // + ASSERT (RxData->Ip6RxData.FragmentCount != 0); + + // + // Create a netbuffer representing IPv6 packet + // + Pkt = NetbufFromExt ( + (NET_FRAGMENT *) RxData->Ip6RxData.FragmentTable, + RxData->Ip6RxData.FragmentCount, + 0, + 0, + IpIoExtFree, + RxData->Ip6RxData.RecycleSignal + ); + if (NULL == Pkt) { + goto CleanUp; + } + + // + // Create a net session + // + CopyMem ( + &Session.Source, + &RxData->Ip6RxData.Header->SourceAddress, + sizeof(EFI_IPv6_ADDRESS) + ); + CopyMem ( + &Session.Dest, + &RxData->Ip6RxData.Header->DestinationAddress, + sizeof(EFI_IPv6_ADDRESS) + ); + Session.IpHdr.Ip6Hdr = RxData->Ip6RxData.Header; + Session.IpHdrLen = RxData->Ip6RxData.HeaderLength; + Session.IpVersion = IP_VERSION_6; + } + + if (EFI_SUCCESS == Status) { + + IpIo->PktRcvdNotify (EFI_SUCCESS, 0, &Session, Pkt, IpIo->RcvdContext); + } else { + // + // Status is EFI_ICMP_ERROR + // + Status = IpIoIcmpHandler (IpIo, Pkt, &Session); + if (EFI_ERROR (Status)) { + NetbufFree (Pkt); + } + } + + goto Resume; + +CleanUp: + + if (IpIo->IpVersion == IP_VERSION_4){ + gBS->SignalEvent (RxData->Ip4RxData.RecycleSignal); + } else { + gBS->SignalEvent (RxData->Ip6RxData.RecycleSignal); + } + +Resume: + + if (IpIo->IpVersion == IP_VERSION_4){ + IpIo->Ip.Ip4->Receive (IpIo->Ip.Ip4, &(IpIo->RcvToken.Ip4Token)); + } else { + IpIo->Ip.Ip6->Receive (IpIo->Ip.Ip6, &(IpIo->RcvToken.Ip6Token)); + } +} + +/** + This function add IpIoListenHandlerDpc to the end of the DPC queue. + + @param[in] Event The event signaled. + @param[in] Context The context passed in by the event notifier. + +**/ +VOID +EFIAPI +IpIoListenHandler ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + // + // Request IpIoListenHandlerDpc as a DPC at TPL_CALLBACK + // + QueueDpc (TPL_CALLBACK, IpIoListenHandlerDpc, Context); +} + + +/** + Create a new IP_IO instance. + + If IpVersion is not IP_VERSION_4 or IP_VERSION_6, then ASSERT(). + + This function uses IP4/IP6 service binding protocol in Controller to create + an IP4/IP6 child (aka IP4/IP6 instance). + + @param[in] Image The image handle of the driver or application that + consumes IP_IO. + @param[in] Controller The controller handle that has IP4 or IP6 service + binding protocol installed. + @param[in] IpVersion The version of the IP protocol to use, either + IPv4 or IPv6. + + @return Pointer to a newly created IP_IO instance, or NULL if failed. + +**/ +IP_IO * +EFIAPI +IpIoCreate ( + IN EFI_HANDLE Image, + IN EFI_HANDLE Controller, + IN UINT8 IpVersion + ) +{ + EFI_STATUS Status; + IP_IO *IpIo; + EFI_EVENT Event; + + ASSERT ((IpVersion == IP_VERSION_4) || (IpVersion == IP_VERSION_6)); + + IpIo = AllocateZeroPool (sizeof (IP_IO)); + if (NULL == IpIo) { + return NULL; + } + + InitializeListHead (&(IpIo->PendingSndList)); + InitializeListHead (&(IpIo->IpList)); + IpIo->Controller = Controller; + IpIo->Image = Image; + IpIo->IpVersion = IpVersion; + Event = NULL; + + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, + IpIoListenHandler, + IpIo, + &Event + ); + if (EFI_ERROR (Status)) { + goto ReleaseIpIo; + } + + if (IpVersion == IP_VERSION_4) { + IpIo->RcvToken.Ip4Token.Event = Event; + } else { + IpIo->RcvToken.Ip6Token.Event = Event; + } + + // + // Create an IP child and open IP protocol + // + Status = IpIoCreateIpChildOpenProtocol ( + Controller, + Image, + &IpIo->ChildHandle, + IpVersion, + (VOID **) & (IpIo->Ip) + ); + if (EFI_ERROR (Status)) { + goto ReleaseIpIo; + } + + return IpIo; + +ReleaseIpIo: + + if (Event != NULL) { + gBS->CloseEvent (Event); + } + + gBS->FreePool (IpIo); + + return NULL; +} + + +/** + Open an IP_IO instance for use. + + If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT(). + + This function is called after IpIoCreate(). It is used for configuring the IP + instance and register the callbacks and their context data for sending and + receiving IP packets. + + @param[in, out] IpIo Pointer to an IP_IO instance that needs + to open. + @param[in] OpenData The configuration data and callbacks for + the IP_IO instance. + + @retval EFI_SUCCESS The IP_IO instance opened with OpenData + successfully. + @retval EFI_ACCESS_DENIED The IP_IO instance is configured, avoid to + reopen it. + @retval EFI_UNSUPPORTED IPv4 RawData mode is no supported. + @retval EFI_INVALID_PARAMETER Invalid input parameter. + @retval Others Error condition occurred. + +**/ +EFI_STATUS +EFIAPI +IpIoOpen ( + IN OUT IP_IO *IpIo, + IN IP_IO_OPEN_DATA *OpenData + ) +{ + EFI_STATUS Status; + UINT8 IpVersion; + + if (IpIo == NULL || OpenData == NULL) { + return EFI_INVALID_PARAMETER; + } + + if (IpIo->IsConfigured) { + return EFI_ACCESS_DENIED; + } + + IpVersion = IpIo->IpVersion; + + ASSERT ((IpVersion == IP_VERSION_4) || (IpVersion == IP_VERSION_6)); + + // + // configure ip + // + if (IpVersion == IP_VERSION_4){ + // + // RawData mode is no supported. + // + ASSERT (!OpenData->IpConfigData.Ip4CfgData.RawData); + if (OpenData->IpConfigData.Ip4CfgData.RawData) { + return EFI_UNSUPPORTED; + } + + if (!OpenData->IpConfigData.Ip4CfgData.UseDefaultAddress) { + IpIo->StationIp = EFI_NTOHL (OpenData->IpConfigData.Ip4CfgData.StationAddress); + IpIo->SubnetMask = EFI_NTOHL (OpenData->IpConfigData.Ip4CfgData.SubnetMask); + } + + Status = IpIo->Ip.Ip4->Configure ( + IpIo->Ip.Ip4, + &OpenData->IpConfigData.Ip4CfgData + ); + } else { + + Status = IpIo->Ip.Ip6->Configure ( + IpIo->Ip.Ip6, + &OpenData->IpConfigData.Ip6CfgData + ); + } + + if (EFI_ERROR (Status)) { + return Status; + } + + // + // @bug To delete the default route entry in this Ip, if it is: + // @bug (0.0.0.0, 0.0.0.0, 0.0.0.0). Delete this statement if Ip modified + // @bug its code + // + if (IpVersion == IP_VERSION_4){ + Status = IpIo->Ip.Ip4->Routes ( + IpIo->Ip.Ip4, + TRUE, + &mZeroIp4Addr, + &mZeroIp4Addr, + &mZeroIp4Addr + ); + + if (EFI_ERROR (Status) && (EFI_NOT_FOUND != Status)) { + return Status; + } + } + + IpIo->PktRcvdNotify = OpenData->PktRcvdNotify; + IpIo->PktSentNotify = OpenData->PktSentNotify; + + IpIo->RcvdContext = OpenData->RcvdContext; + IpIo->SndContext = OpenData->SndContext; + + if (IpVersion == IP_VERSION_4){ + IpIo->Protocol = OpenData->IpConfigData.Ip4CfgData.DefaultProtocol; + + // + // start to listen incoming packet + // + Status = IpIo->Ip.Ip4->Receive ( + IpIo->Ip.Ip4, + &(IpIo->RcvToken.Ip4Token) + ); + if (EFI_ERROR (Status)) { + IpIo->Ip.Ip4->Configure (IpIo->Ip.Ip4, NULL); + return Status; + } + + } else { + + IpIo->Protocol = OpenData->IpConfigData.Ip6CfgData.DefaultProtocol; + Status = IpIo->Ip.Ip6->Receive ( + IpIo->Ip.Ip6, + &(IpIo->RcvToken.Ip6Token) + ); + if (EFI_ERROR (Status)) { + IpIo->Ip.Ip6->Configure (IpIo->Ip.Ip6, NULL); + return Status; + } + } + + IpIo->IsConfigured = TRUE; + InsertTailList (&mActiveIpIoList, &IpIo->Entry); + + return Status; +} + + +/** + Stop an IP_IO instance. + + If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT(). + + This function is paired with IpIoOpen(). The IP_IO will be unconfigured and all + the pending send/receive tokens will be canceled. + + @param[in, out] IpIo Pointer to the IP_IO instance that needs to stop. + + @retval EFI_SUCCESS The IP_IO instance stopped successfully. + @retval EFI_INVALID_PARAMETER Invalid input parameter. + @retval Others Error condition occurred. + +**/ +EFI_STATUS +EFIAPI +IpIoStop ( + IN OUT IP_IO *IpIo + ) +{ + EFI_STATUS Status; + IP_IO_IP_INFO *IpInfo; + UINT8 IpVersion; + + if (IpIo == NULL) { + return EFI_INVALID_PARAMETER; + } + + if (!IpIo->IsConfigured) { + return EFI_SUCCESS; + } + + IpVersion = IpIo->IpVersion; + + ASSERT ((IpVersion == IP_VERSION_4) || (IpVersion == IP_VERSION_6)); + + // + // Remove the IpIo from the active IpIo list. + // + RemoveEntryList (&IpIo->Entry); + + // + // Configure NULL Ip + // + if (IpVersion == IP_VERSION_4) { + Status = IpIo->Ip.Ip4->Configure (IpIo->Ip.Ip4, NULL); + } else { + Status = IpIo->Ip.Ip6->Configure (IpIo->Ip.Ip6, NULL); + } + if (EFI_ERROR (Status)) { + return Status; + } + + IpIo->IsConfigured = FALSE; + + // + // Detroy the Ip List used by IpIo + // + + while (!IsListEmpty (&(IpIo->IpList))) { + IpInfo = NET_LIST_HEAD (&(IpIo->IpList), IP_IO_IP_INFO, Entry); + + IpIoRemoveIp (IpIo, IpInfo); + } + + // + // All pending send tokens should be flushed by resetting the IP instances. + // + ASSERT (IsListEmpty (&IpIo->PendingSndList)); + + // + // Close the receive event. + // + if (IpVersion == IP_VERSION_4){ + gBS->CloseEvent (IpIo->RcvToken.Ip4Token.Event); + } else { + gBS->CloseEvent (IpIo->RcvToken.Ip6Token.Event); + } + + return EFI_SUCCESS; +} + + +/** + Destroy an IP_IO instance. + + This function is paired with IpIoCreate(). The IP_IO will be closed first. + Resource will be freed afterwards. See IpIoCloseProtocolDestroyIpChild(). + + @param[in, out] IpIo Pointer to the IP_IO instance that needs to be + destroyed. + + @retval EFI_SUCCESS The IP_IO instance destroyed successfully. + @retval Others Error condition occurred. + +**/ +EFI_STATUS +EFIAPI +IpIoDestroy ( + IN OUT IP_IO *IpIo + ) +{ + EFI_STATUS Status; + + // + // Stop the IpIo. + // + Status = IpIoStop (IpIo); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Close the IP protocol and destroy the child. + // + Status = IpIoCloseProtocolDestroyIpChild ( + IpIo->Controller, + IpIo->Image, + IpIo->ChildHandle, + IpIo->IpVersion + ); + if (EFI_ERROR (Status)) { + return Status; + } + + gBS->FreePool (IpIo); + + return EFI_SUCCESS; +} + + +/** + Send out an IP packet. + + This function is called after IpIoOpen(). The data to be sent is wrapped in + Pkt. The IP instance wrapped in IpIo is used for sending by default but can be + overriden by Sender. Other sending configs, like source address and gateway + address etc., are specified in OverrideData. + + @param[in, out] IpIo Pointer to an IP_IO instance used for sending IP + packet. + @param[in, out] Pkt Pointer to the IP packet to be sent. + @param[in] Sender The IP protocol instance used for sending. + @param[in] Context Optional context data. + @param[in] NotifyData Optional notify data. + @param[in] Dest The destination IP address to send this packet to. + This parameter is optional when using IPv6. + @param[in] OverrideData The data to override some configuration of the IP + instance used for sending. + + @retval EFI_SUCCESS The operation is completed successfully. + @retval EFI_INVALID_PARAMETER The input parameter is not correct. + @retval EFI_NOT_STARTED The IpIo is not configured. + @retval EFI_OUT_OF_RESOURCES Failed due to resource limit. + @retval Others Error condition occurred. + +**/ +EFI_STATUS +EFIAPI +IpIoSend ( + IN OUT IP_IO *IpIo, + IN OUT NET_BUF *Pkt, + IN IP_IO_IP_INFO *Sender OPTIONAL, + IN VOID *Context OPTIONAL, + IN VOID *NotifyData OPTIONAL, + IN EFI_IP_ADDRESS *Dest OPTIONAL, + IN IP_IO_OVERRIDE *OverrideData OPTIONAL + ) +{ + EFI_STATUS Status; + IP_IO_IP_PROTOCOL Ip; + IP_IO_SEND_ENTRY *SndEntry; + + if ((IpIo == NULL) || (Pkt == NULL)) { + return EFI_INVALID_PARAMETER; + } + + if ((IpIo->IpVersion == IP_VERSION_4) && (Dest == NULL)) { + return EFI_INVALID_PARAMETER; + } + + if (!IpIo->IsConfigured) { + return EFI_NOT_STARTED; + } + + Ip = (NULL == Sender) ? IpIo->Ip : Sender->Ip; + + // + // create a new SndEntry + // + SndEntry = IpIoCreateSndEntry (IpIo, Pkt, Ip, Context, NotifyData, Dest, OverrideData); + if (NULL == SndEntry) { + return EFI_OUT_OF_RESOURCES; + } + + // + // Send this Packet + // + if (IpIo->IpVersion == IP_VERSION_4){ + Status = Ip.Ip4->Transmit ( + Ip.Ip4, + &SndEntry->SndToken.Ip4Token + ); + } else { + Status = Ip.Ip6->Transmit ( + Ip.Ip6, + &SndEntry->SndToken.Ip6Token + ); + } + + if (EFI_ERROR (Status)) { + IpIoDestroySndEntry (SndEntry); + } + + return Status; +} + + +/** + Cancel the IP transmit token which wraps this Packet. + + If IpIo is NULL, then ASSERT(). + If Packet is NULL, then ASSERT(). + + @param[in] IpIo Pointer to the IP_IO instance. + @param[in] Packet Pointer to the packet of NET_BUF to cancel. + +**/ +VOID +EFIAPI +IpIoCancelTxToken ( + IN IP_IO *IpIo, + IN VOID *Packet + ) +{ + LIST_ENTRY *Node; + IP_IO_SEND_ENTRY *SndEntry; + IP_IO_IP_PROTOCOL Ip; + + ASSERT ((IpIo != NULL) && (Packet != NULL)); + + NET_LIST_FOR_EACH (Node, &IpIo->PendingSndList) { + + SndEntry = NET_LIST_USER_STRUCT (Node, IP_IO_SEND_ENTRY, Entry); + + if (SndEntry->Pkt == Packet) { + + Ip = SndEntry->Ip; + + if (IpIo->IpVersion == IP_VERSION_4) { + Ip.Ip4->Cancel ( + Ip.Ip4, + &SndEntry->SndToken.Ip4Token + ); + } else { + Ip.Ip6->Cancel ( + Ip.Ip6, + &SndEntry->SndToken.Ip6Token + ); + } + + break; + } + } + +} + + +/** + Add a new IP instance for sending data. + + If IpIo is NULL, then ASSERT(). + If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT(). + + The function is used to add the IP_IO to the IP_IO sending list. The caller + can later use IpIoFindSender() to get the IP_IO and call IpIoSend() to send + data. + + @param[in, out] IpIo Pointer to a IP_IO instance to add a new IP + instance for sending purpose. + + @return Pointer to the created IP_IO_IP_INFO structure, NULL if failed. + +**/ +IP_IO_IP_INFO * +EFIAPI +IpIoAddIp ( + IN OUT IP_IO *IpIo + ) +{ + EFI_STATUS Status; + IP_IO_IP_INFO *IpInfo; + EFI_EVENT Event; + + ASSERT (IpIo != NULL); + ASSERT ((IpIo->IpVersion == IP_VERSION_4) || (IpIo->IpVersion == IP_VERSION_6)); + + IpInfo = AllocatePool (sizeof (IP_IO_IP_INFO)); + if (IpInfo == NULL) { + return NULL; + } + + // + // Init this IpInfo, set the Addr and SubnetMask to 0 before we configure the IP + // instance. + // + InitializeListHead (&IpInfo->Entry); + IpInfo->ChildHandle = NULL; + ZeroMem (&IpInfo->Addr, sizeof (IpInfo->Addr)); + ZeroMem (&IpInfo->PreMask, sizeof (IpInfo->PreMask)); + + IpInfo->RefCnt = 1; + IpInfo->IpVersion = IpIo->IpVersion; + + // + // Create the IP instance and open the IP protocol. + // + Status = IpIoCreateIpChildOpenProtocol ( + IpIo->Controller, + IpIo->Image, + &IpInfo->ChildHandle, + IpInfo->IpVersion, + (VOID **) &IpInfo->Ip + ); + if (EFI_ERROR (Status)) { + goto ReleaseIpInfo; + } + + // + // Create the event for the DummyRcvToken. + // + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, + IpIoDummyHandler, + IpInfo, + &Event + ); + if (EFI_ERROR (Status)) { + goto ReleaseIpChild; + } + + if (IpInfo->IpVersion == IP_VERSION_4) { + IpInfo->DummyRcvToken.Ip4Token.Event = Event; + } else { + IpInfo->DummyRcvToken.Ip6Token.Event = Event; + } + + // + // Link this IpInfo into the IpIo. + // + InsertTailList (&IpIo->IpList, &IpInfo->Entry); + + return IpInfo; + +ReleaseIpChild: + + IpIoCloseProtocolDestroyIpChild ( + IpIo->Controller, + IpIo->Image, + IpInfo->ChildHandle, + IpInfo->IpVersion + ); + +ReleaseIpInfo: + + gBS->FreePool (IpInfo); + + return NULL; +} + + +/** + Configure the IP instance of this IpInfo and start the receiving if IpConfigData + is not NULL. + + If IpInfo is NULL, then ASSERT(). + If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT(). + + @param[in, out] IpInfo Pointer to the IP_IO_IP_INFO instance. + @param[in, out] IpConfigData The IP configure data used to configure the IP + instance, if NULL the IP instance is reset. If + UseDefaultAddress is set to TRUE, and the configure + operation succeeds, the default address information + is written back in this IpConfigData. + + @retval EFI_SUCCESS The IP instance of this IpInfo is configured successfully + or no need to reconfigure it. + @retval Others Configuration fails. + +**/ +EFI_STATUS +EFIAPI +IpIoConfigIp ( + IN OUT IP_IO_IP_INFO *IpInfo, + IN OUT VOID *IpConfigData OPTIONAL + ) +{ + EFI_STATUS Status; + IP_IO_IP_PROTOCOL Ip; + UINT8 IpVersion; + EFI_IP4_MODE_DATA Ip4ModeData; + EFI_IP6_MODE_DATA Ip6ModeData; + + ASSERT (IpInfo != NULL); + + if (IpInfo->RefCnt > 1) { + // + // This IP instance is shared, don't reconfigure it until it has only one + // consumer. Currently, only the tcp children cloned from their passive parent + // will share the same IP. So this cases only happens while IpConfigData is NULL, + // let the last consumer clean the IP instance. + // + return EFI_SUCCESS; + } + + IpVersion = IpInfo->IpVersion; + ASSERT ((IpVersion == IP_VERSION_4) || (IpVersion == IP_VERSION_6)); + + Ip = IpInfo->Ip; + + if (IpInfo->IpVersion == IP_VERSION_4) { + Status = Ip.Ip4->Configure (Ip.Ip4, IpConfigData); + } else { + Status = Ip.Ip6->Configure (Ip.Ip6, IpConfigData); + } + + if (EFI_ERROR (Status)) { + return Status; + } + + if (IpConfigData != NULL) { + if (IpInfo->IpVersion == IP_VERSION_4) { + + if (((EFI_IP4_CONFIG_DATA *) IpConfigData)->UseDefaultAddress) { + Status = Ip.Ip4->GetModeData ( + Ip.Ip4, + &Ip4ModeData, + NULL, + NULL + ); + if (EFI_ERROR (Status)) { + Ip.Ip4->Configure (Ip.Ip4, NULL); + return Status; + } + + IP4_COPY_ADDRESS (&((EFI_IP4_CONFIG_DATA*) IpConfigData)->StationAddress, &Ip4ModeData.ConfigData.StationAddress); + IP4_COPY_ADDRESS (&((EFI_IP4_CONFIG_DATA*) IpConfigData)->SubnetMask, &Ip4ModeData.ConfigData.SubnetMask); + } + + CopyMem ( + &IpInfo->Addr.Addr, + &((EFI_IP4_CONFIG_DATA *) IpConfigData)->StationAddress, + sizeof (IP4_ADDR) + ); + CopyMem ( + &IpInfo->PreMask.SubnetMask, + &((EFI_IP4_CONFIG_DATA *) IpConfigData)->SubnetMask, + sizeof (IP4_ADDR) + ); + + Status = Ip.Ip4->Receive ( + Ip.Ip4, + &IpInfo->DummyRcvToken.Ip4Token + ); + if (EFI_ERROR (Status)) { + Ip.Ip4->Configure (Ip.Ip4, NULL); + } + } else { + Status = Ip.Ip6->GetModeData ( + Ip.Ip6, + &Ip6ModeData, + NULL, + NULL + ); + if (EFI_ERROR (Status)) { + Ip.Ip6->Configure (Ip.Ip6, NULL); + return Status; + } + + if (Ip6ModeData.IsConfigured) { + CopyMem ( + &((EFI_IP6_CONFIG_DATA *) IpConfigData)->StationAddress, + &Ip6ModeData.ConfigData.StationAddress, + sizeof (EFI_IPv6_ADDRESS) + ); + + if (Ip6ModeData.AddressList != NULL) { + FreePool (Ip6ModeData.AddressList); + } + + if (Ip6ModeData.GroupTable != NULL) { + FreePool (Ip6ModeData.GroupTable); + } + + if (Ip6ModeData.RouteTable != NULL) { + FreePool (Ip6ModeData.RouteTable); + } + + if (Ip6ModeData.NeighborCache != NULL) { + FreePool (Ip6ModeData.NeighborCache); + } + + if (Ip6ModeData.PrefixTable != NULL) { + FreePool (Ip6ModeData.PrefixTable); + } + + if (Ip6ModeData.IcmpTypeList != NULL) { + FreePool (Ip6ModeData.IcmpTypeList); + } + + } else { + Status = EFI_NO_MAPPING; + return Status; + } + + CopyMem ( + &IpInfo->Addr, + &Ip6ModeData.ConfigData.StationAddress, + sizeof (EFI_IPv6_ADDRESS) + ); + + Status = Ip.Ip6->Receive ( + Ip.Ip6, + &IpInfo->DummyRcvToken.Ip6Token + ); + if (EFI_ERROR (Status)) { + Ip.Ip6->Configure (Ip.Ip6, NULL); + } + } + } else { + // + // The IP instance is reset, set the stored Addr and SubnetMask to zero. + // + ZeroMem (&IpInfo->Addr, sizeof (IpInfo->Addr)); + ZeroMem (&IpInfo->PreMask, sizeof (IpInfo->PreMask)); + } + + return Status; +} + + +/** + Destroy an IP instance maintained in IpIo->IpList for + sending purpose. + + If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT(). + + This function pairs with IpIoAddIp(). The IpInfo is previously created by + IpIoAddIp(). The IP_IO_IP_INFO::RefCnt is decremented and the IP instance + will be dstroyed if the RefCnt is zero. + + @param[in] IpIo Pointer to the IP_IO instance. + @param[in] IpInfo Pointer to the IpInfo to be removed. + +**/ +VOID +EFIAPI +IpIoRemoveIp ( + IN IP_IO *IpIo, + IN IP_IO_IP_INFO *IpInfo + ) +{ + + UINT8 IpVersion; + + if (IpIo == NULL || IpInfo == NULL) { + return; + } + + ASSERT (IpInfo->RefCnt > 0); + + NET_PUT_REF (IpInfo); + + if (IpInfo->RefCnt > 0) { + + return; + } + + IpVersion = IpIo->IpVersion; + + ASSERT ((IpVersion == IP_VERSION_4) || (IpVersion == IP_VERSION_6)); + + RemoveEntryList (&IpInfo->Entry); + + if (IpVersion == IP_VERSION_4){ + IpInfo->Ip.Ip4->Configure ( + IpInfo->Ip.Ip4, + NULL + ); + IpIoCloseProtocolDestroyIpChild ( + IpIo->Controller, + IpIo->Image, + IpInfo->ChildHandle, + IP_VERSION_4 + ); + + gBS->CloseEvent (IpInfo->DummyRcvToken.Ip4Token.Event); + + } else { + + IpInfo->Ip.Ip6->Configure ( + IpInfo->Ip.Ip6, + NULL + ); + + IpIoCloseProtocolDestroyIpChild ( + IpIo->Controller, + IpIo->Image, + IpInfo->ChildHandle, + IP_VERSION_6 + ); + + gBS->CloseEvent (IpInfo->DummyRcvToken.Ip6Token.Event); + } + + FreePool (IpInfo); +} + + +/** + Find the first IP protocol maintained in IpIo whose local + address is the same as Src. + + This function is called when the caller needs the IpIo to send data to the + specified Src. The IpIo was added previously by IpIoAddIp(). + + @param[in, out] IpIo Pointer to the pointer of the IP_IO instance. + @param[in] IpVersion The version of the IP protocol to use, either + IPv4 or IPv6. + @param[in] Src The local IP address. + + @return Pointer to the IP protocol can be used for sending purpose and its local + address is the same with Src. NULL if failed. + +**/ +IP_IO_IP_INFO * +EFIAPI +IpIoFindSender ( + IN OUT IP_IO **IpIo, + IN UINT8 IpVersion, + IN EFI_IP_ADDRESS *Src + ) +{ + LIST_ENTRY *IpIoEntry; + IP_IO *IpIoPtr; + LIST_ENTRY *IpInfoEntry; + IP_IO_IP_INFO *IpInfo; + + if (IpIo == NULL || Src == NULL) { + return NULL; + } + + if ((IpVersion != IP_VERSION_4) && (IpVersion != IP_VERSION_6)) { + return NULL; + } + + NET_LIST_FOR_EACH (IpIoEntry, &mActiveIpIoList) { + IpIoPtr = NET_LIST_USER_STRUCT (IpIoEntry, IP_IO, Entry); + + if (((*IpIo != NULL) && (*IpIo != IpIoPtr)) || (IpIoPtr->IpVersion != IpVersion)) { + continue; + } + + NET_LIST_FOR_EACH (IpInfoEntry, &IpIoPtr->IpList) { + IpInfo = NET_LIST_USER_STRUCT (IpInfoEntry, IP_IO_IP_INFO, Entry); + if (IpInfo->IpVersion == IP_VERSION_4){ + + if (EFI_IP4_EQUAL (&IpInfo->Addr.v4, &Src->v4)) { + *IpIo = IpIoPtr; + return IpInfo; + } + + } else { + + if (EFI_IP6_EQUAL (&IpInfo->Addr.v6, &Src->v6)) { + *IpIo = IpIoPtr; + return IpInfo; + } + } + } + } + + // + // No match. + // + return NULL; +} + + +/** + Get the ICMP error map information. + + The ErrorStatus will be returned. The IsHard and Notify are optional. If they + are not NULL, this routine will fill them. + + @param[in] IcmpError IcmpError Type. + @param[in] IpVersion The version of the IP protocol to use, + either IPv4 or IPv6. + @param[out] IsHard If TRUE, indicates that it is a hard error. + @param[out] Notify If TRUE, SockError needs to be notified. + + @retval EFI_UNSUPPORTED Unrecognizable ICMP error code. + @return ICMP Error Status, such as EFI_NETWORK_UNREACHABLE. + +**/ +EFI_STATUS +EFIAPI +IpIoGetIcmpErrStatus ( + IN UINT8 IcmpError, + IN UINT8 IpVersion, + OUT BOOLEAN *IsHard OPTIONAL, + OUT BOOLEAN *Notify OPTIONAL + ) +{ + if (IpVersion == IP_VERSION_4 ) { + ASSERT (IcmpError <= ICMP_ERR_PARAMPROB); + + if (IsHard != NULL) { + *IsHard = mIcmpErrMap[IcmpError].IsHard; + } + + if (Notify != NULL) { + *Notify = mIcmpErrMap[IcmpError].Notify; + } + + switch (IcmpError) { + case ICMP_ERR_UNREACH_NET: + return EFI_NETWORK_UNREACHABLE; + + case ICMP_ERR_TIMXCEED_INTRANS: + case ICMP_ERR_TIMXCEED_REASS: + case ICMP_ERR_UNREACH_HOST: + return EFI_HOST_UNREACHABLE; + + case ICMP_ERR_UNREACH_PROTOCOL: + return EFI_PROTOCOL_UNREACHABLE; + + case ICMP_ERR_UNREACH_PORT: + return EFI_PORT_UNREACHABLE; + + case ICMP_ERR_MSGSIZE: + case ICMP_ERR_UNREACH_SRCFAIL: + case ICMP_ERR_QUENCH: + case ICMP_ERR_PARAMPROB: + return EFI_ICMP_ERROR; + + default: + ASSERT (FALSE); + return EFI_UNSUPPORTED; + } + + } else if (IpVersion == IP_VERSION_6) { + + ASSERT (IcmpError <= ICMP6_ERR_PARAMPROB_IPV6OPTION); + + if (IsHard != NULL) { + *IsHard = mIcmp6ErrMap[IcmpError].IsHard; + } + + if (Notify != NULL) { + *Notify = mIcmp6ErrMap[IcmpError].Notify; + } + + switch (IcmpError) { + case ICMP6_ERR_UNREACH_NET: + return EFI_NETWORK_UNREACHABLE; + + case ICMP6_ERR_UNREACH_HOST: + case ICMP6_ERR_TIMXCEED_HOPLIMIT: + case ICMP6_ERR_TIMXCEED_REASS: + return EFI_HOST_UNREACHABLE; + + case ICMP6_ERR_UNREACH_PROTOCOL: + return EFI_PROTOCOL_UNREACHABLE; + + case ICMP6_ERR_UNREACH_PORT: + return EFI_PORT_UNREACHABLE; + + case ICMP6_ERR_PACKAGE_TOOBIG: + case ICMP6_ERR_PARAMPROB_HEADER: + case ICMP6_ERR_PARAMPROB_NEXHEADER: + case ICMP6_ERR_PARAMPROB_IPV6OPTION: + return EFI_ICMP_ERROR; + + default: + ASSERT (FALSE); + return EFI_UNSUPPORTED; + } + + } else { + // + // Should never be here + // + ASSERT (FALSE); + return EFI_UNSUPPORTED; + } +} + + +/** + Refresh the remote peer's Neighbor Cache entries. + + This function is called when the caller needs the IpIo to refresh the existing + IPv6 neighbor cache entries since the neighbor is considered reachable by the + node has recently received a confirmation that packets sent recently to the + neighbor were received by its IP layer. + + @param[in] IpIo Pointer to an IP_IO instance + @param[in] Neighbor The IP address of the neighbor + @param[in] Timeout Time in 100-ns units that this entry will + remain in the neighbor cache. A value of + zero means that the entry is permanent. + A value of non-zero means that the entry is + dynamic and will be deleted after Timeout. + + @retval EFI_SUCCESS The operation is completed successfully. + @retval EFI_NOT_STARTED The IpIo is not configured. + @retval EFI_INVALID_PARAMETER Neighbor Address is invalid. + @retval EFI_NOT_FOUND The neighbor cache entry is not in the + neighbor table. + @retval EFI_UNSUPPORTED IP version is IPv4, which doesn't support neighbor cache refresh. + @retval EFI_OUT_OF_RESOURCES Failed due to resource limit. + +**/ +EFI_STATUS +EFIAPI +IpIoRefreshNeighbor ( + IN IP_IO *IpIo, + IN EFI_IP_ADDRESS *Neighbor, + IN UINT32 Timeout + ) +{ + EFI_IP6_PROTOCOL *Ip; + + if (!IpIo->IsConfigured) { + return EFI_NOT_STARTED; + } + + if (IpIo->IpVersion != IP_VERSION_6) { + return EFI_UNSUPPORTED; + } + + Ip = IpIo->Ip.Ip6; + + return Ip->Neighbors (Ip, FALSE, &Neighbor->v6, NULL, Timeout, TRUE); +} + diff --git a/NetworkPkg/Library/DxeIpIoLib/DxeIpIoLib.inf b/NetworkPkg/Library/DxeIpIoLib/DxeIpIoLib.inf new file mode 100644 index 0000000000..a789d80de6 --- /dev/null +++ b/NetworkPkg/Library/DxeIpIoLib/DxeIpIoLib.inf @@ -0,0 +1,46 @@ +## @file +# This library instance provides IP services upon EFI IPv4/IPv6 Protocols. +# +# Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+# SPDX-License-Identifier: BSD-2-Clause-Patent +# +## + + +[Defines] + INF_VERSION = 0x00010005 + BASE_NAME = DxeIpIoLib + MODULE_UNI_FILE = DxeIpIoLib.uni + FILE_GUID = A302F877-8625-425c-B1EC-7487B62C4FDA + MODULE_TYPE = DXE_DRIVER + VERSION_STRING = 1.0 + LIBRARY_CLASS = IpIoLib|DXE_CORE DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER + +# +# The following information is for reference only and not required by the build tools. +# +# VALID_ARCHITECTURES = IA32 X64 EBC +# + +[Sources] + DxeIpIoLib.c + +[Packages] + MdePkg/MdePkg.dec + MdeModulePkg/MdeModulePkg.dec + + +[LibraryClasses] + BaseLib + DebugLib + UefiBootServicesTableLib + MemoryAllocationLib + BaseMemoryLib + DpcLib + +[Protocols] + gEfiIp4ProtocolGuid ## SOMETIMES_CONSUMES + gEfiIp4ServiceBindingProtocolGuid ## SOMETIMES_CONSUMES + gEfiIp6ProtocolGuid ## SOMETIMES_CONSUMES + gEfiIp6ServiceBindingProtocolGuid ## SOMETIMES_CONSUMES + diff --git a/NetworkPkg/Library/DxeIpIoLib/DxeIpIoLib.uni b/NetworkPkg/Library/DxeIpIoLib/DxeIpIoLib.uni new file mode 100644 index 0000000000..4af043cfe9 --- /dev/null +++ b/NetworkPkg/Library/DxeIpIoLib/DxeIpIoLib.uni @@ -0,0 +1,16 @@ +// /** @file +// This library instance provides IP services upon EFI IPv4/IPv6 Protocols. +// +// This library instance provides IP services upon EFI IPv4/IPv6 Protocols. +// +// Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+// +// SPDX-License-Identifier: BSD-2-Clause-Patent +// +// **/ + + +#string STR_MODULE_ABSTRACT #language en-US "EFI IPv4/IPv6 IP Services Library" + +#string STR_MODULE_DESCRIPTION #language en-US "This library instance provides IP services upon EFI IPv4/IPv6 Protocols." + diff --git a/NetworkPkg/Library/DxeNetLib/DxeNetLib.c b/NetworkPkg/Library/DxeNetLib/DxeNetLib.c new file mode 100644 index 0000000000..8e2f720666 --- /dev/null +++ b/NetworkPkg/Library/DxeNetLib/DxeNetLib.c @@ -0,0 +1,3394 @@ +/** @file + Network library. + +Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
+(C) Copyright 2015 Hewlett Packard Enterprise Development LP
+SPDX-License-Identifier: BSD-2-Clause-Patent +**/ + +#include + +#include + +#include +#include +#include +#include +#include +#include +#include +#include + +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#define NIC_ITEM_CONFIG_SIZE (sizeof (NIC_IP4_CONFIG_INFO) + sizeof (EFI_IP4_ROUTE_TABLE) * MAX_IP4_CONFIG_IN_VARIABLE) +#define DEFAULT_ZERO_START ((UINTN) ~0) + +// +// All the supported IP4 maskes in host byte order. +// +GLOBAL_REMOVE_IF_UNREFERENCED IP4_ADDR gIp4AllMasks[IP4_MASK_NUM] = { + 0x00000000, + 0x80000000, + 0xC0000000, + 0xE0000000, + 0xF0000000, + 0xF8000000, + 0xFC000000, + 0xFE000000, + + 0xFF000000, + 0xFF800000, + 0xFFC00000, + 0xFFE00000, + 0xFFF00000, + 0xFFF80000, + 0xFFFC0000, + 0xFFFE0000, + + 0xFFFF0000, + 0xFFFF8000, + 0xFFFFC000, + 0xFFFFE000, + 0xFFFFF000, + 0xFFFFF800, + 0xFFFFFC00, + 0xFFFFFE00, + + 0xFFFFFF00, + 0xFFFFFF80, + 0xFFFFFFC0, + 0xFFFFFFE0, + 0xFFFFFFF0, + 0xFFFFFFF8, + 0xFFFFFFFC, + 0xFFFFFFFE, + 0xFFFFFFFF, +}; + +GLOBAL_REMOVE_IF_UNREFERENCED EFI_IPv4_ADDRESS mZeroIp4Addr = {{0, 0, 0, 0}}; + +// +// Any error level digitally larger than mNetDebugLevelMax +// will be silently discarded. +// +GLOBAL_REMOVE_IF_UNREFERENCED UINTN mNetDebugLevelMax = NETDEBUG_LEVEL_ERROR; +GLOBAL_REMOVE_IF_UNREFERENCED UINT32 mSyslogPacketSeq = 0xDEADBEEF; + +// +// You can change mSyslogDstMac mSyslogDstIp and mSyslogSrcIp +// here to direct the syslog packets to the syslog deamon. The +// default is broadcast to both the ethernet and IP. +// +GLOBAL_REMOVE_IF_UNREFERENCED UINT8 mSyslogDstMac[NET_ETHER_ADDR_LEN] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff}; +GLOBAL_REMOVE_IF_UNREFERENCED UINT32 mSyslogDstIp = 0xffffffff; +GLOBAL_REMOVE_IF_UNREFERENCED UINT32 mSyslogSrcIp = 0; + +GLOBAL_REMOVE_IF_UNREFERENCED CHAR8 *mMonthName[] = { + "Jan", + "Feb", + "Mar", + "Apr", + "May", + "Jun", + "Jul", + "Aug", + "Sep", + "Oct", + "Nov", + "Dec" +}; + +// +// VLAN device path node template +// +GLOBAL_REMOVE_IF_UNREFERENCED VLAN_DEVICE_PATH mNetVlanDevicePathTemplate = { + { + MESSAGING_DEVICE_PATH, + MSG_VLAN_DP, + { + (UINT8) (sizeof (VLAN_DEVICE_PATH)), + (UINT8) ((sizeof (VLAN_DEVICE_PATH)) >> 8) + } + }, + 0 +}; + +/** + Locate the handles that support SNP, then open one of them + to send the syslog packets. The caller isn't required to close + the SNP after use because the SNP is opened by HandleProtocol. + + @return The point to SNP if one is properly openned. Otherwise NULL + +**/ +EFI_SIMPLE_NETWORK_PROTOCOL * +SyslogLocateSnp ( + VOID + ) +{ + EFI_SIMPLE_NETWORK_PROTOCOL *Snp; + EFI_STATUS Status; + EFI_HANDLE *Handles; + UINTN HandleCount; + UINTN Index; + + // + // Locate the handles which has SNP installed. + // + Handles = NULL; + Status = gBS->LocateHandleBuffer ( + ByProtocol, + &gEfiSimpleNetworkProtocolGuid, + NULL, + &HandleCount, + &Handles + ); + + if (EFI_ERROR (Status) || (HandleCount == 0)) { + return NULL; + } + + // + // Try to open one of the ethernet SNP protocol to send packet + // + Snp = NULL; + + for (Index = 0; Index < HandleCount; Index++) { + Status = gBS->HandleProtocol ( + Handles[Index], + &gEfiSimpleNetworkProtocolGuid, + (VOID **) &Snp + ); + + if ((Status == EFI_SUCCESS) && (Snp != NULL) && + (Snp->Mode->IfType == NET_IFTYPE_ETHERNET) && + (Snp->Mode->MaxPacketSize >= NET_SYSLOG_PACKET_LEN)) { + + break; + } + + Snp = NULL; + } + + FreePool (Handles); + return Snp; +} + +/** + Transmit a syslog packet synchronously through SNP. The Packet + already has the ethernet header prepended. This function should + fill in the source MAC because it will try to locate a SNP each + time it is called to avoid the problem if SNP is unloaded. + This code snip is copied from MNP. + If Packet is NULL, then ASSERT(). + + @param[in] Packet The Syslog packet + @param[in] Length The length of the packet + + @retval EFI_DEVICE_ERROR Failed to locate a usable SNP protocol + @retval EFI_TIMEOUT Timeout happened to send the packet. + @retval EFI_SUCCESS Packet is sent. + +**/ +EFI_STATUS +SyslogSendPacket ( + IN CHAR8 *Packet, + IN UINT32 Length + ) +{ + EFI_SIMPLE_NETWORK_PROTOCOL *Snp; + ETHER_HEAD *Ether; + EFI_STATUS Status; + EFI_EVENT TimeoutEvent; + UINT8 *TxBuf; + + ASSERT (Packet != NULL); + + Snp = SyslogLocateSnp (); + + if (Snp == NULL) { + return EFI_DEVICE_ERROR; + } + + Ether = (ETHER_HEAD *) Packet; + CopyMem (Ether->SrcMac, Snp->Mode->CurrentAddress.Addr, NET_ETHER_ADDR_LEN); + + // + // Start the timeout event. + // + Status = gBS->CreateEvent ( + EVT_TIMER, + TPL_NOTIFY, + NULL, + NULL, + &TimeoutEvent + ); + + if (EFI_ERROR (Status)) { + return Status; + } + + Status = gBS->SetTimer (TimeoutEvent, TimerRelative, NET_SYSLOG_TX_TIMEOUT); + + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } + + for (;;) { + // + // Transmit the packet through SNP. + // + Status = Snp->Transmit (Snp, 0, Length, Packet, NULL, NULL, NULL); + + if ((Status != EFI_SUCCESS) && (Status != EFI_NOT_READY)) { + Status = EFI_DEVICE_ERROR; + break; + } + + // + // If Status is EFI_SUCCESS, the packet is put in the transmit queue. + // if Status is EFI_NOT_READY, the transmit engine of the network + // interface is busy. Both need to sync SNP. + // + TxBuf = NULL; + + do { + // + // Get the recycled transmit buffer status. + // + Snp->GetStatus (Snp, NULL, (VOID **) &TxBuf); + + if (!EFI_ERROR (gBS->CheckEvent (TimeoutEvent))) { + Status = EFI_TIMEOUT; + break; + } + + } while (TxBuf == NULL); + + if ((Status == EFI_SUCCESS) || (Status == EFI_TIMEOUT)) { + break; + } + + // + // Status is EFI_NOT_READY. Restart the timer event and + // call Snp->Transmit again. + // + gBS->SetTimer (TimeoutEvent, TimerRelative, NET_SYSLOG_TX_TIMEOUT); + } + + gBS->SetTimer (TimeoutEvent, TimerCancel, 0); + +ON_EXIT: + gBS->CloseEvent (TimeoutEvent); + return Status; +} + +/** + Build a syslog packet, including the Ethernet/Ip/Udp headers + and user's message. + + @param[in] Level Syslog severity level + @param[in] Module The module that generates the log + @param[in] File The file that contains the current log + @param[in] Line The line of code in the File that contains the current log + @param[in] Message The log message + @param[in] BufLen The lenght of the Buf + @param[out] Buf The buffer to put the packet data + + @return The length of the syslog packet built, 0 represents no packet is built. + +**/ +UINT32 +SyslogBuildPacket ( + IN UINT32 Level, + IN UINT8 *Module, + IN UINT8 *File, + IN UINT32 Line, + IN UINT8 *Message, + IN UINT32 BufLen, + OUT CHAR8 *Buf + ) +{ + EFI_STATUS Status; + ETHER_HEAD *Ether; + IP4_HEAD *Ip4; + EFI_UDP_HEADER *Udp4; + EFI_TIME Time; + UINT32 Pri; + UINT32 Len; + + // + // Fill in the Ethernet header. Leave alone the source MAC. + // SyslogSendPacket will fill in the address for us. + // + Ether = (ETHER_HEAD *) Buf; + CopyMem (Ether->DstMac, mSyslogDstMac, NET_ETHER_ADDR_LEN); + ZeroMem (Ether->SrcMac, NET_ETHER_ADDR_LEN); + + Ether->EtherType = HTONS (0x0800); // IPv4 protocol + + Buf += sizeof (ETHER_HEAD); + BufLen -= sizeof (ETHER_HEAD); + + // + // Fill in the IP header + // + Ip4 = (IP4_HEAD *) Buf; + Ip4->HeadLen = 5; + Ip4->Ver = 4; + Ip4->Tos = 0; + Ip4->TotalLen = 0; + Ip4->Id = (UINT16) mSyslogPacketSeq; + Ip4->Fragment = 0; + Ip4->Ttl = 16; + Ip4->Protocol = 0x11; + Ip4->Checksum = 0; + Ip4->Src = mSyslogSrcIp; + Ip4->Dst = mSyslogDstIp; + + Buf += sizeof (IP4_HEAD); + BufLen -= sizeof (IP4_HEAD); + + // + // Fill in the UDP header, Udp checksum is optional. Leave it zero. + // + Udp4 = (EFI_UDP_HEADER *) Buf; + Udp4->SrcPort = HTONS (514); + Udp4->DstPort = HTONS (514); + Udp4->Length = 0; + Udp4->Checksum = 0; + + Buf += sizeof (EFI_UDP_HEADER); + BufLen -= sizeof (EFI_UDP_HEADER); + + // + // Build the syslog message body with Timestamp machine module Message + // + Pri = ((NET_SYSLOG_FACILITY & 31) << 3) | (Level & 7); + Status = gRT->GetTime (&Time, NULL); + if (EFI_ERROR (Status)) { + return 0; + } + + // + // Use %a to format the ASCII strings, %s to format UNICODE strings + // + Len = 0; + Len += (UINT32) AsciiSPrint ( + Buf, + BufLen, + "<%d> %a %d %d:%d:%d ", + Pri, + mMonthName [Time.Month-1], + Time.Day, + Time.Hour, + Time.Minute, + Time.Second + ); + + Len += (UINT32) AsciiSPrint ( + Buf + Len, + BufLen - Len, + "Tiano %a: %a (Line: %d File: %a)", + Module, + Message, + Line, + File + ); + Len ++; + + // + // OK, patch the IP length/checksum and UDP length fields. + // + Len += sizeof (EFI_UDP_HEADER); + Udp4->Length = HTONS ((UINT16) Len); + + Len += sizeof (IP4_HEAD); + Ip4->TotalLen = HTONS ((UINT16) Len); + Ip4->Checksum = (UINT16) (~NetblockChecksum ((UINT8 *) Ip4, sizeof (IP4_HEAD))); + + return Len + sizeof (ETHER_HEAD); +} + +/** + Allocate a buffer, then format the message to it. This is a + help function for the NET_DEBUG_XXX macros. The PrintArg of + these macros treats the variable length print parameters as a + single parameter, and pass it to the NetDebugASPrint. For + example, NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name)) + if extracted to: + + NetDebugOutput ( + NETDEBUG_LEVEL_TRACE, + "Tcp", + __FILE__, + __LINE__, + NetDebugASPrint ("State transit to %a\n", Name) + ) + + If Format is NULL, then ASSERT(). + + @param Format The ASCII format string. + @param ... The variable length parameter whose format is determined + by the Format string. + + @return The buffer containing the formatted message, + or NULL if failed to allocate memory. + +**/ +CHAR8 * +EFIAPI +NetDebugASPrint ( + IN CHAR8 *Format, + ... + ) +{ + VA_LIST Marker; + CHAR8 *Buf; + + ASSERT (Format != NULL); + + Buf = (CHAR8 *) AllocatePool (NET_DEBUG_MSG_LEN); + + if (Buf == NULL) { + return NULL; + } + + VA_START (Marker, Format); + AsciiVSPrint (Buf, NET_DEBUG_MSG_LEN, Format, Marker); + VA_END (Marker); + + return Buf; +} + +/** + Builds an UDP4 syslog packet and send it using SNP. + + This function will locate a instance of SNP then send the message through it. + Because it isn't open the SNP BY_DRIVER, apply caution when using it. + + @param Level The severity level of the message. + @param Module The Moudle that generates the log. + @param File The file that contains the log. + @param Line The exact line that contains the log. + @param Message The user message to log. + + @retval EFI_INVALID_PARAMETER Any input parameter is invalid. + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the packet. + @retval EFI_DEVICE_ERROR Device error occurs. + @retval EFI_SUCCESS The log is discard because that it is more verbose + than the mNetDebugLevelMax. Or, it has been sent out. +**/ +EFI_STATUS +EFIAPI +NetDebugOutput ( + IN UINT32 Level, + IN UINT8 *Module, + IN UINT8 *File, + IN UINT32 Line, + IN UINT8 *Message + ) +{ + CHAR8 *Packet; + UINT32 Len; + EFI_STATUS Status; + + // + // Check whether the message should be sent out + // + if (Message == NULL || File == NULL || Module == NULL) { + return EFI_INVALID_PARAMETER; + } + + if (Level > mNetDebugLevelMax) { + Status = EFI_SUCCESS; + goto ON_EXIT; + } + + // + // Allocate a maxium of 1024 bytes, the caller should ensure + // that the message plus the ethernet/ip/udp header is shorter + // than this + // + Packet = (CHAR8 *) AllocatePool (NET_SYSLOG_PACKET_LEN); + + if (Packet == NULL) { + Status = EFI_OUT_OF_RESOURCES; + goto ON_EXIT; + } + + // + // Build the message: Ethernet header + IP header + Udp Header + user data + // + Len = SyslogBuildPacket ( + Level, + Module, + File, + Line, + Message, + NET_SYSLOG_PACKET_LEN, + Packet + ); + if (Len == 0) { + Status = EFI_DEVICE_ERROR; + } else { + mSyslogPacketSeq++; + Status = SyslogSendPacket (Packet, Len); + } + + FreePool (Packet); + +ON_EXIT: + FreePool (Message); + return Status; +} +/** + Return the length of the mask. + + Return the length of the mask, the correct value is from 0 to 32. + If the mask is invalid, return the invalid length 33, which is IP4_MASK_NUM. + NetMask is in the host byte order. + + @param[in] NetMask The netmask to get the length from. + + @return The length of the netmask, IP4_MASK_NUM if the mask is invalid. + +**/ +INTN +EFIAPI +NetGetMaskLength ( + IN IP4_ADDR NetMask + ) +{ + INTN Index; + + for (Index = 0; Index <= IP4_MASK_MAX; Index++) { + if (NetMask == gIp4AllMasks[Index]) { + break; + } + } + + return Index; +} + + + +/** + Return the class of the IP address, such as class A, B, C. + Addr is in host byte order. + + [ATTENTION] + Classful addressing (IP class A/B/C) has been deprecated according to RFC4632. + Caller of this function could only check the returned value against + IP4_ADDR_CLASSD (multicast) or IP4_ADDR_CLASSE (reserved) now. + + The address of class A starts with 0. + If the address belong to class A, return IP4_ADDR_CLASSA. + The address of class B starts with 10. + If the address belong to class B, return IP4_ADDR_CLASSB. + The address of class C starts with 110. + If the address belong to class C, return IP4_ADDR_CLASSC. + The address of class D starts with 1110. + If the address belong to class D, return IP4_ADDR_CLASSD. + The address of class E starts with 1111. + If the address belong to class E, return IP4_ADDR_CLASSE. + + + @param[in] Addr The address to get the class from. + + @return IP address class, such as IP4_ADDR_CLASSA. + +**/ +INTN +EFIAPI +NetGetIpClass ( + IN IP4_ADDR Addr + ) +{ + UINT8 ByteOne; + + ByteOne = (UINT8) (Addr >> 24); + + if ((ByteOne & 0x80) == 0) { + return IP4_ADDR_CLASSA; + + } else if ((ByteOne & 0xC0) == 0x80) { + return IP4_ADDR_CLASSB; + + } else if ((ByteOne & 0xE0) == 0xC0) { + return IP4_ADDR_CLASSC; + + } else if ((ByteOne & 0xF0) == 0xE0) { + return IP4_ADDR_CLASSD; + + } else { + return IP4_ADDR_CLASSE; + + } +} + + +/** + Check whether the IP is a valid unicast address according to + the netmask. + + ASSERT if NetMask is zero. + + If all bits of the host address of IP are 0 or 1, IP is also not a valid unicast address, + except when the originator is one of the endpoints of a point-to-point link with a 31-bit + mask (RFC3021), or a 32bit NetMask (all 0xFF) is used for special network environment (e.g. + PPP link). + + @param[in] Ip The IP to check against. + @param[in] NetMask The mask of the IP. + + @return TRUE if IP is a valid unicast address on the network, otherwise FALSE. + +**/ +BOOLEAN +EFIAPI +NetIp4IsUnicast ( + IN IP4_ADDR Ip, + IN IP4_ADDR NetMask + ) +{ + INTN MaskLength; + + ASSERT (NetMask != 0); + + if (Ip == 0 || IP4_IS_LOCAL_BROADCAST (Ip)) { + return FALSE; + } + + MaskLength = NetGetMaskLength (NetMask); + ASSERT ((MaskLength >= 0) && (MaskLength <= IP4_MASK_NUM)); + if (MaskLength < 31) { + if (((Ip &~NetMask) == ~NetMask) || ((Ip &~NetMask) == 0)) { + return FALSE; + } + } + + return TRUE; +} + +/** + Check whether the incoming IPv6 address is a valid unicast address. + + ASSERT if Ip6 is NULL. + + If the address is a multicast address has binary 0xFF at the start, it is not + a valid unicast address. If the address is unspecified ::, it is not a valid + unicast address to be assigned to any node. If the address is loopback address + ::1, it is also not a valid unicast address to be assigned to any physical + interface. + + @param[in] Ip6 The IPv6 address to check against. + + @return TRUE if Ip6 is a valid unicast address on the network, otherwise FALSE. + +**/ +BOOLEAN +EFIAPI +NetIp6IsValidUnicast ( + IN EFI_IPv6_ADDRESS *Ip6 + ) +{ + UINT8 Byte; + UINT8 Index; + + ASSERT (Ip6 != NULL); + + if (Ip6->Addr[0] == 0xFF) { + return FALSE; + } + + for (Index = 0; Index < 15; Index++) { + if (Ip6->Addr[Index] != 0) { + return TRUE; + } + } + + Byte = Ip6->Addr[Index]; + + if (Byte == 0x0 || Byte == 0x1) { + return FALSE; + } + + return TRUE; +} + +/** + Check whether the incoming Ipv6 address is the unspecified address or not. + + ASSERT if Ip6 is NULL. + + @param[in] Ip6 - Ip6 address, in network order. + + @retval TRUE - Yes, unspecified + @retval FALSE - No + +**/ +BOOLEAN +EFIAPI +NetIp6IsUnspecifiedAddr ( + IN EFI_IPv6_ADDRESS *Ip6 + ) +{ + UINT8 Index; + + ASSERT (Ip6 != NULL); + + for (Index = 0; Index < 16; Index++) { + if (Ip6->Addr[Index] != 0) { + return FALSE; + } + } + + return TRUE; +} + +/** + Check whether the incoming Ipv6 address is a link-local address. + + ASSERT if Ip6 is NULL. + + @param[in] Ip6 - Ip6 address, in network order. + + @retval TRUE - Yes, link-local address + @retval FALSE - No + +**/ +BOOLEAN +EFIAPI +NetIp6IsLinkLocalAddr ( + IN EFI_IPv6_ADDRESS *Ip6 + ) +{ + UINT8 Index; + + ASSERT (Ip6 != NULL); + + if (Ip6->Addr[0] != 0xFE) { + return FALSE; + } + + if (Ip6->Addr[1] != 0x80) { + return FALSE; + } + + for (Index = 2; Index < 8; Index++) { + if (Ip6->Addr[Index] != 0) { + return FALSE; + } + } + + return TRUE; +} + +/** + Check whether the Ipv6 address1 and address2 are on the connected network. + + ASSERT if Ip1 or Ip2 is NULL. + ASSERT if PrefixLength exceeds or equals to IP6_PREFIX_MAX. + + @param[in] Ip1 - Ip6 address1, in network order. + @param[in] Ip2 - Ip6 address2, in network order. + @param[in] PrefixLength - The prefix length of the checking net. + + @retval TRUE - Yes, connected. + @retval FALSE - No. + +**/ +BOOLEAN +EFIAPI +NetIp6IsNetEqual ( + EFI_IPv6_ADDRESS *Ip1, + EFI_IPv6_ADDRESS *Ip2, + UINT8 PrefixLength + ) +{ + UINT8 Byte; + UINT8 Bit; + UINT8 Mask; + + ASSERT ((Ip1 != NULL) && (Ip2 != NULL) && (PrefixLength < IP6_PREFIX_MAX)); + + if (PrefixLength == 0) { + return TRUE; + } + + Byte = (UINT8) (PrefixLength / 8); + Bit = (UINT8) (PrefixLength % 8); + + if (CompareMem (Ip1, Ip2, Byte) != 0) { + return FALSE; + } + + if (Bit > 0) { + Mask = (UINT8) (0xFF << (8 - Bit)); + + ASSERT (Byte < 16); + if (Byte >= 16) { + return FALSE; + } + if ((Ip1->Addr[Byte] & Mask) != (Ip2->Addr[Byte] & Mask)) { + return FALSE; + } + } + + return TRUE; +} + + +/** + Switches the endianess of an IPv6 address + + ASSERT if Ip6 is NULL. + + This function swaps the bytes in a 128-bit IPv6 address to switch the value + from little endian to big endian or vice versa. The byte swapped value is + returned. + + @param Ip6 Points to an IPv6 address + + @return The byte swapped IPv6 address. + +**/ +EFI_IPv6_ADDRESS * +EFIAPI +Ip6Swap128 ( + EFI_IPv6_ADDRESS *Ip6 + ) +{ + UINT64 High; + UINT64 Low; + + ASSERT (Ip6 != NULL); + + CopyMem (&High, Ip6, sizeof (UINT64)); + CopyMem (&Low, &Ip6->Addr[8], sizeof (UINT64)); + + High = SwapBytes64 (High); + Low = SwapBytes64 (Low); + + CopyMem (Ip6, &Low, sizeof (UINT64)); + CopyMem (&Ip6->Addr[8], &High, sizeof (UINT64)); + + return Ip6; +} + +/** + Initialize a random seed using current time and monotonic count. + + Get current time and monotonic count first. Then initialize a random seed + based on some basic mathematics operation on the hour, day, minute, second, + nanosecond and year of the current time and the monotonic count value. + + @return The random seed initialized with current time. + +**/ +UINT32 +EFIAPI +NetRandomInitSeed ( + VOID + ) +{ + EFI_TIME Time; + UINT32 Seed; + UINT64 MonotonicCount; + + gRT->GetTime (&Time, NULL); + Seed = (Time.Hour << 24 | Time.Day << 16 | Time.Minute << 8 | Time.Second); + Seed ^= Time.Nanosecond; + Seed ^= Time.Year << 7; + + gBS->GetNextMonotonicCount (&MonotonicCount); + Seed += (UINT32) MonotonicCount; + + return Seed; +} + + +/** + Extract a UINT32 from a byte stream. + + ASSERT if Buf is NULL. + + Copy a UINT32 from a byte stream, then converts it from Network + byte order to host byte order. Use this function to avoid alignment error. + + @param[in] Buf The buffer to extract the UINT32. + + @return The UINT32 extracted. + +**/ +UINT32 +EFIAPI +NetGetUint32 ( + IN UINT8 *Buf + ) +{ + UINT32 Value; + + ASSERT (Buf != NULL); + + CopyMem (&Value, Buf, sizeof (UINT32)); + return NTOHL (Value); +} + + +/** + Put a UINT32 to the byte stream in network byte order. + + ASSERT if Buf is NULL. + + Converts a UINT32 from host byte order to network byte order. Then copy it to the + byte stream. + + @param[in, out] Buf The buffer to put the UINT32. + @param[in] Data The data to be converted and put into the byte stream. + +**/ +VOID +EFIAPI +NetPutUint32 ( + IN OUT UINT8 *Buf, + IN UINT32 Data + ) +{ + ASSERT (Buf != NULL); + + Data = HTONL (Data); + CopyMem (Buf, &Data, sizeof (UINT32)); +} + + +/** + Remove the first node entry on the list, and return the removed node entry. + + Removes the first node Entry from a doubly linked list. It is up to the caller of + this function to release the memory used by the first node if that is required. On + exit, the removed node is returned. + + If Head is NULL, then ASSERT(). + If Head was not initialized, then ASSERT(). + If PcdMaximumLinkedListLength is not zero, and the number of nodes in the + linked list including the head node is greater than or equal to PcdMaximumLinkedListLength, + then ASSERT(). + + @param[in, out] Head The list header. + + @return The first node entry that is removed from the list, NULL if the list is empty. + +**/ +LIST_ENTRY * +EFIAPI +NetListRemoveHead ( + IN OUT LIST_ENTRY *Head + ) +{ + LIST_ENTRY *First; + + ASSERT (Head != NULL); + + if (IsListEmpty (Head)) { + return NULL; + } + + First = Head->ForwardLink; + Head->ForwardLink = First->ForwardLink; + First->ForwardLink->BackLink = Head; + + DEBUG_CODE ( + First->ForwardLink = (LIST_ENTRY *) NULL; + First->BackLink = (LIST_ENTRY *) NULL; + ); + + return First; +} + + +/** + Remove the last node entry on the list and and return the removed node entry. + + Removes the last node entry from a doubly linked list. It is up to the caller of + this function to release the memory used by the first node if that is required. On + exit, the removed node is returned. + + If Head is NULL, then ASSERT(). + If Head was not initialized, then ASSERT(). + If PcdMaximumLinkedListLength is not zero, and the number of nodes in the + linked list including the head node is greater than or equal to PcdMaximumLinkedListLength, + then ASSERT(). + + @param[in, out] Head The list head. + + @return The last node entry that is removed from the list, NULL if the list is empty. + +**/ +LIST_ENTRY * +EFIAPI +NetListRemoveTail ( + IN OUT LIST_ENTRY *Head + ) +{ + LIST_ENTRY *Last; + + ASSERT (Head != NULL); + + if (IsListEmpty (Head)) { + return NULL; + } + + Last = Head->BackLink; + Head->BackLink = Last->BackLink; + Last->BackLink->ForwardLink = Head; + + DEBUG_CODE ( + Last->ForwardLink = (LIST_ENTRY *) NULL; + Last->BackLink = (LIST_ENTRY *) NULL; + ); + + return Last; +} + + +/** + Insert a new node entry after a designated node entry of a doubly linked list. + + ASSERT if PrevEntry or NewEntry is NULL. + + Inserts a new node entry donated by NewEntry after the node entry donated by PrevEntry + of the doubly linked list. + + @param[in, out] PrevEntry The previous entry to insert after. + @param[in, out] NewEntry The new entry to insert. + +**/ +VOID +EFIAPI +NetListInsertAfter ( + IN OUT LIST_ENTRY *PrevEntry, + IN OUT LIST_ENTRY *NewEntry + ) +{ + ASSERT (PrevEntry != NULL && NewEntry != NULL); + + NewEntry->BackLink = PrevEntry; + NewEntry->ForwardLink = PrevEntry->ForwardLink; + PrevEntry->ForwardLink->BackLink = NewEntry; + PrevEntry->ForwardLink = NewEntry; +} + + +/** + Insert a new node entry before a designated node entry of a doubly linked list. + + ASSERT if PostEntry or NewEntry is NULL. + + Inserts a new node entry donated by NewEntry after the node entry donated by PostEntry + of the doubly linked list. + + @param[in, out] PostEntry The entry to insert before. + @param[in, out] NewEntry The new entry to insert. + +**/ +VOID +EFIAPI +NetListInsertBefore ( + IN OUT LIST_ENTRY *PostEntry, + IN OUT LIST_ENTRY *NewEntry + ) +{ + ASSERT (PostEntry != NULL && NewEntry != NULL); + + NewEntry->ForwardLink = PostEntry; + NewEntry->BackLink = PostEntry->BackLink; + PostEntry->BackLink->ForwardLink = NewEntry; + PostEntry->BackLink = NewEntry; +} + +/** + Safe destroy nodes in a linked list, and return the length of the list after all possible operations finished. + + Destroy network child instance list by list traversals is not safe due to graph dependencies between nodes. + This function performs a safe traversal to destroy these nodes by checking to see if the node being destroyed + has been removed from the list or not. + If it has been removed, then restart the traversal from the head. + If it hasn't been removed, then continue with the next node directly. + This function will end the iterate and return the CallBack's last return value if error happens, + or retrun EFI_SUCCESS if 2 complete passes are made with no changes in the number of children in the list. + + @param[in] List The head of the list. + @param[in] CallBack Pointer to the callback function to destroy one node in the list. + @param[in] Context Pointer to the callback function's context: corresponds to the + parameter Context in NET_DESTROY_LINK_LIST_CALLBACK. + @param[out] ListLength The length of the link list if the function returns successfully. + + @retval EFI_SUCCESS Two complete passes are made with no changes in the number of children. + @retval EFI_INVALID_PARAMETER The input parameter is invalid. + @retval Others Return the CallBack's last return value. + +**/ +EFI_STATUS +EFIAPI +NetDestroyLinkList ( + IN LIST_ENTRY *List, + IN NET_DESTROY_LINK_LIST_CALLBACK CallBack, + IN VOID *Context, OPTIONAL + OUT UINTN *ListLength OPTIONAL + ) +{ + UINTN PreviousLength; + LIST_ENTRY *Entry; + LIST_ENTRY *Ptr; + UINTN Length; + EFI_STATUS Status; + + if (List == NULL || CallBack == NULL) { + return EFI_INVALID_PARAMETER; + } + + Length = 0; + do { + PreviousLength = Length; + Entry = GetFirstNode (List); + while (!IsNull (List, Entry)) { + Status = CallBack (Entry, Context); + if (EFI_ERROR (Status)) { + return Status; + } + // + // Walk through the list to see whether the Entry has been removed or not. + // If the Entry still exists, just try to destroy the next one. + // If not, go back to the start point to iterate the list again. + // + for (Ptr = List->ForwardLink; Ptr != List; Ptr = Ptr->ForwardLink) { + if (Ptr == Entry) { + break; + } + } + if (Ptr == Entry) { + Entry = GetNextNode (List, Entry); + } else { + Entry = GetFirstNode (List); + } + } + for (Length = 0, Ptr = List->ForwardLink; Ptr != List; Length++, Ptr = Ptr->ForwardLink); + } while (Length != PreviousLength); + + if (ListLength != NULL) { + *ListLength = Length; + } + return EFI_SUCCESS; +} + +/** + This function checks the input Handle to see if it's one of these handles in ChildHandleBuffer. + + @param[in] Handle Handle to be checked. + @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. + @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL + if NumberOfChildren is 0. + + @retval TRUE Found the input Handle in ChildHandleBuffer. + @retval FALSE Can't find the input Handle in ChildHandleBuffer. + +**/ +BOOLEAN +EFIAPI +NetIsInHandleBuffer ( + IN EFI_HANDLE Handle, + IN UINTN NumberOfChildren, + IN EFI_HANDLE *ChildHandleBuffer OPTIONAL + ) +{ + UINTN Index; + + if (NumberOfChildren == 0 || ChildHandleBuffer == NULL) { + return FALSE; + } + + for (Index = 0; Index < NumberOfChildren; Index++) { + if (Handle == ChildHandleBuffer[Index]) { + return TRUE; + } + } + + return FALSE; +} + + +/** + Initialize the netmap. Netmap is a reposity to keep the pairs. + + Initialize the forward and backward links of two head nodes donated by Map->Used + and Map->Recycled of two doubly linked lists. + Initializes the count of the pairs in the netmap to zero. + + If Map is NULL, then ASSERT(). + If the address of Map->Used is NULL, then ASSERT(). + If the address of Map->Recycled is NULl, then ASSERT(). + + @param[in, out] Map The netmap to initialize. + +**/ +VOID +EFIAPI +NetMapInit ( + IN OUT NET_MAP *Map + ) +{ + ASSERT (Map != NULL); + + InitializeListHead (&Map->Used); + InitializeListHead (&Map->Recycled); + Map->Count = 0; +} + + +/** + To clean up the netmap, that is, release allocated memories. + + Removes all nodes of the Used doubly linked list and free memory of all related netmap items. + Removes all nodes of the Recycled doubly linked list and free memory of all related netmap items. + The number of the pairs in the netmap is set to be zero. + + If Map is NULL, then ASSERT(). + + @param[in, out] Map The netmap to clean up. + +**/ +VOID +EFIAPI +NetMapClean ( + IN OUT NET_MAP *Map + ) +{ + NET_MAP_ITEM *Item; + LIST_ENTRY *Entry; + LIST_ENTRY *Next; + + ASSERT (Map != NULL); + + NET_LIST_FOR_EACH_SAFE (Entry, Next, &Map->Used) { + Item = NET_LIST_USER_STRUCT (Entry, NET_MAP_ITEM, Link); + + RemoveEntryList (&Item->Link); + Map->Count--; + + gBS->FreePool (Item); + } + + ASSERT ((Map->Count == 0) && IsListEmpty (&Map->Used)); + + NET_LIST_FOR_EACH_SAFE (Entry, Next, &Map->Recycled) { + Item = NET_LIST_USER_STRUCT (Entry, NET_MAP_ITEM, Link); + + RemoveEntryList (&Item->Link); + gBS->FreePool (Item); + } + + ASSERT (IsListEmpty (&Map->Recycled)); +} + + +/** + Test whether the netmap is empty and return true if it is. + + If the number of the pairs in the netmap is zero, return TRUE. + + If Map is NULL, then ASSERT(). + + @param[in] Map The net map to test. + + @return TRUE if the netmap is empty, otherwise FALSE. + +**/ +BOOLEAN +EFIAPI +NetMapIsEmpty ( + IN NET_MAP *Map + ) +{ + ASSERT (Map != NULL); + return (BOOLEAN) (Map->Count == 0); +} + + +/** + Return the number of the pairs in the netmap. + + If Map is NULL, then ASSERT(). + + @param[in] Map The netmap to get the entry number. + + @return The entry number in the netmap. + +**/ +UINTN +EFIAPI +NetMapGetCount ( + IN NET_MAP *Map + ) +{ + ASSERT (Map != NULL); + return Map->Count; +} + + +/** + Return one allocated item. + + If the Recycled doubly linked list of the netmap is empty, it will try to allocate + a batch of items if there are enough resources and add corresponding nodes to the begining + of the Recycled doubly linked list of the netmap. Otherwise, it will directly remove + the fist node entry of the Recycled doubly linked list and return the corresponding item. + + If Map is NULL, then ASSERT(). + + @param[in, out] Map The netmap to allocate item for. + + @return The allocated item. If NULL, the + allocation failed due to resource limit. + +**/ +NET_MAP_ITEM * +NetMapAllocItem ( + IN OUT NET_MAP *Map + ) +{ + NET_MAP_ITEM *Item; + LIST_ENTRY *Head; + UINTN Index; + + ASSERT (Map != NULL); + + Head = &Map->Recycled; + + if (IsListEmpty (Head)) { + for (Index = 0; Index < NET_MAP_INCREAMENT; Index++) { + Item = AllocatePool (sizeof (NET_MAP_ITEM)); + + if (Item == NULL) { + if (Index == 0) { + return NULL; + } + + break; + } + + InsertHeadList (Head, &Item->Link); + } + } + + Item = NET_LIST_HEAD (Head, NET_MAP_ITEM, Link); + NetListRemoveHead (Head); + + return Item; +} + + +/** + Allocate an item to save the pair to the head of the netmap. + + Allocate an item to save the pair and add corresponding node entry + to the beginning of the Used doubly linked list. The number of the + pairs in the netmap increase by 1. + + If Map is NULL, then ASSERT(). + If Key is NULL, then ASSERT(). + + @param[in, out] Map The netmap to insert into. + @param[in] Key The user's key. + @param[in] Value The user's value for the key. + + @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item. + @retval EFI_SUCCESS The item is inserted to the head. + +**/ +EFI_STATUS +EFIAPI +NetMapInsertHead ( + IN OUT NET_MAP *Map, + IN VOID *Key, + IN VOID *Value OPTIONAL + ) +{ + NET_MAP_ITEM *Item; + + ASSERT (Map != NULL && Key != NULL); + + Item = NetMapAllocItem (Map); + + if (Item == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + Item->Key = Key; + Item->Value = Value; + InsertHeadList (&Map->Used, &Item->Link); + + Map->Count++; + return EFI_SUCCESS; +} + + +/** + Allocate an item to save the pair to the tail of the netmap. + + Allocate an item to save the pair and add corresponding node entry + to the tail of the Used doubly linked list. The number of the + pairs in the netmap increase by 1. + + If Map is NULL, then ASSERT(). + If Key is NULL, then ASSERT(). + + @param[in, out] Map The netmap to insert into. + @param[in] Key The user's key. + @param[in] Value The user's value for the key. + + @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item. + @retval EFI_SUCCESS The item is inserted to the tail. + +**/ +EFI_STATUS +EFIAPI +NetMapInsertTail ( + IN OUT NET_MAP *Map, + IN VOID *Key, + IN VOID *Value OPTIONAL + ) +{ + NET_MAP_ITEM *Item; + + ASSERT (Map != NULL && Key != NULL); + + Item = NetMapAllocItem (Map); + + if (Item == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + Item->Key = Key; + Item->Value = Value; + InsertTailList (&Map->Used, &Item->Link); + + Map->Count++; + + return EFI_SUCCESS; +} + + +/** + Check whether the item is in the Map and return TRUE if it is. + + If Map is NULL, then ASSERT(). + If Item is NULL, then ASSERT(). + + @param[in] Map The netmap to search within. + @param[in] Item The item to search. + + @return TRUE if the item is in the netmap, otherwise FALSE. + +**/ +BOOLEAN +NetItemInMap ( + IN NET_MAP *Map, + IN NET_MAP_ITEM *Item + ) +{ + LIST_ENTRY *ListEntry; + + ASSERT (Map != NULL && Item != NULL); + + NET_LIST_FOR_EACH (ListEntry, &Map->Used) { + if (ListEntry == &Item->Link) { + return TRUE; + } + } + + return FALSE; +} + + +/** + Find the key in the netmap and returns the point to the item contains the Key. + + Iterate the Used doubly linked list of the netmap to get every item. Compare the key of every + item with the key to search. It returns the point to the item contains the Key if found. + + If Map is NULL, then ASSERT(). + If Key is NULL, then ASSERT(). + + @param[in] Map The netmap to search within. + @param[in] Key The key to search. + + @return The point to the item contains the Key, or NULL if Key isn't in the map. + +**/ +NET_MAP_ITEM * +EFIAPI +NetMapFindKey ( + IN NET_MAP *Map, + IN VOID *Key + ) +{ + LIST_ENTRY *Entry; + NET_MAP_ITEM *Item; + + ASSERT (Map != NULL && Key != NULL); + + NET_LIST_FOR_EACH (Entry, &Map->Used) { + Item = NET_LIST_USER_STRUCT (Entry, NET_MAP_ITEM, Link); + + if (Item->Key == Key) { + return Item; + } + } + + return NULL; +} + + +/** + Remove the node entry of the item from the netmap and return the key of the removed item. + + Remove the node entry of the item from the Used doubly linked list of the netmap. + The number of the pairs in the netmap decrease by 1. Then add the node + entry of the item to the Recycled doubly linked list of the netmap. If Value is not NULL, + Value will point to the value of the item. It returns the key of the removed item. + + If Map is NULL, then ASSERT(). + If Item is NULL, then ASSERT(). + if item in not in the netmap, then ASSERT(). + + @param[in, out] Map The netmap to remove the item from. + @param[in, out] Item The item to remove. + @param[out] Value The variable to receive the value if not NULL. + + @return The key of the removed item. + +**/ +VOID * +EFIAPI +NetMapRemoveItem ( + IN OUT NET_MAP *Map, + IN OUT NET_MAP_ITEM *Item, + OUT VOID **Value OPTIONAL + ) +{ + ASSERT ((Map != NULL) && (Item != NULL)); + ASSERT (NetItemInMap (Map, Item)); + + RemoveEntryList (&Item->Link); + Map->Count--; + InsertHeadList (&Map->Recycled, &Item->Link); + + if (Value != NULL) { + *Value = Item->Value; + } + + return Item->Key; +} + + +/** + Remove the first node entry on the netmap and return the key of the removed item. + + Remove the first node entry from the Used doubly linked list of the netmap. + The number of the pairs in the netmap decrease by 1. Then add the node + entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL, + parameter Value will point to the value of the item. It returns the key of the removed item. + + If Map is NULL, then ASSERT(). + If the Used doubly linked list is empty, then ASSERT(). + + @param[in, out] Map The netmap to remove the head from. + @param[out] Value The variable to receive the value if not NULL. + + @return The key of the item removed. + +**/ +VOID * +EFIAPI +NetMapRemoveHead ( + IN OUT NET_MAP *Map, + OUT VOID **Value OPTIONAL + ) +{ + NET_MAP_ITEM *Item; + + // + // Often, it indicates a programming error to remove + // the first entry in an empty list + // + ASSERT (Map && !IsListEmpty (&Map->Used)); + + Item = NET_LIST_HEAD (&Map->Used, NET_MAP_ITEM, Link); + RemoveEntryList (&Item->Link); + Map->Count--; + InsertHeadList (&Map->Recycled, &Item->Link); + + if (Value != NULL) { + *Value = Item->Value; + } + + return Item->Key; +} + + +/** + Remove the last node entry on the netmap and return the key of the removed item. + + Remove the last node entry from the Used doubly linked list of the netmap. + The number of the pairs in the netmap decrease by 1. Then add the node + entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL, + parameter Value will point to the value of the item. It returns the key of the removed item. + + If Map is NULL, then ASSERT(). + If the Used doubly linked list is empty, then ASSERT(). + + @param[in, out] Map The netmap to remove the tail from. + @param[out] Value The variable to receive the value if not NULL. + + @return The key of the item removed. + +**/ +VOID * +EFIAPI +NetMapRemoveTail ( + IN OUT NET_MAP *Map, + OUT VOID **Value OPTIONAL + ) +{ + NET_MAP_ITEM *Item; + + // + // Often, it indicates a programming error to remove + // the last entry in an empty list + // + ASSERT (Map && !IsListEmpty (&Map->Used)); + + Item = NET_LIST_TAIL (&Map->Used, NET_MAP_ITEM, Link); + RemoveEntryList (&Item->Link); + Map->Count--; + InsertHeadList (&Map->Recycled, &Item->Link); + + if (Value != NULL) { + *Value = Item->Value; + } + + return Item->Key; +} + + +/** + Iterate through the netmap and call CallBack for each item. + + It will continue the traverse if CallBack returns EFI_SUCCESS, otherwise, break + from the loop. It returns the CallBack's last return value. This function is + delete safe for the current item. + + If Map is NULL, then ASSERT(). + If CallBack is NULL, then ASSERT(). + + @param[in] Map The Map to iterate through. + @param[in] CallBack The callback function to call for each item. + @param[in] Arg The opaque parameter to the callback. + + @retval EFI_SUCCESS There is no item in the netmap or CallBack for each item + return EFI_SUCCESS. + @retval Others It returns the CallBack's last return value. + +**/ +EFI_STATUS +EFIAPI +NetMapIterate ( + IN NET_MAP *Map, + IN NET_MAP_CALLBACK CallBack, + IN VOID *Arg OPTIONAL + ) +{ + + LIST_ENTRY *Entry; + LIST_ENTRY *Next; + LIST_ENTRY *Head; + NET_MAP_ITEM *Item; + EFI_STATUS Result; + + ASSERT ((Map != NULL) && (CallBack != NULL)); + + Head = &Map->Used; + + if (IsListEmpty (Head)) { + return EFI_SUCCESS; + } + + NET_LIST_FOR_EACH_SAFE (Entry, Next, Head) { + Item = NET_LIST_USER_STRUCT (Entry, NET_MAP_ITEM, Link); + Result = CallBack (Map, Item, Arg); + + if (EFI_ERROR (Result)) { + return Result; + } + } + + return EFI_SUCCESS; +} + + +/** + This is the default unload handle for all the network drivers. + + Disconnect the driver specified by ImageHandle from all the devices in the handle database. + Uninstall all the protocols installed in the driver entry point. + + @param[in] ImageHandle The drivers' driver image. + + @retval EFI_SUCCESS The image is unloaded. + @retval Others Failed to unload the image. + +**/ +EFI_STATUS +EFIAPI +NetLibDefaultUnload ( + IN EFI_HANDLE ImageHandle + ) +{ + EFI_STATUS Status; + EFI_HANDLE *DeviceHandleBuffer; + UINTN DeviceHandleCount; + UINTN Index; + UINTN Index2; + EFI_DRIVER_BINDING_PROTOCOL *DriverBinding; + EFI_COMPONENT_NAME_PROTOCOL *ComponentName; + EFI_COMPONENT_NAME2_PROTOCOL *ComponentName2; + + // + // Get the list of all the handles in the handle database. + // If there is an error getting the list, then the unload + // operation fails. + // + Status = gBS->LocateHandleBuffer ( + AllHandles, + NULL, + NULL, + &DeviceHandleCount, + &DeviceHandleBuffer + ); + + if (EFI_ERROR (Status)) { + return Status; + } + + for (Index = 0; Index < DeviceHandleCount; Index++) { + Status = gBS->HandleProtocol ( + DeviceHandleBuffer[Index], + &gEfiDriverBindingProtocolGuid, + (VOID **) &DriverBinding + ); + if (EFI_ERROR (Status)) { + continue; + } + + if (DriverBinding->ImageHandle != ImageHandle) { + continue; + } + + // + // Disconnect the driver specified by ImageHandle from all + // the devices in the handle database. + // + for (Index2 = 0; Index2 < DeviceHandleCount; Index2++) { + Status = gBS->DisconnectController ( + DeviceHandleBuffer[Index2], + DriverBinding->DriverBindingHandle, + NULL + ); + } + + // + // Uninstall all the protocols installed in the driver entry point + // + gBS->UninstallProtocolInterface ( + DriverBinding->DriverBindingHandle, + &gEfiDriverBindingProtocolGuid, + DriverBinding + ); + + Status = gBS->HandleProtocol ( + DeviceHandleBuffer[Index], + &gEfiComponentNameProtocolGuid, + (VOID **) &ComponentName + ); + if (!EFI_ERROR (Status)) { + gBS->UninstallProtocolInterface ( + DriverBinding->DriverBindingHandle, + &gEfiComponentNameProtocolGuid, + ComponentName + ); + } + + Status = gBS->HandleProtocol ( + DeviceHandleBuffer[Index], + &gEfiComponentName2ProtocolGuid, + (VOID **) &ComponentName2 + ); + if (!EFI_ERROR (Status)) { + gBS->UninstallProtocolInterface ( + DriverBinding->DriverBindingHandle, + &gEfiComponentName2ProtocolGuid, + ComponentName2 + ); + } + } + + // + // Free the buffer containing the list of handles from the handle database + // + if (DeviceHandleBuffer != NULL) { + gBS->FreePool (DeviceHandleBuffer); + } + + return EFI_SUCCESS; +} + + + +/** + Create a child of the service that is identified by ServiceBindingGuid. + + Get the ServiceBinding Protocol first, then use it to create a child. + + If ServiceBindingGuid is NULL, then ASSERT(). + If ChildHandle is NULL, then ASSERT(). + + @param[in] Controller The controller which has the service installed. + @param[in] Image The image handle used to open service. + @param[in] ServiceBindingGuid The service's Guid. + @param[in, out] ChildHandle The handle to receive the create child. + + @retval EFI_SUCCESS The child is successfully created. + @retval Others Failed to create the child. + +**/ +EFI_STATUS +EFIAPI +NetLibCreateServiceChild ( + IN EFI_HANDLE Controller, + IN EFI_HANDLE Image, + IN EFI_GUID *ServiceBindingGuid, + IN OUT EFI_HANDLE *ChildHandle + ) +{ + EFI_STATUS Status; + EFI_SERVICE_BINDING_PROTOCOL *Service; + + + ASSERT ((ServiceBindingGuid != NULL) && (ChildHandle != NULL)); + + // + // Get the ServiceBinding Protocol + // + Status = gBS->OpenProtocol ( + Controller, + ServiceBindingGuid, + (VOID **) &Service, + Image, + Controller, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Create a child + // + Status = Service->CreateChild (Service, ChildHandle); + return Status; +} + + +/** + Destroy a child of the service that is identified by ServiceBindingGuid. + + Get the ServiceBinding Protocol first, then use it to destroy a child. + + If ServiceBindingGuid is NULL, then ASSERT(). + + @param[in] Controller The controller which has the service installed. + @param[in] Image The image handle used to open service. + @param[in] ServiceBindingGuid The service's Guid. + @param[in] ChildHandle The child to destroy. + + @retval EFI_SUCCESS The child is successfully destroyed. + @retval Others Failed to destroy the child. + +**/ +EFI_STATUS +EFIAPI +NetLibDestroyServiceChild ( + IN EFI_HANDLE Controller, + IN EFI_HANDLE Image, + IN EFI_GUID *ServiceBindingGuid, + IN EFI_HANDLE ChildHandle + ) +{ + EFI_STATUS Status; + EFI_SERVICE_BINDING_PROTOCOL *Service; + + ASSERT (ServiceBindingGuid != NULL); + + // + // Get the ServiceBinding Protocol + // + Status = gBS->OpenProtocol ( + Controller, + ServiceBindingGuid, + (VOID **) &Service, + Image, + Controller, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + + if (EFI_ERROR (Status)) { + return Status; + } + + // + // destroy the child + // + Status = Service->DestroyChild (Service, ChildHandle); + return Status; +} + +/** + Get handle with Simple Network Protocol installed on it. + + There should be MNP Service Binding Protocol installed on the input ServiceHandle. + If Simple Network Protocol is already installed on the ServiceHandle, the + ServiceHandle will be returned. If SNP is not installed on the ServiceHandle, + try to find its parent handle with SNP installed. + + @param[in] ServiceHandle The handle where network service binding protocols are + installed on. + @param[out] Snp The pointer to store the address of the SNP instance. + This is an optional parameter that may be NULL. + + @return The SNP handle, or NULL if not found. + +**/ +EFI_HANDLE +EFIAPI +NetLibGetSnpHandle ( + IN EFI_HANDLE ServiceHandle, + OUT EFI_SIMPLE_NETWORK_PROTOCOL **Snp OPTIONAL + ) +{ + EFI_STATUS Status; + EFI_SIMPLE_NETWORK_PROTOCOL *SnpInstance; + EFI_DEVICE_PATH_PROTOCOL *DevicePath; + EFI_HANDLE SnpHandle; + + // + // Try to open SNP from ServiceHandle + // + SnpInstance = NULL; + Status = gBS->HandleProtocol (ServiceHandle, &gEfiSimpleNetworkProtocolGuid, (VOID **) &SnpInstance); + if (!EFI_ERROR (Status)) { + if (Snp != NULL) { + *Snp = SnpInstance; + } + return ServiceHandle; + } + + // + // Failed to open SNP, try to get SNP handle by LocateDevicePath() + // + DevicePath = DevicePathFromHandle (ServiceHandle); + if (DevicePath == NULL) { + return NULL; + } + + SnpHandle = NULL; + Status = gBS->LocateDevicePath (&gEfiSimpleNetworkProtocolGuid, &DevicePath, &SnpHandle); + if (EFI_ERROR (Status)) { + // + // Failed to find SNP handle + // + return NULL; + } + + Status = gBS->HandleProtocol (SnpHandle, &gEfiSimpleNetworkProtocolGuid, (VOID **) &SnpInstance); + if (!EFI_ERROR (Status)) { + if (Snp != NULL) { + *Snp = SnpInstance; + } + return SnpHandle; + } + + return NULL; +} + +/** + Retrieve VLAN ID of a VLAN device handle. + + Search VLAN device path node in Device Path of specified ServiceHandle and + return its VLAN ID. If no VLAN device path node found, then this ServiceHandle + is not a VLAN device handle, and 0 will be returned. + + @param[in] ServiceHandle The handle where network service binding protocols are + installed on. + + @return VLAN ID of the device handle, or 0 if not a VLAN device. + +**/ +UINT16 +EFIAPI +NetLibGetVlanId ( + IN EFI_HANDLE ServiceHandle + ) +{ + EFI_DEVICE_PATH_PROTOCOL *DevicePath; + EFI_DEVICE_PATH_PROTOCOL *Node; + + DevicePath = DevicePathFromHandle (ServiceHandle); + if (DevicePath == NULL) { + return 0; + } + + Node = DevicePath; + while (!IsDevicePathEnd (Node)) { + if (Node->Type == MESSAGING_DEVICE_PATH && Node->SubType == MSG_VLAN_DP) { + return ((VLAN_DEVICE_PATH *) Node)->VlanId; + } + Node = NextDevicePathNode (Node); + } + + return 0; +} + +/** + Find VLAN device handle with specified VLAN ID. + + The VLAN child device handle is created by VLAN Config Protocol on ControllerHandle. + This function will append VLAN device path node to the parent device path, + and then use LocateDevicePath() to find the correct VLAN device handle. + + @param[in] ControllerHandle The handle where network service binding protocols are + installed on. + @param[in] VlanId The configured VLAN ID for the VLAN device. + + @return The VLAN device handle, or NULL if not found. + +**/ +EFI_HANDLE +EFIAPI +NetLibGetVlanHandle ( + IN EFI_HANDLE ControllerHandle, + IN UINT16 VlanId + ) +{ + EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath; + EFI_DEVICE_PATH_PROTOCOL *VlanDevicePath; + EFI_DEVICE_PATH_PROTOCOL *DevicePath; + VLAN_DEVICE_PATH VlanNode; + EFI_HANDLE Handle; + + ParentDevicePath = DevicePathFromHandle (ControllerHandle); + if (ParentDevicePath == NULL) { + return NULL; + } + + // + // Construct VLAN device path + // + CopyMem (&VlanNode, &mNetVlanDevicePathTemplate, sizeof (VLAN_DEVICE_PATH)); + VlanNode.VlanId = VlanId; + VlanDevicePath = AppendDevicePathNode ( + ParentDevicePath, + (EFI_DEVICE_PATH_PROTOCOL *) &VlanNode + ); + if (VlanDevicePath == NULL) { + return NULL; + } + + // + // Find VLAN device handle + // + Handle = NULL; + DevicePath = VlanDevicePath; + gBS->LocateDevicePath ( + &gEfiDevicePathProtocolGuid, + &DevicePath, + &Handle + ); + if (!IsDevicePathEnd (DevicePath)) { + // + // Device path is not exactly match + // + Handle = NULL; + } + + FreePool (VlanDevicePath); + return Handle; +} + +/** + Get MAC address associated with the network service handle. + + If MacAddress is NULL, then ASSERT(). + If AddressSize is NULL, then ASSERT(). + + There should be MNP Service Binding Protocol installed on the input ServiceHandle. + If SNP is installed on the ServiceHandle or its parent handle, MAC address will + be retrieved from SNP. If no SNP found, try to get SNP mode data use MNP. + + @param[in] ServiceHandle The handle where network service binding protocols are + installed on. + @param[out] MacAddress The pointer to store the returned MAC address. + @param[out] AddressSize The length of returned MAC address. + + @retval EFI_SUCCESS MAC address is returned successfully. + @retval Others Failed to get SNP mode data. + +**/ +EFI_STATUS +EFIAPI +NetLibGetMacAddress ( + IN EFI_HANDLE ServiceHandle, + OUT EFI_MAC_ADDRESS *MacAddress, + OUT UINTN *AddressSize + ) +{ + EFI_STATUS Status; + EFI_SIMPLE_NETWORK_PROTOCOL *Snp; + EFI_SIMPLE_NETWORK_MODE *SnpMode; + EFI_SIMPLE_NETWORK_MODE SnpModeData; + EFI_MANAGED_NETWORK_PROTOCOL *Mnp; + EFI_SERVICE_BINDING_PROTOCOL *MnpSb; + EFI_HANDLE *SnpHandle; + EFI_HANDLE MnpChildHandle; + + ASSERT (MacAddress != NULL); + ASSERT (AddressSize != NULL); + + // + // Try to get SNP handle + // + Snp = NULL; + SnpHandle = NetLibGetSnpHandle (ServiceHandle, &Snp); + if (SnpHandle != NULL) { + // + // SNP found, use it directly + // + SnpMode = Snp->Mode; + } else { + // + // Failed to get SNP handle, try to get MAC address from MNP + // + MnpChildHandle = NULL; + Status = gBS->HandleProtocol ( + ServiceHandle, + &gEfiManagedNetworkServiceBindingProtocolGuid, + (VOID **) &MnpSb + ); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Create a MNP child + // + Status = MnpSb->CreateChild (MnpSb, &MnpChildHandle); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Open MNP protocol + // + Status = gBS->HandleProtocol ( + MnpChildHandle, + &gEfiManagedNetworkProtocolGuid, + (VOID **) &Mnp + ); + if (EFI_ERROR (Status)) { + MnpSb->DestroyChild (MnpSb, MnpChildHandle); + return Status; + } + + // + // Try to get SNP mode from MNP + // + Status = Mnp->GetModeData (Mnp, NULL, &SnpModeData); + if (EFI_ERROR (Status) && (Status != EFI_NOT_STARTED)) { + MnpSb->DestroyChild (MnpSb, MnpChildHandle); + return Status; + } + SnpMode = &SnpModeData; + + // + // Destroy the MNP child + // + MnpSb->DestroyChild (MnpSb, MnpChildHandle); + } + + *AddressSize = SnpMode->HwAddressSize; + CopyMem (MacAddress->Addr, SnpMode->CurrentAddress.Addr, SnpMode->HwAddressSize); + + return EFI_SUCCESS; +} + +/** + Convert MAC address of the NIC associated with specified Service Binding Handle + to a unicode string. Callers are responsible for freeing the string storage. + + If MacString is NULL, then ASSERT(). + + Locate simple network protocol associated with the Service Binding Handle and + get the mac address from SNP. Then convert the mac address into a unicode + string. It takes 2 unicode characters to represent a 1 byte binary buffer. + Plus one unicode character for the null-terminator. + + @param[in] ServiceHandle The handle where network service binding protocol is + installed on. + @param[in] ImageHandle The image handle used to act as the agent handle to + get the simple network protocol. This parameter is + optional and may be NULL. + @param[out] MacString The pointer to store the address of the string + representation of the mac address. + + @retval EFI_SUCCESS Convert the mac address a unicode string successfully. + @retval EFI_OUT_OF_RESOURCES There are not enough memory resource. + @retval Others Failed to open the simple network protocol. + +**/ +EFI_STATUS +EFIAPI +NetLibGetMacString ( + IN EFI_HANDLE ServiceHandle, + IN EFI_HANDLE ImageHandle, OPTIONAL + OUT CHAR16 **MacString + ) +{ + EFI_STATUS Status; + EFI_MAC_ADDRESS MacAddress; + UINT8 *HwAddress; + UINTN HwAddressSize; + UINT16 VlanId; + CHAR16 *String; + UINTN Index; + UINTN BufferSize; + + ASSERT (MacString != NULL); + + // + // Get MAC address of the network device + // + Status = NetLibGetMacAddress (ServiceHandle, &MacAddress, &HwAddressSize); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // It takes 2 unicode characters to represent a 1 byte binary buffer. + // If VLAN is configured, it will need extra 5 characters like "\0005". + // Plus one unicode character for the null-terminator. + // + BufferSize = (2 * HwAddressSize + 5 + 1) * sizeof (CHAR16); + String = AllocateZeroPool (BufferSize); + if (String == NULL) { + return EFI_OUT_OF_RESOURCES; + } + *MacString = String; + + // + // Convert the MAC address into a unicode string. + // + HwAddress = &MacAddress.Addr[0]; + for (Index = 0; Index < HwAddressSize; Index++) { + UnicodeValueToStringS ( + String, + BufferSize - ((UINTN)String - (UINTN)*MacString), + PREFIX_ZERO | RADIX_HEX, + *(HwAddress++), + 2 + ); + String += StrnLenS (String, (BufferSize - ((UINTN)String - (UINTN)*MacString)) / sizeof (CHAR16)); + } + + // + // Append VLAN ID if any + // + VlanId = NetLibGetVlanId (ServiceHandle); + if (VlanId != 0) { + *String++ = L'\\'; + UnicodeValueToStringS ( + String, + BufferSize - ((UINTN)String - (UINTN)*MacString), + PREFIX_ZERO | RADIX_HEX, + VlanId, + 4 + ); + String += StrnLenS (String, (BufferSize - ((UINTN)String - (UINTN)*MacString)) / sizeof (CHAR16)); + } + + // + // Null terminate the Unicode string + // + *String = L'\0'; + + return EFI_SUCCESS; +} + +/** + Detect media status for specified network device. + + If MediaPresent is NULL, then ASSERT(). + + The underlying UNDI driver may or may not support reporting media status from + GET_STATUS command (PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED). This routine + will try to invoke Snp->GetStatus() to get the media status: if media already + present, it return directly; if media not present, it will stop SNP and then + restart SNP to get the latest media status, this give chance to get the correct + media status for old UNDI driver which doesn't support reporting media status + from GET_STATUS command. + Note: there will be two limitations for current algorithm: + 1) for UNDI with this capability, in case of cable is not attached, there will + be an redundant Stop/Start() process; + 2) for UNDI without this capability, in case that network cable is attached when + Snp->Initialize() is invoked while network cable is unattached later, + NetLibDetectMedia() will report MediaPresent as TRUE, causing upper layer + apps to wait for timeout time. + + @param[in] ServiceHandle The handle where network service binding protocols are + installed on. + @param[out] MediaPresent The pointer to store the media status. + + @retval EFI_SUCCESS Media detection success. + @retval EFI_INVALID_PARAMETER ServiceHandle is not valid network device handle. + @retval EFI_UNSUPPORTED Network device does not support media detection. + @retval EFI_DEVICE_ERROR SNP is in unknown state. + +**/ +EFI_STATUS +EFIAPI +NetLibDetectMedia ( + IN EFI_HANDLE ServiceHandle, + OUT BOOLEAN *MediaPresent + ) +{ + EFI_STATUS Status; + EFI_HANDLE SnpHandle; + EFI_SIMPLE_NETWORK_PROTOCOL *Snp; + UINT32 InterruptStatus; + UINT32 OldState; + EFI_MAC_ADDRESS *MCastFilter; + UINT32 MCastFilterCount; + UINT32 EnableFilterBits; + UINT32 DisableFilterBits; + BOOLEAN ResetMCastFilters; + + ASSERT (MediaPresent != NULL); + + // + // Get SNP handle + // + Snp = NULL; + SnpHandle = NetLibGetSnpHandle (ServiceHandle, &Snp); + if (SnpHandle == NULL) { + return EFI_INVALID_PARAMETER; + } + + // + // Check whether SNP support media detection + // + if (!Snp->Mode->MediaPresentSupported) { + return EFI_UNSUPPORTED; + } + + // + // Invoke Snp->GetStatus() to refresh MediaPresent field in SNP mode data + // + Status = Snp->GetStatus (Snp, &InterruptStatus, NULL); + if (EFI_ERROR (Status)) { + return Status; + } + + if (Snp->Mode->MediaPresent) { + // + // Media is present, return directly + // + *MediaPresent = TRUE; + return EFI_SUCCESS; + } + + // + // Till now, GetStatus() report no media; while, in case UNDI not support + // reporting media status from GetStatus(), this media status may be incorrect. + // So, we will stop SNP and then restart it to get the correct media status. + // + OldState = Snp->Mode->State; + if (OldState >= EfiSimpleNetworkMaxState) { + return EFI_DEVICE_ERROR; + } + + MCastFilter = NULL; + + if (OldState == EfiSimpleNetworkInitialized) { + // + // SNP is already in use, need Shutdown/Stop and then Start/Initialize + // + + // + // Backup current SNP receive filter settings + // + EnableFilterBits = Snp->Mode->ReceiveFilterSetting; + DisableFilterBits = Snp->Mode->ReceiveFilterMask ^ EnableFilterBits; + + ResetMCastFilters = TRUE; + MCastFilterCount = Snp->Mode->MCastFilterCount; + if (MCastFilterCount != 0) { + MCastFilter = AllocateCopyPool ( + MCastFilterCount * sizeof (EFI_MAC_ADDRESS), + Snp->Mode->MCastFilter + ); + ASSERT (MCastFilter != NULL); + if (MCastFilter == NULL) { + Status = EFI_OUT_OF_RESOURCES; + goto Exit; + } + + ResetMCastFilters = FALSE; + } + + // + // Shutdown/Stop the simple network + // + Status = Snp->Shutdown (Snp); + if (!EFI_ERROR (Status)) { + Status = Snp->Stop (Snp); + } + if (EFI_ERROR (Status)) { + goto Exit; + } + + // + // Start/Initialize the simple network + // + Status = Snp->Start (Snp); + if (!EFI_ERROR (Status)) { + Status = Snp->Initialize (Snp, 0, 0); + } + if (EFI_ERROR (Status)) { + goto Exit; + } + + // + // Here we get the correct media status + // + *MediaPresent = Snp->Mode->MediaPresent; + + // + // Restore SNP receive filter settings + // + Status = Snp->ReceiveFilters ( + Snp, + EnableFilterBits, + DisableFilterBits, + ResetMCastFilters, + MCastFilterCount, + MCastFilter + ); + + if (MCastFilter != NULL) { + FreePool (MCastFilter); + } + + return Status; + } + + // + // SNP is not in use, it's in state of EfiSimpleNetworkStopped or EfiSimpleNetworkStarted + // + if (OldState == EfiSimpleNetworkStopped) { + // + // SNP not start yet, start it + // + Status = Snp->Start (Snp); + if (EFI_ERROR (Status)) { + goto Exit; + } + } + + // + // Initialize the simple network + // + Status = Snp->Initialize (Snp, 0, 0); + if (EFI_ERROR (Status)) { + Status = EFI_DEVICE_ERROR; + goto Exit; + } + + // + // Here we get the correct media status + // + *MediaPresent = Snp->Mode->MediaPresent; + + // + // Shut down the simple network + // + Snp->Shutdown (Snp); + +Exit: + if (OldState == EfiSimpleNetworkStopped) { + // + // Original SNP sate is Stopped, restore to original state + // + Snp->Stop (Snp); + } + + if (MCastFilter != NULL) { + FreePool (MCastFilter); + } + + return Status; +} + +/** + + Detect media state for a network device. This routine will wait for a period of time at + a specified checking interval when a certain network is under connecting until connection + process finishs or timeout. If Aip protocol is supported by low layer drivers, three kinds + of media states can be detected: EFI_SUCCESS, EFI_NOT_READY and EFI_NO_MEDIA, represents + connected state, connecting state and no media state respectively. When function detects + the current state is EFI_NOT_READY, it will loop to wait for next time's check until state + turns to be EFI_SUCCESS or EFI_NO_MEDIA. If Aip protocol is not supported, function will + call NetLibDetectMedia() and return state directly. + + @param[in] ServiceHandle The handle where network service binding protocols are + installed on. + @param[in] Timeout The maximum number of 100ns units to wait when network + is connecting. Zero value means detect once and return + immediately. + @param[out] MediaState The pointer to the detected media state. + + @retval EFI_SUCCESS Media detection success. + @retval EFI_INVALID_PARAMETER ServiceHandle is not a valid network device handle or + MediaState pointer is NULL. + @retval EFI_DEVICE_ERROR A device error occurred. + @retval EFI_TIMEOUT Network is connecting but timeout. + +**/ +EFI_STATUS +EFIAPI +NetLibDetectMediaWaitTimeout ( + IN EFI_HANDLE ServiceHandle, + IN UINT64 Timeout, + OUT EFI_STATUS *MediaState + ) +{ + EFI_STATUS Status; + EFI_HANDLE SnpHandle; + EFI_SIMPLE_NETWORK_PROTOCOL *Snp; + EFI_ADAPTER_INFORMATION_PROTOCOL *Aip; + EFI_ADAPTER_INFO_MEDIA_STATE *MediaInfo; + BOOLEAN MediaPresent; + UINTN DataSize; + EFI_STATUS TimerStatus; + EFI_EVENT Timer; + UINT64 TimeRemained; + + if (MediaState == NULL) { + return EFI_INVALID_PARAMETER; + } + *MediaState = EFI_SUCCESS; + MediaInfo = NULL; + + // + // Get SNP handle + // + Snp = NULL; + SnpHandle = NetLibGetSnpHandle (ServiceHandle, &Snp); + if (SnpHandle == NULL) { + return EFI_INVALID_PARAMETER; + } + + Status = gBS->HandleProtocol ( + SnpHandle, + &gEfiAdapterInformationProtocolGuid, + (VOID *) &Aip + ); + if (EFI_ERROR (Status)) { + + MediaPresent = TRUE; + Status = NetLibDetectMedia (ServiceHandle, &MediaPresent); + if (!EFI_ERROR (Status)) { + if (MediaPresent) { + *MediaState = EFI_SUCCESS; + } else { + *MediaState = EFI_NO_MEDIA; + } + } + + // + // NetLibDetectMedia doesn't support EFI_NOT_READY status, return now! + // + return Status; + } + + Status = Aip->GetInformation ( + Aip, + &gEfiAdapterInfoMediaStateGuid, + (VOID **) &MediaInfo, + &DataSize + ); + if (!EFI_ERROR (Status)) { + + *MediaState = MediaInfo->MediaState; + FreePool (MediaInfo); + if (*MediaState != EFI_NOT_READY || Timeout < MEDIA_STATE_DETECT_TIME_INTERVAL) { + + return EFI_SUCCESS; + } + } else { + + if (MediaInfo != NULL) { + FreePool (MediaInfo); + } + + if (Status == EFI_UNSUPPORTED) { + + // + // If gEfiAdapterInfoMediaStateGuid is not supported, call NetLibDetectMedia to get media state! + // + MediaPresent = TRUE; + Status = NetLibDetectMedia (ServiceHandle, &MediaPresent); + if (!EFI_ERROR (Status)) { + if (MediaPresent) { + *MediaState = EFI_SUCCESS; + } else { + *MediaState = EFI_NO_MEDIA; + } + } + return Status; + } + + return Status; + } + + // + // Loop to check media state + // + + Timer = NULL; + TimeRemained = Timeout; + Status = gBS->CreateEvent (EVT_TIMER, TPL_CALLBACK, NULL, NULL, &Timer); + if (EFI_ERROR (Status)) { + return EFI_DEVICE_ERROR; + } + + do { + Status = gBS->SetTimer ( + Timer, + TimerRelative, + MEDIA_STATE_DETECT_TIME_INTERVAL + ); + if (EFI_ERROR (Status)) { + gBS->CloseEvent(Timer); + return EFI_DEVICE_ERROR; + } + + do { + TimerStatus = gBS->CheckEvent (Timer); + if (!EFI_ERROR (TimerStatus)) { + + TimeRemained -= MEDIA_STATE_DETECT_TIME_INTERVAL; + Status = Aip->GetInformation ( + Aip, + &gEfiAdapterInfoMediaStateGuid, + (VOID **) &MediaInfo, + &DataSize + ); + if (!EFI_ERROR (Status)) { + + *MediaState = MediaInfo->MediaState; + FreePool (MediaInfo); + } else { + + if (MediaInfo != NULL) { + FreePool (MediaInfo); + } + gBS->CloseEvent(Timer); + return Status; + } + } + } while (TimerStatus == EFI_NOT_READY); + } while (*MediaState == EFI_NOT_READY && TimeRemained >= MEDIA_STATE_DETECT_TIME_INTERVAL); + + gBS->CloseEvent(Timer); + if (*MediaState == EFI_NOT_READY && TimeRemained < MEDIA_STATE_DETECT_TIME_INTERVAL) { + return EFI_TIMEOUT; + } else { + return EFI_SUCCESS; + } +} + +/** + Check the default address used by the IPv4 driver is static or dynamic (acquired + from DHCP). + + If the controller handle does not have the EFI_IP4_CONFIG2_PROTOCOL installed, the + default address is static. If failed to get the policy from Ip4 Config2 Protocol, + the default address is static. Otherwise, get the result from Ip4 Config2 Protocol. + + @param[in] Controller The controller handle which has the EFI_IP4_CONFIG2_PROTOCOL + relative with the default address to judge. + + @retval TRUE If the default address is static. + @retval FALSE If the default address is acquired from DHCP. + +**/ +BOOLEAN +NetLibDefaultAddressIsStatic ( + IN EFI_HANDLE Controller + ) +{ + EFI_STATUS Status; + EFI_IP4_CONFIG2_PROTOCOL *Ip4Config2; + UINTN DataSize; + EFI_IP4_CONFIG2_POLICY Policy; + BOOLEAN IsStatic; + + Ip4Config2 = NULL; + + DataSize = sizeof (EFI_IP4_CONFIG2_POLICY); + + IsStatic = TRUE; + + // + // Get Ip4Config2 policy. + // + Status = gBS->HandleProtocol (Controller, &gEfiIp4Config2ProtocolGuid, (VOID **) &Ip4Config2); + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } + + Status = Ip4Config2->GetData (Ip4Config2, Ip4Config2DataTypePolicy, &DataSize, &Policy); + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } + + IsStatic = (BOOLEAN) (Policy == Ip4Config2PolicyStatic); + +ON_EXIT: + + return IsStatic; +} + +/** + Create an IPv4 device path node. + + If Node is NULL, then ASSERT(). + + The header type of IPv4 device path node is MESSAGING_DEVICE_PATH. + The header subtype of IPv4 device path node is MSG_IPv4_DP. + Get other info from parameters to make up the whole IPv4 device path node. + + @param[in, out] Node Pointer to the IPv4 device path node. + @param[in] Controller The controller handle. + @param[in] LocalIp The local IPv4 address. + @param[in] LocalPort The local port. + @param[in] RemoteIp The remote IPv4 address. + @param[in] RemotePort The remote port. + @param[in] Protocol The protocol type in the IP header. + @param[in] UseDefaultAddress Whether this instance is using default address or not. + +**/ +VOID +EFIAPI +NetLibCreateIPv4DPathNode ( + IN OUT IPv4_DEVICE_PATH *Node, + IN EFI_HANDLE Controller, + IN IP4_ADDR LocalIp, + IN UINT16 LocalPort, + IN IP4_ADDR RemoteIp, + IN UINT16 RemotePort, + IN UINT16 Protocol, + IN BOOLEAN UseDefaultAddress + ) +{ + ASSERT (Node != NULL); + + Node->Header.Type = MESSAGING_DEVICE_PATH; + Node->Header.SubType = MSG_IPv4_DP; + SetDevicePathNodeLength (&Node->Header, sizeof (IPv4_DEVICE_PATH)); + + CopyMem (&Node->LocalIpAddress, &LocalIp, sizeof (EFI_IPv4_ADDRESS)); + CopyMem (&Node->RemoteIpAddress, &RemoteIp, sizeof (EFI_IPv4_ADDRESS)); + + Node->LocalPort = LocalPort; + Node->RemotePort = RemotePort; + + Node->Protocol = Protocol; + + if (!UseDefaultAddress) { + Node->StaticIpAddress = TRUE; + } else { + Node->StaticIpAddress = NetLibDefaultAddressIsStatic (Controller); + } + + // + // Set the Gateway IP address to default value 0:0:0:0. + // Set the Subnet mask to default value 255:255:255:0. + // + ZeroMem (&Node->GatewayIpAddress, sizeof (EFI_IPv4_ADDRESS)); + SetMem (&Node->SubnetMask, sizeof (EFI_IPv4_ADDRESS), 0xff); + Node->SubnetMask.Addr[3] = 0; +} + +/** + Create an IPv6 device path node. + + If Node is NULL, then ASSERT(). + If LocalIp is NULL, then ASSERT(). + If RemoteIp is NULL, then ASSERT(). + + The header type of IPv6 device path node is MESSAGING_DEVICE_PATH. + The header subtype of IPv6 device path node is MSG_IPv6_DP. + Get other info from parameters to make up the whole IPv6 device path node. + + @param[in, out] Node Pointer to the IPv6 device path node. + @param[in] Controller The controller handle. + @param[in] LocalIp The local IPv6 address. + @param[in] LocalPort The local port. + @param[in] RemoteIp The remote IPv6 address. + @param[in] RemotePort The remote port. + @param[in] Protocol The protocol type in the IP header. + +**/ +VOID +EFIAPI +NetLibCreateIPv6DPathNode ( + IN OUT IPv6_DEVICE_PATH *Node, + IN EFI_HANDLE Controller, + IN EFI_IPv6_ADDRESS *LocalIp, + IN UINT16 LocalPort, + IN EFI_IPv6_ADDRESS *RemoteIp, + IN UINT16 RemotePort, + IN UINT16 Protocol + ) +{ + ASSERT (Node != NULL && LocalIp != NULL && RemoteIp != NULL); + + Node->Header.Type = MESSAGING_DEVICE_PATH; + Node->Header.SubType = MSG_IPv6_DP; + SetDevicePathNodeLength (&Node->Header, sizeof (IPv6_DEVICE_PATH)); + + CopyMem (&Node->LocalIpAddress, LocalIp, sizeof (EFI_IPv6_ADDRESS)); + CopyMem (&Node->RemoteIpAddress, RemoteIp, sizeof (EFI_IPv6_ADDRESS)); + + Node->LocalPort = LocalPort; + Node->RemotePort = RemotePort; + + Node->Protocol = Protocol; + + // + // Set default value to IPAddressOrigin, PrefixLength. + // Set the Gateway IP address to unspecified address. + // + Node->IpAddressOrigin = 0; + Node->PrefixLength = IP6_PREFIX_LENGTH; + ZeroMem (&Node->GatewayIpAddress, sizeof (EFI_IPv6_ADDRESS)); +} + +/** + Find the UNDI/SNP handle from controller and protocol GUID. + + If ProtocolGuid is NULL, then ASSERT(). + + For example, IP will open a MNP child to transmit/receive + packets, when MNP is stopped, IP should also be stopped. IP + needs to find its own private data which is related the IP's + service binding instance that is install on UNDI/SNP handle. + Now, the controller is either a MNP or ARP child handle. But + IP opens these handle BY_DRIVER, use that info, we can get the + UNDI/SNP handle. + + @param[in] Controller Then protocol handle to check. + @param[in] ProtocolGuid The protocol that is related with the handle. + + @return The UNDI/SNP handle or NULL for errors. + +**/ +EFI_HANDLE +EFIAPI +NetLibGetNicHandle ( + IN EFI_HANDLE Controller, + IN EFI_GUID *ProtocolGuid + ) +{ + EFI_OPEN_PROTOCOL_INFORMATION_ENTRY *OpenBuffer; + EFI_HANDLE Handle; + EFI_STATUS Status; + UINTN OpenCount; + UINTN Index; + + ASSERT (ProtocolGuid != NULL); + + Status = gBS->OpenProtocolInformation ( + Controller, + ProtocolGuid, + &OpenBuffer, + &OpenCount + ); + + if (EFI_ERROR (Status)) { + return NULL; + } + + Handle = NULL; + + for (Index = 0; Index < OpenCount; Index++) { + if ((OpenBuffer[Index].Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) != 0) { + Handle = OpenBuffer[Index].ControllerHandle; + break; + } + } + + gBS->FreePool (OpenBuffer); + return Handle; +} + +/** + Convert one Null-terminated ASCII string (decimal dotted) to EFI_IPv4_ADDRESS. + + @param[in] String The pointer to the Ascii string. + @param[out] Ip4Address The pointer to the converted IPv4 address. + + @retval EFI_SUCCESS Convert to IPv4 address successfully. + @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip4Address is NULL. + +**/ +EFI_STATUS +EFIAPI +NetLibAsciiStrToIp4 ( + IN CONST CHAR8 *String, + OUT EFI_IPv4_ADDRESS *Ip4Address + ) +{ + RETURN_STATUS Status; + CHAR8 *EndPointer; + + Status = AsciiStrToIpv4Address (String, &EndPointer, Ip4Address, NULL); + if (RETURN_ERROR (Status) || (*EndPointer != '\0')) { + return EFI_INVALID_PARAMETER; + } else { + return EFI_SUCCESS; + } +} + + +/** + Convert one Null-terminated ASCII string to EFI_IPv6_ADDRESS. The format of the + string is defined in RFC 4291 - Text Representation of Addresses. + + @param[in] String The pointer to the Ascii string. + @param[out] Ip6Address The pointer to the converted IPv6 address. + + @retval EFI_SUCCESS Convert to IPv6 address successfully. + @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip6Address is NULL. + +**/ +EFI_STATUS +EFIAPI +NetLibAsciiStrToIp6 ( + IN CONST CHAR8 *String, + OUT EFI_IPv6_ADDRESS *Ip6Address + ) +{ + RETURN_STATUS Status; + CHAR8 *EndPointer; + + Status = AsciiStrToIpv6Address (String, &EndPointer, Ip6Address, NULL); + if (RETURN_ERROR (Status) || (*EndPointer != '\0')) { + return EFI_INVALID_PARAMETER; + } else { + return EFI_SUCCESS; + } +} + + +/** + Convert one Null-terminated Unicode string (decimal dotted) to EFI_IPv4_ADDRESS. + + @param[in] String The pointer to the Ascii string. + @param[out] Ip4Address The pointer to the converted IPv4 address. + + @retval EFI_SUCCESS Convert to IPv4 address successfully. + @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip4Address is NULL. + +**/ +EFI_STATUS +EFIAPI +NetLibStrToIp4 ( + IN CONST CHAR16 *String, + OUT EFI_IPv4_ADDRESS *Ip4Address + ) +{ + RETURN_STATUS Status; + CHAR16 *EndPointer; + + Status = StrToIpv4Address (String, &EndPointer, Ip4Address, NULL); + if (RETURN_ERROR (Status) || (*EndPointer != L'\0')) { + return EFI_INVALID_PARAMETER; + } else { + return EFI_SUCCESS; + } +} + + +/** + Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS. The format of + the string is defined in RFC 4291 - Text Representation of Addresses. + + @param[in] String The pointer to the Ascii string. + @param[out] Ip6Address The pointer to the converted IPv6 address. + + @retval EFI_SUCCESS Convert to IPv6 address successfully. + @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip6Address is NULL. + +**/ +EFI_STATUS +EFIAPI +NetLibStrToIp6 ( + IN CONST CHAR16 *String, + OUT EFI_IPv6_ADDRESS *Ip6Address + ) +{ + RETURN_STATUS Status; + CHAR16 *EndPointer; + + Status = StrToIpv6Address (String, &EndPointer, Ip6Address, NULL); + if (RETURN_ERROR (Status) || (*EndPointer != L'\0')) { + return EFI_INVALID_PARAMETER; + } else { + return EFI_SUCCESS; + } +} + +/** + Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS and prefix length. + The format of the string is defined in RFC 4291 - Text Representation of Addresses + Prefixes: ipv6-address/prefix-length. + + @param[in] String The pointer to the Ascii string. + @param[out] Ip6Address The pointer to the converted IPv6 address. + @param[out] PrefixLength The pointer to the converted prefix length. + + @retval EFI_SUCCESS Convert to IPv6 address successfully. + @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip6Address is NULL. + +**/ +EFI_STATUS +EFIAPI +NetLibStrToIp6andPrefix ( + IN CONST CHAR16 *String, + OUT EFI_IPv6_ADDRESS *Ip6Address, + OUT UINT8 *PrefixLength + ) +{ + RETURN_STATUS Status; + CHAR16 *EndPointer; + + Status = StrToIpv6Address (String, &EndPointer, Ip6Address, PrefixLength); + if (RETURN_ERROR (Status) || (*EndPointer != L'\0')) { + return EFI_INVALID_PARAMETER; + } else { + return EFI_SUCCESS; + } +} + +/** + + Convert one EFI_IPv6_ADDRESS to Null-terminated Unicode string. + The text representation of address is defined in RFC 4291. + + @param[in] Ip6Address The pointer to the IPv6 address. + @param[out] String The buffer to return the converted string. + @param[in] StringSize The length in bytes of the input String. + + @retval EFI_SUCCESS Convert to string successfully. + @retval EFI_INVALID_PARAMETER The input parameter is invalid. + @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result. BufferSize has been + updated with the size needed to complete the request. +**/ +EFI_STATUS +EFIAPI +NetLibIp6ToStr ( + IN EFI_IPv6_ADDRESS *Ip6Address, + OUT CHAR16 *String, + IN UINTN StringSize + ) +{ + UINT16 Ip6Addr[8]; + UINTN Index; + UINTN LongestZerosStart; + UINTN LongestZerosLength; + UINTN CurrentZerosStart; + UINTN CurrentZerosLength; + CHAR16 Buffer[sizeof"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff"]; + CHAR16 *Ptr; + + if (Ip6Address == NULL || String == NULL || StringSize == 0) { + return EFI_INVALID_PARAMETER; + } + + // + // Convert the UINT8 array to an UINT16 array for easy handling. + // + ZeroMem (Ip6Addr, sizeof (Ip6Addr)); + for (Index = 0; Index < 16; Index++) { + Ip6Addr[Index / 2] |= (Ip6Address->Addr[Index] << ((1 - (Index % 2)) << 3)); + } + + // + // Find the longest zeros and mark it. + // + CurrentZerosStart = DEFAULT_ZERO_START; + CurrentZerosLength = 0; + LongestZerosStart = DEFAULT_ZERO_START; + LongestZerosLength = 0; + for (Index = 0; Index < 8; Index++) { + if (Ip6Addr[Index] == 0) { + if (CurrentZerosStart == DEFAULT_ZERO_START) { + CurrentZerosStart = Index; + CurrentZerosLength = 1; + } else { + CurrentZerosLength++; + } + } else { + if (CurrentZerosStart != DEFAULT_ZERO_START) { + if (CurrentZerosLength > 2 && (LongestZerosStart == (DEFAULT_ZERO_START) || CurrentZerosLength > LongestZerosLength)) { + LongestZerosStart = CurrentZerosStart; + LongestZerosLength = CurrentZerosLength; + } + CurrentZerosStart = DEFAULT_ZERO_START; + CurrentZerosLength = 0; + } + } + } + + if (CurrentZerosStart != DEFAULT_ZERO_START && CurrentZerosLength > 2) { + if (LongestZerosStart == DEFAULT_ZERO_START || LongestZerosLength < CurrentZerosLength) { + LongestZerosStart = CurrentZerosStart; + LongestZerosLength = CurrentZerosLength; + } + } + + Ptr = Buffer; + for (Index = 0; Index < 8; Index++) { + if (LongestZerosStart != DEFAULT_ZERO_START && Index >= LongestZerosStart && Index < LongestZerosStart + LongestZerosLength) { + if (Index == LongestZerosStart) { + *Ptr++ = L':'; + } + continue; + } + if (Index != 0) { + *Ptr++ = L':'; + } + Ptr += UnicodeSPrint(Ptr, 10, L"%x", Ip6Addr[Index]); + } + + if (LongestZerosStart != DEFAULT_ZERO_START && LongestZerosStart + LongestZerosLength == 8) { + *Ptr++ = L':'; + } + *Ptr = L'\0'; + + if ((UINTN)Ptr - (UINTN)Buffer > StringSize) { + return EFI_BUFFER_TOO_SMALL; + } + + StrCpyS (String, StringSize / sizeof (CHAR16), Buffer); + + return EFI_SUCCESS; +} + +/** + This function obtains the system guid from the smbios table. + + If SystemGuid is NULL, then ASSERT(). + + @param[out] SystemGuid The pointer of the returned system guid. + + @retval EFI_SUCCESS Successfully obtained the system guid. + @retval EFI_NOT_FOUND Did not find the SMBIOS table. + +**/ +EFI_STATUS +EFIAPI +NetLibGetSystemGuid ( + OUT EFI_GUID *SystemGuid + ) +{ + EFI_STATUS Status; + SMBIOS_TABLE_ENTRY_POINT *SmbiosTable; + SMBIOS_TABLE_3_0_ENTRY_POINT *Smbios30Table; + SMBIOS_STRUCTURE_POINTER Smbios; + SMBIOS_STRUCTURE_POINTER SmbiosEnd; + CHAR8 *String; + + ASSERT (SystemGuid != NULL); + + SmbiosTable = NULL; + Status = EfiGetSystemConfigurationTable (&gEfiSmbios3TableGuid, (VOID **) &Smbios30Table); + if (!(EFI_ERROR (Status) || Smbios30Table == NULL)) { + Smbios.Hdr = (SMBIOS_STRUCTURE *) (UINTN) Smbios30Table->TableAddress; + SmbiosEnd.Raw = (UINT8 *) (UINTN) (Smbios30Table->TableAddress + Smbios30Table->TableMaximumSize); + } else { + Status = EfiGetSystemConfigurationTable (&gEfiSmbiosTableGuid, (VOID **) &SmbiosTable); + if (EFI_ERROR (Status) || SmbiosTable == NULL) { + return EFI_NOT_FOUND; + } + Smbios.Hdr = (SMBIOS_STRUCTURE *) (UINTN) SmbiosTable->TableAddress; + SmbiosEnd.Raw = (UINT8 *) ((UINTN) SmbiosTable->TableAddress + SmbiosTable->TableLength); + } + + do { + if (Smbios.Hdr->Type == 1) { + if (Smbios.Hdr->Length < 0x19) { + // + // Older version did not support UUID. + // + return EFI_NOT_FOUND; + } + + // + // SMBIOS tables are byte packed so we need to do a byte copy to + // prevend alignment faults on Itanium-based platform. + // + CopyMem (SystemGuid, &Smbios.Type1->Uuid, sizeof (EFI_GUID)); + return EFI_SUCCESS; + } + + // + // Go to the next SMBIOS structure. Each SMBIOS structure may include 2 parts: + // 1. Formatted section; 2. Unformatted string section. So, 2 steps are needed + // to skip one SMBIOS structure. + // + + // + // Step 1: Skip over formatted section. + // + String = (CHAR8 *) (Smbios.Raw + Smbios.Hdr->Length); + + // + // Step 2: Skip over unformated string section. + // + do { + // + // Each string is terminated with a NULL(00h) BYTE and the sets of strings + // is terminated with an additional NULL(00h) BYTE. + // + for ( ; *String != 0; String++) { + } + + if (*(UINT8*)++String == 0) { + // + // Pointer to the next SMBIOS structure. + // + Smbios.Raw = (UINT8 *)++String; + break; + } + } while (TRUE); + } while (Smbios.Raw < SmbiosEnd.Raw); + return EFI_NOT_FOUND; +} + +/** + Create Dns QName according the queried domain name. + + If DomainName is NULL, then ASSERT(). + + QName is a domain name represented as a sequence of labels, + where each label consists of a length octet followed by that + number of octets. The QName terminates with the zero + length octet for the null label of the root. Caller should + take responsibility to free the buffer in returned pointer. + + @param DomainName The pointer to the queried domain name string. + + @retval NULL Failed to fill QName. + @return QName filled successfully. + +**/ +CHAR8 * +EFIAPI +NetLibCreateDnsQName ( + IN CHAR16 *DomainName + ) +{ + CHAR8 *QueryName; + UINTN QueryNameSize; + CHAR8 *Header; + CHAR8 *Tail; + UINTN Len; + UINTN Index; + + ASSERT (DomainName != NULL); + + QueryName = NULL; + QueryNameSize = 0; + Header = NULL; + Tail = NULL; + + // + // One byte for first label length, one byte for terminated length zero. + // + QueryNameSize = StrLen (DomainName) + 2; + + if (QueryNameSize > DNS_MAX_NAME_SIZE) { + return NULL; + } + + QueryName = AllocateZeroPool (QueryNameSize); + if (QueryName == NULL) { + return NULL; + } + + Header = QueryName; + Tail = Header + 1; + Len = 0; + for (Index = 0; DomainName[Index] != 0; Index++) { + *Tail = (CHAR8) DomainName[Index]; + if (*Tail == '.') { + *Header = (CHAR8) Len; + Header = Tail; + Tail ++; + Len = 0; + } else { + Tail++; + Len++; + } + } + *Header = (CHAR8) Len; + *Tail = 0; + + return QueryName; +} diff --git a/NetworkPkg/Library/DxeNetLib/DxeNetLib.inf b/NetworkPkg/Library/DxeNetLib/DxeNetLib.inf new file mode 100644 index 0000000000..35a8247517 --- /dev/null +++ b/NetworkPkg/Library/DxeNetLib/DxeNetLib.inf @@ -0,0 +1,61 @@ +## @file +# This library instance provides the basic network services. +# +# Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+# (C) Copyright 2015 Hewlett Packard Enterprise Development LP
+# SPDX-License-Identifier: BSD-2-Clause-Patent +# +## + + +[Defines] + INF_VERSION = 0x00010005 + BASE_NAME = DxeNetLib + MODULE_UNI_FILE = DxeNetLib.uni + FILE_GUID = db6dcef3-9f4e-4340-9351-fc35aa8a5888 + MODULE_TYPE = DXE_DRIVER + VERSION_STRING = 1.0 + LIBRARY_CLASS = NetLib|DXE_CORE DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER + +# +# The following information is for reference only and not required by the build tools. +# +# VALID_ARCHITECTURES = IA32 X64 EBC +# + +[Sources] + DxeNetLib.c + NetBuffer.c + + +[Packages] + MdePkg/MdePkg.dec + MdeModulePkg/MdeModulePkg.dec + + +[LibraryClasses] + BaseLib + DebugLib + BaseMemoryLib + UefiBootServicesTableLib + UefiRuntimeServicesTableLib + UefiLib + MemoryAllocationLib + DevicePathLib + PrintLib + + +[Guids] + gEfiSmbiosTableGuid ## SOMETIMES_CONSUMES ## SystemTable + gEfiSmbios3TableGuid ## SOMETIMES_CONSUMES ## SystemTable + gEfiAdapterInfoMediaStateGuid ## SOMETIMES_CONSUMES + + +[Protocols] + gEfiSimpleNetworkProtocolGuid ## SOMETIMES_CONSUMES + gEfiManagedNetworkProtocolGuid ## SOMETIMES_CONSUMES + gEfiManagedNetworkServiceBindingProtocolGuid ## SOMETIMES_CONSUMES + gEfiIp4Config2ProtocolGuid ## SOMETIMES_CONSUMES + gEfiComponentNameProtocolGuid ## SOMETIMES_CONSUMES + gEfiComponentName2ProtocolGuid ## SOMETIMES_CONSUMES + gEfiAdapterInformationProtocolGuid ## SOMETIMES_CONSUMES diff --git a/NetworkPkg/Library/DxeNetLib/DxeNetLib.uni b/NetworkPkg/Library/DxeNetLib/DxeNetLib.uni new file mode 100644 index 0000000000..0c9f1fddde --- /dev/null +++ b/NetworkPkg/Library/DxeNetLib/DxeNetLib.uni @@ -0,0 +1,16 @@ +// /** @file +// This library instance provides the basic network services. +// +// This library instance provides the basic network services. +// +// Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+// +// SPDX-License-Identifier: BSD-2-Clause-Patent +// +// **/ + + +#string STR_MODULE_ABSTRACT #language en-US "Provides the basic network services" + +#string STR_MODULE_DESCRIPTION #language en-US "This library instance provides the basic network services." + diff --git a/NetworkPkg/Library/DxeNetLib/NetBuffer.c b/NetworkPkg/Library/DxeNetLib/NetBuffer.c new file mode 100644 index 0000000000..2408e9a104 --- /dev/null +++ b/NetworkPkg/Library/DxeNetLib/NetBuffer.c @@ -0,0 +1,1890 @@ +/** @file + Network library functions providing net buffer operation support. + +Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent +**/ + +#include + +#include +#include +#include +#include +#include +#include + + +/** + Allocate and build up the sketch for a NET_BUF. + + The net buffer allocated has the BlockOpNum's NET_BLOCK_OP, and its associated + NET_VECTOR has the BlockNum's NET_BLOCK. But all the NET_BLOCK_OP and + NET_BLOCK remain un-initialized. + + @param[in] BlockNum The number of NET_BLOCK in the vector of net buffer + @param[in] BlockOpNum The number of NET_BLOCK_OP in the net buffer + + @return Pointer to the allocated NET_BUF, or NULL if the + allocation failed due to resource limit. + +**/ +NET_BUF * +NetbufAllocStruct ( + IN UINT32 BlockNum, + IN UINT32 BlockOpNum + ) +{ + NET_BUF *Nbuf; + NET_VECTOR *Vector; + + ASSERT (BlockOpNum >= 1); + + // + // Allocate three memory blocks. + // + Nbuf = AllocateZeroPool (NET_BUF_SIZE (BlockOpNum)); + + if (Nbuf == NULL) { + return NULL; + } + + Nbuf->Signature = NET_BUF_SIGNATURE; + Nbuf->RefCnt = 1; + Nbuf->BlockOpNum = BlockOpNum; + InitializeListHead (&Nbuf->List); + + if (BlockNum != 0) { + Vector = AllocateZeroPool (NET_VECTOR_SIZE (BlockNum)); + + if (Vector == NULL) { + goto FreeNbuf; + } + + Vector->Signature = NET_VECTOR_SIGNATURE; + Vector->RefCnt = 1; + Vector->BlockNum = BlockNum; + Nbuf->Vector = Vector; + } + + return Nbuf; + +FreeNbuf: + + FreePool (Nbuf); + return NULL; +} + + +/** + Allocate a single block NET_BUF. Upon allocation, all the + free space is in the tail room. + + @param[in] Len The length of the block. + + @return Pointer to the allocated NET_BUF, or NULL if the + allocation failed due to resource limit. + +**/ +NET_BUF * +EFIAPI +NetbufAlloc ( + IN UINT32 Len + ) +{ + NET_BUF *Nbuf; + NET_VECTOR *Vector; + UINT8 *Bulk; + + ASSERT (Len > 0); + + Nbuf = NetbufAllocStruct (1, 1); + + if (Nbuf == NULL) { + return NULL; + } + + Bulk = AllocatePool (Len); + + if (Bulk == NULL) { + goto FreeNBuf; + } + + Vector = Nbuf->Vector; + Vector->Len = Len; + + Vector->Block[0].Bulk = Bulk; + Vector->Block[0].Len = Len; + + Nbuf->BlockOp[0].BlockHead = Bulk; + Nbuf->BlockOp[0].BlockTail = Bulk + Len; + + Nbuf->BlockOp[0].Head = Bulk; + Nbuf->BlockOp[0].Tail = Bulk; + Nbuf->BlockOp[0].Size = 0; + + return Nbuf; + +FreeNBuf: + FreePool (Nbuf); + return NULL; +} + +/** + Free the net vector. + + Decrease the reference count of the net vector by one. The real resource free + operation isn't performed until the reference count of the net vector is + decreased to 0. + + @param[in] Vector Pointer to the NET_VECTOR to be freed. + +**/ +VOID +NetbufFreeVector ( + IN NET_VECTOR *Vector + ) +{ + UINT32 Index; + + ASSERT (Vector != NULL); + NET_CHECK_SIGNATURE (Vector, NET_VECTOR_SIGNATURE); + ASSERT (Vector->RefCnt > 0); + + Vector->RefCnt--; + + if (Vector->RefCnt > 0) { + return; + } + + if (Vector->Free != NULL) { + // + // Call external free function to free the vector if it + // isn't NULL. If NET_VECTOR_OWN_FIRST is set, release the + // first block since it is allocated by us + // + if ((Vector->Flag & NET_VECTOR_OWN_FIRST) != 0) { + gBS->FreePool (Vector->Block[0].Bulk); + } + + Vector->Free (Vector->Arg); + + } else { + // + // Free each memory block associated with the Vector + // + for (Index = 0; Index < Vector->BlockNum; Index++) { + gBS->FreePool (Vector->Block[Index].Bulk); + } + } + + FreePool (Vector); +} + + +/** + Free the net buffer and its associated NET_VECTOR. + + Decrease the reference count of the net buffer by one. Free the associated net + vector and itself if the reference count of the net buffer is decreased to 0. + The net vector free operation just decrease the reference count of the net + vector by one and do the real resource free operation when the reference count + of the net vector is 0. + + @param[in] Nbuf Pointer to the NET_BUF to be freed. + +**/ +VOID +EFIAPI +NetbufFree ( + IN NET_BUF *Nbuf + ) +{ + ASSERT (Nbuf != NULL); + NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); + ASSERT (Nbuf->RefCnt > 0); + + Nbuf->RefCnt--; + + if (Nbuf->RefCnt == 0) { + // + // Update Vector only when NBuf is to be released. That is, + // all the sharing of Nbuf increse Vector's RefCnt by one + // + NetbufFreeVector (Nbuf->Vector); + FreePool (Nbuf); + } +} + + +/** + Create a copy of the net buffer that shares the associated net vector. + + The reference count of the newly created net buffer is set to 1. The reference + count of the associated net vector is increased by one. + + @param[in] Nbuf Pointer to the net buffer to be cloned. + + @return Pointer to the cloned net buffer, or NULL if the + allocation failed due to resource limit. + +**/ +NET_BUF * +EFIAPI +NetbufClone ( + IN NET_BUF *Nbuf + ) +{ + NET_BUF *Clone; + + NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); + + Clone = AllocatePool (NET_BUF_SIZE (Nbuf->BlockOpNum)); + + if (Clone == NULL) { + return NULL; + } + + Clone->Signature = NET_BUF_SIGNATURE; + Clone->RefCnt = 1; + InitializeListHead (&Clone->List); + + Clone->Ip = Nbuf->Ip; + Clone->Tcp = Nbuf->Tcp; + + CopyMem (Clone->ProtoData, Nbuf->ProtoData, NET_PROTO_DATA); + + NET_GET_REF (Nbuf->Vector); + + Clone->Vector = Nbuf->Vector; + Clone->BlockOpNum = Nbuf->BlockOpNum; + Clone->TotalSize = Nbuf->TotalSize; + CopyMem (Clone->BlockOp, Nbuf->BlockOp, sizeof (NET_BLOCK_OP) * Nbuf->BlockOpNum); + + return Clone; +} + + +/** + Create a duplicated copy of the net buffer with data copied and HeadSpace + bytes of head space reserved. + + The duplicated net buffer will allocate its own memory to hold the data of the + source net buffer. + + @param[in] Nbuf Pointer to the net buffer to be duplicated from. + @param[in, out] Duplicate Pointer to the net buffer to duplicate to, if + NULL a new net buffer is allocated. + @param[in] HeadSpace Length of the head space to reserve. + + @return Pointer to the duplicated net buffer, or NULL if + the allocation failed due to resource limit. + +**/ +NET_BUF * +EFIAPI +NetbufDuplicate ( + IN NET_BUF *Nbuf, + IN OUT NET_BUF *Duplicate OPTIONAL, + IN UINT32 HeadSpace + ) +{ + UINT8 *Dst; + + NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); + + if (Duplicate == NULL) { + Duplicate = NetbufAlloc (Nbuf->TotalSize + HeadSpace); + } + + if (Duplicate == NULL) { + return NULL; + } + + // + // Don't set the IP and TCP head point, since it is most + // like that they are pointing to the memory of Nbuf. + // + CopyMem (Duplicate->ProtoData, Nbuf->ProtoData, NET_PROTO_DATA); + NetbufReserve (Duplicate, HeadSpace); + + Dst = NetbufAllocSpace (Duplicate, Nbuf->TotalSize, NET_BUF_TAIL); + NetbufCopy (Nbuf, 0, Nbuf->TotalSize, Dst); + + return Duplicate; +} + + +/** + Free a list of net buffers. + + @param[in, out] Head Pointer to the head of linked net buffers. + +**/ +VOID +EFIAPI +NetbufFreeList ( + IN OUT LIST_ENTRY *Head + ) +{ + LIST_ENTRY *Entry; + LIST_ENTRY *Next; + NET_BUF *Nbuf; + + Entry = Head->ForwardLink; + + NET_LIST_FOR_EACH_SAFE (Entry, Next, Head) { + Nbuf = NET_LIST_USER_STRUCT (Entry, NET_BUF, List); + NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); + + RemoveEntryList (Entry); + NetbufFree (Nbuf); + } + + ASSERT (IsListEmpty (Head)); +} + + +/** + Get the index of NET_BLOCK_OP that contains the byte at Offset in the net + buffer. + + This can be used to, for example, retrieve the IP header in the packet. It + also can be used to get the fragment that contains the byte which is used + mainly by the library implementation itself. + + @param[in] Nbuf Pointer to the net buffer. + @param[in] Offset The offset of the byte. + @param[out] Index Index of the NET_BLOCK_OP that contains the byte at + Offset. + + @return Pointer to the Offset'th byte of data in the net buffer, or NULL + if there is no such data in the net buffer. + +**/ +UINT8 * +EFIAPI +NetbufGetByte ( + IN NET_BUF *Nbuf, + IN UINT32 Offset, + OUT UINT32 *Index OPTIONAL + ) +{ + NET_BLOCK_OP *BlockOp; + UINT32 Loop; + UINT32 Len; + + NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); + + if (Offset >= Nbuf->TotalSize) { + return NULL; + } + + BlockOp = Nbuf->BlockOp; + Len = 0; + + for (Loop = 0; Loop < Nbuf->BlockOpNum; Loop++) { + + if (Len + BlockOp[Loop].Size <= Offset) { + Len += BlockOp[Loop].Size; + continue; + } + + if (Index != NULL) { + *Index = Loop; + } + + return BlockOp[Loop].Head + (Offset - Len); + } + + return NULL; +} + + + +/** + Set the NET_BLOCK and corresponding NET_BLOCK_OP in the net buffer and + corresponding net vector according to the bulk pointer and bulk length. + + All the pointers in the Index'th NET_BLOCK and NET_BLOCK_OP are set to the + bulk's head and tail respectively. So, this function alone can't be used by + NetbufAlloc. + + @param[in, out] Nbuf Pointer to the net buffer. + @param[in] Bulk Pointer to the data. + @param[in] Len Length of the bulk data. + @param[in] Index The data block index in the net buffer the bulk + data should belong to. + +**/ +VOID +NetbufSetBlock ( + IN OUT NET_BUF *Nbuf, + IN UINT8 *Bulk, + IN UINT32 Len, + IN UINT32 Index + ) +{ + NET_BLOCK_OP *BlockOp; + NET_BLOCK *Block; + + NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); + NET_CHECK_SIGNATURE (Nbuf->Vector, NET_VECTOR_SIGNATURE); + ASSERT (Index < Nbuf->BlockOpNum); + + Block = &(Nbuf->Vector->Block[Index]); + BlockOp = &(Nbuf->BlockOp[Index]); + Block->Len = Len; + Block->Bulk = Bulk; + BlockOp->BlockHead = Bulk; + BlockOp->BlockTail = Bulk + Len; + BlockOp->Head = Bulk; + BlockOp->Tail = Bulk + Len; + BlockOp->Size = Len; +} + + + +/** + Set the NET_BLOCK_OP in the net buffer. The corresponding NET_BLOCK + structure is left untouched. + + Some times, there is no 1:1 relationship between NET_BLOCK and NET_BLOCK_OP. + For example, that in NetbufGetFragment. + + @param[in, out] Nbuf Pointer to the net buffer. + @param[in] Bulk Pointer to the data. + @param[in] Len Length of the bulk data. + @param[in] Index The data block index in the net buffer the bulk + data should belong to. + +**/ +VOID +NetbufSetBlockOp ( + IN OUT NET_BUF *Nbuf, + IN UINT8 *Bulk, + IN UINT32 Len, + IN UINT32 Index + ) +{ + NET_BLOCK_OP *BlockOp; + + NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); + ASSERT (Index < Nbuf->BlockOpNum); + + BlockOp = &(Nbuf->BlockOp[Index]); + BlockOp->BlockHead = Bulk; + BlockOp->BlockTail = Bulk + Len; + BlockOp->Head = Bulk; + BlockOp->Tail = Bulk + Len; + BlockOp->Size = Len; +} + + +/** + Helper function for NetbufGetFragment. NetbufGetFragment may allocate the + first block to reserve HeadSpace bytes header space. So it needs to create a + new net vector for the first block and can avoid copy for the remaining data + by sharing the old net vector. + + @param[in] Arg Point to the old NET_VECTOR. + +**/ +VOID +EFIAPI +NetbufGetFragmentFree ( + IN VOID *Arg + ) +{ + NET_VECTOR *Vector; + + Vector = (NET_VECTOR *)Arg; + NetbufFreeVector (Vector); +} + + +/** + Create a NET_BUF structure which contains Len byte data of Nbuf starting from + Offset. + + A new NET_BUF structure will be created but the associated data in NET_VECTOR + is shared. This function exists to do IP packet fragmentation. + + @param[in] Nbuf Pointer to the net buffer to be extracted. + @param[in] Offset Starting point of the data to be included in the new + net buffer. + @param[in] Len Bytes of data to be included in the new net buffer. + @param[in] HeadSpace Bytes of head space to reserve for protocol header. + + @return Pointer to the cloned net buffer, or NULL if the + allocation failed due to resource limit. + +**/ +NET_BUF * +EFIAPI +NetbufGetFragment ( + IN NET_BUF *Nbuf, + IN UINT32 Offset, + IN UINT32 Len, + IN UINT32 HeadSpace + ) +{ + NET_BUF *Child; + NET_VECTOR *Vector; + NET_BLOCK_OP *BlockOp; + UINT32 CurBlockOp; + UINT32 BlockOpNum; + UINT8 *FirstBulk; + UINT32 Index; + UINT32 First; + UINT32 Last; + UINT32 FirstSkip; + UINT32 FirstLen; + UINT32 LastLen; + UINT32 Cur; + + NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); + + if ((Len == 0) || (Offset + Len > Nbuf->TotalSize)) { + return NULL; + } + + // + // First find the first and last BlockOp that contains + // the valid data, and compute the offset of the first + // BlockOp and length of the last BlockOp + // + BlockOp = Nbuf->BlockOp; + Cur = 0; + + for (Index = 0; Index < Nbuf->BlockOpNum; Index++) { + if (Offset < Cur + BlockOp[Index].Size) { + break; + } + + Cur += BlockOp[Index].Size; + } + + // + // First is the index of the first BlockOp, FirstSkip is + // the offset of the first byte in the first BlockOp. + // + First = Index; + FirstSkip = Offset - Cur; + FirstLen = BlockOp[Index].Size - FirstSkip; + + Last = 0; + LastLen = 0; + + if (Len > FirstLen) { + Cur += BlockOp[Index].Size; + Index++; + + for (; Index < Nbuf->BlockOpNum; Index++) { + if (Offset + Len <= Cur + BlockOp[Index].Size) { + Last = Index; + LastLen = Offset + Len - Cur; + break; + } + + Cur += BlockOp[Index].Size; + } + + } else { + Last = First; + LastLen = Len; + FirstLen = Len; + } + + ASSERT (Last >= First); + BlockOpNum = Last - First + 1; + CurBlockOp = 0; + + if (HeadSpace != 0) { + // + // Allocate an extra block to accomdate the head space. + // + BlockOpNum++; + + Child = NetbufAllocStruct (1, BlockOpNum); + + if (Child == NULL) { + return NULL; + } + + FirstBulk = AllocatePool (HeadSpace); + + if (FirstBulk == NULL) { + goto FreeChild; + } + + Vector = Child->Vector; + Vector->Free = NetbufGetFragmentFree; + Vector->Arg = Nbuf->Vector; + Vector->Flag = NET_VECTOR_OWN_FIRST; + Vector->Len = HeadSpace; + + // + // Reserve the head space in the first block + // + NetbufSetBlock (Child, FirstBulk, HeadSpace, 0); + Child->BlockOp[0].Head += HeadSpace; + Child->BlockOp[0].Size = 0; + CurBlockOp++; + + } else { + Child = NetbufAllocStruct (0, BlockOpNum); + + if (Child == NULL) { + return NULL; + } + + Child->Vector = Nbuf->Vector; + } + + NET_GET_REF (Nbuf->Vector); + Child->TotalSize = Len; + + // + // Set all the BlockOp up, the first and last one are special + // and need special process. + // + NetbufSetBlockOp ( + Child, + Nbuf->BlockOp[First].Head + FirstSkip, + FirstLen, + CurBlockOp++ + ); + + for (Index = First + 1; Index < Last; Index++) { + NetbufSetBlockOp ( + Child, + BlockOp[Index].Head, + BlockOp[Index].Size, + CurBlockOp++ + ); + } + + if (First != Last) { + NetbufSetBlockOp ( + Child, + BlockOp[Last].Head, + LastLen, + CurBlockOp + ); + } + + CopyMem (Child->ProtoData, Nbuf->ProtoData, NET_PROTO_DATA); + return Child; + +FreeChild: + + FreePool (Child); + return NULL; +} + + + +/** + Build a NET_BUF from external blocks. + + A new NET_BUF structure will be created from external blocks. Additional block + of memory will be allocated to hold reserved HeadSpace bytes of header room + and existing HeadLen bytes of header but the external blocks are shared by the + net buffer to avoid data copying. + + @param[in] ExtFragment Pointer to the data block. + @param[in] ExtNum The number of the data blocks. + @param[in] HeadSpace The head space to be reserved. + @param[in] HeadLen The length of the protocol header, This function + will pull that number of data into a linear block. + @param[in] ExtFree Pointer to the caller provided free function. + @param[in] Arg The argument passed to ExtFree when ExtFree is + called. + + @return Pointer to the net buffer built from the data blocks, + or NULL if the allocation failed due to resource + limit. + +**/ +NET_BUF * +EFIAPI +NetbufFromExt ( + IN NET_FRAGMENT *ExtFragment, + IN UINT32 ExtNum, + IN UINT32 HeadSpace, + IN UINT32 HeadLen, + IN NET_VECTOR_EXT_FREE ExtFree, + IN VOID *Arg OPTIONAL + ) +{ + NET_BUF *Nbuf; + NET_VECTOR *Vector; + NET_FRAGMENT SavedFragment; + UINT32 SavedIndex; + UINT32 TotalLen; + UINT32 BlockNum; + UINT8 *FirstBlock; + UINT32 FirstBlockLen; + UINT8 *Header; + UINT32 CurBlock; + UINT32 Index; + UINT32 Len; + UINT32 Copied; + + ASSERT ((ExtFragment != NULL) && (ExtNum > 0) && (ExtFree != NULL)); + + SavedFragment.Bulk = NULL; + SavedFragment.Len = 0; + + FirstBlockLen = 0; + FirstBlock = NULL; + BlockNum = ExtNum; + Index = 0; + TotalLen = 0; + SavedIndex = 0; + Len = 0; + Copied = 0; + + // + // No need to consolidate the header if the first block is + // longer than the header length or there is only one block. + // + if ((ExtFragment[0].Len >= HeadLen) || (ExtNum == 1)) { + HeadLen = 0; + } + + // + // Allocate an extra block if we need to: + // 1. Allocate some header space + // 2. aggreate the packet header + // + if ((HeadSpace != 0) || (HeadLen != 0)) { + FirstBlockLen = HeadLen + HeadSpace; + FirstBlock = AllocatePool (FirstBlockLen); + + if (FirstBlock == NULL) { + return NULL; + } + + BlockNum++; + } + + // + // Copy the header to the first block, reduce the NET_BLOCK + // to allocate by one for each block that is completely covered + // by the first bulk. + // + if (HeadLen != 0) { + Len = HeadLen; + Header = FirstBlock + HeadSpace; + + for (Index = 0; Index < ExtNum; Index++) { + if (Len >= ExtFragment[Index].Len) { + CopyMem (Header, ExtFragment[Index].Bulk, ExtFragment[Index].Len); + + Copied += ExtFragment[Index].Len; + Len -= ExtFragment[Index].Len; + Header += ExtFragment[Index].Len; + TotalLen += ExtFragment[Index].Len; + BlockNum--; + + if (Len == 0) { + // + // Increament the index number to point to the next + // non-empty fragment. + // + Index++; + break; + } + + } else { + CopyMem (Header, ExtFragment[Index].Bulk, Len); + + Copied += Len; + TotalLen += Len; + + // + // Adjust the block structure to exclude the data copied, + // So, the left-over block can be processed as other blocks. + // But it must be recovered later. (SavedIndex > 0) always + // holds since we don't aggreate the header if the first block + // is bigger enough that the header is continuous + // + SavedIndex = Index; + SavedFragment = ExtFragment[Index]; + ExtFragment[Index].Bulk += Len; + ExtFragment[Index].Len -= Len; + break; + } + } + } + + Nbuf = NetbufAllocStruct (BlockNum, BlockNum); + + if (Nbuf == NULL) { + goto FreeFirstBlock; + } + + Vector = Nbuf->Vector; + Vector->Free = ExtFree; + Vector->Arg = Arg; + Vector->Flag = ((FirstBlockLen != 0) ? NET_VECTOR_OWN_FIRST : 0); + + // + // Set the first block up which may contain + // some head space and aggregated header + // + CurBlock = 0; + + if (FirstBlockLen != 0) { + NetbufSetBlock (Nbuf, FirstBlock, HeadSpace + Copied, 0); + Nbuf->BlockOp[0].Head += HeadSpace; + Nbuf->BlockOp[0].Size = Copied; + + CurBlock++; + } + + for (; Index < ExtNum; Index++) { + NetbufSetBlock (Nbuf, ExtFragment[Index].Bulk, ExtFragment[Index].Len, CurBlock); + TotalLen += ExtFragment[Index].Len; + CurBlock++; + } + + Vector->Len = TotalLen + HeadSpace; + Nbuf->TotalSize = TotalLen; + + if (SavedIndex != 0) { + ExtFragment[SavedIndex] = SavedFragment; + } + + return Nbuf; + +FreeFirstBlock: + if (FirstBlock != NULL) { + FreePool (FirstBlock); + } + return NULL; +} + + +/** + Build a fragment table to contain the fragments in the net buffer. This is the + opposite operation of the NetbufFromExt. + + @param[in] Nbuf Point to the net buffer. + @param[in, out] ExtFragment Pointer to the data block. + @param[in, out] ExtNum The number of the data blocks. + + @retval EFI_BUFFER_TOO_SMALL The number of non-empty block is bigger than + ExtNum. + @retval EFI_SUCCESS Fragment table is built successfully. + +**/ +EFI_STATUS +EFIAPI +NetbufBuildExt ( + IN NET_BUF *Nbuf, + IN OUT NET_FRAGMENT *ExtFragment, + IN OUT UINT32 *ExtNum + ) +{ + UINT32 Index; + UINT32 Current; + + Current = 0; + + for (Index = 0; (Index < Nbuf->BlockOpNum); Index++) { + if (Nbuf->BlockOp[Index].Size == 0) { + continue; + } + + if (Current < *ExtNum) { + ExtFragment[Current].Bulk = Nbuf->BlockOp[Index].Head; + ExtFragment[Current].Len = Nbuf->BlockOp[Index].Size; + Current++; + } else { + return EFI_BUFFER_TOO_SMALL; + } + } + + *ExtNum = Current; + return EFI_SUCCESS; +} + + +/** + Build a net buffer from a list of net buffers. + + All the fragments will be collected from the list of NEW_BUF and then a new + net buffer will be created through NetbufFromExt. + + @param[in] BufList A List of the net buffer. + @param[in] HeadSpace The head space to be reserved. + @param[in] HeaderLen The length of the protocol header, This function + will pull that number of data into a linear block. + @param[in] ExtFree Pointer to the caller provided free function. + @param[in] Arg The argument passed to ExtFree when ExtFree is called. + + @return Pointer to the net buffer built from the list of net + buffers. + +**/ +NET_BUF * +EFIAPI +NetbufFromBufList ( + IN LIST_ENTRY *BufList, + IN UINT32 HeadSpace, + IN UINT32 HeaderLen, + IN NET_VECTOR_EXT_FREE ExtFree, + IN VOID *Arg OPTIONAL + ) +{ + NET_FRAGMENT *Fragment; + UINT32 FragmentNum; + LIST_ENTRY *Entry; + NET_BUF *Nbuf; + UINT32 Index; + UINT32 Current; + + // + //Compute how many blocks are there + // + FragmentNum = 0; + + NET_LIST_FOR_EACH (Entry, BufList) { + Nbuf = NET_LIST_USER_STRUCT (Entry, NET_BUF, List); + NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); + FragmentNum += Nbuf->BlockOpNum; + } + + // + //Allocate and copy block points + // + Fragment = AllocatePool (sizeof (NET_FRAGMENT) * FragmentNum); + + if (Fragment == NULL) { + return NULL; + } + + Current = 0; + + NET_LIST_FOR_EACH (Entry, BufList) { + Nbuf = NET_LIST_USER_STRUCT (Entry, NET_BUF, List); + NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); + + for (Index = 0; Index < Nbuf->BlockOpNum; Index++) { + if (Nbuf->BlockOp[Index].Size != 0) { + Fragment[Current].Bulk = Nbuf->BlockOp[Index].Head; + Fragment[Current].Len = Nbuf->BlockOp[Index].Size; + Current++; + } + } + } + + Nbuf = NetbufFromExt (Fragment, Current, HeadSpace, HeaderLen, ExtFree, Arg); + FreePool (Fragment); + + return Nbuf; +} + + +/** + Reserve some space in the header room of the net buffer. + + Upon allocation, all the space are in the tail room of the buffer. Call this + function to move some space to the header room. This function is quite limited + in that it can only reserve space from the first block of an empty NET_BUF not + built from the external. But it should be enough for the network stack. + + @param[in, out] Nbuf Pointer to the net buffer. + @param[in] Len The length of buffer to be reserved from the header. + +**/ +VOID +EFIAPI +NetbufReserve ( + IN OUT NET_BUF *Nbuf, + IN UINT32 Len + ) +{ + NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); + NET_CHECK_SIGNATURE (Nbuf->Vector, NET_VECTOR_SIGNATURE); + + ASSERT ((Nbuf->BlockOpNum == 1) && (Nbuf->TotalSize == 0)); + ASSERT ((Nbuf->Vector->Free == NULL) && (Nbuf->Vector->Len >= Len)); + + Nbuf->BlockOp[0].Head += Len; + Nbuf->BlockOp[0].Tail += Len; + + ASSERT (Nbuf->BlockOp[0].Tail <= Nbuf->BlockOp[0].BlockTail); +} + + +/** + Allocate Len bytes of space from the header or tail of the buffer. + + @param[in, out] Nbuf Pointer to the net buffer. + @param[in] Len The length of the buffer to be allocated. + @param[in] FromHead The flag to indicate whether reserve the data + from head (TRUE) or tail (FALSE). + + @return Pointer to the first byte of the allocated buffer, + or NULL if there is no sufficient space. + +**/ +UINT8* +EFIAPI +NetbufAllocSpace ( + IN OUT NET_BUF *Nbuf, + IN UINT32 Len, + IN BOOLEAN FromHead + ) +{ + NET_BLOCK_OP *BlockOp; + UINT32 Index; + UINT8 *SavedTail; + + Index = 0; + + NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); + NET_CHECK_SIGNATURE (Nbuf->Vector, NET_VECTOR_SIGNATURE); + + ASSERT (Len > 0); + + if (FromHead) { + // + // Allocate some space from head. If the buffer is empty, + // allocate from the first block. If it isn't, allocate + // from the first non-empty block, or the block before that. + // + if (Nbuf->TotalSize == 0) { + Index = 0; + } else { + NetbufGetByte (Nbuf, 0, &Index); + + if ((NET_HEADSPACE(&(Nbuf->BlockOp[Index])) < Len) && (Index > 0)) { + Index--; + } + } + + BlockOp = &(Nbuf->BlockOp[Index]); + + if (NET_HEADSPACE (BlockOp) < Len) { + return NULL; + } + + BlockOp->Head -= Len; + BlockOp->Size += Len; + Nbuf->TotalSize += Len; + + return BlockOp->Head; + + } else { + // + // Allocate some space from the tail. If the buffer is empty, + // allocate from the first block. If it isn't, allocate + // from the last non-empty block, or the block after that. + // + if (Nbuf->TotalSize == 0) { + Index = 0; + } else { + NetbufGetByte (Nbuf, Nbuf->TotalSize - 1, &Index); + + if ((NET_TAILSPACE(&(Nbuf->BlockOp[Index])) < Len) && + (Index < Nbuf->BlockOpNum - 1)) { + + Index++; + } + } + + BlockOp = &(Nbuf->BlockOp[Index]); + + if (NET_TAILSPACE (BlockOp) < Len) { + return NULL; + } + + SavedTail = BlockOp->Tail; + + BlockOp->Tail += Len; + BlockOp->Size += Len; + Nbuf->TotalSize += Len; + + return SavedTail; + } +} + + +/** + Trim a single NET_BLOCK by Len bytes from the header or tail. + + @param[in, out] BlockOp Pointer to the NET_BLOCK. + @param[in] Len The length of the data to be trimmed. + @param[in] FromHead The flag to indicate whether trim data from head + (TRUE) or tail (FALSE). + +**/ +VOID +NetblockTrim ( + IN OUT NET_BLOCK_OP *BlockOp, + IN UINT32 Len, + IN BOOLEAN FromHead + ) +{ + ASSERT ((BlockOp != NULL) && (BlockOp->Size >= Len)); + + BlockOp->Size -= Len; + + if (FromHead) { + BlockOp->Head += Len; + } else { + BlockOp->Tail -= Len; + } +} + + +/** + Trim Len bytes from the header or tail of the net buffer. + + @param[in, out] Nbuf Pointer to the net buffer. + @param[in] Len The length of the data to be trimmed. + @param[in] FromHead The flag to indicate whether trim data from head + (TRUE) or tail (FALSE). + + @return Length of the actually trimmed data, which is possible to be less + than Len because the TotalSize of Nbuf is less than Len. + +**/ +UINT32 +EFIAPI +NetbufTrim ( + IN OUT NET_BUF *Nbuf, + IN UINT32 Len, + IN BOOLEAN FromHead + ) +{ + NET_BLOCK_OP *BlockOp; + UINT32 Index; + UINT32 Trimmed; + + NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); + + if (Len == 0 || Nbuf->TotalSize == 0) { + return 0; + } + + if (Len > Nbuf->TotalSize) { + Len = Nbuf->TotalSize; + } + + // + // If FromTail is true, iterate backward. That + // is, init Index to NBuf->BlockNum - 1, and + // decrease it by 1 during each loop. Otherwise, + // iterate forward. That is, init Index to 0, and + // increase it by 1 during each loop. + // + Trimmed = 0; + Nbuf->TotalSize -= Len; + + Index = (FromHead ? 0 : Nbuf->BlockOpNum - 1); + BlockOp = Nbuf->BlockOp; + + for (;;) { + if (BlockOp[Index].Size == 0) { + Index += (FromHead ? 1 : -1); + continue; + } + + if (Len > BlockOp[Index].Size) { + Len -= BlockOp[Index].Size; + Trimmed += BlockOp[Index].Size; + NetblockTrim (&BlockOp[Index], BlockOp[Index].Size, FromHead); + } else { + Trimmed += Len; + NetblockTrim (&BlockOp[Index], Len, FromHead); + break; + } + + Index += (FromHead ? 1 : -1); + } + + return Trimmed; +} + + +/** + Copy Len bytes of data from the specific offset of the net buffer to the + destination memory. + + The Len bytes of data may cross the several fragments of the net buffer. + + @param[in] Nbuf Pointer to the net buffer. + @param[in] Offset The sequence number of the first byte to copy. + @param[in] Len Length of the data to copy. + @param[in] Dest The destination of the data to copy to. + + @return The length of the actual copied data, or 0 if the offset + specified exceeds the total size of net buffer. + +**/ +UINT32 +EFIAPI +NetbufCopy ( + IN NET_BUF *Nbuf, + IN UINT32 Offset, + IN UINT32 Len, + IN UINT8 *Dest + ) +{ + NET_BLOCK_OP *BlockOp; + UINT32 Skip; + UINT32 Left; + UINT32 Copied; + UINT32 Index; + UINT32 Cur; + + NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); + ASSERT (Dest); + + if ((Len == 0) || (Nbuf->TotalSize <= Offset)) { + return 0; + } + + if (Nbuf->TotalSize - Offset < Len) { + Len = Nbuf->TotalSize - Offset; + } + + BlockOp = Nbuf->BlockOp; + + // + // Skip to the offset. Don't make "Offset-By-One" error here. + // Cur + BLOCK.SIZE is the first sequence number of next block. + // So, (Offset < Cur + BLOCK.SIZE) means that the first byte + // is in the current block. if (Offset == Cur + BLOCK.SIZE), the + // first byte is the next block's first byte. + // + Cur = 0; + + for (Index = 0; Index < Nbuf->BlockOpNum; Index++) { + if (BlockOp[Index].Size == 0) { + continue; + } + + if (Offset < Cur + BlockOp[Index].Size) { + break; + } + + Cur += BlockOp[Index].Size; + } + + // + // Cur is the sequence number of the first byte in the block + // Offset - Cur is the number of bytes before first byte to + // to copy in the current block. + // + Skip = Offset - Cur; + Left = BlockOp[Index].Size - Skip; + + if (Len <= Left) { + CopyMem (Dest, BlockOp[Index].Head + Skip, Len); + return Len; + } + + CopyMem (Dest, BlockOp[Index].Head + Skip, Left); + + Dest += Left; + Len -= Left; + Copied = Left; + + Index++; + + for (; Index < Nbuf->BlockOpNum; Index++) { + if (Len > BlockOp[Index].Size) { + Len -= BlockOp[Index].Size; + Copied += BlockOp[Index].Size; + + CopyMem (Dest, BlockOp[Index].Head, BlockOp[Index].Size); + Dest += BlockOp[Index].Size; + } else { + Copied += Len; + CopyMem (Dest, BlockOp[Index].Head, Len); + break; + } + } + + return Copied; +} + + +/** + Initiate the net buffer queue. + + @param[in, out] NbufQue Pointer to the net buffer queue to be initialized. + +**/ +VOID +EFIAPI +NetbufQueInit ( + IN OUT NET_BUF_QUEUE *NbufQue + ) +{ + NbufQue->Signature = NET_QUE_SIGNATURE; + NbufQue->RefCnt = 1; + InitializeListHead (&NbufQue->List); + + InitializeListHead (&NbufQue->BufList); + NbufQue->BufSize = 0; + NbufQue->BufNum = 0; +} + + +/** + Allocate and initialize a net buffer queue. + + @return Pointer to the allocated net buffer queue, or NULL if the + allocation failed due to resource limit. + +**/ +NET_BUF_QUEUE * +EFIAPI +NetbufQueAlloc ( + VOID + ) +{ + NET_BUF_QUEUE *NbufQue; + + NbufQue = AllocatePool (sizeof (NET_BUF_QUEUE)); + if (NbufQue == NULL) { + return NULL; + } + + NetbufQueInit (NbufQue); + + return NbufQue; +} + + +/** + Free a net buffer queue. + + Decrease the reference count of the net buffer queue by one. The real resource + free operation isn't performed until the reference count of the net buffer + queue is decreased to 0. + + @param[in] NbufQue Pointer to the net buffer queue to be freed. + +**/ +VOID +EFIAPI +NetbufQueFree ( + IN NET_BUF_QUEUE *NbufQue + ) +{ + ASSERT (NbufQue != NULL); + NET_CHECK_SIGNATURE (NbufQue, NET_QUE_SIGNATURE); + + NbufQue->RefCnt--; + + if (NbufQue->RefCnt == 0) { + NetbufQueFlush (NbufQue); + FreePool (NbufQue); + } +} + + +/** + Append a net buffer to the net buffer queue. + + @param[in, out] NbufQue Pointer to the net buffer queue. + @param[in, out] Nbuf Pointer to the net buffer to be appended. + +**/ +VOID +EFIAPI +NetbufQueAppend ( + IN OUT NET_BUF_QUEUE *NbufQue, + IN OUT NET_BUF *Nbuf + ) +{ + NET_CHECK_SIGNATURE (NbufQue, NET_QUE_SIGNATURE); + NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); + + InsertTailList (&NbufQue->BufList, &Nbuf->List); + + NbufQue->BufSize += Nbuf->TotalSize; + NbufQue->BufNum++; +} + + +/** + Remove a net buffer from the head in the specific queue and return it. + + @param[in, out] NbufQue Pointer to the net buffer queue. + + @return Pointer to the net buffer removed from the specific queue, + or NULL if there is no net buffer in the specific queue. + +**/ +NET_BUF * +EFIAPI +NetbufQueRemove ( + IN OUT NET_BUF_QUEUE *NbufQue + ) +{ + NET_BUF *First; + + NET_CHECK_SIGNATURE (NbufQue, NET_QUE_SIGNATURE); + + if (NbufQue->BufNum == 0) { + return NULL; + } + + First = NET_LIST_USER_STRUCT (NbufQue->BufList.ForwardLink, NET_BUF, List); + + NetListRemoveHead (&NbufQue->BufList); + + NbufQue->BufSize -= First->TotalSize; + NbufQue->BufNum--; + return First; +} + + +/** + Copy Len bytes of data from the net buffer queue at the specific offset to the + destination memory. + + The copying operation is the same as NetbufCopy but applies to the net buffer + queue instead of the net buffer. + + @param[in] NbufQue Pointer to the net buffer queue. + @param[in] Offset The sequence number of the first byte to copy. + @param[in] Len Length of the data to copy. + @param[out] Dest The destination of the data to copy to. + + @return The length of the actual copied data, or 0 if the offset + specified exceeds the total size of net buffer queue. + +**/ +UINT32 +EFIAPI +NetbufQueCopy ( + IN NET_BUF_QUEUE *NbufQue, + IN UINT32 Offset, + IN UINT32 Len, + OUT UINT8 *Dest + ) +{ + LIST_ENTRY *Entry; + NET_BUF *Nbuf; + UINT32 Skip; + UINT32 Left; + UINT32 Cur; + UINT32 Copied; + + NET_CHECK_SIGNATURE (NbufQue, NET_QUE_SIGNATURE); + ASSERT (Dest != NULL); + + if ((Len == 0) || (NbufQue->BufSize <= Offset)) { + return 0; + } + + if (NbufQue->BufSize - Offset < Len) { + Len = NbufQue->BufSize - Offset; + } + + // + // skip to the Offset + // + Cur = 0; + Nbuf = NULL; + + NET_LIST_FOR_EACH (Entry, &NbufQue->BufList) { + Nbuf = NET_LIST_USER_STRUCT (Entry, NET_BUF, List); + + if (Offset < Cur + Nbuf->TotalSize) { + break; + } + + Cur += Nbuf->TotalSize; + } + + ASSERT (Nbuf != NULL); + + // + // Copy the data in the first buffer. + // + Skip = Offset - Cur; + Left = Nbuf->TotalSize - Skip; + + if (Len < Left) { + return NetbufCopy (Nbuf, Skip, Len, Dest); + } + + NetbufCopy (Nbuf, Skip, Left, Dest); + Dest += Left; + Len -= Left; + Copied = Left; + + // + // Iterate over the others + // + Entry = Entry->ForwardLink; + + while ((Len > 0) && (Entry != &NbufQue->BufList)) { + Nbuf = NET_LIST_USER_STRUCT (Entry, NET_BUF, List); + + if (Len > Nbuf->TotalSize) { + Len -= Nbuf->TotalSize; + Copied += Nbuf->TotalSize; + + NetbufCopy (Nbuf, 0, Nbuf->TotalSize, Dest); + Dest += Nbuf->TotalSize; + + } else { + NetbufCopy (Nbuf, 0, Len, Dest); + Copied += Len; + break; + } + + Entry = Entry->ForwardLink; + } + + return Copied; +} + + +/** + Trim Len bytes of data from the buffer queue and free any net buffer + that is completely trimmed. + + The trimming operation is the same as NetbufTrim but applies to the net buffer + queue instead of the net buffer. + + @param[in, out] NbufQue Pointer to the net buffer queue. + @param[in] Len Length of the data to trim. + + @return The actual length of the data trimmed. + +**/ +UINT32 +EFIAPI +NetbufQueTrim ( + IN OUT NET_BUF_QUEUE *NbufQue, + IN UINT32 Len + ) +{ + LIST_ENTRY *Entry; + LIST_ENTRY *Next; + NET_BUF *Nbuf; + UINT32 Trimmed; + + NET_CHECK_SIGNATURE (NbufQue, NET_QUE_SIGNATURE); + + if (Len == 0) { + return 0; + } + + if (Len > NbufQue->BufSize) { + Len = NbufQue->BufSize; + } + + NbufQue->BufSize -= Len; + Trimmed = 0; + + NET_LIST_FOR_EACH_SAFE (Entry, Next, &NbufQue->BufList) { + Nbuf = NET_LIST_USER_STRUCT (Entry, NET_BUF, List); + + if (Len >= Nbuf->TotalSize) { + Trimmed += Nbuf->TotalSize; + Len -= Nbuf->TotalSize; + + RemoveEntryList (Entry); + NetbufFree (Nbuf); + + NbufQue->BufNum--; + + if (Len == 0) { + break; + } + + } else { + Trimmed += NetbufTrim (Nbuf, Len, NET_BUF_HEAD); + break; + } + } + + return Trimmed; +} + + +/** + Flush the net buffer queue. + + @param[in, out] NbufQue Pointer to the queue to be flushed. + +**/ +VOID +EFIAPI +NetbufQueFlush ( + IN OUT NET_BUF_QUEUE *NbufQue + ) +{ + NET_CHECK_SIGNATURE (NbufQue, NET_QUE_SIGNATURE); + + NetbufFreeList (&NbufQue->BufList); + + NbufQue->BufNum = 0; + NbufQue->BufSize = 0; +} + + +/** + Compute the checksum for a bulk of data. + + @param[in] Bulk Pointer to the data. + @param[in] Len Length of the data, in bytes. + + @return The computed checksum. + +**/ +UINT16 +EFIAPI +NetblockChecksum ( + IN UINT8 *Bulk, + IN UINT32 Len + ) +{ + register UINT32 Sum; + + Sum = 0; + + // + // Add left-over byte, if any + // + if (Len % 2 != 0) { + Sum += *(Bulk + Len - 1); + } + + while (Len > 1) { + Sum += *(UINT16 *) Bulk; + Bulk += 2; + Len -= 2; + } + + // + // Fold 32-bit sum to 16 bits + // + while ((Sum >> 16) != 0) { + Sum = (Sum & 0xffff) + (Sum >> 16); + + } + + return (UINT16) Sum; +} + + +/** + Add two checksums. + + @param[in] Checksum1 The first checksum to be added. + @param[in] Checksum2 The second checksum to be added. + + @return The new checksum. + +**/ +UINT16 +EFIAPI +NetAddChecksum ( + IN UINT16 Checksum1, + IN UINT16 Checksum2 + ) +{ + UINT32 Sum; + + Sum = Checksum1 + Checksum2; + + // + // two UINT16 can only add up to a carry of 1. + // + if ((Sum >> 16) != 0) { + Sum = (Sum & 0xffff) + 1; + + } + + return (UINT16) Sum; +} + + +/** + Compute the checksum for a NET_BUF. + + @param[in] Nbuf Pointer to the net buffer. + + @return The computed checksum. + +**/ +UINT16 +EFIAPI +NetbufChecksum ( + IN NET_BUF *Nbuf + ) +{ + NET_BLOCK_OP *BlockOp; + UINT32 Offset; + UINT16 TotalSum; + UINT16 BlockSum; + UINT32 Index; + + NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); + + TotalSum = 0; + Offset = 0; + BlockOp = Nbuf->BlockOp; + + for (Index = 0; Index < Nbuf->BlockOpNum; Index++) { + if (BlockOp[Index].Size == 0) { + continue; + } + + BlockSum = NetblockChecksum (BlockOp[Index].Head, BlockOp[Index].Size); + + if ((Offset & 0x01) != 0) { + // + // The checksum starts with an odd byte, swap + // the checksum before added to total checksum + // + BlockSum = SwapBytes16 (BlockSum); + } + + TotalSum = NetAddChecksum (BlockSum, TotalSum); + Offset += BlockOp[Index].Size; + } + + return TotalSum; +} + + +/** + Compute the checksum for TCP/UDP pseudo header. + + Src and Dst are in network byte order, and Len is in host byte order. + + @param[in] Src The source address of the packet. + @param[in] Dst The destination address of the packet. + @param[in] Proto The protocol type of the packet. + @param[in] Len The length of the packet. + + @return The computed checksum. + +**/ +UINT16 +EFIAPI +NetPseudoHeadChecksum ( + IN IP4_ADDR Src, + IN IP4_ADDR Dst, + IN UINT8 Proto, + IN UINT16 Len + ) +{ + NET_PSEUDO_HDR Hdr; + + // + // Zero the memory to relieve align problems + // + ZeroMem (&Hdr, sizeof (Hdr)); + + Hdr.SrcIp = Src; + Hdr.DstIp = Dst; + Hdr.Protocol = Proto; + Hdr.Len = HTONS (Len); + + return NetblockChecksum ((UINT8 *) &Hdr, sizeof (Hdr)); +} + +/** + Compute the checksum for TCP6/UDP6 pseudo header. + + Src and Dst are in network byte order, and Len is in host byte order. + + @param[in] Src The source address of the packet. + @param[in] Dst The destination address of the packet. + @param[in] NextHeader The protocol type of the packet. + @param[in] Len The length of the packet. + + @return The computed checksum. + +**/ +UINT16 +EFIAPI +NetIp6PseudoHeadChecksum ( + IN EFI_IPv6_ADDRESS *Src, + IN EFI_IPv6_ADDRESS *Dst, + IN UINT8 NextHeader, + IN UINT32 Len + ) +{ + NET_IP6_PSEUDO_HDR Hdr; + + // + // Zero the memory to relieve align problems + // + ZeroMem (&Hdr, sizeof (Hdr)); + + IP6_COPY_ADDRESS (&Hdr.SrcIp, Src); + IP6_COPY_ADDRESS (&Hdr.DstIp, Dst); + + Hdr.NextHeader = NextHeader; + Hdr.Len = HTONL (Len); + + return NetblockChecksum ((UINT8 *) &Hdr, sizeof (Hdr)); +} + +/** + The function frees the net buffer which allocated by the IP protocol. It releases + only the net buffer and doesn't call the external free function. + + This function should be called after finishing the process of mIpSec->ProcessExt() + for outbound traffic. The (EFI_IPSEC2_PROTOCOL)->ProcessExt() allocates a new + buffer for the ESP, so there needs a function to free the old net buffer. + + @param[in] Nbuf The network buffer to be freed. + +**/ +VOID +NetIpSecNetbufFree ( + NET_BUF *Nbuf + ) +{ + NET_CHECK_SIGNATURE (Nbuf, NET_BUF_SIGNATURE); + ASSERT (Nbuf->RefCnt > 0); + + Nbuf->RefCnt--; + + if (Nbuf->RefCnt == 0) { + + // + // Update Vector only when NBuf is to be released. That is, + // all the sharing of Nbuf increse Vector's RefCnt by one + // + NET_CHECK_SIGNATURE (Nbuf->Vector, NET_VECTOR_SIGNATURE); + ASSERT (Nbuf->Vector->RefCnt > 0); + + Nbuf->Vector->RefCnt--; + + if (Nbuf->Vector->RefCnt > 0) { + return; + } + + // + // If NET_VECTOR_OWN_FIRST is set, release the first block since it is + // allocated by us + // + if ((Nbuf->Vector->Flag & NET_VECTOR_OWN_FIRST) != 0) { + FreePool (Nbuf->Vector->Block[0].Bulk); + } + FreePool (Nbuf->Vector); + FreePool (Nbuf); + } +} + diff --git a/NetworkPkg/Library/DxeTcpIoLib/DxeTcpIoLib.c b/NetworkPkg/Library/DxeTcpIoLib/DxeTcpIoLib.c new file mode 100644 index 0000000000..341295d0b7 --- /dev/null +++ b/NetworkPkg/Library/DxeTcpIoLib/DxeTcpIoLib.c @@ -0,0 +1,1011 @@ +/** @file + This library is used to share code between UEFI network stack modules. + It provides the helper routines to access TCP service. + +Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include + +#include +#include +#include +#include +#include +#include + +/** + The common notify function associated with various TcpIo events. + + @param[in] Event The event signaled. + @param[in] Context The context. + +**/ +VOID +EFIAPI +TcpIoCommonNotify ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + if ((Event == NULL) || (Context == NULL)) { + return ; + } + + *((BOOLEAN *) Context) = TRUE; +} + +/** + The internal function for delay configuring TCP6 when IP6 driver is still in DAD. + + @param[in] Tcp6 The EFI_TCP6_PROTOCOL protocol instance. + @param[in] Tcp6ConfigData The Tcp6 configuration data. + + @retval EFI_SUCCESS The operational settings successfully + completed. + @retval EFI_INVALID_PARAMETER One or more parameters are invalid. + @retval Others Failed to finish the operation. + +**/ +EFI_STATUS +TcpIoGetMapping ( + IN EFI_TCP6_PROTOCOL *Tcp6, + IN EFI_TCP6_CONFIG_DATA *Tcp6ConfigData + ) +{ + EFI_STATUS Status; + EFI_EVENT Event; + + if ((Tcp6 == NULL) || (Tcp6ConfigData == NULL)) { + return EFI_INVALID_PARAMETER; + } + + Event = NULL; + Status = gBS->CreateEvent ( + EVT_TIMER, + TPL_CALLBACK, + NULL, + NULL, + &Event + ); + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } + + Status = gBS->SetTimer ( + Event, + TimerRelative, + TCP_GET_MAPPING_TIMEOUT + ); + + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } + + while (EFI_ERROR (gBS->CheckEvent (Event))) { + + Tcp6->Poll (Tcp6); + + Status = Tcp6->Configure (Tcp6, Tcp6ConfigData); + + if (!EFI_ERROR (Status)) { + break; + } + } + +ON_EXIT: + + if (Event != NULL) { + gBS->CloseEvent (Event); + } + + return Status; +} + +/** + Create a TCP socket with the specified configuration data. + + @param[in] Image The handle of the driver image. + @param[in] Controller The handle of the controller. + @param[in] TcpVersion The version of Tcp, TCP_VERSION_4 or TCP_VERSION_6. + @param[in] ConfigData The Tcp configuration data. + @param[out] TcpIo The TcpIo. + + @retval EFI_SUCCESS The TCP socket is created and configured. + @retval EFI_INVALID_PARAMETER One or more parameters are invalid. + @retval EFI_UNSUPPORTED One or more of the control options are not + supported in the implementation. + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory. + @retval Others Failed to create the TCP socket or configure it. + +**/ +EFI_STATUS +EFIAPI +TcpIoCreateSocket ( + IN EFI_HANDLE Image, + IN EFI_HANDLE Controller, + IN UINT8 TcpVersion, + IN TCP_IO_CONFIG_DATA *ConfigData, + OUT TCP_IO *TcpIo + ) +{ + EFI_STATUS Status; + EFI_EVENT Event; + EFI_GUID *ServiceBindingGuid; + EFI_GUID *ProtocolGuid; + VOID **Interface; + EFI_TCP4_OPTION ControlOption; + EFI_TCP4_CONFIG_DATA Tcp4ConfigData; + EFI_TCP4_ACCESS_POINT *AccessPoint4; + EFI_TCP4_PROTOCOL *Tcp4; + EFI_TCP6_CONFIG_DATA Tcp6ConfigData; + EFI_TCP6_ACCESS_POINT *AccessPoint6; + EFI_TCP6_PROTOCOL *Tcp6; + EFI_TCP4_RECEIVE_DATA *RxData; + + if ((Image == NULL) || (Controller == NULL) || (ConfigData == NULL) || (TcpIo == NULL)) { + return EFI_INVALID_PARAMETER; + } + + Tcp4 = NULL; + Tcp6 = NULL; + + ZeroMem (TcpIo, sizeof (TCP_IO)); + + if (TcpVersion == TCP_VERSION_4) { + ServiceBindingGuid = &gEfiTcp4ServiceBindingProtocolGuid; + ProtocolGuid = &gEfiTcp4ProtocolGuid; + Interface = (VOID **) (&TcpIo->Tcp.Tcp4); + } else if (TcpVersion == TCP_VERSION_6) { + ServiceBindingGuid = &gEfiTcp6ServiceBindingProtocolGuid; + ProtocolGuid = &gEfiTcp6ProtocolGuid; + Interface = (VOID **) (&TcpIo->Tcp.Tcp6); + } else { + return EFI_UNSUPPORTED; + } + + TcpIo->TcpVersion = TcpVersion; + + // + // Create the TCP child instance and get the TCP protocol. + // + Status = NetLibCreateServiceChild ( + Controller, + Image, + ServiceBindingGuid, + &TcpIo->Handle + ); + if (EFI_ERROR (Status)) { + return Status; + } + + Status = gBS->OpenProtocol ( + TcpIo->Handle, + ProtocolGuid, + Interface, + Image, + Controller, + EFI_OPEN_PROTOCOL_BY_DRIVER + ); + if (EFI_ERROR (Status) || (*Interface == NULL)) { + goto ON_ERROR; + } + + if (TcpVersion == TCP_VERSION_4) { + Tcp4 = TcpIo->Tcp.Tcp4; + } else { + Tcp6 = TcpIo->Tcp.Tcp6; + } + + TcpIo->Image = Image; + TcpIo->Controller = Controller; + + // + // Set the configuration parameters. + // + ControlOption.ReceiveBufferSize = 0x200000; + ControlOption.SendBufferSize = 0x200000; + ControlOption.MaxSynBackLog = 0; + ControlOption.ConnectionTimeout = 0; + ControlOption.DataRetries = 6; + ControlOption.FinTimeout = 0; + ControlOption.TimeWaitTimeout = 0; + ControlOption.KeepAliveProbes = 4; + ControlOption.KeepAliveTime = 0; + ControlOption.KeepAliveInterval = 0; + ControlOption.EnableNagle = FALSE; + ControlOption.EnableTimeStamp = FALSE; + ControlOption.EnableWindowScaling = TRUE; + ControlOption.EnableSelectiveAck = FALSE; + ControlOption.EnablePathMtuDiscovery = FALSE; + + if (TcpVersion == TCP_VERSION_4) { + Tcp4ConfigData.TypeOfService = 8; + Tcp4ConfigData.TimeToLive = 255; + Tcp4ConfigData.ControlOption = &ControlOption; + + AccessPoint4 = &Tcp4ConfigData.AccessPoint; + + ZeroMem (AccessPoint4, sizeof (EFI_TCP4_ACCESS_POINT)); + AccessPoint4->StationPort = ConfigData->Tcp4IoConfigData.StationPort; + AccessPoint4->RemotePort = ConfigData->Tcp4IoConfigData.RemotePort; + AccessPoint4->ActiveFlag = ConfigData->Tcp4IoConfigData.ActiveFlag; + + CopyMem ( + &AccessPoint4->StationAddress, + &ConfigData->Tcp4IoConfigData.LocalIp, + sizeof (EFI_IPv4_ADDRESS) + ); + CopyMem ( + &AccessPoint4->SubnetMask, + &ConfigData->Tcp4IoConfigData.SubnetMask, + sizeof (EFI_IPv4_ADDRESS) + ); + CopyMem ( + &AccessPoint4->RemoteAddress, + &ConfigData->Tcp4IoConfigData.RemoteIp, + sizeof (EFI_IPv4_ADDRESS) + ); + + ASSERT (Tcp4 != NULL); + + // + // Configure the TCP4 protocol. + // + Status = Tcp4->Configure (Tcp4, &Tcp4ConfigData); + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + if (!EFI_IP4_EQUAL (&ConfigData->Tcp4IoConfigData.Gateway, &mZeroIp4Addr)) { + // + // The gateway is not zero. Add the default route manually. + // + Status = Tcp4->Routes ( + Tcp4, + FALSE, + &mZeroIp4Addr, + &mZeroIp4Addr, + &ConfigData->Tcp4IoConfigData.Gateway + ); + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + } + } else { + Tcp6ConfigData.TrafficClass = 0; + Tcp6ConfigData.HopLimit = 255; + Tcp6ConfigData.ControlOption = (EFI_TCP6_OPTION *) &ControlOption; + + AccessPoint6 = &Tcp6ConfigData.AccessPoint; + + ZeroMem (AccessPoint6, sizeof (EFI_TCP6_ACCESS_POINT)); + AccessPoint6->StationPort = ConfigData->Tcp6IoConfigData.StationPort; + AccessPoint6->RemotePort = ConfigData->Tcp6IoConfigData.RemotePort; + AccessPoint6->ActiveFlag = ConfigData->Tcp6IoConfigData.ActiveFlag; + + IP6_COPY_ADDRESS (&AccessPoint6->RemoteAddress, &ConfigData->Tcp6IoConfigData.RemoteIp); + + + ASSERT (Tcp6 != NULL); + // + // Configure the TCP6 protocol. + // + Status = Tcp6->Configure (Tcp6, &Tcp6ConfigData); + if (Status == EFI_NO_MAPPING) { + Status = TcpIoGetMapping (Tcp6, &Tcp6ConfigData); + } + + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + } + + // + // Create events for variuos asynchronous operations. + // + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, + TcpIoCommonNotify, + &TcpIo->IsConnDone, + &Event + ); + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + TcpIo->ConnToken.Tcp4Token.CompletionToken.Event = Event; + + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, + TcpIoCommonNotify, + &TcpIo->IsListenDone, + &Event + ); + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + TcpIo->ListenToken.Tcp4Token.CompletionToken.Event = Event; + + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, + TcpIoCommonNotify, + &TcpIo->IsTxDone, + &Event + ); + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + TcpIo->TxToken.Tcp4Token.CompletionToken.Event = Event; + + + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, + TcpIoCommonNotify, + &TcpIo->IsRxDone, + &Event + ); + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + TcpIo->RxToken.Tcp4Token.CompletionToken.Event = Event; + + RxData = (EFI_TCP4_RECEIVE_DATA *) AllocateZeroPool (sizeof (EFI_TCP4_RECEIVE_DATA)); + if (RxData == NULL) { + Status = EFI_OUT_OF_RESOURCES; + goto ON_ERROR; + } + + TcpIo->RxToken.Tcp4Token.Packet.RxData = RxData; + + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, + TcpIoCommonNotify, + &TcpIo->IsCloseDone, + &Event + ); + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + TcpIo->CloseToken.Tcp4Token.CompletionToken.Event = Event; + + + return EFI_SUCCESS; + +ON_ERROR: + + TcpIoDestroySocket (TcpIo); + + return Status; +} + +/** + Destroy the socket. + + @param[in] TcpIo The TcpIo which wraps the socket to be destroyed. + +**/ +VOID +EFIAPI +TcpIoDestroySocket ( + IN TCP_IO *TcpIo + ) +{ + EFI_EVENT Event; + EFI_TCP4_PROTOCOL *Tcp4; + EFI_TCP6_PROTOCOL *Tcp6; + UINT8 TcpVersion; + EFI_GUID *ServiceBindingGuid; + EFI_GUID *ProtocolGuid; + EFI_HANDLE ChildHandle; + + if (TcpIo == NULL) { + return ; + } + + TcpVersion = TcpIo->TcpVersion; + + if ((TcpVersion != TCP_VERSION_4) && (TcpVersion != TCP_VERSION_6)) { + return ; + } + + Event = TcpIo->ConnToken.Tcp4Token.CompletionToken.Event; + + if (Event != NULL) { + gBS->CloseEvent (Event); + } + + Event = TcpIo->ListenToken.Tcp4Token.CompletionToken.Event; + + if (Event != NULL) { + gBS->CloseEvent (Event); + } + + Event = TcpIo->TxToken.Tcp4Token.CompletionToken.Event; + + if (Event != NULL) { + gBS->CloseEvent (Event); + } + + Event = TcpIo->RxToken.Tcp4Token.CompletionToken.Event; + + if (Event != NULL) { + gBS->CloseEvent (Event); + } + + Event = TcpIo->CloseToken.Tcp4Token.CompletionToken.Event; + + if (Event != NULL) { + gBS->CloseEvent (Event); + } + + if (TcpIo->RxToken.Tcp4Token.Packet.RxData != NULL) { + FreePool (TcpIo->RxToken.Tcp4Token.Packet.RxData); + } + + Tcp4 = NULL; + Tcp6 = NULL; + + + if (TcpVersion == TCP_VERSION_4) { + ServiceBindingGuid = &gEfiTcp4ServiceBindingProtocolGuid; + ProtocolGuid = &gEfiTcp4ProtocolGuid; + Tcp4 = TcpIo->Tcp.Tcp4; + if (Tcp4 != NULL) { + Tcp4->Configure (Tcp4, NULL); + } + } else { + ServiceBindingGuid = &gEfiTcp6ServiceBindingProtocolGuid; + ProtocolGuid = &gEfiTcp6ProtocolGuid; + Tcp6 = TcpIo->Tcp.Tcp6; + if (Tcp6 != NULL) { + Tcp6->Configure (Tcp6, NULL); + } + } + + if ((Tcp4 != NULL) || (Tcp6 != NULL)) { + + gBS->CloseProtocol ( + TcpIo->Handle, + ProtocolGuid, + TcpIo->Image, + TcpIo->Controller + ); + } + + ChildHandle = NULL; + + if (TcpIo->IsListenDone) { + if (TcpVersion == TCP_VERSION_4) { + Tcp4 = TcpIo->NewTcp.Tcp4; + if (Tcp4 != NULL) { + Tcp4->Configure (Tcp4, NULL); + ChildHandle = TcpIo->ListenToken.Tcp4Token.NewChildHandle; + } + } else { + Tcp6 = TcpIo->NewTcp.Tcp6; + if (Tcp6 != NULL) { + Tcp6->Configure (Tcp6, NULL); + ChildHandle = TcpIo->ListenToken.Tcp6Token.NewChildHandle; + } + } + + if (ChildHandle != NULL) { + + gBS->CloseProtocol ( + ChildHandle, + ProtocolGuid, + TcpIo->Image, + TcpIo->Controller + ); + } + } + + NetLibDestroyServiceChild ( + TcpIo->Controller, + TcpIo->Image, + ServiceBindingGuid, + TcpIo->Handle + ); +} + +/** + Connect to the other endpoint of the TCP socket. + + @param[in, out] TcpIo The TcpIo wrapping the TCP socket. + @param[in] Timeout The time to wait for connection done. Set to NULL for infinite wait. + + @retval EFI_SUCCESS Connect to the other endpoint of the TCP socket + successfully. + @retval EFI_TIMEOUT Failed to connect to the other endpoint of the + TCP socket in the specified time period. + @retval EFI_INVALID_PARAMETER One or more parameters are invalid. + @retval EFI_UNSUPPORTED One or more of the control options are not + supported in the implementation. + @retval Others Other errors as indicated. + +**/ +EFI_STATUS +EFIAPI +TcpIoConnect ( + IN OUT TCP_IO *TcpIo, + IN EFI_EVENT Timeout OPTIONAL + ) +{ + EFI_TCP4_PROTOCOL *Tcp4; + EFI_TCP6_PROTOCOL *Tcp6; + EFI_STATUS Status; + + if ((TcpIo == NULL) || (TcpIo->Tcp.Tcp4 == NULL)) { + return EFI_INVALID_PARAMETER; + } + + TcpIo->IsConnDone = FALSE; + + Tcp4 = NULL; + Tcp6 = NULL; + + if (TcpIo->TcpVersion == TCP_VERSION_4) { + Tcp4 = TcpIo->Tcp.Tcp4; + Status = Tcp4->Connect (Tcp4, &TcpIo->ConnToken.Tcp4Token); + } else if (TcpIo->TcpVersion == TCP_VERSION_6) { + Tcp6 = TcpIo->Tcp.Tcp6; + Status = Tcp6->Connect (Tcp6, &TcpIo->ConnToken.Tcp6Token); + } else { + return EFI_UNSUPPORTED; + } + + if (EFI_ERROR (Status)) { + return Status; + } + + while (!TcpIo->IsConnDone && ((Timeout == NULL) || EFI_ERROR (gBS->CheckEvent (Timeout)))) { + if (TcpIo->TcpVersion == TCP_VERSION_4) { + Tcp4->Poll (Tcp4); + } else { + Tcp6->Poll (Tcp6); + } + } + + if (!TcpIo->IsConnDone) { + if (TcpIo->TcpVersion == TCP_VERSION_4) { + Tcp4->Cancel (Tcp4, &TcpIo->ConnToken.Tcp4Token.CompletionToken); + } else { + Tcp6->Cancel (Tcp6, &TcpIo->ConnToken.Tcp6Token.CompletionToken); + } + Status = EFI_TIMEOUT; + } else { + Status = TcpIo->ConnToken.Tcp4Token.CompletionToken.Status; + } + + return Status; +} + +/** + Accept the incomding request from the other endpoint of the TCP socket. + + @param[in, out] TcpIo The TcpIo wrapping the TCP socket. + @param[in] Timeout The time to wait for connection done. Set to NULL for infinite wait. + + + @retval EFI_SUCCESS Connect to the other endpoint of the TCP socket + successfully. + @retval EFI_INVALID_PARAMETER One or more parameters are invalid. + @retval EFI_UNSUPPORTED One or more of the control options are not + supported in the implementation. + + @retval EFI_TIMEOUT Failed to connect to the other endpoint of the + TCP socket in the specified time period. + @retval Others Other errors as indicated. + +**/ +EFI_STATUS +EFIAPI +TcpIoAccept ( + IN OUT TCP_IO *TcpIo, + IN EFI_EVENT Timeout OPTIONAL + ) +{ + EFI_STATUS Status; + EFI_GUID *ProtocolGuid; + EFI_TCP4_PROTOCOL *Tcp4; + EFI_TCP6_PROTOCOL *Tcp6; + + if ((TcpIo == NULL) || (TcpIo->Tcp.Tcp4 == NULL)) { + return EFI_INVALID_PARAMETER; + } + + TcpIo->IsListenDone = FALSE; + + Tcp4 = NULL; + Tcp6 = NULL; + + if (TcpIo->TcpVersion == TCP_VERSION_4) { + Tcp4 = TcpIo->Tcp.Tcp4; + Status = Tcp4->Accept (Tcp4, &TcpIo->ListenToken.Tcp4Token); + } else if (TcpIo->TcpVersion == TCP_VERSION_6) { + Tcp6 = TcpIo->Tcp.Tcp6; + Status = Tcp6->Accept (Tcp6, &TcpIo->ListenToken.Tcp6Token); + } else { + return EFI_UNSUPPORTED; + } + + if (EFI_ERROR (Status)) { + return Status; + } + + while (!TcpIo->IsListenDone && ((Timeout == NULL) || EFI_ERROR (gBS->CheckEvent (Timeout)))) { + if (TcpIo->TcpVersion == TCP_VERSION_4) { + Tcp4->Poll (Tcp4); + } else { + Tcp6->Poll (Tcp6); + } + } + + if (!TcpIo->IsListenDone) { + if (TcpIo->TcpVersion == TCP_VERSION_4) { + Tcp4->Cancel (Tcp4, &TcpIo->ListenToken.Tcp4Token.CompletionToken); + } else { + Tcp6->Cancel (Tcp6, &TcpIo->ListenToken.Tcp6Token.CompletionToken); + } + Status = EFI_TIMEOUT; + } else { + Status = TcpIo->ListenToken.Tcp4Token.CompletionToken.Status; + } + + // + // The new TCP instance handle created for the established connection is + // in ListenToken. + // + if (!EFI_ERROR (Status)) { + if (TcpIo->TcpVersion == TCP_VERSION_4) { + ProtocolGuid = &gEfiTcp4ProtocolGuid; + } else { + ProtocolGuid = &gEfiTcp6ProtocolGuid; + } + + Status = gBS->OpenProtocol ( + TcpIo->ListenToken.Tcp4Token.NewChildHandle, + ProtocolGuid, + (VOID **) (&TcpIo->NewTcp.Tcp4), + TcpIo->Image, + TcpIo->Controller, + EFI_OPEN_PROTOCOL_BY_DRIVER + ); + + } + + return Status; +} + +/** + Reset the socket. + + @param[in, out] TcpIo The TcpIo wrapping the TCP socket. + +**/ +VOID +EFIAPI +TcpIoReset ( + IN OUT TCP_IO *TcpIo + ) +{ + EFI_TCP4_PROTOCOL *Tcp4; + EFI_TCP6_PROTOCOL *Tcp6; + EFI_STATUS Status; + + if ((TcpIo == NULL) || (TcpIo->Tcp.Tcp4 == NULL)) { + return ; + } + + TcpIo->IsCloseDone = FALSE; + Tcp4 = NULL; + Tcp6 = NULL; + + if (TcpIo->TcpVersion == TCP_VERSION_4) { + TcpIo->CloseToken.Tcp4Token.AbortOnClose = TRUE; + Tcp4 = TcpIo->Tcp.Tcp4; + Status = Tcp4->Close (Tcp4, &TcpIo->CloseToken.Tcp4Token); + } else if (TcpIo->TcpVersion == TCP_VERSION_6) { + TcpIo->CloseToken.Tcp6Token.AbortOnClose = TRUE; + Tcp6 = TcpIo->Tcp.Tcp6; + Status = Tcp6->Close (Tcp6, &TcpIo->CloseToken.Tcp6Token); + } else { + return ; + } + + if (EFI_ERROR (Status)) { + return ; + } + + while (!TcpIo->IsCloseDone) { + if (TcpIo->TcpVersion == TCP_VERSION_4) { + Tcp4->Poll (Tcp4); + } else { + Tcp6->Poll (Tcp6); + } + } +} + + +/** + Transmit the Packet to the other endpoint of the socket. + + @param[in] TcpIo The TcpIo wrapping the TCP socket. + @param[in] Packet The packet to transmit. + + @retval EFI_SUCCESS The packet is trasmitted. + @retval EFI_INVALID_PARAMETER One or more parameters are invalid. + @retval EFI_UNSUPPORTED One or more of the control options are not + supported in the implementation. + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory. + @retval EFI_DEVICE_ERROR An unexpected network or system error occurred. + @retval Others Other errors as indicated. + +**/ +EFI_STATUS +EFIAPI +TcpIoTransmit ( + IN TCP_IO *TcpIo, + IN NET_BUF *Packet + ) +{ + EFI_STATUS Status; + VOID *Data; + EFI_TCP4_PROTOCOL *Tcp4; + EFI_TCP6_PROTOCOL *Tcp6; + UINTN Size; + + if ((TcpIo == NULL) || (TcpIo->Tcp.Tcp4 == NULL)|| (Packet == NULL)) { + return EFI_INVALID_PARAMETER; + } + + if (TcpIo->TcpVersion == TCP_VERSION_4) { + + Size = sizeof (EFI_TCP4_TRANSMIT_DATA) + + (Packet->BlockOpNum - 1) * sizeof (EFI_TCP4_FRAGMENT_DATA); + } else if (TcpIo->TcpVersion == TCP_VERSION_6) { + Size = sizeof (EFI_TCP6_TRANSMIT_DATA) + + (Packet->BlockOpNum - 1) * sizeof (EFI_TCP6_FRAGMENT_DATA); + } else { + return EFI_UNSUPPORTED; + } + + Data = AllocatePool (Size); + if (Data == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + ((EFI_TCP4_TRANSMIT_DATA *) Data)->Push = TRUE; + ((EFI_TCP4_TRANSMIT_DATA *) Data)->Urgent = FALSE; + ((EFI_TCP4_TRANSMIT_DATA *) Data)->DataLength = Packet->TotalSize; + + // + // Build the fragment table. + // + ((EFI_TCP4_TRANSMIT_DATA *) Data)->FragmentCount = Packet->BlockOpNum; + + NetbufBuildExt ( + Packet, + (NET_FRAGMENT *) &((EFI_TCP4_TRANSMIT_DATA *) Data)->FragmentTable[0], + &((EFI_TCP4_TRANSMIT_DATA *) Data)->FragmentCount + ); + + Tcp4 = NULL; + Tcp6 = NULL; + Status = EFI_DEVICE_ERROR; + + // + // Trasnmit the packet. + // + if (TcpIo->TcpVersion == TCP_VERSION_4) { + TcpIo->TxToken.Tcp4Token.Packet.TxData = (EFI_TCP4_TRANSMIT_DATA *) Data; + Tcp4 = TcpIo->Tcp.Tcp4; + if (TcpIo->IsListenDone) { + Tcp4 = TcpIo->NewTcp.Tcp4; + } + + if (Tcp4 == NULL) { + goto ON_EXIT; + } + + Status = Tcp4->Transmit (Tcp4, &TcpIo->TxToken.Tcp4Token); + } else { + TcpIo->TxToken.Tcp6Token.Packet.TxData = (EFI_TCP6_TRANSMIT_DATA *) Data; + Tcp6 = TcpIo->Tcp.Tcp6; + if (TcpIo->IsListenDone) { + Tcp6 = TcpIo->NewTcp.Tcp6; + } + + if (Tcp6 == NULL) { + goto ON_EXIT; + } + + Status = Tcp6->Transmit (Tcp6, &TcpIo->TxToken.Tcp6Token); + } + + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } + + while (!TcpIo->IsTxDone) { + if (TcpIo->TcpVersion == TCP_VERSION_4) { + Tcp4->Poll (Tcp4); + } else { + Tcp6->Poll (Tcp6); + } + } + + TcpIo->IsTxDone = FALSE; + Status = TcpIo->TxToken.Tcp4Token.CompletionToken.Status; + +ON_EXIT: + + FreePool (Data); + + return Status; +} + +/** + Receive data from the socket. + + @param[in, out] TcpIo The TcpIo which wraps the socket to be destroyed. + @param[in] Packet The buffer to hold the data copy from the socket rx buffer. + @param[in] AsyncMode Is this receive asyncronous or not. + @param[in] Timeout The time to wait for receiving the amount of data the Packet + can hold. Set to NULL for infinite wait. + + @retval EFI_SUCCESS The required amount of data is received from the socket. + @retval EFI_INVALID_PARAMETER One or more parameters are invalid. + @retval EFI_DEVICE_ERROR An unexpected network or system error occurred. + @retval EFI_OUT_OF_RESOURCES Failed to allocate momery. + @retval EFI_TIMEOUT Failed to receive the required amount of data in the + specified time period. + @retval Others Other errors as indicated. + +**/ +EFI_STATUS +EFIAPI +TcpIoReceive ( + IN OUT TCP_IO *TcpIo, + IN NET_BUF *Packet, + IN BOOLEAN AsyncMode, + IN EFI_EVENT Timeout OPTIONAL + ) +{ + EFI_TCP4_PROTOCOL *Tcp4; + EFI_TCP6_PROTOCOL *Tcp6; + EFI_TCP4_RECEIVE_DATA *RxData; + EFI_STATUS Status; + NET_FRAGMENT *Fragment; + UINT32 FragmentCount; + UINT32 CurrentFragment; + + if ((TcpIo == NULL) || (TcpIo->Tcp.Tcp4 == NULL)|| (Packet == NULL)) { + return EFI_INVALID_PARAMETER; + } + + RxData = TcpIo->RxToken.Tcp4Token.Packet.RxData; + if (RxData == NULL) { + return EFI_INVALID_PARAMETER; + } + + Tcp4 = NULL; + Tcp6 = NULL; + + if (TcpIo->TcpVersion == TCP_VERSION_4) { + Tcp4 = TcpIo->Tcp.Tcp4; + + if (TcpIo->IsListenDone) { + Tcp4 = TcpIo->NewTcp.Tcp4; + } + + if (Tcp4 == NULL) { + return EFI_DEVICE_ERROR; + } + + } else if (TcpIo->TcpVersion == TCP_VERSION_6) { + Tcp6 = TcpIo->Tcp.Tcp6; + + if (TcpIo->IsListenDone) { + Tcp6 = TcpIo->NewTcp.Tcp6; + } + + if (Tcp6 == NULL) { + return EFI_DEVICE_ERROR; + } + + } else { + return EFI_UNSUPPORTED; + } + + FragmentCount = Packet->BlockOpNum; + Fragment = AllocatePool (FragmentCount * sizeof (NET_FRAGMENT)); + if (Fragment == NULL) { + Status = EFI_OUT_OF_RESOURCES; + goto ON_EXIT; + } + // + // Build the fragment table. + // + NetbufBuildExt (Packet, Fragment, &FragmentCount); + + RxData->FragmentCount = 1; + CurrentFragment = 0; + Status = EFI_SUCCESS; + + while (CurrentFragment < FragmentCount) { + RxData->DataLength = Fragment[CurrentFragment].Len; + RxData->FragmentTable[0].FragmentLength = Fragment[CurrentFragment].Len; + RxData->FragmentTable[0].FragmentBuffer = Fragment[CurrentFragment].Bulk; + + if (TcpIo->TcpVersion == TCP_VERSION_4) { + Status = Tcp4->Receive (Tcp4, &TcpIo->RxToken.Tcp4Token); + } else { + Status = Tcp6->Receive (Tcp6, &TcpIo->RxToken.Tcp6Token); + } + + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } + + while (!TcpIo->IsRxDone && ((Timeout == NULL) || EFI_ERROR (gBS->CheckEvent (Timeout)))) { + // + // Poll until some data is received or an error occurs. + // + if (TcpIo->TcpVersion == TCP_VERSION_4) { + Tcp4->Poll (Tcp4); + } else { + Tcp6->Poll (Tcp6); + } + } + + if (!TcpIo->IsRxDone) { + // + // Timeout occurs, cancel the receive request. + // + if (TcpIo->TcpVersion == TCP_VERSION_4) { + Tcp4->Cancel (Tcp4, &TcpIo->RxToken.Tcp4Token.CompletionToken); + } else { + Tcp6->Cancel (Tcp6, &TcpIo->RxToken.Tcp6Token.CompletionToken); + } + + Status = EFI_TIMEOUT; + goto ON_EXIT; + } else { + TcpIo->IsRxDone = FALSE; + } + + Status = TcpIo->RxToken.Tcp4Token.CompletionToken.Status; + + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } + + Fragment[CurrentFragment].Len -= RxData->FragmentTable[0].FragmentLength; + if (Fragment[CurrentFragment].Len == 0) { + CurrentFragment++; + } else { + Fragment[CurrentFragment].Bulk += RxData->FragmentTable[0].FragmentLength; + } + } + +ON_EXIT: + + if (Fragment != NULL) { + FreePool (Fragment); + } + + return Status; +} diff --git a/NetworkPkg/Library/DxeTcpIoLib/DxeTcpIoLib.inf b/NetworkPkg/Library/DxeTcpIoLib/DxeTcpIoLib.inf new file mode 100644 index 0000000000..66873d7837 --- /dev/null +++ b/NetworkPkg/Library/DxeTcpIoLib/DxeTcpIoLib.inf @@ -0,0 +1,44 @@ +## @file +# This library instance provides TCP services by EFI TCPv4/TCPv6 Protocols. +# +# Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.
+# SPDX-License-Identifier: BSD-2-Clause-Patent +# +## + + +[Defines] + INF_VERSION = 0x00010005 + BASE_NAME = DxeTcpIoLib + MODULE_UNI_FILE = DxeTcpIoLib.uni + FILE_GUID = D4608509-1AB0-4cc7-827A-AB8E1E7BD3E6 + MODULE_TYPE = DXE_DRIVER + VERSION_STRING = 1.0 + LIBRARY_CLASS = TcpIoLib|DXE_CORE DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER + +# +# The following information is for reference only and not required by the build tools. +# +# VALID_ARCHITECTURES = IA32 X64 EBC +# + +[Sources] + DxeTcpIoLib.c + +[Packages] + MdePkg/MdePkg.dec + MdeModulePkg/MdeModulePkg.dec + + +[LibraryClasses] + BaseLib + DebugLib + UefiBootServicesTableLib + MemoryAllocationLib + BaseMemoryLib + +[Protocols] + gEfiTcp4ServiceBindingProtocolGuid ## SOMETIMES_CONSUMES + gEfiTcp4ProtocolGuid ## SOMETIMES_CONSUMES + gEfiTcp6ServiceBindingProtocolGuid ## SOMETIMES_CONSUMES + gEfiTcp6ProtocolGuid ## SOMETIMES_CONSUMES diff --git a/NetworkPkg/Library/DxeTcpIoLib/DxeTcpIoLib.uni b/NetworkPkg/Library/DxeTcpIoLib/DxeTcpIoLib.uni new file mode 100644 index 0000000000..79ad484a65 --- /dev/null +++ b/NetworkPkg/Library/DxeTcpIoLib/DxeTcpIoLib.uni @@ -0,0 +1,16 @@ +// /** @file +// This library instance provides TCP services by EFI TCPv4/TCPv6 Protocols. +// +// This library instance provides TCP services by EFI TCPv4/TCPv6 Protocols. +// +// Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.
+// +// SPDX-License-Identifier: BSD-2-Clause-Patent +// +// **/ + + +#string STR_MODULE_ABSTRACT #language en-US "Provides TCP services by EFI TCPv4/TCPv6 Protocols" + +#string STR_MODULE_DESCRIPTION #language en-US "This library instance provides TCP services by EFI TCPv4/TCPv6 Protocols." + diff --git a/NetworkPkg/Library/DxeUdpIoLib/DxeUdpIoLib.c b/NetworkPkg/Library/DxeUdpIoLib/DxeUdpIoLib.c new file mode 100644 index 0000000000..155cb31049 --- /dev/null +++ b/NetworkPkg/Library/DxeUdpIoLib/DxeUdpIoLib.c @@ -0,0 +1,1119 @@ +/** @file + Help functions to access UDP service, it is used by both the DHCP and MTFTP. + +Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent +**/ + +#include + +#include +#include + +#include +#include +#include +#include +#include +#include +#include + + +/** + Free a UDP_TX_TOKEN. The TX event is closed. + + @param[in] TxToken The UDP_TX_TOKEN to release. + +**/ +VOID +UdpIoFreeTxToken ( + IN UDP_TX_TOKEN *TxToken + ) +{ + + if (TxToken->UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { + gBS->CloseEvent (TxToken->Token.Udp4.Event); + } else if (TxToken->UdpIo->UdpVersion == UDP_IO_UDP6_VERSION) { + gBS->CloseEvent (TxToken->Token.Udp6.Event); + } else { + ASSERT (FALSE); + } + + FreePool (TxToken); +} + +/** + Free a UDP_RX_TOKEN. The RX event is closed. + + @param[in] RxToken The UDP_RX_TOKEN to release. + +**/ +VOID +UdpIoFreeRxToken ( + IN UDP_RX_TOKEN *RxToken + ) +{ + if (RxToken->UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { + gBS->CloseEvent (RxToken->Token.Udp4.Event); + } else if (RxToken->UdpIo->UdpVersion == UDP_IO_UDP6_VERSION) { + gBS->CloseEvent (RxToken->Token.Udp6.Event); + } else { + ASSERT (FALSE); + } + + FreePool (RxToken); +} + +/** + The callback function when the packet is sent by UDP. + + It will remove the packet from the local list then call + the packet owner's callback function set by UdpIoSendDatagram. + + @param[in] Context The UDP TX Token. + +**/ +VOID +EFIAPI +UdpIoOnDgramSentDpc ( + IN VOID *Context + ) +{ + UDP_TX_TOKEN *TxToken; + + TxToken = (UDP_TX_TOKEN *) Context; + ASSERT (TxToken->Signature == UDP_IO_TX_SIGNATURE); + ASSERT ((TxToken->UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) || + (TxToken->UdpIo->UdpVersion == UDP_IO_UDP6_VERSION)); + + RemoveEntryList (&TxToken->Link); + + if (TxToken->UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { + TxToken->CallBack (TxToken->Packet, NULL, TxToken->Token.Udp4.Status, TxToken->Context); + } else { + TxToken->CallBack (TxToken->Packet, NULL, TxToken->Token.Udp6.Status, TxToken->Context); + } + + UdpIoFreeTxToken (TxToken); +} + +/** + Request UdpIoOnDgramSentDpc as a DPC at TPL_CALLBACK. + + @param[in] Event The event signaled. + @param[in] Context The UDP TX Token. + +**/ +VOID +EFIAPI +UdpIoOnDgramSent ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + // + // Request UdpIoOnDgramSentDpc as a DPC at TPL_CALLBACK + // + QueueDpc (TPL_CALLBACK, UdpIoOnDgramSentDpc, Context); +} + +/** + Recycle the received UDP data. + + @param[in] Context The UDP_RX_TOKEN. + +**/ +VOID +EFIAPI +UdpIoRecycleDgram ( + IN VOID *Context + ) +{ + UDP_RX_TOKEN *RxToken; + + RxToken = (UDP_RX_TOKEN *) Context; + + if (RxToken->UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { + gBS->SignalEvent (RxToken->Token.Udp4.Packet.RxData->RecycleSignal); + } else if (RxToken->UdpIo->UdpVersion == UDP_IO_UDP6_VERSION) { + gBS->SignalEvent (RxToken->Token.Udp6.Packet.RxData->RecycleSignal); + } else { + ASSERT (FALSE); + } + + UdpIoFreeRxToken (RxToken); +} + +/** + The event handle for UDP receive request. + + It will build a NET_BUF from the recieved UDP data, then deliver it + to the receiver. + + @param[in] Context The UDP RX token. + +**/ +VOID +EFIAPI +UdpIoOnDgramRcvdDpc ( + IN VOID *Context + ) +{ + EFI_STATUS Status; + VOID *Token; + VOID *RxData; + VOID *Session; + UDP_RX_TOKEN *RxToken; + UDP_END_POINT EndPoint; + NET_BUF *Netbuf; + + RxToken = (UDP_RX_TOKEN *) Context; + + ZeroMem (&EndPoint, sizeof(UDP_END_POINT)); + + ASSERT ((RxToken->Signature == UDP_IO_RX_SIGNATURE) && + (RxToken == RxToken->UdpIo->RecvRequest)); + + ASSERT ((RxToken->UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) || + (RxToken->UdpIo->UdpVersion == UDP_IO_UDP6_VERSION)); + + // + // Clear the receive request first in case that the caller + // wants to restart the receive in the callback. + // + RxToken->UdpIo->RecvRequest = NULL; + + if (RxToken->UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { + Token = &RxToken->Token.Udp4; + RxData = ((EFI_UDP4_COMPLETION_TOKEN *) Token)->Packet.RxData; + Status = ((EFI_UDP4_COMPLETION_TOKEN *) Token)->Status; + } else { + Token = &RxToken->Token.Udp6; + RxData = ((EFI_UDP6_COMPLETION_TOKEN *) Token)->Packet.RxData; + Status = ((EFI_UDP6_COMPLETION_TOKEN *) Token)->Status; + } + + if (EFI_ERROR (Status) || RxData == NULL) { + if (Status != EFI_ABORTED) { + // + // Invoke the CallBack only if the reception is not actively aborted. + // + RxToken->CallBack (NULL, NULL, Status, RxToken->Context); + } + + UdpIoFreeRxToken (RxToken); + return; + } + + // + // Build a NET_BUF from the UDP receive data, then deliver it up. + // + if (RxToken->UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { + if (((EFI_UDP4_RECEIVE_DATA *) RxData)->DataLength == 0) { + // + // Discard zero length data payload packet. + // + goto Resume; + } + + Netbuf = NetbufFromExt ( + (NET_FRAGMENT *)((EFI_UDP4_RECEIVE_DATA *) RxData)->FragmentTable, + ((EFI_UDP4_RECEIVE_DATA *) RxData)->FragmentCount, + 0, + (UINT32) RxToken->HeadLen, + UdpIoRecycleDgram, + RxToken + ); + + if (Netbuf == NULL) { + gBS->SignalEvent (((EFI_UDP4_RECEIVE_DATA *) RxData)->RecycleSignal); + RxToken->CallBack (NULL, NULL, EFI_OUT_OF_RESOURCES, RxToken->Context); + + UdpIoFreeRxToken (RxToken); + return; + } + + Session = &((EFI_UDP4_RECEIVE_DATA *) RxData)->UdpSession; + EndPoint.LocalPort = ((EFI_UDP4_SESSION_DATA *) Session)->DestinationPort; + EndPoint.RemotePort = ((EFI_UDP4_SESSION_DATA *) Session)->SourcePort; + + CopyMem ( + &EndPoint.LocalAddr, + &((EFI_UDP4_SESSION_DATA *) Session)->DestinationAddress, + sizeof (EFI_IPv4_ADDRESS) + ); + + CopyMem ( + &EndPoint.RemoteAddr, + &((EFI_UDP4_SESSION_DATA *) Session)->SourceAddress, + sizeof (EFI_IPv4_ADDRESS) + ); + + EndPoint.LocalAddr.Addr[0] = NTOHL (EndPoint.LocalAddr.Addr[0]); + EndPoint.RemoteAddr.Addr[0] = NTOHL (EndPoint.RemoteAddr.Addr[0]); + } else { + if (((EFI_UDP6_RECEIVE_DATA *) RxData)->DataLength == 0) { + // + // Discard zero length data payload packet. + // + goto Resume; + } + + Netbuf = NetbufFromExt ( + (NET_FRAGMENT *)((EFI_UDP6_RECEIVE_DATA *) RxData)->FragmentTable, + ((EFI_UDP6_RECEIVE_DATA *) RxData)->FragmentCount, + 0, + (UINT32) RxToken->HeadLen, + UdpIoRecycleDgram, + RxToken + ); + + if (Netbuf == NULL) { + gBS->SignalEvent (((EFI_UDP6_RECEIVE_DATA *) RxData)->RecycleSignal); + RxToken->CallBack (NULL, NULL, EFI_OUT_OF_RESOURCES, RxToken->Context); + + UdpIoFreeRxToken (RxToken); + return; + } + + Session = &((EFI_UDP6_RECEIVE_DATA *) RxData)->UdpSession; + EndPoint.LocalPort = ((EFI_UDP6_SESSION_DATA *) Session)->DestinationPort; + EndPoint.RemotePort = ((EFI_UDP6_SESSION_DATA *) Session)->SourcePort; + + CopyMem ( + &EndPoint.LocalAddr, + &((EFI_UDP6_SESSION_DATA *) Session)->DestinationAddress, + sizeof (EFI_IPv6_ADDRESS) + ); + + CopyMem ( + &EndPoint.RemoteAddr, + &((EFI_UDP6_SESSION_DATA *) Session)->SourceAddress, + sizeof (EFI_IPv6_ADDRESS) + ); + + Ip6Swap128 (&EndPoint.LocalAddr.v6); + Ip6Swap128 (&EndPoint.RemoteAddr.v6); + } + + RxToken->CallBack (Netbuf, &EndPoint, EFI_SUCCESS, RxToken->Context); + return; + +Resume: + if (RxToken->UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { + gBS->SignalEvent (((EFI_UDP4_RECEIVE_DATA *) RxData)->RecycleSignal); + RxToken->UdpIo->Protocol.Udp4->Receive (RxToken->UdpIo->Protocol.Udp4, &RxToken->Token.Udp4); + } else { + gBS->SignalEvent (((EFI_UDP6_RECEIVE_DATA *) RxData)->RecycleSignal); + RxToken->UdpIo->Protocol.Udp6->Receive (RxToken->UdpIo->Protocol.Udp6, &RxToken->Token.Udp6); + } +} + +/** + Request UdpIoOnDgramRcvdDpc() as a DPC at TPL_CALLBACK. + + @param[in] Event The UDP receive request event. + @param[in] Context The UDP RX token. + +**/ +VOID +EFIAPI +UdpIoOnDgramRcvd ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + // + // Request UdpIoOnDgramRcvdDpc as a DPC at TPL_CALLBACK + // + QueueDpc (TPL_CALLBACK, UdpIoOnDgramRcvdDpc, Context); +} + +/** + Create a UDP_RX_TOKEN to wrap the request. + + @param[in] UdpIo The UdpIo to receive packets from. + @param[in] CallBack The function to call when receive finished. + @param[in] Context The opaque parameter to the CallBack. + @param[in] HeadLen The head length to reserver for the packet. + + @return The Wrapped request or NULL if failed to allocate resources or some errors happened. + +**/ +UDP_RX_TOKEN * +UdpIoCreateRxToken ( + IN UDP_IO *UdpIo, + IN UDP_IO_CALLBACK CallBack, + IN VOID *Context, + IN UINT32 HeadLen + ) +{ + UDP_RX_TOKEN *Token; + EFI_STATUS Status; + + ASSERT ((UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) || + (UdpIo->UdpVersion == UDP_IO_UDP6_VERSION)); + + Token = AllocatePool (sizeof (UDP_RX_TOKEN)); + + if (Token == NULL) { + return NULL; + } + + Token->Signature = UDP_IO_RX_SIGNATURE; + Token->UdpIo = UdpIo; + Token->CallBack = CallBack; + Token->Context = Context; + Token->HeadLen = HeadLen; + + if (UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { + + Token->Token.Udp4.Status = EFI_NOT_READY; + Token->Token.Udp4.Packet.RxData = NULL; + + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, + UdpIoOnDgramRcvd, + Token, + &Token->Token.Udp4.Event + ); + } else { + + Token->Token.Udp6.Status = EFI_NOT_READY; + Token->Token.Udp6.Packet.RxData = NULL; + + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, + UdpIoOnDgramRcvd, + Token, + &Token->Token.Udp6.Event + ); + } + + + if (EFI_ERROR (Status)) { + FreePool (Token); + return NULL; + } + + return Token; +} + +/** + Wrap a transmit request into a new created UDP_TX_TOKEN. + + If Packet is NULL, then ASSERT(). + If Udp version is not UDP_IO_UDP4_VERSION or UDP_IO_UDP6_VERSION, then ASSERT(). + + @param[in] UdpIo The UdpIo to send packet to. + @param[in] Packet The user's packet. + @param[in] EndPoint The local and remote access point. + @param[in] Gateway The overrided next hop. + @param[in] CallBack The function to call when transmission completed. + @param[in] Context The opaque parameter to the call back. + + @return The wrapped transmission request or NULL if failed to allocate resources + or for some errors. + +**/ +UDP_TX_TOKEN * +UdpIoCreateTxToken ( + IN UDP_IO *UdpIo, + IN NET_BUF *Packet, + IN UDP_END_POINT *EndPoint OPTIONAL, + IN EFI_IP_ADDRESS *Gateway OPTIONAL, + IN UDP_IO_CALLBACK CallBack, + IN VOID *Context + ) +{ + UDP_TX_TOKEN *TxToken; + VOID *Token; + VOID *Data; + EFI_STATUS Status; + UINT32 Count; + UINTN Size; + IP4_ADDR Ip; + + ASSERT (Packet != NULL); + ASSERT ((UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) || + (UdpIo->UdpVersion == UDP_IO_UDP6_VERSION)); + + if (UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { + Size = sizeof (UDP_TX_TOKEN) + sizeof (EFI_UDP4_FRAGMENT_DATA) * (Packet->BlockOpNum - 1); + } else { + Size = sizeof (UDP_TX_TOKEN) + sizeof (EFI_UDP6_FRAGMENT_DATA) * (Packet->BlockOpNum - 1); + } + + TxToken = AllocatePool (Size); + + if (TxToken == NULL) { + return NULL; + } + + TxToken->Signature = UDP_IO_TX_SIGNATURE; + InitializeListHead (&TxToken->Link); + + TxToken->UdpIo = UdpIo; + TxToken->CallBack = CallBack; + TxToken->Packet = Packet; + TxToken->Context = Context; + + Token = &(TxToken->Token); + Count = Packet->BlockOpNum; + + if (UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { + + ((EFI_UDP4_COMPLETION_TOKEN *) Token)->Status = EFI_NOT_READY; + + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, + UdpIoOnDgramSent, + TxToken, + &((EFI_UDP4_COMPLETION_TOKEN *) Token)->Event + ); + + if (EFI_ERROR (Status)) { + FreePool (TxToken); + return NULL; + } + + Data = &(TxToken->Data.Udp4); + ((EFI_UDP4_COMPLETION_TOKEN *) Token)->Packet.TxData = Data; + + ((EFI_UDP4_TRANSMIT_DATA *) Data)->UdpSessionData = NULL; + ((EFI_UDP4_TRANSMIT_DATA *) Data)->GatewayAddress = NULL; + ((EFI_UDP4_TRANSMIT_DATA *) Data)->DataLength = Packet->TotalSize; + + NetbufBuildExt ( + Packet, + (NET_FRAGMENT *)((EFI_UDP4_TRANSMIT_DATA *) Data)->FragmentTable, + &Count + ); + + ((EFI_UDP4_TRANSMIT_DATA *) Data)->FragmentCount = Count; + + if (EndPoint != NULL) { + Ip = HTONL (EndPoint->LocalAddr.Addr[0]); + CopyMem ( + &TxToken->Session.Udp4.SourceAddress, + &Ip, + sizeof (EFI_IPv4_ADDRESS) + ); + + Ip = HTONL (EndPoint->RemoteAddr.Addr[0]); + CopyMem ( + &TxToken->Session.Udp4.DestinationAddress, + &Ip, + sizeof (EFI_IPv4_ADDRESS) + ); + + TxToken->Session.Udp4.SourcePort = EndPoint->LocalPort; + TxToken->Session.Udp4.DestinationPort = EndPoint->RemotePort; + ((EFI_UDP4_TRANSMIT_DATA *) Data)->UdpSessionData = &(TxToken->Session.Udp4); + } + + if (Gateway != NULL && (Gateway->Addr[0] != 0)) { + Ip = HTONL (Gateway->Addr[0]); + CopyMem (&TxToken->Gateway, &Ip, sizeof (EFI_IPv4_ADDRESS)); + ((EFI_UDP4_TRANSMIT_DATA *) Data)->GatewayAddress = &TxToken->Gateway; + } + + } else { + + ((EFI_UDP6_COMPLETION_TOKEN *) Token)->Status = EFI_NOT_READY; + + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, + UdpIoOnDgramSent, + TxToken, + &((EFI_UDP6_COMPLETION_TOKEN *) Token)->Event + ); + + if (EFI_ERROR (Status)) { + FreePool (TxToken); + return NULL; + } + + Data = &(TxToken->Data.Udp6); + ((EFI_UDP6_COMPLETION_TOKEN *) Token)->Packet.TxData = Data; + ((EFI_UDP6_TRANSMIT_DATA *) Data)->UdpSessionData = NULL; + ((EFI_UDP6_TRANSMIT_DATA *) Data)->DataLength = Packet->TotalSize; + + NetbufBuildExt ( + Packet, + (NET_FRAGMENT *)((EFI_UDP6_TRANSMIT_DATA *) Data)->FragmentTable, + &Count + ); + + ((EFI_UDP6_TRANSMIT_DATA *) Data)->FragmentCount = Count; + + if (EndPoint != NULL) { + CopyMem ( + &TxToken->Session.Udp6.SourceAddress, + &EndPoint->LocalAddr.v6, + sizeof(EFI_IPv6_ADDRESS) + ); + + CopyMem ( + &TxToken->Session.Udp6.DestinationAddress, + &EndPoint->RemoteAddr.v6, + sizeof(EFI_IPv6_ADDRESS) + ); + + TxToken->Session.Udp6.SourcePort = EndPoint->LocalPort; + TxToken->Session.Udp6.DestinationPort = EndPoint->RemotePort; + ((EFI_UDP6_TRANSMIT_DATA *) Data)->UdpSessionData = &(TxToken->Session.Udp6); + } + } + + return TxToken; +} + +/** + Creates a UDP_IO to access the UDP service. It creates and configures + a UDP child. + + If Configure is NULL, then ASSERT(). + If Udp version is not UDP_IO_UDP4_VERSION or UDP_IO_UDP6_VERSION, then ASSERT(). + + It locates the UDP service binding prototype on the Controller parameter + uses the UDP service binding prototype to create a UDP child (also known as + a UDP instance) configures the UDP child by calling Configure function prototype. + Any failures in creating or configuring the UDP child return NULL for failure. + + @param[in] Controller The controller that has the UDP service binding. + protocol installed. + @param[in] ImageHandle The image handle for the driver. + @param[in] Configure The function to configure the created UDP child. + @param[in] UdpVersion The UDP protocol version, UDP4 or UDP6. + @param[in] Context The opaque parameter for the Configure funtion. + + @return Newly-created UDP_IO or NULL if failed. + +**/ +UDP_IO * +EFIAPI +UdpIoCreateIo ( + IN EFI_HANDLE Controller, + IN EFI_HANDLE ImageHandle, + IN UDP_IO_CONFIG Configure, + IN UINT8 UdpVersion, + IN VOID *Context + ) +{ + UDP_IO *UdpIo; + EFI_STATUS Status; + + ASSERT (Configure != NULL); + ASSERT ((UdpVersion == UDP_IO_UDP4_VERSION) || (UdpVersion == UDP_IO_UDP6_VERSION)); + + UdpIo = AllocatePool (sizeof (UDP_IO)); + + if (UdpIo == NULL) { + return NULL; + } + + UdpIo->UdpVersion = UdpVersion; + UdpIo->Signature = UDP_IO_SIGNATURE; + InitializeListHead (&UdpIo->Link); + UdpIo->RefCnt = 1; + + UdpIo->Controller = Controller; + UdpIo->Image = ImageHandle; + + InitializeListHead (&UdpIo->SentDatagram); + UdpIo->RecvRequest = NULL; + UdpIo->UdpHandle = NULL; + + if (UdpVersion == UDP_IO_UDP4_VERSION) { + // + // Create a UDP child then open and configure it + // + Status = NetLibCreateServiceChild ( + Controller, + ImageHandle, + &gEfiUdp4ServiceBindingProtocolGuid, + &UdpIo->UdpHandle + ); + + if (EFI_ERROR (Status)) { + goto FREE_MEM; + } + + Status = gBS->OpenProtocol ( + UdpIo->UdpHandle, + &gEfiUdp4ProtocolGuid, + (VOID **) &UdpIo->Protocol.Udp4, + ImageHandle, + Controller, + EFI_OPEN_PROTOCOL_BY_DRIVER + ); + + if (EFI_ERROR (Status)) { + goto FREE_CHILD; + } + + if (EFI_ERROR (Configure (UdpIo, Context))) { + goto CLOSE_PROTOCOL; + } + + Status = UdpIo->Protocol.Udp4->GetModeData ( + UdpIo->Protocol.Udp4, + NULL, + NULL, + NULL, + &UdpIo->SnpMode + ); + + if (EFI_ERROR (Status)) { + goto CLOSE_PROTOCOL; + } + + } else { + + Status = NetLibCreateServiceChild ( + Controller, + ImageHandle, + &gEfiUdp6ServiceBindingProtocolGuid, + &UdpIo->UdpHandle + ); + + if (EFI_ERROR (Status)) { + goto FREE_MEM; + } + + Status = gBS->OpenProtocol ( + UdpIo->UdpHandle, + &gEfiUdp6ProtocolGuid, + (VOID **) &UdpIo->Protocol.Udp6, + ImageHandle, + Controller, + EFI_OPEN_PROTOCOL_BY_DRIVER + ); + + if (EFI_ERROR (Status)) { + goto FREE_CHILD; + } + + if (EFI_ERROR (Configure (UdpIo, Context))) { + goto CLOSE_PROTOCOL; + } + + Status = UdpIo->Protocol.Udp6->GetModeData ( + UdpIo->Protocol.Udp6, + NULL, + NULL, + NULL, + &UdpIo->SnpMode + ); + + if (EFI_ERROR (Status)) { + goto CLOSE_PROTOCOL; + } + } + + return UdpIo; + +CLOSE_PROTOCOL: + if (UdpVersion == UDP_IO_UDP4_VERSION) { + gBS->CloseProtocol (UdpIo->UdpHandle, &gEfiUdp4ProtocolGuid, ImageHandle, Controller); + } else { + gBS->CloseProtocol (UdpIo->UdpHandle, &gEfiUdp6ProtocolGuid, ImageHandle, Controller); + } + +FREE_CHILD: + if (UdpVersion == UDP_IO_UDP4_VERSION) { + NetLibDestroyServiceChild ( + Controller, + ImageHandle, + &gEfiUdp4ServiceBindingProtocolGuid, + UdpIo->UdpHandle + ); + } else { + NetLibDestroyServiceChild ( + Controller, + ImageHandle, + &gEfiUdp6ServiceBindingProtocolGuid, + UdpIo->UdpHandle + ); + } + +FREE_MEM: + FreePool (UdpIo); + return NULL; +} + +/** + Cancel all the sent datagram that pass the selection criteria of ToCancel. + + If ToCancel is NULL, all the datagrams are cancelled. + If Udp version is not UDP_IO_UDP4_VERSION or UDP_IO_UDP6_VERSION, then ASSERT(). + + @param[in] UdpIo The UDP_IO to cancel packet. + @param[in] IoStatus The IoStatus to return to the packet owners. + @param[in] ToCancel The select funtion to test whether to cancel this + packet or not. + @param[in] Context The opaque parameter to the ToCancel. + +**/ +VOID +EFIAPI +UdpIoCancelDgrams ( + IN UDP_IO *UdpIo, + IN EFI_STATUS IoStatus, + IN UDP_IO_TO_CANCEL ToCancel, OPTIONAL + IN VOID *Context OPTIONAL + ) +{ + LIST_ENTRY *Entry; + LIST_ENTRY *Next; + UDP_TX_TOKEN *TxToken; + + ASSERT ((UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) || + (UdpIo->UdpVersion == UDP_IO_UDP6_VERSION)); + + NET_LIST_FOR_EACH_SAFE (Entry, Next, &UdpIo->SentDatagram) { + TxToken = NET_LIST_USER_STRUCT (Entry, UDP_TX_TOKEN, Link); + + if ((ToCancel == NULL) || (ToCancel (TxToken, Context))) { + + if (UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { + UdpIo->Protocol.Udp4->Cancel (UdpIo->Protocol.Udp4, &TxToken->Token.Udp4); + } else { + UdpIo->Protocol.Udp6->Cancel (UdpIo->Protocol.Udp6, &TxToken->Token.Udp6); + } + } + } +} + +/** + Free the UDP_IO and all its related resources. + + If Udp version is not UDP_IO_UDP4_VERSION or UDP_IO_UDP6_VERSION, then ASSERT(). + + The function will cancel all sent datagram and receive request. + + @param[in] UdpIo The UDP_IO to free. + + @retval EFI_SUCCESS The UDP_IO is freed. + @retval Others Failed to free UDP_IO. + +**/ +EFI_STATUS +EFIAPI +UdpIoFreeIo ( + IN UDP_IO *UdpIo + ) +{ + EFI_STATUS Status; + UDP_RX_TOKEN *RxToken; + + ASSERT ((UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) || + (UdpIo->UdpVersion == UDP_IO_UDP6_VERSION)); + + // + // Cancel all the sent datagram and receive requests. The + // callbacks of transmit requests are executed to allow the + // caller to release the resource. The callback of receive + // request are NOT executed. This is because it is most + // likely that the current user of the UDP IO port is closing + // itself. + // + UdpIoCancelDgrams (UdpIo, EFI_ABORTED, NULL, NULL); + + if (UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { + + if ((RxToken = UdpIo->RecvRequest) != NULL) { + Status = UdpIo->Protocol.Udp4->Cancel (UdpIo->Protocol.Udp4, &RxToken->Token.Udp4); + if (EFI_ERROR (Status)) { + return Status; + } + } + + // + // Close then destroy the Udp4 child + // + Status = gBS->CloseProtocol ( + UdpIo->UdpHandle, + &gEfiUdp4ProtocolGuid, + UdpIo->Image, + UdpIo->Controller + ); + if (EFI_ERROR (Status)) { + return Status; + } + + Status = NetLibDestroyServiceChild ( + UdpIo->Controller, + UdpIo->Image, + &gEfiUdp4ServiceBindingProtocolGuid, + UdpIo->UdpHandle + ); + if (EFI_ERROR (Status)) { + return Status; + } + + } else { + + if ((RxToken = UdpIo->RecvRequest) != NULL) { + Status = UdpIo->Protocol.Udp6->Cancel (UdpIo->Protocol.Udp6, &RxToken->Token.Udp6); + if (EFI_ERROR (Status)) { + return Status; + } + } + + // + // Close then destroy the Udp6 child + // + Status = gBS->CloseProtocol ( + UdpIo->UdpHandle, + &gEfiUdp6ProtocolGuid, + UdpIo->Image, + UdpIo->Controller + ); + if (EFI_ERROR (Status)) { + return Status; + } + + Status = NetLibDestroyServiceChild ( + UdpIo->Controller, + UdpIo->Image, + &gEfiUdp6ServiceBindingProtocolGuid, + UdpIo->UdpHandle + ); + if (EFI_ERROR (Status)) { + return Status; + } + } + + if (!IsListEmpty(&UdpIo->Link)) { + RemoveEntryList (&UdpIo->Link); + } + + FreePool (UdpIo); + return EFI_SUCCESS; +} + + +/** + Clean up the UDP_IO without freeing it. The function is called when + user wants to re-use the UDP_IO later. + + If Udp version is not UDP_IO_UDP4_VERSION or UDP_IO_UDP6_VERSION, then ASSERT(). + + It will release all the transmitted datagrams and receive request. It will + also configure NULL for the UDP instance. + + @param[in] UdpIo The UDP_IO to clean up. + +**/ +VOID +EFIAPI +UdpIoCleanIo ( + IN UDP_IO *UdpIo + ) +{ + UDP_RX_TOKEN *RxToken; + + ASSERT ((UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) || + (UdpIo->UdpVersion == UDP_IO_UDP6_VERSION)); + + // + // Cancel all the sent datagram and receive requests. + // + UdpIoCancelDgrams (UdpIo, EFI_ABORTED, NULL, NULL); + + if (UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { + if ((RxToken = UdpIo->RecvRequest) != NULL) { + UdpIo->Protocol.Udp4->Cancel (UdpIo->Protocol.Udp4, &RxToken->Token.Udp4); + } + + UdpIo->Protocol.Udp4->Configure (UdpIo->Protocol.Udp4, NULL); + + } else { + if ((RxToken = UdpIo->RecvRequest) != NULL) { + UdpIo->Protocol.Udp6->Cancel (UdpIo->Protocol.Udp6, &RxToken->Token.Udp6); + } + + UdpIo->Protocol.Udp6->Configure (UdpIo->Protocol.Udp6, NULL); + } +} + +/** + Send a packet through the UDP_IO. + + If Udp version is not UDP_IO_UDP4_VERSION or UDP_IO_UDP6_VERSION, then ASSERT(). + + The packet will be wrapped in UDP_TX_TOKEN. Function Callback will be called + when the packet is sent. The optional parameter EndPoint overrides the default + address pair if specified. + + @param[in] UdpIo The UDP_IO to send the packet through. + @param[in] Packet The packet to send. + @param[in] EndPoint The local and remote access point. Override the + default address pair set during configuration. + @param[in] Gateway The gateway to use. + @param[in] CallBack The function being called when packet is + transmitted or failed. + @param[in] Context The opaque parameter passed to CallBack. + + @retval EFI_OUT_OF_RESOURCES Failed to allocate resource for the packet. + @retval EFI_SUCCESS The packet is successfully delivered to UDP for + transmission. + +**/ +EFI_STATUS +EFIAPI +UdpIoSendDatagram ( + IN UDP_IO *UdpIo, + IN NET_BUF *Packet, + IN UDP_END_POINT *EndPoint OPTIONAL, + IN EFI_IP_ADDRESS *Gateway OPTIONAL, + IN UDP_IO_CALLBACK CallBack, + IN VOID *Context + ) +{ + UDP_TX_TOKEN *TxToken; + EFI_STATUS Status; + + ASSERT ((UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) || + (UdpIo->UdpVersion == UDP_IO_UDP6_VERSION)); + + TxToken = UdpIoCreateTxToken (UdpIo, Packet, EndPoint, Gateway, CallBack, Context); + + if (TxToken == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + // + // Insert the tx token into SendDatagram list before transmitting it. Remove + // it from the list if the returned status is not EFI_SUCCESS. + // + InsertHeadList (&UdpIo->SentDatagram, &TxToken->Link); + + if (UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { + Status = UdpIo->Protocol.Udp4->Transmit (UdpIo->Protocol.Udp4, &TxToken->Token.Udp4); + } else { + Status = UdpIo->Protocol.Udp6->Transmit (UdpIo->Protocol.Udp6, &TxToken->Token.Udp6); + } + + if (EFI_ERROR (Status)) { + RemoveEntryList (&TxToken->Link); + UdpIoFreeTxToken (TxToken); + return Status; + } + + return EFI_SUCCESS; +} + + +/** + The select function to cancel a single sent datagram. + + @param[in] Token The UDP_TX_TOKEN to test against + @param[in] Context The NET_BUF of the sent datagram + + @retval TRUE The packet is to be cancelled. + @retval FALSE The packet is not to be cancelled. +**/ +BOOLEAN +EFIAPI +UdpIoCancelSingleDgram ( + IN UDP_TX_TOKEN *Token, + IN VOID *Context + ) +{ + NET_BUF *Packet; + + Packet = (NET_BUF *) Context; + + if (Token->Packet == Packet) { + return TRUE; + } + + return FALSE; +} + +/** + Cancel a single sent datagram. + + @param[in] UdpIo The UDP_IO to cancel the packet from + @param[in] Packet The packet to cancel + +**/ +VOID +EFIAPI +UdpIoCancelSentDatagram ( + IN UDP_IO *UdpIo, + IN NET_BUF *Packet + ) +{ + UdpIoCancelDgrams (UdpIo, EFI_ABORTED, UdpIoCancelSingleDgram, Packet); +} + +/** + Issue a receive request to the UDP_IO. + + If Udp version is not UDP_IO_UDP4_VERSION or UDP_IO_UDP6_VERSION, then ASSERT(). + + This function is called when upper-layer needs packet from UDP for processing. + Only one receive request is acceptable at a time so a common usage model is + to invoke this function inside its Callback function when the former packet + is processed. + + @param[in] UdpIo The UDP_IO to receive the packet from. + @param[in] CallBack The call back function to execute when the packet + is received. + @param[in] Context The opaque context passed to Callback. + @param[in] HeadLen The length of the upper-layer's protocol header. + + @retval EFI_ALREADY_STARTED There is already a pending receive request. Only + one receive request is supported at a time. + @retval EFI_OUT_OF_RESOURCES Failed to allocate needed resources. + @retval EFI_SUCCESS The receive request is issued successfully. + @retval EFI_UNSUPPORTED The UDP version in UDP_IO is not supported. + +**/ +EFI_STATUS +EFIAPI +UdpIoRecvDatagram ( + IN UDP_IO *UdpIo, + IN UDP_IO_CALLBACK CallBack, + IN VOID *Context, + IN UINT32 HeadLen + ) +{ + UDP_RX_TOKEN *RxToken; + EFI_STATUS Status; + + ASSERT ((UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) || + (UdpIo->UdpVersion == UDP_IO_UDP6_VERSION)); + + if (UdpIo->RecvRequest != NULL) { + return EFI_ALREADY_STARTED; + } + + RxToken = UdpIoCreateRxToken (UdpIo, CallBack, Context, HeadLen); + + if (RxToken == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + UdpIo->RecvRequest = RxToken; + if (UdpIo->UdpVersion == UDP_IO_UDP4_VERSION) { + Status = UdpIo->Protocol.Udp4->Receive (UdpIo->Protocol.Udp4, &RxToken->Token.Udp4); + } else { + Status = UdpIo->Protocol.Udp6->Receive (UdpIo->Protocol.Udp6, &RxToken->Token.Udp6); + } + + if (EFI_ERROR (Status)) { + UdpIo->RecvRequest = NULL; + UdpIoFreeRxToken (RxToken); + } + + return Status; +} diff --git a/NetworkPkg/Library/DxeUdpIoLib/DxeUdpIoLib.inf b/NetworkPkg/Library/DxeUdpIoLib/DxeUdpIoLib.inf new file mode 100644 index 0000000000..483c2cda02 --- /dev/null +++ b/NetworkPkg/Library/DxeUdpIoLib/DxeUdpIoLib.inf @@ -0,0 +1,46 @@ +## @file +# This library instance provides UDP services by consuming EFI UDPv4/UDPv6 Protocols. +# +# Copyright (c) 2008 - 2018, Intel Corporation. All rights reserved.
+# SPDX-License-Identifier: BSD-2-Clause-Patent +# +## + + +[Defines] + INF_VERSION = 0x00010005 + BASE_NAME = DxeUpdIoLib + MODULE_UNI_FILE = DxeUpdIoLib.uni + FILE_GUID = 7E615AA1-41EE-49d4-B7E9-1D7A60AA5C8D + MODULE_TYPE = DXE_DRIVER + VERSION_STRING = 1.0 + LIBRARY_CLASS = UdpIoLib|DXE_CORE DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER + +# +# The following information is for reference only and not required by the build tools. +# +# VALID_ARCHITECTURES = IA32 X64 EBC +# + +[Sources] + DxeUdpIoLib.c + +[Packages] + MdePkg/MdePkg.dec + MdeModulePkg/MdeModulePkg.dec + + +[LibraryClasses] + BaseLib + DebugLib + UefiBootServicesTableLib + MemoryAllocationLib + BaseMemoryLib + DpcLib + +[Protocols] + gEfiUdp4ServiceBindingProtocolGuid ## SOMETIMES_CONSUMES + gEfiUdp4ProtocolGuid ## SOMETIMES_CONSUMES + gEfiUdp6ServiceBindingProtocolGuid ## SOMETIMES_CONSUMES + gEfiUdp6ProtocolGuid ## SOMETIMES_CONSUMES + diff --git a/NetworkPkg/Library/DxeUdpIoLib/DxeUpdIoLib.uni b/NetworkPkg/Library/DxeUdpIoLib/DxeUpdIoLib.uni new file mode 100644 index 0000000000..bc94905995 --- /dev/null +++ b/NetworkPkg/Library/DxeUdpIoLib/DxeUpdIoLib.uni @@ -0,0 +1,16 @@ +// /** @file +// This library instance provides UDP services by consuming EFI UDPv4/UDPv6 Protocols. +// +// This library instance provides UDP services by consuming EFI UDPv4/UDPv6 Protocols. +// +// Copyright (c) 2008 - 2018, Intel Corporation. All rights reserved.
+// +// SPDX-License-Identifier: BSD-2-Clause-Patent +// +// **/ + + +#string STR_MODULE_ABSTRACT #language en-US "Provides UDP services by consuming EFI UDPv4/UDPv6 Protocols" + +#string STR_MODULE_DESCRIPTION #language en-US "This library instance provides UDP services by consuming EFI UDPv4/UDPv6 Protocols." + diff --git a/NetworkPkg/MnpDxe/ComponentName.c b/NetworkPkg/MnpDxe/ComponentName.c new file mode 100644 index 0000000000..fe85c3bc23 --- /dev/null +++ b/NetworkPkg/MnpDxe/ComponentName.c @@ -0,0 +1,341 @@ +/** @file + UEFI Component Name(2) protocol implementation for MnpDxe driver. + +Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "MnpImpl.h" + +// +// EFI Component Name Protocol +// +GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gMnpComponentName = { + MnpComponentNameGetDriverName, + MnpComponentNameGetControllerName, + "eng" +}; + +// +// EFI Component Name 2 Protocol +// +GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gMnpComponentName2 = { + (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) MnpComponentNameGetDriverName, + (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) MnpComponentNameGetControllerName, + "en" +}; + +GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mMnpDriverNameTable[] = { + { + "eng;en", + L"MNP Network Service Driver" + }, + { + NULL, + NULL + } +}; + +GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE *gMnpControllerNameTable = NULL; + +/** + Retrieves a Unicode string that is the user readable name of the driver. + + This function retrieves the user readable name of a driver in the form of a + Unicode string. If the driver specified by This has a user readable name in + the language specified by Language, then a pointer to the driver name is + returned in DriverName, and EFI_SUCCESS is returned. If the driver specified + by This does not support the language specified by Language, + then EFI_UNSUPPORTED is returned. + + @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param[in] Language A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified + in RFC 4646 or ISO 639-2 language code format. + + @param[out] DriverName A pointer to the Unicode string to return. + This Unicode string is the name of the + driver specified by This in the language + specified by Language. + + @retval EFI_SUCCESS The Unicode string for the Driver specified by + This and the language specified by Language was + returned in DriverName. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER DriverName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +MnpComponentNameGetDriverName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN CHAR8 *Language, + OUT CHAR16 **DriverName + ) +{ + return LookupUnicodeString2 ( + Language, + This->SupportedLanguages, + mMnpDriverNameTable, + DriverName, + (BOOLEAN) (This == &gMnpComponentName) + ); +} + +/** + Update the component name for the MNP child handle. + + @param Mnp[in] A pointer to the EFI_MANAGED_NETWORK_PROTOCOL. + + + @retval EFI_SUCCESS Update the ControllerNameTable of this instance successfully. + @retval EFI_INVALID_PARAMETER The input parameter is invalid. + +**/ +EFI_STATUS +UpdateName ( + IN EFI_MANAGED_NETWORK_PROTOCOL *Mnp + ) +{ + EFI_STATUS Status; + MNP_INSTANCE_DATA *Instance; + CHAR16 HandleName[80]; + EFI_MANAGED_NETWORK_CONFIG_DATA MnpConfigData; + EFI_SIMPLE_NETWORK_MODE SnpModeData; + UINTN OffSet; + UINTN Index; + + if (Mnp == NULL) { + return EFI_INVALID_PARAMETER; + } + + Instance = MNP_INSTANCE_DATA_FROM_THIS (Mnp); + // + // Format the child name into the string buffer as: + // MNP (MAC=FF-FF-FF-FF-FF-FF, ProtocolType=0x0800, VlanId=0) + // + Status = Mnp->GetModeData (Mnp, &MnpConfigData, &SnpModeData); + if (!EFI_ERROR (Status)) { + OffSet = 0; + // + // Print the MAC address. + // + OffSet += UnicodeSPrint ( + HandleName, + sizeof (HandleName), + L"MNP (MAC=" + ); + for (Index = 0; Index < SnpModeData.HwAddressSize; Index++) { + OffSet += UnicodeSPrint ( + HandleName + OffSet, + sizeof (HandleName) - OffSet * sizeof (CHAR16), + L"%02X-", + SnpModeData.CurrentAddress.Addr[Index] + ); + } + ASSERT (OffSet > 0); + // + // Remove the last '-' + // + OffSet--; + // + // Print the ProtocolType and VLAN ID for this instance. + // + OffSet += UnicodeSPrint ( + HandleName + OffSet, + sizeof (HandleName) - OffSet * sizeof (CHAR16), + L", ProtocolType=0x%X, VlanId=%d)", + MnpConfigData.ProtocolTypeFilter, + Instance->MnpServiceData->VlanId + ); + } else if (Status == EFI_NOT_STARTED) { + UnicodeSPrint ( + HandleName, + sizeof (HandleName), + L"MNP (Not started)" + ); + } else { + return Status; + } + + if (gMnpControllerNameTable != NULL) { + FreeUnicodeStringTable (gMnpControllerNameTable); + gMnpControllerNameTable = NULL; + } + + Status = AddUnicodeString2 ( + "eng", + gMnpComponentName.SupportedLanguages, + &gMnpControllerNameTable, + HandleName, + TRUE + ); + if (EFI_ERROR (Status)) { + return Status; + } + + return AddUnicodeString2 ( + "en", + gMnpComponentName2.SupportedLanguages, + &gMnpControllerNameTable, + HandleName, + FALSE + ); +} + +/** + Retrieves a Unicode string that is the user readable name of the controller + that is being managed by a driver. + + This function retrieves the user readable name of the controller specified by + ControllerHandle and ChildHandle in the form of a Unicode string. If the + driver specified by This has a user readable name in the language specified by + Language, then a pointer to the controller name is returned in ControllerName, + and EFI_SUCCESS is returned. If the driver specified by This is not currently + managing the controller specified by ControllerHandle and ChildHandle, + then EFI_UNSUPPORTED is returned. If the driver specified by This does not + support the language specified by Language, then EFI_UNSUPPORTED is returned. + Currently not implemented. + + @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param[in] ControllerHandle The handle of a controller that the driver + specified by This is managing. This handle + specifies the controller whose name is to be + returned. + + @param[in] ChildHandle The handle of the child controller to retrieve + the name of. This is an optional parameter that + may be NULL. It will be NULL for device + drivers. It will also be NULL for a bus drivers + that wish to retrieve the name of the bus + controller. It will not be NULL for a bus + driver that wishes to retrieve the name of a + child controller. + + @param[in] Language A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified in + RFC 4646 or ISO 639-2 language code format. + + @param[out] ControllerName A pointer to the Unicode string to return. + This Unicode string is the name of the + controller specified by ControllerHandle and + ChildHandle in the language specified by + Language from the point of view of the driver + specified by This. + + @retval EFI_SUCCESS The Unicode string for the user readable name + specified by This, ControllerHandle, ChildHandle, + and Language was returned in ControllerName. + + @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. + + @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid + EFI_HANDLE. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER ControllerName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This is not currently + managing the controller specified by + ControllerHandle and ChildHandle. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +MnpComponentNameGetControllerName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_HANDLE ChildHandle OPTIONAL, + IN CHAR8 *Language, + OUT CHAR16 **ControllerName + ) +{ + EFI_STATUS Status; + EFI_MANAGED_NETWORK_PROTOCOL *Mnp; + + // + // Only provide names for MNP child handles. + // + if (ChildHandle == NULL) { + return EFI_UNSUPPORTED; + } + + // + // Make sure this driver is currently managing ControllerHandle + // + Status = EfiTestManagedDevice ( + ControllerHandle, + gMnpDriverBinding.DriverBindingHandle, + &gEfiSimpleNetworkProtocolGuid + ); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Make sure this driver produced ChildHandle + // + Status = EfiTestChildHandle ( + ControllerHandle, + ChildHandle, + &gEfiManagedNetworkServiceBindingProtocolGuid + ); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Retrieve an instance of a produced protocol from ChildHandle + // + Status = gBS->OpenProtocol ( + ChildHandle, + &gEfiManagedNetworkProtocolGuid, + (VOID **)&Mnp, + NULL, + NULL, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Update the component name for this child handle. + // + Status = UpdateName (Mnp); + if (EFI_ERROR (Status)) { + return Status; + } + + return LookupUnicodeString2 ( + Language, + This->SupportedLanguages, + gMnpControllerNameTable, + ControllerName, + (BOOLEAN)(This == &gMnpComponentName) + ); +} diff --git a/NetworkPkg/MnpDxe/ComponentName.h b/NetworkPkg/MnpDxe/ComponentName.h new file mode 100644 index 0000000000..201c6da11a --- /dev/null +++ b/NetworkPkg/MnpDxe/ComponentName.h @@ -0,0 +1,144 @@ +/** @file + The header file of UEFI Component Name(2) protocol. + +Copyright (c) 2004 - 2012, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef _COMPONENT_NAME_H_ +#define _COMPONENT_NAME_H_ + +#include +#include + +extern EFI_COMPONENT_NAME2_PROTOCOL gMnpComponentName2; +extern EFI_COMPONENT_NAME_PROTOCOL gMnpComponentName; +extern EFI_UNICODE_STRING_TABLE *gMnpControllerNameTable; + +/** + Retrieves a Unicode string that is the user readable name of the driver. + + This function retrieves the user readable name of a driver in the form of a + Unicode string. If the driver specified by This has a user readable name in + the language specified by Language, then a pointer to the driver name is + returned in DriverName, and EFI_SUCCESS is returned. If the driver specified + by This does not support the language specified by Language, + then EFI_UNSUPPORTED is returned. + + @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param[in] Language A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified + in RFC 4646 or ISO 639-2 language code format. + + @param[out] DriverName A pointer to the Unicode string to return. + This Unicode string is the name of the + driver specified by This in the language + specified by Language. + + @retval EFI_SUCCESS The Unicode string for the Driver specified by + This and the language specified by Language was + returned in DriverName. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER DriverName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +MnpComponentNameGetDriverName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN CHAR8 *Language, + OUT CHAR16 **DriverName + ); + +/** + Retrieves a Unicode string that is the user readable name of the controller + that is being managed by a driver. + + This function retrieves the user readable name of the controller specified by + ControllerHandle and ChildHandle in the form of a Unicode string. If the + driver specified by This has a user readable name in the language specified by + Language, then a pointer to the controller name is returned in ControllerName, + and EFI_SUCCESS is returned. If the driver specified by This is not currently + managing the controller specified by ControllerHandle and ChildHandle, + then EFI_UNSUPPORTED is returned. If the driver specified by This does not + support the language specified by Language, then EFI_UNSUPPORTED is returned. + Currently not implemented. + + @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param[in] ControllerHandle The handle of a controller that the driver + specified by This is managing. This handle + specifies the controller whose name is to be + returned. + + @param[in] ChildHandle The handle of the child controller to retrieve + the name of. This is an optional parameter that + may be NULL. It will be NULL for device + drivers. It will also be NULL for a bus drivers + that wish to retrieve the name of the bus + controller. It will not be NULL for a bus + driver that wishes to retrieve the name of a + child controller. + + @param[in] Language A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified in + RFC 4646 or ISO 639-2 language code format. + + @param[out] ControllerName A pointer to the Unicode string to return. + This Unicode string is the name of the + controller specified by ControllerHandle and + ChildHandle in the language specified by + Language from the point of view of the driver + specified by This. + + @retval EFI_SUCCESS The Unicode string for the user readable name + specified by This, ControllerHandle, ChildHandle, + and Language was returned in ControllerName. + + @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. + + @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid + EFI_HANDLE. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER ControllerName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This is not currently + managing the controller specified by + ControllerHandle and ChildHandle. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +MnpComponentNameGetControllerName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_HANDLE ChildHandle OPTIONAL, + IN CHAR8 *Language, + OUT CHAR16 **ControllerName + ); + +#endif diff --git a/NetworkPkg/MnpDxe/MnpConfig.c b/NetworkPkg/MnpDxe/MnpConfig.c new file mode 100644 index 0000000000..5906ad546f --- /dev/null +++ b/NetworkPkg/MnpDxe/MnpConfig.c @@ -0,0 +1,1939 @@ +/** @file + Implementation of Managed Network Protocol private services. + +Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "MnpImpl.h" +#include "MnpVlan.h" + +EFI_SERVICE_BINDING_PROTOCOL mMnpServiceBindingProtocol = { + MnpServiceBindingCreateChild, + MnpServiceBindingDestroyChild +}; + +EFI_MANAGED_NETWORK_PROTOCOL mMnpProtocolTemplate = { + MnpGetModeData, + MnpConfigure, + MnpMcastIpToMac, + MnpGroups, + MnpTransmit, + MnpReceive, + MnpCancel, + MnpPoll +}; + +EFI_MANAGED_NETWORK_CONFIG_DATA mMnpDefaultConfigData = { + 10000000, + 10000000, + 0, + FALSE, + FALSE, + FALSE, + FALSE, + FALSE, + FALSE, + FALSE +}; + +/** + Add Count of net buffers to MnpDeviceData->FreeNbufQue. The length of the net + buffer is specified by MnpDeviceData->BufferLength. + + @param[in, out] MnpDeviceData Pointer to the MNP_DEVICE_DATA. + @param[in] Count Number of NET_BUFFERs to add. + + @retval EFI_SUCCESS The specified amount of NET_BUFs are allocated + and added to MnpDeviceData->FreeNbufQue. + @retval EFI_OUT_OF_RESOURCES Failed to allocate a NET_BUF structure. + +**/ +EFI_STATUS +MnpAddFreeNbuf ( + IN OUT MNP_DEVICE_DATA *MnpDeviceData, + IN UINTN Count + ) +{ + EFI_STATUS Status; + UINTN Index; + NET_BUF *Nbuf; + + NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); + ASSERT ((Count > 0) && (MnpDeviceData->BufferLength > 0)); + + Status = EFI_SUCCESS; + for (Index = 0; Index < Count; Index++) { + Nbuf = NetbufAlloc (MnpDeviceData->BufferLength + MnpDeviceData->PaddingSize); + if (Nbuf == NULL) { + DEBUG ((EFI_D_ERROR, "MnpAddFreeNbuf: NetBufAlloc failed.\n")); + + Status = EFI_OUT_OF_RESOURCES; + break; + } + + if (MnpDeviceData->PaddingSize > 0) { + // + // Pad padding bytes before the media header + // + NetbufAllocSpace (Nbuf, MnpDeviceData->PaddingSize, NET_BUF_TAIL); + NetbufTrim (Nbuf, MnpDeviceData->PaddingSize, NET_BUF_HEAD); + } + + NetbufQueAppend (&MnpDeviceData->FreeNbufQue, Nbuf); + } + + MnpDeviceData->NbufCnt += Index; + return Status; +} + + +/** + Allocate a free NET_BUF from MnpDeviceData->FreeNbufQue. If there is none + in the queue, first try to allocate some and add them into the queue, then + fetch the NET_BUF from the updated FreeNbufQue. + + @param[in, out] MnpDeviceData Pointer to the MNP_DEVICE_DATA. + + @return Pointer to the allocated free NET_BUF structure, if NULL the + operation is failed. + +**/ +NET_BUF * +MnpAllocNbuf ( + IN OUT MNP_DEVICE_DATA *MnpDeviceData + ) +{ + EFI_STATUS Status; + NET_BUF_QUEUE *FreeNbufQue; + NET_BUF *Nbuf; + EFI_TPL OldTpl; + + NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); + + FreeNbufQue = &MnpDeviceData->FreeNbufQue; + OldTpl = gBS->RaiseTPL (TPL_NOTIFY); + + // + // Check whether there are available buffers, or else try to add some. + // + if (FreeNbufQue->BufNum == 0) { + if ((MnpDeviceData->NbufCnt + MNP_NET_BUFFER_INCREASEMENT) > MNP_MAX_NET_BUFFER_NUM) { + DEBUG ( + (EFI_D_ERROR, + "MnpAllocNbuf: The maximum NET_BUF size is reached for MNP driver instance %p.\n", + MnpDeviceData) + ); + + Nbuf = NULL; + goto ON_EXIT; + } + + Status = MnpAddFreeNbuf (MnpDeviceData, MNP_NET_BUFFER_INCREASEMENT); + if (EFI_ERROR (Status)) { + DEBUG ( + (EFI_D_ERROR, + "MnpAllocNbuf: Failed to add NET_BUFs into the FreeNbufQue, %r.\n", + Status) + ); + + // + // Don't return NULL, perhaps MnpAddFreeNbuf does add some NET_BUFs but + // the amount is less than MNP_NET_BUFFER_INCREASEMENT. + // + } + } + + Nbuf = NetbufQueRemove (FreeNbufQue); + + // + // Increase the RefCnt. + // + if (Nbuf != NULL) { + NET_GET_REF (Nbuf); + } + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + + return Nbuf; +} + + +/** + Try to reclaim the Nbuf into the buffer pool. + + @param[in, out] MnpDeviceData Pointer to the mnp device context data. + @param[in, out] Nbuf Pointer to the NET_BUF to free. + +**/ +VOID +MnpFreeNbuf ( + IN OUT MNP_DEVICE_DATA *MnpDeviceData, + IN OUT NET_BUF *Nbuf + ) +{ + EFI_TPL OldTpl; + + NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); + ASSERT (Nbuf->RefCnt > 1); + + OldTpl = gBS->RaiseTPL (TPL_NOTIFY); + + NET_PUT_REF (Nbuf); + + if (Nbuf->RefCnt == 1) { + // + // Trim all buffer contained in the Nbuf, then append it to the NbufQue. + // + NetbufTrim (Nbuf, Nbuf->TotalSize, NET_BUF_TAIL); + + if (NetbufAllocSpace (Nbuf, NET_VLAN_TAG_LEN, NET_BUF_HEAD) != NULL) { + // + // There is space reserved for vlan tag in the head, reclaim it + // + NetbufTrim (Nbuf, NET_VLAN_TAG_LEN, NET_BUF_TAIL); + } + + NetbufQueAppend (&MnpDeviceData->FreeNbufQue, Nbuf); + } + + gBS->RestoreTPL (OldTpl); +} + +/** + Add Count of TX buffers to MnpDeviceData->AllTxBufList and MnpDeviceData->FreeTxBufList. + The length of the buffer is specified by MnpDeviceData->BufferLength. + + @param[in, out] MnpDeviceData Pointer to the MNP_DEVICE_DATA. + @param[in] Count Number of TX buffers to add. + + @retval EFI_SUCCESS The specified amount of TX buffers are allocated. + @retval EFI_OUT_OF_RESOURCES Failed to allocate a TX buffer. + +**/ +EFI_STATUS +MnpAddFreeTxBuf ( + IN OUT MNP_DEVICE_DATA *MnpDeviceData, + IN UINTN Count + ) +{ + EFI_STATUS Status; + UINT32 Index; + MNP_TX_BUF_WRAP *TxBufWrap; + + NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); + ASSERT ((Count > 0) && (MnpDeviceData->BufferLength > 0)); + + Status = EFI_SUCCESS; + for (Index = 0; Index < Count; Index++) { + TxBufWrap = (MNP_TX_BUF_WRAP*) AllocatePool (OFFSET_OF (MNP_TX_BUF_WRAP, TxBuf) + MnpDeviceData->BufferLength ); + if (TxBufWrap == NULL) { + DEBUG ((EFI_D_ERROR, "MnpAddFreeTxBuf: TxBuf Alloc failed.\n")); + + Status = EFI_OUT_OF_RESOURCES; + break; + } + DEBUG ((EFI_D_INFO, "MnpAddFreeTxBuf: Add TxBufWrap %p, TxBuf %p\n", TxBufWrap, TxBufWrap->TxBuf)); + TxBufWrap->Signature = MNP_TX_BUF_WRAP_SIGNATURE; + TxBufWrap->InUse = FALSE; + InsertTailList (&MnpDeviceData->FreeTxBufList, &TxBufWrap->WrapEntry); + InsertTailList (&MnpDeviceData->AllTxBufList, &TxBufWrap->AllEntry); + } + + MnpDeviceData->TxBufCount += Index; + return Status; +} + +/** + Allocate a free TX buffer from MnpDeviceData->FreeTxBufList. If there is none + in the queue, first try to recycle some from SNP, then try to allocate some and add + them into the queue, then fetch the NET_BUF from the updated FreeTxBufList. + + @param[in, out] MnpDeviceData Pointer to the MNP_DEVICE_DATA. + + @return Pointer to the allocated free NET_BUF structure, if NULL the + operation is failed. + +**/ +UINT8 * +MnpAllocTxBuf ( + IN OUT MNP_DEVICE_DATA *MnpDeviceData + ) +{ + EFI_TPL OldTpl; + UINT8 *TxBuf; + EFI_STATUS Status; + LIST_ENTRY *Entry; + MNP_TX_BUF_WRAP *TxBufWrap; + + NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + if (IsListEmpty (&MnpDeviceData->FreeTxBufList)) { + // + // First try to recycle some TX buffer from SNP + // + Status = MnpRecycleTxBuf (MnpDeviceData); + if (EFI_ERROR (Status)) { + TxBuf = NULL; + goto ON_EXIT; + } + + // + // If still no free TX buffer, allocate more. + // + if (IsListEmpty (&MnpDeviceData->FreeTxBufList)) { + if ((MnpDeviceData->TxBufCount + MNP_TX_BUFFER_INCREASEMENT) > MNP_MAX_TX_BUFFER_NUM) { + DEBUG ( + (EFI_D_ERROR, + "MnpAllocTxBuf: The maximum TxBuf size is reached for MNP driver instance %p.\n", + MnpDeviceData) + ); + + TxBuf = NULL; + goto ON_EXIT; + } + + Status = MnpAddFreeTxBuf (MnpDeviceData, MNP_TX_BUFFER_INCREASEMENT); + if (IsListEmpty (&MnpDeviceData->FreeTxBufList)) { + DEBUG ( + (EFI_D_ERROR, + "MnpAllocNbuf: Failed to add TxBuf into the FreeTxBufList, %r.\n", + Status) + ); + + TxBuf = NULL; + goto ON_EXIT; + } + } + } + + ASSERT (!IsListEmpty (&MnpDeviceData->FreeTxBufList)); + Entry = MnpDeviceData->FreeTxBufList.ForwardLink; + RemoveEntryList (MnpDeviceData->FreeTxBufList.ForwardLink); + TxBufWrap = NET_LIST_USER_STRUCT_S (Entry, MNP_TX_BUF_WRAP, WrapEntry, MNP_TX_BUF_WRAP_SIGNATURE); + TxBufWrap->InUse = TRUE; + TxBuf = TxBufWrap->TxBuf; + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + + return TxBuf; +} + +/** + Try to reclaim the TX buffer into the buffer pool. + + @param[in, out] MnpDeviceData Pointer to the mnp device context data. + @param[in, out] TxBuf Pointer to the TX buffer to free. + +**/ +VOID +MnpFreeTxBuf ( + IN OUT MNP_DEVICE_DATA *MnpDeviceData, + IN OUT UINT8 *TxBuf + ) +{ + MNP_TX_BUF_WRAP *TxBufWrap; + EFI_TPL OldTpl; + + NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); + + if (TxBuf == NULL) { + return; + } + + TxBufWrap = NET_LIST_USER_STRUCT (TxBuf, MNP_TX_BUF_WRAP, TxBuf); + if (TxBufWrap->Signature != MNP_TX_BUF_WRAP_SIGNATURE) { + DEBUG ( + (EFI_D_ERROR, + "MnpFreeTxBuf: Signature check failed in MnpFreeTxBuf.\n") + ); + return; + } + + if (!TxBufWrap->InUse) { + DEBUG ( + (EFI_D_WARN, + "MnpFreeTxBuf: Duplicated recycle report from SNP.\n") + ); + return; + } + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + InsertTailList (&MnpDeviceData->FreeTxBufList, &TxBufWrap->WrapEntry); + TxBufWrap->InUse = FALSE; + gBS->RestoreTPL (OldTpl); +} + +/** + Try to recycle all the transmitted buffer address from SNP. + + @param[in, out] MnpDeviceData Pointer to the mnp device context data. + + @retval EFI_SUCCESS Successed to recyclethe transmitted buffer address. + @retval Others Failed to recyclethe transmitted buffer address. + +**/ +EFI_STATUS +MnpRecycleTxBuf ( + IN OUT MNP_DEVICE_DATA *MnpDeviceData + ) +{ + UINT8 *TxBuf; + EFI_SIMPLE_NETWORK_PROTOCOL *Snp; + EFI_STATUS Status; + + Snp = MnpDeviceData->Snp; + ASSERT (Snp != NULL); + + do { + TxBuf = NULL; + Status = Snp->GetStatus (Snp, NULL, (VOID **) &TxBuf); + if (EFI_ERROR (Status)) { + return Status; + } + + if (TxBuf != NULL) { + MnpFreeTxBuf (MnpDeviceData, TxBuf); + } + } while (TxBuf != NULL); + + return EFI_SUCCESS; +} + +/** + Initialize the mnp device context data. + + @param[in, out] MnpDeviceData Pointer to the mnp device context data. + @param[in] ImageHandle The driver image handle. + @param[in] ControllerHandle Handle of device to bind driver to. + + @retval EFI_SUCCESS The mnp service context is initialized. + @retval EFI_UNSUPPORTED ControllerHandle does not support Simple Network Protocol. + @retval Others Other errors as indicated. + +**/ +EFI_STATUS +MnpInitializeDeviceData ( + IN OUT MNP_DEVICE_DATA *MnpDeviceData, + IN EFI_HANDLE ImageHandle, + IN EFI_HANDLE ControllerHandle + ) +{ + EFI_STATUS Status; + EFI_SIMPLE_NETWORK_PROTOCOL *Snp; + EFI_SIMPLE_NETWORK_MODE *SnpMode; + + MnpDeviceData->Signature = MNP_DEVICE_DATA_SIGNATURE; + MnpDeviceData->ImageHandle = ImageHandle; + MnpDeviceData->ControllerHandle = ControllerHandle; + + // + // Copy the MNP Protocol interfaces from the template. + // + CopyMem (&MnpDeviceData->VlanConfig, &mVlanConfigProtocolTemplate, sizeof (EFI_VLAN_CONFIG_PROTOCOL)); + + // + // Open the Simple Network protocol. + // + Status = gBS->OpenProtocol ( + ControllerHandle, + &gEfiSimpleNetworkProtocolGuid, + (VOID **) &Snp, + ImageHandle, + ControllerHandle, + EFI_OPEN_PROTOCOL_BY_DRIVER + ); + if (EFI_ERROR (Status)) { + return EFI_UNSUPPORTED; + } + + // + // Get MTU from Snp. + // + SnpMode = Snp->Mode; + MnpDeviceData->Snp = Snp; + + // + // Initialize the lists. + // + InitializeListHead (&MnpDeviceData->ServiceList); + InitializeListHead (&MnpDeviceData->GroupAddressList); + + // + // Get the buffer length used to allocate NET_BUF to hold data received + // from SNP. Do this before fill the FreeNetBufQue. + // + // + MnpDeviceData->BufferLength = SnpMode->MediaHeaderSize + NET_VLAN_TAG_LEN + SnpMode->MaxPacketSize + NET_ETHER_FCS_SIZE; + + // + // Make sure the protocol headers immediately following the media header + // 4-byte aligned, and also preserve additional space for VLAN tag + // + MnpDeviceData->PaddingSize = ((4 - SnpMode->MediaHeaderSize) & 0x3) + NET_VLAN_TAG_LEN; + + // + // Initialize MAC string which will be used as VLAN configuration variable name + // + Status = NetLibGetMacString (ControllerHandle, ImageHandle, &MnpDeviceData->MacString); + if (EFI_ERROR (Status)) { + goto ERROR; + } + + // + // Initialize the FreeNetBufQue and pre-allocate some NET_BUFs. + // + NetbufQueInit (&MnpDeviceData->FreeNbufQue); + Status = MnpAddFreeNbuf (MnpDeviceData, MNP_INIT_NET_BUFFER_NUM); + if (EFI_ERROR (Status)) { + DEBUG ((EFI_D_ERROR, "MnpInitializeDeviceData: MnpAddFreeNbuf failed, %r.\n", Status)); + + goto ERROR; + } + + // + // Get one NET_BUF from the FreeNbufQue for rx cache. + // + MnpDeviceData->RxNbufCache = MnpAllocNbuf (MnpDeviceData); + NetbufAllocSpace ( + MnpDeviceData->RxNbufCache, + MnpDeviceData->BufferLength, + NET_BUF_TAIL + ); + + // + // Allocate buffer pool for tx. + // + InitializeListHead (&MnpDeviceData->FreeTxBufList); + InitializeListHead (&MnpDeviceData->AllTxBufList); + MnpDeviceData->TxBufCount = 0; + + // + // Create the system poll timer. + // + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL | EVT_TIMER, + TPL_CALLBACK, + MnpSystemPoll, + MnpDeviceData, + &MnpDeviceData->PollTimer + ); + if (EFI_ERROR (Status)) { + DEBUG ((EFI_D_ERROR, "MnpInitializeDeviceData: CreateEvent for poll timer failed.\n")); + + goto ERROR; + } + + // + // Create the timer for packet timeout check. + // + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL | EVT_TIMER, + TPL_CALLBACK, + MnpCheckPacketTimeout, + MnpDeviceData, + &MnpDeviceData->TimeoutCheckTimer + ); + if (EFI_ERROR (Status)) { + DEBUG ((EFI_D_ERROR, "MnpInitializeDeviceData: CreateEvent for packet timeout check failed.\n")); + + goto ERROR; + } + + // + // Create the timer for media detection. + // + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL | EVT_TIMER, + TPL_CALLBACK, + MnpCheckMediaStatus, + MnpDeviceData, + &MnpDeviceData->MediaDetectTimer + ); + if (EFI_ERROR (Status)) { + DEBUG ((EFI_D_ERROR, "MnpInitializeDeviceData: CreateEvent for media detection failed.\n")); + + goto ERROR; + } + +ERROR: + if (EFI_ERROR (Status)) { + // + // Free the dynamic allocated resources if necessary. + // + if (MnpDeviceData->MacString != NULL) { + FreePool (MnpDeviceData->MacString); + } + + if (MnpDeviceData->TimeoutCheckTimer != NULL) { + gBS->CloseEvent (MnpDeviceData->TimeoutCheckTimer); + } + + if (MnpDeviceData->MediaDetectTimer != NULL) { + gBS->CloseEvent (MnpDeviceData->MediaDetectTimer); + } + + if (MnpDeviceData->PollTimer != NULL) { + gBS->CloseEvent (MnpDeviceData->PollTimer); + } + + if (MnpDeviceData->RxNbufCache != NULL) { + MnpFreeNbuf (MnpDeviceData, MnpDeviceData->RxNbufCache); + } + + if (MnpDeviceData->FreeNbufQue.BufNum != 0) { + NetbufQueFlush (&MnpDeviceData->FreeNbufQue); + } + + // + // Close the Simple Network Protocol. + // + gBS->CloseProtocol ( + ControllerHandle, + &gEfiSimpleNetworkProtocolGuid, + ImageHandle, + ControllerHandle + ); + } + + return Status; +} + + +/** + Destroy the MNP device context data. + + @param[in, out] MnpDeviceData Pointer to the mnp device context data. + @param[in] ImageHandle The driver image handle. + +**/ +VOID +MnpDestroyDeviceData ( + IN OUT MNP_DEVICE_DATA *MnpDeviceData, + IN EFI_HANDLE ImageHandle + ) +{ + LIST_ENTRY *Entry; + LIST_ENTRY *NextEntry; + MNP_TX_BUF_WRAP *TxBufWrap; + + NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); + + // + // Free Vlan Config variable name string + // + if (MnpDeviceData->MacString != NULL) { + FreePool (MnpDeviceData->MacString); + } + + // + // The GroupAddressList must be empty. + // + ASSERT (IsListEmpty (&MnpDeviceData->GroupAddressList)); + + // + // Close the event. + // + gBS->CloseEvent (MnpDeviceData->TimeoutCheckTimer); + gBS->CloseEvent (MnpDeviceData->MediaDetectTimer); + gBS->CloseEvent (MnpDeviceData->PollTimer); + + // + // Free the Tx buffer pool. + // + NET_LIST_FOR_EACH_SAFE(Entry, NextEntry, &MnpDeviceData->AllTxBufList) { + TxBufWrap = NET_LIST_USER_STRUCT (Entry, MNP_TX_BUF_WRAP, AllEntry); + RemoveEntryList (Entry); + FreePool (TxBufWrap); + MnpDeviceData->TxBufCount--; + } + ASSERT (IsListEmpty (&MnpDeviceData->AllTxBufList)); + ASSERT (MnpDeviceData->TxBufCount == 0); + + // + // Free the RxNbufCache. + // + MnpFreeNbuf (MnpDeviceData, MnpDeviceData->RxNbufCache); + + // + // Flush the FreeNbufQue. + // + MnpDeviceData->NbufCnt -= MnpDeviceData->FreeNbufQue.BufNum; + NetbufQueFlush (&MnpDeviceData->FreeNbufQue); + + // + // Close the Simple Network Protocol. + // + gBS->CloseProtocol ( + MnpDeviceData->ControllerHandle, + &gEfiSimpleNetworkProtocolGuid, + ImageHandle, + MnpDeviceData->ControllerHandle + ); +} + + +/** + Create mnp service context data. + + @param[in] MnpDeviceData Pointer to the mnp device context data. + @param[in] VlanId The VLAN ID. + @param[in] Priority The VLAN priority. If VlanId is 0, + Priority is ignored. + + @return A pointer to MNP_SERVICE_DATA or NULL if failed to create MNP service context. + +**/ +MNP_SERVICE_DATA * +MnpCreateServiceData ( + IN MNP_DEVICE_DATA *MnpDeviceData, + IN UINT16 VlanId, + IN UINT8 Priority OPTIONAL + ) +{ + EFI_HANDLE MnpServiceHandle; + MNP_SERVICE_DATA *MnpServiceData; + EFI_STATUS Status; + EFI_SIMPLE_NETWORK_MODE *SnpMode; + EFI_VLAN_CONFIG_PROTOCOL *VlanConfig; + + // + // Initialize the Mnp Service Data. + // + MnpServiceData = AllocateZeroPool (sizeof (MNP_SERVICE_DATA)); + if (MnpServiceData == NULL) { + DEBUG ((EFI_D_ERROR, "MnpCreateServiceData: Faild to allocate memory for the new Mnp Service Data.\n")); + + return NULL; + } + + // + // Add to MNP service list + // + InsertTailList (&MnpDeviceData->ServiceList, &MnpServiceData->Link); + + MnpServiceData->Signature = MNP_SERVICE_DATA_SIGNATURE; + MnpServiceData->MnpDeviceData = MnpDeviceData; + + // + // Copy the ServiceBinding structure. + // + CopyMem (&MnpServiceData->ServiceBinding, &mMnpServiceBindingProtocol, sizeof (EFI_SERVICE_BINDING_PROTOCOL)); + + // + // Initialize the lists. + // + InitializeListHead (&MnpServiceData->ChildrenList); + + SnpMode = MnpDeviceData->Snp->Mode; + if (VlanId != 0) { + // + // Create VLAN child handle + // + MnpServiceHandle = MnpCreateVlanChild ( + MnpDeviceData->ImageHandle, + MnpDeviceData->ControllerHandle, + VlanId, + &MnpServiceData->DevicePath + ); + if (MnpServiceHandle == NULL) { + DEBUG ((EFI_D_ERROR, "MnpCreateServiceData: Faild to create child handle.\n")); + + return NULL; + } + + // + // Open VLAN Config Protocol by child + // + Status = gBS->OpenProtocol ( + MnpDeviceData->ControllerHandle, + &gEfiVlanConfigProtocolGuid, + (VOID **) &VlanConfig, + MnpDeviceData->ImageHandle, + MnpServiceHandle, + EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER + ); + if (EFI_ERROR (Status)) { + goto Exit; + } + + // + // Reduce MTU for VLAN device + // + MnpServiceData->Mtu = SnpMode->MaxPacketSize - NET_VLAN_TAG_LEN; + } else { + // + // VlanId set to 0 means rx/tx untagged frame + // + MnpServiceHandle = MnpDeviceData->ControllerHandle; + MnpServiceData->Mtu = SnpMode->MaxPacketSize; + } + + MnpServiceData->ServiceHandle = MnpServiceHandle; + MnpServiceData->VlanId = VlanId; + MnpServiceData->Priority = Priority; + + // + // Install the MNP Service Binding Protocol + // + Status = gBS->InstallMultipleProtocolInterfaces ( + &MnpServiceHandle, + &gEfiManagedNetworkServiceBindingProtocolGuid, + &MnpServiceData->ServiceBinding, + NULL + ); + +Exit: + if (EFI_ERROR (Status)) { + MnpDestroyServiceData (MnpServiceData); + MnpServiceData = NULL; + } + + return MnpServiceData; +} + +/** + Destroy the MNP service context data. + + @param[in, out] MnpServiceData Pointer to the mnp service context data. + + @retval EFI_SUCCESS The mnp service context is destroyed. + @retval Others Errors as indicated. + +**/ +EFI_STATUS +MnpDestroyServiceData ( + IN OUT MNP_SERVICE_DATA *MnpServiceData + ) +{ + EFI_STATUS Status; + + // + // Uninstall the MNP Service Binding Protocol + // + Status = gBS->UninstallMultipleProtocolInterfaces ( + MnpServiceData->ServiceHandle, + &gEfiManagedNetworkServiceBindingProtocolGuid, + &MnpServiceData->ServiceBinding, + NULL + ); + if (EFI_ERROR (Status)) { + return Status; + } + + if (MnpServiceData->VlanId != 0) { + // + // Close VlanConfig Protocol opened by VLAN child handle + // + Status = gBS->CloseProtocol ( + MnpServiceData->MnpDeviceData->ControllerHandle, + &gEfiVlanConfigProtocolGuid, + MnpServiceData->MnpDeviceData->ImageHandle, + MnpServiceData->ServiceHandle + ); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Uninstall Device Path Protocol to destroy the VLAN child handle + // + Status = gBS->UninstallMultipleProtocolInterfaces ( + MnpServiceData->ServiceHandle, + &gEfiDevicePathProtocolGuid, + MnpServiceData->DevicePath, + NULL + ); + if (EFI_ERROR (Status)) { + return Status; + } + + if (MnpServiceData->DevicePath != NULL) { + FreePool (MnpServiceData->DevicePath); + } + } + + // + // Remove from MnpDeviceData service list + // + RemoveEntryList (&MnpServiceData->Link); + + FreePool (MnpServiceData); + + return Status; +} + +/** + Callback function which provided by user to remove one node in NetDestroyLinkList process. + + @param[in] Entry The entry to be removed. + @param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList. + + @retval EFI_SUCCESS The entry has been removed successfully. + @retval Others Fail to remove the entry. + +**/ +EFI_STATUS +EFIAPI +MnpDestoryChildEntry ( + IN LIST_ENTRY *Entry, + IN VOID *Context + ) +{ + MNP_INSTANCE_DATA *Instance; + EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; + + ServiceBinding = (EFI_SERVICE_BINDING_PROTOCOL *) Context; + Instance = CR (Entry, MNP_INSTANCE_DATA, InstEntry, MNP_INSTANCE_DATA_SIGNATURE); + return ServiceBinding->DestroyChild (ServiceBinding, Instance->Handle); +} + +/** + Destroy all child of the MNP service data. + + @param[in, out] MnpServiceData Pointer to the mnp service context data. + + @retval EFI_SUCCESS All child are destroyed. + @retval Others Failed to destroy all child. + +**/ +EFI_STATUS +MnpDestroyServiceChild ( + IN OUT MNP_SERVICE_DATA *MnpServiceData + ) +{ + LIST_ENTRY *List; + EFI_STATUS Status; + UINTN ListLength; + + List = &MnpServiceData->ChildrenList; + + Status = NetDestroyLinkList ( + List, + MnpDestoryChildEntry, + &MnpServiceData->ServiceBinding, + &ListLength + ); + if (EFI_ERROR (Status) || ListLength != 0) { + return EFI_DEVICE_ERROR; + } + + return EFI_SUCCESS; +} + +/** + Find the MNP Service Data for given VLAN ID. + + @param[in] MnpDeviceData Pointer to the mnp device context data. + @param[in] VlanId The VLAN ID. + + @return A pointer to MNP_SERVICE_DATA or NULL if not found. + +**/ +MNP_SERVICE_DATA * +MnpFindServiceData ( + IN MNP_DEVICE_DATA *MnpDeviceData, + IN UINT16 VlanId + ) +{ + LIST_ENTRY *Entry; + MNP_SERVICE_DATA *MnpServiceData; + + NET_LIST_FOR_EACH (Entry, &MnpDeviceData->ServiceList) { + // + // Check VLAN ID of each Mnp Service Data + // + MnpServiceData = MNP_SERVICE_DATA_FROM_LINK (Entry); + if (MnpServiceData->VlanId == VlanId) { + return MnpServiceData; + } + } + + return NULL; +} + +/** + Initialize the mnp instance context data. + + @param[in] MnpServiceData Pointer to the mnp service context data. + @param[in, out] Instance Pointer to the mnp instance context data + to initialize. + +**/ +VOID +MnpInitializeInstanceData ( + IN MNP_SERVICE_DATA *MnpServiceData, + IN OUT MNP_INSTANCE_DATA *Instance + ) +{ + NET_CHECK_SIGNATURE (MnpServiceData, MNP_SERVICE_DATA_SIGNATURE); + ASSERT (Instance != NULL); + + // + // Set the signature. + // + Instance->Signature = MNP_INSTANCE_DATA_SIGNATURE; + + // + // Copy the MNP Protocol interfaces from the template. + // + CopyMem (&Instance->ManagedNetwork, &mMnpProtocolTemplate, sizeof (Instance->ManagedNetwork)); + + // + // Copy the default config data. + // + CopyMem (&Instance->ConfigData, &mMnpDefaultConfigData, sizeof (Instance->ConfigData)); + + // + // Initialize the lists. + // + InitializeListHead (&Instance->GroupCtrlBlkList); + InitializeListHead (&Instance->RcvdPacketQueue); + InitializeListHead (&Instance->RxDeliveredPacketQueue); + + // + // Initialize the RxToken Map. + // + NetMapInit (&Instance->RxTokenMap); + + // + // Save the MnpServiceData info. + // + Instance->MnpServiceData = MnpServiceData; +} + + +/** + Check whether the token specified by Arg matches the token in Item. + + @param[in] Map Pointer to the NET_MAP. + @param[in] Item Pointer to the NET_MAP_ITEM. + @param[in] Arg Pointer to the Arg, it's a pointer to the token to + check. + + @retval EFI_SUCCESS The token specified by Arg is different from the + token in Item. + @retval EFI_ACCESS_DENIED The token specified by Arg is the same as that in + Item. + +**/ +EFI_STATUS +EFIAPI +MnpTokenExist ( + IN NET_MAP *Map, + IN NET_MAP_ITEM *Item, + IN VOID *Arg + ) +{ + EFI_MANAGED_NETWORK_COMPLETION_TOKEN *Token; + EFI_MANAGED_NETWORK_COMPLETION_TOKEN *TokenInItem; + + Token = (EFI_MANAGED_NETWORK_COMPLETION_TOKEN *) Arg; + TokenInItem = (EFI_MANAGED_NETWORK_COMPLETION_TOKEN *) Item->Key; + + if ((Token == TokenInItem) || (Token->Event == TokenInItem->Event)) { + // + // The token is the same either the two tokens equals or the Events in + // the two tokens are the same. + // + return EFI_ACCESS_DENIED; + } + + return EFI_SUCCESS; +} + +/** + Cancel the token specified by Arg if it matches the token in Item. + + @param[in, out] Map Pointer to the NET_MAP. + @param[in, out] Item Pointer to the NET_MAP_ITEM. + @param[in] Arg Pointer to the Arg, it's a pointer to the + token to cancel. + + @retval EFI_SUCCESS The Arg is NULL, and the token in Item is cancelled, + or the Arg isn't NULL, and the token in Item is + different from the Arg. + @retval EFI_ABORTED The Arg isn't NULL, the token in Item mathces the + Arg, and the token is cancelled. + +**/ +EFI_STATUS +EFIAPI +MnpCancelTokens ( + IN OUT NET_MAP *Map, + IN OUT NET_MAP_ITEM *Item, + IN VOID *Arg + ) +{ + EFI_MANAGED_NETWORK_COMPLETION_TOKEN *TokenToCancel; + + if ((Arg != NULL) && (Item->Key != Arg)) { + // + // The token in Item is not the token specified by Arg. + // + return EFI_SUCCESS; + } + + TokenToCancel = (EFI_MANAGED_NETWORK_COMPLETION_TOKEN *) Item->Key; + + // + // Remove the item from the map. + // + NetMapRemoveItem (Map, Item, NULL); + + // + // Cancel this token with status set to EFI_ABORTED. + // + TokenToCancel->Status = EFI_ABORTED; + gBS->SignalEvent (TokenToCancel->Event); + + if (Arg != NULL) { + // + // Only abort the token specified by Arg if Arg isn't NULL. + // + return EFI_ABORTED; + } + + return EFI_SUCCESS; +} + + +/** + Start and initialize the simple network. + + @param[in] Snp Pointer to the simple network protocol. + + @retval EFI_SUCCESS The simple network protocol is started. + @retval Others Other errors as indicated. + +**/ +EFI_STATUS +MnpStartSnp ( + IN EFI_SIMPLE_NETWORK_PROTOCOL *Snp + ) +{ + EFI_STATUS Status; + + ASSERT (Snp != NULL); + + // + // Start the simple network. + // + Status = Snp->Start (Snp); + + if (!EFI_ERROR (Status)) { + // + // Initialize the simple network. + // + Status = Snp->Initialize (Snp, 0, 0); + } + + return Status; +} + + +/** + Stop the simple network. + + @param[in] MnpDeviceData Pointer to the MNP_DEVICE_DATA. + + @retval EFI_SUCCESS The simple network is stopped. + @retval Others Other errors as indicated. + +**/ +EFI_STATUS +MnpStopSnp ( + IN MNP_DEVICE_DATA *MnpDeviceData + ) +{ + EFI_STATUS Status; + EFI_SIMPLE_NETWORK_PROTOCOL *Snp; + + Snp = MnpDeviceData->Snp; + ASSERT (Snp != NULL); + + // + // Recycle all the transmit buffer from SNP. + // + Status = MnpRecycleTxBuf (MnpDeviceData); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Shut down the simple network. + // + Status = Snp->Shutdown (Snp); + if (!EFI_ERROR (Status)) { + // + // Stop the simple network. + // + Status = Snp->Stop (Snp); + } + + return Status; +} + + +/** + Start the managed network, this function is called when one instance is configured + or reconfigured. + + @param[in, out] MnpServiceData Pointer to the mnp service context data. + @param[in] IsConfigUpdate The instance is reconfigured or it's the first + time the instanced is configured. + @param[in] EnableSystemPoll Enable the system polling or not. + + @retval EFI_SUCCESS The managed network is started and some + configuration is updated. + @retval Others Other errors as indicated. + +**/ +EFI_STATUS +MnpStart ( + IN OUT MNP_SERVICE_DATA *MnpServiceData, + IN BOOLEAN IsConfigUpdate, + IN BOOLEAN EnableSystemPoll + ) +{ + EFI_STATUS Status; + EFI_TIMER_DELAY TimerOpType; + MNP_DEVICE_DATA *MnpDeviceData; + + NET_CHECK_SIGNATURE (MnpServiceData, MNP_SERVICE_DATA_SIGNATURE); + + Status = EFI_SUCCESS; + MnpDeviceData = MnpServiceData->MnpDeviceData; + + if (!IsConfigUpdate) { + // + // If it's not a configuration update, increase the configured children number. + // + MnpDeviceData->ConfiguredChildrenNumber++; + + if (MnpDeviceData->ConfiguredChildrenNumber == 1) { + // + // It's the first configured child, start the simple network. + // + Status = MnpStartSnp (MnpDeviceData->Snp); + if (EFI_ERROR (Status)) { + DEBUG ((EFI_D_ERROR, "MnpStart: MnpStartSnp failed, %r.\n", Status)); + + goto ErrorExit; + } + + // + // Start the timeout timer. + // + Status = gBS->SetTimer ( + MnpDeviceData->TimeoutCheckTimer, + TimerPeriodic, + MNP_TIMEOUT_CHECK_INTERVAL + ); + if (EFI_ERROR (Status)) { + DEBUG ( + (EFI_D_ERROR, + "MnpStart, gBS->SetTimer for TimeoutCheckTimer %r.\n", + Status) + ); + + goto ErrorExit; + } + + // + // Start the media detection timer. + // + Status = gBS->SetTimer ( + MnpDeviceData->MediaDetectTimer, + TimerPeriodic, + MNP_MEDIA_DETECT_INTERVAL + ); + if (EFI_ERROR (Status)) { + DEBUG ( + (EFI_D_ERROR, + "MnpStart, gBS->SetTimer for MediaDetectTimer %r.\n", + Status) + ); + + goto ErrorExit; + } + } + } + + if (MnpDeviceData->EnableSystemPoll ^ EnableSystemPoll) { + // + // The EnableSystemPoll differs with the current state, disable or enable + // the system poll. + // + TimerOpType = EnableSystemPoll ? TimerPeriodic : TimerCancel; + + Status = gBS->SetTimer (MnpDeviceData->PollTimer, TimerOpType, MNP_SYS_POLL_INTERVAL); + if (EFI_ERROR (Status)) { + DEBUG ((EFI_D_ERROR, "MnpStart: gBS->SetTimer for PollTimer failed, %r.\n", Status)); + + goto ErrorExit; + } + + MnpDeviceData->EnableSystemPoll = EnableSystemPoll; + } + + // + // Change the receive filters if need. + // + Status = MnpConfigReceiveFilters (MnpDeviceData); + +ErrorExit: + return Status; +} + + +/** + Stop the managed network. + + @param[in, out] MnpServiceData Pointer to the mnp service context data. + + @retval EFI_SUCCESS The managed network is stopped. + @retval Others Other errors as indicated. + +**/ +EFI_STATUS +MnpStop ( + IN OUT MNP_SERVICE_DATA *MnpServiceData + ) +{ + EFI_STATUS Status; + MNP_DEVICE_DATA *MnpDeviceData; + + NET_CHECK_SIGNATURE (MnpServiceData, MNP_SERVICE_DATA_SIGNATURE); + MnpDeviceData = MnpServiceData->MnpDeviceData; + ASSERT (MnpDeviceData->ConfiguredChildrenNumber > 0); + + // + // Configure the receive filters. + // + MnpConfigReceiveFilters (MnpDeviceData); + + // + // Decrease the children number. + // + MnpDeviceData->ConfiguredChildrenNumber--; + + if (MnpDeviceData->ConfiguredChildrenNumber > 0) { + // + // If there are other configured chilren, return and keep the timers and + // simple network unchanged. + // + return EFI_SUCCESS; + } + + // + // No configured children now. + // + if (MnpDeviceData->EnableSystemPoll) { + // + // The system poll in on, cancel the poll timer. + // + Status = gBS->SetTimer (MnpDeviceData->PollTimer, TimerCancel, 0); + MnpDeviceData->EnableSystemPoll = FALSE; + } + + // + // Cancel the timeout timer. + // + Status = gBS->SetTimer (MnpDeviceData->TimeoutCheckTimer, TimerCancel, 0); + + // + // Cancel the media detect timer. + // + Status = gBS->SetTimer (MnpDeviceData->MediaDetectTimer, TimerCancel, 0); + + // + // Stop the simple network. + // + Status = MnpStopSnp (MnpDeviceData); + return Status; +} + + +/** + Flush the instance's received data. + + @param[in, out] Instance Pointer to the mnp instance context data. + +**/ +VOID +MnpFlushRcvdDataQueue ( + IN OUT MNP_INSTANCE_DATA *Instance + ) +{ + EFI_TPL OldTpl; + MNP_RXDATA_WRAP *RxDataWrap; + + NET_CHECK_SIGNATURE (Instance, MNP_INSTANCE_DATA_SIGNATURE); + + OldTpl = gBS->RaiseTPL (TPL_NOTIFY); + + while (!IsListEmpty (&Instance->RcvdPacketQueue)) { + // + // Remove all the Wraps. + // + RxDataWrap = NET_LIST_HEAD (&Instance->RcvdPacketQueue, MNP_RXDATA_WRAP, WrapEntry); + + // + // Recycle the RxDataWrap. + // + MnpRecycleRxData (NULL, (VOID *) RxDataWrap); + Instance->RcvdPacketQueueSize--; + } + + ASSERT (Instance->RcvdPacketQueueSize == 0); + + gBS->RestoreTPL (OldTpl); +} + + +/** + Configure the Instance using ConfigData. + + @param[in, out] Instance Pointer to the mnp instance context data. + @param[in] ConfigData Pointer to the configuration data used to configure + the isntance. + + @retval EFI_SUCCESS The Instance is configured. + @retval EFI_UNSUPPORTED EnableReceiveTimestamps is on and the + implementation doesn't support it. + @retval Others Other errors as indicated. + +**/ +EFI_STATUS +MnpConfigureInstance ( + IN OUT MNP_INSTANCE_DATA *Instance, + IN EFI_MANAGED_NETWORK_CONFIG_DATA *ConfigData OPTIONAL + ) +{ + EFI_STATUS Status; + MNP_SERVICE_DATA *MnpServiceData; + MNP_DEVICE_DATA *MnpDeviceData; + EFI_MANAGED_NETWORK_CONFIG_DATA *OldConfigData; + EFI_MANAGED_NETWORK_CONFIG_DATA *NewConfigData; + BOOLEAN IsConfigUpdate; + + NET_CHECK_SIGNATURE (Instance, MNP_INSTANCE_DATA_SIGNATURE); + + if ((ConfigData != NULL) && ConfigData->EnableReceiveTimestamps) { + // + // Don't support timestamp. + // + return EFI_UNSUPPORTED; + } + + Status = EFI_SUCCESS; + + MnpServiceData = Instance->MnpServiceData; + MnpDeviceData = MnpServiceData->MnpDeviceData; + NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); + + IsConfigUpdate = (BOOLEAN) ((Instance->Configured) && (ConfigData != NULL)); + + OldConfigData = &Instance->ConfigData; + NewConfigData = ConfigData; + if (NewConfigData == NULL) { + // + // Restore back the default config data if a reset of this instance + // is required. + // + NewConfigData = &mMnpDefaultConfigData; + } + + // + // Reset the instance's receive filter. + // + Instance->ReceiveFilter = 0; + + // + // Clear the receive counters according to the old ConfigData. + // + if (OldConfigData->EnableUnicastReceive) { + MnpDeviceData->UnicastCount--; + } + + if (OldConfigData->EnableMulticastReceive) { + MnpDeviceData->MulticastCount--; + } + + if (OldConfigData->EnableBroadcastReceive) { + MnpDeviceData->BroadcastCount--; + } + + if (OldConfigData->EnablePromiscuousReceive) { + MnpDeviceData->PromiscuousCount--; + } + + // + // Set the receive filter counters and the receive filter of the + // instance according to the new ConfigData. + // + if (NewConfigData->EnableUnicastReceive) { + MnpDeviceData->UnicastCount++; + Instance->ReceiveFilter |= MNP_RECEIVE_UNICAST; + } + + if (NewConfigData->EnableMulticastReceive) { + MnpDeviceData->MulticastCount++; + } + + if (NewConfigData->EnableBroadcastReceive) { + MnpDeviceData->BroadcastCount++; + Instance->ReceiveFilter |= MNP_RECEIVE_BROADCAST; + } + + if (NewConfigData->EnablePromiscuousReceive) { + MnpDeviceData->PromiscuousCount++; + } + + if (OldConfigData->FlushQueuesOnReset) { + MnpFlushRcvdDataQueue (Instance); + } + + if (ConfigData == NULL) { + Instance->ManagedNetwork.Cancel (&Instance->ManagedNetwork, NULL); + } + + if (!NewConfigData->EnableMulticastReceive) { + MnpGroupOp (Instance, FALSE, NULL, NULL); + } + + // + // Save the new configuration data. + // + CopyMem (OldConfigData, NewConfigData, sizeof (*OldConfigData)); + + Instance->Configured = (BOOLEAN) (ConfigData != NULL); + if (Instance->Configured) { + // + // The instance is configured, start the Mnp. + // + Status = MnpStart ( + MnpServiceData, + IsConfigUpdate, + (BOOLEAN) !NewConfigData->DisableBackgroundPolling + ); + } else { + // + // The instance is changed to the unconfigured state, stop the Mnp. + // + Status = MnpStop (MnpServiceData); + } + + return Status; +} + +/** + Configure the Snp receive filters according to the instances' receive filter + settings. + + @param[in] MnpDeviceData Pointer to the mnp device context data. + + @retval EFI_SUCCESS The receive filters is configured. + @retval EFI_OUT_OF_RESOURCES The receive filters can't be configured due + to lack of memory resource. + +**/ +EFI_STATUS +MnpConfigReceiveFilters ( + IN MNP_DEVICE_DATA *MnpDeviceData + ) +{ + EFI_STATUS Status; + EFI_SIMPLE_NETWORK_PROTOCOL *Snp; + EFI_MAC_ADDRESS *MCastFilter; + UINT32 MCastFilterCnt; + UINT32 EnableFilterBits; + UINT32 DisableFilterBits; + BOOLEAN ResetMCastFilters; + LIST_ENTRY *Entry; + UINT32 Index; + MNP_GROUP_ADDRESS *GroupAddress; + + NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); + + Snp = MnpDeviceData->Snp; + + // + // Initialize the enable filter and disable filter. + // + EnableFilterBits = 0; + DisableFilterBits = Snp->Mode->ReceiveFilterMask; + + if (MnpDeviceData->UnicastCount != 0) { + // + // Enable unicast if any instance wants to receive unicast. + // + EnableFilterBits |= EFI_SIMPLE_NETWORK_RECEIVE_UNICAST; + } + + if (MnpDeviceData->BroadcastCount != 0) { + // + // Enable broadcast if any instance wants to receive broadcast. + // + EnableFilterBits |= EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST; + } + + MCastFilter = NULL; + MCastFilterCnt = 0; + ResetMCastFilters = TRUE; + + if ((MnpDeviceData->MulticastCount != 0) && (MnpDeviceData->GroupAddressCount != 0)) { + // + // There are instances configured to receive multicast and already some group + // addresses are joined. + // + + ResetMCastFilters = FALSE; + + if (MnpDeviceData->GroupAddressCount <= Snp->Mode->MaxMCastFilterCount) { + // + // The joind group address is less than simple network's maximum count. + // Just configure the snp to do the multicast filtering. + // + + EnableFilterBits |= EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST; + + // + // Allocate pool for the mulicast addresses. + // + MCastFilterCnt = MnpDeviceData->GroupAddressCount; + MCastFilter = AllocatePool (sizeof (EFI_MAC_ADDRESS) * MCastFilterCnt); + if (MCastFilter == NULL) { + DEBUG ((EFI_D_ERROR, "MnpConfigReceiveFilters: Failed to allocate memory resource for MCastFilter.\n")); + + return EFI_OUT_OF_RESOURCES; + } + + // + // Fill the multicast HW address buffer. + // + Index = 0; + NET_LIST_FOR_EACH (Entry, &MnpDeviceData->GroupAddressList) { + + GroupAddress = NET_LIST_USER_STRUCT (Entry, MNP_GROUP_ADDRESS, AddrEntry); + CopyMem (MCastFilter + Index, &GroupAddress->Address, sizeof (*(MCastFilter + Index))); + Index++; + + ASSERT (Index <= MCastFilterCnt); + } + } else { + // + // The maximum multicast is reached, set the filter to be promiscuous + // multicast. + // + + if ((Snp->Mode->ReceiveFilterMask & EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST) != 0) { + EnableFilterBits |= EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST; + } else { + // + // Either MULTICAST or PROMISCUOUS_MULTICAST is not supported by Snp, + // set the NIC to be promiscuous although this will tremendously degrade + // the performance. + // + EnableFilterBits |= EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS; + } + } + } + + if (MnpDeviceData->PromiscuousCount != 0) { + // + // Enable promiscuous if any instance wants to receive promiscuous. + // + EnableFilterBits |= EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS; + } + + // + // Set the disable filter. + // + DisableFilterBits ^= EnableFilterBits; + + // + // Configure the receive filters of SNP. + // + Status = Snp->ReceiveFilters ( + Snp, + EnableFilterBits, + DisableFilterBits, + ResetMCastFilters, + MCastFilterCnt, + MCastFilter + ); + DEBUG_CODE ( + if (EFI_ERROR (Status)) { + DEBUG ( + (EFI_D_ERROR, + "MnpConfigReceiveFilters: Snp->ReceiveFilters failed, %r.\n", + Status) + ); + } + ); + + if (MCastFilter != NULL) { + // + // Free the buffer used to hold the group addresses. + // + FreePool (MCastFilter); + } + + return Status; +} + + +/** + Add a group address control block which controls the MacAddress for + this instance. + + @param[in, out] Instance Pointer to the mnp instance context data. + @param[in, out] CtrlBlk Pointer to the group address control block. + @param[in, out] GroupAddress Pointer to the group adress. + @param[in] MacAddress Pointer to the mac address. + @param[in] HwAddressSize The hardware address size. + + @retval EFI_SUCCESS The group address control block is added. + @retval EFI_OUT_OF_RESOURCES Failed due to lack of memory resources. + +**/ +EFI_STATUS +MnpGroupOpAddCtrlBlk ( + IN OUT MNP_INSTANCE_DATA *Instance, + IN OUT MNP_GROUP_CONTROL_BLOCK *CtrlBlk, + IN OUT MNP_GROUP_ADDRESS *GroupAddress OPTIONAL, + IN EFI_MAC_ADDRESS *MacAddress, + IN UINT32 HwAddressSize + ) +{ + MNP_DEVICE_DATA *MnpDeviceData; + + NET_CHECK_SIGNATURE (Instance, MNP_INSTANCE_DATA_SIGNATURE); + + MnpDeviceData = Instance->MnpServiceData->MnpDeviceData; + NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); + + if (GroupAddress == NULL) { + ASSERT (MacAddress != NULL); + + // + // Allocate a new GroupAddress to be added into MNP's GroupAddressList. + // + GroupAddress = AllocatePool (sizeof (MNP_GROUP_ADDRESS)); + if (GroupAddress == NULL) { + + DEBUG ((EFI_D_ERROR, "MnpGroupOpFormCtrlBlk: Failed to allocate memory resource.\n")); + + return EFI_OUT_OF_RESOURCES; + } + + CopyMem (&GroupAddress->Address, MacAddress, sizeof (GroupAddress->Address)); + GroupAddress->RefCnt = 0; + InsertTailList ( + &MnpDeviceData->GroupAddressList, + &GroupAddress->AddrEntry + ); + MnpDeviceData->GroupAddressCount++; + } + + // + // Increase the RefCnt. + // + GroupAddress->RefCnt++; + + // + // Add the CtrlBlk into the instance's GroupCtrlBlkList. + // + CtrlBlk->GroupAddress = GroupAddress; + InsertTailList (&Instance->GroupCtrlBlkList, &CtrlBlk->CtrlBlkEntry); + + return EFI_SUCCESS; +} + + +/** + Delete a group control block from the instance. If the controlled group address's + reference count reaches zero, the group address is removed too. + + @param[in] Instance Pointer to the instance context data. + @param[in] CtrlBlk Pointer to the group control block to delete. + + @return The group address controlled by the control block is no longer used or not. + +**/ +BOOLEAN +MnpGroupOpDelCtrlBlk ( + IN MNP_INSTANCE_DATA *Instance, + IN MNP_GROUP_CONTROL_BLOCK *CtrlBlk + ) +{ + MNP_DEVICE_DATA *MnpDeviceData; + MNP_GROUP_ADDRESS *GroupAddress; + + NET_CHECK_SIGNATURE (Instance, MNP_INSTANCE_DATA_SIGNATURE); + + MnpDeviceData = Instance->MnpServiceData->MnpDeviceData; + NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); + + // + // Remove and free the CtrlBlk. + // + GroupAddress = CtrlBlk->GroupAddress; + RemoveEntryList (&CtrlBlk->CtrlBlkEntry); + FreePool (CtrlBlk); + + ASSERT (GroupAddress->RefCnt > 0); + + // + // Count down the RefCnt. + // + GroupAddress->RefCnt--; + + if (GroupAddress->RefCnt == 0) { + // + // Free this GroupAddress entry if no instance uses it. + // + MnpDeviceData->GroupAddressCount--; + RemoveEntryList (&GroupAddress->AddrEntry); + FreePool (GroupAddress); + + return TRUE; + } + + return FALSE; +} + + +/** + Do the group operations for this instance. + + @param[in, out] Instance Pointer to the instance context data. + @param[in] JoinFlag Set to TRUE to join a group. Set to TRUE to + leave a group/groups. + @param[in] MacAddress Pointer to the group address to join or leave. + @param[in] CtrlBlk Pointer to the group control block if JoinFlag + is FALSE. + + @retval EFI_SUCCESS The group operation finished. + @retval EFI_OUT_OF_RESOURCES Failed due to lack of memory resources. + @retval Others Other errors as indicated. + +**/ +EFI_STATUS +MnpGroupOp ( + IN OUT MNP_INSTANCE_DATA *Instance, + IN BOOLEAN JoinFlag, + IN EFI_MAC_ADDRESS *MacAddress OPTIONAL, + IN MNP_GROUP_CONTROL_BLOCK *CtrlBlk OPTIONAL + ) +{ + MNP_DEVICE_DATA *MnpDeviceData; + LIST_ENTRY *Entry; + LIST_ENTRY *NextEntry; + MNP_GROUP_ADDRESS *GroupAddress; + EFI_SIMPLE_NETWORK_MODE *SnpMode; + MNP_GROUP_CONTROL_BLOCK *NewCtrlBlk; + EFI_STATUS Status; + BOOLEAN AddressExist; + BOOLEAN NeedUpdate; + + NET_CHECK_SIGNATURE (Instance, MNP_INSTANCE_DATA_SIGNATURE); + + MnpDeviceData = Instance->MnpServiceData->MnpDeviceData; + SnpMode = MnpDeviceData->Snp->Mode; + + if (JoinFlag) { + // + // A new gropu address is to be added. + // + GroupAddress = NULL; + AddressExist = FALSE; + + // + // Allocate memory for the control block. + // + NewCtrlBlk = AllocatePool (sizeof (MNP_GROUP_CONTROL_BLOCK)); + if (NewCtrlBlk == NULL) { + DEBUG ((EFI_D_ERROR, "MnpGroupOp: Failed to allocate memory resource.\n")); + + return EFI_OUT_OF_RESOURCES; + } + + NET_LIST_FOR_EACH (Entry, &MnpDeviceData->GroupAddressList) { + // + // Check whether the MacAddress is already joined by other instances. + // + GroupAddress = NET_LIST_USER_STRUCT (Entry, MNP_GROUP_ADDRESS, AddrEntry); + if (CompareMem (MacAddress, &GroupAddress->Address, SnpMode->HwAddressSize) == 0) { + AddressExist = TRUE; + break; + } + } + + if (!AddressExist) { + GroupAddress = NULL; + } + + // + // Add the GroupAddress for this instance. + // + Status = MnpGroupOpAddCtrlBlk ( + Instance, + NewCtrlBlk, + GroupAddress, + MacAddress, + SnpMode->HwAddressSize + ); + if (EFI_ERROR (Status)) { + return Status; + } + + NeedUpdate = TRUE; + } else { + if (MacAddress != NULL) { + ASSERT (CtrlBlk != NULL); + + // + // Leave the specific multicast mac address. + // + NeedUpdate = MnpGroupOpDelCtrlBlk (Instance, CtrlBlk); + } else { + // + // Leave all multicast mac addresses. + // + NeedUpdate = FALSE; + + NET_LIST_FOR_EACH_SAFE (Entry, NextEntry, &Instance->GroupCtrlBlkList) { + + NewCtrlBlk = NET_LIST_USER_STRUCT ( + Entry, + MNP_GROUP_CONTROL_BLOCK, + CtrlBlkEntry + ); + // + // Update is required if the group address left is no longer used + // by other instances. + // + NeedUpdate = MnpGroupOpDelCtrlBlk (Instance, NewCtrlBlk); + } + } + } + + Status = EFI_SUCCESS; + + if (NeedUpdate) { + // + // Reconfigure the receive filters if necessary. + // + Status = MnpConfigReceiveFilters (MnpDeviceData); + } + + return Status; +} diff --git a/NetworkPkg/MnpDxe/MnpDriver.c b/NetworkPkg/MnpDxe/MnpDriver.c new file mode 100644 index 0000000000..e99e7c5a61 --- /dev/null +++ b/NetworkPkg/MnpDxe/MnpDriver.c @@ -0,0 +1,683 @@ +/** @file + Implementation of driver entry point and driver binding protocol. + +Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "MnpDriver.h" +#include "MnpImpl.h" +#include "MnpVlan.h" + +EFI_DRIVER_BINDING_PROTOCOL gMnpDriverBinding = { + MnpDriverBindingSupported, + MnpDriverBindingStart, + MnpDriverBindingStop, + 0xa, + NULL, + NULL +}; + +/** + Callback function which provided by user to remove one node in NetDestroyLinkList process. + + @param[in] Entry The entry to be removed. + @param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList. + + @retval EFI_SUCCESS The entry has been removed successfully. + @retval Others Fail to remove the entry. + +**/ +EFI_STATUS +EFIAPI +MnpDestroyServiceDataEntry ( + IN LIST_ENTRY *Entry, + IN VOID *Context + ) +{ + MNP_SERVICE_DATA *MnpServiceData; + + MnpServiceData = MNP_SERVICE_DATA_FROM_LINK (Entry); + return MnpDestroyServiceData (MnpServiceData); +} + +/** + Callback function which provided by user to remove one node in NetDestroyLinkList process. + + @param[in] Entry The entry to be removed. + @param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList. + + @retval EFI_SUCCESS The entry has been removed successfully. + @retval Others Fail to remove the entry. + +**/ +EFI_STATUS +EFIAPI +MnpDestroyServiceChildEntry ( + IN LIST_ENTRY *Entry, + IN VOID *Context + ) +{ + MNP_SERVICE_DATA *MnpServiceData; + + MnpServiceData = MNP_SERVICE_DATA_FROM_LINK (Entry); + return MnpDestroyServiceChild (MnpServiceData); +} + +/** + Test to see if this driver supports ControllerHandle. This service + is called by the EFI boot service ConnectController(). In + order to make drivers as small as possible, there are a few calling + restrictions for this service. ConnectController() must + follow these calling restrictions. If any other agent wishes to call + Supported() it must also follow these calling restrictions. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to test. + @param[in] RemainingDevicePath Optional parameter use to pick a specific + child device to start. + + @retval EFI_SUCCESS This driver supports this device. + @retval EFI_ALREADY_STARTED This driver is already running on this device. + @retval Others This driver does not support this device. + +**/ +EFI_STATUS +EFIAPI +MnpDriverBindingSupported ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL + ) +{ + EFI_STATUS Status; + EFI_SIMPLE_NETWORK_PROTOCOL *Snp; + + // + // Test to open the Simple Network protocol BY_DRIVER. + // + Status = gBS->OpenProtocol ( + ControllerHandle, + &gEfiSimpleNetworkProtocolGuid, + (VOID **) &Snp, + This->DriverBindingHandle, + ControllerHandle, + EFI_OPEN_PROTOCOL_BY_DRIVER + ); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Close the openned SNP protocol. + // + gBS->CloseProtocol ( + ControllerHandle, + &gEfiSimpleNetworkProtocolGuid, + This->DriverBindingHandle, + ControllerHandle + ); + + return EFI_SUCCESS; +} + + +/** + Start this driver on ControllerHandle. This service is called by the + EFI boot service ConnectController(). In order to make drivers as small + as possible, there are a few calling restrictions for this service. + ConnectController() must follow these calling restrictions. If any other + agent wishes to call Start() it must also follow these calling restrictions. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to bind driver to. + @param[in] RemainingDevicePath Optional parameter use to pick a specific + child device to start. + + @retval EFI_SUCCESS This driver is added to ControllerHandle. + @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle. + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for Mnp Service Data. + @retval Others This driver does not support this device. + +**/ +EFI_STATUS +EFIAPI +MnpDriverBindingStart ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL + ) +{ + EFI_STATUS Status; + MNP_SERVICE_DATA *MnpServiceData; + MNP_DEVICE_DATA *MnpDeviceData; + LIST_ENTRY *Entry; + VLAN_TCI *VlanVariable; + UINTN NumberOfVlan; + UINTN Index; + + VlanVariable = NULL; + + // + // Initialize the Mnp Device Data + // + MnpDeviceData = AllocateZeroPool (sizeof (MNP_DEVICE_DATA)); + if (MnpDeviceData == NULL) { + DEBUG ((EFI_D_ERROR, "MnpDriverBindingStart(): Failed to allocate the Mnp Device Data.\n")); + + return EFI_OUT_OF_RESOURCES; + } + + Status = MnpInitializeDeviceData (MnpDeviceData, This->DriverBindingHandle, ControllerHandle); + if (EFI_ERROR (Status)) { + DEBUG ((EFI_D_ERROR, "MnpDriverBindingStart: MnpInitializeDeviceData failed, %r.\n", Status)); + + FreePool (MnpDeviceData); + return Status; + } + + // + // Check whether NIC driver has already produced VlanConfig protocol + // + Status = gBS->OpenProtocol ( + ControllerHandle, + &gEfiVlanConfigProtocolGuid, + NULL, + This->DriverBindingHandle, + ControllerHandle, + EFI_OPEN_PROTOCOL_TEST_PROTOCOL + ); + if (!EFI_ERROR (Status)) { + // + // NIC hardware already implement VLAN, + // no need to provide software VLAN implementation in MNP driver + // + MnpDeviceData->NumberOfVlan = 0; + ZeroMem (&MnpDeviceData->VlanConfig, sizeof (EFI_VLAN_CONFIG_PROTOCOL)); + MnpServiceData = MnpCreateServiceData (MnpDeviceData, 0, 0); + Status = (MnpServiceData != NULL) ? EFI_SUCCESS : EFI_OUT_OF_RESOURCES; + goto Exit; + } + + // + // Install VLAN Config Protocol + // + Status = gBS->InstallMultipleProtocolInterfaces ( + &ControllerHandle, + &gEfiVlanConfigProtocolGuid, + &MnpDeviceData->VlanConfig, + NULL + ); + if (EFI_ERROR (Status)) { + goto Exit; + } + + // + // Get current VLAN configuration from EFI Variable + // + NumberOfVlan = 0; + Status = MnpGetVlanVariable (MnpDeviceData, &NumberOfVlan, &VlanVariable); + if (EFI_ERROR (Status)) { + // + // No VLAN is set, create a default MNP service data for untagged frame + // + MnpDeviceData->NumberOfVlan = 0; + MnpServiceData = MnpCreateServiceData (MnpDeviceData, 0, 0); + Status = (MnpServiceData != NULL) ? EFI_SUCCESS : EFI_OUT_OF_RESOURCES; + goto Exit; + } + + // + // Create MNP service data for each VLAN + // + MnpDeviceData->NumberOfVlan = NumberOfVlan; + for (Index = 0; Index < NumberOfVlan; Index++) { + MnpServiceData = MnpCreateServiceData ( + MnpDeviceData, + VlanVariable[Index].Bits.Vid, + (UINT8) VlanVariable[Index].Bits.Priority + ); + + if (MnpServiceData == NULL) { + Status = EFI_OUT_OF_RESOURCES; + + goto Exit; + } + } + +Exit: + if (VlanVariable != NULL) { + FreePool (VlanVariable); + } + + if (EFI_ERROR (Status)) { + // + // Destroy all MNP service data + // + while (!IsListEmpty (&MnpDeviceData->ServiceList)) { + Entry = GetFirstNode (&MnpDeviceData->ServiceList); + MnpServiceData = MNP_SERVICE_DATA_FROM_LINK (Entry); + MnpDestroyServiceData (MnpServiceData); + } + + // + // Uninstall the VLAN Config Protocol if any + // + if (MnpDeviceData->VlanConfig.Set != NULL) { + gBS->UninstallMultipleProtocolInterfaces ( + MnpDeviceData->ControllerHandle, + &gEfiVlanConfigProtocolGuid, + &MnpDeviceData->VlanConfig, + NULL + ); + } + + // + // Destroy Mnp Device Data + // + MnpDestroyDeviceData (MnpDeviceData, This->DriverBindingHandle); + FreePool (MnpDeviceData); + } + + return Status; +} + +/** + Stop this driver on ControllerHandle. This service is called by the + EFI boot service DisconnectController(). In order to make drivers as + small as possible, there are a few calling restrictions for this service. + DisconnectController() must follow these calling restrictions. If any other + agent wishes to call Stop() it must also follow these calling restrictions. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to stop driver on. + @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If + number of children is zero stop the entire + bus driver. + @param[in] ChildHandleBuffer List of Child Handles to Stop. + + @retval EFI_SUCCESS This driver is removed ControllerHandle. + @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error. + +**/ +EFI_STATUS +EFIAPI +MnpDriverBindingStop ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN UINTN NumberOfChildren, + IN EFI_HANDLE *ChildHandleBuffer OPTIONAL + ) +{ + EFI_STATUS Status; + EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; + EFI_VLAN_CONFIG_PROTOCOL *VlanConfig; + MNP_DEVICE_DATA *MnpDeviceData; + MNP_SERVICE_DATA *MnpServiceData; + LIST_ENTRY *List; + UINTN ListLength; + + // + // Try to retrieve MNP service binding protocol from the ControllerHandle + // + Status = gBS->OpenProtocol ( + ControllerHandle, + &gEfiManagedNetworkServiceBindingProtocolGuid, + (VOID **) &ServiceBinding, + This->DriverBindingHandle, + ControllerHandle, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + if (EFI_ERROR (Status)) { + // + // Retrieve VLAN Config Protocol from the ControllerHandle + // + Status = gBS->OpenProtocol ( + ControllerHandle, + &gEfiVlanConfigProtocolGuid, + (VOID **) &VlanConfig, + This->DriverBindingHandle, + ControllerHandle, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + if (EFI_ERROR (Status)) { + DEBUG ((EFI_D_ERROR, "MnpDriverBindingStop: try to stop unknown Controller.\n")); + return EFI_DEVICE_ERROR; + } + + MnpDeviceData = MNP_DEVICE_DATA_FROM_THIS (VlanConfig); + } else { + MnpServiceData = MNP_SERVICE_DATA_FROM_THIS (ServiceBinding); + MnpDeviceData = MnpServiceData->MnpDeviceData; + } + + if (NumberOfChildren == 0) { + // + // Destroy all MNP service data + // + List = &MnpDeviceData->ServiceList; + Status = NetDestroyLinkList ( + List, + MnpDestroyServiceDataEntry, + NULL, + &ListLength + ); + if (EFI_ERROR (Status) || ListLength !=0) { + return EFI_DEVICE_ERROR; + } + + // + // Uninstall the VLAN Config Protocol if any + // + if (MnpDeviceData->VlanConfig.Set != NULL) { + gBS->UninstallMultipleProtocolInterfaces ( + MnpDeviceData->ControllerHandle, + &gEfiVlanConfigProtocolGuid, + &MnpDeviceData->VlanConfig, + NULL + ); + } + + // + // Destroy Mnp Device Data + // + MnpDestroyDeviceData (MnpDeviceData, This->DriverBindingHandle); + FreePool (MnpDeviceData); + + if (gMnpControllerNameTable != NULL) { + FreeUnicodeStringTable (gMnpControllerNameTable); + gMnpControllerNameTable = NULL; + } + return EFI_SUCCESS; + } + + // + // Stop all MNP child + // + List = &MnpDeviceData->ServiceList; + Status = NetDestroyLinkList ( + List, + MnpDestroyServiceChildEntry, + NULL, + &ListLength + ); + if (EFI_ERROR (Status)) { + return EFI_DEVICE_ERROR; + } + + return EFI_SUCCESS; +} + + +/** + Creates a child handle with a set of I/O services. + + @param[in] This Protocol instance pointer. + @param[in, out] ChildHandle Pointer to the handle of the child to create. If + it is NULL, then a new handle is created. If + it is not NULL, then the I/O services are added + to the existing child handle. + + @retval EFI_SUCCES The protocol was added to ChildHandle. + @retval EFI_INVALID_PARAMETER ChildHandle is NULL. + @retval EFI_OUT_OF_RESOURCES There are not enough resources available to + create the child. + @retval Others The child handle was not created. + +**/ +EFI_STATUS +EFIAPI +MnpServiceBindingCreateChild ( + IN EFI_SERVICE_BINDING_PROTOCOL *This, + IN OUT EFI_HANDLE *ChildHandle + ) +{ + EFI_STATUS Status; + MNP_SERVICE_DATA *MnpServiceData; + MNP_INSTANCE_DATA *Instance; + VOID *MnpSb; + EFI_TPL OldTpl; + + if ((This == NULL) || (ChildHandle == NULL)) { + return EFI_INVALID_PARAMETER; + } + + MnpServiceData = MNP_SERVICE_DATA_FROM_THIS (This); + + // + // Allocate buffer for the new instance. + // + Instance = AllocateZeroPool (sizeof (MNP_INSTANCE_DATA)); + if (Instance == NULL) { + DEBUG ((EFI_D_ERROR, "MnpServiceBindingCreateChild: Faild to allocate memory for the new instance.\n")); + + return EFI_OUT_OF_RESOURCES; + } + + // + // Init the instance data. + // + MnpInitializeInstanceData (MnpServiceData, Instance); + + Status = gBS->InstallMultipleProtocolInterfaces ( + ChildHandle, + &gEfiManagedNetworkProtocolGuid, + &Instance->ManagedNetwork, + NULL + ); + if (EFI_ERROR (Status)) { + DEBUG ( + (EFI_D_ERROR, + "MnpServiceBindingCreateChild: Failed to install the MNP protocol, %r.\n", + Status) + ); + + goto ErrorExit; + } + + // + // Save the instance's childhandle. + // + Instance->Handle = *ChildHandle; + + Status = gBS->OpenProtocol ( + MnpServiceData->ServiceHandle, + &gEfiManagedNetworkServiceBindingProtocolGuid, + (VOID **) &MnpSb, + gMnpDriverBinding.DriverBindingHandle, + Instance->Handle, + EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER + ); + if (EFI_ERROR (Status)) { + goto ErrorExit; + } + + // + // Add the child instance into ChildrenList. + // + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + InsertTailList (&MnpServiceData->ChildrenList, &Instance->InstEntry); + MnpServiceData->ChildrenNumber++; + + gBS->RestoreTPL (OldTpl); + +ErrorExit: + + if (EFI_ERROR (Status)) { + + if (Instance->Handle != NULL) { + + gBS->UninstallMultipleProtocolInterfaces ( + Instance->Handle, + &gEfiManagedNetworkProtocolGuid, + &Instance->ManagedNetwork, + NULL + ); + } + + FreePool (Instance); + } + + return Status; +} + + +/** + Destroys a child handle with a set of I/O services. + + The DestroyChild() function does the opposite of CreateChild(). It removes a + protocol that was installed by CreateChild() from ChildHandle. If the removed + protocol is the last protocol on ChildHandle, then ChildHandle is destroyed. + + @param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL + instance. + @param[in] ChildHandle Handle of the child to destroy. + + @retval EFI_SUCCES The protocol was removed from ChildHandle. + @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that + is being removed. + @retval EFI_INVALID_PARAMETER ChildHandle is NULL. + @retval EFI_ACCESS_DENIED The protocol could not be removed from the + ChildHandle because its services are being + used. + @retval Others The child handle was not destroyed. + +**/ +EFI_STATUS +EFIAPI +MnpServiceBindingDestroyChild ( + IN EFI_SERVICE_BINDING_PROTOCOL *This, + IN EFI_HANDLE ChildHandle + ) +{ + EFI_STATUS Status; + MNP_SERVICE_DATA *MnpServiceData; + EFI_MANAGED_NETWORK_PROTOCOL *ManagedNetwork; + MNP_INSTANCE_DATA *Instance; + EFI_TPL OldTpl; + + if ((This == NULL) || (ChildHandle == NULL)) { + return EFI_INVALID_PARAMETER; + } + + MnpServiceData = MNP_SERVICE_DATA_FROM_THIS (This); + + // + // Try to retrieve ManagedNetwork Protocol from ChildHandle. + // + Status = gBS->OpenProtocol ( + ChildHandle, + &gEfiManagedNetworkProtocolGuid, + (VOID **) &ManagedNetwork, + gMnpDriverBinding.DriverBindingHandle, + ChildHandle, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + if (EFI_ERROR (Status)) { + return EFI_UNSUPPORTED; + } + + Instance = MNP_INSTANCE_DATA_FROM_THIS (ManagedNetwork); + + // + // MnpServiceBindingDestroyChild may be called twice: first called by + // MnpServiceBindingStop, second called by uninstalling the MNP protocol + // in this ChildHandle. Use destroyed to make sure the resource clean code + // will only excecute once. + // + if (Instance->Destroyed) { + return EFI_SUCCESS; + } + + Instance->Destroyed = TRUE; + + // + // Close the Simple Network protocol. + // + gBS->CloseProtocol ( + MnpServiceData->ServiceHandle, + &gEfiManagedNetworkServiceBindingProtocolGuid, + MnpServiceData->MnpDeviceData->ImageHandle, + ChildHandle + ); + + // + // Uninstall the ManagedNetwork protocol. + // + Status = gBS->UninstallMultipleProtocolInterfaces ( + ChildHandle, + &gEfiManagedNetworkProtocolGuid, + &Instance->ManagedNetwork, + NULL + ); + if (EFI_ERROR (Status)) { + DEBUG ( + (EFI_D_ERROR, + "MnpServiceBindingDestroyChild: Failed to uninstall the ManagedNetwork protocol, %r.\n", + Status) + ); + + Instance->Destroyed = FALSE; + return Status; + } + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + // + // Reset the configuration. + // + ManagedNetwork->Configure (ManagedNetwork, NULL); + + // + // Try to flush the RcvdPacketQueue. + // + MnpFlushRcvdDataQueue (Instance); + + // + // Clean the RxTokenMap. + // + NetMapClean (&Instance->RxTokenMap); + + // + // Remove this instance from the ChildrenList. + // + RemoveEntryList (&Instance->InstEntry); + MnpServiceData->ChildrenNumber--; + + gBS->RestoreTPL (OldTpl); + + FreePool (Instance); + + return Status; +} + +/** + The entry point for Mnp driver which installs the driver binding and component + name protocol on its ImageHandle. + + @param[in] ImageHandle The image handle of the driver. + @param[in] SystemTable The system table. + + @retval EFI_SUCCES The driver binding and component name protocols are + successfully installed. + @retval Others Other errors as indicated. + +**/ +EFI_STATUS +EFIAPI +MnpDriverEntryPoint ( + IN EFI_HANDLE ImageHandle, + IN EFI_SYSTEM_TABLE *SystemTable + ) +{ + return EfiLibInstallDriverBindingComponentName2 ( + ImageHandle, + SystemTable, + &gMnpDriverBinding, + ImageHandle, + &gMnpComponentName, + &gMnpComponentName2 + ); +} diff --git a/NetworkPkg/MnpDxe/MnpDriver.h b/NetworkPkg/MnpDxe/MnpDriver.h new file mode 100644 index 0000000000..150d21e9ec --- /dev/null +++ b/NetworkPkg/MnpDxe/MnpDriver.h @@ -0,0 +1,268 @@ +/** @file + Declaration of strctures and functions for MnpDxe driver. + +Copyright (c) 2005 - 2016, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef _MNP_DRIVER_H_ +#define _MNP_DRIVER_H_ + +#include + +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "ComponentName.h" + +#define MNP_DEVICE_DATA_SIGNATURE SIGNATURE_32 ('M', 'n', 'p', 'D') + +// +// Global Variables +// +extern EFI_DRIVER_BINDING_PROTOCOL gMnpDriverBinding; + +typedef struct { + UINT32 Signature; + + EFI_HANDLE ControllerHandle; + EFI_HANDLE ImageHandle; + + EFI_VLAN_CONFIG_PROTOCOL VlanConfig; + UINTN NumberOfVlan; + CHAR16 *MacString; + EFI_SIMPLE_NETWORK_PROTOCOL *Snp; + + // + // List of MNP_SERVICE_DATA + // + LIST_ENTRY ServiceList; + // + // Number of configured MNP Service Binding child + // + UINTN ConfiguredChildrenNumber; + + LIST_ENTRY GroupAddressList; + UINT32 GroupAddressCount; + + LIST_ENTRY FreeTxBufList; + LIST_ENTRY AllTxBufList; + UINT32 TxBufCount; + + NET_BUF_QUEUE FreeNbufQue; + INTN NbufCnt; + + EFI_EVENT PollTimer; + BOOLEAN EnableSystemPoll; + + EFI_EVENT TimeoutCheckTimer; + EFI_EVENT MediaDetectTimer; + + UINT32 UnicastCount; + UINT32 BroadcastCount; + UINT32 MulticastCount; + UINT32 PromiscuousCount; + + // + // The size of the data buffer in the MNP_PACKET_BUFFER used to + // store a packet. + // + UINT32 BufferLength; + UINT32 PaddingSize; + NET_BUF *RxNbufCache; +} MNP_DEVICE_DATA; + +#define MNP_DEVICE_DATA_FROM_THIS(a) \ + CR ( \ + (a), \ + MNP_DEVICE_DATA, \ + VlanConfig, \ + MNP_DEVICE_DATA_SIGNATURE \ + ) + +#define MNP_SERVICE_DATA_SIGNATURE SIGNATURE_32 ('M', 'n', 'p', 'S') + +typedef struct { + UINT32 Signature; + + LIST_ENTRY Link; + + MNP_DEVICE_DATA *MnpDeviceData; + EFI_HANDLE ServiceHandle; + EFI_SERVICE_BINDING_PROTOCOL ServiceBinding; + EFI_DEVICE_PATH_PROTOCOL *DevicePath; + + LIST_ENTRY ChildrenList; + UINTN ChildrenNumber; + + UINT32 Mtu; + + UINT16 VlanId; + UINT8 Priority; +} MNP_SERVICE_DATA; + + +#define MNP_SERVICE_DATA_FROM_THIS(a) \ + CR ( \ + (a), \ + MNP_SERVICE_DATA, \ + ServiceBinding, \ + MNP_SERVICE_DATA_SIGNATURE \ + ) + +#define MNP_SERVICE_DATA_FROM_LINK(a) \ + CR ( \ + (a), \ + MNP_SERVICE_DATA, \ + Link, \ + MNP_SERVICE_DATA_SIGNATURE \ + ) + + +/** + Test to see if this driver supports ControllerHandle. This service + is called by the EFI boot service ConnectController(). In + order to make drivers as small as possible, there are a few calling + restrictions for this service. ConnectController() must + follow these calling restrictions. If any other agent wishes to call + Supported() it must also follow these calling restrictions. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to test. + @param[in] RemainingDevicePath Optional parameter use to pick a specific + child device to start. + + @retval EFI_SUCCESS This driver supports this device. + @retval EFI_ALREADY_STARTED This driver is already running on this device. + @retval Others This driver does not support this device. + +**/ +EFI_STATUS +EFIAPI +MnpDriverBindingSupported ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL + ); + +/** + Start this driver on ControllerHandle. This service is called by the + EFI boot service ConnectController(). In order to make drivers as small + as possible, there are a few calling restrictions for this service. + ConnectController() must follow these calling restrictions. If any other + agent wishes to call Start() it must also follow these calling restrictions. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to bind driver to. + @param[in] RemainingDevicePath Optional parameter use to pick a specific + child device to start. + + @retval EFI_SUCCESS This driver is added to ControllerHandle. + @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle. + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for Mnp Service Data. + @retval Others This driver does not support this device. + +**/ +EFI_STATUS +EFIAPI +MnpDriverBindingStart ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL + ); + + +/** + Stop this driver on ControllerHandle. This service is called by the + EFI boot service DisconnectController(). In order to make drivers as + small as possible, there are a few calling restrictions for this service. + DisconnectController() must follow these calling restrictions. If any other + agent wishes to call Stop() it must also follow these calling restrictions. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to stop driver on. + @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If + number of children is zero stop the entire + bus driver. + @param[in] ChildHandleBuffer List of Child Handles to Stop. + + @retval EFI_SUCCESS This driver is removed ControllerHandle. + @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error. + +**/ +EFI_STATUS +EFIAPI +MnpDriverBindingStop ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN UINTN NumberOfChildren, + IN EFI_HANDLE *ChildHandleBuffer OPTIONAL + ); + +/** + Creates a child handle with a set of I/O services. + + @param[in] This Protocol instance pointer. + @param[in, out] ChildHandle Pointer to the handle of the child to create. If + it is NULL, then a new handle is created. If + it is not NULL, then the I/O services are added + to the existing child handle. + + @retval EFI_SUCCES The protocol was added to ChildHandle. + @retval EFI_INVALID_PARAMETER ChildHandle is NULL. + @retval EFI_OUT_OF_RESOURCES There are not enough resources available to + create the child. + @retval Others The child handle was not created. + +**/ +EFI_STATUS +EFIAPI +MnpServiceBindingCreateChild ( + IN EFI_SERVICE_BINDING_PROTOCOL *This, + IN OUT EFI_HANDLE *ChildHandle + ); + +/** + Destroys a child handle with a set of I/O services. + + The DestroyChild() function does the opposite of CreateChild(). It removes a + protocol that was installed by CreateChild() from ChildHandle. If the removed + protocol is the last protocol on ChildHandle, then ChildHandle is destroyed. + + @param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL + instance. + @param[in] ChildHandle Handle of the child to destroy. + + @retval EFI_SUCCES The protocol was removed from ChildHandle. + @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that + is being removed. + @retval EFI_INVALID_PARAMETER ChildHandle is NULL. + @retval EFI_ACCESS_DENIED The protocol could not be removed from the + ChildHandle because its services are being + used. + @retval Others The child handle was not destroyed. + +**/ +EFI_STATUS +EFIAPI +MnpServiceBindingDestroyChild ( + IN EFI_SERVICE_BINDING_PROTOCOL *This, + IN EFI_HANDLE ChildHandle + ); + +#endif diff --git a/NetworkPkg/MnpDxe/MnpDxe.inf b/NetworkPkg/MnpDxe/MnpDxe.inf new file mode 100644 index 0000000000..d4685b3e6a --- /dev/null +++ b/NetworkPkg/MnpDxe/MnpDxe.inf @@ -0,0 +1,68 @@ +## @file +# This module produces EFI MNP Protocol, EFI MNP Servie Binding Protocol and EFI VLAN Protocol. +# +# This module produces EFI Managed Network Protocol upon EFI Simple Network Protocol, +# to provide raw asynchronous network I/O services. It also produces EFI VLAN Protocol +# to provide manageability interface for VLAN configuration. +# +# Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+# SPDX-License-Identifier: BSD-2-Clause-Patent +# +## + +[Defines] + INF_VERSION = 0x00010005 + BASE_NAME = MnpDxe + MODULE_UNI_FILE = MnpDxe.uni + FILE_GUID = 025BBFC7-E6A9-4b8b-82AD-6815A1AEAF4A + MODULE_TYPE = UEFI_DRIVER + VERSION_STRING = 1.0 + ENTRY_POINT = MnpDriverEntryPoint + UNLOAD_IMAGE = NetLibDefaultUnload +# +# The following information is for reference only and not required by the build tools. +# +# VALID_ARCHITECTURES = IA32 X64 EBC +# +# DRIVER_BINDING = gMnpDriverBinding +# COMPONENT_NAME = gMnpComponentName +# COMPONENT_NAME2 = gMnpComponentName2 +# + +[Sources] + MnpMain.c + MnpIo.c + ComponentName.h + MnpDriver.h + ComponentName.c + MnpDriver.c + MnpConfig.c + MnpImpl.h + MnpVlan.h + MnpVlan.c + +[Packages] + MdePkg/MdePkg.dec + MdeModulePkg/MdeModulePkg.dec + +[LibraryClasses] + BaseLib + BaseMemoryLib + MemoryAllocationLib + UefiLib + UefiBootServicesTableLib + UefiDriverEntryPoint + DebugLib + NetLib + DpcLib + +[Protocols] + gEfiManagedNetworkServiceBindingProtocolGuid ## BY_START + gEfiSimpleNetworkProtocolGuid ## TO_START + gEfiManagedNetworkProtocolGuid ## BY_START + ## BY_START + ## UNDEFINED # variable + gEfiVlanConfigProtocolGuid + +[UserExtensions.TianoCore."ExtraFiles"] + MnpDxeExtra.uni diff --git a/NetworkPkg/MnpDxe/MnpDxe.uni b/NetworkPkg/MnpDxe/MnpDxe.uni new file mode 100644 index 0000000000..04be3cd7fe --- /dev/null +++ b/NetworkPkg/MnpDxe/MnpDxe.uni @@ -0,0 +1,18 @@ +// /** @file +// This module produces EFI MNP Protocol, EFI MNP Servie Binding Protocol and EFI VLAN Protocol. +// +// This module produces EFI Managed Network Protocol upon EFI Simple Network Protocol, +// to provide raw asynchronous network I/O services. It also produces EFI VLAN Protocol +// to provide manageability interface for VLAN configuration. +// +// Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+// +// SPDX-License-Identifier: BSD-2-Clause-Patent +// +// **/ + + +#string STR_MODULE_ABSTRACT #language en-US "Produces EFI MNP Protocol, EFI MNP Servie Binding Protocol and EFI VLAN Protocol" + +#string STR_MODULE_DESCRIPTION #language en-US "This module produces EFI Managed Network Protocol upon EFI Simple Network Protocol to provide raw asynchronous network I/O services. It also produces EFI VLAN Protocol to provide manageability interface for VLAN configuration." + diff --git a/NetworkPkg/MnpDxe/MnpDxeExtra.uni b/NetworkPkg/MnpDxe/MnpDxeExtra.uni new file mode 100644 index 0000000000..504ad2d8ad --- /dev/null +++ b/NetworkPkg/MnpDxe/MnpDxeExtra.uni @@ -0,0 +1,14 @@ +// /** @file +// MnpDxe Localized Strings and Content +// +// Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.
+// +// SPDX-License-Identifier: BSD-2-Clause-Patent +// +// **/ + +#string STR_PROPERTIES_MODULE_NAME +#language en-US +"MNP DXE Driver" + + diff --git a/NetworkPkg/MnpDxe/MnpImpl.h b/NetworkPkg/MnpDxe/MnpImpl.h new file mode 100644 index 0000000000..7d54240346 --- /dev/null +++ b/NetworkPkg/MnpDxe/MnpImpl.h @@ -0,0 +1,898 @@ +/** @file + Declaration of structures and functions of MnpDxe driver. + +Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef _MNP_IMPL_H_ +#define _MNP_IMPL_H_ + +#include "MnpDriver.h" + +#define NET_ETHER_FCS_SIZE 4 + +#define MNP_SYS_POLL_INTERVAL (10 * TICKS_PER_MS) // 10 milliseconds +#define MNP_TIMEOUT_CHECK_INTERVAL (50 * TICKS_PER_MS) // 50 milliseconds +#define MNP_MEDIA_DETECT_INTERVAL (500 * TICKS_PER_MS) // 500 milliseconds +#define MNP_TX_TIMEOUT_TIME (500 * TICKS_PER_MS) // 500 milliseconds +#define MNP_INIT_NET_BUFFER_NUM 512 +#define MNP_NET_BUFFER_INCREASEMENT 64 +#define MNP_MAX_NET_BUFFER_NUM 65536 +#define MNP_TX_BUFFER_INCREASEMENT 32 // Same as the recycling Q length for xmit_done in UNDI command. +#define MNP_MAX_TX_BUFFER_NUM 65536 + +#define MNP_MAX_RCVD_PACKET_QUE_SIZE 256 + +#define MNP_RECEIVE_UNICAST 0x01 +#define MNP_RECEIVE_BROADCAST 0x02 + +#define UNICAST_PACKET MNP_RECEIVE_UNICAST +#define BROADCAST_PACKET MNP_RECEIVE_BROADCAST + +#define MNP_INSTANCE_DATA_SIGNATURE SIGNATURE_32 ('M', 'n', 'p', 'I') + +#define MNP_INSTANCE_DATA_FROM_THIS(a) \ + CR ( \ + (a), \ + MNP_INSTANCE_DATA, \ + ManagedNetwork, \ + MNP_INSTANCE_DATA_SIGNATURE \ + ) + +typedef struct { + UINT32 Signature; + + MNP_SERVICE_DATA *MnpServiceData; + + EFI_HANDLE Handle; + + LIST_ENTRY InstEntry; + + EFI_MANAGED_NETWORK_PROTOCOL ManagedNetwork; + + BOOLEAN Configured; + BOOLEAN Destroyed; + + LIST_ENTRY GroupCtrlBlkList; + + NET_MAP RxTokenMap; + + LIST_ENTRY RxDeliveredPacketQueue; + LIST_ENTRY RcvdPacketQueue; + UINTN RcvdPacketQueueSize; + + EFI_MANAGED_NETWORK_CONFIG_DATA ConfigData; + + UINT8 ReceiveFilter; +} MNP_INSTANCE_DATA; + +typedef struct { + LIST_ENTRY AddrEntry; + EFI_MAC_ADDRESS Address; + INTN RefCnt; +} MNP_GROUP_ADDRESS; + +typedef struct { + LIST_ENTRY CtrlBlkEntry; + MNP_GROUP_ADDRESS *GroupAddress; +} MNP_GROUP_CONTROL_BLOCK; + +typedef struct { + LIST_ENTRY WrapEntry; + MNP_INSTANCE_DATA *Instance; + EFI_MANAGED_NETWORK_RECEIVE_DATA RxData; + NET_BUF *Nbuf; + UINT64 TimeoutTick; +} MNP_RXDATA_WRAP; + +#define MNP_TX_BUF_WRAP_SIGNATURE SIGNATURE_32 ('M', 'T', 'B', 'W') + +typedef struct { + UINT32 Signature; + LIST_ENTRY WrapEntry; // Link to FreeTxBufList + LIST_ENTRY AllEntry; // Link to AllTxBufList + BOOLEAN InUse; + UINT8 TxBuf[1]; +} MNP_TX_BUF_WRAP; + +/** + Initialize the mnp device context data. + + @param[in, out] MnpDeviceData Pointer to the mnp device context data. + @param[in] ImageHandle The driver image handle. + @param[in] ControllerHandle Handle of device to bind driver to. + + @retval EFI_SUCCESS The mnp service context is initialized. + @retval EFI_UNSUPPORTED ControllerHandle does not support Simple Network Protocol. + @retval Others Other errors as indicated. + +**/ +EFI_STATUS +MnpInitializeDeviceData ( + IN OUT MNP_DEVICE_DATA *MnpDeviceData, + IN EFI_HANDLE ImageHandle, + IN EFI_HANDLE ControllerHandle + ); + +/** + Destroy the MNP device context data. + + @param[in, out] MnpDeviceData Pointer to the mnp device context data. + @param[in] ImageHandle The driver image handle. + +**/ +VOID +MnpDestroyDeviceData ( + IN OUT MNP_DEVICE_DATA *MnpDeviceData, + IN EFI_HANDLE ImageHandle + ); + +/** + Create mnp service context data. + + @param[in] MnpDeviceData Pointer to the mnp device context data. + @param[in] VlanId The VLAN ID. + @param[in] Priority The VLAN priority. If VlanId is 0, + Priority is ignored. + + @return A pointer to MNP_SERVICE_DATA or NULL if failed to create MNP service context. + +**/ +MNP_SERVICE_DATA * +MnpCreateServiceData ( + IN MNP_DEVICE_DATA *MnpDeviceData, + IN UINT16 VlanId, + IN UINT8 Priority OPTIONAL + ); + +/** + Initialize the mnp service context data. + + @param[in, out] MnpServiceData Pointer to the mnp service context data. + @param[in] ImageHandle The driver image handle. + @param[in] ControllerHandle Handle of device to bind driver to. + + @retval EFI_SUCCESS The mnp service context is initialized. + @retval EFI_UNSUPPORTED ControllerHandle does not support Simple Network Protocol. + @retval Others Other errors as indicated. + +**/ +EFI_STATUS +MnpInitializeServiceData ( + IN OUT MNP_SERVICE_DATA *MnpServiceData, + IN EFI_HANDLE ImageHandle, + IN EFI_HANDLE ControllerHandle + ); + +/** + Destroy the MNP service context data. + + @param[in, out] MnpServiceData Pointer to the mnp service context data. + + @retval EFI_SUCCESS The mnp service context is destroyed. + @retval Others Errors as indicated. + +**/ +EFI_STATUS +MnpDestroyServiceData ( + IN OUT MNP_SERVICE_DATA *MnpServiceData + ); + +/** + Destroy all child of the MNP service data. + + @param[in, out] MnpServiceData Pointer to the mnp service context data. + + @retval EFI_SUCCESS All child are destroyed. + @retval Others Failed to destroy all child. + +**/ +EFI_STATUS +MnpDestroyServiceChild ( + IN OUT MNP_SERVICE_DATA *MnpServiceData + ); + +/** + Find the MNP Service Data for given VLAN ID. + + @param[in] MnpDeviceData Pointer to the mnp device context data. + @param[in] VlanId The VLAN ID. + + @return A pointer to MNP_SERVICE_DATA or NULL if not found. + +**/ +MNP_SERVICE_DATA * +MnpFindServiceData ( + IN MNP_DEVICE_DATA *MnpDeviceData, + IN UINT16 VlanId + ); + +/** + Initialize the mnp instance context data. + + @param[in] MnpServiceData Pointer to the mnp service context data. + @param[in, out] Instance Pointer to the mnp instance context data + to initialize. + +**/ +VOID +MnpInitializeInstanceData ( + IN MNP_SERVICE_DATA *MnpServiceData, + IN OUT MNP_INSTANCE_DATA *Instance + ); + +/** + Check whether the token specified by Arg matches the token in Item. + + @param[in] Map Pointer to the NET_MAP. + @param[in] Item Pointer to the NET_MAP_ITEM. + @param[in] Arg Pointer to the Arg, it's a pointer to the token to + check. + + @retval EFI_SUCCESS The token specified by Arg is different from the + token in Item. + @retval EFI_ACCESS_DENIED The token specified by Arg is the same as that in + Item. + +**/ +EFI_STATUS +EFIAPI +MnpTokenExist ( + IN NET_MAP *Map, + IN NET_MAP_ITEM *Item, + IN VOID *Arg + ); + +/** + Cancel the token specified by Arg if it matches the token in Item. + + @param[in, out] Map Pointer to the NET_MAP. + @param[in, out] Item Pointer to the NET_MAP_ITEM. + @param[in] Arg Pointer to the Arg, it's a pointer to the + token to cancel. + + @retval EFI_SUCCESS The Arg is NULL, and the token in Item is cancelled, + or the Arg isn't NULL, and the token in Item is + different from the Arg. + @retval EFI_ABORTED The Arg isn't NULL, the token in Item mathces the + Arg, and the token is cancelled. + +**/ +EFI_STATUS +EFIAPI +MnpCancelTokens ( + IN OUT NET_MAP *Map, + IN OUT NET_MAP_ITEM *Item, + IN VOID *Arg + ); + +/** + Flush the instance's received data. + + @param[in, out] Instance Pointer to the mnp instance context data. + +**/ +VOID +MnpFlushRcvdDataQueue ( + IN OUT MNP_INSTANCE_DATA *Instance + ); + +/** + Configure the Instance using ConfigData. + + @param[in, out] Instance Pointer to the mnp instance context data. + @param[in] ConfigData Pointer to the configuration data used to configure + the isntance. + + @retval EFI_SUCCESS The Instance is configured. + @retval EFI_UNSUPPORTED EnableReceiveTimestamps is on and the + implementation doesn't support it. + @retval Others Other errors as indicated. + +**/ +EFI_STATUS +MnpConfigureInstance ( + IN OUT MNP_INSTANCE_DATA *Instance, + IN EFI_MANAGED_NETWORK_CONFIG_DATA *ConfigData OPTIONAL + ); + +/** + Do the group operations for this instance. + + @param[in, out] Instance Pointer to the instance context data. + @param[in] JoinFlag Set to TRUE to join a group. Set to TRUE to + leave a group/groups. + @param[in] MacAddress Pointer to the group address to join or leave. + @param[in] CtrlBlk Pointer to the group control block if JoinFlag + is FALSE. + + @retval EFI_SUCCESS The group operation finished. + @retval EFI_OUT_OF_RESOURCES Failed due to lack of memory resources. + @retval Others Other errors as indicated. + +**/ +EFI_STATUS +MnpGroupOp ( + IN OUT MNP_INSTANCE_DATA *Instance, + IN BOOLEAN JoinFlag, + IN EFI_MAC_ADDRESS *MacAddress OPTIONAL, + IN MNP_GROUP_CONTROL_BLOCK *CtrlBlk OPTIONAL + ); + +/** + Validates the Mnp transmit token. + + @param[in] Instance Pointer to the Mnp instance context data. + @param[in] Token Pointer to the transmit token to check. + + @return The Token is valid or not. + +**/ +BOOLEAN +MnpIsValidTxToken ( + IN MNP_INSTANCE_DATA *Instance, + IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN *Token + ); + +/** + Build the packet to transmit from the TxData passed in. + + @param[in] MnpServiceData Pointer to the mnp service context data. + @param[in] TxData Pointer to the transmit data containing the information + to build the packet. + @param[out] PktBuf Pointer to record the address of the packet. + @param[out] PktLen Pointer to a UINT32 variable used to record the packet's + length. + + @retval EFI_SUCCESS TxPackage is built. + @retval EFI_OUT_OF_RESOURCES The deliver fails due to lack of memory resource. + +**/ +EFI_STATUS +MnpBuildTxPacket ( + IN MNP_SERVICE_DATA *MnpServiceData, + IN EFI_MANAGED_NETWORK_TRANSMIT_DATA *TxData, + OUT UINT8 **PktBuf, + OUT UINT32 *PktLen + ); + +/** + Synchronously send out the packet. + + This functon places the packet buffer to SNP driver's tansmit queue. The packet + can be considered successfully sent out once SNP acccetp the packet, while the + packet buffer recycle is deferred for better performance. + + @param[in] MnpServiceData Pointer to the mnp service context data. + @param[in] Packet Pointer to the pakcet buffer. + @param[in] Length The length of the packet. + @param[in, out] Token Pointer to the token the packet generated from. + + @retval EFI_SUCCESS The packet is sent out. + @retval EFI_TIMEOUT Time out occurs, the packet isn't sent. + @retval EFI_DEVICE_ERROR An unexpected network error occurs. + +**/ +EFI_STATUS +MnpSyncSendPacket ( + IN MNP_SERVICE_DATA *MnpServiceData, + IN UINT8 *Packet, + IN UINT32 Length, + IN OUT EFI_MANAGED_NETWORK_COMPLETION_TOKEN *Token + ); + +/** + Try to deliver the received packet to the instance. + + @param[in, out] Instance Pointer to the mnp instance context data. + + @retval EFI_SUCCESS The received packet is delivered, or there is no + packet to deliver, or there is no available receive + token. + @retval EFI_OUT_OF_RESOURCES The deliver fails due to lack of memory resource. + +**/ +EFI_STATUS +MnpInstanceDeliverPacket ( + IN OUT MNP_INSTANCE_DATA *Instance + ); + +/** + Recycle the RxData and other resources used to hold and deliver the received + packet. + + @param[in] Event The event this notify function registered to. + @param[in] Context Pointer to the context data registerd to the Event. + +**/ +VOID +EFIAPI +MnpRecycleRxData ( + IN EFI_EVENT Event, + IN VOID *Context + ); + +/** + Try to receive a packet and deliver it. + + @param[in, out] MnpDeviceData Pointer to the mnp device context data. + + @retval EFI_SUCCESS add return value to function comment + @retval EFI_NOT_STARTED The simple network protocol is not started. + @retval EFI_NOT_READY No packet received. + @retval EFI_DEVICE_ERROR An unexpected error occurs. + +**/ +EFI_STATUS +MnpReceivePacket ( + IN OUT MNP_DEVICE_DATA *MnpDeviceData + ); + +/** + Allocate a free NET_BUF from MnpDeviceData->FreeNbufQue. If there is none + in the queue, first try to allocate some and add them into the queue, then + fetch the NET_BUF from the updated FreeNbufQue. + + @param[in, out] MnpDeviceData Pointer to the MNP_DEVICE_DATA. + + @return Pointer to the allocated free NET_BUF structure, if NULL the + operation is failed. + +**/ +NET_BUF * +MnpAllocNbuf ( + IN OUT MNP_DEVICE_DATA *MnpDeviceData + ); + +/** + Try to reclaim the Nbuf into the buffer pool. + + @param[in, out] MnpDeviceData Pointer to the mnp device context data. + @param[in, out] Nbuf Pointer to the NET_BUF to free. + +**/ +VOID +MnpFreeNbuf ( + IN OUT MNP_DEVICE_DATA *MnpDeviceData, + IN OUT NET_BUF *Nbuf + ); + +/** + Allocate a free TX buffer from MnpDeviceData->FreeTxBufList. If there is none + in the queue, first try to recycle some from SNP, then try to allocate some and add + them into the queue, then fetch the NET_BUF from the updated FreeTxBufList. + + @param[in, out] MnpDeviceData Pointer to the MNP_DEVICE_DATA. + + @return Pointer to the allocated free NET_BUF structure, if NULL the + operation is failed. + +**/ +UINT8 * +MnpAllocTxBuf ( + IN OUT MNP_DEVICE_DATA *MnpDeviceData + ); + +/** + Try to recycle all the transmitted buffer address from SNP. + + @param[in, out] MnpDeviceData Pointer to the mnp device context data. + + @retval EFI_SUCCESS Successed to recyclethe transmitted buffer address. + @retval Others Failed to recyclethe transmitted buffer address. + +**/ +EFI_STATUS +MnpRecycleTxBuf ( + IN OUT MNP_DEVICE_DATA *MnpDeviceData + ); + +/** + Remove the received packets if timeout occurs. + + @param[in] Event The event this notify function registered to. + @param[in] Context Pointer to the context data registered to the event. + +**/ +VOID +EFIAPI +MnpCheckPacketTimeout ( + IN EFI_EVENT Event, + IN VOID *Context + ); + +/** + Poll to update MediaPresent field in SNP ModeData by Snp.GetStatus(). + + @param[in] Event The event this notify function registered to. + @param[in] Context Pointer to the context data registered to the event. + +**/ +VOID +EFIAPI +MnpCheckMediaStatus ( + IN EFI_EVENT Event, + IN VOID *Context + ); + +/** + Poll to receive the packets from Snp. This function is either called by upperlayer + protocols/applications or the system poll timer notify mechanism. + + @param[in] Event The event this notify function registered to. + @param[in] Context Pointer to the context data registered to the event. + +**/ +VOID +EFIAPI +MnpSystemPoll ( + IN EFI_EVENT Event, + IN VOID *Context + ); + +/** + Returns the operational parameters for the current MNP child driver. May also + support returning the underlying SNP driver mode data. + + The GetModeData() function is used to read the current mode data (operational + parameters) from the MNP or the underlying SNP. + + @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. + @param[out] MnpConfigData Pointer to storage for MNP operational parameters. Type + EFI_MANAGED_NETWORK_CONFIG_DATA is defined in "Related + Definitions" below. + @param[out] SnpModeData Pointer to storage for SNP operational parameters. This + feature may be unsupported. Type EFI_SIMPLE_NETWORK_MODE + is defined in the EFI_SIMPLE_NETWORK_PROTOCOL. + + @retval EFI_SUCCESS The operation completed successfully. + @retval EFI_INVALID_PARAMETER This is NULL. + @retval EFI_UNSUPPORTED The requested feature is unsupported in this + MNP implementation. + @retval EFI_NOT_STARTED This MNP child driver instance has not been + configured. The default values are returned in + MnpConfigData if it is not NULL. + @retval Others The mode data could not be read. + +**/ +EFI_STATUS +EFIAPI +MnpGetModeData ( + IN EFI_MANAGED_NETWORK_PROTOCOL *This, + OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL, + OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL + ); + +/** + Sets or clears the operational parameters for the MNP child driver. + + The Configure() function is used to set, change, or reset the operational + parameters for the MNP child driver instance. Until the operational parameters + have been set, no network traffic can be sent or received by this MNP child + driver instance. Once the operational parameters have been reset, no more + traffic can be sent or received until the operational parameters have been set + again. + Each MNP child driver instance can be started and stopped independently of + each other by setting or resetting their receive filter settings with the + Configure() function. + After any successful call to Configure(), the MNP child driver instance is + started. The internal periodic timer (if supported) is enabled. Data can be + transmitted and may be received if the receive filters have also been enabled. + Note: If multiple MNP child driver instances will receive the same packet + because of overlapping receive filter settings, then the first MNP child + driver instance will receive the original packet and additional instances will + receive copies of the original packet. + Note: Warning: Receive filter settings that overlap will consume extra + processor and/or DMA resources and degrade system and network performance. + + @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. + @param[in] MnpConfigData Pointer to configuration data that will be assigned + to the MNP child driver instance. If NULL, the MNP + child driver instance is reset to startup defaults + and all pending transmit and receive requests are + flushed. Type EFI_MANAGED_NETWORK_CONFIG_DATA is + defined in EFI_MANAGED_NETWORK_PROTOCOL.GetModeData(). + + @retval EFI_SUCCESS The operation completed successfully. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is + TRUE: + * This is NULL. + * MnpConfigData.ProtocolTypeFilter is not + valid. + The operational data for the MNP child driver + instance is unchanged. + @retval EFI_OUT_OF_RESOURCES Required system resources (usually memory) + could not be allocated. + The MNP child driver instance has been reset to + startup defaults. + @retval EFI_UNSUPPORTED The requested feature is unsupported in + this [MNP] implementation. The operational data + for the MNP child driver instance is unchanged. + @retval EFI_DEVICE_ERROR An unexpected network or system error + occurred. The MNP child driver instance has + been reset to startup defaults. + @retval Others The MNP child driver instance has been reset to + startup defaults. + +**/ +EFI_STATUS +EFIAPI +MnpConfigure ( + IN EFI_MANAGED_NETWORK_PROTOCOL *This, + IN EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL + ); + +/** + Translates an IP multicast address to a hardware (MAC) multicast address. This + function may be unsupported in some MNP implementations. + + The McastIpToMac() function translates an IP multicast address to a hardware + (MAC) multicast address. This function may be implemented by calling the + underlying EFI_SIMPLE_NETWORK. MCastIpToMac() function, which may also be + unsupported in some MNP implementations. + + @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. + @param[in] Ipv6Flag Set to TRUE to if IpAddress is an IPv6 multicast address. + Set to FALSE if IpAddress is an IPv4 multicast address. + @param[in] IpAddress Pointer to the multicast IP address (in network byte + order) to convert. + @param[out] MacAddress Pointer to the resulting multicast MAC address. + + @retval EFI_SUCCESS The operation completed successfully. + @retval EFI_INVALID_PARAMETER One of the following conditions is TRUE: + * This is NULL. + * IpAddress is NULL. + * IpAddress is not a valid multicast IP + address. + * MacAddress is NULL. + @retval EFI_NOT_STARTED This MNP child driver instance has not been + configured. + @retval EFI_UNSUPPORTED The requested feature is unsupported in this + MNP implementation. + @retval EFI_DEVICE_ERROR An unexpected network or system error occurred. + @retval Others The address could not be converted. +**/ +EFI_STATUS +EFIAPI +MnpMcastIpToMac ( + IN EFI_MANAGED_NETWORK_PROTOCOL *This, + IN BOOLEAN Ipv6Flag, + IN EFI_IP_ADDRESS *IpAddress, + OUT EFI_MAC_ADDRESS *MacAddress + ); + +/** + Enables and disables receive filters for multicast address. This function may + be unsupported in some MNP implementations. + + The Groups() function only adds and removes multicast MAC addresses from the + filter list. The MNP driver does not transmit or process Internet Group + Management Protocol (IGMP) packets. If JoinFlag is FALSE and MacAddress is + NULL, then all joined groups are left. + + @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. + @param[in] JoinFlag Set to TRUE to join this multicast group. + Set to FALSE to leave this multicast group. + @param[in] MacAddress Pointer to the multicast MAC group (address) to join or + leave. + + @retval EFI_SUCCESS The requested operation completed successfully. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + * This is NULL. + * JoinFlag is TRUE and MacAddress is NULL. + * MacAddress is not a valid multicast MAC + address. + * The MNP multicast group settings are + unchanged. + @retval EFI_NOT_STARTED This MNP child driver instance has not been + configured. + @retval EFI_ALREADY_STARTED The supplied multicast group is already joined. + @retval EFI_NOT_FOUND The supplied multicast group is not joined. + @retval EFI_DEVICE_ERROR An unexpected network or system error occurred. + The MNP child driver instance has been reset to + startup defaults. + @retval EFI_UNSUPPORTED The requested feature is unsupported in this MNP + implementation. + @retval Others The requested operation could not be completed. + The MNP multicast group settings are unchanged. + +**/ +EFI_STATUS +EFIAPI +MnpGroups ( + IN EFI_MANAGED_NETWORK_PROTOCOL *This, + IN BOOLEAN JoinFlag, + IN EFI_MAC_ADDRESS *MacAddress OPTIONAL + ); + +/** + Places asynchronous outgoing data packets into the transmit queue. + + The Transmit() function places a completion token into the transmit packet + queue. This function is always asynchronous. + The caller must fill in the Token.Event and Token.TxData fields in the + completion token, and these fields cannot be NULL. When the transmit operation + completes, the MNP updates the Token.Status field and the Token.Event is + signaled. + Note: There may be a performance penalty if the packet needs to be + defragmented before it can be transmitted by the network device. Systems in + which performance is critical should review the requirements and features of + the underlying communications device and drivers. + + + @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. + @param[in] Token Pointer to a token associated with the transmit data + descriptor. Type EFI_MANAGED_NETWORK_COMPLETION_TOKEN + is defined in "Related Definitions" below. + + @retval EFI_SUCCESS The transmit completion token was cached. + @retval EFI_NOT_STARTED This MNP child driver instance has not been + configured. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is + TRUE: + * This is NULL. + * Token is NULL. + * Token.Event is NULL. + * Token.TxData is NULL. + * Token.TxData.DestinationAddress is not + NULL and Token.TxData.HeaderLength is zero. + * Token.TxData.FragmentCount is zero. + * (Token.TxData.HeaderLength + + Token.TxData.DataLength) is not equal to the + sum of the + Token.TxData.FragmentTable[].FragmentLength + fields. + * One or more of the + Token.TxData.FragmentTable[].FragmentLength + fields is zero. + * One or more of the + Token.TxData.FragmentTable[].FragmentBufferfields + is NULL. + * Token.TxData.DataLength is greater than MTU. + @retval EFI_ACCESS_DENIED The transmit completion token is already in the + transmit queue. + @retval EFI_OUT_OF_RESOURCES The transmit data could not be queued due to a + lack of system resources (usually memory). + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. + The MNP child driver instance has been reset to + startup defaults. + @retval EFI_NOT_READY The transmit request could not be queued because + the transmit queue is full. + +**/ +EFI_STATUS +EFIAPI +MnpTransmit ( + IN EFI_MANAGED_NETWORK_PROTOCOL *This, + IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN *Token + ); + +/** + Aborts an asynchronous transmit or receive request. + + The Cancel() function is used to abort a pending transmit or receive request. + If the token is in the transmit or receive request queues, after calling this + function, Token.Status will be set to EFI_ABORTED and then Token.Event will be + signaled. If the token is not in one of the queues, which usually means that + the asynchronous operation has completed, this function will not signal the + token and EFI_NOT_FOUND is returned. + + @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. + @param[in] Token Pointer to a token that has been issued by + EFI_MANAGED_NETWORK_PROTOCOL.Transmit() or + EFI_MANAGED_NETWORK_PROTOCOL.Receive(). If NULL, all + pending tokens are aborted. + + @retval EFI_SUCCESS The asynchronous I/O request was aborted and + Token.Event was signaled. When Token is NULL, + all pending requests were aborted and their + events were signaled. + @retval EFI_NOT_STARTED This MNP child driver instance has not been + configured. + @retval EFI_INVALID_PARAMETER This is NULL. + @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O + request was not found in the transmit or + receive queue. It has either completed or was + not issued by Transmit() and Receive(). + +**/ +EFI_STATUS +EFIAPI +MnpCancel ( + IN EFI_MANAGED_NETWORK_PROTOCOL *This, + IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN *Token OPTIONAL + ); + +/** + Places an asynchronous receiving request into the receiving queue. + + The Receive() function places a completion token into the receive packet + queue. This function is always asynchronous. + The caller must fill in the Token.Event field in the completion token, and + this field cannot be NULL. When the receive operation completes, the MNP + updates the Token.Status and Token.RxData fields and the Token.Event is + signaled. + + @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. + @param[in] Token Pointer to a token associated with the receive + data descriptor. Type + EFI_MANAGED_NETWORK_COMPLETION_TOKEN is defined in + EFI_MANAGED_NETWORK_PROTOCOL.Transmit(). + + @retval EFI_SUCCESS The receive completion token was cached. + @retval EFI_NOT_STARTED This MNP child driver instance has not been + configured. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is + TRUE: + * This is NULL. + * Token is NULL. + * Token.Event is NULL + @retval EFI_OUT_OF_RESOURCES The transmit data could not be queued due to a + lack of system resources (usually memory). + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. + The MNP child driver instance has been reset to + startup defaults. + @retval EFI_ACCESS_DENIED The receive completion token was already in the + receive queue. + @retval EFI_NOT_READY The receive request could not be queued because + the receive queue is full. + +**/ +EFI_STATUS +EFIAPI +MnpReceive ( + IN EFI_MANAGED_NETWORK_PROTOCOL *This, + IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN *Token + ); + +/** + Polls for incoming data packets and processes outgoing data packets. + + The Poll() function can be used by network drivers and applications to + increase the rate that data packets are moved between the communications + device and the transmit and receive queues. + Normally, a periodic timer event internally calls the Poll() function. But, in + some systems, the periodic timer event may not call Poll() fast enough to + transmit and/or receive all data packets without missing packets. Drivers and + applications that are experiencing packet loss should try calling the Poll() + function more often. + + @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. + + @retval EFI_SUCCESS Incoming or outgoing data was processed. + @retval EFI_NOT_STARTED This MNP child driver instance has not been + configured. + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The + MNP child driver instance has been reset to startup + defaults. + @retval EFI_NOT_READY No incoming or outgoing data was processed. Consider + increasing the polling rate. + @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive + queue. Consider increasing the polling rate. + +**/ +EFI_STATUS +EFIAPI +MnpPoll ( + IN EFI_MANAGED_NETWORK_PROTOCOL *This + ); + +/** + Configure the Snp receive filters according to the instances' receive filter + settings. + + @param[in] MnpDeviceData Pointer to the mnp device context data. + + @retval EFI_SUCCESS The receive filters is configured. + @retval EFI_OUT_OF_RESOURCES The receive filters can't be configured due + to lack of memory resource. + +**/ +EFI_STATUS +MnpConfigReceiveFilters ( + IN MNP_DEVICE_DATA *MnpDeviceData + ); + +#endif diff --git a/NetworkPkg/MnpDxe/MnpIo.c b/NetworkPkg/MnpDxe/MnpIo.c new file mode 100644 index 0000000000..56405d62b5 --- /dev/null +++ b/NetworkPkg/MnpDxe/MnpIo.c @@ -0,0 +1,1133 @@ +/** @file + Implementation of Managed Network Protocol I/O functions. + +Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "MnpImpl.h" +#include "MnpVlan.h" + +/** + Validates the Mnp transmit token. + + @param[in] Instance Pointer to the Mnp instance context data. + @param[in] Token Pointer to the transmit token to check. + + @return The Token is valid or not. + +**/ +BOOLEAN +MnpIsValidTxToken ( + IN MNP_INSTANCE_DATA *Instance, + IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN *Token + ) +{ + MNP_SERVICE_DATA *MnpServiceData; + EFI_MANAGED_NETWORK_TRANSMIT_DATA *TxData; + UINT32 Index; + UINT32 TotalLength; + EFI_MANAGED_NETWORK_FRAGMENT_DATA *FragmentTable; + + MnpServiceData = Instance->MnpServiceData; + NET_CHECK_SIGNATURE (MnpServiceData, MNP_SERVICE_DATA_SIGNATURE); + + TxData = Token->Packet.TxData; + + if ((Token->Event == NULL) || (TxData == NULL) || (TxData->FragmentCount == 0)) { + // + // The token is invalid if the Event is NULL, or the TxData is NULL, or + // the fragment count is zero. + // + DEBUG ((EFI_D_WARN, "MnpIsValidTxToken: Invalid Token.\n")); + return FALSE; + } + + if ((TxData->DestinationAddress != NULL) && (TxData->HeaderLength != 0)) { + // + // The token is invalid if the HeaderLength isn't zero while the DestinationAddress + // is NULL (The destination address is already put into the packet). + // + DEBUG ((EFI_D_WARN, "MnpIsValidTxToken: DestinationAddress isn't NULL, HeaderLength must be 0.\n")); + return FALSE; + } + + TotalLength = 0; + FragmentTable = TxData->FragmentTable; + for (Index = 0; Index < TxData->FragmentCount; Index++) { + + if ((FragmentTable[Index].FragmentLength == 0) || (FragmentTable[Index].FragmentBuffer == NULL)) { + // + // The token is invalid if any FragmentLength is zero or any FragmentBuffer is NULL. + // + DEBUG ((EFI_D_WARN, "MnpIsValidTxToken: Invalid FragmentLength or FragmentBuffer.\n")); + return FALSE; + } + + TotalLength += FragmentTable[Index].FragmentLength; + } + + if ((TxData->DestinationAddress == NULL) && (FragmentTable[0].FragmentLength < TxData->HeaderLength)) { + // + // Media header is split between fragments. + // + return FALSE; + } + + if (TotalLength != (TxData->DataLength + TxData->HeaderLength)) { + // + // The length calculated from the fragment information doesn't equal to the + // sum of the DataLength and the HeaderLength. + // + DEBUG ((EFI_D_WARN, "MnpIsValidTxData: Invalid Datalength compared with the sum of fragment length.\n")); + return FALSE; + } + + if (TxData->DataLength > MnpServiceData->Mtu) { + // + // The total length is larger than the MTU. + // + DEBUG ((EFI_D_WARN, "MnpIsValidTxData: TxData->DataLength exceeds Mtu.\n")); + return FALSE; + } + + return TRUE; +} + +/** + Build the packet to transmit from the TxData passed in. + + @param[in] MnpServiceData Pointer to the mnp service context data. + @param[in] TxData Pointer to the transmit data containing the information + to build the packet. + @param[out] PktBuf Pointer to record the address of the packet. + @param[out] PktLen Pointer to a UINT32 variable used to record the packet's + length. + + @retval EFI_SUCCESS TxPackage is built. + @retval EFI_OUT_OF_RESOURCES The deliver fails due to lack of memory resource. + +**/ +EFI_STATUS +MnpBuildTxPacket ( + IN MNP_SERVICE_DATA *MnpServiceData, + IN EFI_MANAGED_NETWORK_TRANSMIT_DATA *TxData, + OUT UINT8 **PktBuf, + OUT UINT32 *PktLen + ) +{ + EFI_SIMPLE_NETWORK_MODE *SnpMode; + UINT8 *DstPos; + UINT16 Index; + MNP_DEVICE_DATA *MnpDeviceData; + UINT8 *TxBuf; + + MnpDeviceData = MnpServiceData->MnpDeviceData; + + TxBuf = MnpAllocTxBuf (MnpDeviceData); + if (TxBuf == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + // + // Reserve space for vlan tag if needed. + // + if (MnpServiceData->VlanId != 0) { + *PktBuf = TxBuf + NET_VLAN_TAG_LEN; + } else { + *PktBuf = TxBuf; + } + + if ((TxData->DestinationAddress == NULL) && (TxData->FragmentCount == 1)) { + CopyMem ( + *PktBuf, + TxData->FragmentTable[0].FragmentBuffer, + TxData->FragmentTable[0].FragmentLength + ); + + *PktLen = TxData->FragmentTable[0].FragmentLength; + } else { + // + // Either media header isn't in FragmentTable or there is more than + // one fragment, copy the data into the packet buffer. Reserve the + // media header space if necessary. + // + SnpMode = MnpDeviceData->Snp->Mode; + DstPos = *PktBuf; + *PktLen = 0; + if (TxData->DestinationAddress != NULL) { + // + // If dest address is not NULL, move DstPos to reserve space for the + // media header. Add the media header length to buflen. + // + DstPos += SnpMode->MediaHeaderSize; + *PktLen += SnpMode->MediaHeaderSize; + } + + for (Index = 0; Index < TxData->FragmentCount; Index++) { + // + // Copy the data. + // + CopyMem ( + DstPos, + TxData->FragmentTable[Index].FragmentBuffer, + TxData->FragmentTable[Index].FragmentLength + ); + DstPos += TxData->FragmentTable[Index].FragmentLength; + } + + // + // Set the buffer length. + // + *PktLen += TxData->DataLength + TxData->HeaderLength; + } + + return EFI_SUCCESS; +} + + +/** + Synchronously send out the packet. + + This functon places the packet buffer to SNP driver's tansmit queue. The packet + can be considered successfully sent out once SNP acccetp the packet, while the + packet buffer recycle is deferred for better performance. + + @param[in] MnpServiceData Pointer to the mnp service context data. + @param[in] Packet Pointer to the pakcet buffer. + @param[in] Length The length of the packet. + @param[in, out] Token Pointer to the token the packet generated from. + + @retval EFI_SUCCESS The packet is sent out. + @retval EFI_TIMEOUT Time out occurs, the packet isn't sent. + @retval EFI_DEVICE_ERROR An unexpected network error occurs. + +**/ +EFI_STATUS +MnpSyncSendPacket ( + IN MNP_SERVICE_DATA *MnpServiceData, + IN UINT8 *Packet, + IN UINT32 Length, + IN OUT EFI_MANAGED_NETWORK_COMPLETION_TOKEN *Token + ) +{ + EFI_STATUS Status; + EFI_SIMPLE_NETWORK_PROTOCOL *Snp; + EFI_MANAGED_NETWORK_TRANSMIT_DATA *TxData; + UINT32 HeaderSize; + MNP_DEVICE_DATA *MnpDeviceData; + UINT16 ProtocolType; + + MnpDeviceData = MnpServiceData->MnpDeviceData; + Snp = MnpDeviceData->Snp; + TxData = Token->Packet.TxData; + Token->Status = EFI_SUCCESS; + HeaderSize = Snp->Mode->MediaHeaderSize - TxData->HeaderLength; + + // + // Check media status before transmit packet. + // Note: media status will be updated by periodic timer MediaDetectTimer. + // + if (Snp->Mode->MediaPresentSupported && !Snp->Mode->MediaPresent) { + // + // Media not present, skip packet transmit and report EFI_NO_MEDIA + // + DEBUG ((EFI_D_WARN, "MnpSyncSendPacket: No network cable detected.\n")); + Token->Status = EFI_NO_MEDIA; + goto SIGNAL_TOKEN; + } + + + if (MnpServiceData->VlanId != 0) { + // + // Insert VLAN tag + // + MnpInsertVlanTag (MnpServiceData, TxData, &ProtocolType, &Packet, &Length); + } else { + ProtocolType = TxData->ProtocolType; + } + + // + // Transmit the packet through SNP. + // + Status = Snp->Transmit ( + Snp, + HeaderSize, + Length, + Packet, + TxData->SourceAddress, + TxData->DestinationAddress, + &ProtocolType + ); + if (Status == EFI_NOT_READY) { + Status = MnpRecycleTxBuf (MnpDeviceData); + if (EFI_ERROR (Status)) { + Token->Status = EFI_DEVICE_ERROR; + goto SIGNAL_TOKEN; + } + + Status = Snp->Transmit ( + Snp, + HeaderSize, + Length, + Packet, + TxData->SourceAddress, + TxData->DestinationAddress, + &ProtocolType + ); + } + + if (EFI_ERROR (Status)) { + Token->Status = EFI_DEVICE_ERROR; + } + +SIGNAL_TOKEN: + + gBS->SignalEvent (Token->Event); + + // + // Dispatch the DPC queued by the NotifyFunction of Token->Event. + // + DispatchDpc (); + + return EFI_SUCCESS; +} + + +/** + Try to deliver the received packet to the instance. + + @param[in, out] Instance Pointer to the mnp instance context data. + + @retval EFI_SUCCESS The received packet is delivered, or there is no + packet to deliver, or there is no available receive + token. + @retval EFI_OUT_OF_RESOURCES The deliver fails due to lack of memory resource. + +**/ +EFI_STATUS +MnpInstanceDeliverPacket ( + IN OUT MNP_INSTANCE_DATA *Instance + ) +{ + MNP_DEVICE_DATA *MnpDeviceData; + MNP_RXDATA_WRAP *RxDataWrap; + NET_BUF *DupNbuf; + EFI_MANAGED_NETWORK_RECEIVE_DATA *RxData; + EFI_SIMPLE_NETWORK_MODE *SnpMode; + EFI_MANAGED_NETWORK_COMPLETION_TOKEN *RxToken; + + MnpDeviceData = Instance->MnpServiceData->MnpDeviceData; + NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); + + if (NetMapIsEmpty (&Instance->RxTokenMap) || IsListEmpty (&Instance->RcvdPacketQueue)) { + // + // No pending received data or no available receive token, return. + // + return EFI_SUCCESS; + } + + ASSERT (Instance->RcvdPacketQueueSize != 0); + + RxDataWrap = NET_LIST_HEAD (&Instance->RcvdPacketQueue, MNP_RXDATA_WRAP, WrapEntry); + if (RxDataWrap->Nbuf->RefCnt > 2) { + // + // There are other instances share this Nbuf, duplicate to get a + // copy to allow the instance to do R/W operations. + // + DupNbuf = MnpAllocNbuf (MnpDeviceData); + if (DupNbuf == NULL) { + DEBUG ((EFI_D_WARN, "MnpDeliverPacket: Failed to allocate a free Nbuf.\n")); + + return EFI_OUT_OF_RESOURCES; + } + + // + // Duplicate the net buffer. + // + NetbufDuplicate (RxDataWrap->Nbuf, DupNbuf, 0); + MnpFreeNbuf (MnpDeviceData, RxDataWrap->Nbuf); + RxDataWrap->Nbuf = DupNbuf; + } + + // + // All resources are OK, remove the packet from the queue. + // + NetListRemoveHead (&Instance->RcvdPacketQueue); + Instance->RcvdPacketQueueSize--; + + RxData = &RxDataWrap->RxData; + SnpMode = MnpDeviceData->Snp->Mode; + + // + // Set all the buffer pointers. + // + RxData->MediaHeader = NetbufGetByte (RxDataWrap->Nbuf, 0, NULL); + RxData->DestinationAddress = RxData->MediaHeader; + RxData->SourceAddress = (UINT8 *) RxData->MediaHeader + SnpMode->HwAddressSize; + RxData->PacketData = (UINT8 *) RxData->MediaHeader + SnpMode->MediaHeaderSize; + + // + // Insert this RxDataWrap into the delivered queue. + // + InsertTailList (&Instance->RxDeliveredPacketQueue, &RxDataWrap->WrapEntry); + + // + // Get the receive token from the RxTokenMap. + // + RxToken = NetMapRemoveHead (&Instance->RxTokenMap, NULL); + + // + // Signal this token's event. + // + RxToken->Packet.RxData = &RxDataWrap->RxData; + RxToken->Status = EFI_SUCCESS; + gBS->SignalEvent (RxToken->Event); + + return EFI_SUCCESS; +} + + +/** + Deliver the received packet for the instances belonging to the MnpServiceData. + + @param[in] MnpServiceData Pointer to the mnp service context data. + +**/ +VOID +MnpDeliverPacket ( + IN MNP_SERVICE_DATA *MnpServiceData + ) +{ + LIST_ENTRY *Entry; + MNP_INSTANCE_DATA *Instance; + + NET_CHECK_SIGNATURE (MnpServiceData, MNP_SERVICE_DATA_SIGNATURE); + + NET_LIST_FOR_EACH (Entry, &MnpServiceData->ChildrenList) { + Instance = NET_LIST_USER_STRUCT (Entry, MNP_INSTANCE_DATA, InstEntry); + NET_CHECK_SIGNATURE (Instance, MNP_INSTANCE_DATA_SIGNATURE); + + // + // Try to deliver packet for this instance. + // + MnpInstanceDeliverPacket (Instance); + } +} + + +/** + Recycle the RxData and other resources used to hold and deliver the received + packet. + + @param[in] Event The event this notify function registered to. + @param[in] Context Pointer to the context data registerd to the Event. + +**/ +VOID +EFIAPI +MnpRecycleRxData ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + MNP_RXDATA_WRAP *RxDataWrap; + MNP_DEVICE_DATA *MnpDeviceData; + + ASSERT (Context != NULL); + + RxDataWrap = (MNP_RXDATA_WRAP *) Context; + NET_CHECK_SIGNATURE (RxDataWrap->Instance, MNP_INSTANCE_DATA_SIGNATURE); + + ASSERT (RxDataWrap->Nbuf != NULL); + + MnpDeviceData = RxDataWrap->Instance->MnpServiceData->MnpDeviceData; + NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); + + // + // Free this Nbuf. + // + MnpFreeNbuf (MnpDeviceData, RxDataWrap->Nbuf); + RxDataWrap->Nbuf = NULL; + + // + // Close the recycle event. + // + gBS->CloseEvent (RxDataWrap->RxData.RecycleEvent); + + // + // Remove this Wrap entry from the list. + // + RemoveEntryList (&RxDataWrap->WrapEntry); + + FreePool (RxDataWrap); +} + + +/** + Queue the received packet into instance's receive queue. + + @param[in, out] Instance Pointer to the mnp instance context data. + @param[in, out] RxDataWrap Pointer to the Wrap structure containing the + received data and other information. +**/ +VOID +MnpQueueRcvdPacket ( + IN OUT MNP_INSTANCE_DATA *Instance, + IN OUT MNP_RXDATA_WRAP *RxDataWrap + ) +{ + MNP_RXDATA_WRAP *OldRxDataWrap; + + NET_CHECK_SIGNATURE (Instance, MNP_INSTANCE_DATA_SIGNATURE); + + // + // Check the queue size. If it exceeds the limit, drop one packet + // from the head. + // + if (Instance->RcvdPacketQueueSize == MNP_MAX_RCVD_PACKET_QUE_SIZE) { + + DEBUG ((EFI_D_WARN, "MnpQueueRcvdPacket: Drop one packet bcz queue size limit reached.\n")); + + // + // Get the oldest packet. + // + OldRxDataWrap = NET_LIST_HEAD ( + &Instance->RcvdPacketQueue, + MNP_RXDATA_WRAP, + WrapEntry + ); + + // + // Recycle this OldRxDataWrap, this entry will be removed by the callee. + // + MnpRecycleRxData (NULL, (VOID *) OldRxDataWrap); + Instance->RcvdPacketQueueSize--; + } + + // + // Update the timeout tick using the configured parameter. + // + RxDataWrap->TimeoutTick = Instance->ConfigData.ReceivedQueueTimeoutValue; + + // + // Insert this Wrap into the instance queue. + // + InsertTailList (&Instance->RcvdPacketQueue, &RxDataWrap->WrapEntry); + Instance->RcvdPacketQueueSize++; +} + + +/** + Match the received packet with the instance receive filters. + + @param[in] Instance Pointer to the mnp instance context data. + @param[in] RxData Pointer to the EFI_MANAGED_NETWORK_RECEIVE_DATA. + @param[in] GroupAddress Pointer to the GroupAddress, the GroupAddress is + non-NULL and it contains the destination multicast + mac address of the received packet if the packet + destinated to a multicast mac address. + @param[in] PktAttr The received packets attribute. + + @return The received packet matches the instance's receive filters or not. + +**/ +BOOLEAN +MnpMatchPacket ( + IN MNP_INSTANCE_DATA *Instance, + IN EFI_MANAGED_NETWORK_RECEIVE_DATA *RxData, + IN MNP_GROUP_ADDRESS *GroupAddress OPTIONAL, + IN UINT8 PktAttr + ) +{ + EFI_MANAGED_NETWORK_CONFIG_DATA *ConfigData; + LIST_ENTRY *Entry; + MNP_GROUP_CONTROL_BLOCK *GroupCtrlBlk; + + NET_CHECK_SIGNATURE (Instance, MNP_INSTANCE_DATA_SIGNATURE); + + ConfigData = &Instance->ConfigData; + + // + // Check the protocol type. + // + if ((ConfigData->ProtocolTypeFilter != 0) && (ConfigData->ProtocolTypeFilter != RxData->ProtocolType)) { + return FALSE; + } + + if (ConfigData->EnablePromiscuousReceive) { + // + // Always match if this instance is configured to be promiscuous. + // + return TRUE; + } + + // + // The protocol type is matched, check receive filter, include unicast and broadcast. + // + if ((Instance->ReceiveFilter & PktAttr) != 0) { + return TRUE; + } + + // + // Check multicast addresses. + // + if (ConfigData->EnableMulticastReceive && RxData->MulticastFlag) { + + ASSERT (GroupAddress != NULL); + + NET_LIST_FOR_EACH (Entry, &Instance->GroupCtrlBlkList) { + + GroupCtrlBlk = NET_LIST_USER_STRUCT (Entry, MNP_GROUP_CONTROL_BLOCK, CtrlBlkEntry); + if (GroupCtrlBlk->GroupAddress == GroupAddress) { + // + // The instance is configured to receiveing packets destinated to this + // multicast address. + // + return TRUE; + } + } + } + + // + // No match. + // + return FALSE; +} + + +/** + Analyse the received packets. + + @param[in] MnpServiceData Pointer to the mnp service context data. + @param[in] Nbuf Pointer to the net buffer holding the received + packet. + @param[in, out] RxData Pointer to the buffer used to save the analysed + result in EFI_MANAGED_NETWORK_RECEIVE_DATA. + @param[out] GroupAddress Pointer to pointer to a MNP_GROUP_ADDRESS used to + pass out the address of the multicast address the + received packet destinated to. + @param[out] PktAttr Pointer to the buffer used to save the analysed + packet attribute. + +**/ +VOID +MnpAnalysePacket ( + IN MNP_SERVICE_DATA *MnpServiceData, + IN NET_BUF *Nbuf, + IN OUT EFI_MANAGED_NETWORK_RECEIVE_DATA *RxData, + OUT MNP_GROUP_ADDRESS **GroupAddress, + OUT UINT8 *PktAttr + ) +{ + EFI_SIMPLE_NETWORK_MODE *SnpMode; + MNP_DEVICE_DATA *MnpDeviceData; + UINT8 *BufPtr; + LIST_ENTRY *Entry; + + MnpDeviceData = MnpServiceData->MnpDeviceData; + SnpMode = MnpDeviceData->Snp->Mode; + + // + // Get the packet buffer. + // + BufPtr = NetbufGetByte (Nbuf, 0, NULL); + ASSERT (BufPtr != NULL); + + // + // Set the initial values. + // + RxData->BroadcastFlag = FALSE; + RxData->MulticastFlag = FALSE; + RxData->PromiscuousFlag = FALSE; + *PktAttr = UNICAST_PACKET; + + if (!NET_MAC_EQUAL (&SnpMode->CurrentAddress, BufPtr, SnpMode->HwAddressSize)) { + // + // This packet isn't destinated to our current mac address, it't not unicast. + // + *PktAttr = 0; + + if (NET_MAC_EQUAL (&SnpMode->BroadcastAddress, BufPtr, SnpMode->HwAddressSize)) { + // + // It's broadcast. + // + RxData->BroadcastFlag = TRUE; + *PktAttr = BROADCAST_PACKET; + } else if ((*BufPtr & 0x01) == 0x1) { + // + // It's multicast, try to match the multicast filters. + // + NET_LIST_FOR_EACH (Entry, &MnpDeviceData->GroupAddressList) { + + *GroupAddress = NET_LIST_USER_STRUCT (Entry, MNP_GROUP_ADDRESS, AddrEntry); + if (NET_MAC_EQUAL (BufPtr, &((*GroupAddress)->Address), SnpMode->HwAddressSize)) { + RxData->MulticastFlag = TRUE; + break; + } + } + + if (!RxData->MulticastFlag) { + // + // No match, set GroupAddress to NULL. This multicast packet must + // be the result of PROMISUCOUS or PROMISUCOUS_MULTICAST flag is on. + // + *GroupAddress = NULL; + RxData->PromiscuousFlag = TRUE; + + if (MnpDeviceData->PromiscuousCount == 0) { + // + // Skip the below code, there is no receiver of this packet. + // + return ; + } + } + } else { + RxData->PromiscuousFlag = TRUE; + } + } + + ZeroMem (&RxData->Timestamp, sizeof (EFI_TIME)); + + // + // Fill the common parts of RxData. + // + RxData->PacketLength = Nbuf->TotalSize; + RxData->HeaderLength = SnpMode->MediaHeaderSize; + RxData->AddressLength = SnpMode->HwAddressSize; + RxData->DataLength = RxData->PacketLength - RxData->HeaderLength; + RxData->ProtocolType = NTOHS (*(UINT16 *) (BufPtr + 2 * SnpMode->HwAddressSize)); +} + + +/** + Wrap the RxData. + + @param[in] Instance Pointer to the mnp instance context data. + @param[in] RxData Pointer to the receive data to wrap. + + @return Pointer to a MNP_RXDATA_WRAP which wraps the RxData. + +**/ +MNP_RXDATA_WRAP * +MnpWrapRxData ( + IN MNP_INSTANCE_DATA *Instance, + IN EFI_MANAGED_NETWORK_RECEIVE_DATA *RxData + ) +{ + EFI_STATUS Status; + MNP_RXDATA_WRAP *RxDataWrap; + + // + // Allocate memory. + // + RxDataWrap = AllocatePool (sizeof (MNP_RXDATA_WRAP)); + if (RxDataWrap == NULL) { + DEBUG ((EFI_D_ERROR, "MnpDispatchPacket: Failed to allocate a MNP_RXDATA_WRAP.\n")); + return NULL; + } + + RxDataWrap->Instance = Instance; + + // + // Fill the RxData in RxDataWrap, + // + CopyMem (&RxDataWrap->RxData, RxData, sizeof (RxDataWrap->RxData)); + + // + // Create the recycle event. + // + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, + MnpRecycleRxData, + RxDataWrap, + &RxDataWrap->RxData.RecycleEvent + ); + if (EFI_ERROR (Status)) { + DEBUG ((EFI_D_ERROR, "MnpDispatchPacket: gBS->CreateEvent failed, %r.\n", Status)); + + FreePool (RxDataWrap); + return NULL; + } + + return RxDataWrap; +} + + +/** + Enqueue the received the packets to the instances belonging to the + MnpServiceData. + + @param[in] MnpServiceData Pointer to the mnp service context data. + @param[in] Nbuf Pointer to the net buffer representing the received + packet. + +**/ +VOID +MnpEnqueuePacket ( + IN MNP_SERVICE_DATA *MnpServiceData, + IN NET_BUF *Nbuf + ) +{ + LIST_ENTRY *Entry; + MNP_INSTANCE_DATA *Instance; + EFI_MANAGED_NETWORK_RECEIVE_DATA RxData; + UINT8 PktAttr; + MNP_GROUP_ADDRESS *GroupAddress; + MNP_RXDATA_WRAP *RxDataWrap; + + + GroupAddress = NULL; + // + // First, analyse the packet header. + // + MnpAnalysePacket (MnpServiceData, Nbuf, &RxData, &GroupAddress, &PktAttr); + + if (RxData.PromiscuousFlag && (MnpServiceData->MnpDeviceData->PromiscuousCount == 0)) { + // + // No receivers, no more action need. + // + return ; + } + + // + // Iterate the children to find match. + // + NET_LIST_FOR_EACH (Entry, &MnpServiceData->ChildrenList) { + + Instance = NET_LIST_USER_STRUCT (Entry, MNP_INSTANCE_DATA, InstEntry); + NET_CHECK_SIGNATURE (Instance, MNP_INSTANCE_DATA_SIGNATURE); + + if (!Instance->Configured) { + continue; + } + + // + // Check the packet against the instance receive filters. + // + if (MnpMatchPacket (Instance, &RxData, GroupAddress, PktAttr)) { + // + // Wrap the RxData. + // + RxDataWrap = MnpWrapRxData (Instance, &RxData); + if (RxDataWrap == NULL) { + continue; + } + + // + // Associate RxDataWrap with Nbuf and increase the RefCnt. + // + RxDataWrap->Nbuf = Nbuf; + NET_GET_REF (RxDataWrap->Nbuf); + + // + // Queue the packet into the instance queue. + // + MnpQueueRcvdPacket (Instance, RxDataWrap); + } + } +} + + +/** + Try to receive a packet and deliver it. + + @param[in, out] MnpDeviceData Pointer to the mnp device context data. + + @retval EFI_SUCCESS add return value to function comment + @retval EFI_NOT_STARTED The simple network protocol is not started. + @retval EFI_NOT_READY No packet received. + @retval EFI_DEVICE_ERROR An unexpected error occurs. + +**/ +EFI_STATUS +MnpReceivePacket ( + IN OUT MNP_DEVICE_DATA *MnpDeviceData + ) +{ + EFI_STATUS Status; + EFI_SIMPLE_NETWORK_PROTOCOL *Snp; + NET_BUF *Nbuf; + UINT8 *BufPtr; + UINTN BufLen; + UINTN HeaderSize; + UINT32 Trimmed; + MNP_SERVICE_DATA *MnpServiceData; + UINT16 VlanId; + BOOLEAN IsVlanPacket; + + NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); + + Snp = MnpDeviceData->Snp; + if (Snp->Mode->State != EfiSimpleNetworkInitialized) { + // + // The simple network protocol is not started. + // + return EFI_NOT_STARTED; + } + + if (MnpDeviceData->RxNbufCache == NULL) { + // + // Try to get a new buffer as there may be buffers recycled. + // + MnpDeviceData->RxNbufCache = MnpAllocNbuf (MnpDeviceData); + + if (MnpDeviceData->RxNbufCache == NULL) { + // + // No available buffer in the buffer pool. + // + return EFI_DEVICE_ERROR; + } + + NetbufAllocSpace ( + MnpDeviceData->RxNbufCache, + MnpDeviceData->BufferLength, + NET_BUF_TAIL + ); + } + + Nbuf = MnpDeviceData->RxNbufCache; + BufLen = Nbuf->TotalSize; + BufPtr = NetbufGetByte (Nbuf, 0, NULL); + ASSERT (BufPtr != NULL); + + // + // Receive packet through Snp. + // + Status = Snp->Receive (Snp, &HeaderSize, &BufLen, BufPtr, NULL, NULL, NULL); + if (EFI_ERROR (Status)) { + DEBUG_CODE ( + if (Status != EFI_NOT_READY) { + DEBUG ((EFI_D_WARN, "MnpReceivePacket: Snp->Receive() = %r.\n", Status)); + } + ); + + return Status; + } + + // + // Sanity check. + // + if ((HeaderSize != Snp->Mode->MediaHeaderSize) || (BufLen < HeaderSize)) { + DEBUG ( + (EFI_D_WARN, + "MnpReceivePacket: Size error, HL:TL = %d:%d.\n", + HeaderSize, + BufLen) + ); + return EFI_DEVICE_ERROR; + } + + Trimmed = 0; + if (Nbuf->TotalSize != BufLen) { + // + // Trim the packet from tail. + // + Trimmed = NetbufTrim (Nbuf, Nbuf->TotalSize - (UINT32) BufLen, NET_BUF_TAIL); + ASSERT (Nbuf->TotalSize == BufLen); + } + + VlanId = 0; + if (MnpDeviceData->NumberOfVlan != 0) { + // + // VLAN is configured, remove the VLAN tag if any + // + IsVlanPacket = MnpRemoveVlanTag (MnpDeviceData, Nbuf, &VlanId); + } else { + IsVlanPacket = FALSE; + } + + MnpServiceData = MnpFindServiceData (MnpDeviceData, VlanId); + if (MnpServiceData == NULL) { + // + // VLAN is not set for this tagged frame, ignore this packet + // + if (Trimmed > 0) { + NetbufAllocSpace (Nbuf, Trimmed, NET_BUF_TAIL); + } + + if (IsVlanPacket) { + NetbufAllocSpace (Nbuf, NET_VLAN_TAG_LEN, NET_BUF_HEAD); + } + + goto EXIT; + } + + // + // Enqueue the packet to the matched instances. + // + MnpEnqueuePacket (MnpServiceData, Nbuf); + + if (Nbuf->RefCnt > 2) { + // + // RefCnt > 2 indicates there is at least one receiver of this packet. + // Free the current RxNbufCache and allocate a new one. + // + MnpFreeNbuf (MnpDeviceData, Nbuf); + + Nbuf = MnpAllocNbuf (MnpDeviceData); + MnpDeviceData->RxNbufCache = Nbuf; + if (Nbuf == NULL) { + DEBUG ((EFI_D_ERROR, "MnpReceivePacket: Alloc packet for receiving cache failed.\n")); + return EFI_DEVICE_ERROR; + } + + NetbufAllocSpace (Nbuf, MnpDeviceData->BufferLength, NET_BUF_TAIL); + } else { + // + // No receiver for this packet. + // + if (Trimmed > 0) { + NetbufAllocSpace (Nbuf, Trimmed, NET_BUF_TAIL); + } + if (IsVlanPacket) { + NetbufAllocSpace (Nbuf, NET_VLAN_TAG_LEN, NET_BUF_HEAD); + } + + goto EXIT; + } + // + // Deliver the queued packets. + // + MnpDeliverPacket (MnpServiceData); + +EXIT: + + ASSERT (Nbuf->TotalSize == MnpDeviceData->BufferLength); + + return Status; +} + + +/** + Remove the received packets if timeout occurs. + + @param[in] Event The event this notify function registered to. + @param[in] Context Pointer to the context data registered to the event. + +**/ +VOID +EFIAPI +MnpCheckPacketTimeout ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + MNP_DEVICE_DATA *MnpDeviceData; + MNP_SERVICE_DATA *MnpServiceData; + LIST_ENTRY *Entry; + LIST_ENTRY *ServiceEntry; + LIST_ENTRY *RxEntry; + LIST_ENTRY *NextEntry; + MNP_INSTANCE_DATA *Instance; + MNP_RXDATA_WRAP *RxDataWrap; + EFI_TPL OldTpl; + + MnpDeviceData = (MNP_DEVICE_DATA *) Context; + NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); + + NET_LIST_FOR_EACH (ServiceEntry, &MnpDeviceData->ServiceList) { + MnpServiceData = MNP_SERVICE_DATA_FROM_LINK (ServiceEntry); + + NET_LIST_FOR_EACH (Entry, &MnpServiceData->ChildrenList) { + + Instance = NET_LIST_USER_STRUCT (Entry, MNP_INSTANCE_DATA, InstEntry); + NET_CHECK_SIGNATURE (Instance, MNP_INSTANCE_DATA_SIGNATURE); + + if (!Instance->Configured || (Instance->ConfigData.ReceivedQueueTimeoutValue == 0)) { + // + // This instance is not configured or there is no receive time out, + // just skip to the next instance. + // + continue; + } + + OldTpl = gBS->RaiseTPL (TPL_NOTIFY); + + NET_LIST_FOR_EACH_SAFE (RxEntry, NextEntry, &Instance->RcvdPacketQueue) { + + RxDataWrap = NET_LIST_USER_STRUCT (RxEntry, MNP_RXDATA_WRAP, WrapEntry); + + // + // TimeoutTick unit is microsecond, MNP_TIMEOUT_CHECK_INTERVAL unit is 100ns. + // + if (RxDataWrap->TimeoutTick >= (MNP_TIMEOUT_CHECK_INTERVAL / 10)) { + RxDataWrap->TimeoutTick -= (MNP_TIMEOUT_CHECK_INTERVAL / 10); + } else { + // + // Drop the timeout packet. + // + DEBUG ((EFI_D_WARN, "MnpCheckPacketTimeout: Received packet timeout.\n")); + MnpRecycleRxData (NULL, RxDataWrap); + Instance->RcvdPacketQueueSize--; + } + } + + gBS->RestoreTPL (OldTpl); + } + } +} + +/** + Poll to update MediaPresent field in SNP ModeData by Snp->GetStatus(). + + @param[in] Event The event this notify function registered to. + @param[in] Context Pointer to the context data registered to the event. + +**/ +VOID +EFIAPI +MnpCheckMediaStatus ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + MNP_DEVICE_DATA *MnpDeviceData; + EFI_SIMPLE_NETWORK_PROTOCOL *Snp; + UINT32 InterruptStatus; + + MnpDeviceData = (MNP_DEVICE_DATA *) Context; + NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); + + Snp = MnpDeviceData->Snp; + if (Snp->Mode->MediaPresentSupported) { + // + // Upon successful return of GetStatus(), the MediaPresent field of + // EFI_SIMPLE_NETWORK_MODE will be updated to reflect any change of media status + // + Snp->GetStatus (Snp, &InterruptStatus, NULL); + } +} + +/** + Poll to receive the packets from Snp. This function is either called by upperlayer + protocols/applications or the system poll timer notify mechanism. + + @param[in] Event The event this notify function registered to. + @param[in] Context Pointer to the context data registered to the event. + +**/ +VOID +EFIAPI +MnpSystemPoll ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + MNP_DEVICE_DATA *MnpDeviceData; + + MnpDeviceData = (MNP_DEVICE_DATA *) Context; + NET_CHECK_SIGNATURE (MnpDeviceData, MNP_DEVICE_DATA_SIGNATURE); + + // + // Try to receive packets from Snp. + // + MnpReceivePacket (MnpDeviceData); + + // + // Dispatch the DPC queued by the NotifyFunction of rx token's events. + // + DispatchDpc (); +} diff --git a/NetworkPkg/MnpDxe/MnpMain.c b/NetworkPkg/MnpDxe/MnpMain.c new file mode 100644 index 0000000000..d96178a1d9 --- /dev/null +++ b/NetworkPkg/MnpDxe/MnpMain.c @@ -0,0 +1,789 @@ +/** @file + Implementation of Managed Network Protocol public services. + +Copyright (c) 2005 - 2016, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "MnpImpl.h" + +/** + Returns the operational parameters for the current MNP child driver. May also + support returning the underlying SNP driver mode data. + + The GetModeData() function is used to read the current mode data (operational + parameters) from the MNP or the underlying SNP. + + @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. + @param[out] MnpConfigData Pointer to storage for MNP operational parameters. Type + EFI_MANAGED_NETWORK_CONFIG_DATA is defined in "Related + Definitions" below. + @param[out] SnpModeData Pointer to storage for SNP operational parameters. This + feature may be unsupported. Type EFI_SIMPLE_NETWORK_MODE + is defined in the EFI_SIMPLE_NETWORK_PROTOCOL. + + @retval EFI_SUCCESS The operation completed successfully. + @retval EFI_INVALID_PARAMETER This is NULL. + @retval EFI_UNSUPPORTED The requested feature is unsupported in this + MNP implementation. + @retval EFI_NOT_STARTED This MNP child driver instance has not been + configured. The default values are returned in + MnpConfigData if it is not NULL. + @retval Others The mode data could not be read. + +**/ +EFI_STATUS +EFIAPI +MnpGetModeData ( + IN EFI_MANAGED_NETWORK_PROTOCOL *This, + OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL, + OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL + ) +{ + MNP_INSTANCE_DATA *Instance; + EFI_SIMPLE_NETWORK_PROTOCOL *Snp; + EFI_TPL OldTpl; + EFI_STATUS Status; + UINT32 InterruptStatus; + + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + Instance = MNP_INSTANCE_DATA_FROM_THIS (This); + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + if (MnpConfigData != NULL) { + // + // Copy the instance configuration data. + // + CopyMem (MnpConfigData, &Instance->ConfigData, sizeof (*MnpConfigData)); + } + + if (SnpModeData != NULL) { + // + // Copy the underlayer Snp mode data. + // + Snp = Instance->MnpServiceData->MnpDeviceData->Snp; + + // + // Upon successful return of GetStatus(), the Snp->Mode->MediaPresent + // will be updated to reflect any change of media status + // + Snp->GetStatus (Snp, &InterruptStatus, NULL); + CopyMem (SnpModeData, Snp->Mode, sizeof (*SnpModeData)); + } + + if (!Instance->Configured) { + Status = EFI_NOT_STARTED; + } else { + Status = EFI_SUCCESS; + } + + gBS->RestoreTPL (OldTpl); + + return Status; +} + + +/** + Sets or clears the operational parameters for the MNP child driver. + + The Configure() function is used to set, change, or reset the operational + parameters for the MNP child driver instance. Until the operational parameters + have been set, no network traffic can be sent or received by this MNP child + driver instance. Once the operational parameters have been reset, no more + traffic can be sent or received until the operational parameters have been set + again. + Each MNP child driver instance can be started and stopped independently of + each other by setting or resetting their receive filter settings with the + Configure() function. + After any successful call to Configure(), the MNP child driver instance is + started. The internal periodic timer (if supported) is enabled. Data can be + transmitted and may be received if the receive filters have also been enabled. + Note: If multiple MNP child driver instances will receive the same packet + because of overlapping receive filter settings, then the first MNP child + driver instance will receive the original packet and additional instances will + receive copies of the original packet. + Note: Warning: Receive filter settings that overlap will consume extra + processor and/or DMA resources and degrade system and network performance. + + @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. + @param[in] MnpConfigData Pointer to configuration data that will be assigned + to the MNP child driver instance. If NULL, the MNP + child driver instance is reset to startup defaults + and all pending transmit and receive requests are + flushed. Type EFI_MANAGED_NETWORK_CONFIG_DATA is + defined in EFI_MANAGED_NETWORK_PROTOCOL.GetModeData(). + + @retval EFI_SUCCESS The operation completed successfully. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is + TRUE: + * This is NULL. + * MnpConfigData.ProtocolTypeFilter is not + valid. + The operational data for the MNP child driver + instance is unchanged. + @retval EFI_OUT_OF_RESOURCES Required system resources (usually memory) + could not be allocated. + The MNP child driver instance has been reset to + startup defaults. + @retval EFI_UNSUPPORTED The requested feature is unsupported in + this [MNP] implementation. The operational data + for the MNP child driver instance is unchanged. + @retval EFI_DEVICE_ERROR An unexpected network or system error + occurred. The MNP child driver instance has + been reset to startup defaults. + @retval Others The MNP child driver instance has been reset to + startup defaults. + +**/ +EFI_STATUS +EFIAPI +MnpConfigure ( + IN EFI_MANAGED_NETWORK_PROTOCOL *This, + IN EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL + ) +{ + MNP_INSTANCE_DATA *Instance; + EFI_TPL OldTpl; + EFI_STATUS Status; + + if ((This == NULL) || + ((MnpConfigData != NULL) && + (MnpConfigData->ProtocolTypeFilter > 0) && + (MnpConfigData->ProtocolTypeFilter <= 1500)) + ) { + return EFI_INVALID_PARAMETER; + } + + Instance = MNP_INSTANCE_DATA_FROM_THIS (This); + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + if ((MnpConfigData == NULL) && (!Instance->Configured)) { + // + // If the instance is not configured and a reset is requested, just return. + // + Status = EFI_SUCCESS; + goto ON_EXIT; + } + + // + // Configure the instance. + // + Status = MnpConfigureInstance (Instance, MnpConfigData); + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + + return Status; +} + + +/** + Translates an IP multicast address to a hardware (MAC) multicast address. This + function may be unsupported in some MNP implementations. + + The McastIpToMac() function translates an IP multicast address to a hardware + (MAC) multicast address. This function may be implemented by calling the + underlying EFI_SIMPLE_NETWORK. MCastIpToMac() function, which may also be + unsupported in some MNP implementations. + + @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. + @param[in] Ipv6Flag Set to TRUE to if IpAddress is an IPv6 multicast address. + Set to FALSE if IpAddress is an IPv4 multicast address. + @param[in] IpAddress Pointer to the multicast IP address (in network byte + order) to convert. + @param[out] MacAddress Pointer to the resulting multicast MAC address. + + @retval EFI_SUCCESS The operation completed successfully. + @retval EFI_INVALID_PARAMETER One of the following conditions is TRUE: + * This is NULL. + * IpAddress is NULL. + * IpAddress is not a valid multicast IP + address. + * MacAddress is NULL. + @retval EFI_NOT_STARTED This MNP child driver instance has not been + configured. + @retval EFI_UNSUPPORTED The requested feature is unsupported in this + MNP implementation. + @retval EFI_DEVICE_ERROR An unexpected network or system error occurred. + @retval Others The address could not be converted. +**/ +EFI_STATUS +EFIAPI +MnpMcastIpToMac ( + IN EFI_MANAGED_NETWORK_PROTOCOL *This, + IN BOOLEAN Ipv6Flag, + IN EFI_IP_ADDRESS *IpAddress, + OUT EFI_MAC_ADDRESS *MacAddress + ) +{ + EFI_STATUS Status; + MNP_INSTANCE_DATA *Instance; + EFI_SIMPLE_NETWORK_PROTOCOL *Snp; + EFI_TPL OldTpl; + EFI_IPv6_ADDRESS *Ip6Address; + + if ((This == NULL) || (IpAddress == NULL) || (MacAddress == NULL)) { + return EFI_INVALID_PARAMETER; + } + + Ip6Address = &IpAddress->v6; + + if ((Ipv6Flag && !IP6_IS_MULTICAST (Ip6Address)) || + (!Ipv6Flag && !IP4_IS_MULTICAST (EFI_NTOHL (*IpAddress))) + ) { + // + // The IP address passed in is not a multicast address. + // + return EFI_INVALID_PARAMETER; + } + + Instance = MNP_INSTANCE_DATA_FROM_THIS (This); + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + if (!Instance->Configured) { + + Status = EFI_NOT_STARTED; + goto ON_EXIT; + } + + Snp = Instance->MnpServiceData->MnpDeviceData->Snp; + ASSERT (Snp != NULL); + + ZeroMem (MacAddress, sizeof (EFI_MAC_ADDRESS)); + + if (Snp->Mode->IfType == NET_IFTYPE_ETHERNET) { + if (!Ipv6Flag) { + // + // Translate the IPv4 address into a multicast MAC address if the NIC is an + // ethernet NIC according to RFC1112.. + // + MacAddress->Addr[0] = 0x01; + MacAddress->Addr[1] = 0x00; + MacAddress->Addr[2] = 0x5E; + MacAddress->Addr[3] = (UINT8) (IpAddress->v4.Addr[1] & 0x7F); + MacAddress->Addr[4] = IpAddress->v4.Addr[2]; + MacAddress->Addr[5] = IpAddress->v4.Addr[3]; + } else { + // + // Translate the IPv6 address into a multicast MAC address if the NIC is an + // ethernet NIC according to RFC2464. + // + + MacAddress->Addr[0] = 0x33; + MacAddress->Addr[1] = 0x33; + MacAddress->Addr[2] = Ip6Address->Addr[12]; + MacAddress->Addr[3] = Ip6Address->Addr[13]; + MacAddress->Addr[4] = Ip6Address->Addr[14]; + MacAddress->Addr[5] = Ip6Address->Addr[15]; + } + + Status = EFI_SUCCESS; + } else { + // + // Invoke Snp to translate the multicast IP address. + // + Status = Snp->MCastIpToMac ( + Snp, + Ipv6Flag, + IpAddress, + MacAddress + ); + } + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + + return Status; +} + +/** + Enables and disables receive filters for multicast address. This function may + be unsupported in some MNP implementations. + + The Groups() function only adds and removes multicast MAC addresses from the + filter list. The MNP driver does not transmit or process Internet Group + Management Protocol (IGMP) packets. If JoinFlag is FALSE and MacAddress is + NULL, then all joined groups are left. + + @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. + @param[in] JoinFlag Set to TRUE to join this multicast group. + Set to FALSE to leave this multicast group. + @param[in] MacAddress Pointer to the multicast MAC group (address) to join or + leave. + + @retval EFI_SUCCESS The requested operation completed successfully. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + * This is NULL. + * JoinFlag is TRUE and MacAddress is NULL. + * MacAddress is not a valid multicast MAC + address. + * The MNP multicast group settings are + unchanged. + @retval EFI_NOT_STARTED This MNP child driver instance has not been + configured. + @retval EFI_ALREADY_STARTED The supplied multicast group is already joined. + @retval EFI_NOT_FOUND The supplied multicast group is not joined. + @retval EFI_DEVICE_ERROR An unexpected network or system error occurred. + The MNP child driver instance has been reset to + startup defaults. + @retval EFI_UNSUPPORTED The requested feature is unsupported in this MNP + implementation. + @retval Others The requested operation could not be completed. + The MNP multicast group settings are unchanged. + +**/ +EFI_STATUS +EFIAPI +MnpGroups ( + IN EFI_MANAGED_NETWORK_PROTOCOL *This, + IN BOOLEAN JoinFlag, + IN EFI_MAC_ADDRESS *MacAddress OPTIONAL + ) +{ + MNP_INSTANCE_DATA *Instance; + EFI_SIMPLE_NETWORK_MODE *SnpMode; + MNP_GROUP_CONTROL_BLOCK *GroupCtrlBlk; + MNP_GROUP_ADDRESS *GroupAddress; + LIST_ENTRY *ListEntry; + BOOLEAN AddressExist; + EFI_TPL OldTpl; + EFI_STATUS Status; + + if (This == NULL || (JoinFlag && (MacAddress == NULL))) { + // + // This is NULL, or it's a join operation but MacAddress is NULL. + // + return EFI_INVALID_PARAMETER; + } + + Instance = MNP_INSTANCE_DATA_FROM_THIS (This); + SnpMode = Instance->MnpServiceData->MnpDeviceData->Snp->Mode; + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + if (!Instance->Configured) { + Status = EFI_NOT_STARTED; + goto ON_EXIT; + } + + if ((!Instance->ConfigData.EnableMulticastReceive) || + ((MacAddress != NULL) && !NET_MAC_IS_MULTICAST (MacAddress, &SnpMode->BroadcastAddress, SnpMode->HwAddressSize))) { + // + // The instance isn't configured to do mulitcast receive. OR + // the passed in MacAddress is not a mutlticast mac address. + // + Status = EFI_INVALID_PARAMETER; + goto ON_EXIT; + } + + Status = EFI_SUCCESS; + AddressExist = FALSE; + GroupCtrlBlk = NULL; + + if (MacAddress != NULL) { + // + // Search the instance's GroupCtrlBlkList to find the specific address. + // + NET_LIST_FOR_EACH (ListEntry, &Instance->GroupCtrlBlkList) { + + GroupCtrlBlk = NET_LIST_USER_STRUCT ( + ListEntry, + MNP_GROUP_CONTROL_BLOCK, + CtrlBlkEntry + ); + GroupAddress = GroupCtrlBlk->GroupAddress; + if (0 == CompareMem ( + MacAddress, + &GroupAddress->Address, + SnpMode->HwAddressSize + )) { + // + // There is already the same multicast mac address configured. + // + AddressExist = TRUE; + break; + } + } + + if (JoinFlag && AddressExist) { + // + // The multicast mac address to join already exists. + // + Status = EFI_ALREADY_STARTED; + } + + if (!JoinFlag && !AddressExist) { + // + // The multicast mac address to leave doesn't exist in this instance. + // + Status = EFI_NOT_FOUND; + } + + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } + } else if (IsListEmpty (&Instance->GroupCtrlBlkList)) { + // + // The MacAddress is NULL and there is no configured multicast mac address, + // just return. + // + goto ON_EXIT; + } + + // + // OK, it is time to take action. + // + Status = MnpGroupOp (Instance, JoinFlag, MacAddress, GroupCtrlBlk); + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + + return Status; +} + +/** + Places asynchronous outgoing data packets into the transmit queue. + + The Transmit() function places a completion token into the transmit packet + queue. This function is always asynchronous. + The caller must fill in the Token.Event and Token.TxData fields in the + completion token, and these fields cannot be NULL. When the transmit operation + completes, the MNP updates the Token.Status field and the Token.Event is + signaled. + Note: There may be a performance penalty if the packet needs to be + defragmented before it can be transmitted by the network device. Systems in + which performance is critical should review the requirements and features of + the underlying communications device and drivers. + + + @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. + @param[in] Token Pointer to a token associated with the transmit data + descriptor. Type EFI_MANAGED_NETWORK_COMPLETION_TOKEN + is defined in "Related Definitions" below. + + @retval EFI_SUCCESS The transmit completion token was cached. + @retval EFI_NOT_STARTED This MNP child driver instance has not been + configured. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is + TRUE: + * This is NULL. + * Token is NULL. + * Token.Event is NULL. + * Token.TxData is NULL. + * Token.TxData.DestinationAddress is not + NULL and Token.TxData.HeaderLength is zero. + * Token.TxData.FragmentCount is zero. + * (Token.TxData.HeaderLength + + Token.TxData.DataLength) is not equal to the + sum of the + Token.TxData.FragmentTable[].FragmentLength + fields. + * One or more of the + Token.TxData.FragmentTable[].FragmentLength + fields is zero. + * One or more of the + Token.TxData.FragmentTable[].FragmentBufferfields + is NULL. + * Token.TxData.DataLength is greater than MTU. + @retval EFI_ACCESS_DENIED The transmit completion token is already in the + transmit queue. + @retval EFI_OUT_OF_RESOURCES The transmit data could not be queued due to a + lack of system resources (usually memory). + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. + The MNP child driver instance has been reset to + startup defaults. + @retval EFI_NOT_READY The transmit request could not be queued because + the transmit queue is full. + +**/ +EFI_STATUS +EFIAPI +MnpTransmit ( + IN EFI_MANAGED_NETWORK_PROTOCOL *This, + IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN *Token + ) +{ + EFI_STATUS Status; + MNP_INSTANCE_DATA *Instance; + MNP_SERVICE_DATA *MnpServiceData; + UINT8 *PktBuf; + UINT32 PktLen; + EFI_TPL OldTpl; + + if ((This == NULL) || (Token == NULL)) { + return EFI_INVALID_PARAMETER; + } + + Instance = MNP_INSTANCE_DATA_FROM_THIS (This); + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + if (!Instance->Configured) { + + Status = EFI_NOT_STARTED; + goto ON_EXIT; + } + + if (!MnpIsValidTxToken (Instance, Token)) { + // + // The Token is invalid. + // + Status = EFI_INVALID_PARAMETER; + goto ON_EXIT; + } + + MnpServiceData = Instance->MnpServiceData; + NET_CHECK_SIGNATURE (MnpServiceData, MNP_SERVICE_DATA_SIGNATURE); + + // + // Build the tx packet + // + Status = MnpBuildTxPacket (MnpServiceData, Token->Packet.TxData, &PktBuf, &PktLen); + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } + + // + // OK, send the packet synchronously. + // + Status = MnpSyncSendPacket (MnpServiceData, PktBuf, PktLen, Token); + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + + return Status; +} + + +/** + Places an asynchronous receiving request into the receiving queue. + + The Receive() function places a completion token into the receive packet + queue. This function is always asynchronous. + The caller must fill in the Token.Event field in the completion token, and + this field cannot be NULL. When the receive operation completes, the MNP + updates the Token.Status and Token.RxData fields and the Token.Event is + signaled. + + @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. + @param[in] Token Pointer to a token associated with the receive + data descriptor. Type + EFI_MANAGED_NETWORK_COMPLETION_TOKEN is defined in + EFI_MANAGED_NETWORK_PROTOCOL.Transmit(). + + @retval EFI_SUCCESS The receive completion token was cached. + @retval EFI_NOT_STARTED This MNP child driver instance has not been + configured. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is + TRUE: + * This is NULL. + * Token is NULL. + * Token.Event is NULL + @retval EFI_OUT_OF_RESOURCES The transmit data could not be queued due to a + lack of system resources (usually memory). + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. + The MNP child driver instance has been reset to + startup defaults. + @retval EFI_ACCESS_DENIED The receive completion token was already in the + receive queue. + @retval EFI_NOT_READY The receive request could not be queued because + the receive queue is full. + +**/ +EFI_STATUS +EFIAPI +MnpReceive ( + IN EFI_MANAGED_NETWORK_PROTOCOL *This, + IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN *Token + ) +{ + EFI_STATUS Status; + MNP_INSTANCE_DATA *Instance; + EFI_TPL OldTpl; + + if ((This == NULL) || (Token == NULL) || (Token->Event == NULL)) { + return EFI_INVALID_PARAMETER; + } + + Instance = MNP_INSTANCE_DATA_FROM_THIS (This); + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + if (!Instance->Configured) { + Status = EFI_NOT_STARTED; + goto ON_EXIT; + } + + // + // Check whether this token(event) is already in the rx token queue. + // + Status = NetMapIterate (&Instance->RxTokenMap, MnpTokenExist, (VOID *) Token); + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } + + // + // Insert the Token into the RxTokenMap. + // + Status = NetMapInsertTail (&Instance->RxTokenMap, (VOID *) Token, NULL); + if (!EFI_ERROR (Status)) { + // + // Try to deliver any buffered packets. + // + Status = MnpInstanceDeliverPacket (Instance); + + // + // Dispatch the DPC queued by the NotifyFunction of Token->Event. + // + DispatchDpc (); + } + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + + return Status; +} + +/** + Aborts an asynchronous transmit or receive request. + + The Cancel() function is used to abort a pending transmit or receive request. + If the token is in the transmit or receive request queues, after calling this + function, Token.Status will be set to EFI_ABORTED and then Token.Event will be + signaled. If the token is not in one of the queues, which usually means that + the asynchronous operation has completed, this function will not signal the + token and EFI_NOT_FOUND is returned. + + @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. + @param[in] Token Pointer to a token that has been issued by + EFI_MANAGED_NETWORK_PROTOCOL.Transmit() or + EFI_MANAGED_NETWORK_PROTOCOL.Receive(). If NULL, all + pending tokens are aborted. + + @retval EFI_SUCCESS The asynchronous I/O request was aborted and + Token.Event was signaled. When Token is NULL, + all pending requests were aborted and their + events were signaled. + @retval EFI_NOT_STARTED This MNP child driver instance has not been + configured. + @retval EFI_INVALID_PARAMETER This is NULL. + @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O + request was not found in the transmit or + receive queue. It has either completed or was + not issued by Transmit() and Receive(). + +**/ +EFI_STATUS +EFIAPI +MnpCancel ( + IN EFI_MANAGED_NETWORK_PROTOCOL *This, + IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN *Token OPTIONAL + ) +{ + EFI_STATUS Status; + MNP_INSTANCE_DATA *Instance; + EFI_TPL OldTpl; + + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + Instance = MNP_INSTANCE_DATA_FROM_THIS (This); + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + if (!Instance->Configured) { + Status = EFI_NOT_STARTED; + goto ON_EXIT; + } + + // + // Iterate the RxTokenMap to cancel the specified Token. + // + Status = NetMapIterate (&Instance->RxTokenMap, MnpCancelTokens, (VOID *) Token); + if (Token != NULL) { + Status = (Status == EFI_ABORTED) ? EFI_SUCCESS : EFI_NOT_FOUND; + } + + // + // Dispatch the DPC queued by the NotifyFunction of the cancled token's events. + // + DispatchDpc (); + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + + return Status; +} + +/** + Polls for incoming data packets and processes outgoing data packets. + + The Poll() function can be used by network drivers and applications to + increase the rate that data packets are moved between the communications + device and the transmit and receive queues. + Normally, a periodic timer event internally calls the Poll() function. But, in + some systems, the periodic timer event may not call Poll() fast enough to + transmit and/or receive all data packets without missing packets. Drivers and + applications that are experiencing packet loss should try calling the Poll() + function more often. + + @param[in] This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance. + + @retval EFI_SUCCESS Incoming or outgoing data was processed. + @retval EFI_NOT_STARTED This MNP child driver instance has not been + configured. + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The + MNP child driver instance has been reset to startup + defaults. + @retval EFI_NOT_READY No incoming or outgoing data was processed. Consider + increasing the polling rate. + @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive + queue. Consider increasing the polling rate. + +**/ +EFI_STATUS +EFIAPI +MnpPoll ( + IN EFI_MANAGED_NETWORK_PROTOCOL *This + ) +{ + EFI_STATUS Status; + MNP_INSTANCE_DATA *Instance; + EFI_TPL OldTpl; + + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + Instance = MNP_INSTANCE_DATA_FROM_THIS (This); + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + if (!Instance->Configured) { + Status = EFI_NOT_STARTED; + goto ON_EXIT; + } + + // + // Try to receive packets. + // + Status = MnpReceivePacket (Instance->MnpServiceData->MnpDeviceData); + + // + // Dispatch the DPC queued by the NotifyFunction of rx token's events. + // + DispatchDpc (); + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + + return Status; +} diff --git a/NetworkPkg/MnpDxe/MnpVlan.c b/NetworkPkg/MnpDxe/MnpVlan.c new file mode 100644 index 0000000000..54fb189502 --- /dev/null +++ b/NetworkPkg/MnpDxe/MnpVlan.c @@ -0,0 +1,732 @@ +/** @file + VLAN Config Protocol implementation and VLAN packet process routine. + +Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "MnpImpl.h" +#include "MnpVlan.h" + +VLAN_DEVICE_PATH mVlanDevicePathTemplate = { + { + MESSAGING_DEVICE_PATH, + MSG_VLAN_DP, + { + (UINT8) (sizeof (VLAN_DEVICE_PATH)), + (UINT8) ((sizeof (VLAN_DEVICE_PATH)) >> 8) + } + }, + 0 +}; + +EFI_VLAN_CONFIG_PROTOCOL mVlanConfigProtocolTemplate = { + VlanConfigSet, + VlanConfigFind, + VlanConfigRemove +}; + + +/** + Create a child handle for the VLAN ID. + + @param[in] ImageHandle The driver image handle. + @param[in] ControllerHandle Handle of device to bind driver to. + @param[in] VlanId The VLAN ID. + @param[out] Devicepath Pointer to returned device path for child handle. + + @return The handle of VLAN child or NULL if failed to create VLAN child. + +**/ +EFI_HANDLE +MnpCreateVlanChild ( + IN EFI_HANDLE ImageHandle, + IN EFI_HANDLE ControllerHandle, + IN UINT16 VlanId, + OUT EFI_DEVICE_PATH_PROTOCOL **Devicepath OPTIONAL + ) +{ + EFI_HANDLE ChildHandle; + VLAN_DEVICE_PATH VlanNode; + EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath; + EFI_DEVICE_PATH_PROTOCOL *VlanDevicePath; + EFI_STATUS Status; + + // + // Try to get parent device path + // + Status = gBS->OpenProtocol ( + ControllerHandle, + &gEfiDevicePathProtocolGuid, + (VOID **) &ParentDevicePath, + ImageHandle, + ControllerHandle, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + if (EFI_ERROR (Status)) { + return NULL; + } + + // + // Construct device path for child handle: MAC + VLAN + // + CopyMem (&VlanNode, &mVlanDevicePathTemplate, sizeof (VLAN_DEVICE_PATH)); + VlanNode.VlanId = VlanId; + VlanDevicePath = AppendDevicePathNode ( + ParentDevicePath, + (EFI_DEVICE_PATH_PROTOCOL *) &VlanNode + ); + if (VlanDevicePath == NULL) { + return NULL; + } + + // + // Create child VLAN handle by installing DevicePath protocol + // + ChildHandle = NULL; + Status = gBS->InstallMultipleProtocolInterfaces ( + &ChildHandle, + &gEfiDevicePathProtocolGuid, + VlanDevicePath, + NULL + ); + if (EFI_ERROR (Status)) { + FreePool (VlanDevicePath); + return NULL; + } + + if (Devicepath != NULL) { + *Devicepath = VlanDevicePath; + } + + return ChildHandle; +} + +/** + Remove VLAN tag from a packet. + + @param[in, out] MnpDeviceData Pointer to the mnp device context data. + @param[in, out] Nbuf Pointer to the NET_BUF to remove VLAN tag. + @param[out] VlanId Pointer to the returned VLAN ID. + + @retval TRUE VLAN tag is removed from this packet. + @retval FALSE There is no VLAN tag in this packet. + +**/ +BOOLEAN +MnpRemoveVlanTag ( + IN OUT MNP_DEVICE_DATA *MnpDeviceData, + IN OUT NET_BUF *Nbuf, + OUT UINT16 *VlanId + ) +{ + UINT8 *Packet; + UINTN ProtocolOffset; + UINT16 ProtocolType; + VLAN_TCI VlanTag; + + ProtocolOffset = MnpDeviceData->Snp->Mode->HwAddressSize * 2; + + // + // Get the packet buffer. + // + Packet = NetbufGetByte (Nbuf, 0, NULL); + ASSERT (Packet != NULL); + + // + // Check whether this is VLAN tagged frame by Ether Type + // + *VlanId = 0; + ProtocolType = NTOHS (*(UINT16 *) (Packet + ProtocolOffset)); + if (ProtocolType != ETHER_TYPE_VLAN) { + // + // Not a VLAN tagged frame + // + return FALSE; + } + + VlanTag.Uint16 = NTOHS (*(UINT16 *) (Packet + ProtocolOffset + sizeof (ProtocolType))); + *VlanId = VlanTag.Bits.Vid; + + // + // Move hardware address (DA + SA) 4 bytes right to override VLAN tag + // + CopyMem (Packet + NET_VLAN_TAG_LEN, Packet, ProtocolOffset); + + // + // Remove VLAN tag from the Nbuf + // + NetbufTrim (Nbuf, NET_VLAN_TAG_LEN, NET_BUF_HEAD); + + return TRUE; +} + + +/** + Build the vlan packet to transmit from the TxData passed in. + + @param MnpServiceData Pointer to the mnp service context data. + @param TxData Pointer to the transmit data containing the + information to build the packet. + @param ProtocolType Pointer to the Ethernet protocol type. + @param Packet Pointer to record the address of the packet. + @param Length Pointer to a UINT32 variable used to record the + packet's length. + +**/ +VOID +MnpInsertVlanTag ( + IN MNP_SERVICE_DATA *MnpServiceData, + IN EFI_MANAGED_NETWORK_TRANSMIT_DATA *TxData, + OUT UINT16 *ProtocolType, + IN OUT UINT8 **Packet, + IN OUT UINT32 *Length + ) +{ + VLAN_TCI *VlanTci; + UINT16 *Tpid; + UINT16 *EtherType; + MNP_DEVICE_DATA *MnpDeviceData; + EFI_SIMPLE_NETWORK_MODE *SnpMode; + + MnpDeviceData = MnpServiceData->MnpDeviceData; + SnpMode = MnpDeviceData->Snp->Mode; + + *ProtocolType = ETHER_TYPE_VLAN; + *Length = *Length + NET_VLAN_TAG_LEN; + *Packet = *Packet - NET_VLAN_TAG_LEN; + + Tpid = (UINT16 *) (*Packet + SnpMode->MediaHeaderSize - sizeof (*ProtocolType)); + VlanTci = (VLAN_TCI *) (UINTN) (Tpid + 1); + if (TxData->HeaderLength != 0) { + // + // Media header is in packet, move DA+SA 4 bytes left + // + CopyMem ( + *Packet, + *Packet + NET_VLAN_TAG_LEN, + SnpMode->MediaHeaderSize - sizeof (*ProtocolType) + ); + *Tpid = HTONS (ETHER_TYPE_VLAN); + } else { + // + // Media header not in packet, VLAN TCI and original protocol type becomes payload + // + EtherType = (UINT16 *) (UINTN) (VlanTci + 1); + *EtherType = HTONS (TxData->ProtocolType); + } + + VlanTci->Bits.Vid = MnpServiceData->VlanId; + VlanTci->Bits.Cfi = VLAN_TCI_CFI_CANONICAL_MAC; + VlanTci->Bits.Priority = MnpServiceData->Priority; + VlanTci->Uint16 = HTONS (VlanTci->Uint16); +} + +/** + Check VLAN configuration variable and delete the duplicative content if has identical Vlan ID. + + @param[in] MnpDeviceData Pointer to the MNP device context data. + @param[in] Buffer Pointer to the buffer contains the array of VLAN_TCI. + @param[in] NumberOfVlan Pointer to number of VLAN. + @param[out] NewNumberOfVlan Pointer to number of unique VLAN. + + @retval EFI_SUCCESS The VLAN variable is successfully checked. + @retval EFI_OUT_OF_RESOURCES There is not enough resource to set the configuration. + +**/ +EFI_STATUS +MnpCheckVlanVariable ( + IN MNP_DEVICE_DATA *MnpDeviceData, + IN VLAN_TCI *Buffer, + IN UINTN NumberOfVlan, + OUT UINTN *NewNumberOfVlan + ) +{ + UINTN Index; + UINTN Index2; + UINTN Count; + BOOLEAN FoundDuplicateItem; + EFI_STATUS Status; + + Count = 0; + FoundDuplicateItem = FALSE; + Status = EFI_SUCCESS; + + for (Index = 0; Index < NumberOfVlan; Index++) { + for (Index2 = Index + 1; Index2 < NumberOfVlan; Index2++) { + if (Buffer[Index].Bits.Vid == Buffer[Index2].Bits.Vid) { + FoundDuplicateItem = TRUE; + Count++; + break; + } + } + if (FoundDuplicateItem) { + for (Index2 = Index +1; Index2 < NumberOfVlan; Index++, Index2++) { + CopyMem (Buffer + Index, Buffer + Index2, sizeof (VLAN_TCI)); + } + } + FoundDuplicateItem = FALSE; + } + + *NewNumberOfVlan = NumberOfVlan - Count; + if (Count != 0) { + Status = MnpSetVlanVariable (MnpDeviceData, *NewNumberOfVlan, Buffer); + } + + return Status; +} + +/** + Get VLAN configuration variable. + + @param[in] MnpDeviceData Pointer to the MNP device context data. + @param[out] NumberOfVlan Pointer to number of VLAN to be returned. + @param[out] VlanVariable Pointer to the buffer to return requested + array of VLAN_TCI. + + @retval EFI_SUCCESS The array of VLAN_TCI was returned in VlanVariable + and number of VLAN was returned in NumberOfVlan. + @retval EFI_NOT_FOUND VLAN configuration variable not found. + @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the configuration. + +**/ +EFI_STATUS +MnpGetVlanVariable ( + IN MNP_DEVICE_DATA *MnpDeviceData, + OUT UINTN *NumberOfVlan, + OUT VLAN_TCI **VlanVariable + ) +{ + UINTN BufferSize; + EFI_STATUS Status; + VLAN_TCI *Buffer; + UINTN NewNumberOfVlan; + + // + // Get VLAN configuration from EFI Variable + // + Buffer = NULL; + BufferSize = 0; + Status = gRT->GetVariable ( + MnpDeviceData->MacString, + &gEfiVlanConfigProtocolGuid, + NULL, + &BufferSize, + NULL + ); + if (Status != EFI_BUFFER_TOO_SMALL) { + return EFI_NOT_FOUND; + } + + // + // Allocate buffer to read the variable + // + Buffer = AllocateZeroPool (BufferSize); + if (Buffer == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + Status = gRT->GetVariable ( + MnpDeviceData->MacString, + &gEfiVlanConfigProtocolGuid, + NULL, + &BufferSize, + Buffer + ); + if (EFI_ERROR (Status)) { + FreePool (Buffer); + return Status; + } + + Status = MnpCheckVlanVariable (MnpDeviceData, Buffer, BufferSize / sizeof (VLAN_TCI), &NewNumberOfVlan); + if (!EFI_ERROR (Status)) { + *NumberOfVlan = NewNumberOfVlan; + *VlanVariable = Buffer; + } + + return Status; +} + +/** + Set VLAN configuration variable. + + @param[in] MnpDeviceData Pointer to the MNP device context data. + @param[in] NumberOfVlan Number of VLAN in array VlanVariable. + @param[in] VlanVariable Pointer to array of VLAN_TCI. + + @retval EFI_SUCCESS The VLAN variable is successfully set. + @retval EFI_OUT_OF_RESOURCES There is not enough resource to set the configuration. + +**/ +EFI_STATUS +MnpSetVlanVariable ( + IN MNP_DEVICE_DATA *MnpDeviceData, + IN UINTN NumberOfVlan, + IN VLAN_TCI *VlanVariable + ) +{ + return gRT->SetVariable ( + MnpDeviceData->MacString, + &gEfiVlanConfigProtocolGuid, + EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS, + NumberOfVlan * sizeof (VLAN_TCI), + VlanVariable + ); +} + + +/** + Create a VLAN device or modify the configuration parameter of an + already-configured VLAN. + + The Set() function is used to create a new VLAN device or change the VLAN + configuration parameters. If the VlanId hasn't been configured in the + physical Ethernet device, a new VLAN device will be created. If a VLAN with + this VlanId is already configured, then related configuration will be updated + as the input parameters. + + If VlanId is zero, the VLAN device will send and receive untagged frames. + Otherwise, the VLAN device will send and receive VLAN-tagged frames containing the VlanId. + If VlanId is out of scope of (0-4094), EFI_INVALID_PARAMETER is returned. + If Priority is out of the scope of (0-7), then EFI_INVALID_PARAMETER is returned. + If there is not enough system memory to perform the registration, then + EFI_OUT_OF_RESOURCES is returned. + + @param[in] This Points to the EFI_VLAN_CONFIG_PROTOCOL. + @param[in] VlanId A unique identifier (1-4094) of the VLAN which is being created + or modified, or zero (0). + @param[in] Priority 3 bit priority in VLAN header. Priority 0 is default value. If + VlanId is zero (0), Priority is ignored. + + @retval EFI_SUCCESS The VLAN is successfully configured. + @retval EFI_INVALID_PARAMETER One or more of following conditions is TRUE: + - This is NULL. + - VlanId is an invalid VLAN Identifier. + - Priority is invalid. + @retval EFI_OUT_OF_RESOURCES There is not enough system memory to perform the registration. + +**/ +EFI_STATUS +EFIAPI +VlanConfigSet ( + IN EFI_VLAN_CONFIG_PROTOCOL *This, + IN UINT16 VlanId, + IN UINT8 Priority + ) +{ + EFI_STATUS Status; + MNP_DEVICE_DATA *MnpDeviceData; + MNP_SERVICE_DATA *MnpServiceData; + VLAN_TCI *OldVariable; + VLAN_TCI *NewVariable; + UINTN NumberOfVlan; + UINTN Index; + BOOLEAN IsAdd; + LIST_ENTRY *Entry; + + if ((This == NULL) || (VlanId > 4094) || (Priority > 7)) { + return EFI_INVALID_PARAMETER; + } + + IsAdd = FALSE; + MnpDeviceData = MNP_DEVICE_DATA_FROM_THIS (This); + if (MnpDeviceData->NumberOfVlan == 0) { + // + // No existing VLAN, this is the first VLAN to add + // + IsAdd = TRUE; + Entry = GetFirstNode (&MnpDeviceData->ServiceList); + MnpServiceData = MNP_SERVICE_DATA_FROM_LINK (Entry); + + if (VlanId != 0) { + // + // VlanId is not 0, need destroy the default MNP service data + // + Status = MnpDestroyServiceChild (MnpServiceData); + if (EFI_ERROR (Status)) { + return Status; + } + + Status = MnpDestroyServiceData (MnpServiceData); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Create a new MNP service data for this VLAN + // + MnpServiceData = MnpCreateServiceData (MnpDeviceData, VlanId, Priority); + if (MnpServiceData == NULL) { + return EFI_OUT_OF_RESOURCES; + } + } + } else { + // + // Try to find VlanId in existing VLAN list + // + MnpServiceData = MnpFindServiceData (MnpDeviceData, VlanId); + if (MnpServiceData == NULL) { + // + // VlanId not found, create a new MNP service data + // + IsAdd = TRUE; + MnpServiceData = MnpCreateServiceData (MnpDeviceData, VlanId, Priority); + if (MnpServiceData == NULL) { + return EFI_OUT_OF_RESOURCES; + } + } + } + + MnpServiceData->VlanId = VlanId; + MnpServiceData->Priority = Priority; + if (IsAdd) { + MnpDeviceData->NumberOfVlan++; + } + + // + // Update VLAN configuration variable + // + OldVariable = NULL; + NewVariable = NULL; + NumberOfVlan = 0; + MnpGetVlanVariable (MnpDeviceData, &NumberOfVlan, &OldVariable); + + if (IsAdd) { + // + // VLAN not exist - add + // + NewVariable = AllocateZeroPool ((NumberOfVlan + 1) * sizeof (VLAN_TCI)); + if (NewVariable == NULL) { + Status = EFI_OUT_OF_RESOURCES; + goto Exit; + } + + if (OldVariable != NULL) { + CopyMem (NewVariable, OldVariable, NumberOfVlan * sizeof (VLAN_TCI)); + } + + Index = NumberOfVlan++; + } else { + // + // VLAN already exist - update + // + for (Index = 0; Index < NumberOfVlan; Index++) { + if (OldVariable[Index].Bits.Vid == VlanId) { + break; + } + } + ASSERT (Index < NumberOfVlan); + + NewVariable = OldVariable; + OldVariable = NULL; + } + + NewVariable[Index].Bits.Vid = VlanId; + NewVariable[Index].Bits.Priority = Priority; + + Status = MnpSetVlanVariable (MnpDeviceData, NumberOfVlan, NewVariable); + FreePool (NewVariable); + +Exit: + if (OldVariable != NULL) { + FreePool (OldVariable); + } + + return Status; +} + + +/** + Find configuration information for specified VLAN or all configured VLANs. + + The Find() function is used to find the configuration information for matching + VLAN and allocate a buffer into which those entries are copied. + + @param[in] This Points to the EFI_VLAN_CONFIG_PROTOCOL. + @param[in] VlanId Pointer to VLAN identifier. Set to NULL to find all + configured VLANs. + @param[out] NumberOfVlan The number of VLANs which is found by the specified criteria. + @param[out] Entries The buffer which receive the VLAN configuration. + + @retval EFI_SUCCESS The VLAN is successfully found. + @retval EFI_INVALID_PARAMETER One or more of following conditions is TRUE: + - This is NULL. + - Specified VlanId is invalid. + @retval EFI_NOT_FOUND No matching VLAN is found. + +**/ +EFI_STATUS +EFIAPI +VlanConfigFind ( + IN EFI_VLAN_CONFIG_PROTOCOL *This, + IN UINT16 *VlanId OPTIONAL, + OUT UINT16 *NumberOfVlan, + OUT EFI_VLAN_FIND_DATA **Entries + ) +{ + MNP_DEVICE_DATA *MnpDeviceData; + MNP_SERVICE_DATA *MnpServiceData; + LIST_ENTRY *Entry; + EFI_VLAN_FIND_DATA *VlanData; + + if ((This == NULL) || (VlanId != NULL && *VlanId > 4094) || (NumberOfVlan == NULL) || (Entries == NULL)) { + return EFI_INVALID_PARAMETER; + } + + *NumberOfVlan = 0; + *Entries = NULL; + + MnpDeviceData = MNP_DEVICE_DATA_FROM_THIS (This); + if (MnpDeviceData->NumberOfVlan == 0) { + return EFI_NOT_FOUND; + } + + if (VlanId == NULL) { + // + // Return all current VLAN configuration + // + *NumberOfVlan = (UINT16) MnpDeviceData->NumberOfVlan; + VlanData = AllocateZeroPool (*NumberOfVlan * sizeof (EFI_VLAN_FIND_DATA)); + if (VlanData == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + *Entries = VlanData; + NET_LIST_FOR_EACH (Entry, &MnpDeviceData->ServiceList) { + MnpServiceData = MNP_SERVICE_DATA_FROM_LINK (Entry); + + VlanData->VlanId = MnpServiceData->VlanId; + VlanData->Priority = MnpServiceData->Priority; + VlanData++; + } + + return EFI_SUCCESS; + } + + // + // VlanId is specified, try to find it in current VLAN list + // + MnpServiceData = MnpFindServiceData (MnpDeviceData, *VlanId); + if (MnpServiceData == NULL) { + return EFI_NOT_FOUND; + } + + VlanData = AllocateZeroPool (sizeof (EFI_VLAN_FIND_DATA)); + if (VlanData == NULL) { + return EFI_OUT_OF_RESOURCES; + } + VlanData->VlanId = MnpServiceData->VlanId; + VlanData->Priority = MnpServiceData->Priority; + + *NumberOfVlan = 1; + *Entries = VlanData; + + return EFI_SUCCESS; +} + + +/** + Remove the configured VLAN device. + + The Remove() function is used to remove the specified VLAN device. + If the VlanId is out of the scope of (0-4094), EFI_INVALID_PARAMETER is returned. + If specified VLAN hasn't been previously configured, EFI_NOT_FOUND is returned. + + @param[in] This Points to the EFI_VLAN_CONFIG_PROTOCOL. + @param[in] VlanId Identifier (0-4094) of the VLAN to be removed. + + @retval EFI_SUCCESS The VLAN is successfully removed. + @retval EFI_INVALID_PARAMETER One or more of following conditions is TRUE: + - This is NULL. + - VlanId is an invalid parameter. + @retval EFI_NOT_FOUND The to-be-removed VLAN does not exist. + +**/ +EFI_STATUS +EFIAPI +VlanConfigRemove ( + IN EFI_VLAN_CONFIG_PROTOCOL *This, + IN UINT16 VlanId + ) +{ + EFI_STATUS Status; + MNP_DEVICE_DATA *MnpDeviceData; + MNP_SERVICE_DATA *MnpServiceData; + LIST_ENTRY *Entry; + VLAN_TCI *VlanVariable; + VLAN_TCI *VlanData; + + if ((This == NULL) || (VlanId > 4094)) { + return EFI_INVALID_PARAMETER; + } + + MnpDeviceData = MNP_DEVICE_DATA_FROM_THIS (This); + if (MnpDeviceData->NumberOfVlan == 0) { + return EFI_NOT_FOUND; + } + + // + // Try to find the VlanId + // + MnpServiceData = MnpFindServiceData (MnpDeviceData, VlanId); + if (MnpServiceData == NULL) { + return EFI_NOT_FOUND; + } + + MnpDeviceData->NumberOfVlan--; + + if ((VlanId != 0) || (MnpDeviceData->NumberOfVlan != 0)) { + // + // If VlanId is not 0 or VlanId is 0 and it is not the last VLAN to remove, + // destroy its MNP service data + // + Status = MnpDestroyServiceChild (MnpServiceData); + if (EFI_ERROR (Status)) { + return Status; + } + + Status = MnpDestroyServiceData (MnpServiceData); + if (EFI_ERROR (Status)) { + return Status; + } + } + + if ((VlanId != 0) && (MnpDeviceData->NumberOfVlan == 0)) { + // + // This is the last VLAN to be removed, restore the default MNP service data + // + MnpServiceData = MnpCreateServiceData (MnpDeviceData, 0, 0); + if (MnpServiceData == NULL) { + return EFI_OUT_OF_RESOURCES; + } + } + + // + // Update VLAN configuration variable + // + VlanVariable = NULL; + if (MnpDeviceData->NumberOfVlan != 0) { + VlanVariable = AllocatePool (MnpDeviceData->NumberOfVlan * sizeof (VLAN_TCI)); + if (VlanVariable == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + VlanData = VlanVariable; + NET_LIST_FOR_EACH (Entry, &MnpDeviceData->ServiceList) { + MnpServiceData = MNP_SERVICE_DATA_FROM_LINK (Entry); + + VlanData->Bits.Vid = MnpServiceData->VlanId; + VlanData->Bits.Priority = MnpServiceData->Priority; + VlanData++; + } + } + + Status = MnpSetVlanVariable (MnpDeviceData, MnpDeviceData->NumberOfVlan, VlanVariable); + + if (VlanVariable != NULL) { + FreePool (VlanVariable); + } + + return Status; +} diff --git a/NetworkPkg/MnpDxe/MnpVlan.h b/NetworkPkg/MnpDxe/MnpVlan.h new file mode 100644 index 0000000000..4e0ddef2df --- /dev/null +++ b/NetworkPkg/MnpDxe/MnpVlan.h @@ -0,0 +1,205 @@ +/** @file + Header file to be included by MnpVlan.c. + +Copyright (c) 2009 - 2013, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef __MNP_VLAN_H__ +#define __MNP_VLAN_H__ + +#include "MnpDriver.h" + +extern EFI_VLAN_CONFIG_PROTOCOL mVlanConfigProtocolTemplate; + + +/** + Create a child handle for the VLAN ID. + + @param[in] ImageHandle The driver image handle. + @param[in] ControllerHandle Handle of device to bind driver to. + @param[in] VlanId The VLAN ID. + @param[out] Devicepath Pointer to returned device path for child handle. + + @return The handle of VLAN child or NULL if failed to create VLAN child. + +**/ +EFI_HANDLE +MnpCreateVlanChild ( + IN EFI_HANDLE ImageHandle, + IN EFI_HANDLE ControllerHandle, + IN UINT16 VlanId, + OUT EFI_DEVICE_PATH_PROTOCOL **Devicepath OPTIONAL + ); + +/** + Remove VLAN tag of a packet. + + @param[in, out] MnpDeviceData Pointer to the mnp device context data. + @param[in, out] Nbuf Pointer to the NET_BUF to remove VLAN tag. + @param[out] VlanId Pointer to the returned VLAN ID. + + @retval TRUE VLAN tag is removed from this packet. + @retval FALSE There is no VLAN tag in this packet. + +**/ +BOOLEAN +MnpRemoveVlanTag ( + IN OUT MNP_DEVICE_DATA *MnpDeviceData, + IN OUT NET_BUF *Nbuf, + OUT UINT16 *VlanId + ); + +/** + Build the vlan packet to transmit from the TxData passed in. + + @param MnpServiceData Pointer to the mnp service context data. + @param TxData Pointer to the transmit data containing the + information to build the packet. + @param ProtocolType Pointer to the Ethernet protocol type. + @param Packet Pointer to record the address of the packet. + @param Length Pointer to a UINT32 variable used to record the + packet's length. + +**/ +VOID +MnpInsertVlanTag ( + IN MNP_SERVICE_DATA *MnpServiceData, + IN EFI_MANAGED_NETWORK_TRANSMIT_DATA *TxData, + OUT UINT16 *ProtocolType, + IN OUT UINT8 **Packet, + IN OUT UINT32 *Length + ); + +/** + Get VLAN configuration variable. + + @param[in] MnpDeviceData Pointer to the MNP device context data. + @param[out] NumberOfVlan Pointer to number of VLAN to be returned. + @param[out] VlanVariable Pointer to the buffer to return requested + array of VLAN_TCI. + + @retval EFI_SUCCESS The array of VLAN_TCI was returned in VlanVariable + and number of VLAN was returned in NumberOfVlan. + @retval EFI_NOT_FOUND VLAN configuration variable not found. + @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the configuration. + +**/ +EFI_STATUS +MnpGetVlanVariable ( + IN MNP_DEVICE_DATA *MnpDeviceData, + OUT UINTN *NumberOfVlan, + OUT VLAN_TCI **VlanVariable + ); + +/** + Set VLAN configuration variable. + + @param[in] MnpDeviceData Pointer to the MNP device context data. + @param[in] NumberOfVlan Number of VLAN in array VlanVariable. + @param[in] VlanVariable Pointer to array of VLAN_TCI. + + @retval EFI_SUCCESS The VLAN variable is successfully set. + @retval EFI_OUT_OF_RESOURCES There is not enough resource to set the configuration. + +**/ +EFI_STATUS +MnpSetVlanVariable ( + IN MNP_DEVICE_DATA *MnpDeviceData, + IN UINTN NumberOfVlan, + IN VLAN_TCI *VlanVariable + ); + +/** + Create a VLAN device or modify the configuration parameter of an + already-configured VLAN. + + The Set() function is used to create a new VLAN device or change the VLAN + configuration parameters. If the VlanId hasn't been configured in the + physical Ethernet device, a new VLAN device will be created. If a VLAN with + this VlanId is already configured, then related configuration will be updated + as the input parameters. + + If VlanId is zero, the VLAN device will send and receive untagged frames. + Otherwise, the VLAN device will send and receive VLAN-tagged frames containing the VlanId. + If VlanId is out of scope of (0-4094), EFI_INVALID_PARAMETER is returned. + If Priority is out of the scope of (0-7), then EFI_INVALID_PARAMETER is returned. + If there is not enough system memory to perform the registration, then + EFI_OUT_OF_RESOURCES is returned. + + @param[in] This Points to the EFI_VLAN_CONFIG_PROTOCOL. + @param[in] VlanId A unique identifier (1-4094) of the VLAN which is being created + or modified, or zero (0). + @param[in] Priority 3 bit priority in VLAN header. Priority 0 is default value. If + VlanId is zero (0), Priority is ignored. + + @retval EFI_SUCCESS The VLAN is successfully configured. + @retval EFI_INVALID_PARAMETER One or more of following conditions is TRUE: + - This is NULL. + - VlanId is an invalid VLAN Identifier. + - Priority is invalid. + @retval EFI_OUT_OF_RESOURCES There is not enough system memory to perform the registration. + +**/ +EFI_STATUS +EFIAPI +VlanConfigSet ( + IN EFI_VLAN_CONFIG_PROTOCOL *This, + IN UINT16 VlanId, + IN UINT8 Priority + ); + +/** + Find configuration information for specified VLAN or all configured VLANs. + + The Find() function is used to find the configuration information for matching + VLAN and allocate a buffer into which those entries are copied. + + @param[in] This Points to the EFI_VLAN_CONFIG_PROTOCOL. + @param[in] VlanId Pointer to VLAN identifier. Set to NULL to find all + configured VLANs. + @param[out] NumberOfVlan The number of VLANs which is found by the specified criteria. + @param[out] Entries The buffer which receive the VLAN configuration. + + @retval EFI_SUCCESS The VLAN is successfully found. + @retval EFI_INVALID_PARAMETER One or more of following conditions is TRUE: + - This is NULL. + - Specified VlanId is invalid. + @retval EFI_NOT_FOUND No matching VLAN is found. + +**/ +EFI_STATUS +EFIAPI +VlanConfigFind ( + IN EFI_VLAN_CONFIG_PROTOCOL *This, + IN UINT16 *VlanId OPTIONAL, + OUT UINT16 *NumberOfVlan, + OUT EFI_VLAN_FIND_DATA **Entries + ); + +/** + Remove the configured VLAN device. + + The Remove() function is used to remove the specified VLAN device. + If the VlanId is out of the scope of (0-4094), EFI_INVALID_PARAMETER is returned. + If specified VLAN hasn't been previously configured, EFI_NOT_FOUND is returned. + + @param[in] This Points to the EFI_VLAN_CONFIG_PROTOCOL. + @param[in] VlanId Identifier (0-4094) of the VLAN to be removed. + + @retval EFI_SUCCESS The VLAN is successfully removed. + @retval EFI_INVALID_PARAMETER One or more of following conditions is TRUE: + - This is NULL. + - VlanId is an invalid parameter. + @retval EFI_NOT_FOUND The to-be-removed VLAN does not exist. + +**/ +EFI_STATUS +EFIAPI +VlanConfigRemove ( + IN EFI_VLAN_CONFIG_PROTOCOL *This, + IN UINT16 VlanId + ); + +#endif diff --git a/NetworkPkg/Mtftp4Dxe/ComponentName.c b/NetworkPkg/Mtftp4Dxe/ComponentName.c new file mode 100644 index 0000000000..8b84caf113 --- /dev/null +++ b/NetworkPkg/Mtftp4Dxe/ComponentName.c @@ -0,0 +1,425 @@ +/** @file + UEFI Component Name(2) protocol implementation for Mtftp4Dxe driver. + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Mtftp4Impl.h" + +// +// EFI Component Name Functions +// +/** + Retrieves a Unicode string that is the user readable name of the driver. + + This function retrieves the user readable name of a driver in the form of a + Unicode string. If the driver specified by This has a user readable name in + the language specified by Language, then a pointer to the driver name is + returned in DriverName, and EFI_SUCCESS is returned. If the driver specified + by This does not support the language specified by Language, + then EFI_UNSUPPORTED is returned. + + @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param[in] Language A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified + in RFC 4646 or ISO 639-2 language code format. + + @param[out] DriverName A pointer to the Unicode string to return. + This Unicode string is the name of the + driver specified by This in the language + specified by Language. + + @retval EFI_SUCCESS The Unicode string for the Driver specified by + This and the language specified by Language was + returned in DriverName. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER DriverName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +Mtftp4ComponentNameGetDriverName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN CHAR8 *Language, + OUT CHAR16 **DriverName + ); + + +/** + Retrieves a Unicode string that is the user readable name of the controller + that is being managed by a driver. + + This function retrieves the user readable name of the controller specified by + ControllerHandle and ChildHandle in the form of a Unicode string. If the + driver specified by This has a user readable name in the language specified by + Language, then a pointer to the controller name is returned in ControllerName, + and EFI_SUCCESS is returned. If the driver specified by This is not currently + managing the controller specified by ControllerHandle and ChildHandle, + then EFI_UNSUPPORTED is returned. If the driver specified by This does not + support the language specified by Language, then EFI_UNSUPPORTED is returned. + + @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param[in] ControllerHandle The handle of a controller that the driver + specified by This is managing. This handle + specifies the controller whose name is to be + returned. + + @param[in] ChildHandle The handle of the child controller to retrieve + the name of. This is an optional parameter that + may be NULL. It will be NULL for device + drivers. It will also be NULL for a bus drivers + that wish to retrieve the name of the bus + controller. It will not be NULL for a bus + driver that wishes to retrieve the name of a + child controller. + + @param[in] Language A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified in + RFC 4646 or ISO 639-2 language code format. + + @param[out] ControllerName A pointer to the Unicode string to return. + This Unicode string is the name of the + controller specified by ControllerHandle and + ChildHandle in the language specified by + Language from the point of view of the driver + specified by This. + + @retval EFI_SUCCESS The Unicode string for the user readable name in + the language specified by Language for the + driver specified by This was returned in + DriverName. + + @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. + + @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid + EFI_HANDLE. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER ControllerName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This is not currently + managing the controller specified by + ControllerHandle and ChildHandle. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +Mtftp4ComponentNameGetControllerName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_HANDLE ChildHandle OPTIONAL, + IN CHAR8 *Language, + OUT CHAR16 **ControllerName + ); + + +/// +/// EFI Component Name Protocol +/// +GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gMtftp4ComponentName = { + Mtftp4ComponentNameGetDriverName, + Mtftp4ComponentNameGetControllerName, + "eng" +}; + +/// +/// EFI Component Name 2 Protocol +/// +GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gMtftp4ComponentName2 = { + (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) Mtftp4ComponentNameGetDriverName, + (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) Mtftp4ComponentNameGetControllerName, + "en" +}; + + +GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mMtftp4DriverNameTable[] = { + { + "eng;en", + L"MTFTP4 Network Service" + }, + { + NULL, + NULL + } +}; + +GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE *gMtftp4ControllerNameTable = NULL; + +/** + Retrieves a Unicode string that is the user readable name of the driver. + + This function retrieves the user readable name of a driver in the form of a + Unicode string. If the driver specified by This has a user readable name in + the language specified by Language, then a pointer to the driver name is + returned in DriverName, and EFI_SUCCESS is returned. If the driver specified + by This does not support the language specified by Language, + then EFI_UNSUPPORTED is returned. + + @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param[in] Language A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified + in RFC 4646 or ISO 639-2 language code format. + + @param[out] DriverName A pointer to the Unicode string to return. + This Unicode string is the name of the + driver specified by This in the language + specified by Language. + + @retval EFI_SUCCESS The Unicode string for the Driver specified by + This and the language specified by Language was + returned in DriverName. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER DriverName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +Mtftp4ComponentNameGetDriverName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN CHAR8 *Language, + OUT CHAR16 **DriverName + ) +{ + return LookupUnicodeString2 ( + Language, + This->SupportedLanguages, + mMtftp4DriverNameTable, + DriverName, + (BOOLEAN)(This == &gMtftp4ComponentName) + ); +} + +/** + Update the component name for the Mtftp4 child handle. + + @param Mtftp4[in] A pointer to the EFI_MTFTP4_PROTOCOL. + + + @retval EFI_SUCCESS Update the ControllerNameTable of this instance successfully. + @retval EFI_INVALID_PARAMETER The input parameter is invalid. + +**/ +EFI_STATUS +UpdateName ( + IN EFI_MTFTP4_PROTOCOL *Mtftp4 + ) +{ + EFI_STATUS Status; + CHAR16 HandleName[80]; + EFI_MTFTP4_MODE_DATA ModeData; + + if (Mtftp4 == NULL) { + return EFI_INVALID_PARAMETER; + } + + // + // Format the child name into the string buffer as: + // MTFTPv4 (ServerIp=192.168.1.10, ServerPort=69) + // + Status = Mtftp4->GetModeData (Mtftp4, &ModeData); + if (EFI_ERROR (Status)) { + return Status; + } + + UnicodeSPrint (HandleName, sizeof (HandleName), + L"MTFTPv4 (ServerIp=%d.%d.%d.%d, ServerPort=%d)", + ModeData.ConfigData.ServerIp.Addr[0], + ModeData.ConfigData.ServerIp.Addr[1], + ModeData.ConfigData.ServerIp.Addr[2], + ModeData.ConfigData.ServerIp.Addr[3], + ModeData.ConfigData.InitialServerPort + ); + + if (gMtftp4ControllerNameTable != NULL) { + FreeUnicodeStringTable (gMtftp4ControllerNameTable); + gMtftp4ControllerNameTable = NULL; + } + + Status = AddUnicodeString2 ( + "eng", + gMtftp4ComponentName.SupportedLanguages, + &gMtftp4ControllerNameTable, + HandleName, + TRUE + ); + if (EFI_ERROR (Status)) { + return Status; + } + + return AddUnicodeString2 ( + "en", + gMtftp4ComponentName2.SupportedLanguages, + &gMtftp4ControllerNameTable, + HandleName, + FALSE + ); +} + +/** + Retrieves a Unicode string that is the user readable name of the controller + that is being managed by a driver. + + This function retrieves the user readable name of the controller specified by + ControllerHandle and ChildHandle in the form of a Unicode string. If the + driver specified by This has a user readable name in the language specified by + Language, then a pointer to the controller name is returned in ControllerName, + and EFI_SUCCESS is returned. If the driver specified by This is not currently + managing the controller specified by ControllerHandle and ChildHandle, + then EFI_UNSUPPORTED is returned. If the driver specified by This does not + support the language specified by Language, then EFI_UNSUPPORTED is returned. + + @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param[in] ControllerHandle The handle of a controller that the driver + specified by This is managing. This handle + specifies the controller whose name is to be + returned. + + @param[in] ChildHandle The handle of the child controller to retrieve + the name of. This is an optional parameter that + may be NULL. It will be NULL for device + drivers. It will also be NULL for a bus drivers + that wish to retrieve the name of the bus + controller. It will not be NULL for a bus + driver that wishes to retrieve the name of a + child controller. + + @param[in] Language A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified in + RFC 4646 or ISO 639-2 language code format. + + @param[out] ControllerName A pointer to the Unicode string to return. + This Unicode string is the name of the + controller specified by ControllerHandle and + ChildHandle in the language specified by + Language from the point of view of the driver + specified by This. + + @retval EFI_SUCCESS The Unicode string for the user readable name in + the language specified by Language for the + driver specified by This was returned in + DriverName. + + @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. + + @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid + EFI_HANDLE. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER ControllerName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This is not currently + managing the controller specified by + ControllerHandle and ChildHandle. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +Mtftp4ComponentNameGetControllerName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_HANDLE ChildHandle OPTIONAL, + IN CHAR8 *Language, + OUT CHAR16 **ControllerName + ) +{ + EFI_STATUS Status; + EFI_MTFTP4_PROTOCOL *Mtftp4; + + // + // Only provide names for child handles. + // + if (ChildHandle == NULL) { + return EFI_UNSUPPORTED; + } + + // + // Make sure this driver produced ChildHandle + // + Status = EfiTestChildHandle ( + ControllerHandle, + ChildHandle, + &gEfiUdp4ProtocolGuid + ); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Retrieve an instance of a produced protocol from ChildHandle + // + Status = gBS->OpenProtocol ( + ChildHandle, + &gEfiMtftp4ProtocolGuid, + (VOID **)&Mtftp4, + NULL, + NULL, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Update the component name for this child handle. + // + Status = UpdateName (Mtftp4); + if (EFI_ERROR (Status)) { + return Status; + } + + return LookupUnicodeString2 ( + Language, + This->SupportedLanguages, + gMtftp4ControllerNameTable, + ControllerName, + (BOOLEAN)(This == &gMtftp4ComponentName) + ); +} diff --git a/NetworkPkg/Mtftp4Dxe/Mtftp4Driver.c b/NetworkPkg/Mtftp4Dxe/Mtftp4Driver.c new file mode 100644 index 0000000000..ae9e65544a --- /dev/null +++ b/NetworkPkg/Mtftp4Dxe/Mtftp4Driver.c @@ -0,0 +1,739 @@ +/** @file + Implementation of Mtftp drivers. + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Mtftp4Impl.h" + +EFI_DRIVER_BINDING_PROTOCOL gMtftp4DriverBinding = { + Mtftp4DriverBindingSupported, + Mtftp4DriverBindingStart, + Mtftp4DriverBindingStop, + 0xa, + NULL, + NULL +}; + +EFI_SERVICE_BINDING_PROTOCOL gMtftp4ServiceBindingTemplete = { + Mtftp4ServiceBindingCreateChild, + Mtftp4ServiceBindingDestroyChild +}; + + +/** + The driver entry point which installs multiple protocols to the ImageHandle. + + @param ImageHandle The MTFTP's image handle. + @param SystemTable The system table. + + @retval EFI_SUCCESS The handles are successfully installed on the image. + @retval others some EFI_ERROR occured. + +**/ +EFI_STATUS +EFIAPI +Mtftp4DriverEntryPoint ( + IN EFI_HANDLE ImageHandle, + IN EFI_SYSTEM_TABLE *SystemTable + ) +{ + return EfiLibInstallDriverBindingComponentName2 ( + ImageHandle, + SystemTable, + &gMtftp4DriverBinding, + ImageHandle, + &gMtftp4ComponentName, + &gMtftp4ComponentName2 + ); +} + + +/** + Test whether MTFTP driver support this controller. + + @param This The MTFTP driver binding instance + @param Controller The controller to test + @param RemainingDevicePath The remaining device path + + @retval EFI_SUCCESS The controller has UDP service binding protocol + installed, MTFTP can support it. + @retval EFI_ALREADY_STARTED The device specified by ControllerHandle and + RemainingDevicePath is already being managed by + the driver specified by This. + @retval EFI_ACCESS_DENIED The device specified by ControllerHandle and + RemainingDevicePath is already being managed by a + different driver or an application that requires + exclusive access. + @retval EFI_UNSUPPORTED The device specified by ControllerHandle and + RemainingDevicePath is not supported by the driver + specified by This. + +**/ +EFI_STATUS +EFIAPI +Mtftp4DriverBindingSupported ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE Controller, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath + ) +{ + EFI_STATUS Status; + + Status = gBS->OpenProtocol ( + Controller, + &gEfiUdp4ServiceBindingProtocolGuid, + NULL, + This->DriverBindingHandle, + Controller, + EFI_OPEN_PROTOCOL_TEST_PROTOCOL + ); + + return Status; +} + + +/** + Config a NULL UDP that is used to keep the connection between UDP and MTFTP. + + Just leave the Udp child unconfigured. When UDP is unloaded, + MTFTP will be informed with DriverBinding Stop. + + @param UdpIo The UDP_IO to configure + @param Context The opaque parameter to the callback + + @retval EFI_SUCCESS It always return EFI_SUCCESS directly. + +**/ +EFI_STATUS +EFIAPI +Mtftp4ConfigNullUdp ( + IN UDP_IO *UdpIo, + IN VOID *Context + ) +{ + return EFI_SUCCESS; +} + + +/** + Create then initialize a MTFTP service binding instance. + + @param Controller The controller to install the MTFTP service + binding on + @param Image The driver binding image of the MTFTP driver + @param Service The variable to receive the created service + binding instance. + + @retval EFI_OUT_OF_RESOURCES Failed to allocate resource to create the instance + @retval EFI_DEVICE_ERROR Failed to create a NULL UDP port to keep + connection with UDP. + @retval EFI_SUCCESS The service instance is created for the + controller. + +**/ +EFI_STATUS +Mtftp4CreateService ( + IN EFI_HANDLE Controller, + IN EFI_HANDLE Image, + OUT MTFTP4_SERVICE **Service + ) +{ + MTFTP4_SERVICE *MtftpSb; + EFI_STATUS Status; + + *Service = NULL; + MtftpSb = AllocatePool (sizeof (MTFTP4_SERVICE)); + + if (MtftpSb == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + MtftpSb->Signature = MTFTP4_SERVICE_SIGNATURE; + MtftpSb->ServiceBinding = gMtftp4ServiceBindingTemplete; + MtftpSb->ChildrenNum = 0; + InitializeListHead (&MtftpSb->Children); + + MtftpSb->Timer = NULL; + MtftpSb->TimerNotifyLevel = NULL; + MtftpSb->TimerToGetMap = NULL; + MtftpSb->Controller = Controller; + MtftpSb->Image = Image; + MtftpSb->ConnectUdp = NULL; + + // + // Create the timer and a udp to be notified when UDP is uninstalled + // + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL | EVT_TIMER, + TPL_CALLBACK, + Mtftp4OnTimerTick, + MtftpSb, + &MtftpSb->Timer + ); + if (EFI_ERROR (Status)) { + FreePool (MtftpSb); + return Status; + } + + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL | EVT_TIMER, + TPL_NOTIFY, + Mtftp4OnTimerTickNotifyLevel, + MtftpSb, + &MtftpSb->TimerNotifyLevel + ); + if (EFI_ERROR (Status)) { + gBS->CloseEvent (MtftpSb->Timer); + FreePool (MtftpSb); + return Status; + } + + // + // Create the timer used to time out the procedure which is used to + // get the default IP address. + // + Status = gBS->CreateEvent ( + EVT_TIMER, + TPL_CALLBACK, + NULL, + NULL, + &MtftpSb->TimerToGetMap + ); + if (EFI_ERROR (Status)) { + gBS->CloseEvent (MtftpSb->TimerNotifyLevel); + gBS->CloseEvent (MtftpSb->Timer); + FreePool (MtftpSb); + return Status; + } + + MtftpSb->ConnectUdp = UdpIoCreateIo ( + Controller, + Image, + Mtftp4ConfigNullUdp, + UDP_IO_UDP4_VERSION, + NULL + ); + + if (MtftpSb->ConnectUdp == NULL) { + gBS->CloseEvent (MtftpSb->TimerToGetMap); + gBS->CloseEvent (MtftpSb->TimerNotifyLevel); + gBS->CloseEvent (MtftpSb->Timer); + FreePool (MtftpSb); + return EFI_DEVICE_ERROR; + } + + *Service = MtftpSb; + return EFI_SUCCESS; +} + + +/** + Release all the resource used the MTFTP service binding instance. + + @param MtftpSb The MTFTP service binding instance. + +**/ +VOID +Mtftp4CleanService ( + IN MTFTP4_SERVICE *MtftpSb + ) +{ + UdpIoFreeIo (MtftpSb->ConnectUdp); + gBS->CloseEvent (MtftpSb->TimerToGetMap); + gBS->CloseEvent (MtftpSb->TimerNotifyLevel); + gBS->CloseEvent (MtftpSb->Timer); +} + + +/** + Start the MTFTP driver on this controller. + + MTFTP driver will install a MTFTP SERVICE BINDING protocol on the supported + controller, which can be used to create/destroy MTFTP children. + + @param This The MTFTP driver binding protocol. + @param Controller The controller to manage. + @param RemainingDevicePath Remaining device path. + + @retval EFI_ALREADY_STARTED The MTFTP service binding protocol has been + started on the controller. + @retval EFI_SUCCESS The MTFTP service binding is installed on the + controller. + +**/ +EFI_STATUS +EFIAPI +Mtftp4DriverBindingStart ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE Controller, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath + ) +{ + MTFTP4_SERVICE *MtftpSb; + EFI_STATUS Status; + + // + // Directly return if driver is already running. + // + Status = gBS->OpenProtocol ( + Controller, + &gEfiMtftp4ServiceBindingProtocolGuid, + NULL, + This->DriverBindingHandle, + Controller, + EFI_OPEN_PROTOCOL_TEST_PROTOCOL + ); + + if (Status == EFI_SUCCESS) { + return EFI_ALREADY_STARTED; + } + + Status = Mtftp4CreateService (Controller, This->DriverBindingHandle, &MtftpSb); + + if (EFI_ERROR (Status)) { + return Status; + } + ASSERT (MtftpSb != NULL); + + Status = gBS->SetTimer (MtftpSb->Timer, TimerPeriodic, TICKS_PER_SECOND); + + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + Status = gBS->SetTimer (MtftpSb->TimerNotifyLevel, TimerPeriodic, TICKS_PER_SECOND); + + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + // + // Install the Mtftp4ServiceBinding Protocol onto Controller + // + Status = gBS->InstallMultipleProtocolInterfaces ( + &Controller, + &gEfiMtftp4ServiceBindingProtocolGuid, + &MtftpSb->ServiceBinding, + NULL + ); + + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + return EFI_SUCCESS; + +ON_ERROR: + Mtftp4CleanService (MtftpSb); + FreePool (MtftpSb); + + return Status; +} + +/** + Callback function which provided by user to remove one node in NetDestroyLinkList process. + + @param[in] Entry The entry to be removed. + @param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList. + + @retval EFI_SUCCESS The entry has been removed successfully. + @retval Others Fail to remove the entry. + +**/ +EFI_STATUS +EFIAPI +Mtftp4DestroyChildEntryInHandleBuffer ( + IN LIST_ENTRY *Entry, + IN VOID *Context + ) +{ + MTFTP4_PROTOCOL *Instance; + EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; + UINTN NumberOfChildren; + EFI_HANDLE *ChildHandleBuffer; + + if (Entry == NULL || Context == NULL) { + return EFI_INVALID_PARAMETER; + } + + Instance = NET_LIST_USER_STRUCT_S (Entry, MTFTP4_PROTOCOL, Link, MTFTP4_PROTOCOL_SIGNATURE); + ServiceBinding = ((MTFTP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *) Context)->ServiceBinding; + NumberOfChildren = ((MTFTP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *) Context)->NumberOfChildren; + ChildHandleBuffer = ((MTFTP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *) Context)->ChildHandleBuffer; + + if (!NetIsInHandleBuffer (Instance->Handle, NumberOfChildren, ChildHandleBuffer)) { + return EFI_SUCCESS; + } + + return ServiceBinding->DestroyChild (ServiceBinding, Instance->Handle); +} + +/** + Stop the MTFTP driver on controller. The controller is a UDP + child handle. + + @param This The MTFTP driver binding protocol + @param Controller The controller to stop + @param NumberOfChildren The number of children + @param ChildHandleBuffer The array of the child handle. + + @retval EFI_SUCCESS The driver is stopped on the controller. + @retval EFI_DEVICE_ERROR Failed to stop the driver on the controller. + +**/ +EFI_STATUS +EFIAPI +Mtftp4DriverBindingStop ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE Controller, + IN UINTN NumberOfChildren, + IN EFI_HANDLE *ChildHandleBuffer + ) +{ + EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; + MTFTP4_SERVICE *MtftpSb; + EFI_HANDLE NicHandle; + EFI_STATUS Status; + LIST_ENTRY *List; + MTFTP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT Context; + + // + // MTFTP driver opens UDP child, So, Controller is a UDP + // child handle. Locate the Nic handle first. Then get the + // MTFTP private data back. + // + NicHandle = NetLibGetNicHandle (Controller, &gEfiUdp4ProtocolGuid); + + if (NicHandle == NULL) { + return EFI_SUCCESS; + } + + Status = gBS->OpenProtocol ( + NicHandle, + &gEfiMtftp4ServiceBindingProtocolGuid, + (VOID **) &ServiceBinding, + This->DriverBindingHandle, + NicHandle, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + + if (EFI_ERROR (Status)) { + return EFI_DEVICE_ERROR; + } + + MtftpSb = MTFTP4_SERVICE_FROM_THIS (ServiceBinding); + + if (!IsListEmpty (&MtftpSb->Children)) { + // + // Destroy the Mtftp4 child instance in ChildHandleBuffer. + // + List = &MtftpSb->Children; + Context.ServiceBinding = ServiceBinding; + Context.NumberOfChildren = NumberOfChildren; + Context.ChildHandleBuffer = ChildHandleBuffer; + Status = NetDestroyLinkList ( + List, + Mtftp4DestroyChildEntryInHandleBuffer, + &Context, + NULL + ); + } + + if (NumberOfChildren == 0 && IsListEmpty (&MtftpSb->Children)) { + gBS->UninstallProtocolInterface ( + NicHandle, + &gEfiMtftp4ServiceBindingProtocolGuid, + ServiceBinding + ); + + Mtftp4CleanService (MtftpSb); + if (gMtftp4ControllerNameTable != NULL) { + FreeUnicodeStringTable (gMtftp4ControllerNameTable); + gMtftp4ControllerNameTable = NULL; + } + FreePool (MtftpSb); + + Status = EFI_SUCCESS; + } + + return Status; +} + + +/** + Initialize a MTFTP protocol instance which is the child of MtftpSb. + + @param MtftpSb The MTFTP service binding protocol. + @param Instance The MTFTP instance to initialize. + +**/ +VOID +Mtftp4InitProtocol ( + IN MTFTP4_SERVICE *MtftpSb, + OUT MTFTP4_PROTOCOL *Instance + ) +{ + ZeroMem (Instance, sizeof (MTFTP4_PROTOCOL)); + + Instance->Signature = MTFTP4_PROTOCOL_SIGNATURE; + InitializeListHead (&Instance->Link); + CopyMem (&Instance->Mtftp4, &gMtftp4ProtocolTemplate, sizeof (Instance->Mtftp4)); + Instance->State = MTFTP4_STATE_UNCONFIGED; + Instance->Service = MtftpSb; + + InitializeListHead (&Instance->Blocks); +} + + +/** + Create a MTFTP child for the service binding instance, then + install the MTFTP protocol to the ChildHandle. + + @param This The MTFTP service binding instance. + @param ChildHandle The Child handle to install the MTFTP protocol. + + @retval EFI_INVALID_PARAMETER The parameter is invalid. + @retval EFI_OUT_OF_RESOURCES Failed to allocate resource for the new child. + @retval EFI_SUCCESS The child is successfully create. + +**/ +EFI_STATUS +EFIAPI +Mtftp4ServiceBindingCreateChild ( + IN EFI_SERVICE_BINDING_PROTOCOL *This, + IN EFI_HANDLE *ChildHandle + ) +{ + MTFTP4_SERVICE *MtftpSb; + MTFTP4_PROTOCOL *Instance; + EFI_STATUS Status; + EFI_TPL OldTpl; + VOID *Udp4; + + if ((This == NULL) || (ChildHandle == NULL)) { + return EFI_INVALID_PARAMETER; + } + + Instance = AllocatePool (sizeof (*Instance)); + + if (Instance == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + MtftpSb = MTFTP4_SERVICE_FROM_THIS (This); + + Mtftp4InitProtocol (MtftpSb, Instance); + + Instance->UnicastPort = UdpIoCreateIo ( + MtftpSb->Controller, + MtftpSb->Image, + Mtftp4ConfigNullUdp, + UDP_IO_UDP4_VERSION, + Instance + ); + + if (Instance->UnicastPort == NULL) { + FreePool (Instance); + return EFI_OUT_OF_RESOURCES; + } + + // + // Install the MTFTP protocol onto ChildHandle + // + Status = gBS->InstallMultipleProtocolInterfaces ( + ChildHandle, + &gEfiMtftp4ProtocolGuid, + &Instance->Mtftp4, + NULL + ); + + if (EFI_ERROR (Status)) { + UdpIoFreeIo (Instance->UnicastPort); + FreePool (Instance); + return Status; + } + + Instance->Handle = *ChildHandle; + + // + // Open the Udp4 protocol BY_CHILD. + // + Status = gBS->OpenProtocol ( + MtftpSb->ConnectUdp->UdpHandle, + &gEfiUdp4ProtocolGuid, + (VOID **) &Udp4, + gMtftp4DriverBinding.DriverBindingHandle, + Instance->Handle, + EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER + ); + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + // + // Open the Udp4 protocol by child. + // + Status = gBS->OpenProtocol ( + Instance->UnicastPort->UdpHandle, + &gEfiUdp4ProtocolGuid, + (VOID **) &Udp4, + gMtftp4DriverBinding.DriverBindingHandle, + Instance->Handle, + EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER + ); + if (EFI_ERROR (Status)) { + // + // Close the Udp4 protocol. + // + gBS->CloseProtocol ( + MtftpSb->ConnectUdp->UdpHandle, + &gEfiUdp4ProtocolGuid, + gMtftp4DriverBinding.DriverBindingHandle, + ChildHandle + ); + goto ON_ERROR; + } + + // + // Add it to the parent's child list. + // + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + InsertTailList (&MtftpSb->Children, &Instance->Link); + MtftpSb->ChildrenNum++; + + gBS->RestoreTPL (OldTpl); + + return EFI_SUCCESS; + +ON_ERROR: + if (Instance->Handle != NULL) { + gBS->UninstallMultipleProtocolInterfaces ( + Instance->Handle, + &gEfiMtftp4ProtocolGuid, + &Instance->Mtftp4, + NULL + ); + } + + UdpIoFreeIo (Instance->UnicastPort); + FreePool (Instance); + + return Status; +} + + +/** + Destroy one of the service binding's child. + + @param This The service binding instance + @param ChildHandle The child handle to destroy + + @retval EFI_INVALID_PARAMETER The parameter is invaid. + @retval EFI_UNSUPPORTED The child may have already been destroyed. + @retval EFI_SUCCESS The child is destroyed and removed from the + parent's child list. + +**/ +EFI_STATUS +EFIAPI +Mtftp4ServiceBindingDestroyChild ( + IN EFI_SERVICE_BINDING_PROTOCOL *This, + IN EFI_HANDLE ChildHandle + ) +{ + MTFTP4_SERVICE *MtftpSb; + MTFTP4_PROTOCOL *Instance; + EFI_MTFTP4_PROTOCOL *Mtftp4; + EFI_STATUS Status; + EFI_TPL OldTpl; + + if ((This == NULL) || (ChildHandle == NULL)) { + return EFI_INVALID_PARAMETER; + } + + // + // Retrieve the private context data structures + // + Status = gBS->OpenProtocol ( + ChildHandle, + &gEfiMtftp4ProtocolGuid, + (VOID **) &Mtftp4, + gMtftp4DriverBinding.DriverBindingHandle, + ChildHandle, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + + if (EFI_ERROR (Status)) { + return EFI_UNSUPPORTED; + } + + Instance = MTFTP4_PROTOCOL_FROM_THIS (Mtftp4); + MtftpSb = MTFTP4_SERVICE_FROM_THIS (This); + + if (Instance->Service != MtftpSb) { + return EFI_INVALID_PARAMETER; + } + + if (Instance->InDestroy) { + return EFI_SUCCESS; + } + + Instance->InDestroy = TRUE; + + // + // Close the Udp4 protocol. + // + gBS->CloseProtocol ( + MtftpSb->ConnectUdp->UdpHandle, + &gEfiUdp4ProtocolGuid, + gMtftp4DriverBinding.DriverBindingHandle, + ChildHandle + ); + + gBS->CloseProtocol ( + Instance->UnicastPort->UdpHandle, + &gEfiUdp4ProtocolGuid, + gMtftp4DriverBinding.DriverBindingHandle, + ChildHandle + ); + + if (Instance->McastUdpPort != NULL) { + gBS->CloseProtocol ( + Instance->McastUdpPort->UdpHandle, + &gEfiUdp4ProtocolGuid, + gMtftp4DriverBinding.DriverBindingHandle, + ChildHandle + ); + } + + // + // Uninstall the MTFTP4 protocol first to enable a top down destruction. + // + Status = gBS->UninstallProtocolInterface ( + ChildHandle, + &gEfiMtftp4ProtocolGuid, + Mtftp4 + ); + + if (EFI_ERROR (Status)) { + Instance->InDestroy = FALSE; + return Status; + } + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + Mtftp4CleanOperation (Instance, EFI_DEVICE_ERROR); + UdpIoFreeIo (Instance->UnicastPort); + + RemoveEntryList (&Instance->Link); + MtftpSb->ChildrenNum--; + + gBS->RestoreTPL (OldTpl); + + FreePool (Instance); + return EFI_SUCCESS; +} diff --git a/NetworkPkg/Mtftp4Dxe/Mtftp4Driver.h b/NetworkPkg/Mtftp4Dxe/Mtftp4Driver.h new file mode 100644 index 0000000000..c90e690186 --- /dev/null +++ b/NetworkPkg/Mtftp4Dxe/Mtftp4Driver.h @@ -0,0 +1,131 @@ +/** @file + Mtftp drivers function header. + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef __EFI_MTFTP4_DRIVER_H__ +#define __EFI_MTFTP4_DRIVER_H__ + +#include + +#include + +#include +#include +#include + +extern EFI_COMPONENT_NAME_PROTOCOL gMtftp4ComponentName; +extern EFI_COMPONENT_NAME2_PROTOCOL gMtftp4ComponentName2; +extern EFI_DRIVER_BINDING_PROTOCOL gMtftp4DriverBinding; +extern EFI_UNICODE_STRING_TABLE *gMtftp4ControllerNameTable; + +/** + Test whether MTFTP driver support this controller. + + @param This The MTFTP driver binding instance + @param Controller The controller to test + @param RemainingDevicePath The remaining device path + + @retval EFI_SUCCESS The controller has UDP service binding protocol + installed, MTFTP can support it. + @retval Others MTFTP can't support the controller. + +**/ +EFI_STATUS +EFIAPI +Mtftp4DriverBindingSupported ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE Controller, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath + ); + +/** + Start the MTFTP driver on this controller. + + MTFTP driver will install a MTFTP SERVICE BINDING protocol on the supported + controller, which can be used to create/destroy MTFTP children. + + @param This The MTFTP driver binding protocol. + @param Controller The controller to manage. + @param RemainingDevicePath Remaining device path. + + @retval EFI_ALREADY_STARTED The MTFTP service binding protocol has been + started on the controller. + @retval EFI_SUCCESS The MTFTP service binding is installed on the + controller. + +**/ +EFI_STATUS +EFIAPI +Mtftp4DriverBindingStart ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE Controller, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath + ); + +/** + Stop the MTFTP driver on controller. The controller is a UDP + child handle. + + @param This The MTFTP driver binding protocol + @param Controller The controller to stop + @param NumberOfChildren The number of children + @param ChildHandleBuffer The array of the child handle. + + @retval EFI_SUCCESS The driver is stopped on the controller. + @retval EFI_DEVICE_ERROR Failed to stop the driver on the controller. + +**/ +EFI_STATUS +EFIAPI +Mtftp4DriverBindingStop ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE Controller, + IN UINTN NumberOfChildren, + IN EFI_HANDLE *ChildHandleBuffer + ); + +/** + Create a MTFTP child for the service binding instance, then + install the MTFTP protocol to the ChildHandle. + + @param This The MTFTP service binding instance. + @param ChildHandle The Child handle to install the MTFTP protocol. + + @retval EFI_INVALID_PARAMETER The parameter is invalid. + @retval EFI_OUT_OF_RESOURCES Failed to allocate resource for the new child. + @retval EFI_SUCCESS The child is successfully create. + +**/ +EFI_STATUS +EFIAPI +Mtftp4ServiceBindingCreateChild ( + IN EFI_SERVICE_BINDING_PROTOCOL *This, + IN EFI_HANDLE *ChildHandle + ); + +/** + Destroy one of the service binding's child. + + @param This The service binding instance + @param ChildHandle The child handle to destroy + + @retval EFI_INVALID_PARAMETER The parameter is invaid. + @retval EFI_UNSUPPORTED The child may have already been destroyed. + @retval EFI_SUCCESS The child is destroyed and removed from the + parent's child list. + +**/ +EFI_STATUS +EFIAPI +Mtftp4ServiceBindingDestroyChild ( + IN EFI_SERVICE_BINDING_PROTOCOL *This, + IN EFI_HANDLE ChildHandle + ); + + + +#endif diff --git a/NetworkPkg/Mtftp4Dxe/Mtftp4Dxe.inf b/NetworkPkg/Mtftp4Dxe/Mtftp4Dxe.inf new file mode 100644 index 0000000000..6e5335ca23 --- /dev/null +++ b/NetworkPkg/Mtftp4Dxe/Mtftp4Dxe.inf @@ -0,0 +1,69 @@ +## @file +# This module produces EFI MTFTPv4 Protocol and EFI MTFTPv4 Service Binding Protocol. +# +# This module produces EFI MTFTPv4 Protocol upon EFI UDPv4 Protocol, to provide +# basic services for client-side unicast and/or multicase TFTP operations. +# +# Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
+# SPDX-License-Identifier: BSD-2-Clause-Patent +# +# +## + +[Defines] + INF_VERSION = 0x00010005 + BASE_NAME = Mtftp4Dxe + MODULE_UNI_FILE = Mtftp4Dxe.uni + FILE_GUID = DC3641B8-2FA8-4ed3-BC1F-F9962A03454B + MODULE_TYPE = UEFI_DRIVER + VERSION_STRING = 1.0 + ENTRY_POINT = Mtftp4DriverEntryPoint + UNLOAD_IMAGE = NetLibDefaultUnload +# +# The following information is for reference only and not required by the build tools. +# +# VALID_ARCHITECTURES = IA32 X64 EBC +# +# DRIVER_BINDING = gMtftp4DriverBinding +# COMPONENT_NAME = gMtftp4ComponentName +# COMPONENT_NAME2 = gMtftp4ComponentName2 +# + +[Sources] + Mtftp4Option.c + Mtftp4Rrq.c + Mtftp4Impl.h + ComponentName.c + Mtftp4Support.c + Mtftp4Impl.c + Mtftp4Option.h + Mtftp4Support.h + Mtftp4Driver.h + Mtftp4Driver.c + Mtftp4Wrq.c + + +[Packages] + MdePkg/MdePkg.dec + MdeModulePkg/MdeModulePkg.dec + + +[LibraryClasses] + UefiLib + UefiBootServicesTableLib + UefiDriverEntryPoint + DebugLib + NetLib + UdpIoLib + MemoryAllocationLib + BaseMemoryLib + + +[Protocols] + gEfiMtftp4ServiceBindingProtocolGuid ## BY_START + gEfiUdp4ServiceBindingProtocolGuid ## TO_START + gEfiMtftp4ProtocolGuid ## BY_START + gEfiUdp4ProtocolGuid ## TO_START + +[UserExtensions.TianoCore."ExtraFiles"] + Mtftp4DxeExtra.uni diff --git a/NetworkPkg/Mtftp4Dxe/Mtftp4Dxe.uni b/NetworkPkg/Mtftp4Dxe/Mtftp4Dxe.uni new file mode 100644 index 0000000000..1c2c80bcd1 --- /dev/null +++ b/NetworkPkg/Mtftp4Dxe/Mtftp4Dxe.uni @@ -0,0 +1,17 @@ +// /** @file +// This module produces EFI MTFTPv4 Protocol and EFI MTFTPv4 Service Binding Protocol. +// +// This module produces EFI MTFTPv4 Protocol upon EFI UDPv4 Protocol, to provide +// basic services for client-side unicast and/or multicase TFTP operations. +// +// Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
+// +// SPDX-License-Identifier: BSD-2-Clause-Patent +// +// **/ + + +#string STR_MODULE_ABSTRACT #language en-US "Produces EFI MTFTPv4 Protocol and EFI MTFTPv4 Service Binding Protocol" + +#string STR_MODULE_DESCRIPTION #language en-US "This module produces EFI MTFTPv4 Protocol upon EFI UDPv4 Protocol, to provide basic services for client-side unicast or multicase TFTP operations or both." + diff --git a/NetworkPkg/Mtftp4Dxe/Mtftp4DxeExtra.uni b/NetworkPkg/Mtftp4Dxe/Mtftp4DxeExtra.uni new file mode 100644 index 0000000000..cd685c452d --- /dev/null +++ b/NetworkPkg/Mtftp4Dxe/Mtftp4DxeExtra.uni @@ -0,0 +1,14 @@ +// /** @file +// Mtftp4Dxe Localized Strings and Content +// +// Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.
+// +// SPDX-License-Identifier: BSD-2-Clause-Patent +// +// **/ + +#string STR_PROPERTIES_MODULE_NAME +#language en-US +"MTFTP v4 DXE Driver" + + diff --git a/NetworkPkg/Mtftp4Dxe/Mtftp4Impl.c b/NetworkPkg/Mtftp4Dxe/Mtftp4Impl.c new file mode 100644 index 0000000000..70bd693e4e --- /dev/null +++ b/NetworkPkg/Mtftp4Dxe/Mtftp4Impl.c @@ -0,0 +1,1113 @@ +/** @file + Interface routine for Mtftp4. + +(C) Copyright 2014 Hewlett-Packard Development Company, L.P.
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + + +#include "Mtftp4Impl.h" + + +/** + Clean up the MTFTP session to get ready for new operation. + + @param Instance The MTFTP session to clean up + @param Result The result to return to the caller who initiated + the operation. +**/ +VOID +Mtftp4CleanOperation ( + IN OUT MTFTP4_PROTOCOL *Instance, + IN EFI_STATUS Result + ) +{ + LIST_ENTRY *Entry; + LIST_ENTRY *Next; + MTFTP4_BLOCK_RANGE *Block; + EFI_MTFTP4_TOKEN *Token; + + // + // Free various resources. + // + Token = Instance->Token; + + if (Token != NULL) { + Token->Status = Result; + + if (Token->Event != NULL) { + gBS->SignalEvent (Token->Event); + } + + Instance->Token = NULL; + } + + ASSERT (Instance->UnicastPort != NULL); + UdpIoCleanIo (Instance->UnicastPort); + + if (Instance->LastPacket != NULL) { + NetbufFree (Instance->LastPacket); + Instance->LastPacket = NULL; + } + + if (Instance->McastUdpPort != NULL) { + gBS->CloseProtocol ( + Instance->McastUdpPort->UdpHandle, + &gEfiUdp4ProtocolGuid, + gMtftp4DriverBinding.DriverBindingHandle, + Instance->Handle + ); + UdpIoFreeIo (Instance->McastUdpPort); + Instance->McastUdpPort = NULL; + } + + NET_LIST_FOR_EACH_SAFE (Entry, Next, &Instance->Blocks) { + Block = NET_LIST_USER_STRUCT (Entry, MTFTP4_BLOCK_RANGE, Link); + RemoveEntryList (Entry); + FreePool (Block); + } + + ZeroMem (&Instance->RequestOption, sizeof (MTFTP4_OPTION)); + + Instance->Operation = 0; + + Instance->BlkSize = MTFTP4_DEFAULT_BLKSIZE; + Instance->WindowSize = 1; + Instance->TotalBlock = 0; + Instance->AckedBlock = 0; + Instance->LastBlock = 0; + Instance->ServerIp = 0; + Instance->ListeningPort = 0; + Instance->ConnectedPort = 0; + Instance->Gateway = 0; + Instance->PacketToLive = 0; + Instance->MaxRetry = 0; + Instance->CurRetry = 0; + Instance->Timeout = 0; + Instance->McastIp = 0; + Instance->McastPort = 0; + Instance->Master = TRUE; +} + + +/** + Check packet for GetInfo. + + GetInfo is implemented with EfiMtftp4ReadFile. It use Mtftp4GetInfoCheckPacket + to inspect the first packet from server, then abort the session. + + @param This The MTFTP4 protocol instance + @param Token The user's token + @param PacketLen The length of the packet + @param Packet The received packet. + + @retval EFI_ABORTED Abort the ReadFile operation and return. + +**/ +EFI_STATUS +EFIAPI +Mtftp4GetInfoCheckPacket ( + IN EFI_MTFTP4_PROTOCOL *This, + IN EFI_MTFTP4_TOKEN *Token, + IN UINT16 PacketLen, + IN EFI_MTFTP4_PACKET *Packet + ) +{ + MTFTP4_GETINFO_STATE *State; + EFI_STATUS Status; + UINT16 OpCode; + EFI_MTFTP4_ERROR_HEADER *ErrorHeader; + + State = (MTFTP4_GETINFO_STATE *) Token->Context; + OpCode = NTOHS (Packet->OpCode); + + // + // Set the GetInfo's return status according to the OpCode. + // + switch (OpCode) { + case EFI_MTFTP4_OPCODE_ERROR: + ErrorHeader = (EFI_MTFTP4_ERROR_HEADER *) Packet; + if (ErrorHeader->ErrorCode == EFI_MTFTP4_ERRORCODE_FILE_NOT_FOUND) { + DEBUG ((EFI_D_ERROR, "TFTP error code 1 (File Not Found)\n")); + } else { + DEBUG ((EFI_D_ERROR, "TFTP error code %d\n", ErrorHeader->ErrorCode)); + } + State->Status = EFI_TFTP_ERROR; + break; + + case EFI_MTFTP4_OPCODE_OACK: + State->Status = EFI_SUCCESS; + break; + + default: + State->Status = EFI_PROTOCOL_ERROR; + } + + // + // Allocate buffer then copy the packet over. Use gBS->AllocatePool + // in case AllocatePool will implements something tricky. + // + Status = gBS->AllocatePool (EfiBootServicesData, PacketLen, (VOID **) State->Packet); + + if (EFI_ERROR (Status)) { + State->Status = EFI_OUT_OF_RESOURCES; + return EFI_ABORTED; + } + + *(State->PacketLen) = PacketLen; + CopyMem (*(State->Packet), Packet, PacketLen); + + return EFI_ABORTED; +} + + +/** + Check whether the override data is valid. + + It will first validate whether the server is a valid unicast. If a gateway + is provided in the Override, it also check that it is a unicast on the + connected network. + + @param Instance The MTFTP instance + @param Override The override data to validate. + + @retval TRUE The override data is valid + @retval FALSE The override data is invalid + +**/ +BOOLEAN +Mtftp4OverrideValid ( + IN MTFTP4_PROTOCOL *Instance, + IN EFI_MTFTP4_OVERRIDE_DATA *Override + ) +{ + EFI_MTFTP4_CONFIG_DATA *Config; + IP4_ADDR Ip; + IP4_ADDR Netmask; + IP4_ADDR Gateway; + + CopyMem (&Ip, &Override->ServerIp, sizeof (IP4_ADDR)); + if (IP4_IS_UNSPECIFIED (NTOHL (Ip)) || IP4_IS_LOCAL_BROADCAST (NTOHL (Ip))) { + return FALSE; + } + + Config = &Instance->Config; + + CopyMem (&Gateway, &Override->GatewayIp, sizeof (IP4_ADDR)); + Gateway = NTOHL (Gateway); + + if (!Config->UseDefaultSetting && (Gateway != 0)) { + CopyMem (&Netmask, &Config->SubnetMask, sizeof (IP4_ADDR)); + CopyMem (&Ip, &Config->StationIp, sizeof (IP4_ADDR)); + + Netmask = NTOHL (Netmask); + Ip = NTOHL (Ip); + + if ((Netmask != 0 && !NetIp4IsUnicast (Gateway, Netmask)) || !IP4_NET_EQUAL (Gateway, Ip, Netmask)) { + return FALSE; + } + } + + return TRUE; +} + + +/** + Poll the UDP to get the IP4 default address, which may be retrieved + by DHCP. + + The default time out value is 5 seconds. If IP has retrieved the default address, + the UDP is reconfigured. + + @param Instance The Mtftp instance + @param UdpIo The UDP_IO to poll + @param UdpCfgData The UDP configure data to reconfigure the UDP_IO + + @retval TRUE The default address is retrieved and UDP is reconfigured. + @retval FALSE Some error occured. + +**/ +BOOLEAN +Mtftp4GetMapping ( + IN MTFTP4_PROTOCOL *Instance, + IN UDP_IO *UdpIo, + IN EFI_UDP4_CONFIG_DATA *UdpCfgData + ) +{ + MTFTP4_SERVICE *Service; + EFI_IP4_MODE_DATA Ip4Mode; + EFI_UDP4_PROTOCOL *Udp; + EFI_STATUS Status; + + ASSERT (Instance->Config.UseDefaultSetting); + + Service = Instance->Service; + Udp = UdpIo->Protocol.Udp4; + + Status = gBS->SetTimer ( + Service->TimerToGetMap, + TimerRelative, + MTFTP4_TIME_TO_GETMAP * TICKS_PER_SECOND + ); + if (EFI_ERROR (Status)) { + return FALSE; + } + + while (EFI_ERROR (gBS->CheckEvent (Service->TimerToGetMap))) { + Udp->Poll (Udp); + + if (!EFI_ERROR (Udp->GetModeData (Udp, NULL, &Ip4Mode, NULL, NULL)) && + Ip4Mode.IsConfigured) { + + Udp->Configure (Udp, NULL); + return (BOOLEAN) (Udp->Configure (Udp, UdpCfgData) == EFI_SUCCESS); + } + } + + return FALSE; +} + + +/** + Configure the UDP port for unicast receiving. + + @param UdpIo The UDP_IO instance + @param Instance The MTFTP session + + @retval EFI_SUCCESS The UDP port is successfully configured for the + session to unicast receive. + +**/ +EFI_STATUS +Mtftp4ConfigUnicastPort ( + IN UDP_IO *UdpIo, + IN MTFTP4_PROTOCOL *Instance + ) +{ + EFI_MTFTP4_CONFIG_DATA *Config; + EFI_UDP4_CONFIG_DATA UdpConfig; + EFI_STATUS Status; + IP4_ADDR Ip; + + Config = &Instance->Config; + + UdpConfig.AcceptBroadcast = FALSE; + UdpConfig.AcceptPromiscuous = FALSE; + UdpConfig.AcceptAnyPort = FALSE; + UdpConfig.AllowDuplicatePort = FALSE; + UdpConfig.TypeOfService = 0; + UdpConfig.TimeToLive = 64; + UdpConfig.DoNotFragment = FALSE; + UdpConfig.ReceiveTimeout = 0; + UdpConfig.TransmitTimeout = 0; + UdpConfig.UseDefaultAddress = Config->UseDefaultSetting; + IP4_COPY_ADDRESS (&UdpConfig.StationAddress, &Config->StationIp); + IP4_COPY_ADDRESS (&UdpConfig.SubnetMask, &Config->SubnetMask); + UdpConfig.StationPort = Config->LocalPort; + UdpConfig.RemotePort = 0; + + Ip = HTONL (Instance->ServerIp); + IP4_COPY_ADDRESS (&UdpConfig.RemoteAddress, &Ip); + + Status = UdpIo->Protocol.Udp4->Configure (UdpIo->Protocol.Udp4, &UdpConfig); + + if ((Status == EFI_NO_MAPPING) && Mtftp4GetMapping (Instance, UdpIo, &UdpConfig)) { + return EFI_SUCCESS; + } + + if (!Config->UseDefaultSetting && !EFI_IP4_EQUAL (&mZeroIp4Addr, &Config->GatewayIp)) { + // + // The station IP address is manually configured and the Gateway IP is not 0. + // Add the default route for this UDP instance. + // + Status = UdpIo->Protocol.Udp4->Routes ( + UdpIo->Protocol.Udp4, + FALSE, + &mZeroIp4Addr, + &mZeroIp4Addr, + &Config->GatewayIp + ); + if (EFI_ERROR (Status)) { + UdpIo->Protocol.Udp4->Configure (UdpIo->Protocol.Udp4, NULL); + } + } + return Status; +} + + +/** + Start the MTFTP session to do the operation, such as read file, + write file, and read directory. + + @param This The MTFTP session + @param Token The token than encapsues the user's request. + @param Operation The operation to do + + @retval EFI_INVALID_PARAMETER Some of the parameters are invalid. + @retval EFI_NOT_STARTED The MTFTP session hasn't been configured. + @retval EFI_ALREADY_STARTED There is pending operation for the session. + @retval EFI_SUCCESS The operation is successfully started. + +**/ +EFI_STATUS +Mtftp4Start ( + IN EFI_MTFTP4_PROTOCOL *This, + IN EFI_MTFTP4_TOKEN *Token, + IN UINT16 Operation + ) +{ + MTFTP4_PROTOCOL *Instance; + EFI_MTFTP4_OVERRIDE_DATA *Override; + EFI_MTFTP4_CONFIG_DATA *Config; + EFI_TPL OldTpl; + EFI_STATUS Status; + EFI_STATUS TokenStatus; + + // + // Validate the parameters + // + if ((This == NULL) || (Token == NULL) || (Token->Filename == NULL) || + ((Token->OptionCount != 0) && (Token->OptionList == NULL))) { + return EFI_INVALID_PARAMETER; + } + + // + // User must provide at least one method to collect the data for download. + // + if (((Operation == EFI_MTFTP4_OPCODE_RRQ) || (Operation == EFI_MTFTP4_OPCODE_DIR)) && + ((Token->Buffer == NULL) && (Token->CheckPacket == NULL))) { + return EFI_INVALID_PARAMETER; + } + + // + // User must provide at least one method to provide the data for upload. + // + if ((Operation == EFI_MTFTP4_OPCODE_WRQ) && + ((Token->Buffer == NULL) && (Token->PacketNeeded == NULL))) { + return EFI_INVALID_PARAMETER; + } + + Instance = MTFTP4_PROTOCOL_FROM_THIS (This); + + Status = EFI_SUCCESS; + TokenStatus = EFI_SUCCESS; + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + if (Instance->State != MTFTP4_STATE_CONFIGED) { + Status = EFI_NOT_STARTED; + } + + if (Instance->Operation != 0) { + Status = EFI_ACCESS_DENIED; + } + + if ((Token->OverrideData != NULL) && !Mtftp4OverrideValid (Instance, Token->OverrideData)) { + Status = EFI_INVALID_PARAMETER; + } + + if (EFI_ERROR (Status)) { + gBS->RestoreTPL (OldTpl); + return Status; + } + + // + // Set the Operation now to prevent the application start other + // operations. + // + Instance->Operation = Operation; + Override = Token->OverrideData; + + if (Token->OptionCount != 0) { + Status = Mtftp4ParseOption ( + Token->OptionList, + Token->OptionCount, + TRUE, + Instance->Operation, + &Instance->RequestOption + ); + + if (EFI_ERROR (Status)) { + TokenStatus = EFI_DEVICE_ERROR; + goto ON_ERROR; + } + } + + // + // Set the operation parameters from the configuration or override data. + // + Config = &Instance->Config; + Instance->Token = Token; + Instance->BlkSize = MTFTP4_DEFAULT_BLKSIZE; + Instance->WindowSize = MTFTP4_DEFAULT_WINDOWSIZE; + + CopyMem (&Instance->ServerIp, &Config->ServerIp, sizeof (IP4_ADDR)); + Instance->ServerIp = NTOHL (Instance->ServerIp); + + Instance->ListeningPort = Config->InitialServerPort; + Instance->ConnectedPort = 0; + + CopyMem (&Instance->Gateway, &Config->GatewayIp, sizeof (IP4_ADDR)); + Instance->Gateway = NTOHL (Instance->Gateway); + + Instance->MaxRetry = Config->TryCount; + Instance->Timeout = Config->TimeoutValue; + Instance->Master = TRUE; + + if (Override != NULL) { + CopyMem (&Instance->ServerIp, &Override->ServerIp, sizeof (IP4_ADDR)); + CopyMem (&Instance->Gateway, &Override->GatewayIp, sizeof (IP4_ADDR)); + + Instance->ServerIp = NTOHL (Instance->ServerIp); + Instance->Gateway = NTOHL (Instance->Gateway); + + Instance->ListeningPort = Override->ServerPort; + Instance->MaxRetry = Override->TryCount; + Instance->Timeout = Override->TimeoutValue; + } + + if (Instance->ListeningPort == 0) { + Instance->ListeningPort = MTFTP4_DEFAULT_SERVER_PORT; + } + + if (Instance->MaxRetry == 0) { + Instance->MaxRetry = MTFTP4_DEFAULT_RETRY; + } + + if (Instance->Timeout == 0) { + Instance->Timeout = MTFTP4_DEFAULT_TIMEOUT; + } + + // + // Config the unicast UDP child to send initial request + // + Status = Mtftp4ConfigUnicastPort (Instance->UnicastPort, Instance); + if (EFI_ERROR (Status)) { + TokenStatus = EFI_DEVICE_ERROR; + goto ON_ERROR; + } + + // + // Set initial status. + // + Token->Status = EFI_NOT_READY; + + // + // Build and send an initial requests + // + if (Operation == EFI_MTFTP4_OPCODE_WRQ) { + Status = Mtftp4WrqStart (Instance, Operation); + } else { + Status = Mtftp4RrqStart (Instance, Operation); + } + + if (EFI_ERROR (Status)) { + TokenStatus = EFI_DEVICE_ERROR; + goto ON_ERROR; + } + + gBS->RestoreTPL(OldTpl); + + if (Token->Event != NULL) { + return EFI_SUCCESS; + } + + // + // Return immediately for asynchronous operation or poll the + // instance for synchronous operation. + // + while (Token->Status == EFI_NOT_READY) { + This->Poll (This); + } + + return Token->Status; + +ON_ERROR: + Mtftp4CleanOperation (Instance, TokenStatus); + gBS->RestoreTPL (OldTpl); + + return Status; +} + + +/** + Reads the current operational settings. + + The GetModeData()function reads the current operational settings of this + EFI MTFTPv4 Protocol driver instance. + + @param This Pointer to the EFI_MTFTP4_PROTOCOL instance. + @param ModeData Pointer to storage for the EFI MTFTPv4 Protocol + driver mode data. + + @retval EFI_SUCCESS The configuration data was successfully returned. + @retval EFI_OUT_OF_RESOURCES The required mode data could not be allocated. + @retval EFI_INVALID_PARAMETER This is NULL or ModeData is NULL. + +**/ +EFI_STATUS +EFIAPI +EfiMtftp4GetModeData ( + IN EFI_MTFTP4_PROTOCOL *This, + OUT EFI_MTFTP4_MODE_DATA *ModeData + ) +{ + MTFTP4_PROTOCOL *Instance; + EFI_TPL OldTpl; + + if ((This == NULL) || (ModeData == NULL)) { + return EFI_INVALID_PARAMETER; + } + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + Instance = MTFTP4_PROTOCOL_FROM_THIS (This); + CopyMem(&ModeData->ConfigData, &Instance->Config, sizeof (Instance->Config)); + ModeData->SupportedOptionCount = MTFTP4_SUPPORTED_OPTIONS; + ModeData->SupportedOptoins = (UINT8 **) mMtftp4SupportedOptions; + ModeData->UnsupportedOptionCount = 0; + ModeData->UnsupportedOptoins = NULL; + + gBS->RestoreTPL (OldTpl); + + return EFI_SUCCESS; +} + + + +/** + Initializes, changes, or resets the default operational setting for this + EFI MTFTPv4 Protocol driver instance. + + The Configure() function is used to set and change the configuration data for + this EFI MTFTPv4 Protocol driver instance. The configuration data can be reset + to startup defaults by calling Configure() with MtftpConfigData set to NULL. + Whenever the instance is reset, any pending operation is aborted. By changing + the EFI MTFTPv4 Protocol driver instance configuration data, the client can + connect to different MTFTPv4 servers. The configuration parameters in + MtftpConfigData are used as the default parameters in later MTFTPv4 operations + and can be overridden in later operations. + + @param This Pointer to the EFI_MTFTP4_PROTOCOL instance + @param ConfigData MtftpConfigDataPointer to the configuration data + structure + + @retval EFI_SUCCESS The EFI MTFTPv4 Protocol driver was configured + successfully. + @retval EFI_INVALID_PARAMETER One or more following conditions are TRUE: + 1.This is NULL. + 2.MtftpConfigData.UseDefaultSetting is FALSE and + MtftpConfigData.StationIp is not a valid IPv4 + unicast address. + 3.MtftpCofigData.UseDefaultSetting is FALSE and + MtftpConfigData.SubnetMask is invalid. + 4.MtftpCofigData.ServerIp is not a valid IPv4 + unicast address. + 5.MtftpConfigData.UseDefaultSetting is FALSE and + MtftpConfigData.GatewayIp is not a valid IPv4 + unicast address or is not in the same subnet + with station address. + @retval EFI_ACCESS_DENIED The EFI configuration could not be changed at this + time because there is one MTFTP background operation + in progress. + @retval EFI_NO_MAPPING When using a default address, configuration + (DHCP, BOOTP, RARP, etc.) has not finished yet. + @retval EFI_UNSUPPORTED A configuration protocol (DHCP, BOOTP, RARP, etc.) + could not be located when clients choose to use + the default address settings. + @retval EFI_OUT_OF_RESOURCES The EFI MTFTPv4 Protocol driver instance data could + not be allocated. + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. + The EFI MTFTPv4 Protocol driver instance is not + configured. + +**/ +EFI_STATUS +EFIAPI +EfiMtftp4Configure ( + IN EFI_MTFTP4_PROTOCOL *This, + IN EFI_MTFTP4_CONFIG_DATA *ConfigData + ) +{ + MTFTP4_PROTOCOL *Instance; + EFI_TPL OldTpl; + IP4_ADDR Ip; + IP4_ADDR Netmask; + IP4_ADDR Gateway; + IP4_ADDR ServerIp; + + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + Instance = MTFTP4_PROTOCOL_FROM_THIS (This); + + if (ConfigData == NULL) { + // + // Reset the operation if ConfigData is NULL + // + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + Mtftp4CleanOperation (Instance, EFI_ABORTED); + ZeroMem (&Instance->Config, sizeof (EFI_MTFTP4_CONFIG_DATA)); + Instance->State = MTFTP4_STATE_UNCONFIGED; + + gBS->RestoreTPL (OldTpl); + + } else { + // + // Configure the parameters for new operation. + // + CopyMem (&Ip, &ConfigData->StationIp, sizeof (IP4_ADDR)); + CopyMem (&Netmask, &ConfigData->SubnetMask, sizeof (IP4_ADDR)); + CopyMem (&Gateway, &ConfigData->GatewayIp, sizeof (IP4_ADDR)); + CopyMem (&ServerIp, &ConfigData->ServerIp, sizeof (IP4_ADDR)); + + Ip = NTOHL (Ip); + Netmask = NTOHL (Netmask); + Gateway = NTOHL (Gateway); + ServerIp = NTOHL (ServerIp); + + if (ServerIp == 0 || IP4_IS_LOCAL_BROADCAST (ServerIp)) { + return EFI_INVALID_PARAMETER; + } + + if (!ConfigData->UseDefaultSetting && + ((!IP4_IS_VALID_NETMASK (Netmask) || (Netmask != 0 && !NetIp4IsUnicast (Ip, Netmask))))) { + + return EFI_INVALID_PARAMETER; + } + + if ((Gateway != 0) && + ((Netmask != 0xFFFFFFFF && !IP4_NET_EQUAL (Gateway, Ip, Netmask)) || (Netmask != 0 && !NetIp4IsUnicast (Gateway, Netmask)))) { + + return EFI_INVALID_PARAMETER; + } + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + if ((Instance->State == MTFTP4_STATE_CONFIGED) && (Instance->Operation != 0)) { + gBS->RestoreTPL (OldTpl); + return EFI_ACCESS_DENIED; + } + + CopyMem(&Instance->Config, ConfigData, sizeof (*ConfigData));; + Instance->State = MTFTP4_STATE_CONFIGED; + + gBS->RestoreTPL (OldTpl); + } + + return EFI_SUCCESS; +} + + + +/** + Parses the options in an MTFTPv4 OACK packet. + + The ParseOptions() function parses the option fields in an MTFTPv4 OACK packet + and returns the number of options that were found and optionally a list of + pointers to the options in the packet. + If one or more of the option fields are not valid, then EFI_PROTOCOL_ERROR is + returned and *OptionCount and *OptionList stop at the last valid option. + The OptionList is allocated by this function, and caller should free it when used. + + @param This Pointer to the EFI_MTFTP4_PROTOCOL instance. + @param PacketLen Length of the OACK packet to be parsed. + @param Packet Pointer to the OACK packet to be parsed. + @param OptionCount Pointer to the number of options in following OptionList. + @param OptionList Pointer to EFI_MTFTP4_OPTION storage. Call the + EFI Boot Service FreePool() to release theOptionList + if the options in this OptionList are not needed + any more + + @retval EFI_SUCCESS The OACK packet was valid and the OptionCount and + OptionList parameters have been updated. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + 1.PacketLen is 0. + 2.Packet is NULL or Packet is not a valid MTFTPv4 packet. + 3.OptionCount is NULL. + @retval EFI_NOT_FOUND No options were found in the OACK packet. + @retval EFI_OUT_OF_RESOURCES Storage for the OptionList array cannot be allocated. + @retval EFI_PROTOCOL_ERROR One or more of the option fields is invalid. + +**/ +EFI_STATUS +EFIAPI +EfiMtftp4ParseOptions ( + IN EFI_MTFTP4_PROTOCOL *This, + IN UINT32 PacketLen, + IN EFI_MTFTP4_PACKET *Packet, + OUT UINT32 *OptionCount, + OUT EFI_MTFTP4_OPTION **OptionList OPTIONAL + ) +{ + EFI_STATUS Status; + + if ((This == NULL) || (PacketLen < MTFTP4_OPCODE_LEN) || + (Packet == NULL) || (OptionCount == NULL)) { + + return EFI_INVALID_PARAMETER; + } + + Status = Mtftp4ExtractOptions (Packet, PacketLen, OptionCount, OptionList); + + if (EFI_ERROR (Status)) { + return Status; + } + + if (*OptionCount == 0) { + return EFI_NOT_FOUND; + } + + return EFI_SUCCESS; +} + + +/** + Downloads a file from an MTFTPv4 server. + + The ReadFile() function is used to initialize and start an MTFTPv4 download + process and optionally wait for completion. When the download operation completes, + whether successfully or not, the Token.Status field is updated by the EFI MTFTPv4 + Protocol driver and then Token.Event is signaled (if it is not NULL). + Data can be downloaded from the MTFTPv4 server into either of the following locations: + 1.A fixed buffer that is pointed to by Token.Buffer + 2.A download service function that is pointed to by Token.CheckPacket + If both Token.Buffer and Token.CheckPacket are used, then Token.CheckPacket + will be called first. If the call is successful, the packet will be stored in + Token.Buffer. + + @param This Pointer to the EFI_MTFTP4_PROTOCOL instance + @param Token Pointer to the token structure to provide the + parameters that are used in this operation. + + @retval EFI_SUCCESS The data file has been transferred successfully. + @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. + @retval EFI_BUFFER_TOO_SMALL BufferSize is not large enough to hold the downloaded + data in downloading process. + @retval EFI_ABORTED Current operation is aborted by user. + @retval EFI_ICMP_ERROR An ICMP ERROR packet was received. + @retval EFI_TIMEOUT No responses were received from the MTFTPv4 server. + @retval EFI_TFTP_ERROR An MTFTPv4 ERROR packet was received. + @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred. + @retval EFI_NO_MEDIA There was a media error. + +**/ +EFI_STATUS +EFIAPI +EfiMtftp4ReadFile ( + IN EFI_MTFTP4_PROTOCOL *This, + IN EFI_MTFTP4_TOKEN *Token + ) +{ + return Mtftp4Start (This, Token, EFI_MTFTP4_OPCODE_RRQ); +} + + +/** + Sends a data file to an MTFTPv4 server. May be unsupported in some EFI implementations + + The WriteFile() function is used to initialize an uploading operation with the + given option list and optionally wait for completion. If one or more of the + options is not supported by the server, the unsupported options are ignored and + a standard TFTP process starts instead. When the upload process completes, + whether successfully or not, Token.Event is signaled, and the EFI MTFTPv4 Protocol + driver updates Token.Status. + The caller can supply the data to be uploaded in the following two modes: + 1.Through the user-provided buffer + 2.Through a callback function + With the user-provided buffer, the Token.BufferSize field indicates the length + of the buffer, and the driver will upload the data in the buffer. With an + EFI_MTFTP4_PACKET_NEEDED callback function, the driver will call this callback + function to get more data from the user to upload. See the definition of + EFI_MTFTP4_PACKET_NEEDED for more information. These two modes cannot be used at + the same time. The callback function will be ignored if the user provides the buffer. + + @param This Pointer to the EFI_MTFTP4_PROTOCOL instance. + @param Token Pointer to the token structure to provide the + parameters that are used in this function + + @retval EFI_SUCCESS The upload session has started. + @retval EFI_UNSUPPORTED The operation is not supported by this implementation. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + 1. This is NULL. + 2. Token is NULL. + 3. Token.Filename is NULL. + 4. Token.OptionCount is not zero and + Token.OptionList is NULL. + 5. One or more options in Token.OptionList have wrong + format. + 6. Token.Buffer and Token.PacketNeeded are both + NULL. + 7. One or more IPv4 addresses in Token.OverrideData + are not valid unicast IPv4 addresses if + Token.OverrideData is not NULL. + @retval EFI_UNSUPPORTED One or more options in the Token.OptionList are in the + unsupported list of structure EFI_MTFTP4_MODE_DATA. + @retval EFI_NOT_STARTED The EFI MTFTPv4 Protocol driver has not been started. + @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, + BOOTP, RARP, etc.) is not finished yet. + @retval EFI_ALREADY_STARTED This Token is already being used in another MTFTPv4 + session. + @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. + @retval EFI_ACCESS_DENIED The previous operation has not completed yet. + @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred. + +**/ +EFI_STATUS +EFIAPI +EfiMtftp4WriteFile ( + IN EFI_MTFTP4_PROTOCOL *This, + IN EFI_MTFTP4_TOKEN *Token + ) +{ + return Mtftp4Start (This, Token, EFI_MTFTP4_OPCODE_WRQ); +} + + +/** + Downloads a data file "directory" from an MTFTPv4 server. + May be unsupported in some EFI implementations + + The ReadDirectory() function is used to return a list of files on the MTFTPv4 + server that are logically (or operationally) related to Token.Filename. The + directory request packet that is sent to the server is built with the option + list that was provided by caller, if present. + The file information that the server returns is put into either of the following + locations: + 1.A fixed buffer that is pointed to by Token.Buffer + 2.A download service function that is pointed to by Token.CheckPacket + If both Token.Buffer and Token.CheckPacket are used, then Token.CheckPacket will + be called first. If the call is successful, the packet will be stored in Token.Buffer. + The returned directory listing in the Token.Buffer or EFI_MTFTP4_PACKET consists + of a list of two or three variable-length ASCII strings, each terminated by a + null character, for each file in the directory. If the multicast option is involved, + the first field of each directory entry is the static multicast IP address and + UDP port number that is associated with the file name. The format of the field + is ip:ip:ip:ip:port. If the multicast option is not involved, this field and its + terminating null character are not present. + The next field of each directory entry is the file name and the last field is + the file information string. The information string contains the file size and + the create/modify timestamp. The format of the information string is filesize + yyyy-mm-dd hh:mm:ss:ffff. The timestamp is Coordinated Universal Time + (UTC; also known as Greenwich Mean Time [GMT]). + The only difference between ReadFile and ReadDirectory is the opcode used. + + @param This Pointer to the EFI_MTFTP4_PROTOCOL instance + @param Token Pointer to the token structure to provide the + parameters that are used in this function + + @retval EFI_SUCCESS The MTFTPv4 related file "directory" has been downloaded. + @retval EFI_UNSUPPORTED The operation is not supported by this implementation. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + 1. This is NULL. + 2. Token is NULL. + 3. Token.Filename is NULL. + 4. Token.OptionCount is not zero and + Token.OptionList is NULL. + 5. One or more options in Token.OptionList have wrong + format. + 6. Token.Buffer and Token.PacketNeeded are both + NULL. + 7. One or more IPv4 addresses in Token.OverrideData + are not valid unicast IPv4 addresses if + Token.OverrideData is not NULL. + @retval EFI_UNSUPPORTED One or more options in the Token.OptionList are in the + unsupported list of structure EFI_MTFTP4_MODE_DATA. + @retval EFI_NOT_STARTED The EFI MTFTPv4 Protocol driver has not been started. + @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, + BOOTP, RARP, etc.) is not finished yet. + @retval EFI_ALREADY_STARTED This Token is already being used in another MTFTPv4 + session. + @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. + @retval EFI_ACCESS_DENIED The previous operation has not completed yet. + @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred. + +**/ +EFI_STATUS +EFIAPI +EfiMtftp4ReadDirectory ( + IN EFI_MTFTP4_PROTOCOL *This, + IN EFI_MTFTP4_TOKEN *Token + ) +{ + return Mtftp4Start (This, Token, EFI_MTFTP4_OPCODE_DIR); +} + + +/** + Gets information about a file from an MTFTPv4 server. + + The GetInfo() function assembles an MTFTPv4 request packet with options; + sends it to the MTFTPv4 server; and may return an MTFTPv4 OACK, MTFTPv4 ERROR, + or ICMP ERROR packet. Retries occur only if no response packets are received + from the MTFTPv4 server before the timeout expires. + It is implemented with EfiMtftp4ReadFile: build a token, then pass it to + EfiMtftp4ReadFile. In its check packet callback abort the opertions. + + @param This Pointer to the EFI_MTFTP4_PROTOCOL instance + @param OverrideData Data that is used to override the existing + parameters. If NULL, the default parameters that + were set in the EFI_MTFTP4_PROTOCOL.Configure() + function are used + @param Filename Pointer to null-terminated ASCII file name string + @param ModeStr Pointer to null-terminated ASCII mode string. If NULL, "octet" + will be used + @param OptionCount Number of option/value string pairs in OptionList + @param OptionList Pointer to array of option/value string pairs. + Ignored if OptionCount is zero + @param PacketLength The number of bytes in the returned packet + @param Packet PacketThe pointer to the received packet. This + buffer must be freed by the caller. + + @retval EFI_SUCCESS An MTFTPv4 OACK packet was received and is in + the Buffer. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + 1.This is NULL. + 2.Filename is NULL. + 3.OptionCount is not zero and OptionList is NULL. + 4.One or more options in OptionList have wrong format. + 5.PacketLength is NULL. + 6.One or more IPv4 addresses in OverrideData are + not valid unicast IPv4 addresses if OverrideData + is not NULL. + @retval EFI_UNSUPPORTED One or more options in the OptionList are in the + unsupported list of structure EFI_MTFTP4_MODE_DATA + @retval EFI_NOT_STARTED The EFI MTFTPv4 Protocol driver has not been started. + @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, + BOOTP, RARP, etc.) has not finished yet. + @retval EFI_ACCESS_DENIED The previous operation has not completed yet. + @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated. + @retval EFI_TFTP_ERROR An MTFTPv4 ERROR packet was received and is in + the Buffer. + @retval EFI_ICMP_ERROR An ICMP ERROR packet was received and the Packet + is set to NULL. + @retval EFI_PROTOCOL_ERROR An unexpected MTFTPv4 packet was received and is + in the Buffer. + @retval EFI_TIMEOUT No responses were received from the MTFTPv4 server. + @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred. + @retval EFI_NO_MEDIA There was a media error. + +**/ +EFI_STATUS +EFIAPI +EfiMtftp4GetInfo ( + IN EFI_MTFTP4_PROTOCOL *This, + IN EFI_MTFTP4_OVERRIDE_DATA *OverrideData OPTIONAL, + IN UINT8 *Filename, + IN UINT8 *ModeStr OPTIONAL, + IN UINT8 OptionCount, + IN EFI_MTFTP4_OPTION *OptionList OPTIONAL, + OUT UINT32 *PacketLength, + OUT EFI_MTFTP4_PACKET **Packet OPTIONAL + ) +{ + EFI_MTFTP4_TOKEN Token; + MTFTP4_GETINFO_STATE State; + EFI_STATUS Status; + + if ((This == NULL) || (Filename == NULL) || (PacketLength == NULL) || + ((OptionCount != 0) && (OptionList == NULL))) { + return EFI_INVALID_PARAMETER; + } + + if (Packet != NULL) { + *Packet = NULL; + } + + *PacketLength = 0; + State.Packet = Packet; + State.PacketLen = PacketLength; + State.Status = EFI_SUCCESS; + + // + // Fill in the Token to issue an synchronous ReadFile operation + // + Token.Status = EFI_SUCCESS; + Token.Event = NULL; + Token.OverrideData = OverrideData; + Token.Filename = Filename; + Token.ModeStr = ModeStr; + Token.OptionCount = OptionCount; + Token.OptionList = OptionList; + Token.BufferSize = 0; + Token.Buffer = NULL; + Token.Context = &State; + Token.CheckPacket = Mtftp4GetInfoCheckPacket; + Token.TimeoutCallback = NULL; + Token.PacketNeeded = NULL; + + Status = EfiMtftp4ReadFile (This, &Token); + + if (EFI_ABORTED == Status) { + return State.Status; + } + + return Status; +} + +/** + Polls for incoming data packets and processes outgoing data packets. + + The Poll() function can be used by network drivers and applications to increase + the rate that data packets are moved between the communications device and the + transmit and receive queues. + In some systems, the periodic timer event in the managed network driver may not + poll the underlying communications device fast enough to transmit and/or receive + all data packets without missing incoming packets or dropping outgoing packets. + Drivers and applications that are experiencing packet loss should try calling + the Poll() function more often. + + @param This Pointer to the EFI_MTFTP4_PROTOCOL instance + + @retval EFI_SUCCESS Incoming or outgoing data was processed. + @retval EFI_NOT_STARTED This EFI MTFTPv4 Protocol instance has not been started. + @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, + BOOTP, RARP, etc.) is not finished yet. + @retval EFI_INVALID_PARAMETER This is NULL. + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. + @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive + queue. Consider increasing the polling rate. + +**/ +EFI_STATUS +EFIAPI +EfiMtftp4Poll ( + IN EFI_MTFTP4_PROTOCOL *This + ) +{ + MTFTP4_PROTOCOL *Instance; + EFI_UDP4_PROTOCOL *Udp; + EFI_STATUS Status; + + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + Instance = MTFTP4_PROTOCOL_FROM_THIS (This); + + if (Instance->State == MTFTP4_STATE_UNCONFIGED) { + return EFI_NOT_STARTED; + } else if (Instance->State == MTFTP4_STATE_DESTROY) { + return EFI_DEVICE_ERROR; + } + + Udp = Instance->UnicastPort->Protocol.Udp4; + Status = Udp->Poll (Udp); + Mtftp4OnTimerTick (NULL, Instance->Service); + return Status; +} + +EFI_MTFTP4_PROTOCOL gMtftp4ProtocolTemplate = { + EfiMtftp4GetModeData, + EfiMtftp4Configure, + EfiMtftp4GetInfo, + EfiMtftp4ParseOptions, + EfiMtftp4ReadFile, + EfiMtftp4WriteFile, + EfiMtftp4ReadDirectory, + EfiMtftp4Poll +}; diff --git a/NetworkPkg/Mtftp4Dxe/Mtftp4Impl.h b/NetworkPkg/Mtftp4Dxe/Mtftp4Impl.h new file mode 100644 index 0000000000..33393d4247 --- /dev/null +++ b/NetworkPkg/Mtftp4Dxe/Mtftp4Impl.h @@ -0,0 +1,226 @@ +/** @file + + Mtftp4 Implementation. + + Mtftp4 Implementation, it supports the following RFCs: + RFC1350 - THE TFTP PROTOCOL (REVISION 2) + RFC2090 - TFTP Multicast Option + RFC2347 - TFTP Option Extension + RFC2348 - TFTP Blocksize Option + RFC2349 - TFTP Timeout Interval and Transfer Size Options + RFC7440 - TFTP Windowsize Option + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + + +#ifndef __EFI_MTFTP4_IMPL_H__ +#define __EFI_MTFTP4_IMPL_H__ + +#include + +#include +#include + +#include +#include +#include +#include +#include +#include + +extern EFI_MTFTP4_PROTOCOL gMtftp4ProtocolTemplate; + +typedef struct _MTFTP4_SERVICE MTFTP4_SERVICE; +typedef struct _MTFTP4_PROTOCOL MTFTP4_PROTOCOL; + +#include "Mtftp4Driver.h" +#include "Mtftp4Option.h" +#include "Mtftp4Support.h" + + +/// +/// Some constant value of Mtftp service. +/// +#define MTFTP4_SERVICE_SIGNATURE SIGNATURE_32 ('T', 'F', 'T', 'P') +#define MTFTP4_PROTOCOL_SIGNATURE SIGNATURE_32 ('t', 'f', 't', 'p') + +#define MTFTP4_DEFAULT_SERVER_PORT 69 +#define MTFTP4_DEFAULT_TIMEOUT 3 +#define MTFTP4_DEFAULT_RETRY 5 +#define MTFTP4_DEFAULT_BLKSIZE 512 +#define MTFTP4_DEFAULT_WINDOWSIZE 1 +#define MTFTP4_TIME_TO_GETMAP 5 + +#define MTFTP4_STATE_UNCONFIGED 0 +#define MTFTP4_STATE_CONFIGED 1 +#define MTFTP4_STATE_DESTROY 2 + +/// +/// Mtftp service block +/// +struct _MTFTP4_SERVICE { + UINT32 Signature; + EFI_SERVICE_BINDING_PROTOCOL ServiceBinding; + + UINT16 ChildrenNum; + LIST_ENTRY Children; + + EFI_EVENT Timer; ///< Ticking timer for all the MTFTP clients to handle the packet timeout case. + EFI_EVENT TimerNotifyLevel; ///< Ticking timer for all the MTFTP clients to calculate the packet live time. + EFI_EVENT TimerToGetMap; + + EFI_HANDLE Controller; + EFI_HANDLE Image; + + // + // This UDP child is used to keep the connection between the UDP + // and MTFTP, so MTFTP will be notified when UDP is uninstalled. + // + UDP_IO *ConnectUdp; +}; + + +typedef struct { + EFI_MTFTP4_PACKET **Packet; + UINT32 *PacketLen; + EFI_STATUS Status; +} MTFTP4_GETINFO_STATE; + +struct _MTFTP4_PROTOCOL { + UINT32 Signature; + LIST_ENTRY Link; + EFI_MTFTP4_PROTOCOL Mtftp4; + + INTN State; + BOOLEAN InDestroy; + + MTFTP4_SERVICE *Service; + EFI_HANDLE Handle; + + EFI_MTFTP4_CONFIG_DATA Config; + + // + // Operation parameters: token and requested options. + // + EFI_MTFTP4_TOKEN *Token; + MTFTP4_OPTION RequestOption; + UINT16 Operation; + + // + // Blocks is a list of MTFTP4_BLOCK_RANGE which contains + // holes in the file + // + UINT16 BlkSize; + UINT16 LastBlock; + LIST_ENTRY Blocks; + + UINT16 WindowSize; + + // + // Record the total received and saved block number. + // + UINT64 TotalBlock; + + // + // Record the acked block number. + // + UINT64 AckedBlock; + + // + // The server's communication end point: IP and two ports. one for + // initial request, one for its selected port. + // + IP4_ADDR ServerIp; + UINT16 ListeningPort; + UINT16 ConnectedPort; + IP4_ADDR Gateway; + UDP_IO *UnicastPort; + + // + // Timeout and retransmit status + // + NET_BUF *LastPacket; + UINT32 PacketToLive; + BOOLEAN HasTimeout; + UINT32 CurRetry; + UINT32 MaxRetry; + UINT32 Timeout; + + // + // Parameter used by RRQ's multicast download. + // + IP4_ADDR McastIp; + UINT16 McastPort; + BOOLEAN Master; + UDP_IO *McastUdpPort; +}; + +typedef struct { + EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; + UINTN NumberOfChildren; + EFI_HANDLE *ChildHandleBuffer; +} MTFTP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT; + +/** + Clean up the MTFTP session to get ready for new operation. + + @param Instance The MTFTP session to clean up + @param Result The result to return to the caller who initiated + the operation. +**/ +VOID +Mtftp4CleanOperation ( + IN OUT MTFTP4_PROTOCOL *Instance, + IN EFI_STATUS Result + ); + +/** + Start the MTFTP session for upload. + + It will first init some states, then send the WRQ request packet, + and start receiving the packet. + + @param Instance The MTFTP session + @param Operation Redundant parameter, which is always + EFI_MTFTP4_OPCODE_WRQ here. + + @retval EFI_SUCCESS The upload process has been started. + @retval Others Failed to start the upload. + +**/ +EFI_STATUS +Mtftp4WrqStart ( + IN MTFTP4_PROTOCOL *Instance, + IN UINT16 Operation + ); + +/** + Start the MTFTP session to download. + + It will first initialize some of the internal states then build and send a RRQ + reqeuest packet, at last, it will start receive for the downloading. + + @param Instance The Mtftp session + @param Operation The MTFTP opcode, it may be a EFI_MTFTP4_OPCODE_RRQ + or EFI_MTFTP4_OPCODE_DIR. + + @retval EFI_SUCCESS The mtftp download session is started. + @retval Others Failed to start downloading. + +**/ +EFI_STATUS +Mtftp4RrqStart ( + IN MTFTP4_PROTOCOL *Instance, + IN UINT16 Operation + ); + +#define MTFTP4_SERVICE_FROM_THIS(a) \ + CR (a, MTFTP4_SERVICE, ServiceBinding, MTFTP4_SERVICE_SIGNATURE) + +#define MTFTP4_PROTOCOL_FROM_THIS(a) \ + CR (a, MTFTP4_PROTOCOL, Mtftp4, MTFTP4_PROTOCOL_SIGNATURE) + +#endif diff --git a/NetworkPkg/Mtftp4Dxe/Mtftp4Option.c b/NetworkPkg/Mtftp4Dxe/Mtftp4Option.c new file mode 100644 index 0000000000..d97f157f17 --- /dev/null +++ b/NetworkPkg/Mtftp4Dxe/Mtftp4Option.c @@ -0,0 +1,549 @@ +/** @file + Routines to process MTFTP4 options. + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Mtftp4Impl.h" + +CHAR8 *mMtftp4SupportedOptions[MTFTP4_SUPPORTED_OPTIONS] = { + "blksize", + "windowsize", + "timeout", + "tsize", + "multicast" +}; + + +/** + Check whether two ascii strings are equel, ignore the case. + + @param Str1 The first ascii string + @param Str2 The second ascii string + + @retval TRUE Two strings are equal when case is ignored. + @retval FALSE Two string are not equal. + +**/ +BOOLEAN +NetStringEqualNoCase ( + IN UINT8 *Str1, + IN UINT8 *Str2 + ) +{ + UINT8 Ch1; + UINT8 Ch2; + + ASSERT ((Str1 != NULL) && (Str2 != NULL)); + + for (; (*Str1 != '\0') && (*Str2 != '\0'); Str1++, Str2++) { + Ch1 = *Str1; + Ch2 = *Str2; + + // + // Convert them to lower case then compare two + // + if (('A' <= Ch1) && (Ch1 <= 'Z')) { + Ch1 += 'a' - 'A'; + } + + if (('A' <= Ch2) && (Ch2 <= 'Z')) { + Ch2 += 'a' - 'A'; + } + + if (Ch1 != Ch2) { + return FALSE; + } + } + + return (BOOLEAN) (*Str1 == *Str2); +} + + +/** + Convert a string to a UINT32 number. + + @param Str The string to convert from + + @return The number get from the string + +**/ +UINT32 +NetStringToU32 ( + IN UINT8 *Str + ) +{ + UINT32 Num; + + ASSERT (Str != NULL); + + Num = 0; + + for (; NET_IS_DIGIT (*Str); Str++) { + Num = Num * 10 + (*Str - '0'); + } + + return Num; +} + + +/** + Convert a string of the format "192.168.0.1" to an IP address. + + @param Str The string representation of IP + @param Ip The varible to get IP. + + @retval EFI_INVALID_PARAMETER The IP string is invalid. + @retval EFI_SUCCESS The IP is parsed into the Ip + +**/ +EFI_STATUS +NetStringToIp ( + IN UINT8 *Str, + OUT IP4_ADDR *Ip + ) +{ + UINT32 Byte; + UINT32 Addr; + UINTN Index; + + *Ip = 0; + Addr = 0; + + for (Index = 0; Index < 4; Index++) { + if (!NET_IS_DIGIT (*Str)) { + return EFI_INVALID_PARAMETER; + } + + Byte = NetStringToU32 (Str); + + if (Byte > 255) { + return EFI_INVALID_PARAMETER; + } + + Addr = (Addr << 8) | Byte; + + // + // Skip all the digitals and check whether the sepeator is the dot + // + while (NET_IS_DIGIT (*Str)) { + Str++; + } + + if ((Index < 3) && (*Str != '.')) { + return EFI_INVALID_PARAMETER; + } + + Str++; + } + + *Ip = Addr; + + return EFI_SUCCESS; +} + + +/** + Go through the packet to fill the Options array with the start + addresses of each MTFTP option name/value pair. + + @param Packet The packet to check + @param PacketLen The packet's length + @param Count The size of the Options on input. The actual + options on output + @param Options The option array to fill in + + @retval EFI_INVALID_PARAMETER The packet is mal-formated + @retval EFI_BUFFER_TOO_SMALL The Options array is too small + @retval EFI_SUCCESS The packet has been parsed into the Options array. + +**/ +EFI_STATUS +Mtftp4FillOptions ( + IN EFI_MTFTP4_PACKET *Packet, + IN UINT32 PacketLen, + IN OUT UINT32 *Count, + OUT EFI_MTFTP4_OPTION *Options OPTIONAL + ) +{ + UINT8 *Cur; + UINT8 *Last; + UINT8 Num; + UINT8 *Name; + UINT8 *Value; + + Num = 0; + Cur = (UINT8 *) Packet + MTFTP4_OPCODE_LEN; + Last = (UINT8 *) Packet + PacketLen - 1; + + // + // process option name and value pairs. The last byte is always zero + // + while (Cur < Last) { + Name = Cur; + + while (*Cur != 0) { + Cur++; + } + + if (Cur == Last) { + return EFI_INVALID_PARAMETER; + } + + Value = ++Cur; + + while (*Cur != 0) { + Cur++; + } + + Num++; + + if ((Options != NULL) && (Num <= *Count)) { + Options[Num - 1].OptionStr = Name; + Options[Num - 1].ValueStr = Value; + } + + Cur++; + } + + if ((*Count < Num) || (Options == NULL)) { + *Count = Num; + return EFI_BUFFER_TOO_SMALL; + } + + *Count = Num; + return EFI_SUCCESS; +} + + +/** + Allocate and fill in a array of Mtftp options from the Packet. + + It first calls Mtftp4FillOption to get the option number, then allocate + the array, at last, call Mtftp4FillOption again to save the options. + + @param Packet The packet to parse + @param PacketLen The length of the packet + @param OptionCount The number of options in the packet + @param OptionList The point to get the option array. + + @retval EFI_INVALID_PARAMETER The parametera are invalid or packet isn't a + well-formated OACK packet. + @retval EFI_SUCCESS The option array is build + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the array + +**/ +EFI_STATUS +Mtftp4ExtractOptions ( + IN EFI_MTFTP4_PACKET *Packet, + IN UINT32 PacketLen, + OUT UINT32 *OptionCount, + OUT EFI_MTFTP4_OPTION **OptionList OPTIONAL + ) +{ + EFI_STATUS Status; + + *OptionCount = 0; + + if (OptionList != NULL) { + *OptionList = NULL; + } + + if (NTOHS (Packet->OpCode) != EFI_MTFTP4_OPCODE_OACK) { + return EFI_INVALID_PARAMETER; + } + + if (PacketLen == MTFTP4_OPCODE_LEN) { + return EFI_SUCCESS; + } + + // + // The last byte must be zero to terminate the options + // + if (*((UINT8 *) Packet + PacketLen - 1) != 0) { + return EFI_INVALID_PARAMETER; + } + + // + // Get the number of options + // + Status = Mtftp4FillOptions (Packet, PacketLen, OptionCount, NULL); + + if ((Status == EFI_SUCCESS) || (Status != EFI_BUFFER_TOO_SMALL)) { + return Status; + } + + // + // Allocate memory for the options, then call Mtftp4FillOptions to + // fill it if caller want that. + // + if (OptionList == NULL) { + return EFI_SUCCESS; + } + + *OptionList = AllocatePool (*OptionCount * sizeof (EFI_MTFTP4_OPTION)); + + if (*OptionList == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + Mtftp4FillOptions (Packet, PacketLen, OptionCount, *OptionList); + return EFI_SUCCESS; +} + + +/** + Parse the MTFTP multicast option. + + @param Value The Mtftp multicast value string + @param Option The option to save the info into. + + @retval EFI_INVALID_PARAMETER The multicast value string is invalid. + @retval EFI_SUCCESS The multicast value is parsed into the Option + +**/ +EFI_STATUS +Mtftp4ExtractMcast ( + IN UINT8 *Value, + IN OUT MTFTP4_OPTION *Option + ) +{ + EFI_STATUS Status; + UINT32 Num; + + // + // The multicast option is formated like "204.0.0.1,1857,1" + // The server can also omit the ip and port, use ",,1" + // + if (*Value == ',') { + Option->McastIp = 0; + } else { + Status = NetStringToIp (Value, &Option->McastIp); + + if (EFI_ERROR (Status)) { + return Status; + } + + while ((*Value != 0) && (*Value != ',')) { + Value++; + } + } + + if (*Value != ',') { + return EFI_INVALID_PARAMETER; + } + + Value++; + + // + // Convert the port setting. the server can send us a port number or + // empty string. such as the port in ",,1" + // + if (*Value == ',') { + Option->McastPort = 0; + } else { + Num = NetStringToU32 (Value); + + if (Num > 65535) { + return EFI_INVALID_PARAMETER; + } + + Option->McastPort = (UINT16) Num; + + while (NET_IS_DIGIT (*Value)) { + Value++; + } + } + + if (*Value != ',') { + return EFI_INVALID_PARAMETER; + } + + Value++; + + // + // Check the master/slave setting, 1 for master, 0 for slave. + // + Num = NetStringToU32 (Value); + + if ((Num != 0) && (Num != 1)) { + return EFI_INVALID_PARAMETER; + } + + Option->Master = (BOOLEAN) (Num == 1); + + while (NET_IS_DIGIT (*Value)) { + Value++; + } + + if (*Value != '\0') { + return EFI_INVALID_PARAMETER; + } + + return EFI_SUCCESS; +} + + +/** + Parse the option in Options array to MTFTP4_OPTION which program + can access directly. + + @param Options The option array, which contains addresses of each + option's name/value string. + @param Count The number of options in the Options + @param Request Whether this is a request or OACK. The format of + multicast is different according to this setting. + @param Operation The current performed operation. + @param MtftpOption The MTFTP4_OPTION for easy access. + + @retval EFI_INVALID_PARAMETER The option is mal-formated + @retval EFI_UNSUPPORTED Some option isn't supported + @retval EFI_SUCCESS The option are OK and has been parsed. + +**/ +EFI_STATUS +Mtftp4ParseOption ( + IN EFI_MTFTP4_OPTION *Options, + IN UINT32 Count, + IN BOOLEAN Request, + IN UINT16 Operation, + OUT MTFTP4_OPTION *MtftpOption + ) +{ + EFI_STATUS Status; + UINT32 Index; + UINT32 Value; + EFI_MTFTP4_OPTION *This; + + MtftpOption->Exist = 0; + + for (Index = 0; Index < Count; Index++) { + This = Options + Index; + + if ((This->OptionStr == NULL) || (This->ValueStr == NULL)) { + return EFI_INVALID_PARAMETER; + } + + if (NetStringEqualNoCase (This->OptionStr, (UINT8 *) "blksize")) { + // + // block size option, valid value is between [8, 65464] + // + Value = NetStringToU32 (This->ValueStr); + + if ((Value < 8) || (Value > 65464)) { + return EFI_INVALID_PARAMETER; + } + + MtftpOption->BlkSize = (UINT16) Value; + MtftpOption->Exist |= MTFTP4_BLKSIZE_EXIST; + + } else if (NetStringEqualNoCase (This->OptionStr, (UINT8 *) "timeout")) { + // + // timeout option, valid value is between [1, 255] + // + Value = NetStringToU32 (This->ValueStr); + + if ((Value < 1) || (Value > 255)) { + return EFI_INVALID_PARAMETER; + } + + MtftpOption->Timeout = (UINT8) Value; + + } else if (NetStringEqualNoCase (This->OptionStr, (UINT8 *) "tsize")) { + // + // tsize option, the biggest transfer supported is 4GB with block size option + // + MtftpOption->Tsize = NetStringToU32 (This->ValueStr); + MtftpOption->Exist |= MTFTP4_TSIZE_EXIST; + + } else if (NetStringEqualNoCase (This->OptionStr, (UINT8 *) "multicast")) { + // + // Multicast option, if it is a request, the value must be a zero + // length string, otherwise, it is formated like "204.0.0.1,1857,1\0" + // + if (Request) { + if (*(This->ValueStr) != '\0') { + return EFI_INVALID_PARAMETER; + } + + } else { + Status = Mtftp4ExtractMcast (This->ValueStr, MtftpOption); + + if (EFI_ERROR (Status)) { + return Status; + } + } + + MtftpOption->Exist |= MTFTP4_MCAST_EXIST; + + } else if (NetStringEqualNoCase (This->OptionStr, (UINT8 *) "windowsize")) { + if (Operation == EFI_MTFTP4_OPCODE_WRQ) { + // + // Currently, windowsize is not supported in the write operation. + // + return EFI_UNSUPPORTED; + } + + Value = NetStringToU32 (This->ValueStr); + + if (Value < 1) { + return EFI_INVALID_PARAMETER; + } + + MtftpOption->WindowSize = (UINT16) Value; + MtftpOption->Exist |= MTFTP4_WINDOWSIZE_EXIST; + } else if (Request) { + // + // Ignore the unsupported option if it is a reply, and return + // EFI_UNSUPPORTED if it's a request according to the UEFI spec. + // + return EFI_UNSUPPORTED; + } + } + + return EFI_SUCCESS; +} + + +/** + Parse the options in the OACK packet to MTFTP4_OPTION which program + can access directly. + + @param Packet The OACK packet to parse + @param PacketLen The length of the packet + @param Operation The current performed operation. + @param MtftpOption The MTFTP_OPTION for easy access. + + @retval EFI_INVALID_PARAMETER The packet option is mal-formated + @retval EFI_UNSUPPORTED Some option isn't supported + @retval EFI_SUCCESS The option are OK and has been parsed. + +**/ +EFI_STATUS +Mtftp4ParseOptionOack ( + IN EFI_MTFTP4_PACKET *Packet, + IN UINT32 PacketLen, + IN UINT16 Operation, + OUT MTFTP4_OPTION *MtftpOption + ) +{ + EFI_MTFTP4_OPTION *OptionList; + EFI_STATUS Status; + UINT32 Count; + + MtftpOption->Exist = 0; + + Status = Mtftp4ExtractOptions (Packet, PacketLen, &Count, &OptionList); + + if (EFI_ERROR (Status) || (Count == 0)) { + return Status; + } + ASSERT (OptionList != NULL); + + Status = Mtftp4ParseOption (OptionList, Count, FALSE, Operation, MtftpOption); + + FreePool (OptionList); + return Status; +} diff --git a/NetworkPkg/Mtftp4Dxe/Mtftp4Option.h b/NetworkPkg/Mtftp4Dxe/Mtftp4Option.h new file mode 100644 index 0000000000..fcc4cbe8fd --- /dev/null +++ b/NetworkPkg/Mtftp4Dxe/Mtftp4Option.h @@ -0,0 +1,111 @@ +/** @file + Routines to process MTFTP4 options. + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + + +#ifndef __EFI_MTFTP4_OPTION_H__ +#define __EFI_MTFTP4_OPTION_H__ + +#define MTFTP4_SUPPORTED_OPTIONS 5 +#define MTFTP4_OPCODE_LEN 2 +#define MTFTP4_ERRCODE_LEN 2 +#define MTFTP4_BLKNO_LEN 2 +#define MTFTP4_DATA_HEAD_LEN 4 + +#define MTFTP4_BLKSIZE_EXIST 0x01 +#define MTFTP4_TIMEOUT_EXIST 0x02 +#define MTFTP4_TSIZE_EXIST 0x04 +#define MTFTP4_MCAST_EXIST 0x08 +#define MTFTP4_WINDOWSIZE_EXIST 0x10 + +typedef struct { + UINT16 BlkSize; + UINT16 WindowSize; + UINT8 Timeout; + UINT32 Tsize; + IP4_ADDR McastIp; + UINT16 McastPort; + BOOLEAN Master; + UINT32 Exist; +} MTFTP4_OPTION; + +/** + Allocate and fill in a array of Mtftp options from the Packet. + + It first calls Mtftp4FillOption to get the option number, then allocate + the array, at last, call Mtftp4FillOption again to save the options. + + @param Packet The packet to parse + @param PacketLen The length of the packet + @param OptionCount The number of options in the packet + @param OptionList The point to get the option array. + + @retval EFI_INVALID_PARAMETER The parametera are invalid or packet isn't a + well-formated OACK packet. + @retval EFI_SUCCESS The option array is build + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the array + +**/ +EFI_STATUS +Mtftp4ExtractOptions ( + IN EFI_MTFTP4_PACKET *Packet, + IN UINT32 PacketLen, + OUT UINT32 *OptionCount, + OUT EFI_MTFTP4_OPTION **OptionList OPTIONAL + ); + +/** + Parse the option in Options array to MTFTP4_OPTION which program + can access directly. + + @param Options The option array, which contains addresses of each + option's name/value string. + @param Count The number of options in the Options + @param Request Whether this is a request or OACK. The format of + multicast is different according to this setting. + @param Operation The current performed operation. + @param MtftpOption The MTFTP4_OPTION for easy access. + + @retval EFI_INVALID_PARAMETER The option is mal-formated + @retval EFI_UNSUPPORTED Some option isn't supported + @retval EFI_SUCCESS The option are OK and has been parsed. + +**/ +EFI_STATUS +Mtftp4ParseOption ( + IN EFI_MTFTP4_OPTION *Options, + IN UINT32 Count, + IN BOOLEAN Request, + IN UINT16 Operation, + OUT MTFTP4_OPTION *MtftpOption + ); + +/** + Parse the options in the OACK packet to MTFTP4_OPTION which program + can access directly. + + @param Packet The OACK packet to parse + @param PacketLen The length of the packet + @param Operation The current performed operation. + @param MtftpOption The MTFTP_OPTION for easy access. + + @retval EFI_INVALID_PARAMETER The packet option is mal-formated + @retval EFI_UNSUPPORTED Some option isn't supported + @retval EFI_SUCCESS The option are OK and has been parsed. + +**/ +EFI_STATUS +Mtftp4ParseOptionOack ( + IN EFI_MTFTP4_PACKET *Packet, + IN UINT32 PacketLen, + IN UINT16 Operation, + OUT MTFTP4_OPTION *MtftpOption + ); + +extern CHAR8 *mMtftp4SupportedOptions[MTFTP4_SUPPORTED_OPTIONS]; + +#endif diff --git a/NetworkPkg/Mtftp4Dxe/Mtftp4Rrq.c b/NetworkPkg/Mtftp4Dxe/Mtftp4Rrq.c new file mode 100644 index 0000000000..24c965afb5 --- /dev/null +++ b/NetworkPkg/Mtftp4Dxe/Mtftp4Rrq.c @@ -0,0 +1,818 @@ +/** @file + Routines to process Rrq (download). + +(C) Copyright 2014 Hewlett-Packard Development Company, L.P.
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + + +#include "Mtftp4Impl.h" + + +/** + The packet process callback for MTFTP download. + + @param UdpPacket The packet received + @param EndPoint The local/remote access point of the packet + @param IoStatus The status of the receiving + @param Context Opaque parameter, which is the MTFTP session + +**/ +VOID +EFIAPI +Mtftp4RrqInput ( + IN NET_BUF *UdpPacket, + IN UDP_END_POINT *EndPoint, + IN EFI_STATUS IoStatus, + IN VOID *Context + ); + + +/** + Start the MTFTP session to download. + + It will first initialize some of the internal states then build and send a RRQ + reqeuest packet, at last, it will start receive for the downloading. + + @param Instance The Mtftp session + @param Operation The MTFTP opcode, it may be a EFI_MTFTP4_OPCODE_RRQ + or EFI_MTFTP4_OPCODE_DIR. + + @retval EFI_SUCCESS The mtftp download session is started. + @retval Others Failed to start downloading. + +**/ +EFI_STATUS +Mtftp4RrqStart ( + IN MTFTP4_PROTOCOL *Instance, + IN UINT16 Operation + ) +{ + EFI_STATUS Status; + + // + // The valid block number range are [1, 0xffff]. For example: + // the client sends an RRQ request to the server, the server + // transfers the DATA1 block. If option negoitation is ongoing, + // the server will send back an OACK, then client will send ACK0. + // + Status = Mtftp4InitBlockRange (&Instance->Blocks, 1, 0xffff); + + if (EFI_ERROR (Status)) { + return Status; + } + + Status = Mtftp4SendRequest (Instance); + + if (EFI_ERROR (Status)) { + return Status; + } + + return UdpIoRecvDatagram (Instance->UnicastPort, Mtftp4RrqInput, Instance, 0); +} + + +/** + Build and send a ACK packet for the download session. + + @param Instance The Mtftp session + @param BlkNo The BlkNo to ack. + + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the packet + @retval EFI_SUCCESS The ACK has been sent + @retval Others Failed to send the ACK. + +**/ +EFI_STATUS +Mtftp4RrqSendAck ( + IN MTFTP4_PROTOCOL *Instance, + IN UINT16 BlkNo + ) +{ + EFI_MTFTP4_PACKET *Ack; + NET_BUF *Packet; + EFI_STATUS Status; + + Status = EFI_SUCCESS; + + Packet = NetbufAlloc (sizeof (EFI_MTFTP4_ACK_HEADER)); + if (Packet == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + Ack = (EFI_MTFTP4_PACKET *) NetbufAllocSpace ( + Packet, + sizeof (EFI_MTFTP4_ACK_HEADER), + FALSE + ); + ASSERT (Ack != NULL); + + Ack->Ack.OpCode = HTONS (EFI_MTFTP4_OPCODE_ACK); + Ack->Ack.Block[0] = HTONS (BlkNo); + + Status = Mtftp4SendPacket (Instance, Packet); + if (!EFI_ERROR (Status)) { + Instance->AckedBlock = Instance->TotalBlock; + } + + return Status; +} + + +/** + Deliver the received data block to the user, which can be saved + in the user provide buffer or through the CheckPacket callback. + + @param Instance The Mtftp session + @param Packet The received data packet + @param Len The packet length + + @retval EFI_SUCCESS The data is saved successfully + @retval EFI_ABORTED The user tells to abort by return an error through + CheckPacket + @retval EFI_BUFFER_TOO_SMALL The user's buffer is too small and buffer length is + updated to the actual buffer size needed. + +**/ +EFI_STATUS +Mtftp4RrqSaveBlock ( + IN OUT MTFTP4_PROTOCOL *Instance, + IN EFI_MTFTP4_PACKET *Packet, + IN UINT32 Len + ) +{ + EFI_MTFTP4_TOKEN *Token; + EFI_STATUS Status; + UINT16 Block; + UINT64 Start; + UINT32 DataLen; + UINT64 BlockCounter; + BOOLEAN Completed; + + Completed = FALSE; + Token = Instance->Token; + Block = NTOHS (Packet->Data.Block); + DataLen = Len - MTFTP4_DATA_HEAD_LEN; + + // + // This is the last block, save the block no + // + if (DataLen < Instance->BlkSize) { + Completed = TRUE; + Instance->LastBlock = Block; + Mtftp4SetLastBlockNum (&Instance->Blocks, Block); + } + + // + // Remove this block number from the file hole. If Mtftp4RemoveBlockNum + // returns EFI_NOT_FOUND, the block has been saved, don't save it again. + // Note that : For bigger files, allowing the block counter to roll over + // to accept transfers of unlimited size. So BlockCounter is memorised as + // continuous block counter. + // + Status = Mtftp4RemoveBlockNum (&Instance->Blocks, Block, Completed, &BlockCounter); + + if (Status == EFI_NOT_FOUND) { + return EFI_SUCCESS; + } else if (EFI_ERROR (Status)) { + return Status; + } + + if (Token->CheckPacket != NULL) { + Status = Token->CheckPacket (&Instance->Mtftp4, Token, (UINT16) Len, Packet); + + if (EFI_ERROR (Status)) { + Mtftp4SendError ( + Instance, + EFI_MTFTP4_ERRORCODE_ILLEGAL_OPERATION, + (UINT8 *) "User aborted download" + ); + + return EFI_ABORTED; + } + } + + if (Token->Buffer != NULL) { + Start = MultU64x32 (BlockCounter - 1, Instance->BlkSize); + + if (Start + DataLen <= Token->BufferSize) { + CopyMem ((UINT8 *) Token->Buffer + Start, Packet->Data.Data, DataLen); + + // + // Update the file size when received the last block + // + if ((Instance->LastBlock == Block) && Completed) { + Token->BufferSize = Start + DataLen; + } + + } else if (Instance->LastBlock != 0) { + // + // Don't save the data if the buffer is too small, return + // EFI_BUFFER_TOO_SMALL if received the last packet. This + // will give a accurate file length. + // + Token->BufferSize = Start + DataLen; + + Mtftp4SendError ( + Instance, + EFI_MTFTP4_ERRORCODE_DISK_FULL, + (UINT8 *) "User provided memory block is too small" + ); + + return EFI_BUFFER_TOO_SMALL; + } + } + + return EFI_SUCCESS; +} + + +/** + Function to process the received data packets. + + It will save the block then send back an ACK if it is active. + + @param Instance The downloading MTFTP session + @param Packet The packet received + @param Len The length of the packet + @param Multicast Whether this packet is multicast or unicast + @param Completed Return whether the download has completed + + @retval EFI_SUCCESS The data packet is successfully processed + @retval EFI_ABORTED The download is aborted by the user + @retval EFI_BUFFER_TOO_SMALL The user provided buffer is too small + +**/ +EFI_STATUS +Mtftp4RrqHandleData ( + IN MTFTP4_PROTOCOL *Instance, + IN EFI_MTFTP4_PACKET *Packet, + IN UINT32 Len, + IN BOOLEAN Multicast, + OUT BOOLEAN *Completed + ) +{ + EFI_STATUS Status; + UINT16 BlockNum; + INTN Expected; + + *Completed = FALSE; + Status = EFI_SUCCESS; + BlockNum = NTOHS (Packet->Data.Block); + Expected = Mtftp4GetNextBlockNum (&Instance->Blocks); + + ASSERT (Expected >= 0); + + // + // If we are active (Master) and received an unexpected packet, transmit + // the ACK for the block we received, then restart receiving the + // expected one. If we are passive (Slave), save the block. + // + if (Instance->Master && (Expected != BlockNum)) { + // + // If Expected is 0, (UINT16) (Expected - 1) is also the expected Ack number (65535). + // + return Mtftp4RrqSendAck (Instance, (UINT16) (Expected - 1)); + } + + Status = Mtftp4RrqSaveBlock (Instance, Packet, Len); + + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Record the total received and saved block number. + // + Instance->TotalBlock ++; + + // + // Reset the passive client's timer whenever it received a + // valid data packet. + // + if (!Instance->Master) { + Mtftp4SetTimeout (Instance); + } + + // + // Check whether we have received all the blocks. Send the ACK if we + // are active (unicast client or master client for multicast download). + // If we have received all the blocks, send an ACK even if we are passive + // to tell the server that we are done. + // + Expected = Mtftp4GetNextBlockNum (&Instance->Blocks); + + if (Instance->Master || (Expected < 0)) { + if (Expected < 0) { + // + // If we are passive client, then the just received Block maybe + // isn't the last block. We need to send an ACK to the last block + // to inform the server that we are done. If we are active client, + // the Block == Instance->LastBlock. + // + BlockNum = Instance->LastBlock; + *Completed = TRUE; + + } else { + BlockNum = (UINT16) (Expected - 1); + } + + if (Instance->WindowSize == (Instance->TotalBlock - Instance->AckedBlock) || Expected < 0) { + Status = Mtftp4RrqSendAck (Instance, BlockNum); + } + + } + + return Status; +} + + +/** + Validate whether the options received in the server's OACK packet is valid. + + The options are valid only if: + 1. The server doesn't include options not requested by us + 2. The server can only use smaller blksize than that is requested + 3. The server can only use the same timeout as requested + 4. The server doesn't change its multicast channel. + + @param This The downloading Mtftp session + @param Reply The options in the OACK packet + @param Request The requested options + + @retval TRUE The options in the OACK is OK. + @retval FALSE The options in the OACK is invalid. + +**/ +BOOLEAN +Mtftp4RrqOackValid ( + IN MTFTP4_PROTOCOL *This, + IN MTFTP4_OPTION *Reply, + IN MTFTP4_OPTION *Request + ) +{ + + // + // It is invalid for server to return options we don't request + // + if ((Reply->Exist &~Request->Exist) != 0) { + return FALSE; + } + + // + // Server can only specify a smaller block size and window size to be used and + // return the timeout matches that requested. + // + if ((((Reply->Exist & MTFTP4_BLKSIZE_EXIST) != 0)&& (Reply->BlkSize > Request->BlkSize)) || + (((Reply->Exist & MTFTP4_WINDOWSIZE_EXIST) != 0)&& (Reply->WindowSize > Request->WindowSize)) || + (((Reply->Exist & MTFTP4_TIMEOUT_EXIST) != 0) && (Reply->Timeout != Request->Timeout)) + ) { + return FALSE; + } + + // + // The server can send ",,master" to client to change its master + // setting. But if it use the specific multicast channel, it can't + // change the setting. + // + if (((Reply->Exist & MTFTP4_MCAST_EXIST) != 0) && (This->McastIp != 0)) { + if ((Reply->McastIp != 0) && (Reply->McastIp != This->McastIp)) { + return FALSE; + } + + if ((Reply->McastPort != 0) && (Reply->McastPort != This->McastPort)) { + return FALSE; + } + } + + return TRUE; +} + + +/** + Configure a UDP IO port to receive the multicast. + + @param McastIo The UDP IO to configure + @param Context The opaque parameter to the function which is the + MTFTP session. + + @retval EFI_SUCCESS The UDP child is successfully configured. + @retval Others Failed to configure the UDP child. + +**/ +EFI_STATUS +EFIAPI +Mtftp4RrqConfigMcastPort ( + IN UDP_IO *McastIo, + IN VOID *Context + ) +{ + MTFTP4_PROTOCOL *Instance; + EFI_MTFTP4_CONFIG_DATA *Config; + EFI_UDP4_CONFIG_DATA UdpConfig; + EFI_IPv4_ADDRESS Group; + EFI_STATUS Status; + IP4_ADDR Ip; + + Instance = (MTFTP4_PROTOCOL *) Context; + Config = &Instance->Config; + + UdpConfig.AcceptBroadcast = FALSE; + UdpConfig.AcceptPromiscuous = FALSE; + UdpConfig.AcceptAnyPort = FALSE; + UdpConfig.AllowDuplicatePort = FALSE; + UdpConfig.TypeOfService = 0; + UdpConfig.TimeToLive = 64; + UdpConfig.DoNotFragment = FALSE; + UdpConfig.ReceiveTimeout = 0; + UdpConfig.TransmitTimeout = 0; + UdpConfig.UseDefaultAddress = Config->UseDefaultSetting; + IP4_COPY_ADDRESS (&UdpConfig.StationAddress, &Config->StationIp); + IP4_COPY_ADDRESS (&UdpConfig.SubnetMask, &Config->SubnetMask); + UdpConfig.StationPort = Instance->McastPort; + UdpConfig.RemotePort = 0; + + Ip = HTONL (Instance->ServerIp); + IP4_COPY_ADDRESS (&UdpConfig.RemoteAddress, &Ip); + + Status = McastIo->Protocol.Udp4->Configure (McastIo->Protocol.Udp4, &UdpConfig); + + if (EFI_ERROR (Status)) { + return Status; + } + + if (!Config->UseDefaultSetting && + !EFI_IP4_EQUAL (&mZeroIp4Addr, &Config->GatewayIp)) { + // + // The station IP address is manually configured and the Gateway IP is not 0. + // Add the default route for this UDP instance. + // + Status = McastIo->Protocol.Udp4->Routes ( + McastIo->Protocol.Udp4, + FALSE, + &mZeroIp4Addr, + &mZeroIp4Addr, + &Config->GatewayIp + ); + + if (EFI_ERROR (Status)) { + McastIo->Protocol.Udp4->Configure (McastIo->Protocol.Udp4, NULL); + return Status; + } + } + + // + // join the multicast group + // + Ip = HTONL (Instance->McastIp); + IP4_COPY_ADDRESS (&Group, &Ip); + + return McastIo->Protocol.Udp4->Groups (McastIo->Protocol.Udp4, TRUE, &Group); +} + + +/** + Function to process the OACK. + + It will first validate the OACK packet, then update the various negotiated parameters. + + @param Instance The download MTFTP session + @param Packet The packet received + @param Len The packet length + @param Multicast Whether this packet is received as a multicast + @param Completed Returns whether the download has completed. NOT + used by this function. + + @retval EFI_DEVICE_ERROR Failed to create/start a multicast UDP child + @retval EFI_TFTP_ERROR Some error happened during the process + @retval EFI_SUCCESS The OACK is successfully processed. + +**/ +EFI_STATUS +Mtftp4RrqHandleOack ( + IN OUT MTFTP4_PROTOCOL *Instance, + IN EFI_MTFTP4_PACKET *Packet, + IN UINT32 Len, + IN BOOLEAN Multicast, + OUT BOOLEAN *Completed + ) +{ + MTFTP4_OPTION Reply; + EFI_STATUS Status; + INTN Expected; + EFI_UDP4_PROTOCOL *Udp4; + + *Completed = FALSE; + + // + // If already started the master download, don't change the + // setting. Master download always succeeds. + // + Expected = Mtftp4GetNextBlockNum (&Instance->Blocks); + ASSERT (Expected != -1); + + if (Instance->Master && (Expected != 1)) { + return EFI_SUCCESS; + } + + // + // Parse and validate the options from server + // + ZeroMem (&Reply, sizeof (MTFTP4_OPTION)); + + Status = Mtftp4ParseOptionOack (Packet, Len, Instance->Operation, &Reply); + + if (EFI_ERROR (Status) || + !Mtftp4RrqOackValid (Instance, &Reply, &Instance->RequestOption)) { + // + // Don't send an ERROR packet if the error is EFI_OUT_OF_RESOURCES. + // + if (Status != EFI_OUT_OF_RESOURCES) { + Mtftp4SendError ( + Instance, + EFI_MTFTP4_ERRORCODE_ILLEGAL_OPERATION, + (UINT8 *) "Mal-formated OACK packet" + ); + } + + return EFI_TFTP_ERROR; + } + + if ((Reply.Exist & MTFTP4_MCAST_EXIST) != 0) { + + // + // Save the multicast info. Always update the Master, only update the + // multicast IP address, block size, window size, timeoute at the first time. If IP + // address is updated, create a UDP child to receive the multicast. + // + Instance->Master = Reply.Master; + + if (Instance->McastIp == 0) { + if ((Reply.McastIp == 0) || (Reply.McastPort == 0)) { + Mtftp4SendError ( + Instance, + EFI_MTFTP4_ERRORCODE_ILLEGAL_OPERATION, + (UINT8 *) "Illegal multicast setting" + ); + + return EFI_TFTP_ERROR; + } + + // + // Create a UDP child then start receive the multicast from it. + // + Instance->McastIp = Reply.McastIp; + Instance->McastPort = Reply.McastPort; + if (Instance->McastUdpPort == NULL) { + Instance->McastUdpPort = UdpIoCreateIo ( + Instance->Service->Controller, + Instance->Service->Image, + Mtftp4RrqConfigMcastPort, + UDP_IO_UDP4_VERSION, + Instance + ); + if (Instance->McastUdpPort != NULL) { + Status = gBS->OpenProtocol ( + Instance->McastUdpPort->UdpHandle, + &gEfiUdp4ProtocolGuid, + (VOID **) &Udp4, + Instance->Service->Image, + Instance->Handle, + EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER + ); + if (EFI_ERROR (Status)) { + UdpIoFreeIo (Instance->McastUdpPort); + Instance->McastUdpPort = NULL; + return EFI_DEVICE_ERROR; + } + } + } + + + if (Instance->McastUdpPort == NULL) { + return EFI_DEVICE_ERROR; + } + + Status = UdpIoRecvDatagram (Instance->McastUdpPort, Mtftp4RrqInput, Instance, 0); + + if (EFI_ERROR (Status)) { + Mtftp4SendError ( + Instance, + EFI_MTFTP4_ERRORCODE_ACCESS_VIOLATION, + (UINT8 *) "Failed to create socket to receive multicast packet" + ); + + return Status; + } + + // + // Update the parameters used. + // + if (Reply.BlkSize != 0) { + Instance->BlkSize = Reply.BlkSize; + } + + if (Reply.WindowSize != 0) { + Instance->WindowSize = Reply.WindowSize; + } + + if (Reply.Timeout != 0) { + Instance->Timeout = Reply.Timeout; + } + } + + } else { + Instance->Master = TRUE; + + if (Reply.BlkSize != 0) { + Instance->BlkSize = Reply.BlkSize; + } + + if (Reply.WindowSize != 0) { + Instance->WindowSize = Reply.WindowSize; + } + + if (Reply.Timeout != 0) { + Instance->Timeout = Reply.Timeout; + } + } + + // + // Send an ACK to (Expected - 1) which is 0 for unicast download, + // or tell the server we want to receive the Expected block. + // + return Mtftp4RrqSendAck (Instance, (UINT16) (Expected - 1)); +} + + +/** + The packet process callback for MTFTP download. + + @param UdpPacket The packet received + @param EndPoint The local/remote access point of the packet + @param IoStatus The status of the receiving + @param Context Opaque parameter, which is the MTFTP session + +**/ +VOID +EFIAPI +Mtftp4RrqInput ( + IN NET_BUF *UdpPacket, + IN UDP_END_POINT *EndPoint, + IN EFI_STATUS IoStatus, + IN VOID *Context + ) +{ + MTFTP4_PROTOCOL *Instance; + EFI_MTFTP4_PACKET *Packet; + BOOLEAN Completed; + BOOLEAN Multicast; + EFI_STATUS Status; + UINT16 Opcode; + UINT32 Len; + + Instance = (MTFTP4_PROTOCOL *) Context; + NET_CHECK_SIGNATURE (Instance, MTFTP4_PROTOCOL_SIGNATURE); + + Status = EFI_SUCCESS; + Packet = NULL; + Completed = FALSE; + Multicast = FALSE; + + if (EFI_ERROR (IoStatus)) { + Status = IoStatus; + goto ON_EXIT; + } + + ASSERT (UdpPacket != NULL); + + // + // Find the port this packet is from to restart receive correctly. + // + Multicast = (BOOLEAN) (EndPoint->LocalAddr.Addr[0] == Instance->McastIp); + + if (UdpPacket->TotalSize < MTFTP4_OPCODE_LEN) { + goto ON_EXIT; + } + + // + // Client send initial request to server's listening port. Server + // will select a UDP port to communicate with the client. The server + // is required to use the same port as RemotePort to multicast the + // data. + // + if (EndPoint->RemotePort != Instance->ConnectedPort) { + if (Instance->ConnectedPort != 0) { + goto ON_EXIT; + } else { + Instance->ConnectedPort = EndPoint->RemotePort; + } + } + + // + // Copy the MTFTP packet to a continuous buffer if it isn't already so. + // + Len = UdpPacket->TotalSize; + + if (UdpPacket->BlockOpNum > 1) { + Packet = AllocatePool (Len); + + if (Packet == NULL) { + Status = EFI_OUT_OF_RESOURCES; + goto ON_EXIT; + } + + NetbufCopy (UdpPacket, 0, Len, (UINT8 *) Packet); + + } else { + Packet = (EFI_MTFTP4_PACKET *) NetbufGetByte (UdpPacket, 0, NULL); + ASSERT (Packet != NULL); + } + + Opcode = NTOHS (Packet->OpCode); + + // + // Call the user's CheckPacket if provided. Abort the transmission + // if CheckPacket returns an EFI_ERROR code. + // + if ((Instance->Token->CheckPacket != NULL) && + ((Opcode == EFI_MTFTP4_OPCODE_OACK) || (Opcode == EFI_MTFTP4_OPCODE_ERROR))) { + + Status = Instance->Token->CheckPacket ( + &Instance->Mtftp4, + Instance->Token, + (UINT16) Len, + Packet + ); + + if (EFI_ERROR (Status)) { + // + // Send an error message to the server to inform it + // + if (Opcode != EFI_MTFTP4_OPCODE_ERROR) { + Mtftp4SendError ( + Instance, + EFI_MTFTP4_ERRORCODE_REQUEST_DENIED, + (UINT8 *) "User aborted the transfer" + ); + } + + Status = EFI_ABORTED; + goto ON_EXIT; + } + } + + switch (Opcode) { + case EFI_MTFTP4_OPCODE_DATA: + if ((Len > (UINT32) (MTFTP4_DATA_HEAD_LEN + Instance->BlkSize)) || + (Len < (UINT32) MTFTP4_DATA_HEAD_LEN)) { + goto ON_EXIT; + } + + Status = Mtftp4RrqHandleData (Instance, Packet, Len, Multicast, &Completed); + break; + + case EFI_MTFTP4_OPCODE_OACK: + if (Multicast || (Len <= MTFTP4_OPCODE_LEN)) { + goto ON_EXIT; + } + + Status = Mtftp4RrqHandleOack (Instance, Packet, Len, Multicast, &Completed); + break; + + case EFI_MTFTP4_OPCODE_ERROR: + Status = EFI_TFTP_ERROR; + break; + + default: + break; + } + +ON_EXIT: + + // + // Free the resources, then if !EFI_ERROR (Status), restart the + // receive, otherwise end the session. + // + if ((Packet != NULL) && (UdpPacket->BlockOpNum > 1)) { + FreePool (Packet); + } + + if (UdpPacket != NULL) { + NetbufFree (UdpPacket); + } + + if (!EFI_ERROR (Status) && !Completed) { + if (Multicast) { + Status = UdpIoRecvDatagram (Instance->McastUdpPort, Mtftp4RrqInput, Instance, 0); + } else { + Status = UdpIoRecvDatagram (Instance->UnicastPort, Mtftp4RrqInput, Instance, 0); + } + } + + if (EFI_ERROR (Status) || Completed) { + Mtftp4CleanOperation (Instance, Status); + } +} diff --git a/NetworkPkg/Mtftp4Dxe/Mtftp4Support.c b/NetworkPkg/Mtftp4Dxe/Mtftp4Support.c new file mode 100644 index 0000000000..ad2ff7bf3a --- /dev/null +++ b/NetworkPkg/Mtftp4Dxe/Mtftp4Support.c @@ -0,0 +1,663 @@ +/** @file + Support routines for Mtftp. + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Mtftp4Impl.h" + + +/** + Allocate a MTFTP4 block range, then init it to the range of [Start, End] + + @param Start The start block number + @param End The last block number in the range + + @return Pointer to the created block range, NULL if failed to allocate memory. + +**/ +MTFTP4_BLOCK_RANGE * +Mtftp4AllocateRange ( + IN UINT16 Start, + IN UINT16 End + ) +{ + MTFTP4_BLOCK_RANGE *Range; + + Range = AllocateZeroPool (sizeof (MTFTP4_BLOCK_RANGE)); + + if (Range == NULL) { + return NULL; + } + + InitializeListHead (&Range->Link); + Range->Start = Start; + Range->End = End; + Range->Bound = End; + + return Range; +} + + +/** + Initialize the block range for either RRQ or WRQ. + + RRQ and WRQ have different requirements for Start and End. + For example, during start up, WRQ initializes its whole valid block range + to [0, 0xffff]. This is bacause the server will send us a ACK0 to inform us + to start the upload. When the client received ACK0, it will remove 0 from the + range, get the next block number, which is 1, then upload the BLOCK1. For RRQ + without option negotiation, the server will directly send us the BLOCK1 in + response to the client's RRQ. When received BLOCK1, the client will remove + it from the block range and send an ACK. It also works if there is option + negotiation. + + @param Head The block range head to initialize + @param Start The Start block number. + @param End The last block number. + + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for initial block range + @retval EFI_SUCCESS The initial block range is created. + +**/ +EFI_STATUS +Mtftp4InitBlockRange ( + IN LIST_ENTRY *Head, + IN UINT16 Start, + IN UINT16 End + ) +{ + MTFTP4_BLOCK_RANGE *Range; + + Range = Mtftp4AllocateRange (Start, End); + + if (Range == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + InsertTailList (Head, &Range->Link); + return EFI_SUCCESS; +} + + +/** + Get the first valid block number on the range list. + + @param Head The block range head + + @return The first valid block number, -1 if the block range is empty. + +**/ +INTN +Mtftp4GetNextBlockNum ( + IN LIST_ENTRY *Head + ) +{ + MTFTP4_BLOCK_RANGE *Range; + + if (IsListEmpty (Head)) { + return -1; + } + + Range = NET_LIST_HEAD (Head, MTFTP4_BLOCK_RANGE, Link); + return Range->Start; +} + + +/** + Set the last block number of the block range list. + + It will remove all the blocks after the Last. MTFTP initialize the block range + to the maximum possible range, such as [0, 0xffff] for WRQ. When it gets the + last block number, it will call this function to set the last block number. + + @param Head The block range list + @param Last The last block number + +**/ +VOID +Mtftp4SetLastBlockNum ( + IN LIST_ENTRY *Head, + IN UINT16 Last + ) +{ + MTFTP4_BLOCK_RANGE *Range; + + // + // Iterate from the tail to head to remove the block number + // after the last. + // + while (!IsListEmpty (Head)) { + Range = NET_LIST_TAIL (Head, MTFTP4_BLOCK_RANGE, Link); + + if (Range->Start > Last) { + RemoveEntryList (&Range->Link); + FreePool (Range); + continue; + } + + if (Range->End > Last) { + Range->End = Last; + } + + return ; + } +} + + +/** + Remove the block number from the block range list. + + @param Head The block range list to remove from + @param Num The block number to remove + @param Completed Whether Num is the last block number. + @param BlockCounter The continuous block counter instead of the value after roll-over. + + @retval EFI_NOT_FOUND The block number isn't in the block range list + @retval EFI_SUCCESS The block number has been removed from the list + @retval EFI_OUT_OF_RESOURCES Failed to allocate resource + +**/ +EFI_STATUS +Mtftp4RemoveBlockNum ( + IN LIST_ENTRY *Head, + IN UINT16 Num, + IN BOOLEAN Completed, + OUT UINT64 *BlockCounter + ) +{ + MTFTP4_BLOCK_RANGE *Range; + MTFTP4_BLOCK_RANGE *NewRange; + LIST_ENTRY *Entry; + + NET_LIST_FOR_EACH (Entry, Head) { + + // + // Each block represents a hole [Start, End] in the file, + // skip to the first range with End >= Num + // + Range = NET_LIST_USER_STRUCT (Entry, MTFTP4_BLOCK_RANGE, Link); + + if (Range->End < Num) { + continue; + } + + // + // There are three different cases for Start + // 1. (Start > Num) && (End >= Num): + // because all the holes before this one has the condition of + // End < Num, so this block number has been removed. + // + // 2. (Start == Num) && (End >= Num): + // Need to increase the Start by one, and if End == Num, this + // hole has been removed completely, remove it. + // + // 3. (Start < Num) && (End >= Num): + // if End == Num, only need to decrease the End by one because + // we have (Start < Num) && (Num == End), so (Start <= End - 1). + // if (End > Num), the hold is splited into two holes, with + // [Start, Num - 1] and [Num + 1, End]. + // + if (Range->Start > Num) { + return EFI_NOT_FOUND; + + } else if (Range->Start == Num) { + Range->Start++; + + // + // Note that: RFC 1350 does not mention block counter roll-over, + // but several TFTP hosts implement the roll-over be able to accept + // transfers of unlimited size. There is no consensus, however, whether + // the counter should wrap around to zero or to one. Many implementations + // wrap to zero, because this is the simplest to implement. Here we choose + // this solution. + // + *BlockCounter = Num; + + if (Range->Round > 0) { + *BlockCounter += Range->Bound + MultU64x32 ((UINTN) (Range->Round -1), (UINT32) (Range->Bound + 1)) + 1; + } + + if (Range->Start > Range->Bound) { + Range->Start = 0; + Range->Round ++; + } + + if ((Range->Start > Range->End) || Completed) { + RemoveEntryList (&Range->Link); + FreePool (Range); + } + + return EFI_SUCCESS; + + } else { + if (Range->End == Num) { + Range->End--; + } else { + NewRange = Mtftp4AllocateRange ((UINT16) (Num + 1), (UINT16) Range->End); + + if (NewRange == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + Range->End = Num - 1; + NetListInsertAfter (&Range->Link, &NewRange->Link); + } + + return EFI_SUCCESS; + } + } + + return EFI_NOT_FOUND; +} + + +/** + Build then transmit the request packet for the MTFTP session. + + @param Instance The Mtftp session + + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the request + @retval EFI_SUCCESS The request is built and sent + @retval Others Failed to transmit the packet. + +**/ +EFI_STATUS +Mtftp4SendRequest ( + IN MTFTP4_PROTOCOL *Instance + ) +{ + EFI_MTFTP4_PACKET *Packet; + EFI_MTFTP4_OPTION *Options; + EFI_MTFTP4_TOKEN *Token; + RETURN_STATUS Status; + NET_BUF *Nbuf; + UINT8 *Mode; + UINT8 *Cur; + UINTN Index; + UINT32 BufferLength; + UINTN FileNameLength; + UINTN ModeLength; + UINTN OptionStrLength; + UINTN ValueStrLength; + + Token = Instance->Token; + Options = Token->OptionList; + Mode = Instance->Token->ModeStr; + + if (Mode == NULL) { + Mode = (UINT8 *) "octet"; + } + + // + // Compute the packet length + // + FileNameLength = AsciiStrLen ((CHAR8 *) Token->Filename); + ModeLength = AsciiStrLen ((CHAR8 *) Mode); + BufferLength = (UINT32) FileNameLength + (UINT32) ModeLength + 4; + + for (Index = 0; Index < Token->OptionCount; Index++) { + OptionStrLength = AsciiStrLen ((CHAR8 *) Options[Index].OptionStr); + ValueStrLength = AsciiStrLen ((CHAR8 *) Options[Index].ValueStr); + BufferLength += (UINT32) OptionStrLength + (UINT32) ValueStrLength + 2; + } + // + // Allocate a packet then copy the data over + // + if ((Nbuf = NetbufAlloc (BufferLength)) == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + Packet = (EFI_MTFTP4_PACKET *) NetbufAllocSpace (Nbuf, BufferLength, FALSE); + ASSERT (Packet != NULL); + + Packet->OpCode = HTONS (Instance->Operation); + BufferLength -= sizeof (Packet->OpCode); + + Cur = Packet->Rrq.Filename; + Status = AsciiStrCpyS ((CHAR8 *) Cur, BufferLength, (CHAR8 *) Token->Filename); + ASSERT_EFI_ERROR (Status); + BufferLength -= (UINT32) (FileNameLength + 1); + Cur += FileNameLength + 1; + Status = AsciiStrCpyS ((CHAR8 *) Cur, BufferLength, (CHAR8 *) Mode); + ASSERT_EFI_ERROR (Status); + BufferLength -= (UINT32) (ModeLength + 1); + Cur += ModeLength + 1; + + for (Index = 0; Index < Token->OptionCount; ++Index) { + OptionStrLength = AsciiStrLen ((CHAR8 *) Options[Index].OptionStr); + ValueStrLength = AsciiStrLen ((CHAR8 *) Options[Index].ValueStr); + + Status = AsciiStrCpyS ((CHAR8 *) Cur, BufferLength, (CHAR8 *) Options[Index].OptionStr); + ASSERT_EFI_ERROR (Status); + BufferLength -= (UINT32) (OptionStrLength + 1); + Cur += OptionStrLength + 1; + + Status = AsciiStrCpyS ((CHAR8 *) Cur, BufferLength, (CHAR8 *) Options[Index].ValueStr); + ASSERT_EFI_ERROR (Status); + BufferLength -= (UINT32) (ValueStrLength + 1); + Cur += ValueStrLength + 1; + + } + + return Mtftp4SendPacket (Instance, Nbuf); +} + + +/** + Build then send an error message. + + @param Instance The MTFTP session + @param ErrCode The error code + @param ErrInfo The error message + + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the error packet + @retval EFI_SUCCESS The error packet is transmitted. + @retval Others Failed to transmit the packet. + +**/ +EFI_STATUS +Mtftp4SendError ( + IN MTFTP4_PROTOCOL *Instance, + IN UINT16 ErrCode, + IN UINT8 *ErrInfo + ) +{ + NET_BUF *Packet; + EFI_MTFTP4_PACKET *TftpError; + UINT32 Len; + + Len = (UINT32) (AsciiStrLen ((CHAR8 *) ErrInfo) + sizeof (EFI_MTFTP4_ERROR_HEADER)); + Packet = NetbufAlloc (Len); + if (Packet == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + TftpError = (EFI_MTFTP4_PACKET *) NetbufAllocSpace (Packet, Len, FALSE); + ASSERT (TftpError != NULL); + + TftpError->OpCode = HTONS (EFI_MTFTP4_OPCODE_ERROR); + TftpError->Error.ErrorCode = HTONS (ErrCode); + + AsciiStrCpyS ((CHAR8 *) TftpError->Error.ErrorMessage, Len, (CHAR8 *) ErrInfo); + + return Mtftp4SendPacket (Instance, Packet); +} + + +/** + The callback function called when the packet is transmitted. + + It simply frees the packet. + + @param Packet The transmitted (or failed to) packet + @param EndPoint The local and remote UDP access point + @param IoStatus The result of the transmission + @param Context Opaque parameter to the callback + +**/ +VOID +EFIAPI +Mtftp4OnPacketSent ( + IN NET_BUF *Packet, + IN UDP_END_POINT *EndPoint, + IN EFI_STATUS IoStatus, + IN VOID *Context + ) +{ + NetbufFree (Packet); +} + + +/** + Set the timeout for the instance. User a longer time for passive instances. + + @param Instance The Mtftp session to set time out + +**/ +VOID +Mtftp4SetTimeout ( + IN OUT MTFTP4_PROTOCOL *Instance + ) +{ + if (Instance->Master) { + Instance->PacketToLive = Instance->Timeout; + } else { + Instance->PacketToLive = Instance->Timeout * 2; + } +} + + +/** + Send the packet for the instance. + + It will first save a reference to the packet for later retransmission. + Then determine the destination port, listen port for requests, and connected + port for others. At last, send the packet out. + + @param Instance The Mtftp instance + @param Packet The packet to send + + @retval EFI_SUCCESS The packet is sent out + @retval Others Failed to transmit the packet. + +**/ +EFI_STATUS +Mtftp4SendPacket ( + IN OUT MTFTP4_PROTOCOL *Instance, + IN OUT NET_BUF *Packet + ) +{ + UDP_END_POINT UdpPoint; + EFI_STATUS Status; + UINT16 OpCode; + UINT8 *Buffer; + + // + // Save the packet for retransmission + // + if (Instance->LastPacket != NULL) { + NetbufFree (Instance->LastPacket); + } + + Instance->LastPacket = Packet; + + Instance->CurRetry = 0; + Mtftp4SetTimeout (Instance); + + ZeroMem (&UdpPoint, sizeof (UdpPoint)); + UdpPoint.RemoteAddr.Addr[0] = Instance->ServerIp; + + // + // Send the requests to the listening port, other packets + // to the connected port + // + Buffer = NetbufGetByte (Packet, 0, NULL); + ASSERT (Buffer != NULL); + OpCode = NTOHS (*(UINT16 *)Buffer); + + if ((OpCode == EFI_MTFTP4_OPCODE_RRQ) || + (OpCode == EFI_MTFTP4_OPCODE_DIR) || + (OpCode == EFI_MTFTP4_OPCODE_WRQ)) { + UdpPoint.RemotePort = Instance->ListeningPort; + } else { + UdpPoint.RemotePort = Instance->ConnectedPort; + } + + NET_GET_REF (Packet); + + Status = UdpIoSendDatagram ( + Instance->UnicastPort, + Packet, + &UdpPoint, + NULL, + Mtftp4OnPacketSent, + Instance + ); + + if (EFI_ERROR (Status)) { + NET_PUT_REF (Packet); + } + + return Status; +} + + +/** + Retransmit the last packet for the instance. + + @param Instance The Mtftp instance + + @retval EFI_SUCCESS The last packet is retransmitted. + @retval Others Failed to retransmit. + +**/ +EFI_STATUS +Mtftp4Retransmit ( + IN MTFTP4_PROTOCOL *Instance + ) +{ + UDP_END_POINT UdpPoint; + EFI_STATUS Status; + UINT16 OpCode; + UINT8 *Buffer; + + ASSERT (Instance->LastPacket != NULL); + + ZeroMem (&UdpPoint, sizeof (UdpPoint)); + UdpPoint.RemoteAddr.Addr[0] = Instance->ServerIp; + + // + // Set the requests to the listening port, other packets to the connected port + // + Buffer = NetbufGetByte (Instance->LastPacket, 0, NULL); + ASSERT (Buffer != NULL); + OpCode = NTOHS (*(UINT16 *) Buffer); + + if ((OpCode == EFI_MTFTP4_OPCODE_RRQ) || (OpCode == EFI_MTFTP4_OPCODE_DIR) || + (OpCode == EFI_MTFTP4_OPCODE_WRQ)) { + UdpPoint.RemotePort = Instance->ListeningPort; + } else { + UdpPoint.RemotePort = Instance->ConnectedPort; + } + + NET_GET_REF (Instance->LastPacket); + + Status = UdpIoSendDatagram ( + Instance->UnicastPort, + Instance->LastPacket, + &UdpPoint, + NULL, + Mtftp4OnPacketSent, + Instance + ); + + if (EFI_ERROR (Status)) { + NET_PUT_REF (Instance->LastPacket); + } + + return Status; +} + + +/** + The timer ticking function in TPL_NOTIFY level for the Mtftp service instance. + + @param Event The ticking event + @param Context The Mtftp service instance + +**/ +VOID +EFIAPI +Mtftp4OnTimerTickNotifyLevel ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + MTFTP4_SERVICE *MtftpSb; + LIST_ENTRY *Entry; + LIST_ENTRY *Next; + MTFTP4_PROTOCOL *Instance; + + MtftpSb = (MTFTP4_SERVICE *) Context; + + // + // Iterate through all the children of the Mtftp service instance. Time + // out the current packet transmit. + // + NET_LIST_FOR_EACH_SAFE (Entry, Next, &MtftpSb->Children) { + Instance = NET_LIST_USER_STRUCT (Entry, MTFTP4_PROTOCOL, Link); + if ((Instance->PacketToLive == 0) || (--Instance->PacketToLive > 0)) { + Instance->HasTimeout = FALSE; + } else { + Instance->HasTimeout = TRUE; + } + } +} + + +/** + The timer ticking function for the Mtftp service instance. + + @param Event The ticking event + @param Context The Mtftp service instance + +**/ +VOID +EFIAPI +Mtftp4OnTimerTick ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + MTFTP4_SERVICE *MtftpSb; + LIST_ENTRY *Entry; + LIST_ENTRY *Next; + MTFTP4_PROTOCOL *Instance; + EFI_MTFTP4_TOKEN *Token; + + MtftpSb = (MTFTP4_SERVICE *) Context; + + // + // Iterate through all the children of the Mtftp service instance. + // + NET_LIST_FOR_EACH_SAFE (Entry, Next, &MtftpSb->Children) { + Instance = NET_LIST_USER_STRUCT (Entry, MTFTP4_PROTOCOL, Link); + if (!Instance->HasTimeout) { + continue; + } + + Instance->HasTimeout = FALSE; + + // + // Call the user's time out handler + // + Token = Instance->Token; + + if (Token != NULL && Token->TimeoutCallback != NULL && + EFI_ERROR (Token->TimeoutCallback (&Instance->Mtftp4, Token))) { + Mtftp4SendError ( + Instance, + EFI_MTFTP4_ERRORCODE_REQUEST_DENIED, + (UINT8 *) "User aborted the transfer in time out" + ); + + Mtftp4CleanOperation (Instance, EFI_ABORTED); + continue; + } + + // + // Retransmit the packet if haven't reach the maxmium retry count, + // otherwise exit the transfer. + // + if (++Instance->CurRetry < Instance->MaxRetry) { + Mtftp4Retransmit (Instance); + Mtftp4SetTimeout (Instance); + } else { + Mtftp4CleanOperation (Instance, EFI_TIMEOUT); + continue; + } + } +} diff --git a/NetworkPkg/Mtftp4Dxe/Mtftp4Support.h b/NetworkPkg/Mtftp4Dxe/Mtftp4Support.h new file mode 100644 index 0000000000..cfa7582faa --- /dev/null +++ b/NetworkPkg/Mtftp4Dxe/Mtftp4Support.h @@ -0,0 +1,198 @@ +/** @file + Support routines for MTFTP. + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef __EFI_MTFTP4_SUPPORT_H__ +#define __EFI_MTFTP4_SUPPORT_H__ + +// +// The structure representing a range of block numbers, [Start, End]. +// It is used to remember the holes in the MTFTP block space. If all +// the holes are filled in, then the download or upload has completed. +// +typedef struct { + LIST_ENTRY Link; + INTN Start; + INTN End; + INTN Round; + INTN Bound; +} MTFTP4_BLOCK_RANGE; + + +/** + Initialize the block range for either RRQ or WRQ. + + RRQ and WRQ have different requirements for Start and End. + For example, during start up, WRQ initializes its whole valid block range + to [0, 0xffff]. This is bacause the server will send us a ACK0 to inform us + to start the upload. When the client received ACK0, it will remove 0 from the + range, get the next block number, which is 1, then upload the BLOCK1. For RRQ + without option negotiation, the server will directly send us the BLOCK1 in + response to the client's RRQ. When received BLOCK1, the client will remove + it from the block range and send an ACK. It also works if there is option + negotiation. + + @param Head The block range head to initialize + @param Start The Start block number. + @param End The last block number. + + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for initial block range + @retval EFI_SUCCESS The initial block range is created. + +**/ +EFI_STATUS +Mtftp4InitBlockRange ( + IN LIST_ENTRY *Head, + IN UINT16 Start, + IN UINT16 End + ); + +/** + Get the first valid block number on the range list. + + @param Head The block range head + + @return The first valid block number, -1 if the block range is empty. + +**/ +INTN +Mtftp4GetNextBlockNum ( + IN LIST_ENTRY *Head + ); + +/** + Set the last block number of the block range list. + + It will remove all the blocks after the Last. MTFTP initialize the block range + to the maximum possible range, such as [0, 0xffff] for WRQ. When it gets the + last block number, it will call this function to set the last block number. + + @param Head The block range list + @param Last The last block number + +**/ +VOID +Mtftp4SetLastBlockNum ( + IN LIST_ENTRY *Head, + IN UINT16 Last + ); + +/** + Remove the block number from the block range list. + + @param Head The block range list to remove from + @param Num The block number to remove + @param Completed Whether Num is the last block number. + @param BlockCounter The continuous block counter instead of the value after roll-over. + + @retval EFI_NOT_FOUND The block number isn't in the block range list + @retval EFI_SUCCESS The block number has been removed from the list + @retval EFI_OUT_OF_RESOURCES Failed to allocate resource + +**/ +EFI_STATUS +Mtftp4RemoveBlockNum ( + IN LIST_ENTRY *Head, + IN UINT16 Num, + IN BOOLEAN Completed, + OUT UINT64 *BlockCounter + ); + +/** + Set the timeout for the instance. User a longer time for passive instances. + + @param Instance The Mtftp session to set time out + +**/ +VOID +Mtftp4SetTimeout ( + IN OUT MTFTP4_PROTOCOL *Instance + ); + +/** + Send the packet for the instance. + + It will first save a reference to the packet for later retransmission. + Then determine the destination port, listen port for requests, and connected + port for others. At last, send the packet out. + + @param Instance The Mtftp instance + @param Packet The packet to send + + @retval EFI_SUCCESS The packet is sent out + @retval Others Failed to transmit the packet. + +**/ +EFI_STATUS +Mtftp4SendPacket ( + IN OUT MTFTP4_PROTOCOL *Instance, + IN OUT NET_BUF *Packet + ); + +/** + Build then transmit the request packet for the MTFTP session. + + @param Instance The Mtftp session + + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the request + @retval EFI_SUCCESS The request is built and sent + @retval Others Failed to transmit the packet. + +**/ +EFI_STATUS +Mtftp4SendRequest ( + IN MTFTP4_PROTOCOL *Instance + ); + +/** + Build then send an error message. + + @param Instance The MTFTP session + @param ErrCode The error code + @param ErrInfo The error message + + @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the error packet + @retval EFI_SUCCESS The error packet is transmitted. + @retval Others Failed to transmit the packet. + +**/ +EFI_STATUS +Mtftp4SendError ( + IN MTFTP4_PROTOCOL *Instance, + IN UINT16 ErrCode, + IN UINT8 *ErrInfo + ); + + +/** + The timer ticking function in TPL_NOTIFY level for the Mtftp service instance. + + @param Event The ticking event + @param Context The Mtftp service instance + +**/ +VOID +EFIAPI +Mtftp4OnTimerTickNotifyLevel ( + IN EFI_EVENT Event, + IN VOID *Context + ); + +/** + The timer ticking function for the Mtftp service instance. + + @param Event The ticking event + @param Context The Mtftp service instance + +**/ +VOID +EFIAPI +Mtftp4OnTimerTick ( + IN EFI_EVENT Event, + IN VOID *Context + ); +#endif diff --git a/NetworkPkg/Mtftp4Dxe/Mtftp4Wrq.c b/NetworkPkg/Mtftp4Dxe/Mtftp4Wrq.c new file mode 100644 index 0000000000..14156b801e --- /dev/null +++ b/NetworkPkg/Mtftp4Dxe/Mtftp4Wrq.c @@ -0,0 +1,529 @@ +/** @file + Routines to process Wrq (upload). + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Mtftp4Impl.h" + + + +/** + Build then send a MTFTP data packet for the MTFTP upload session. + + @param Instance The MTFTP upload session. + @param BlockNum The block number to send. + + @retval EFI_OUT_OF_RESOURCES Failed to build the packet. + @retval EFI_ABORTED The consumer of this child directs to abort the + transmission by return an error through PacketNeeded. + @retval EFI_SUCCESS The data is sent. + +**/ +EFI_STATUS +Mtftp4WrqSendBlock ( + IN OUT MTFTP4_PROTOCOL *Instance, + IN UINT16 BlockNum + ) +{ + EFI_MTFTP4_PACKET *Packet; + EFI_MTFTP4_TOKEN *Token; + NET_BUF *UdpPacket; + EFI_STATUS Status; + UINT16 DataLen; + UINT8 *DataBuf; + UINT64 Start; + + // + // Allocate a buffer to hold the user data + // + UdpPacket = NetbufAlloc (Instance->BlkSize + MTFTP4_DATA_HEAD_LEN); + + if (UdpPacket == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + Packet = (EFI_MTFTP4_PACKET *) NetbufAllocSpace (UdpPacket, MTFTP4_DATA_HEAD_LEN, FALSE); + ASSERT (Packet != NULL); + + Packet->Data.OpCode = HTONS (EFI_MTFTP4_OPCODE_DATA); + Packet->Data.Block = HTONS (BlockNum); + + // + // Read the block from either the buffer or PacketNeeded callback + // + Token = Instance->Token; + DataLen = Instance->BlkSize; + + if (Token->Buffer != NULL) { + Start = MultU64x32 (BlockNum - 1, Instance->BlkSize); + + if (Token->BufferSize < Start + Instance->BlkSize) { + DataLen = (UINT16) (Token->BufferSize - Start); + Instance->LastBlock = BlockNum; + Mtftp4SetLastBlockNum (&Instance->Blocks, BlockNum); + } + + if (DataLen > 0) { + NetbufAllocSpace (UdpPacket, DataLen, FALSE); + CopyMem (Packet->Data.Data, (UINT8 *) Token->Buffer + Start, DataLen); + } + + } else { + // + // Get data from PacketNeeded + // + DataBuf = NULL; + Status = Token->PacketNeeded ( + &Instance->Mtftp4, + Token, + &DataLen, + (VOID **) &DataBuf + ); + + if (EFI_ERROR (Status) || (DataLen > Instance->BlkSize)) { + if (DataBuf != NULL) { + FreePool (DataBuf); + } + + if (UdpPacket != NULL) { + NetbufFree (UdpPacket); + } + + Mtftp4SendError ( + Instance, + EFI_MTFTP4_ERRORCODE_REQUEST_DENIED, + (UINT8 *) "User aborted the transfer" + ); + + return EFI_ABORTED; + } + + if (DataLen < Instance->BlkSize) { + Instance->LastBlock = BlockNum; + Mtftp4SetLastBlockNum (&Instance->Blocks, BlockNum); + } + + if (DataLen > 0) { + NetbufAllocSpace (UdpPacket, DataLen, FALSE); + CopyMem (Packet->Data.Data, DataBuf, DataLen); + FreePool (DataBuf); + } + } + + return Mtftp4SendPacket (Instance, UdpPacket); +} + + +/** + Function to handle received ACK packet. + + If the ACK number matches the expected block number, and there are more + data pending, send the next block. Otherwise tell the caller that we are done. + + @param Instance The MTFTP upload session + @param Packet The MTFTP packet received + @param Len The packet length + @param Completed Return whether the upload has finished. + + @retval EFI_SUCCESS The ACK is successfully processed. + @retval EFI_TFTP_ERROR The block number loops back. + @retval Others Failed to transmit the next data packet. + +**/ +EFI_STATUS +Mtftp4WrqHandleAck ( + IN MTFTP4_PROTOCOL *Instance, + IN EFI_MTFTP4_PACKET *Packet, + IN UINT32 Len, + OUT BOOLEAN *Completed + ) +{ + UINT16 AckNum; + INTN Expected; + UINT64 BlockCounter; + + *Completed = FALSE; + AckNum = NTOHS (Packet->Ack.Block[0]); + Expected = Mtftp4GetNextBlockNum (&Instance->Blocks); + + ASSERT (Expected >= 0); + + // + // Get an unwanted ACK, return EFI_SUCCESS to let Mtftp4WrqInput + // restart receive. + // + if (Expected != AckNum) { + return EFI_SUCCESS; + } + + // + // Remove the acked block number, if this is the last block number, + // tell the Mtftp4WrqInput to finish the transfer. This is the last + // block number if the block range are empty. + // + Mtftp4RemoveBlockNum (&Instance->Blocks, AckNum, *Completed, &BlockCounter); + + Expected = Mtftp4GetNextBlockNum (&Instance->Blocks); + + if (Expected < 0) { + + // + // The block range is empty. It may either because the the last + // block has been ACKed, or the sequence number just looped back, + // that is, there is more than 0xffff blocks. + // + if (Instance->LastBlock == AckNum) { + ASSERT (Instance->LastBlock >= 1); + *Completed = TRUE; + return EFI_SUCCESS; + + } else { + Mtftp4SendError ( + Instance, + EFI_MTFTP4_ERRORCODE_REQUEST_DENIED, + (UINT8 *) "Block number rolls back, not supported, try blksize option" + ); + + return EFI_TFTP_ERROR; + } + } + + return Mtftp4WrqSendBlock (Instance, (UINT16) Expected); +} + + +/** + Check whether the received OACK is valid. + + The OACK is valid only if: + 1. It only include options requested by us + 2. It can only include a smaller block size + 3. It can't change the proposed time out value. + 4. Other requirements of the individal MTFTP options as required. + + @param Reply The options included in the OACK + @param Request The options we requested + + @retval TRUE The options included in OACK is valid. + @retval FALSE The options included in OACK is invalid. + +**/ +BOOLEAN +Mtftp4WrqOackValid ( + IN MTFTP4_OPTION *Reply, + IN MTFTP4_OPTION *Request + ) +{ + // + // It is invalid for server to return options we don't request + // + if ((Reply->Exist & ~Request->Exist) != 0) { + return FALSE; + } + + // + // Server can only specify a smaller block size to be used and + // return the timeout matches that requested. + // + if ((((Reply->Exist & MTFTP4_BLKSIZE_EXIST) != 0) && (Reply->BlkSize > Request->BlkSize)) || + (((Reply->Exist & MTFTP4_TIMEOUT_EXIST) != 0) && (Reply->Timeout != Request->Timeout))) { + return FALSE; + } + + return TRUE; +} + + +/** + Function to handle the MTFTP OACK packet. + + It parses the packet's options, and update the internal states of the session. + + @param Instance The MTFTP session + @param Packet The received OACK packet + @param Len The length of the packet + @param Completed Whether the transmisson has completed. NOT used by + this function. + + @retval EFI_SUCCESS The OACK process is OK + @retval EFI_TFTP_ERROR Some error occured, and the session reset. + +**/ +EFI_STATUS +Mtftp4WrqHandleOack ( + IN OUT MTFTP4_PROTOCOL *Instance, + IN EFI_MTFTP4_PACKET *Packet, + IN UINT32 Len, + OUT BOOLEAN *Completed + ) +{ + MTFTP4_OPTION Reply; + EFI_MTFTP4_PACKET Bogus; + EFI_STATUS Status; + INTN Expected; + + *Completed = FALSE; + + // + // Ignore the OACK if already started the upload + // + Expected = Mtftp4GetNextBlockNum (&Instance->Blocks); + + if (Expected != 0) { + return EFI_SUCCESS; + } + + // + // Parse and validate the options from server + // + ZeroMem (&Reply, sizeof (MTFTP4_OPTION)); + Status = Mtftp4ParseOptionOack (Packet, Len, Instance->Operation, &Reply); + + if (EFI_ERROR (Status) || !Mtftp4WrqOackValid (&Reply, &Instance->RequestOption)) { + // + // Don't send a MTFTP error packet when out of resource, it can + // only make it worse. + // + if (Status != EFI_OUT_OF_RESOURCES) { + Mtftp4SendError ( + Instance, + EFI_MTFTP4_ERRORCODE_ILLEGAL_OPERATION, + (UINT8 *) "Mal-formated OACK packet" + ); + } + + return EFI_TFTP_ERROR; + } + + if (Reply.BlkSize != 0) { + Instance->BlkSize = Reply.BlkSize; + } + + if (Reply.Timeout != 0) { + Instance->Timeout = Reply.Timeout; + } + + // + // Build a bogus ACK0 packet then pass it to the Mtftp4WrqHandleAck, + // which will start the transmission of the first data block. + // + Bogus.Ack.OpCode = HTONS (EFI_MTFTP4_OPCODE_ACK); + Bogus.Ack.Block[0] = 0; + + Status = Mtftp4WrqHandleAck ( + Instance, + &Bogus, + sizeof (EFI_MTFTP4_ACK_HEADER), + Completed + ); + + return Status; +} + + +/** + The input process routine for MTFTP upload. + + @param UdpPacket The received MTFTP packet. + @param EndPoint The local/remote access point + @param IoStatus The result of the packet receiving + @param Context Opaque parameter for the callback, which is the + MTFTP session. +**/ +VOID +EFIAPI +Mtftp4WrqInput ( + IN NET_BUF *UdpPacket, + IN UDP_END_POINT *EndPoint, + IN EFI_STATUS IoStatus, + IN VOID *Context + ) +{ + MTFTP4_PROTOCOL *Instance; + EFI_MTFTP4_PACKET *Packet; + BOOLEAN Completed; + EFI_STATUS Status; + UINT32 Len; + UINT16 Opcode; + + Instance = (MTFTP4_PROTOCOL *) Context; + NET_CHECK_SIGNATURE (Instance, MTFTP4_PROTOCOL_SIGNATURE); + + Completed = FALSE; + Packet = NULL; + Status = EFI_SUCCESS; + + if (EFI_ERROR (IoStatus)) { + Status = IoStatus; + goto ON_EXIT; + } + + ASSERT (UdpPacket != NULL); + + if (UdpPacket->TotalSize < MTFTP4_OPCODE_LEN) { + goto ON_EXIT; + } + + // + // Client send initial request to server's listening port. Server + // will select a UDP port to communicate with the client. + // + if (EndPoint->RemotePort != Instance->ConnectedPort) { + if (Instance->ConnectedPort != 0) { + goto ON_EXIT; + } else { + Instance->ConnectedPort = EndPoint->RemotePort; + } + } + + // + // Copy the MTFTP packet to a continuous buffer if it isn't already so. + // + Len = UdpPacket->TotalSize; + + if (UdpPacket->BlockOpNum > 1) { + Packet = AllocatePool (Len); + + if (Packet == NULL) { + Status = EFI_OUT_OF_RESOURCES; + goto ON_EXIT; + } + + NetbufCopy (UdpPacket, 0, Len, (UINT8 *) Packet); + + } else { + Packet = (EFI_MTFTP4_PACKET *) NetbufGetByte (UdpPacket, 0, NULL); + ASSERT (Packet != NULL); + } + + Opcode = NTOHS (Packet->OpCode); + + // + // Call the user's CheckPacket if provided. Abort the transmission + // if CheckPacket returns an EFI_ERROR code. + // + if ((Instance->Token->CheckPacket != NULL) && + ((Opcode == EFI_MTFTP4_OPCODE_OACK) || (Opcode == EFI_MTFTP4_OPCODE_ERROR))) { + + Status = Instance->Token->CheckPacket ( + &Instance->Mtftp4, + Instance->Token, + (UINT16) Len, + Packet + ); + + if (EFI_ERROR (Status)) { + // + // Send an error message to the server to inform it + // + if (Opcode != EFI_MTFTP4_OPCODE_ERROR) { + Mtftp4SendError ( + Instance, + EFI_MTFTP4_ERRORCODE_REQUEST_DENIED, + (UINT8 *) "User aborted the transfer" + ); + } + + Status = EFI_ABORTED; + goto ON_EXIT; + } + } + + switch (Opcode) { + case EFI_MTFTP4_OPCODE_ACK: + if (Len != MTFTP4_OPCODE_LEN + MTFTP4_BLKNO_LEN) { + goto ON_EXIT; + } + + Status = Mtftp4WrqHandleAck (Instance, Packet, Len, &Completed); + break; + + case EFI_MTFTP4_OPCODE_OACK: + if (Len <= MTFTP4_OPCODE_LEN) { + goto ON_EXIT; + } + + Status = Mtftp4WrqHandleOack (Instance, Packet, Len, &Completed); + break; + + case EFI_MTFTP4_OPCODE_ERROR: + Status = EFI_TFTP_ERROR; + break; + + default: + break; + } + +ON_EXIT: + // + // Free the resources, then if !EFI_ERROR (Status) and not completed, + // restart the receive, otherwise end the session. + // + if ((Packet != NULL) && (UdpPacket->BlockOpNum > 1)) { + FreePool (Packet); + } + + if (UdpPacket != NULL) { + NetbufFree (UdpPacket); + } + + if (!EFI_ERROR (Status) && !Completed) { + Status = UdpIoRecvDatagram (Instance->UnicastPort, Mtftp4WrqInput, Instance, 0); + } + + // + // Status may have been updated by UdpIoRecvDatagram + // + if (EFI_ERROR (Status) || Completed) { + Mtftp4CleanOperation (Instance, Status); + } +} + + + +/** + Start the MTFTP session for upload. + + It will first init some states, then send the WRQ request packet, + and start receiving the packet. + + @param Instance The MTFTP session + @param Operation Redundant parameter, which is always + EFI_MTFTP4_OPCODE_WRQ here. + + @retval EFI_SUCCESS The upload process has been started. + @retval Others Failed to start the upload. + +**/ +EFI_STATUS +Mtftp4WrqStart ( + IN MTFTP4_PROTOCOL *Instance, + IN UINT16 Operation + ) +{ + EFI_STATUS Status; + + // + // The valid block number range are [0, 0xffff]. For example: + // the client sends an WRQ request to the server, the server + // ACK with an ACK0 to let client start transfer the first + // packet. + // + Status = Mtftp4InitBlockRange (&Instance->Blocks, 0, 0xffff); + + if (EFI_ERROR (Status)) { + return Status; + } + + Status = Mtftp4SendRequest (Instance); + + if (EFI_ERROR (Status)) { + return Status; + } + + return UdpIoRecvDatagram (Instance->UnicastPort, Mtftp4WrqInput, Instance, 0); +} + diff --git a/NetworkPkg/Network.fdf.inc b/NetworkPkg/Network.fdf.inc index 92e2c56cb8..803a0d64fd 100644 --- a/NetworkPkg/Network.fdf.inc +++ b/NetworkPkg/Network.fdf.inc @@ -11,24 +11,24 @@ # !if $(NETWORK_ENABLE) == TRUE - INF MdeModulePkg/Universal/Network/DpcDxe/DpcDxe.inf + INF NetworkPkg/DpcDxe/DpcDxe.inf !if $(NETWORK_SNP_ENABLE) == TRUE - INF MdeModulePkg/Universal/Network/SnpDxe/SnpDxe.inf + INF NetworkPkg/SnpDxe/SnpDxe.inf !endif !if $(NETWORK_VLAN_ENABLE) == TRUE - INF MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigDxe.inf + INF NetworkPkg/VlanConfigDxe/VlanConfigDxe.inf !endif - INF MdeModulePkg/Universal/Network/MnpDxe/MnpDxe.inf + INF NetworkPkg/MnpDxe/MnpDxe.inf !if $(NETWORK_IP4_ENABLE) == TRUE - INF MdeModulePkg/Universal/Network/ArpDxe/ArpDxe.inf - INF MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Dxe.inf - INF MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Dxe.inf - INF MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Dxe.inf - INF MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Dxe.inf + INF NetworkPkg/ArpDxe/ArpDxe.inf + INF NetworkPkg/Dhcp4Dxe/Dhcp4Dxe.inf + INF NetworkPkg/Ip4Dxe/Ip4Dxe.inf + INF NetworkPkg/Udp4Dxe/Udp4Dxe.inf + INF NetworkPkg/Mtftp4Dxe/Mtftp4Dxe.inf !endif !if $(NETWORK_IP6_ENABLE) == TRUE diff --git a/NetworkPkg/NetworkComponents.dsc.inc b/NetworkPkg/NetworkComponents.dsc.inc index aede5ea8be..40cb8ee18e 100644 --- a/NetworkPkg/NetworkComponents.dsc.inc +++ b/NetworkPkg/NetworkComponents.dsc.inc @@ -13,24 +13,24 @@ ## !if $(NETWORK_ENABLE) == TRUE - MdeModulePkg/Universal/Network/DpcDxe/DpcDxe.inf + NetworkPkg/DpcDxe/DpcDxe.inf !if $(NETWORK_SNP_ENABLE) == TRUE - MdeModulePkg/Universal/Network/SnpDxe/SnpDxe.inf + NetworkPkg/SnpDxe/SnpDxe.inf !endif !if $(NETWORK_VLAN_ENABLE) == TRUE - MdeModulePkg/Universal/Network/VlanConfigDxe/VlanConfigDxe.inf + NetworkPkg/VlanConfigDxe/VlanConfigDxe.inf !endif - MdeModulePkg/Universal/Network/MnpDxe/MnpDxe.inf + NetworkPkg/MnpDxe/MnpDxe.inf !if $(NETWORK_IP4_ENABLE) == TRUE - MdeModulePkg/Universal/Network/ArpDxe/ArpDxe.inf - MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Dxe.inf - MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Dxe.inf - MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Dxe.inf - MdeModulePkg/Universal/Network/Mtftp4Dxe/Mtftp4Dxe.inf + NetworkPkg/ArpDxe/ArpDxe.inf + NetworkPkg/Dhcp4Dxe/Dhcp4Dxe.inf + NetworkPkg/Ip4Dxe/Ip4Dxe.inf + NetworkPkg/Udp4Dxe/Udp4Dxe.inf + NetworkPkg/Mtftp4Dxe/Mtftp4Dxe.inf !endif !if $(NETWORK_IP6_ENABLE) == TRUE diff --git a/NetworkPkg/NetworkLibs.dsc.inc b/NetworkPkg/NetworkLibs.dsc.inc index a23f982381..4b99f48085 100644 --- a/NetworkPkg/NetworkLibs.dsc.inc +++ b/NetworkPkg/NetworkLibs.dsc.inc @@ -11,10 +11,10 @@ # ## - DpcLib|MdeModulePkg/Library/DxeDpcLib/DxeDpcLib.inf - NetLib|MdeModulePkg/Library/DxeNetLib/DxeNetLib.inf - IpIoLib|MdeModulePkg/Library/DxeIpIoLib/DxeIpIoLib.inf - UdpIoLib|MdeModulePkg/Library/DxeUdpIoLib/DxeUdpIoLib.inf - TcpIoLib|MdeModulePkg/Library/DxeTcpIoLib/DxeTcpIoLib.inf + DpcLib|NetworkPkg/Library/DxeDpcLib/DxeDpcLib.inf + NetLib|NetworkPkg/Library/DxeNetLib/DxeNetLib.inf + IpIoLib|NetworkPkg/Library/DxeIpIoLib/DxeIpIoLib.inf + UdpIoLib|NetworkPkg/Library/DxeUdpIoLib/DxeUdpIoLib.inf + TcpIoLib|NetworkPkg/Library/DxeTcpIoLib/DxeTcpIoLib.inf # HttpLib is used for Http Boot - HttpLib|MdeModulePkg/Library/DxeHttpLib/DxeHttpLib.inf + HttpLib|NetworkPkg/Library/DxeHttpLib/DxeHttpLib.inf diff --git a/NetworkPkg/SnpDxe/Callback.c b/NetworkPkg/SnpDxe/Callback.c new file mode 100644 index 0000000000..6387dbdb35 --- /dev/null +++ b/NetworkPkg/SnpDxe/Callback.c @@ -0,0 +1,354 @@ +/** @file + This file contains the callback routines for undi3.1. + the callback routines for Undi3.1 have an extra parameter UniqueId which + stores the interface context for the NIC that snp is trying to talk. + +Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Snp.h" + +/** + Acquire or release a lock of the exclusive access to a critical section of the + code/data. + + This is a callback routine supplied to UNDI3.1 at undi_start time. + New callbacks for 3.1: there won't be a virtual2physical callback for UNDI 3.1 + because undi3.1 uses the MemMap call to map the required address by itself! + + @param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this to + store Undi interface context (Undi does not read or write + this variable). + @param Enable Non-zero indicates acquire; Zero indicates release. + +**/ +VOID +EFIAPI +SnpUndi32CallbackBlock ( + IN UINT64 UniqueId, + IN UINT32 Enable + ) +{ + SNP_DRIVER *Snp; + + Snp = (SNP_DRIVER *) (UINTN) UniqueId; + // + // tcpip was calling snp at tpl_notify and when we acquire a lock that was + // created at a lower level (TPL_CALLBACK) it gives an assert! + // + if (Enable != 0) { + EfiAcquireLock (&Snp->Lock); + } else { + EfiReleaseLock (&Snp->Lock); + } +} + +/** + Delay MicroSeconds of micro seconds. + + This is a callback routine supplied to UNDI at undi_start time. + + @param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this to + store Undi interface context (Undi does not read or write + this variable). + @param MicroSeconds Number of micro seconds to pause, ususlly multiple of 10. + +**/ +VOID +EFIAPI +SnpUndi32CallbackDelay ( + IN UINT64 UniqueId, + IN UINT64 MicroSeconds + ) +{ + if (MicroSeconds != 0) { + gBS->Stall ((UINTN) MicroSeconds); + } +} + +/** + IO routine for UNDI3.1. + + This is a callback routine supplied to UNDI at undi_start time. + + @param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this + to store Undi interface context (Undi does not read or + write this variable). + @param ReadOrWrite Indicates read or write, IO or Memory. + @param NumBytes Number of bytes to read or write. + @param MemOrPortAddr IO or memory address to read from or write to. + @param BufferPtr Memory location to read into or that contains the bytes + to write. + +**/ +VOID +EFIAPI +SnpUndi32CallbackMemio ( + IN UINT64 UniqueId, + IN UINT8 ReadOrWrite, + IN UINT8 NumBytes, + IN UINT64 MemOrPortAddr, + IN OUT UINT64 BufferPtr + ) +{ + SNP_DRIVER *Snp; + EFI_PCI_IO_PROTOCOL_WIDTH Width; + + Snp = (SNP_DRIVER *) (UINTN) UniqueId; + + Width = (EFI_PCI_IO_PROTOCOL_WIDTH) 0; + switch (NumBytes) { + case 2: + Width = (EFI_PCI_IO_PROTOCOL_WIDTH) 1; + break; + + case 4: + Width = (EFI_PCI_IO_PROTOCOL_WIDTH) 2; + break; + + case 8: + Width = (EFI_PCI_IO_PROTOCOL_WIDTH) 3; + break; + } + + switch (ReadOrWrite) { + case PXE_IO_READ: + Snp->PciIo->Io.Read ( + Snp->PciIo, + Width, + Snp->IoBarIndex, // BAR 1 (for 32bit regs), IO base address + MemOrPortAddr, + 1, // count + (VOID *) (UINTN) BufferPtr + ); + break; + + case PXE_IO_WRITE: + Snp->PciIo->Io.Write ( + Snp->PciIo, + Width, + Snp->IoBarIndex, // BAR 1 (for 32bit regs), IO base address + MemOrPortAddr, + 1, // count + (VOID *) (UINTN) BufferPtr + ); + break; + + case PXE_MEM_READ: + Snp->PciIo->Mem.Read ( + Snp->PciIo, + Width, + Snp->MemoryBarIndex, // BAR 0, Memory base address + MemOrPortAddr, + 1, // count + (VOID *) (UINTN) BufferPtr + ); + break; + + case PXE_MEM_WRITE: + Snp->PciIo->Mem.Write ( + Snp->PciIo, + Width, + Snp->MemoryBarIndex, // BAR 0, Memory base address + MemOrPortAddr, + 1, // count + (VOID *) (UINTN) BufferPtr + ); + break; + } + + return ; +} + +/** + Map a CPU address to a device address. + + This is a callback routine supplied to UNDI at undi_start time. + + @param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this to + store Undi interface context (Undi does not read or write + this variable). + @param CpuAddr Virtual address to be mapped. + @param NumBytes Size of memory to be mapped. + @param Direction Direction of data flow for this memory's usage: + cpu->device, device->cpu or both ways. + @param DeviceAddrPtr Pointer to return the mapped device address. + +**/ +VOID +EFIAPI +SnpUndi32CallbackMap ( + IN UINT64 UniqueId, + IN UINT64 CpuAddr, + IN UINT32 NumBytes, + IN UINT32 Direction, + IN OUT UINT64 DeviceAddrPtr + ) +{ + EFI_PHYSICAL_ADDRESS *DevAddrPtr; + EFI_PCI_IO_PROTOCOL_OPERATION DirectionFlag; + UINTN BuffSize; + SNP_DRIVER *Snp; + UINTN Index; + EFI_STATUS Status; + + BuffSize = (UINTN) NumBytes; + Snp = (SNP_DRIVER *) (UINTN) UniqueId; + DevAddrPtr = (EFI_PHYSICAL_ADDRESS *) (UINTN) DeviceAddrPtr; + + if (CpuAddr == 0) { + *DevAddrPtr = 0; + return ; + } + + switch (Direction) { + case TO_AND_FROM_DEVICE: + DirectionFlag = EfiPciIoOperationBusMasterCommonBuffer; + break; + + case FROM_DEVICE: + DirectionFlag = EfiPciIoOperationBusMasterWrite; + break; + + case TO_DEVICE: + DirectionFlag = EfiPciIoOperationBusMasterRead; + break; + + default: + *DevAddrPtr = 0; + // + // any non zero indicates error! + // + return ; + } + // + // find an unused map_list entry + // + for (Index = 0; Index < MAX_MAP_LENGTH; Index++) { + if (Snp->MapList[Index].VirtualAddress == 0) { + break; + } + } + + if (Index >= MAX_MAP_LENGTH) { + DEBUG ((EFI_D_INFO, "SNP maplist is FULL\n")); + *DevAddrPtr = 0; + return ; + } + + Snp->MapList[Index].VirtualAddress = (EFI_PHYSICAL_ADDRESS) CpuAddr; + + Status = Snp->PciIo->Map ( + Snp->PciIo, + DirectionFlag, + (VOID *) (UINTN) CpuAddr, + &BuffSize, + DevAddrPtr, + &(Snp->MapList[Index].MapCookie) + ); + if (Status != EFI_SUCCESS) { + *DevAddrPtr = 0; + Snp->MapList[Index].VirtualAddress = 0; + } + + return ; +} + +/** + Unmap an address that was previously mapped using map callback. + + This is a callback routine supplied to UNDI at undi_start time. + + @param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this to + store. Undi interface context (Undi does not read or write + this variable). + @param CpuAddr Virtual address that was mapped. + @param NumBytes Size of memory mapped. + @param Direction Direction of data flow for this memory's usage: + cpu->device, device->cpu or both ways. + @param DeviceAddr The mapped device address. + +**/ +VOID +EFIAPI +SnpUndi32CallbackUnmap ( + IN UINT64 UniqueId, + IN UINT64 CpuAddr, + IN UINT32 NumBytes, + IN UINT32 Direction, + IN UINT64 DeviceAddr + ) +{ + SNP_DRIVER *Snp; + UINT16 Index; + + Snp = (SNP_DRIVER *) (UINTN) UniqueId; + + for (Index = 0; Index < MAX_MAP_LENGTH; Index++) { + if (Snp->MapList[Index].VirtualAddress == CpuAddr) { + break; + } + } + + if (Index >= MAX_MAP_LENGTH) { + DEBUG ((EFI_D_ERROR, "SNP could not find a mapping, failed to unmap.\n")); + return ; + } + + Snp->PciIo->Unmap (Snp->PciIo, Snp->MapList[Index].MapCookie); + Snp->MapList[Index].VirtualAddress = 0; + Snp->MapList[Index].MapCookie = NULL; + return ; +} + +/** + Synchronize the virtual buffer contents with the mapped buffer contents. + + This is a callback routine supplied to UNDI at undi_start time. The virtual + and mapped buffers need not correspond to the same physical memory (especially + if the virtual address is > 4GB). Depending on the direction for which the + buffer is mapped, undi will need to synchronize their contents whenever it + writes to/reads from the buffer using either the cpu address or the device + address. + EFI does not provide a sync call since virt=physical, we should just do the + synchronization ourselves here. + + @param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this to + store Undi interface context (Undi does not read or write + this variable). + @param CpuAddr Virtual address that was mapped. + @param NumBytes Size of memory mapped. + @param Direction Direction of data flow for this memory's usage: + cpu->device, device->cpu or both ways. + @param DeviceAddr The mapped device address. + +**/ +VOID +EFIAPI +SnpUndi32CallbackSync ( + IN UINT64 UniqueId, + IN UINT64 CpuAddr, + IN UINT32 NumBytes, + IN UINT32 Direction, + IN UINT64 DeviceAddr + ) +{ + if ((CpuAddr == 0) || (DeviceAddr == 0) || (NumBytes == 0)) { + return ; + + } + + switch (Direction) { + case FROM_DEVICE: + CopyMem ((UINT8 *) (UINTN) CpuAddr, (UINT8 *) (UINTN) DeviceAddr, NumBytes); + break; + + case TO_DEVICE: + CopyMem ((UINT8 *) (UINTN) DeviceAddr, (UINT8 *) (UINTN) CpuAddr, NumBytes); + break; + } + + return ; +} diff --git a/NetworkPkg/SnpDxe/ComponentName.c b/NetworkPkg/SnpDxe/ComponentName.c new file mode 100644 index 0000000000..2139e2a47f --- /dev/null +++ b/NetworkPkg/SnpDxe/ComponentName.c @@ -0,0 +1,430 @@ +/** @file + UEFI Component Name(2) protocol implementation for SnpDxe driver. + +Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + + +#include "Snp.h" + +// +// EFI Component Name Functions +// +/** + Retrieves a Unicode string that is the user readable name of the driver. + + This function retrieves the user readable name of a driver in the form of a + Unicode string. If the driver specified by This has a user readable name in + the language specified by Language, then a pointer to the driver name is + returned in DriverName, and EFI_SUCCESS is returned. If the driver specified + by This does not support the language specified by Language, + then EFI_UNSUPPORTED is returned. + + @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param Language[in] A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified + in RFC 4646 or ISO 639-2 language code format. + + @param DriverName[out] A pointer to the Unicode string to return. + This Unicode string is the name of the + driver specified by This in the language + specified by Language. + + @retval EFI_SUCCESS The Unicode string for the Driver specified by + This and the language specified by Language was + returned in DriverName. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER DriverName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +SimpleNetworkComponentNameGetDriverName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN CHAR8 *Language, + OUT CHAR16 **DriverName + ); + + +/** + Retrieves a Unicode string that is the user readable name of the controller + that is being managed by a driver. + + This function retrieves the user readable name of the controller specified by + ControllerHandle and ChildHandle in the form of a Unicode string. If the + driver specified by This has a user readable name in the language specified by + Language, then a pointer to the controller name is returned in ControllerName, + and EFI_SUCCESS is returned. If the driver specified by This is not currently + managing the controller specified by ControllerHandle and ChildHandle, + then EFI_UNSUPPORTED is returned. If the driver specified by This does not + support the language specified by Language, then EFI_UNSUPPORTED is returned. + + @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param ControllerHandle[in] The handle of a controller that the driver + specified by This is managing. This handle + specifies the controller whose name is to be + returned. + + @param ChildHandle[in] The handle of the child controller to retrieve + the name of. This is an optional parameter that + may be NULL. It will be NULL for device + drivers. It will also be NULL for a bus drivers + that wish to retrieve the name of the bus + controller. It will not be NULL for a bus + driver that wishes to retrieve the name of a + child controller. + + @param Language[in] A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified in + RFC 4646 or ISO 639-2 language code format. + + @param ControllerName[out] A pointer to the Unicode string to return. + This Unicode string is the name of the + controller specified by ControllerHandle and + ChildHandle in the language specified by + Language from the point of view of the driver + specified by This. + + @retval EFI_SUCCESS The Unicode string for the user readable name in + the language specified by Language for the + driver specified by This was returned in + DriverName. + + @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. + + @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid + EFI_HANDLE. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER ControllerName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This is not currently + managing the controller specified by + ControllerHandle and ChildHandle. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +SimpleNetworkComponentNameGetControllerName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_HANDLE ChildHandle OPTIONAL, + IN CHAR8 *Language, + OUT CHAR16 **ControllerName + ); + + +// +// EFI Component Name Protocol +// +GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gSimpleNetworkComponentName = { + SimpleNetworkComponentNameGetDriverName, + SimpleNetworkComponentNameGetControllerName, + "eng" +}; + +// +// EFI Component Name 2 Protocol +// +GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gSimpleNetworkComponentName2 = { + (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) SimpleNetworkComponentNameGetDriverName, + (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) SimpleNetworkComponentNameGetControllerName, + "en" +}; + + +GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mSimpleNetworkDriverNameTable[] = { + { + "eng;en", + L"Simple Network Protocol Driver" + }, + { + NULL, + NULL + } +}; + +GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE *gSimpleNetworkControllerNameTable = NULL; + +/** + Retrieves a Unicode string that is the user readable name of the driver. + + This function retrieves the user readable name of a driver in the form of a + Unicode string. If the driver specified by This has a user readable name in + the language specified by Language, then a pointer to the driver name is + returned in DriverName, and EFI_SUCCESS is returned. If the driver specified + by This does not support the language specified by Language, + then EFI_UNSUPPORTED is returned. + + @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param Language[in] A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified + in RFC 4646 or ISO 639-2 language code format. + + @param DriverName[out] A pointer to the Unicode string to return. + This Unicode string is the name of the + driver specified by This in the language + specified by Language. + + @retval EFI_SUCCESS The Unicode string for the Driver specified by + This and the language specified by Language was + returned in DriverName. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER DriverName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +SimpleNetworkComponentNameGetDriverName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN CHAR8 *Language, + OUT CHAR16 **DriverName + ) +{ + return LookupUnicodeString2 ( + Language, + This->SupportedLanguages, + mSimpleNetworkDriverNameTable, + DriverName, + (BOOLEAN)(This == &gSimpleNetworkComponentName) + ); +} + +/** + Update the component name for the Snp child handle. + + @param Snp[in] A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL. + + + @retval EFI_SUCCESS Update the ControllerNameTable of this instance successfully. + @retval EFI_INVALID_PARAMETER The input parameter is invalid. + +**/ +EFI_STATUS +UpdateName ( + IN EFI_SIMPLE_NETWORK_PROTOCOL *Snp + ) +{ + EFI_STATUS Status; + CHAR16 HandleName[80]; + UINTN OffSet; + UINTN Index; + + if (Snp == NULL) { + return EFI_INVALID_PARAMETER; + } + + OffSet = 0; + OffSet += UnicodeSPrint ( + HandleName, + sizeof (HandleName), + L"SNP (MAC=" + ); + for (Index = 0; Index < Snp->Mode->HwAddressSize; Index++) { + OffSet += UnicodeSPrint ( + HandleName + OffSet, + sizeof (HandleName) - OffSet * sizeof (CHAR16), + L"%02X-", + Snp->Mode->CurrentAddress.Addr[Index] + ); + } + ASSERT (OffSet > 0); + // + // Remove the last '-' + // + OffSet--; + OffSet += UnicodeSPrint ( + HandleName + OffSet, + sizeof (HandleName) - OffSet * sizeof (CHAR16), + L")" + ); + if (gSimpleNetworkControllerNameTable != NULL) { + FreeUnicodeStringTable (gSimpleNetworkControllerNameTable); + gSimpleNetworkControllerNameTable = NULL; + } + + Status = AddUnicodeString2 ( + "eng", + gSimpleNetworkComponentName.SupportedLanguages, + &gSimpleNetworkControllerNameTable, + HandleName, + TRUE + ); + if (EFI_ERROR (Status)) { + return Status; + } + + return AddUnicodeString2 ( + "en", + gSimpleNetworkComponentName2.SupportedLanguages, + &gSimpleNetworkControllerNameTable, + HandleName, + FALSE + ); +} + +/** + Retrieves a Unicode string that is the user readable name of the controller + that is being managed by a driver. + + This function retrieves the user readable name of the controller specified by + ControllerHandle and ChildHandle in the form of a Unicode string. If the + driver specified by This has a user readable name in the language specified by + Language, then a pointer to the controller name is returned in ControllerName, + and EFI_SUCCESS is returned. If the driver specified by This is not currently + managing the controller specified by ControllerHandle and ChildHandle, + then EFI_UNSUPPORTED is returned. If the driver specified by This does not + support the language specified by Language, then EFI_UNSUPPORTED is returned. + Currently not implemented. + + @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param ControllerHandle[in] The handle of a controller that the driver + specified by This is managing. This handle + specifies the controller whose name is to be + returned. + + @param ChildHandle[in] The handle of the child controller to retrieve + the name of. This is an optional parameter that + may be NULL. It will be NULL for device + drivers. It will also be NULL for a bus drivers + that wish to retrieve the name of the bus + controller. It will not be NULL for a bus + driver that wishes to retrieve the name of a + child controller. + + @param Language[in] A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified in + RFC 4646 or ISO 639-2 language code format. + + @param ControllerName[out] A pointer to the Unicode string to return. + This Unicode string is the name of the + controller specified by ControllerHandle and + ChildHandle in the language specified by + Language from the point of view of the driver + specified by This. + + @retval EFI_SUCCESS The Unicode string for the user readable name in + the language specified by Language for the + driver specified by This was returned in + DriverName. + + @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. + + @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid + EFI_HANDLE. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER ControllerName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This is not currently + managing the controller specified by + ControllerHandle and ChildHandle. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +SimpleNetworkComponentNameGetControllerName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_HANDLE ChildHandle OPTIONAL, + IN CHAR8 *Language, + OUT CHAR16 **ControllerName + ) +{ + EFI_STATUS Status; + EFI_SIMPLE_NETWORK_PROTOCOL *Snp; + + if (ChildHandle != NULL) { + return EFI_UNSUPPORTED; + } + + // + // Make sure this driver is currently managing ControllHandle + // + Status = EfiTestManagedDevice ( + ControllerHandle, + gSimpleNetworkDriverBinding.DriverBindingHandle, + &gEfiSimpleNetworkProtocolGuid + ); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Retrieve an instance of a produced protocol from ControllerHandle + // + Status = gBS->OpenProtocol ( + ControllerHandle, + &gEfiSimpleNetworkProtocolGuid, + (VOID **)&Snp, + NULL, + NULL, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + if (EFI_ERROR (Status)) { + return Status; + } + // + // Update the component name for this child handle. + // + Status = UpdateName (Snp); + if (EFI_ERROR (Status)) { + return Status; + } + + return LookupUnicodeString2 ( + Language, + This->SupportedLanguages, + gSimpleNetworkControllerNameTable, + ControllerName, + (BOOLEAN)(This == &gSimpleNetworkComponentName) + ); +} diff --git a/NetworkPkg/SnpDxe/Get_status.c b/NetworkPkg/SnpDxe/Get_status.c new file mode 100644 index 0000000000..be6608a0b3 --- /dev/null +++ b/NetworkPkg/SnpDxe/Get_status.c @@ -0,0 +1,257 @@ +/** @file + Implementation of reading the current interrupt status and recycled transmit + buffer status from a network interface. + +Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Snp.h" + +/** + Call undi to get the status of the interrupts, get the list of recycled transmit + buffers that completed transmitting. The recycled transmit buffer address will + be saved into Snp->RecycledTxBuf. This function will also update the MediaPresent + field of EFI_SIMPLE_NETWORK_MODE if UNDI support it. + + @param[in] Snp Pointer to snp driver structure. + @param[out] InterruptStatusPtr A non null pointer to contain the interrupt + status. + @param[in] GetTransmittedBuf Set to TRUE to retrieve the recycled transmit + buffer address. + + @retval EFI_SUCCESS The status of the network interface was retrieved. + @retval EFI_DEVICE_ERROR The command could not be sent to the network + interface. + +**/ +EFI_STATUS +PxeGetStatus ( + IN SNP_DRIVER *Snp, + OUT UINT32 *InterruptStatusPtr, + IN BOOLEAN GetTransmittedBuf + ) +{ + PXE_DB_GET_STATUS *Db; + UINT16 InterruptFlags; + UINT32 Index; + UINT64 *Tmp; + + Tmp = NULL; + Db = Snp->Db; + Snp->Cdb.OpCode = PXE_OPCODE_GET_STATUS; + + Snp->Cdb.OpFlags = 0; + + if (GetTransmittedBuf) { + Snp->Cdb.OpFlags |= PXE_OPFLAGS_GET_TRANSMITTED_BUFFERS; + ZeroMem (Db->TxBuffer, sizeof (Db->TxBuffer)); + } + + if (InterruptStatusPtr != NULL) { + Snp->Cdb.OpFlags |= PXE_OPFLAGS_GET_INTERRUPT_STATUS; + } + + if (Snp->MediaStatusSupported) { + Snp->Cdb.OpFlags |= PXE_OPFLAGS_GET_MEDIA_STATUS; + } + + Snp->Cdb.CPBsize = PXE_CPBSIZE_NOT_USED; + Snp->Cdb.CPBaddr = PXE_CPBADDR_NOT_USED; + + Snp->Cdb.DBsize = (UINT16) sizeof (PXE_DB_GET_STATUS); + Snp->Cdb.DBaddr = (UINT64)(UINTN) Db; + + Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; + Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; + Snp->Cdb.IFnum = Snp->IfNum; + Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; + + // + // Issue UNDI command and check result. + // + DEBUG ((EFI_D_NET, "\nSnp->undi.get_status() ")); + + (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); + + if (Snp->Cdb.StatCode != PXE_STATCODE_SUCCESS) { + DEBUG ( + (EFI_D_NET, + "\nSnp->undi.get_status() %xh:%xh\n", + Snp->Cdb.StatFlags, + Snp->Cdb.StatCode) + ); + + return EFI_DEVICE_ERROR; + } + // + // report the values back.. + // + if (InterruptStatusPtr != NULL) { + InterruptFlags = (UINT16) (Snp->Cdb.StatFlags & PXE_STATFLAGS_GET_STATUS_INTERRUPT_MASK); + + *InterruptStatusPtr = 0; + + if ((InterruptFlags & PXE_STATFLAGS_GET_STATUS_RECEIVE) == PXE_STATFLAGS_GET_STATUS_RECEIVE) { + *InterruptStatusPtr |= EFI_SIMPLE_NETWORK_RECEIVE_INTERRUPT; + } + + if ((InterruptFlags & PXE_STATFLAGS_GET_STATUS_TRANSMIT) == PXE_STATFLAGS_GET_STATUS_TRANSMIT) { + *InterruptStatusPtr |= EFI_SIMPLE_NETWORK_TRANSMIT_INTERRUPT; + } + + if ((InterruptFlags & PXE_STATFLAGS_GET_STATUS_COMMAND) == PXE_STATFLAGS_GET_STATUS_COMMAND) { + *InterruptStatusPtr |= EFI_SIMPLE_NETWORK_COMMAND_INTERRUPT; + } + + if ((InterruptFlags & PXE_STATFLAGS_GET_STATUS_SOFTWARE) == PXE_STATFLAGS_GET_STATUS_SOFTWARE) { + *InterruptStatusPtr |= EFI_SIMPLE_NETWORK_COMMAND_INTERRUPT; + } + + } + + if (GetTransmittedBuf) { + if ((Snp->Cdb.StatFlags & PXE_STATFLAGS_GET_STATUS_NO_TXBUFS_WRITTEN) == 0) { + // + // UNDI has written some transmitted buffer addresses into the DB. Store them into Snp->RecycledTxBuf. + // + for (Index = 0; Index < MAX_XMIT_BUFFERS; Index++) { + if (Db->TxBuffer[Index] != 0) { + if (Snp->RecycledTxBufCount == Snp->MaxRecycledTxBuf) { + // + // Snp->RecycledTxBuf is full, reallocate a new one. + // + if ((Snp->MaxRecycledTxBuf + SNP_TX_BUFFER_INCREASEMENT) >= SNP_MAX_TX_BUFFER_NUM) { + return EFI_DEVICE_ERROR; + } + Tmp = AllocatePool (sizeof (UINT64) * (Snp->MaxRecycledTxBuf + SNP_TX_BUFFER_INCREASEMENT)); + if (Tmp == NULL) { + return EFI_DEVICE_ERROR; + } + CopyMem (Tmp, Snp->RecycledTxBuf, sizeof (UINT64) * Snp->RecycledTxBufCount); + FreePool (Snp->RecycledTxBuf); + Snp->RecycledTxBuf = Tmp; + Snp->MaxRecycledTxBuf += SNP_TX_BUFFER_INCREASEMENT; + } + Snp->RecycledTxBuf[Snp->RecycledTxBufCount] = Db->TxBuffer[Index]; + Snp->RecycledTxBufCount++; + } + } + } + } + + // + // Update MediaPresent field of EFI_SIMPLE_NETWORK_MODE if the UNDI support + // returning media status from GET_STATUS command + // + if (Snp->MediaStatusSupported) { + Snp->Snp.Mode->MediaPresent = + (BOOLEAN) (((Snp->Cdb.StatFlags & PXE_STATFLAGS_GET_STATUS_NO_MEDIA) != 0) ? FALSE : TRUE); + } + + return EFI_SUCCESS; +} + +/** + Reads the current interrupt status and recycled transmit buffer status from a + network interface. + + This function gets the current interrupt and recycled transmit buffer status + from the network interface. The interrupt status is returned as a bit mask in + InterruptStatus. If InterruptStatus is NULL, the interrupt status will not be + read. If TxBuf is not NULL, a recycled transmit buffer address will be retrieved. + If a recycled transmit buffer address is returned in TxBuf, then the buffer has + been successfully transmitted, and the status for that buffer is cleared. If + the status of the network interface is successfully collected, EFI_SUCCESS + will be returned. If the driver has not been initialized, EFI_DEVICE_ERROR will + be returned. + + @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. + @param InterruptStatus A pointer to the bit mask of the currently active + interrupts (see "Related Definitions"). If this is NULL, + the interrupt status will not be read from the device. + If this is not NULL, the interrupt status will be read + from the device. When the interrupt status is read, it + will also be cleared. Clearing the transmit interrupt does + not empty the recycled transmit buffer array. + @param TxBuf Recycled transmit buffer address. The network interface + will not transmit if its internal recycled transmit + buffer array is full. Reading the transmit buffer does + not clear the transmit interrupt. If this is NULL, then + the transmit buffer status will not be read. If there + are no transmit buffers to recycle and TxBuf is not NULL, + TxBuf will be set to NULL. + + @retval EFI_SUCCESS The status of the network interface was retrieved. + @retval EFI_NOT_STARTED The network interface has not been started. + @retval EFI_INVALID_PARAMETER This parameter was NULL or did not point to a valid + EFI_SIMPLE_NETWORK_PROTOCOL structure. + @retval EFI_DEVICE_ERROR The command could not be sent to the network + interface. + +**/ +EFI_STATUS +EFIAPI +SnpUndi32GetStatus ( + IN EFI_SIMPLE_NETWORK_PROTOCOL *This, + OUT UINT32 *InterruptStatus, OPTIONAL + OUT VOID **TxBuf OPTIONAL + ) +{ + SNP_DRIVER *Snp; + EFI_TPL OldTpl; + EFI_STATUS Status; + + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + if (InterruptStatus == NULL && TxBuf == NULL) { + return EFI_INVALID_PARAMETER; + } + + Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This); + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + if (Snp == NULL) { + return EFI_DEVICE_ERROR; + } + + switch (Snp->Mode.State) { + case EfiSimpleNetworkInitialized: + break; + + case EfiSimpleNetworkStopped: + Status = EFI_NOT_STARTED; + goto ON_EXIT; + + default: + Status = EFI_DEVICE_ERROR; + goto ON_EXIT; + } + + if (Snp->RecycledTxBufCount == 0 && TxBuf != NULL) { + Status = PxeGetStatus (Snp, InterruptStatus, TRUE); + } else { + Status = PxeGetStatus (Snp, InterruptStatus, FALSE); + } + + if (TxBuf != NULL) { + // + // Get a recycled buf from Snp->RecycledTxBuf + // + if (Snp->RecycledTxBufCount == 0) { + *TxBuf = NULL; + } else { + Snp->RecycledTxBufCount--; + *TxBuf = (VOID *) (UINTN) Snp->RecycledTxBuf[Snp->RecycledTxBufCount]; + } + } + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + + return Status; +} diff --git a/NetworkPkg/SnpDxe/Initialize.c b/NetworkPkg/SnpDxe/Initialize.c new file mode 100644 index 0000000000..4d33154241 --- /dev/null +++ b/NetworkPkg/SnpDxe/Initialize.c @@ -0,0 +1,277 @@ +/** @file + Implementation of initializing a network adapter. + +Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + + +#include "Snp.h" + +/** + Call UNDI to initialize the interface. + + @param Snp Pointer to snp driver structure. + @param CableDetectFlag Do/don't detect the cable (depending on what + undi supports). + + @retval EFI_SUCCESS UNDI is initialized successfully. + @retval EFI_DEVICE_ERROR UNDI could not be initialized. + @retval Other Other errors as indicated. + +**/ +EFI_STATUS +PxeInit ( + SNP_DRIVER *Snp, + UINT16 CableDetectFlag + ) +{ + PXE_CPB_INITIALIZE *Cpb; + VOID *Addr; + EFI_STATUS Status; + + Status = EFI_SUCCESS; + + Cpb = Snp->Cpb; + if (Snp->TxRxBufferSize != 0) { + Status = Snp->PciIo->AllocateBuffer ( + Snp->PciIo, + AllocateAnyPages, + EfiBootServicesData, + SNP_MEM_PAGES (Snp->TxRxBufferSize), + &Addr, + 0 + ); + + if (Status != EFI_SUCCESS) { + DEBUG ( + (EFI_D_ERROR, + "\nSnp->PxeInit() AllocateBuffer %xh (%r)\n", + Status, + Status) + ); + + return Status; + } + + ASSERT (Addr); + + Snp->TxRxBuffer = Addr; + } + + Cpb->MemoryAddr = (UINT64)(UINTN) Snp->TxRxBuffer; + + Cpb->MemoryLength = Snp->TxRxBufferSize; + + // + // let UNDI decide/detect these values + // + Cpb->LinkSpeed = 0; + Cpb->TxBufCnt = 0; + Cpb->TxBufSize = 0; + Cpb->RxBufCnt = 0; + Cpb->RxBufSize = 0; + + Cpb->DuplexMode = PXE_DUPLEX_DEFAULT; + + Cpb->LoopBackMode = LOOPBACK_NORMAL; + + Snp->Cdb.OpCode = PXE_OPCODE_INITIALIZE; + Snp->Cdb.OpFlags = CableDetectFlag; + + Snp->Cdb.CPBsize = (UINT16) sizeof (PXE_CPB_INITIALIZE); + Snp->Cdb.DBsize = (UINT16) sizeof (PXE_DB_INITIALIZE); + + Snp->Cdb.CPBaddr = (UINT64)(UINTN) Snp->Cpb; + Snp->Cdb.DBaddr = (UINT64)(UINTN) Snp->Db; + + Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; + Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; + Snp->Cdb.IFnum = Snp->IfNum; + Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; + + DEBUG ((EFI_D_NET, "\nSnp->undi.initialize() ")); + + (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); + + // + // There are two fields need to be checked here: + // First is the upper two bits (14 & 15) in the CDB.StatFlags field. Until these bits change to report + // PXE_STATFLAGS_COMMAND_COMPLETE or PXE_STATFLAGS_COMMAND_FAILED, the command has not been executed by the UNDI. + // Second is the CDB.StatCode field. After command execution completes, either successfully or not, + // the CDB.StatCode field contains the result of the command execution. + // + if ((((Snp->Cdb.StatFlags) & PXE_STATFLAGS_STATUS_MASK) == PXE_STATFLAGS_COMMAND_COMPLETE) && + (Snp->Cdb.StatCode == PXE_STATCODE_SUCCESS)) { + // + // If cable detect feature is enabled in CDB.OpFlags, check the CDB.StatFlags to see if there is an + // active connection to this network device. If the no media StatFlag is set, the UNDI and network + // device are still initialized. + // + if (CableDetectFlag == PXE_OPFLAGS_INITIALIZE_DETECT_CABLE) { + if(((Snp->Cdb.StatFlags) & PXE_STATFLAGS_INITIALIZED_NO_MEDIA) != PXE_STATFLAGS_INITIALIZED_NO_MEDIA) { + Snp->Mode.MediaPresent = TRUE; + } else { + Snp->Mode.MediaPresent = FALSE; + } + } + + Snp->Mode.State = EfiSimpleNetworkInitialized; + Status = EFI_SUCCESS; + } else { + DEBUG ( + (EFI_D_WARN, + "\nSnp->undi.initialize() %xh:%xh\n", + Snp->Cdb.StatFlags, + Snp->Cdb.StatCode) + ); + + if (Snp->TxRxBuffer != NULL) { + Snp->PciIo->FreeBuffer ( + Snp->PciIo, + SNP_MEM_PAGES (Snp->TxRxBufferSize), + (VOID *) Snp->TxRxBuffer + ); + } + + Snp->TxRxBuffer = NULL; + + Status = EFI_DEVICE_ERROR; + } + + return Status; +} + + +/** + Resets a network adapter and allocates the transmit and receive buffers + required by the network interface; optionally, also requests allocation of + additional transmit and receive buffers. + + This function allocates the transmit and receive buffers required by the network + interface. If this allocation fails, then EFI_OUT_OF_RESOURCES is returned. + If the allocation succeeds and the network interface is successfully initialized, + then EFI_SUCCESS will be returned. + + @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. + + @param ExtraRxBufferSize The size, in bytes, of the extra receive buffer space + that the driver should allocate for the network interface. + Some network interfaces will not be able to use the + extra buffer, and the caller will not know if it is + actually being used. + @param ExtraTxBufferSize The size, in bytes, of the extra transmit buffer space + that the driver should allocate for the network interface. + Some network interfaces will not be able to use the + extra buffer, and the caller will not know if it is + actually being used. + + @retval EFI_SUCCESS The network interface was initialized. + @retval EFI_NOT_STARTED The network interface has not been started. + @retval EFI_OUT_OF_RESOURCES There was not enough memory for the transmit and + receive buffers. + @retval EFI_INVALID_PARAMETER This parameter was NULL or did not point to a valid + EFI_SIMPLE_NETWORK_PROTOCOL structure. + @retval EFI_DEVICE_ERROR The command could not be sent to the network interface. + @retval EFI_UNSUPPORTED The increased buffer size feature is not supported. + +**/ +EFI_STATUS +EFIAPI +SnpUndi32Initialize ( + IN EFI_SIMPLE_NETWORK_PROTOCOL *This, + IN UINTN ExtraRxBufferSize OPTIONAL, + IN UINTN ExtraTxBufferSize OPTIONAL + ) +{ + EFI_STATUS EfiStatus; + SNP_DRIVER *Snp; + EFI_TPL OldTpl; + + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This); + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + if (Snp == NULL) { + EfiStatus = EFI_INVALID_PARAMETER; + goto ON_EXIT; + } + + switch (Snp->Mode.State) { + case EfiSimpleNetworkStarted: + break; + + case EfiSimpleNetworkStopped: + EfiStatus = EFI_NOT_STARTED; + goto ON_EXIT; + + default: + EfiStatus = EFI_DEVICE_ERROR; + goto ON_EXIT; + } + + EfiStatus = gBS->CreateEvent ( + EVT_NOTIFY_WAIT, + TPL_NOTIFY, + &SnpWaitForPacketNotify, + Snp, + &Snp->Snp.WaitForPacket + ); + + if (EFI_ERROR (EfiStatus)) { + Snp->Snp.WaitForPacket = NULL; + EfiStatus = EFI_DEVICE_ERROR; + goto ON_EXIT; + } + // + // + // + Snp->Mode.MCastFilterCount = 0; + Snp->Mode.ReceiveFilterSetting = 0; + ZeroMem (Snp->Mode.MCastFilter, sizeof Snp->Mode.MCastFilter); + CopyMem ( + &Snp->Mode.CurrentAddress, + &Snp->Mode.PermanentAddress, + sizeof (EFI_MAC_ADDRESS) + ); + + // + // Compute tx/rx buffer sizes based on UNDI init info and parameters. + // + Snp->TxRxBufferSize = (UINT32) (Snp->InitInfo.MemoryRequired + ExtraRxBufferSize + ExtraTxBufferSize); + + // + // If UNDI support cable detect for INITIALIZE command, try it first. + // + if (Snp->CableDetectSupported) { + if (PxeInit (Snp, PXE_OPFLAGS_INITIALIZE_DETECT_CABLE) == EFI_SUCCESS) { + goto ON_EXIT; + } + } + + Snp->Mode.MediaPresent = FALSE; + + EfiStatus = PxeInit (Snp, PXE_OPFLAGS_INITIALIZE_DO_NOT_DETECT_CABLE); + + if (EFI_ERROR (EfiStatus)) { + gBS->CloseEvent (Snp->Snp.WaitForPacket); + goto ON_EXIT; + } + + // + // Try to update the MediaPresent field of EFI_SIMPLE_NETWORK_MODE if the UNDI support it. + // + if (Snp->MediaStatusSupported) { + PxeGetStatus (Snp, NULL, FALSE); + } + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + + return EfiStatus; +} diff --git a/NetworkPkg/SnpDxe/Mcast_ip_to_mac.c b/NetworkPkg/SnpDxe/Mcast_ip_to_mac.c new file mode 100644 index 0000000000..9863c1f9ea --- /dev/null +++ b/NetworkPkg/SnpDxe/Mcast_ip_to_mac.c @@ -0,0 +1,173 @@ +/** @file + Implementation of converting an multicast IP address to multicast HW MAC + address. + +Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Snp.h" + +/** + Call undi to convert an multicast IP address to a MAC address. + + @param Snp Pointer to snp driver structure. + @param IPv6 Flag to indicate if this is an ipv6 address. + @param IP Multicast IP address. + @param MAC Pointer to hold the return MAC address. + + @retval EFI_SUCCESS The multicast IP address was mapped to the + multicast HW MAC address. + @retval EFI_INVALID_PARAMETER Invalid UNDI command. + @retval EFI_UNSUPPORTED Command is not supported by UNDI. + @retval EFI_DEVICE_ERROR Fail to execute UNDI command. + +**/ +EFI_STATUS +PxeIp2Mac ( + IN SNP_DRIVER *Snp, + IN BOOLEAN IPv6, + IN EFI_IP_ADDRESS *IP, + IN OUT EFI_MAC_ADDRESS *MAC + ) +{ + PXE_CPB_MCAST_IP_TO_MAC *Cpb; + PXE_DB_MCAST_IP_TO_MAC *Db; + + Cpb = Snp->Cpb; + Db = Snp->Db; + Snp->Cdb.OpCode = PXE_OPCODE_MCAST_IP_TO_MAC; + Snp->Cdb.OpFlags = (UINT16) (IPv6 ? PXE_OPFLAGS_MCAST_IPV6_TO_MAC : PXE_OPFLAGS_MCAST_IPV4_TO_MAC); + Snp->Cdb.CPBsize = (UINT16) sizeof (PXE_CPB_MCAST_IP_TO_MAC); + Snp->Cdb.DBsize = (UINT16) sizeof (PXE_DB_MCAST_IP_TO_MAC); + + Snp->Cdb.CPBaddr = (UINT64)(UINTN) Cpb; + Snp->Cdb.DBaddr = (UINT64)(UINTN) Db; + + Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; + Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; + Snp->Cdb.IFnum = Snp->IfNum; + Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; + + CopyMem (&Cpb->IP, IP, sizeof (PXE_IP_ADDR)); + + // + // Issue UNDI command and check result. + // + DEBUG ((EFI_D_NET, "\nSnp->undi.mcast_ip_to_mac() ")); + + (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); + + switch (Snp->Cdb.StatCode) { + case PXE_STATCODE_SUCCESS: + break; + + case PXE_STATCODE_INVALID_CPB: + return EFI_INVALID_PARAMETER; + + case PXE_STATCODE_UNSUPPORTED: + DEBUG ( + (EFI_D_NET, + "\nSnp->undi.mcast_ip_to_mac() %xh:%xh\n", + Snp->Cdb.StatFlags, + Snp->Cdb.StatCode) + ); + return EFI_UNSUPPORTED; + + default: + // + // UNDI command failed. Return EFI_DEVICE_ERROR + // to caller. + // + DEBUG ( + (EFI_D_NET, + "\nSnp->undi.mcast_ip_to_mac() %xh:%xh\n", + Snp->Cdb.StatFlags, + Snp->Cdb.StatCode) + ); + + return EFI_DEVICE_ERROR; + } + + CopyMem (MAC, &Db->MAC, sizeof (PXE_MAC_ADDR)); + return EFI_SUCCESS; +} + + +/** + Converts a multicast IP address to a multicast HW MAC address. + + This function converts a multicast IP address to a multicast HW MAC address + for all packet transactions. If the mapping is accepted, then EFI_SUCCESS will + be returned. + + @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. + @param IPv6 Set to TRUE if the multicast IP address is IPv6 [RFC 2460]. + Set to FALSE if the multicast IP address is IPv4 [RFC 791]. + @param IP The multicast IP address that is to be converted to a multicast + HW MAC address. + @param MAC The multicast HW MAC address that is to be generated from IP. + + @retval EFI_SUCCESS The multicast IP address was mapped to the + multicast HW MAC address. + @retval EFI_NOT_STARTED The Simple Network Protocol interface has not + been started by calling Start(). + @retval EFI_INVALID_PARAMETER IP is NULL. + @retval EFI_INVALID_PARAMETER MAC is NULL. + @retval EFI_INVALID_PARAMETER IP does not point to a valid IPv4 or IPv6 + multicast address. + @retval EFI_DEVICE_ERROR The Simple Network Protocol interface has not + been initialized by calling Initialize(). + @retval EFI_UNSUPPORTED IPv6 is TRUE and the implementation does not + support IPv6 multicast to MAC address conversion. + +**/ +EFI_STATUS +EFIAPI +SnpUndi32McastIpToMac ( + IN EFI_SIMPLE_NETWORK_PROTOCOL *This, + IN BOOLEAN IPv6, + IN EFI_IP_ADDRESS *IP, + OUT EFI_MAC_ADDRESS *MAC + ) +{ + SNP_DRIVER *Snp; + EFI_TPL OldTpl; + EFI_STATUS Status; + + // + // Get pointer to SNP driver instance for *this. + // + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + if (IP == NULL || MAC == NULL) { + return EFI_INVALID_PARAMETER; + } + + Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This); + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + switch (Snp->Mode.State) { + case EfiSimpleNetworkInitialized: + break; + + case EfiSimpleNetworkStopped: + Status = EFI_NOT_STARTED; + goto ON_EXIT; + + default: + Status = EFI_DEVICE_ERROR; + goto ON_EXIT; + } + + Status = PxeIp2Mac (Snp, IPv6, IP, MAC); + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + + return Status; +} diff --git a/NetworkPkg/SnpDxe/Nvdata.c b/NetworkPkg/SnpDxe/Nvdata.c new file mode 100644 index 0000000000..7010b63a54 --- /dev/null +++ b/NetworkPkg/SnpDxe/Nvdata.c @@ -0,0 +1,217 @@ +/** @file + Implementation of reading and writing operations on the NVRAM device + attached to a network interface. + +Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Snp.h" + + +/** + This routine calls Undi to read the desired number of eeprom bytes. + + @param Snp pointer to the snp driver structure + @param Offset eeprom register value relative to the base address + @param BufferSize number of bytes to read + @param Buffer pointer where to read into + + @retval EFI_SUCCESS The NVRAM access was performed. + @retval EFI_INVALID_PARAMETER Invalid UNDI command. + @retval EFI_UNSUPPORTED Command is not supported by UNDI. + @retval EFI_DEVICE_ERROR Fail to execute UNDI command. + +**/ +EFI_STATUS +PxeNvDataRead ( + IN SNP_DRIVER *Snp, + IN UINTN Offset, + IN UINTN BufferSize, + IN OUT VOID *Buffer + ) +{ + PXE_DB_NVDATA *Db; + + Db = Snp->Db; + Snp->Cdb.OpCode = PXE_OPCODE_NVDATA; + + Snp->Cdb.OpFlags = PXE_OPFLAGS_NVDATA_READ; + + Snp->Cdb.CPBsize = PXE_CPBSIZE_NOT_USED; + Snp->Cdb.CPBaddr = PXE_CPBADDR_NOT_USED; + + Snp->Cdb.DBsize = (UINT16) sizeof (PXE_DB_NVDATA); + Snp->Cdb.DBaddr = (UINT64)(UINTN) Db; + + Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; + Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; + Snp->Cdb.IFnum = Snp->IfNum; + Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; + + // + // Issue UNDI command and check result. + // + DEBUG ((EFI_D_NET, "\nsnp->undi.nvdata () ")); + + (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); + + switch (Snp->Cdb.StatCode) { + case PXE_STATCODE_SUCCESS: + break; + + case PXE_STATCODE_UNSUPPORTED: + DEBUG ( + (EFI_D_NET, + "\nsnp->undi.nvdata() %xh:%xh\n", + Snp->Cdb.StatFlags, + Snp->Cdb.StatCode) + ); + + return EFI_UNSUPPORTED; + + default: + DEBUG ( + (EFI_D_NET, + "\nsnp->undi.nvdata() %xh:%xh\n", + Snp->Cdb.StatFlags, + Snp->Cdb.StatCode) + ); + + return EFI_DEVICE_ERROR; + } + + ASSERT (Offset < sizeof (Db->Data)); + + CopyMem (Buffer, &Db->Data.Byte[Offset], BufferSize); + + return EFI_SUCCESS; +} + + +/** + Performs read and write operations on the NVRAM device attached to a network + interface. + + This function performs read and write operations on the NVRAM device attached + to a network interface. If ReadWrite is TRUE, a read operation is performed. + If ReadWrite is FALSE, a write operation is performed. Offset specifies the + byte offset at which to start either operation. Offset must be a multiple of + NvRamAccessSize , and it must have a value between zero and NvRamSize. + BufferSize specifies the length of the read or write operation. BufferSize must + also be a multiple of NvRamAccessSize, and Offset + BufferSize must not exceed + NvRamSize. + If any of the above conditions is not met, then EFI_INVALID_PARAMETER will be + returned. + If all the conditions are met and the operation is "read," the NVRAM device + attached to the network interface will be read into Buffer and EFI_SUCCESS + will be returned. If this is a write operation, the contents of Buffer will be + used to update the contents of the NVRAM device attached to the network + interface and EFI_SUCCESS will be returned. + + It does the basic checking on the input parameters and retrieves snp structure + and then calls the read_nvdata() call which does the actual reading + + @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. + @param ReadWrite TRUE for read operations, FALSE for write operations. + @param Offset Byte offset in the NVRAM device at which to start the read or + write operation. This must be a multiple of NvRamAccessSize + and less than NvRamSize. (See EFI_SIMPLE_NETWORK_MODE) + @param BufferSize The number of bytes to read or write from the NVRAM device. + This must also be a multiple of NvramAccessSize. + @param Buffer A pointer to the data buffer. + + @retval EFI_SUCCESS The NVRAM access was performed. + @retval EFI_NOT_STARTED The network interface has not been started. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + * The This parameter is NULL + * The This parameter does not point to a valid + EFI_SIMPLE_NETWORK_PROTOCOL structure + * The Offset parameter is not a multiple of + EFI_SIMPLE_NETWORK_MODE.NvRamAccessSize + * The Offset parameter is not less than + EFI_SIMPLE_NETWORK_MODE.NvRamSize + * The BufferSize parameter is not a multiple of + EFI_SIMPLE_NETWORK_MODE.NvRamAccessSize + * The Buffer parameter is NULL + @retval EFI_DEVICE_ERROR The command could not be sent to the network + interface. + @retval EFI_UNSUPPORTED This function is not supported by the network + interface. + +**/ +EFI_STATUS +EFIAPI +SnpUndi32NvData ( + IN EFI_SIMPLE_NETWORK_PROTOCOL *This, + IN BOOLEAN ReadWrite, + IN UINTN Offset, + IN UINTN BufferSize, + IN OUT VOID *Buffer + ) +{ + SNP_DRIVER *Snp; + EFI_TPL OldTpl; + EFI_STATUS Status; + + // + // Get pointer to SNP driver instance for *this. + // + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This); + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + // + // Return error if the SNP is not initialized. + // + switch (Snp->Mode.State) { + case EfiSimpleNetworkInitialized: + break; + + case EfiSimpleNetworkStopped: + Status = EFI_NOT_STARTED; + goto ON_EXIT; + + default: + Status = EFI_DEVICE_ERROR; + goto ON_EXIT; + } + // + // Return error if non-volatile memory variables are not valid. + // + if (Snp->Mode.NvRamSize == 0 || Snp->Mode.NvRamAccessSize == 0) { + Status = EFI_UNSUPPORTED; + goto ON_EXIT; + } + // + // Check for invalid parameter combinations. + // + if ((BufferSize == 0) || + (Buffer == NULL) || + (Offset >= Snp->Mode.NvRamSize) || + (Offset + BufferSize > Snp->Mode.NvRamSize) || + (BufferSize % Snp->Mode.NvRamAccessSize != 0) || + (Offset % Snp->Mode.NvRamAccessSize != 0) + ) { + Status = EFI_INVALID_PARAMETER; + goto ON_EXIT; + } + // + // check the implementation flags of undi if we can write the nvdata! + // + if (!ReadWrite) { + Status = EFI_UNSUPPORTED; + } else { + Status = PxeNvDataRead (Snp, Offset, BufferSize, Buffer); + } + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + + return Status; +} diff --git a/NetworkPkg/SnpDxe/Receive.c b/NetworkPkg/SnpDxe/Receive.c new file mode 100644 index 0000000000..28cea0d2e9 --- /dev/null +++ b/NetworkPkg/SnpDxe/Receive.c @@ -0,0 +1,251 @@ +/** @file + Implementation of receiving a packet from a network interface. + +Copyright (c) 2004 - 2010, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + + +#include "Snp.h" + +/** + Call UNDI to receive a packet and fills in the data in the input pointers. + + @param Snp Pointer to snp driver structure + @param Buffer Pointer to the memory for the received data + @param BufferSize Pointer to the length of the buffer on entry and contains + the length of the received data on return + @param HeaderSize Pointer to the header portion of the data received. + @param SrcAddr Pointer to contain the source ethernet address on return + @param DestAddr Pointer to contain the destination ethernet address on + return + @param Protocol Pointer to contain the protocol type from the ethernet + header on return + + + @retval EFI_SUCCESS The received data was stored in Buffer, and + BufferSize has been updated to the number of + bytes received. + @retval EFI_DEVICE_ERROR Fail to execute UNDI command. + @retval EFI_NOT_READY No packets have been received on the network + interface. + @retval EFI_BUFFER_TOO_SMALL BufferSize is too small for the received + packets. BufferSize has been updated to the + required size. + +**/ +EFI_STATUS +PxeReceive ( + SNP_DRIVER *Snp, + VOID *Buffer, + UINTN *BufferSize, + UINTN *HeaderSize, + EFI_MAC_ADDRESS *SrcAddr, + EFI_MAC_ADDRESS *DestAddr, + UINT16 *Protocol + ) +{ + PXE_CPB_RECEIVE *Cpb; + PXE_DB_RECEIVE *Db; + UINTN BuffSize; + + Cpb = Snp->Cpb; + Db = Snp->Db; + BuffSize = *BufferSize; + + Cpb->BufferAddr = (UINT64)(UINTN) Buffer; + Cpb->BufferLen = (UINT32) *BufferSize; + + Cpb->reserved = 0; + + Snp->Cdb.OpCode = PXE_OPCODE_RECEIVE; + Snp->Cdb.OpFlags = PXE_OPFLAGS_NOT_USED; + + Snp->Cdb.CPBsize = (UINT16) sizeof (PXE_CPB_RECEIVE); + Snp->Cdb.CPBaddr = (UINT64)(UINTN) Cpb; + + Snp->Cdb.DBsize = (UINT16) sizeof (PXE_DB_RECEIVE); + Snp->Cdb.DBaddr = (UINT64)(UINTN) Db; + + Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; + Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; + Snp->Cdb.IFnum = Snp->IfNum; + Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; + + // + // Issue UNDI command and check result. + // + DEBUG ((EFI_D_NET, "\nsnp->undi.receive () ")); + + (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); + + switch (Snp->Cdb.StatCode) { + case PXE_STATCODE_SUCCESS: + break; + + case PXE_STATCODE_NO_DATA: + DEBUG ( + (EFI_D_NET, + "\nsnp->undi.receive () %xh:%xh\n", + Snp->Cdb.StatFlags, + Snp->Cdb.StatCode) + ); + + return EFI_NOT_READY; + + default: + DEBUG ( + (EFI_D_ERROR, + "\nsnp->undi.receive() %xh:%xh\n", + Snp->Cdb.StatFlags, + Snp->Cdb.StatCode) + ); + + return EFI_DEVICE_ERROR; + } + + *BufferSize = Db->FrameLen; + + if (HeaderSize != NULL) { + *HeaderSize = Db->MediaHeaderLen; + } + + if (SrcAddr != NULL) { + CopyMem (SrcAddr, &Db->SrcAddr, Snp->Mode.HwAddressSize); + } + + if (DestAddr != NULL) { + CopyMem (DestAddr, &Db->DestAddr, Snp->Mode.HwAddressSize); + } + + if (Protocol != NULL) { + // + // We need to do the byte swapping + // + *Protocol = (UINT16) PXE_SWAP_UINT16 (Db->Protocol); + } + + // + // We have received a packet from network interface, which implies that the + // network cable should be present. While, some UNDI driver may not report + // correct media status during Snp->Initialize(). So, we need ensure + // MediaPresent in SNP mode data is set to correct value. + // + if (Snp->Mode.MediaPresentSupported && !Snp->Mode.MediaPresent) { + Snp->Mode.MediaPresent = TRUE; + } + + return (*BufferSize <= BuffSize) ? EFI_SUCCESS : EFI_BUFFER_TOO_SMALL; +} + +/** + Receives a packet from a network interface. + + This function retrieves one packet from the receive queue of a network interface. + If there are no packets on the receive queue, then EFI_NOT_READY will be + returned. If there is a packet on the receive queue, and the size of the packet + is smaller than BufferSize, then the contents of the packet will be placed in + Buffer, and BufferSize will be updated with the actual size of the packet. + In addition, if SrcAddr, DestAddr, and Protocol are not NULL, then these values + will be extracted from the media header and returned. EFI_SUCCESS will be + returned if a packet was successfully received. + If BufferSize is smaller than the received packet, then the size of the receive + packet will be placed in BufferSize and EFI_BUFFER_TOO_SMALL will be returned. + If the driver has not been initialized, EFI_DEVICE_ERROR will be returned. + + @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. + @param HeaderSize The size, in bytes, of the media header received on the network + interface. If this parameter is NULL, then the media header size + will not be returned. + @param BufferSize On entry, the size, in bytes, of Buffer. On exit, the size, in + bytes, of the packet that was received on the network interface. + @param Buffer A pointer to the data buffer to receive both the media + header and the data. + @param SrcAddr The source HW MAC address. If this parameter is NULL, the HW + MAC source address will not be extracted from the media header. + @param DestAddr The destination HW MAC address. If this parameter is NULL, + the HW MAC destination address will not be extracted from + the media header. + @param Protocol The media header type. If this parameter is NULL, then the + protocol will not be extracted from the media header. See + RFC 1700 section "Ether Types" for examples. + + @retval EFI_SUCCESS The received data was stored in Buffer, and + BufferSize has been updated to the number of + bytes received. + @retval EFI_NOT_STARTED The network interface has not been started. + @retval EFI_NOT_READY No packets have been received on the network interface. + @retval EFI_BUFFER_TOO_SMALL BufferSize is too small for the received packets. + BufferSize has been updated to the required size. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + * The This parameter is NULL + * The This parameter does not point to a valid + EFI_SIMPLE_NETWORK_PROTOCOL structure. + * The BufferSize parameter is NULL + * The Buffer parameter is NULL + @retval EFI_DEVICE_ERROR The command could not be sent to the network interface. + +**/ +EFI_STATUS +EFIAPI +SnpUndi32Receive ( + IN EFI_SIMPLE_NETWORK_PROTOCOL *This, + OUT UINTN *HeaderSize OPTIONAL, + IN OUT UINTN *BufferSize, + OUT VOID *Buffer, + OUT EFI_MAC_ADDRESS *SrcAddr OPTIONAL, + OUT EFI_MAC_ADDRESS *DestAddr OPTIONAL, + OUT UINT16 *Protocol OPTIONAL + ) +{ + SNP_DRIVER *Snp; + EFI_TPL OldTpl; + EFI_STATUS Status; + + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This); + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + switch (Snp->Mode.State) { + case EfiSimpleNetworkInitialized: + break; + + case EfiSimpleNetworkStopped: + Status = EFI_NOT_STARTED; + goto ON_EXIT; + + default: + Status = EFI_DEVICE_ERROR; + goto ON_EXIT; + } + + if ((BufferSize == NULL) || (Buffer == NULL)) { + Status = EFI_INVALID_PARAMETER; + goto ON_EXIT; + } + + if (Snp->Mode.ReceiveFilterSetting == 0) { + Status = EFI_DEVICE_ERROR; + goto ON_EXIT; + } + + Status = PxeReceive ( + Snp, + Buffer, + BufferSize, + HeaderSize, + SrcAddr, + DestAddr, + Protocol + ); + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + + return Status; +} diff --git a/NetworkPkg/SnpDxe/Receive_filters.c b/NetworkPkg/SnpDxe/Receive_filters.c new file mode 100644 index 0000000000..494d2709b6 --- /dev/null +++ b/NetworkPkg/SnpDxe/Receive_filters.c @@ -0,0 +1,478 @@ +/** @file + Implementation of managing the multicast receive filters of a network + interface. + +Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + + + +#include "Snp.h" + +/** + Call undi to enable the receive filters. + + @param Snp Pointer to snp driver structure. + @param EnableFlags Bit mask for enabling the receive filters. + @param MCastAddressCount Multicast address count for a new multicast address + list. + @param MCastAddressList List of new multicast addresses. + + @retval EFI_SUCCESS The multicast receive filter list was updated. + @retval EFI_INVALID_PARAMETER Invalid UNDI command. + @retval EFI_UNSUPPORTED Command is not supported by UNDI. + @retval EFI_DEVICE_ERROR Fail to execute UNDI command. + +**/ +EFI_STATUS +PxeRecvFilterEnable ( + SNP_DRIVER *Snp, + UINT32 EnableFlags, + UINTN MCastAddressCount, + EFI_MAC_ADDRESS *MCastAddressList + ) +{ + Snp->Cdb.OpCode = PXE_OPCODE_RECEIVE_FILTERS; + Snp->Cdb.OpFlags = PXE_OPFLAGS_RECEIVE_FILTER_ENABLE; + Snp->Cdb.CPBsize = PXE_CPBSIZE_NOT_USED; + Snp->Cdb.DBsize = PXE_DBSIZE_NOT_USED; + Snp->Cdb.CPBaddr = PXE_CPBADDR_NOT_USED; + Snp->Cdb.DBaddr = PXE_DBADDR_NOT_USED; + Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; + Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; + Snp->Cdb.IFnum = Snp->IfNum; + Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; + + if ((EnableFlags & EFI_SIMPLE_NETWORK_RECEIVE_UNICAST) != 0) { + Snp->Cdb.OpFlags |= PXE_OPFLAGS_RECEIVE_FILTER_UNICAST; + } + + if ((EnableFlags & EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST) != 0) { + Snp->Cdb.OpFlags |= PXE_OPFLAGS_RECEIVE_FILTER_BROADCAST; + } + + if ((EnableFlags & EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS) != 0) { + Snp->Cdb.OpFlags |= PXE_OPFLAGS_RECEIVE_FILTER_PROMISCUOUS; + } + + if ((EnableFlags & EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST) != 0) { + Snp->Cdb.OpFlags |= PXE_OPFLAGS_RECEIVE_FILTER_ALL_MULTICAST; + } + + if ((EnableFlags & EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST) != 0) { + Snp->Cdb.OpFlags |= PXE_OPFLAGS_RECEIVE_FILTER_FILTERED_MULTICAST; + } + + if (MCastAddressCount != 0) { + Snp->Cdb.CPBsize = (UINT16) (MCastAddressCount * sizeof (EFI_MAC_ADDRESS)); + Snp->Cdb.CPBaddr = (UINT64)(UINTN)Snp->Cpb; + CopyMem (Snp->Cpb, MCastAddressList, Snp->Cdb.CPBsize); + } + // + // Issue UNDI command and check result. + // + DEBUG ((EFI_D_NET, "\nsnp->undi.receive_filters() ")); + + (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); + + if (Snp->Cdb.StatCode != PXE_STATCODE_SUCCESS) { + // + // UNDI command failed. Return UNDI status to caller. + // + DEBUG ( + (EFI_D_ERROR, + "\nsnp->undi.receive_filters() %xh:%xh\n", + Snp->Cdb.StatFlags, + Snp->Cdb.StatCode) + ); + + switch (Snp->Cdb.StatCode) { + case PXE_STATCODE_INVALID_CDB: + case PXE_STATCODE_INVALID_CPB: + case PXE_STATCODE_INVALID_PARAMETER: + return EFI_INVALID_PARAMETER; + + case PXE_STATCODE_UNSUPPORTED: + return EFI_UNSUPPORTED; + } + + return EFI_DEVICE_ERROR; + } + + return EFI_SUCCESS; +} + +/** + Call undi to disable the receive filters. + + @param Snp Pointer to snp driver structure + @param DisableFlags Bit mask for disabling the receive filters + @param ResetMCastList Boolean flag to reset/delete the multicast filter + list. + + @retval EFI_SUCCESS The multicast receive filter list was updated. + @retval EFI_DEVICE_ERROR Fail to execute UNDI command. + +**/ +EFI_STATUS +PxeRecvFilterDisable ( + SNP_DRIVER *Snp, + UINT32 DisableFlags, + BOOLEAN ResetMCastList + ) +{ + Snp->Cdb.OpCode = PXE_OPCODE_RECEIVE_FILTERS; + Snp->Cdb.CPBsize = PXE_CPBSIZE_NOT_USED; + Snp->Cdb.DBsize = PXE_DBSIZE_NOT_USED; + Snp->Cdb.CPBaddr = PXE_CPBADDR_NOT_USED; + Snp->Cdb.DBaddr = PXE_DBADDR_NOT_USED; + Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; + Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; + Snp->Cdb.IFnum = Snp->IfNum; + Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; + + Snp->Cdb.OpFlags = (UINT16) ((DisableFlags != 0) ? PXE_OPFLAGS_RECEIVE_FILTER_DISABLE : PXE_OPFLAGS_NOT_USED); + + if (ResetMCastList) { + Snp->Cdb.OpFlags |= PXE_OPFLAGS_RECEIVE_FILTER_RESET_MCAST_LIST; + } + + if ((DisableFlags & EFI_SIMPLE_NETWORK_RECEIVE_UNICAST) != 0) { + Snp->Cdb.OpFlags |= PXE_OPFLAGS_RECEIVE_FILTER_UNICAST; + } + + if ((DisableFlags & EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST) != 0) { + Snp->Cdb.OpFlags |= PXE_OPFLAGS_RECEIVE_FILTER_BROADCAST; + } + + if ((DisableFlags & EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS) != 0) { + Snp->Cdb.OpFlags |= PXE_OPFLAGS_RECEIVE_FILTER_PROMISCUOUS; + } + + if ((DisableFlags & EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST) != 0) { + Snp->Cdb.OpFlags |= PXE_OPFLAGS_RECEIVE_FILTER_ALL_MULTICAST; + } + + if ((DisableFlags & EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST) != 0) { + Snp->Cdb.OpFlags |= PXE_OPFLAGS_RECEIVE_FILTER_FILTERED_MULTICAST; + } + // + // Issue UNDI command and check result. + // + DEBUG ((EFI_D_NET, "\nsnp->undi.receive_filters() ")); + + (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); + + if (Snp->Cdb.StatCode != PXE_STATCODE_SUCCESS) { + // + // UNDI command failed. Return UNDI status to caller. + // + DEBUG ( + (EFI_D_ERROR, + "\nsnp->undi.receive_filters() %xh:%xh\n", + Snp->Cdb.StatFlags, + Snp->Cdb.StatCode) + ); + + return EFI_DEVICE_ERROR; + } + + return EFI_SUCCESS; +} + +/** + Call undi to read the receive filters. + + @param Snp Pointer to snp driver structure. + + @retval EFI_SUCCESS The receive filter was read. + @retval EFI_DEVICE_ERROR Fail to execute UNDI command. + +**/ +EFI_STATUS +PxeRecvFilterRead ( + SNP_DRIVER *Snp + ) +{ + Snp->Cdb.OpCode = PXE_OPCODE_RECEIVE_FILTERS; + Snp->Cdb.OpFlags = PXE_OPFLAGS_RECEIVE_FILTER_READ; + Snp->Cdb.CPBsize = PXE_CPBSIZE_NOT_USED; + Snp->Cdb.DBsize = (UINT16) (Snp->Mode.MaxMCastFilterCount * sizeof (EFI_MAC_ADDRESS)); + Snp->Cdb.CPBaddr = PXE_CPBADDR_NOT_USED; + if (Snp->Cdb.DBsize == 0) { + Snp->Cdb.DBaddr = (UINT64)(UINTN) NULL; + } else { + Snp->Cdb.DBaddr = (UINT64)(UINTN) Snp->Db; + ZeroMem (Snp->Db, Snp->Cdb.DBsize); + } + + Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; + Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; + Snp->Cdb.IFnum = Snp->IfNum; + Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; + + DEBUG ((EFI_D_NET, "\nsnp->undi.receive_filters() ")); + + (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); + + if (Snp->Cdb.StatCode != PXE_STATCODE_SUCCESS) { + // + // UNDI command failed. Return UNDI status to caller. + // + DEBUG ( + (EFI_D_ERROR, + "\nsnp->undi.receive_filters() %xh:%xh\n", + Snp->Cdb.StatFlags, + Snp->Cdb.StatCode) + ); + + return EFI_DEVICE_ERROR; + } + // + // Convert UNDI32 StatFlags to EFI SNP filter flags. + // + Snp->Mode.ReceiveFilterSetting = 0; + + if ((Snp->Cdb.StatFlags & PXE_STATFLAGS_RECEIVE_FILTER_UNICAST) != 0) { + Snp->Mode.ReceiveFilterSetting |= EFI_SIMPLE_NETWORK_RECEIVE_UNICAST; + } + + if ((Snp->Cdb.StatFlags & PXE_STATFLAGS_RECEIVE_FILTER_BROADCAST) != 0) { + Snp->Mode.ReceiveFilterSetting |= EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST; + } + + if ((Snp->Cdb.StatFlags & PXE_STATFLAGS_RECEIVE_FILTER_PROMISCUOUS) != 0) { + Snp->Mode.ReceiveFilterSetting |= EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS; + } + + if ((Snp->Cdb.StatFlags & PXE_STATFLAGS_RECEIVE_FILTER_ALL_MULTICAST) != 0) { + Snp->Mode.ReceiveFilterSetting |= EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST; + } + + if ((Snp->Cdb.StatFlags & PXE_STATFLAGS_RECEIVE_FILTER_FILTERED_MULTICAST) != 0) { + Snp->Mode.ReceiveFilterSetting |= EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST; + } + + CopyMem (Snp->Mode.MCastFilter, Snp->Db, Snp->Cdb.DBsize); + + // + // Count number of active entries in multicast filter list. + // + { + EFI_MAC_ADDRESS ZeroMacAddr; + + SetMem (&ZeroMacAddr, sizeof ZeroMacAddr, 0); + + for (Snp->Mode.MCastFilterCount = 0; + Snp->Mode.MCastFilterCount < Snp->Mode.MaxMCastFilterCount; + Snp->Mode.MCastFilterCount++ + ) { + if (CompareMem ( + &Snp->Mode.MCastFilter[Snp->Mode.MCastFilterCount], + &ZeroMacAddr, + sizeof ZeroMacAddr + ) == 0) { + break; + } + } + } + + return EFI_SUCCESS; +} + + +/** + Manages the multicast receive filters of a network interface. + + This function is used enable and disable the hardware and software receive + filters for the underlying network device. + The receive filter change is broken down into three steps: + * The filter mask bits that are set (ON) in the Enable parameter are added to + the current receive filter settings. + * The filter mask bits that are set (ON) in the Disable parameter are subtracted + from the updated receive filter settings. + * If the resulting receive filter setting is not supported by the hardware a + more liberal setting is selected. + If the same bits are set in the Enable and Disable parameters, then the bits + in the Disable parameter takes precedence. + If the ResetMCastFilter parameter is TRUE, then the multicast address list + filter is disabled (irregardless of what other multicast bits are set in the + Enable and Disable parameters). The SNP->Mode->MCastFilterCount field is set + to zero. The Snp->Mode->MCastFilter contents are undefined. + After enabling or disabling receive filter settings, software should verify + the new settings by checking the Snp->Mode->ReceiveFilterSettings, + Snp->Mode->MCastFilterCount and Snp->Mode->MCastFilter fields. + Note: Some network drivers and/or devices will automatically promote receive + filter settings if the requested setting can not be honored. For example, if + a request for four multicast addresses is made and the underlying hardware + only supports two multicast addresses the driver might set the promiscuous + or promiscuous multicast receive filters instead. The receiving software is + responsible for discarding any extra packets that get through the hardware + receive filters. + Note: Note: To disable all receive filter hardware, the network driver must + be Shutdown() and Stopped(). Calling ReceiveFilters() with Disable set to + Snp->Mode->ReceiveFilterSettings will make it so no more packets are + returned by the Receive() function, but the receive hardware may still be + moving packets into system memory before inspecting and discarding them. + Unexpected system errors, reboots and hangs can occur if an OS is loaded + and the network devices are not Shutdown() and Stopped(). + If ResetMCastFilter is TRUE, then the multicast receive filter list on the + network interface will be reset to the default multicast receive filter list. + If ResetMCastFilter is FALSE, and this network interface allows the multicast + receive filter list to be modified, then the MCastFilterCnt and MCastFilter + are used to update the current multicast receive filter list. The modified + receive filter list settings can be found in the MCastFilter field of + EFI_SIMPLE_NETWORK_MODE. If the network interface does not allow the multicast + receive filter list to be modified, then EFI_INVALID_PARAMETER will be returned. + If the driver has not been initialized, EFI_DEVICE_ERROR will be returned. + If the receive filter mask and multicast receive filter list have been + successfully updated on the network interface, EFI_SUCCESS will be returned. + + @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. + @param Enable A bit mask of receive filters to enable on the network + interface. + @param Disable A bit mask of receive filters to disable on the network + interface. For backward compatibility with EFI 1.1 + platforms, the EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST bit + must be set when the ResetMCastFilter parameter is TRUE. + @param ResetMCastFilter Set to TRUE to reset the contents of the multicast + receive filters on the network interface to their + default values. + @param MCastFilterCnt Number of multicast HW MAC addresses in the new MCastFilter + list. This value must be less than or equal to the + MCastFilterCnt field of EFI_SIMPLE_NETWORK_MODE. + This field is optional if ResetMCastFilter is TRUE. + @param MCastFilter A pointer to a list of new multicast receive filter HW + MAC addresses. This list will replace any existing + multicast HW MAC address list. This field is optional + if ResetMCastFilter is TRUE. + + @retval EFI_SUCCESS The multicast receive filter list was updated. + @retval EFI_NOT_STARTED The network interface has not been started. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + * This is NULL + * There are bits set in Enable that are not set + in Snp->Mode->ReceiveFilterMask + * There are bits set in Disable that are not set + in Snp->Mode->ReceiveFilterMask + * Multicast is being enabled (the + EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST bit is + set in Enable, it is not set in Disable, and + ResetMCastFilter is FALSE) and MCastFilterCount + is zero + * Multicast is being enabled and MCastFilterCount + is greater than Snp->Mode->MaxMCastFilterCount + * Multicast is being enabled and MCastFilter is NULL + * Multicast is being enabled and one or more of + the addresses in the MCastFilter list are not + valid multicast MAC addresses + @retval EFI_DEVICE_ERROR One or more of the following conditions is TRUE: + * The network interface has been started but has + not been initialized + * An unexpected error was returned by the + underlying network driver or device + @retval EFI_UNSUPPORTED This function is not supported by the network + interface. + +**/ +EFI_STATUS +EFIAPI +SnpUndi32ReceiveFilters ( + IN EFI_SIMPLE_NETWORK_PROTOCOL *This, + IN UINT32 Enable, + IN UINT32 Disable, + IN BOOLEAN ResetMCastFilter, + IN UINTN MCastFilterCnt, OPTIONAL + IN EFI_MAC_ADDRESS *MCastFilter OPTIONAL + ) +{ + SNP_DRIVER *Snp; + EFI_STATUS Status; + EFI_TPL OldTpl; + + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This); + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + switch (Snp->Mode.State) { + case EfiSimpleNetworkInitialized: + break; + + case EfiSimpleNetworkStopped: + Status = EFI_NOT_STARTED; + goto ON_EXIT; + + default: + Status = EFI_DEVICE_ERROR; + goto ON_EXIT; + } + // + // check if we are asked to enable or disable something that the UNDI + // does not even support! + // + if (((Enable &~Snp->Mode.ReceiveFilterMask) != 0) || + ((Disable &~Snp->Mode.ReceiveFilterMask) != 0)) { + Status = EFI_INVALID_PARAMETER; + goto ON_EXIT; + } + + if (ResetMCastFilter) { + + Disable |= EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST & Snp->Mode.ReceiveFilterMask; + MCastFilterCnt = 0; + MCastFilter = NULL; + } else { + if (MCastFilterCnt != 0) { + if ((MCastFilterCnt > Snp->Mode.MaxMCastFilterCount) || + (MCastFilter == NULL)) { + + Status = EFI_INVALID_PARAMETER; + goto ON_EXIT; + } + } + } + + if (Enable == 0 && Disable == 0 && !ResetMCastFilter && MCastFilterCnt == 0) { + Status = EFI_SUCCESS; + goto ON_EXIT; + } + + if ((Enable & EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST) != 0 && MCastFilterCnt == 0) { + Status = EFI_INVALID_PARAMETER; + goto ON_EXIT; + } + + if ((Enable != 0) || (MCastFilterCnt != 0)) { + Status = PxeRecvFilterEnable ( + Snp, + Enable, + MCastFilterCnt, + MCastFilter + ); + + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } + } + + if ((Disable != 0) || ResetMCastFilter) { + Status = PxeRecvFilterDisable (Snp, Disable, ResetMCastFilter); + + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } + } + + Status = PxeRecvFilterRead (Snp); + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + + return Status; +} diff --git a/NetworkPkg/SnpDxe/Reset.c b/NetworkPkg/SnpDxe/Reset.c new file mode 100644 index 0000000000..3069bfde66 --- /dev/null +++ b/NetworkPkg/SnpDxe/Reset.c @@ -0,0 +1,130 @@ +/** @file + Implementation of resetting a network adapter. + +Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Snp.h" + + +/** + Call UNDI to reset the NIC. + + @param Snp Pointer to the snp driver structure. + + @return EFI_SUCCESSFUL The NIC was reset. + @retval EFI_DEVICE_ERROR The NIC cannot be reset. + +**/ +EFI_STATUS +PxeReset ( + SNP_DRIVER *Snp + ) +{ + Snp->Cdb.OpCode = PXE_OPCODE_RESET; + Snp->Cdb.OpFlags = PXE_OPFLAGS_NOT_USED; + Snp->Cdb.CPBsize = PXE_CPBSIZE_NOT_USED; + Snp->Cdb.DBsize = PXE_DBSIZE_NOT_USED; + Snp->Cdb.CPBaddr = PXE_CPBADDR_NOT_USED; + Snp->Cdb.DBaddr = PXE_DBADDR_NOT_USED; + Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; + Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; + Snp->Cdb.IFnum = Snp->IfNum; + Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; + + // + // Issue UNDI command and check result. + // + DEBUG ((EFI_D_NET, "\nsnp->undi.reset() ")); + + (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); + + if (Snp->Cdb.StatCode != PXE_STATCODE_SUCCESS) { + DEBUG ( + (EFI_D_WARN, + "\nsnp->undi32.reset() %xh:%xh\n", + Snp->Cdb.StatFlags, + Snp->Cdb.StatCode) + ); + + // + // UNDI could not be reset. Return UNDI error. + // + return EFI_DEVICE_ERROR; + } + + return EFI_SUCCESS; +} + + +/** + Resets a network adapter and reinitializes it with the parameters that were + provided in the previous call to Initialize(). + + This function resets a network adapter and reinitializes it with the parameters + that were provided in the previous call to Initialize(). The transmit and + receive queues are emptied and all pending interrupts are cleared. + Receive filters, the station address, the statistics, and the multicast-IP-to-HW + MAC addresses are not reset by this call. If the network interface was + successfully reset, then EFI_SUCCESS will be returned. If the driver has not + been initialized, EFI_DEVICE_ERROR will be returned. + + @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. + @param ExtendedVerification Indicates that the driver may perform a more + exhaustive verification operation of the device + during reset. + + @retval EFI_SUCCESS The network interface was reset. + @retval EFI_NOT_STARTED The network interface has not been started. + @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value. + @retval EFI_DEVICE_ERROR The command could not be sent to the network interface. + @retval EFI_UNSUPPORTED This function is not supported by the network interface. + +**/ +EFI_STATUS +EFIAPI +SnpUndi32Reset ( + IN EFI_SIMPLE_NETWORK_PROTOCOL *This, + IN BOOLEAN ExtendedVerification + ) +{ + SNP_DRIVER *Snp; + EFI_TPL OldTpl; + EFI_STATUS Status; + + // + // Resolve Warning 4 unreferenced parameter problem + // + ExtendedVerification = 0; + DEBUG ((EFI_D_WARN, "ExtendedVerification = %d is not implemented!\n", ExtendedVerification)); + + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This); + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + switch (Snp->Mode.State) { + case EfiSimpleNetworkInitialized: + break; + + case EfiSimpleNetworkStopped: + Status = EFI_NOT_STARTED; + goto ON_EXIT; + + default: + Status = EFI_DEVICE_ERROR; + goto ON_EXIT; + } + + Status = PxeReset (Snp); + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + + return Status; +} diff --git a/NetworkPkg/SnpDxe/Shutdown.c b/NetworkPkg/SnpDxe/Shutdown.c new file mode 100644 index 0000000000..aad0fe8493 --- /dev/null +++ b/NetworkPkg/SnpDxe/Shutdown.c @@ -0,0 +1,146 @@ +/** @file + Implementation of shuting down a network adapter. + +Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Snp.h" + + +/** + Call UNDI to shut down the interface. + + @param Snp Pointer to snp driver structure. + + @retval EFI_SUCCESS UNDI is shut down successfully. + @retval EFI_DEVICE_ERROR UNDI could not be shut down. + +**/ +EFI_STATUS +PxeShutdown ( + IN SNP_DRIVER *Snp + ) +{ + Snp->Cdb.OpCode = PXE_OPCODE_SHUTDOWN; + Snp->Cdb.OpFlags = PXE_OPFLAGS_NOT_USED; + Snp->Cdb.CPBsize = PXE_CPBSIZE_NOT_USED; + Snp->Cdb.DBsize = PXE_DBSIZE_NOT_USED; + Snp->Cdb.CPBaddr = PXE_CPBADDR_NOT_USED; + Snp->Cdb.DBaddr = PXE_DBADDR_NOT_USED; + Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; + Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; + Snp->Cdb.IFnum = Snp->IfNum; + Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; + + // + // Issue UNDI command and check result. + // + DEBUG ((EFI_D_NET, "\nsnp->undi.shutdown() ")); + + (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); + + if (Snp->Cdb.StatCode != PXE_STATCODE_SUCCESS) { + // + // UNDI could not be shutdown. Return UNDI error. + // + DEBUG ((EFI_D_WARN, "\nsnp->undi.shutdown() %xh:%xh\n", Snp->Cdb.StatFlags, Snp->Cdb.StatCode)); + + return EFI_DEVICE_ERROR; + } + // + // Free allocated memory. + // + if (Snp->TxRxBuffer != NULL) { + Snp->PciIo->FreeBuffer ( + Snp->PciIo, + SNP_MEM_PAGES (Snp->TxRxBufferSize), + (VOID *) Snp->TxRxBuffer + ); + } + + Snp->TxRxBuffer = NULL; + Snp->TxRxBufferSize = 0; + + return EFI_SUCCESS; +} + + +/** + Resets a network adapter and leaves it in a state that is safe for another + driver to initialize. + + This function releases the memory buffers assigned in the Initialize() call. + Pending transmits and receives are lost, and interrupts are cleared and disabled. + After this call, only the Initialize() and Stop() calls may be used. If the + network interface was successfully shutdown, then EFI_SUCCESS will be returned. + If the driver has not been initialized, EFI_DEVICE_ERROR will be returned. + + @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. + + @retval EFI_SUCCESS The network interface was shutdown. + @retval EFI_NOT_STARTED The network interface has not been started. + @retval EFI_INVALID_PARAMETER This parameter was NULL or did not point to a valid + EFI_SIMPLE_NETWORK_PROTOCOL structure. + @retval EFI_DEVICE_ERROR The command could not be sent to the network interface. + +**/ +EFI_STATUS +EFIAPI +SnpUndi32Shutdown ( + IN EFI_SIMPLE_NETWORK_PROTOCOL *This + ) +{ + SNP_DRIVER *Snp; + EFI_STATUS Status; + EFI_TPL OldTpl; + + // + // Get pointer to SNP driver instance for *This. + // + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This); + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + // + // Return error if the SNP is not initialized. + // + switch (Snp->Mode.State) { + case EfiSimpleNetworkInitialized: + break; + + case EfiSimpleNetworkStopped: + Status = EFI_NOT_STARTED; + goto ON_EXIT; + + default: + Status = EFI_DEVICE_ERROR; + goto ON_EXIT; + } + + Status = PxeShutdown (Snp); + + Snp->Mode.State = EfiSimpleNetworkStarted; + Snp->Mode.ReceiveFilterSetting = 0; + + Snp->Mode.MCastFilterCount = 0; + Snp->Mode.ReceiveFilterSetting = 0; + ZeroMem (Snp->Mode.MCastFilter, sizeof Snp->Mode.MCastFilter); + CopyMem ( + &Snp->Mode.CurrentAddress, + &Snp->Mode.PermanentAddress, + sizeof (EFI_MAC_ADDRESS) + ); + + gBS->CloseEvent (Snp->Snp.WaitForPacket); + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + + return Status; +} diff --git a/NetworkPkg/SnpDxe/Snp.c b/NetworkPkg/SnpDxe/Snp.c new file mode 100644 index 0000000000..a23af05078 --- /dev/null +++ b/NetworkPkg/SnpDxe/Snp.c @@ -0,0 +1,862 @@ +/** @file + Implementation of driver entry point and driver binding protocol. + +Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Snp.h" + +/** + One notified function to stop UNDI device when gBS->ExitBootServices() called. + + @param Event Pointer to this event + @param Context Event handler private data + +**/ +VOID +EFIAPI +SnpNotifyExitBootServices ( + EFI_EVENT Event, + VOID *Context + ) +{ + SNP_DRIVER *Snp; + + Snp = (SNP_DRIVER *)Context; + + // + // Shutdown and stop UNDI driver + // + PxeShutdown (Snp); + PxeStop (Snp); +} + +/** + Send command to UNDI. It does nothing currently. + + @param Cdb command to be sent to UNDI. + + @retval EFI_INVALID_PARAMETER The command is 0. + @retval EFI_UNSUPPORTED Default return status because it's not + supported currently. + +**/ +EFI_STATUS +EFIAPI +IssueHwUndiCommand ( + UINT64 Cdb + ) +{ + DEBUG ((EFI_D_ERROR, "\nIssueHwUndiCommand() - This should not be called!")); + + if (Cdb == 0) { + return EFI_INVALID_PARAMETER; + + } + // + // %%TBD - For now, nothing is done. + // + return EFI_UNSUPPORTED; +} + + +/** + Compute 8-bit checksum of a buffer. + + @param Buffer Pointer to buffer. + @param Length Length of buffer in bytes. + + @return 8-bit checksum of all bytes in buffer, or zero if ptr is NULL or len + is zero. + +**/ +UINT8 +Calc8BitCksum ( + VOID *Buffer, + UINTN Length + ) +{ + UINT8 *Ptr; + UINT8 Cksum; + + Ptr = Buffer; + Cksum = 0; + + if (Ptr == NULL || Length == 0) { + return 0; + } + + while (Length-- != 0) { + Cksum = (UINT8) (Cksum + *Ptr++); + } + + return Cksum; +} + +/** + Test to see if this driver supports ControllerHandle. This service + is called by the EFI boot service ConnectController(). In + order to make drivers as small as possible, there are a few calling + restrictions for this service. ConnectController() must + follow these calling restrictions. If any other agent wishes to call + Supported() it must also follow these calling restrictions. + + @param This Protocol instance pointer. + @param ControllerHandle Handle of device to test. + @param RemainingDevicePath Optional parameter use to pick a specific child + device to start. + + @retval EFI_SUCCESS This driver supports this device. + @retval EFI_ALREADY_STARTED This driver is already running on this device. + @retval other This driver does not support this device. + +**/ +EFI_STATUS +EFIAPI +SimpleNetworkDriverSupported ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE Controller, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath + ) +{ + EFI_STATUS Status; + EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL *NiiProtocol; + PXE_UNDI *Pxe; + + Status = gBS->OpenProtocol ( + Controller, + &gEfiDevicePathProtocolGuid, + NULL, + This->DriverBindingHandle, + Controller, + EFI_OPEN_PROTOCOL_TEST_PROTOCOL + ); + if (EFI_ERROR (Status)) { + return Status; + } + + Status = gBS->OpenProtocol ( + Controller, + &gEfiNetworkInterfaceIdentifierProtocolGuid_31, + (VOID **) &NiiProtocol, + This->DriverBindingHandle, + Controller, + EFI_OPEN_PROTOCOL_BY_DRIVER + ); + + if (EFI_ERROR (Status)) { + if (Status == EFI_ALREADY_STARTED) { + DEBUG ((EFI_D_INFO, "Support(): Already Started. on handle %p\n", Controller)); + } + return Status; + } + + DEBUG ((EFI_D_INFO, "Support(): UNDI3.1 found on handle %p\n", Controller)); + + // + // check the version, we don't want to connect to the undi16 + // + if (NiiProtocol->Type != EfiNetworkInterfaceUndi) { + Status = EFI_UNSUPPORTED; + goto Done; + } + // + // Check to see if !PXE structure is valid. Paragraph alignment of !PXE structure is required. + // + if ((NiiProtocol->Id & 0x0F) != 0) { + DEBUG ((EFI_D_NET, "\n!PXE structure is not paragraph aligned.\n")); + Status = EFI_UNSUPPORTED; + goto Done; + } + + Pxe = (PXE_UNDI *) (UINTN) (NiiProtocol->Id); + + // + // Verify !PXE revisions. + // + if (Pxe->hw.Signature != PXE_ROMID_SIGNATURE) { + DEBUG ((EFI_D_NET, "\n!PXE signature is not valid.\n")); + Status = EFI_UNSUPPORTED; + goto Done; + } + + if (Pxe->hw.Rev < PXE_ROMID_REV) { + DEBUG ((EFI_D_NET, "\n!PXE.Rev is not supported.\n")); + Status = EFI_UNSUPPORTED; + goto Done; + } + + if (Pxe->hw.MajorVer < PXE_ROMID_MAJORVER) { + + DEBUG ((EFI_D_NET, "\n!PXE.MajorVer is not supported.\n")); + Status = EFI_UNSUPPORTED; + goto Done; + + } else if (Pxe->hw.MajorVer == PXE_ROMID_MAJORVER && Pxe->hw.MinorVer < PXE_ROMID_MINORVER) { + DEBUG ((EFI_D_NET, "\n!PXE.MinorVer is not supported.")); + Status = EFI_UNSUPPORTED; + goto Done; + } + // + // Do S/W UNDI specific checks. + // + if ((Pxe->hw.Implementation & PXE_ROMID_IMP_HW_UNDI) == 0) { + if (Pxe->sw.EntryPoint < Pxe->sw.Len) { + DEBUG ((EFI_D_NET, "\n!PXE S/W entry point is not valid.")); + Status = EFI_UNSUPPORTED; + goto Done; + } + + if (Pxe->sw.BusCnt == 0) { + DEBUG ((EFI_D_NET, "\n!PXE.BusCnt is zero.")); + Status = EFI_UNSUPPORTED; + goto Done; + } + } + + Status = EFI_SUCCESS; + DEBUG ((EFI_D_INFO, "Support(): supported on %p\n", Controller)); + +Done: + gBS->CloseProtocol ( + Controller, + &gEfiNetworkInterfaceIdentifierProtocolGuid_31, + This->DriverBindingHandle, + Controller + ); + + return Status; +} + +/** + Start this driver on ControllerHandle. This service is called by the + EFI boot service ConnectController(). In order to make + drivers as small as possible, there are a few calling restrictions for + this service. ConnectController() must follow these + calling restrictions. If any other agent wishes to call Start() it + must also follow these calling restrictions. + + @param This Protocol instance pointer. + @param ControllerHandle Handle of device to bind driver to. + @param RemainingDevicePath Optional parameter use to pick a specific child + device to start. + + @retval EFI_SUCCESS This driver is added to ControllerHandle + @retval EFI_DEVICE_ERROR This driver could not be started due to a device error + @retval other This driver does not support this device + +**/ +EFI_STATUS +EFIAPI +SimpleNetworkDriverStart ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE Controller, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath + ) +{ + EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL *Nii; + EFI_DEVICE_PATH_PROTOCOL *NiiDevicePath; + EFI_STATUS Status; + PXE_UNDI *Pxe; + SNP_DRIVER *Snp; + VOID *Address; + EFI_HANDLE Handle; + UINT8 BarIndex; + PXE_STATFLAGS InitStatFlags; + EFI_PCI_IO_PROTOCOL *PciIo; + EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *BarDesc; + BOOLEAN FoundIoBar; + BOOLEAN FoundMemoryBar; + + DEBUG ((EFI_D_NET, "\nSnpNotifyNetworkInterfaceIdentifier() ")); + + Status = gBS->OpenProtocol ( + Controller, + &gEfiDevicePathProtocolGuid, + (VOID **) &NiiDevicePath, + This->DriverBindingHandle, + Controller, + EFI_OPEN_PROTOCOL_BY_DRIVER + ); + + if (EFI_ERROR (Status)) { + return Status; + } + + Status = gBS->LocateDevicePath ( + &gEfiPciIoProtocolGuid, + &NiiDevicePath, + &Handle + ); + + if (EFI_ERROR (Status)) { + return Status; + } + + Status = gBS->OpenProtocol ( + Handle, + &gEfiPciIoProtocolGuid, + (VOID **) &PciIo, + This->DriverBindingHandle, + Controller, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + if (EFI_ERROR (Status)) { + return Status; + } + // + // Get the NII interface. + // + Status = gBS->OpenProtocol ( + Controller, + &gEfiNetworkInterfaceIdentifierProtocolGuid_31, + (VOID **) &Nii, + This->DriverBindingHandle, + Controller, + EFI_OPEN_PROTOCOL_BY_DRIVER + ); + if (EFI_ERROR (Status)) { + gBS->CloseProtocol ( + Controller, + &gEfiDevicePathProtocolGuid, + This->DriverBindingHandle, + Controller + ); + return Status; + } + + DEBUG ((EFI_D_INFO, "Start(): UNDI3.1 found\n")); + + Pxe = (PXE_UNDI *) (UINTN) (Nii->Id); + + if (Calc8BitCksum (Pxe, Pxe->hw.Len) != 0) { + DEBUG ((EFI_D_NET, "\n!PXE checksum is not correct.\n")); + goto NiiError; + } + + if ((Pxe->hw.Implementation & PXE_ROMID_IMP_PROMISCUOUS_RX_SUPPORTED) != 0) { + // + // We can get any packets. + // + } else if ((Pxe->hw.Implementation & PXE_ROMID_IMP_BROADCAST_RX_SUPPORTED) != 0) { + // + // We need to be able to get broadcast packets for DHCP. + // If we do not have promiscuous support, we must at least have + // broadcast support or we cannot do DHCP! + // + } else { + DEBUG ((EFI_D_NET, "\nUNDI does not have promiscuous or broadcast support.")); + goto NiiError; + } + // + // OK, we like this UNDI, and we know snp is not already there on this handle + // Allocate and initialize a new simple network protocol structure. + // + Status = PciIo->AllocateBuffer ( + PciIo, + AllocateAnyPages, + EfiBootServicesData, + SNP_MEM_PAGES (sizeof (SNP_DRIVER)), + &Address, + 0 + ); + + if (Status != EFI_SUCCESS) { + DEBUG ((EFI_D_NET, "\nCould not allocate SNP_DRIVER structure.\n")); + goto NiiError; + } + + Snp = (SNP_DRIVER *) (UINTN) Address; + + ZeroMem (Snp, sizeof (SNP_DRIVER)); + + Snp->PciIo = PciIo; + Snp->Signature = SNP_DRIVER_SIGNATURE; + + EfiInitializeLock (&Snp->Lock, TPL_NOTIFY); + + Snp->Snp.Revision = EFI_SIMPLE_NETWORK_PROTOCOL_REVISION; + Snp->Snp.Start = SnpUndi32Start; + Snp->Snp.Stop = SnpUndi32Stop; + Snp->Snp.Initialize = SnpUndi32Initialize; + Snp->Snp.Reset = SnpUndi32Reset; + Snp->Snp.Shutdown = SnpUndi32Shutdown; + Snp->Snp.ReceiveFilters = SnpUndi32ReceiveFilters; + Snp->Snp.StationAddress = SnpUndi32StationAddress; + Snp->Snp.Statistics = SnpUndi32Statistics; + Snp->Snp.MCastIpToMac = SnpUndi32McastIpToMac; + Snp->Snp.NvData = SnpUndi32NvData; + Snp->Snp.GetStatus = SnpUndi32GetStatus; + Snp->Snp.Transmit = SnpUndi32Transmit; + Snp->Snp.Receive = SnpUndi32Receive; + Snp->Snp.WaitForPacket = NULL; + + Snp->Snp.Mode = &Snp->Mode; + + Snp->TxRxBufferSize = 0; + Snp->TxRxBuffer = NULL; + + Snp->RecycledTxBuf = AllocatePool (sizeof (UINT64) * SNP_TX_BUFFER_INCREASEMENT); + if (Snp->RecycledTxBuf == NULL) { + Status = EFI_OUT_OF_RESOURCES; + goto Error_DeleteSNP; + } + Snp->MaxRecycledTxBuf = SNP_TX_BUFFER_INCREASEMENT; + Snp->RecycledTxBufCount = 0; + + if (Nii->Revision >= EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_REVISION) { + Snp->IfNum = Nii->IfNum; + + } else { + Snp->IfNum = (UINT8) (Nii->IfNum & 0xFF); + } + + if ((Pxe->hw.Implementation & PXE_ROMID_IMP_HW_UNDI) != 0) { + Snp->IsSwUndi = FALSE; + Snp->IssueUndi32Command = &IssueHwUndiCommand; + } else { + Snp->IsSwUndi = TRUE; + + if ((Pxe->sw.Implementation & PXE_ROMID_IMP_SW_VIRT_ADDR) != 0) { + Snp->IssueUndi32Command = (ISSUE_UNDI32_COMMAND) (UINTN) Pxe->sw.EntryPoint; + } else { + Snp->IssueUndi32Command = (ISSUE_UNDI32_COMMAND) (UINTN) ((UINT8) (UINTN) Pxe + Pxe->sw.EntryPoint); + } + } + // + // Allocate a global CPB and DB buffer for this UNDI interface. + // we do this because: + // + // -UNDI 3.0 wants all the addresses passed to it (even the cpb and db) to be + // within 2GB limit, create them here and map them so that when undi calls + // v2p callback to check if the physical address is < 2gb, we will pass. + // + // -This is not a requirement for 3.1 or later UNDIs but the code looks + // simpler if we use the same cpb, db variables for both old and new undi + // interfaces from all the SNP interface calls (we don't map the buffers + // for the newer undi interfaces though) + // . + // -it is OK to allocate one global set of CPB, DB pair for each UNDI + // interface as EFI does not multi-task and so SNP will not be re-entered! + // + Status = PciIo->AllocateBuffer ( + PciIo, + AllocateAnyPages, + EfiBootServicesData, + SNP_MEM_PAGES (4096), + &Address, + 0 + ); + + if (Status != EFI_SUCCESS) { + DEBUG ((EFI_D_NET, "\nCould not allocate CPB and DB structures.\n")); + goto Error_DeleteSNP; + } + + Snp->Cpb = (VOID *) (UINTN) Address; + Snp->Db = (VOID *) ((UINTN) Address + 2048); + + // + // Find the correct BAR to do IO. + // + // Enumerate through the PCI BARs for the device to determine which one is + // the IO BAR. Save the index of the BAR into the adapter info structure. + // for regular 32bit BARs, 0 is memory mapped, 1 is io mapped + // + Snp->MemoryBarIndex = 0; + Snp->IoBarIndex = 1; + FoundMemoryBar = FALSE; + FoundIoBar = FALSE; + for (BarIndex = 0; BarIndex < PCI_MAX_BAR; BarIndex++) { + Status = PciIo->GetBarAttributes ( + PciIo, + BarIndex, + NULL, + (VOID**) &BarDesc + ); + if (Status == EFI_UNSUPPORTED) { + continue; + } else if (EFI_ERROR (Status)) { + goto Error_DeleteSNP; + } + + if ((!FoundMemoryBar) && (BarDesc->ResType == ACPI_ADDRESS_SPACE_TYPE_MEM)) { + Snp->MemoryBarIndex = BarIndex; + FoundMemoryBar = TRUE; + } else if ((!FoundIoBar) && (BarDesc->ResType == ACPI_ADDRESS_SPACE_TYPE_IO)) { + Snp->IoBarIndex = BarIndex; + FoundIoBar = TRUE; + } + + FreePool (BarDesc); + + if (FoundMemoryBar && FoundIoBar) { + break; + } + } + + Status = PxeStart (Snp); + + if (Status != EFI_SUCCESS) { + goto Error_DeleteSNP; + } + + Snp->Cdb.OpCode = PXE_OPCODE_GET_INIT_INFO; + Snp->Cdb.OpFlags = PXE_OPFLAGS_NOT_USED; + + Snp->Cdb.CPBsize = PXE_CPBSIZE_NOT_USED; + Snp->Cdb.CPBaddr = PXE_DBADDR_NOT_USED; + + Snp->Cdb.DBsize = (UINT16) sizeof (Snp->InitInfo); + Snp->Cdb.DBaddr = (UINT64)(UINTN) (&Snp->InitInfo); + + Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; + Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; + + Snp->Cdb.IFnum = Snp->IfNum; + Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; + + DEBUG ((EFI_D_NET, "\nSnp->undi.get_init_info() ")); + + (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); + + // + // Save the INIT Stat Code... + // + InitStatFlags = Snp->Cdb.StatFlags; + + if (Snp->Cdb.StatCode != PXE_STATCODE_SUCCESS) { + DEBUG ((EFI_D_NET, "\nSnp->undi.init_info() %xh:%xh\n", Snp->Cdb.StatFlags, Snp->Cdb.StatCode)); + PxeStop (Snp); + goto Error_DeleteSNP; + } + + // + // Initialize simple network protocol mode structure + // + Snp->Mode.State = EfiSimpleNetworkStopped; + Snp->Mode.HwAddressSize = Snp->InitInfo.HWaddrLen; + Snp->Mode.MediaHeaderSize = Snp->InitInfo.MediaHeaderLen; + Snp->Mode.MaxPacketSize = Snp->InitInfo.FrameDataLen; + Snp->Mode.NvRamAccessSize = Snp->InitInfo.NvWidth; + Snp->Mode.NvRamSize = Snp->InitInfo.NvCount * Snp->Mode.NvRamAccessSize; + Snp->Mode.IfType = Snp->InitInfo.IFtype; + Snp->Mode.MaxMCastFilterCount = Snp->InitInfo.MCastFilterCnt; + Snp->Mode.MCastFilterCount = 0; + + switch (InitStatFlags & PXE_STATFLAGS_CABLE_DETECT_MASK) { + case PXE_STATFLAGS_CABLE_DETECT_SUPPORTED: + Snp->CableDetectSupported = TRUE; + break; + + case PXE_STATFLAGS_CABLE_DETECT_NOT_SUPPORTED: + default: + Snp->CableDetectSupported = FALSE; + } + + switch (InitStatFlags & PXE_STATFLAGS_GET_STATUS_NO_MEDIA_MASK) { + case PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED: + Snp->MediaStatusSupported = TRUE; + break; + + case PXE_STATFLAGS_GET_STATUS_NO_MEDIA_NOT_SUPPORTED: + default: + Snp->MediaStatusSupported = FALSE; + } + + if (Snp->CableDetectSupported || Snp->MediaStatusSupported) { + Snp->Mode.MediaPresentSupported = TRUE; + } + + if ((Pxe->hw.Implementation & PXE_ROMID_IMP_STATION_ADDR_SETTABLE) != 0) { + Snp->Mode.MacAddressChangeable = TRUE; + } else { + Snp->Mode.MacAddressChangeable = FALSE; + } + + if ((Pxe->hw.Implementation & PXE_ROMID_IMP_MULTI_FRAME_SUPPORTED) != 0) { + Snp->Mode.MultipleTxSupported = TRUE; + } else { + Snp->Mode.MultipleTxSupported = FALSE; + } + + Snp->Mode.ReceiveFilterMask = EFI_SIMPLE_NETWORK_RECEIVE_UNICAST; + + if ((Pxe->hw.Implementation & PXE_ROMID_IMP_PROMISCUOUS_MULTICAST_RX_SUPPORTED) != 0) { + Snp->Mode.ReceiveFilterMask |= EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST; + + } + + if ((Pxe->hw.Implementation & PXE_ROMID_IMP_PROMISCUOUS_RX_SUPPORTED) != 0) { + Snp->Mode.ReceiveFilterMask |= EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS; + + } + + if ((Pxe->hw.Implementation & PXE_ROMID_IMP_BROADCAST_RX_SUPPORTED) != 0) { + Snp->Mode.ReceiveFilterMask |= EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST; + + } + + if ((Pxe->hw.Implementation & PXE_ROMID_IMP_FILTERED_MULTICAST_RX_SUPPORTED) != 0) { + Snp->Mode.ReceiveFilterMask |= EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST; + + } + + if ((Pxe->hw.Implementation & PXE_ROMID_IMP_PROMISCUOUS_MULTICAST_RX_SUPPORTED) != 0) { + Snp->Mode.ReceiveFilterMask |= EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST; + + } + + Snp->Mode.ReceiveFilterSetting = 0; + + // + // need to get the station address to save in the mode structure. we need to + // initialize the UNDI first for this. + // + Snp->TxRxBufferSize = Snp->InitInfo.MemoryRequired; + Status = PxeInit (Snp, PXE_OPFLAGS_INITIALIZE_DO_NOT_DETECT_CABLE); + + if (EFI_ERROR (Status)) { + PxeStop (Snp); + goto Error_DeleteSNP; + } + + Status = PxeGetStnAddr (Snp); + + if (Status != EFI_SUCCESS) { + DEBUG ((EFI_D_ERROR, "\nSnp->undi.get_station_addr() failed.\n")); + PxeShutdown (Snp); + PxeStop (Snp); + goto Error_DeleteSNP; + } + + Snp->Mode.MediaPresent = FALSE; + + // + // We should not leave UNDI started and initialized here. this DriverStart() + // routine must only find and attach the SNP interface to UNDI layer that it + // finds on the given handle! + // The UNDI layer will be started when upper layers call Snp->start. + // How ever, this DriverStart() must fill up the snp mode structure which + // contains the MAC address of the NIC. For this reason we started and + // initialized UNDI here, now we are done, do a shutdown and stop of the + // UNDI interface! + // + PxeShutdown (Snp); + PxeStop (Snp); + + // + // Create EXIT_BOOT_SERIVES Event + // + Status = gBS->CreateEventEx ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, + SnpNotifyExitBootServices, + Snp, + &gEfiEventExitBootServicesGuid, + &Snp->ExitBootServicesEvent + ); + if (EFI_ERROR (Status)) { + goto Error_DeleteSNP; + } + + // + // add SNP to the undi handle + // + Status = gBS->InstallProtocolInterface ( + &Controller, + &gEfiSimpleNetworkProtocolGuid, + EFI_NATIVE_INTERFACE, + &(Snp->Snp) + ); + + if (!EFI_ERROR (Status)) { + return Status; + } + + PciIo->FreeBuffer ( + PciIo, + SNP_MEM_PAGES (4096), + Snp->Cpb + ); + +Error_DeleteSNP: + + if (Snp->RecycledTxBuf != NULL) { + FreePool (Snp->RecycledTxBuf); + } + + PciIo->FreeBuffer ( + PciIo, + SNP_MEM_PAGES (sizeof (SNP_DRIVER)), + Snp + ); +NiiError: + gBS->CloseProtocol ( + Controller, + &gEfiNetworkInterfaceIdentifierProtocolGuid_31, + This->DriverBindingHandle, + Controller + ); + + gBS->CloseProtocol ( + Controller, + &gEfiDevicePathProtocolGuid, + This->DriverBindingHandle, + Controller + ); + + // + // If we got here that means we are in error state. + // + if (!EFI_ERROR (Status)) { + Status = EFI_DEVICE_ERROR; + } + + return Status; +} + +/** + Stop this driver on ControllerHandle. This service is called by the + EFI boot service DisconnectController(). In order to + make drivers as small as possible, there are a few calling + restrictions for this service. DisconnectController() + must follow these calling restrictions. If any other agent wishes + to call Stop() it must also follow these calling restrictions. + + @param This Protocol instance pointer. + @param ControllerHandle Handle of device to stop driver on + @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of + children is zero stop the entire bus driver. + @param ChildHandleBuffer List of Child Handles to Stop. + + @retval EFI_SUCCESS This driver is removed ControllerHandle + @retval other This driver was not removed from this device + +**/ +EFI_STATUS +EFIAPI +SimpleNetworkDriverStop ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE Controller, + IN UINTN NumberOfChildren, + IN EFI_HANDLE *ChildHandleBuffer + ) +{ + EFI_STATUS Status; + EFI_SIMPLE_NETWORK_PROTOCOL *SnpProtocol; + SNP_DRIVER *Snp; + EFI_PCI_IO_PROTOCOL *PciIo; + + // + // Get our context back. + // + Status = gBS->OpenProtocol ( + Controller, + &gEfiSimpleNetworkProtocolGuid, + (VOID **) &SnpProtocol, + This->DriverBindingHandle, + Controller, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + + if (EFI_ERROR (Status)) { + return EFI_UNSUPPORTED; + } + + Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (SnpProtocol); + + Status = gBS->UninstallProtocolInterface ( + Controller, + &gEfiSimpleNetworkProtocolGuid, + &Snp->Snp + ); + + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Close EXIT_BOOT_SERIVES Event + // + gBS->CloseEvent (Snp->ExitBootServicesEvent); + + Status = gBS->CloseProtocol ( + Controller, + &gEfiNetworkInterfaceIdentifierProtocolGuid_31, + This->DriverBindingHandle, + Controller + ); + + Status = gBS->CloseProtocol ( + Controller, + &gEfiDevicePathProtocolGuid, + This->DriverBindingHandle, + Controller + ); + + PxeShutdown (Snp); + PxeStop (Snp); + + FreePool (Snp->RecycledTxBuf); + + PciIo = Snp->PciIo; + PciIo->FreeBuffer ( + PciIo, + SNP_MEM_PAGES (4096), + Snp->Cpb + ); + + PciIo->FreeBuffer ( + PciIo, + SNP_MEM_PAGES (sizeof (SNP_DRIVER)), + Snp + ); + + return Status; +} + +// +// Simple Network Protocol Driver Global Variables +// +EFI_DRIVER_BINDING_PROTOCOL gSimpleNetworkDriverBinding = { + SimpleNetworkDriverSupported, + SimpleNetworkDriverStart, + SimpleNetworkDriverStop, + 0xa, + NULL, + NULL +}; + +/** + The SNP driver entry point. + + @param ImageHandle The driver image handle. + @param SystemTable The system table. + + @retval EFI_SUCEESS Initialization routine has found UNDI hardware, + loaded it's ROM, and installed a notify event for + the Network Indentifier Interface Protocol + successfully. + @retval Other Return value from HandleProtocol for + DeviceIoProtocol or LoadedImageProtocol + +**/ +EFI_STATUS +EFIAPI +InitializeSnpNiiDriver ( + IN EFI_HANDLE ImageHandle, + IN EFI_SYSTEM_TABLE *SystemTable + ) +{ + return EfiLibInstallDriverBindingComponentName2 ( + ImageHandle, + SystemTable, + &gSimpleNetworkDriverBinding, + ImageHandle, + &gSimpleNetworkComponentName, + &gSimpleNetworkComponentName2 + ); +} diff --git a/NetworkPkg/SnpDxe/Snp.h b/NetworkPkg/SnpDxe/Snp.h new file mode 100644 index 0000000000..e6b6293039 --- /dev/null +++ b/NetworkPkg/SnpDxe/Snp.h @@ -0,0 +1,1033 @@ +/** @file + Declaration of strctures and functions for SnpDxe driver. + +Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ +#ifndef _SNP_H_ +#define _SNP_H_ + + +#include + +#include +#include +#include +#include + +#include + +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include + +#define FOUR_GIGABYTES (UINT64) 0x100000000ULL + + +#define SNP_DRIVER_SIGNATURE SIGNATURE_32 ('s', 'n', 'd', 's') +#define MAX_MAP_LENGTH 100 + +#define PCI_BAR_IO_MASK 0x00000003 +#define PCI_BAR_IO_MODE 0x00000001 + +#define PCI_BAR_MEM_MASK 0x0000000F +#define PCI_BAR_MEM_MODE 0x00000000 +#define PCI_BAR_MEM_64BIT 0x00000004 + +#define SNP_TX_BUFFER_INCREASEMENT MAX_XMIT_BUFFERS +#define SNP_MAX_TX_BUFFER_NUM 65536 + +typedef +EFI_STATUS +(EFIAPI *ISSUE_UNDI32_COMMAND) ( + UINT64 Cdb + ); + +typedef struct { + UINT32 Signature; + EFI_LOCK Lock; + + EFI_SIMPLE_NETWORK_PROTOCOL Snp; + EFI_SIMPLE_NETWORK_MODE Mode; + + EFI_HANDLE DeviceHandle; + EFI_DEVICE_PATH_PROTOCOL *DevicePath; + + // + // Local instance data needed by SNP driver + // + // Pointer to S/W UNDI API entry point + // This will be NULL for H/W UNDI + // + ISSUE_UNDI32_COMMAND IssueUndi32Command; + + BOOLEAN IsSwUndi; + + // + // undi interface number, if one undi manages more nics + // + PXE_IFNUM IfNum; + + // + // Allocated tx/rx buffer that was passed to UNDI Initialize. + // + UINT32 TxRxBufferSize; + VOID *TxRxBuffer; + // + // mappable buffers for receive and fill header for undi3.0 + // these will be used if the user buffers are above 4GB limit (instead of + // mapping the user buffers) + // + UINT8 *ReceiveBufffer; + VOID *ReceiveBufferUnmap; + UINT8 *FillHeaderBuffer; + VOID *FillHeaderBufferUnmap; + + EFI_PCI_IO_PROTOCOL *PciIo; + UINT8 IoBarIndex; + UINT8 MemoryBarIndex; + + // + // Buffers for command descriptor block, command parameter block + // and data block. + // + PXE_CDB Cdb; + VOID *Cpb; + VOID *CpbUnmap; + VOID *Db; + + // + // UNDI structure, we need to remember the init info for a long time! + // + PXE_DB_GET_INIT_INFO InitInfo; + + VOID *SnpDriverUnmap; + // + // when ever we map an address, we must remember it's address and the un-map + // cookie so that we can unmap later + // + struct MAP_LIST { + EFI_PHYSICAL_ADDRESS VirtualAddress; + VOID *MapCookie; + } MapList[MAX_MAP_LENGTH]; + + EFI_EVENT ExitBootServicesEvent; + + // + // Whether UNDI support reporting media status from GET_STATUS command, + // i.e. PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED or + // PXE_STATFLAGS_GET_STATUS_NO_MEDIA_NOT_SUPPORTED + // + BOOLEAN MediaStatusSupported; + + // + // Whether UNDI support cable detect for INITIALIZE command, + // i.e. PXE_STATFLAGS_CABLE_DETECT_SUPPORTED or + // PXE_STATFLAGS_CABLE_DETECT_NOT_SUPPORTED + // + BOOLEAN CableDetectSupported; + + // + // Array of the recycled transmit buffer address from UNDI. + // + UINT64 *RecycledTxBuf; + // + // The maximum number of recycled buffer pointers in RecycledTxBuf. + // + UINT32 MaxRecycledTxBuf; + // + // Current number of recycled buffer pointers in RecycledTxBuf. + // + UINT32 RecycledTxBufCount; +} SNP_DRIVER; + +#define EFI_SIMPLE_NETWORK_DEV_FROM_THIS(a) CR (a, SNP_DRIVER, Snp, SNP_DRIVER_SIGNATURE) + +// +// Global Variables +// +extern EFI_DRIVER_BINDING_PROTOCOL gSimpleNetworkDriverBinding; +extern EFI_COMPONENT_NAME_PROTOCOL gSimpleNetworkComponentName; +extern EFI_COMPONENT_NAME2_PROTOCOL gSimpleNetworkComponentName2; + +/** + this routine calls undi to start the interface and changes the snp state. + + @param Snp pointer to snp driver structure + + @retval EFI_DEVICE_ERROR UNDI could not be started + @retval EFI_SUCCESS UNDI is started successfully + +**/ +EFI_STATUS +PxeStart ( + IN SNP_DRIVER *Snp + ); + +/** + this routine calls undi to stop the interface and changes the snp state. + + @param Snp pointer to snp driver structure + + @retval EFI_INVALID_PARAMETER invalid parameter + @retval EFI_NOT_STARTED SNP is not started + @retval EFI_DEVICE_ERROR SNP is not initialized + @retval EFI_UNSUPPORTED operation unsupported + +**/ +EFI_STATUS +PxeStop ( + SNP_DRIVER *Snp + ); + +/** + this routine calls undi to initialize the interface. + + @param Snp pointer to snp driver structure + @param CableDetectFlag Do/don't detect the cable (depending on what undi supports) + + @retval EFI_SUCCESS UNDI is initialized successfully + @retval EFI_DEVICE_ERROR UNDI could not be initialized + @retval Other other errors + +**/ +EFI_STATUS +PxeInit ( + SNP_DRIVER *Snp, + UINT16 CableDetectFlag + ); + +/** + this routine calls undi to shut down the interface. + + @param Snp pointer to snp driver structure + + @retval EFI_SUCCESS UNDI is shut down successfully + @retval EFI_DEVICE_ERROR UNDI could not be shut down + +**/ +EFI_STATUS +PxeShutdown ( + IN SNP_DRIVER *Snp + ); + +/** + this routine calls undi to read the MAC address of the NIC and updates the + mode structure with the address. + + @param Snp pointer to snp driver structure. + + @retval EFI_SUCCESS the MAC address of the NIC is read successfully. + @retval EFI_DEVICE_ERROR failed to read the MAC address of the NIC. + +**/ +EFI_STATUS +PxeGetStnAddr ( + SNP_DRIVER *Snp + ); + +/** + Call undi to get the status of the interrupts, get the list of recycled transmit + buffers that completed transmitting. The recycled transmit buffer address will + be saved into Snp->RecycledTxBuf. This function will also update the MediaPresent + field of EFI_SIMPLE_NETWORK_MODE if UNDI support it. + + @param[in] Snp Pointer to snp driver structure. + @param[out] InterruptStatusPtr A non null pointer to contain the interrupt + status. + @param[in] GetTransmittedBuf Set to TRUE to retrieve the recycled transmit + buffer address. + + @retval EFI_SUCCESS The status of the network interface was retrieved. + @retval EFI_DEVICE_ERROR The command could not be sent to the network + interface. + +**/ +EFI_STATUS +PxeGetStatus ( + IN SNP_DRIVER *Snp, + OUT UINT32 *InterruptStatusPtr, + IN BOOLEAN GetTransmittedBuf + ); + +/** + This is a callback routine supplied to UNDI3.1 at undi_start time. + UNDI call this routine when it wants to have exclusive access to a critical + section of the code/data. + New callbacks for 3.1: + there won't be a virtual2physical callback for UNDI 3.1 because undi3.1 uses + the MemMap call to map the required address by itself! + + @param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this to + store Undi interface context (Undi does not read or write + this variable) + @param Enable non-zero indicates acquire + zero indicates release +**/ +VOID +EFIAPI +SnpUndi32CallbackBlock ( + IN UINT64 UniqueId, + IN UINT32 Enable + ); + +/** + This is a callback routine supplied to UNDI at undi_start time. + UNDI call this routine with the number of micro seconds when it wants to + pause. + + @param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this to + store Undi interface context (Undi does not read or write + this variable) + @param MicroSeconds number of micro seconds to pause, ususlly multiple of 10. +**/ +VOID +EFIAPI +SnpUndi32CallbackDelay ( + IN UINT64 UniqueId, + IN UINT64 MicroSeconds + ); + +/** + This is a callback routine supplied to UNDI at undi_start time. + This is the IO routine for UNDI3.1 to start CPB. + + @param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this + to store Undi interface context (Undi does not read or + write this variable) + @param ReadOrWrite indicates read or write, IO or Memory. + @param NumBytes number of bytes to read or write. + @param MemOrPortAddr IO or memory address to read from or write to. + @param BufferPtr memory location to read into or that contains the bytes + to write. +**/ +VOID +EFIAPI +SnpUndi32CallbackMemio ( + IN UINT64 UniqueId, + IN UINT8 ReadOrWrite, + IN UINT8 NumBytes, + IN UINT64 MemOrPortAddr, + IN OUT UINT64 BufferPtr + ); + +/** + This is a callback routine supplied to UNDI at undi_start time. + UNDI call this routine when it has to map a CPU address to a device + address. + + @param UniqueId - This was supplied to UNDI at Undi_Start, SNP uses this to store + Undi interface context (Undi does not read or write this variable) + @param CpuAddr - Virtual address to be mapped! + @param NumBytes - size of memory to be mapped + @param Direction - direction of data flow for this memory's usage: + cpu->device, device->cpu or both ways + @param DeviceAddrPtr - pointer to return the mapped device address + +**/ +VOID +EFIAPI +SnpUndi32CallbackMap ( + IN UINT64 UniqueId, + IN UINT64 CpuAddr, + IN UINT32 NumBytes, + IN UINT32 Direction, + IN OUT UINT64 DeviceAddrPtr + ); + +/** + This is a callback routine supplied to UNDI at undi_start time. + UNDI call this routine when it wants to unmap an address that was previously + mapped using map callback. + + @param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this to store. + Undi interface context (Undi does not read or write this variable) + @param CpuAddr Virtual address that was mapped! + @param NumBytes size of memory mapped + @param Direction direction of data flow for this memory's usage: + cpu->device, device->cpu or both ways + @param DeviceAddr the mapped device address + +**/ +VOID +EFIAPI +SnpUndi32CallbackUnmap ( + IN UINT64 UniqueId, + IN UINT64 CpuAddr, + IN UINT32 NumBytes, + IN UINT32 Direction, + IN UINT64 DeviceAddr + ); + +/** + This is a callback routine supplied to UNDI at undi_start time. + UNDI call this routine when it wants synchronize the virtual buffer contents + with the mapped buffer contents. The virtual and mapped buffers need not + correspond to the same physical memory (especially if the virtual address is + > 4GB). Depending on the direction for which the buffer is mapped, undi will + need to synchronize their contents whenever it writes to/reads from the buffer + using either the cpu address or the device address. + + EFI does not provide a sync call, since virt=physical, we sould just do + the synchronization ourself here! + + @param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this to store + Undi interface context (Undi does not read or write this variable) + @param CpuAddr Virtual address that was mapped! + @param NumBytes size of memory mapped. + @param Direction direction of data flow for this memory's usage: + cpu->device, device->cpu or both ways. + @param DeviceAddr the mapped device address. + +**/ +VOID +EFIAPI +SnpUndi32CallbackSync ( + IN UINT64 UniqueId, + IN UINT64 CpuAddr, + IN UINT32 NumBytes, + IN UINT32 Direction, + IN UINT64 DeviceAddr + ); + +/** + Changes the state of a network interface from "stopped" to "started". + + This function starts a network interface. If the network interface successfully + starts, then EFI_SUCCESS will be returned. + + @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. + + @retval EFI_SUCCESS The network interface was started. + @retval EFI_ALREADY_STARTED The network interface is already in the started state. + @retval EFI_INVALID_PARAMETER This parameter was NULL or did not point to a valid + EFI_SIMPLE_NETWORK_PROTOCOL structure. + @retval EFI_DEVICE_ERROR The command could not be sent to the network interface. + @retval EFI_UNSUPPORTED This function is not supported by the network interface. + +**/ +EFI_STATUS +EFIAPI +SnpUndi32Start ( + IN EFI_SIMPLE_NETWORK_PROTOCOL *This + ); + +/** + Changes the state of a network interface from "started" to "stopped". + + This function stops a network interface. This call is only valid if the network + interface is in the started state. If the network interface was successfully + stopped, then EFI_SUCCESS will be returned. + + @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. + + + @retval EFI_SUCCESS The network interface was stopped. + @retval EFI_NOT_STARTED The network interface has not been started. + @retval EFI_INVALID_PARAMETER This parameter was NULL or did not point to a valid + EFI_SIMPLE_NETWORK_PROTOCOL structure. + @retval EFI_DEVICE_ERROR The command could not be sent to the network interface. + @retval EFI_UNSUPPORTED This function is not supported by the network interface. + +**/ +EFI_STATUS +EFIAPI +SnpUndi32Stop ( + IN EFI_SIMPLE_NETWORK_PROTOCOL *This + ); + +/** + Resets a network adapter and allocates the transmit and receive buffers + required by the network interface; optionally, also requests allocation of + additional transmit and receive buffers. + + This function allocates the transmit and receive buffers required by the network + interface. If this allocation fails, then EFI_OUT_OF_RESOURCES is returned. + If the allocation succeeds and the network interface is successfully initialized, + then EFI_SUCCESS will be returned. + + @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. + + @param ExtraRxBufferSize The size, in bytes, of the extra receive buffer space + that the driver should allocate for the network interface. + Some network interfaces will not be able to use the + extra buffer, and the caller will not know if it is + actually being used. + @param ExtraTxBufferSize The size, in bytes, of the extra transmit buffer space + that the driver should allocate for the network interface. + Some network interfaces will not be able to use the + extra buffer, and the caller will not know if it is + actually being used. + + @retval EFI_SUCCESS The network interface was initialized. + @retval EFI_NOT_STARTED The network interface has not been started. + @retval EFI_OUT_OF_RESOURCES There was not enough memory for the transmit and + receive buffers. + @retval EFI_INVALID_PARAMETER This parameter was NULL or did not point to a valid + EFI_SIMPLE_NETWORK_PROTOCOL structure. + @retval EFI_DEVICE_ERROR The command could not be sent to the network interface. + @retval EFI_UNSUPPORTED The increased buffer size feature is not supported. + +**/ +EFI_STATUS +EFIAPI +SnpUndi32Initialize ( + IN EFI_SIMPLE_NETWORK_PROTOCOL *This, + IN UINTN ExtraRxBufferSize OPTIONAL, + IN UINTN ExtraTxBufferSize OPTIONAL + ); + +/** + Resets a network adapter and reinitializes it with the parameters that were + provided in the previous call to Initialize(). + + This function resets a network adapter and reinitializes it with the parameters + that were provided in the previous call to Initialize(). The transmit and + receive queues are emptied and all pending interrupts are cleared. + Receive filters, the station address, the statistics, and the multicast-IP-to-HW + MAC addresses are not reset by this call. If the network interface was + successfully reset, then EFI_SUCCESS will be returned. If the driver has not + been initialized, EFI_DEVICE_ERROR will be returned. + + @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. + @param ExtendedVerification Indicates that the driver may perform a more + exhaustive verification operation of the device + during reset. + + @retval EFI_SUCCESS The network interface was reset. + @retval EFI_NOT_STARTED The network interface has not been started. + @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value. + @retval EFI_DEVICE_ERROR The command could not be sent to the network interface. + @retval EFI_UNSUPPORTED This function is not supported by the network interface. + +**/ +EFI_STATUS +EFIAPI +SnpUndi32Reset ( + IN EFI_SIMPLE_NETWORK_PROTOCOL *This, + IN BOOLEAN ExtendedVerification + ); + +/** + Resets a network adapter and leaves it in a state that is safe for another + driver to initialize. + + This function releases the memory buffers assigned in the Initialize() call. + Pending transmits and receives are lost, and interrupts are cleared and disabled. + After this call, only the Initialize() and Stop() calls may be used. If the + network interface was successfully shutdown, then EFI_SUCCESS will be returned. + If the driver has not been initialized, EFI_DEVICE_ERROR will be returned. + + @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. + + @retval EFI_SUCCESS The network interface was shutdown. + @retval EFI_NOT_STARTED The network interface has not been started. + @retval EFI_INVALID_PARAMETER This parameter was NULL or did not point to a valid + EFI_SIMPLE_NETWORK_PROTOCOL structure. + @retval EFI_DEVICE_ERROR The command could not be sent to the network interface. + +**/ +EFI_STATUS +EFIAPI +SnpUndi32Shutdown ( + IN EFI_SIMPLE_NETWORK_PROTOCOL *This + ); + +/** + Manages the multicast receive filters of a network interface. + + This function is used enable and disable the hardware and software receive + filters for the underlying network device. + The receive filter change is broken down into three steps: + * The filter mask bits that are set (ON) in the Enable parameter are added to + the current receive filter settings. + * The filter mask bits that are set (ON) in the Disable parameter are subtracted + from the updated receive filter settings. + * If the resulting receive filter setting is not supported by the hardware a + more liberal setting is selected. + If the same bits are set in the Enable and Disable parameters, then the bits + in the Disable parameter takes precedence. + If the ResetMCastFilter parameter is TRUE, then the multicast address list + filter is disabled (irregardless of what other multicast bits are set in the + Enable and Disable parameters). The SNP->Mode->MCastFilterCount field is set + to zero. The Snp->Mode->MCastFilter contents are undefined. + After enabling or disabling receive filter settings, software should verify + the new settings by checking the Snp->Mode->ReceiveFilterSettings, + Snp->Mode->MCastFilterCount and Snp->Mode->MCastFilter fields. + Note: Some network drivers and/or devices will automatically promote receive + filter settings if the requested setting can not be honored. For example, if + a request for four multicast addresses is made and the underlying hardware + only supports two multicast addresses the driver might set the promiscuous + or promiscuous multicast receive filters instead. The receiving software is + responsible for discarding any extra packets that get through the hardware + receive filters. + Note: Note: To disable all receive filter hardware, the network driver must + be Shutdown() and Stopped(). Calling ReceiveFilters() with Disable set to + Snp->Mode->ReceiveFilterSettings will make it so no more packets are + returned by the Receive() function, but the receive hardware may still be + moving packets into system memory before inspecting and discarding them. + Unexpected system errors, reboots and hangs can occur if an OS is loaded + and the network devices are not Shutdown() and Stopped(). + If ResetMCastFilter is TRUE, then the multicast receive filter list on the + network interface will be reset to the default multicast receive filter list. + If ResetMCastFilter is FALSE, and this network interface allows the multicast + receive filter list to be modified, then the MCastFilterCnt and MCastFilter + are used to update the current multicast receive filter list. The modified + receive filter list settings can be found in the MCastFilter field of + EFI_SIMPLE_NETWORK_MODE. If the network interface does not allow the multicast + receive filter list to be modified, then EFI_INVALID_PARAMETER will be returned. + If the driver has not been initialized, EFI_DEVICE_ERROR will be returned. + If the receive filter mask and multicast receive filter list have been + successfully updated on the network interface, EFI_SUCCESS will be returned. + + @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. + @param Enable A bit mask of receive filters to enable on the network + interface. + @param Disable A bit mask of receive filters to disable on the network + interface. For backward compatibility with EFI 1.1 + platforms, the EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST bit + must be set when the ResetMCastFilter parameter is TRUE. + @param ResetMCastFilter Set to TRUE to reset the contents of the multicast + receive filters on the network interface to their + default values. + @param MCastFilterCnt Number of multicast HW MAC addresses in the new MCastFilter + list. This value must be less than or equal to the + MCastFilterCnt field of EFI_SIMPLE_NETWORK_MODE. + This field is optional if ResetMCastFilter is TRUE. + @param MCastFilter A pointer to a list of new multicast receive filter HW + MAC addresses. This list will replace any existing + multicast HW MAC address list. This field is optional + if ResetMCastFilter is TRUE. + + @retval EFI_SUCCESS The multicast receive filter list was updated. + @retval EFI_NOT_STARTED The network interface has not been started. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + * This is NULL + * There are bits set in Enable that are not set + in Snp->Mode->ReceiveFilterMask + * There are bits set in Disable that are not set + in Snp->Mode->ReceiveFilterMask + * Multicast is being enabled (the + EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST bit is + set in Enable, it is not set in Disable, and + ResetMCastFilter is FALSE) and MCastFilterCount + is zero + * Multicast is being enabled and MCastFilterCount + is greater than Snp->Mode->MaxMCastFilterCount + * Multicast is being enabled and MCastFilter is NULL + * Multicast is being enabled and one or more of + the addresses in the MCastFilter list are not + valid multicast MAC addresses + @retval EFI_DEVICE_ERROR One or more of the following conditions is TRUE: + * The network interface has been started but has + not been initialized + * An unexpected error was returned by the + underlying network driver or device + @retval EFI_UNSUPPORTED This function is not supported by the network + interface. + +**/ +EFI_STATUS +EFIAPI +SnpUndi32ReceiveFilters ( + IN EFI_SIMPLE_NETWORK_PROTOCOL *This, + IN UINT32 Enable, + IN UINT32 Disable, + IN BOOLEAN ResetMCastFilter, + IN UINTN MCastFilterCnt, OPTIONAL + IN EFI_MAC_ADDRESS *MCastFilter OPTIONAL + ); + +/** + Modifies or resets the current station address, if supported. + + This function modifies or resets the current station address of a network + interface, if supported. If Reset is TRUE, then the current station address is + set to the network interface's permanent address. If Reset is FALSE, and the + network interface allows its station address to be modified, then the current + station address is changed to the address specified by New. If the network + interface does not allow its station address to be modified, then + EFI_INVALID_PARAMETER will be returned. If the station address is successfully + updated on the network interface, EFI_SUCCESS will be returned. If the driver + has not been initialized, EFI_DEVICE_ERROR will be returned. + + @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. + @param Reset Flag used to reset the station address to the network interface's + permanent address. + @param New New station address to be used for the network interface. + + + @retval EFI_SUCCESS The network interface's station address was updated. + @retval EFI_NOT_STARTED The Simple Network Protocol interface has not been + started by calling Start(). + @retval EFI_INVALID_PARAMETER The New station address was not accepted by the NIC. + @retval EFI_INVALID_PARAMETER Reset is FALSE and New is NULL. + @retval EFI_DEVICE_ERROR The Simple Network Protocol interface has not + been initialized by calling Initialize(). + @retval EFI_DEVICE_ERROR An error occurred attempting to set the new + station address. + @retval EFI_UNSUPPORTED The NIC does not support changing the network + interface's station address. + +**/ +EFI_STATUS +EFIAPI +SnpUndi32StationAddress ( + IN EFI_SIMPLE_NETWORK_PROTOCOL *This, + IN BOOLEAN Reset, + IN EFI_MAC_ADDRESS *New OPTIONAL + ); + +/** + Resets or collects the statistics on a network interface. + + This function resets or collects the statistics on a network interface. If the + size of the statistics table specified by StatisticsSize is not big enough for + all the statistics that are collected by the network interface, then a partial + buffer of statistics is returned in StatisticsTable, StatisticsSize is set to + the size required to collect all the available statistics, and + EFI_BUFFER_TOO_SMALL is returned. + If StatisticsSize is big enough for all the statistics, then StatisticsTable + will be filled, StatisticsSize will be set to the size of the returned + StatisticsTable structure, and EFI_SUCCESS is returned. + If the driver has not been initialized, EFI_DEVICE_ERROR will be returned. + If Reset is FALSE, and both StatisticsSize and StatisticsTable are NULL, then + no operations will be performed, and EFI_SUCCESS will be returned. + If Reset is TRUE, then all of the supported statistics counters on this network + interface will be reset to zero. + + @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. + @param Reset Set to TRUE to reset the statistics for the network interface. + @param StatisticsSize On input the size, in bytes, of StatisticsTable. On output + the size, in bytes, of the resulting table of statistics. + @param StatisticsTable A pointer to the EFI_NETWORK_STATISTICS structure that + contains the statistics. Type EFI_NETWORK_STATISTICS is + defined in "Related Definitions" below. + + @retval EFI_SUCCESS The requested operation succeeded. + @retval EFI_NOT_STARTED The Simple Network Protocol interface has not been + started by calling Start(). + @retval EFI_BUFFER_TOO_SMALL StatisticsSize is not NULL and StatisticsTable is + NULL. The current buffer size that is needed to + hold all the statistics is returned in StatisticsSize. + @retval EFI_BUFFER_TOO_SMALL StatisticsSize is not NULL and StatisticsTable is + not NULL. The current buffer size that is needed + to hold all the statistics is returned in + StatisticsSize. A partial set of statistics is + returned in StatisticsTable. + @retval EFI_INVALID_PARAMETER StatisticsSize is NULL and StatisticsTable is not + NULL. + @retval EFI_DEVICE_ERROR The Simple Network Protocol interface has not + been initialized by calling Initialize(). + @retval EFI_DEVICE_ERROR An error was encountered collecting statistics + from the NIC. + @retval EFI_UNSUPPORTED The NIC does not support collecting statistics + from the network interface. + +**/ +EFI_STATUS +EFIAPI +SnpUndi32Statistics ( + IN EFI_SIMPLE_NETWORK_PROTOCOL *This, + IN BOOLEAN Reset, + IN OUT UINTN *StatisticsSize, OPTIONAL + IN OUT EFI_NETWORK_STATISTICS *StatisticsTable OPTIONAL + ); + +/** + Converts a multicast IP address to a multicast HW MAC address. + + This function converts a multicast IP address to a multicast HW MAC address + for all packet transactions. If the mapping is accepted, then EFI_SUCCESS will + be returned. + + @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. + @param IPv6 Set to TRUE if the multicast IP address is IPv6 [RFC 2460]. + Set to FALSE if the multicast IP address is IPv4 [RFC 791]. + @param IP The multicast IP address that is to be converted to a multicast + HW MAC address. + @param MAC The multicast HW MAC address that is to be generated from IP. + + @retval EFI_SUCCESS The multicast IP address was mapped to the + multicast HW MAC address. + @retval EFI_NOT_STARTED The Simple Network Protocol interface has not + been started by calling Start(). + @retval EFI_INVALID_PARAMETER IP is NULL. + @retval EFI_INVALID_PARAMETER MAC is NULL. + @retval EFI_INVALID_PARAMETER IP does not point to a valid IPv4 or IPv6 + multicast address. + @retval EFI_DEVICE_ERROR The Simple Network Protocol interface has not + been initialized by calling Initialize(). + @retval EFI_UNSUPPORTED IPv6 is TRUE and the implementation does not + support IPv6 multicast to MAC address conversion. + +**/ +EFI_STATUS +EFIAPI +SnpUndi32McastIpToMac ( + IN EFI_SIMPLE_NETWORK_PROTOCOL *This, + IN BOOLEAN IPv6, + IN EFI_IP_ADDRESS *IP, + OUT EFI_MAC_ADDRESS *MAC + ); + +/** + Performs read and write operations on the NVRAM device attached to a network + interface. + + This function performs read and write operations on the NVRAM device attached + to a network interface. If ReadWrite is TRUE, a read operation is performed. + If ReadWrite is FALSE, a write operation is performed. Offset specifies the + byte offset at which to start either operation. Offset must be a multiple of + NvRamAccessSize , and it must have a value between zero and NvRamSize. + BufferSize specifies the length of the read or write operation. BufferSize must + also be a multiple of NvRamAccessSize, and Offset + BufferSize must not exceed + NvRamSize. + If any of the above conditions is not met, then EFI_INVALID_PARAMETER will be + returned. + If all the conditions are met and the operation is "read," the NVRAM device + attached to the network interface will be read into Buffer and EFI_SUCCESS + will be returned. If this is a write operation, the contents of Buffer will be + used to update the contents of the NVRAM device attached to the network + interface and EFI_SUCCESS will be returned. + + It does the basic checking on the input parameters and retrieves snp structure + and then calls the read_nvdata() call which does the actual reading + + @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. + @param ReadWrite TRUE for read operations, FALSE for write operations. + @param Offset Byte offset in the NVRAM device at which to start the read or + write operation. This must be a multiple of NvRamAccessSize + and less than NvRamSize. (See EFI_SIMPLE_NETWORK_MODE) + @param BufferSize The number of bytes to read or write from the NVRAM device. + This must also be a multiple of NvramAccessSize. + @param Buffer A pointer to the data buffer. + + @retval EFI_SUCCESS The NVRAM access was performed. + @retval EFI_NOT_STARTED The network interface has not been started. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + * The This parameter is NULL + * The This parameter does not point to a valid + EFI_SIMPLE_NETWORK_PROTOCOL structure + * The Offset parameter is not a multiple of + EFI_SIMPLE_NETWORK_MODE.NvRamAccessSize + * The Offset parameter is not less than + EFI_SIMPLE_NETWORK_MODE.NvRamSize + * The BufferSize parameter is not a multiple of + EFI_SIMPLE_NETWORK_MODE.NvRamAccessSize + * The Buffer parameter is NULL + @retval EFI_DEVICE_ERROR The command could not be sent to the network + interface. + @retval EFI_UNSUPPORTED This function is not supported by the network + interface. + +**/ +EFI_STATUS +EFIAPI +SnpUndi32NvData ( + IN EFI_SIMPLE_NETWORK_PROTOCOL *This, + IN BOOLEAN ReadWrite, + IN UINTN Offset, + IN UINTN BufferSize, + IN OUT VOID *Buffer + ); + +/** + Reads the current interrupt status and recycled transmit buffer status from a + network interface. + + This function gets the current interrupt and recycled transmit buffer status + from the network interface. The interrupt status is returned as a bit mask in + InterruptStatus. If InterruptStatus is NULL, the interrupt status will not be + read. If TxBuf is not NULL, a recycled transmit buffer address will be retrieved. + If a recycled transmit buffer address is returned in TxBuf, then the buffer has + been successfully transmitted, and the status for that buffer is cleared. If + the status of the network interface is successfully collected, EFI_SUCCESS + will be returned. If the driver has not been initialized, EFI_DEVICE_ERROR will + be returned. + + @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. + @param InterruptStatus A pointer to the bit mask of the currently active + interrupts (see "Related Definitions"). If this is NULL, + the interrupt status will not be read from the device. + If this is not NULL, the interrupt status will be read + from the device. When the interrupt status is read, it + will also be cleared. Clearing the transmit interrupt does + not empty the recycled transmit buffer array. + @param TxBuf Recycled transmit buffer address. The network interface + will not transmit if its internal recycled transmit + buffer array is full. Reading the transmit buffer does + not clear the transmit interrupt. If this is NULL, then + the transmit buffer status will not be read. If there + are no transmit buffers to recycle and TxBuf is not NULL, + TxBuf will be set to NULL. + + @retval EFI_SUCCESS The status of the network interface was retrieved. + @retval EFI_NOT_STARTED The network interface has not been started. + @retval EFI_INVALID_PARAMETER This parameter was NULL or did not point to a valid + EFI_SIMPLE_NETWORK_PROTOCOL structure. + @retval EFI_DEVICE_ERROR The command could not be sent to the network + interface. + +**/ +EFI_STATUS +EFIAPI +SnpUndi32GetStatus ( + IN EFI_SIMPLE_NETWORK_PROTOCOL *This, + OUT UINT32 *InterruptStatus, OPTIONAL + OUT VOID **TxBuf OPTIONAL + ); + +/** + Places a packet in the transmit queue of a network interface. + + This function places the packet specified by Header and Buffer on the transmit + queue. If HeaderSize is nonzero and HeaderSize is not equal to + This->Mode->MediaHeaderSize, then EFI_INVALID_PARAMETER will be returned. If + BufferSize is less than This->Mode->MediaHeaderSize, then EFI_BUFFER_TOO_SMALL + will be returned. If Buffer is NULL, then EFI_INVALID_PARAMETER will be + returned. If HeaderSize is nonzero and DestAddr or Protocol is NULL, then + EFI_INVALID_PARAMETER will be returned. If the transmit engine of the network + interface is busy, then EFI_NOT_READY will be returned. If this packet can be + accepted by the transmit engine of the network interface, the packet contents + specified by Buffer will be placed on the transmit queue of the network + interface, and EFI_SUCCESS will be returned. GetStatus() can be used to + determine when the packet has actually been transmitted. The contents of the + Buffer must not be modified until the packet has actually been transmitted. + The Transmit() function performs nonblocking I/O. A caller who wants to perform + blocking I/O, should call Transmit(), and then GetStatus() until the + transmitted buffer shows up in the recycled transmit buffer. + If the driver has not been initialized, EFI_DEVICE_ERROR will be returned. + + @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. + @param HeaderSize The size, in bytes, of the media header to be filled in by the + Transmit() function. If HeaderSize is nonzero, then it must + be equal to This->Mode->MediaHeaderSize and the DestAddr and + Protocol parameters must not be NULL. + @param BufferSize The size, in bytes, of the entire packet (media header and + data) to be transmitted through the network interface. + @param Buffer A pointer to the packet (media header followed by data) to be + transmitted. This parameter cannot be NULL. If HeaderSize is + zero, then the media header in Buffer must already be filled + in by the caller. If HeaderSize is nonzero, then the media + header will be filled in by the Transmit() function. + @param SrcAddr The source HW MAC address. If HeaderSize is zero, then this + parameter is ignored. If HeaderSize is nonzero and SrcAddr + is NULL, then This->Mode->CurrentAddress is used for the + source HW MAC address. + @param DestAddr The destination HW MAC address. If HeaderSize is zero, then + this parameter is ignored. + @param Protocol The type of header to build. If HeaderSize is zero, then this + parameter is ignored. See RFC 1700, section "Ether Types," + for examples. + + @retval EFI_SUCCESS The packet was placed on the transmit queue. + @retval EFI_NOT_STARTED The network interface has not been started. + @retval EFI_NOT_READY The network interface is too busy to accept this + transmit request. + @retval EFI_BUFFER_TOO_SMALL The BufferSize parameter is too small. + @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported + value. + @retval EFI_DEVICE_ERROR The command could not be sent to the network interface. + @retval EFI_UNSUPPORTED This function is not supported by the network interface. + +**/ +EFI_STATUS +EFIAPI +SnpUndi32Transmit ( + IN EFI_SIMPLE_NETWORK_PROTOCOL *This, + IN UINTN HeaderSize, + IN UINTN BufferSize, + IN VOID *Buffer, + IN EFI_MAC_ADDRESS *SrcAddr, OPTIONAL + IN EFI_MAC_ADDRESS *DestAddr, OPTIONAL + IN UINT16 *Protocol OPTIONAL + ); + +/** + Receives a packet from a network interface. + + This function retrieves one packet from the receive queue of a network interface. + If there are no packets on the receive queue, then EFI_NOT_READY will be + returned. If there is a packet on the receive queue, and the size of the packet + is smaller than BufferSize, then the contents of the packet will be placed in + Buffer, and BufferSize will be updated with the actual size of the packet. + In addition, if SrcAddr, DestAddr, and Protocol are not NULL, then these values + will be extracted from the media header and returned. EFI_SUCCESS will be + returned if a packet was successfully received. + If BufferSize is smaller than the received packet, then the size of the receive + packet will be placed in BufferSize and EFI_BUFFER_TOO_SMALL will be returned. + If the driver has not been initialized, EFI_DEVICE_ERROR will be returned. + + @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. + @param HeaderSize The size, in bytes, of the media header received on the network + interface. If this parameter is NULL, then the media header size + will not be returned. + @param BufferSize On entry, the size, in bytes, of Buffer. On exit, the size, in + bytes, of the packet that was received on the network interface. + @param Buffer A pointer to the data buffer to receive both the media + header and the data. + @param SrcAddr The source HW MAC address. If this parameter is NULL, the HW + MAC source address will not be extracted from the media header. + @param DestAddr The destination HW MAC address. If this parameter is NULL, + the HW MAC destination address will not be extracted from + the media header. + @param Protocol The media header type. If this parameter is NULL, then the + protocol will not be extracted from the media header. See + RFC 1700 section "Ether Types" for examples. + + @retval EFI_SUCCESS The received data was stored in Buffer, and + BufferSize has been updated to the number of + bytes received. + @retval EFI_NOT_STARTED The network interface has not been started. + @retval EFI_NOT_READY No packets have been received on the network interface. + @retval EFI_BUFFER_TOO_SMALL BufferSize is too small for the received packets. + BufferSize has been updated to the required size. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + * The This parameter is NULL + * The This parameter does not point to a valid + EFI_SIMPLE_NETWORK_PROTOCOL structure. + * The BufferSize parameter is NULL + * The Buffer parameter is NULL + @retval EFI_DEVICE_ERROR The command could not be sent to the network interface. + +**/ +EFI_STATUS +EFIAPI +SnpUndi32Receive ( + IN EFI_SIMPLE_NETWORK_PROTOCOL *This, + OUT UINTN *HeaderSize OPTIONAL, + IN OUT UINTN *BufferSize, + OUT VOID *Buffer, + OUT EFI_MAC_ADDRESS *SrcAddr OPTIONAL, + OUT EFI_MAC_ADDRESS *DestAddr OPTIONAL, + OUT UINT16 *Protocol OPTIONAL + ); + +/** + Nofication call back function for WaitForPacket event. + + @param Event EFI Event. + @param SnpPtr Pointer to SNP_DRIVER structure. + +**/ +VOID +EFIAPI +SnpWaitForPacketNotify ( + EFI_EVENT Event, + VOID *SnpPtr + ); + +#define SNP_MEM_PAGES(x) (((x) - 1) / 4096 + 1) + + +#endif /* _SNP_H_ */ diff --git a/NetworkPkg/SnpDxe/SnpDxe.inf b/NetworkPkg/SnpDxe/SnpDxe.inf new file mode 100644 index 0000000000..eab97d2e9e --- /dev/null +++ b/NetworkPkg/SnpDxe/SnpDxe.inf @@ -0,0 +1,77 @@ +## @file +# This module produces EFI SNP Protocol. +# +# This module produces Simple Network Protocol upon EFI Network Interface +# Identifier Protocol, to provide a packet level interface to a network adapter. +# +# Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+# SPDX-License-Identifier: BSD-2-Clause-Patent +# +## + +[Defines] + INF_VERSION = 0x00010005 + BASE_NAME = SnpDxe + MODULE_UNI_FILE = SnpDxe.uni + FILE_GUID = A2f436EA-A127-4EF8-957C-8048606FF670 + MODULE_TYPE = UEFI_DRIVER + VERSION_STRING = 1.0 + ENTRY_POINT = InitializeSnpNiiDriver + UNLOAD_IMAGE = NetLibDefaultUnload + +# +# The following information is for reference only and not required by the build tools. +# +# VALID_ARCHITECTURES = IA32 X64 EBC +# +# DRIVER_BINDING = mSimpleNetworkDriverBinding +# COMPONENT_NAME = gSimpleNetworkComponentName +# COMPONENT_NAME2 = gSimpleNetworkComponentName2 +# + +[Sources] + Receive.c + Snp.h + Nvdata.c + Get_status.c + Start.c + Snp.c + Stop.c + Statistics.c + Reset.c + Shutdown.c + Mcast_ip_to_mac.c + Transmit.c + WaitForPacket.c + Receive_filters.c + Initialize.c + ComponentName.c + Callback.c + Station_address.c + + +[Packages] + MdePkg/MdePkg.dec + MdeModulePkg/MdeModulePkg.dec + + +[LibraryClasses] + UefiLib + BaseLib + UefiBootServicesTableLib + UefiDriverEntryPoint + BaseMemoryLib + DebugLib + NetLib + +[Guids] + gEfiEventExitBootServicesGuid ## SOMETIMES_CONSUMES ## Event + +[Protocols] + gEfiSimpleNetworkProtocolGuid ## BY_START + gEfiDevicePathProtocolGuid ## TO_START + gEfiNetworkInterfaceIdentifierProtocolGuid_31 ## TO_START + gEfiPciIoProtocolGuid ## TO_START + +[UserExtensions.TianoCore."ExtraFiles"] + SnpDxeExtra.uni diff --git a/NetworkPkg/SnpDxe/SnpDxe.uni b/NetworkPkg/SnpDxe/SnpDxe.uni new file mode 100644 index 0000000000..f37bb17fe0 --- /dev/null +++ b/NetworkPkg/SnpDxe/SnpDxe.uni @@ -0,0 +1,17 @@ +// /** @file +// This module produces EFI SNP Protocol. +// +// This module produces Simple Network Protocol upon EFI Network Interface +// Identifier Protocol, to provide a packet level interface to a network adapter. +// +// Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+// +// SPDX-License-Identifier: BSD-2-Clause-Patent +// +// **/ + + +#string STR_MODULE_ABSTRACT #language en-US "Produces EFI SNP Protocol" + +#string STR_MODULE_DESCRIPTION #language en-US "This module produces Simple Network Protocol upon EFI Network Interface Identifier Protocol to provide a packet level interface to a network adapter." + diff --git a/NetworkPkg/SnpDxe/SnpDxeExtra.uni b/NetworkPkg/SnpDxe/SnpDxeExtra.uni new file mode 100644 index 0000000000..5cf6e9d18e --- /dev/null +++ b/NetworkPkg/SnpDxe/SnpDxeExtra.uni @@ -0,0 +1,14 @@ +// /** @file +// SnpDxe Localized Strings and Content +// +// Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.
+// +// SPDX-License-Identifier: BSD-2-Clause-Patent +// +// **/ + +#string STR_PROPERTIES_MODULE_NAME +#language en-US +"SNP DXE Driver" + + diff --git a/NetworkPkg/SnpDxe/Start.c b/NetworkPkg/SnpDxe/Start.c new file mode 100644 index 0000000000..033ca22f66 --- /dev/null +++ b/NetworkPkg/SnpDxe/Start.c @@ -0,0 +1,162 @@ +/** @file + Implementation of starting a network adapter. + +Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Snp.h" + + +/** + Call UNDI to start the interface and changes the snp state. + + @param Snp pointer to snp driver structure. + + @retval EFI_SUCCESS UNDI is started successfully. + @retval EFI_DEVICE_ERROR UNDI could not be started. + +**/ +EFI_STATUS +PxeStart ( + IN SNP_DRIVER *Snp + ) +{ + PXE_CPB_START_31 *Cpb31; + + Cpb31 = Snp->Cpb; + // + // Initialize UNDI Start CDB for H/W UNDI + // + Snp->Cdb.OpCode = PXE_OPCODE_START; + Snp->Cdb.OpFlags = PXE_OPFLAGS_NOT_USED; + Snp->Cdb.CPBsize = PXE_CPBSIZE_NOT_USED; + Snp->Cdb.DBsize = PXE_DBSIZE_NOT_USED; + Snp->Cdb.CPBaddr = PXE_CPBADDR_NOT_USED; + Snp->Cdb.DBaddr = PXE_DBADDR_NOT_USED; + Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; + Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; + Snp->Cdb.IFnum = Snp->IfNum; + Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; + + // + // Make changes to H/W UNDI Start CDB if this is + // a S/W UNDI. + // + if (Snp->IsSwUndi) { + Snp->Cdb.CPBsize = (UINT16) sizeof (PXE_CPB_START_31); + Snp->Cdb.CPBaddr = (UINT64)(UINTN) Cpb31; + + Cpb31->Delay = (UINT64)(UINTN) &SnpUndi32CallbackDelay; + Cpb31->Block = (UINT64)(UINTN) &SnpUndi32CallbackBlock; + + // + // Virtual == Physical. This can be set to zero. + // + Cpb31->Virt2Phys = (UINT64)(UINTN) 0; + Cpb31->Mem_IO = (UINT64)(UINTN) &SnpUndi32CallbackMemio; + + Cpb31->Map_Mem = (UINT64)(UINTN) &SnpUndi32CallbackMap; + Cpb31->UnMap_Mem = (UINT64)(UINTN) &SnpUndi32CallbackUnmap; + Cpb31->Sync_Mem = (UINT64)(UINTN) &SnpUndi32CallbackSync; + + Cpb31->Unique_ID = (UINT64)(UINTN) Snp; + } + // + // Issue UNDI command and check result. + // + DEBUG ((EFI_D_NET, "\nsnp->undi.start() ")); + + (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); + + if (Snp->Cdb.StatCode != PXE_STATCODE_SUCCESS) { + // + // UNDI could not be started. Return UNDI error. + // + DEBUG ( + (EFI_D_ERROR, + "\nsnp->undi.start() %xh:%xh\n", + Snp->Cdb.StatCode, + Snp->Cdb.StatFlags) + ); + + return EFI_DEVICE_ERROR; + } + // + // Set simple network state to Started and return success. + // + Snp->Mode.State = EfiSimpleNetworkStarted; + + return EFI_SUCCESS; +} + + +/** + Change the state of a network interface from "stopped" to "started." + + This function starts a network interface. If the network interface successfully + starts, then EFI_SUCCESS will be returned. + + @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. + + @retval EFI_SUCCESS The network interface was started. + @retval EFI_ALREADY_STARTED The network interface is already in the started state. + @retval EFI_INVALID_PARAMETER This parameter was NULL or did not point to a valid + EFI_SIMPLE_NETWORK_PROTOCOL structure. + @retval EFI_DEVICE_ERROR The command could not be sent to the network interface. + @retval EFI_UNSUPPORTED This function is not supported by the network interface. + +**/ +EFI_STATUS +EFIAPI +SnpUndi32Start ( + IN EFI_SIMPLE_NETWORK_PROTOCOL *This + ) +{ + SNP_DRIVER *Snp; + EFI_STATUS Status; + UINTN Index; + EFI_TPL OldTpl; + + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This); + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + switch (Snp->Mode.State) { + case EfiSimpleNetworkStopped: + break; + + case EfiSimpleNetworkStarted: + case EfiSimpleNetworkInitialized: + Status = EFI_ALREADY_STARTED; + goto ON_EXIT; + + default: + Status = EFI_DEVICE_ERROR; + goto ON_EXIT; + } + + Status = PxeStart (Snp); + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } + // + // clear the map_list in SNP structure + // + for (Index = 0; Index < MAX_MAP_LENGTH; Index++) { + Snp->MapList[Index].VirtualAddress = 0; + Snp->MapList[Index].MapCookie = 0; + } + + Snp->Mode.MCastFilterCount = 0; + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + + return Status; +} diff --git a/NetworkPkg/SnpDxe/Station_address.c b/NetworkPkg/SnpDxe/Station_address.c new file mode 100644 index 0000000000..a5c87d4799 --- /dev/null +++ b/NetworkPkg/SnpDxe/Station_address.c @@ -0,0 +1,243 @@ +/** @file + Implementation of reading the MAC address of a network adapter. + +Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Snp.h" + + +/** + Call UNDI to read the MAC address of the NIC and update the mode structure + with the address. + + @param Snp Pointer to snp driver structure. + + @retval EFI_SUCCESS The MAC address of the NIC is read successfully. + @retval EFI_DEVICE_ERROR Failed to read the MAC address of the NIC. + +**/ +EFI_STATUS +PxeGetStnAddr ( + SNP_DRIVER *Snp + ) +{ + PXE_DB_STATION_ADDRESS *Db; + + Db = Snp->Db; + Snp->Cdb.OpCode = PXE_OPCODE_STATION_ADDRESS; + Snp->Cdb.OpFlags = PXE_OPFLAGS_STATION_ADDRESS_READ; + + Snp->Cdb.CPBaddr = PXE_CPBADDR_NOT_USED; + Snp->Cdb.CPBsize = PXE_CPBSIZE_NOT_USED; + + Snp->Cdb.DBsize = (UINT16) sizeof (PXE_DB_STATION_ADDRESS); + Snp->Cdb.DBaddr = (UINT64)(UINTN) Db; + + Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; + Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; + Snp->Cdb.IFnum = Snp->IfNum; + Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; + + // + // Issue UNDI command and check result. + // + DEBUG ((EFI_D_NET, "\nsnp->undi.station_addr() ")); + + (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); + + if (Snp->Cdb.StatCode != PXE_STATCODE_SUCCESS) { + DEBUG ( + (EFI_D_ERROR, + "\nsnp->undi.station_addr() %xh:%xh\n", + Snp->Cdb.StatFlags, + Snp->Cdb.StatCode) + ); + + return EFI_DEVICE_ERROR; + } + // + // Set new station address in SNP->Mode structure and return success. + // + CopyMem ( + &(Snp->Mode.CurrentAddress), + &Db->StationAddr, + Snp->Mode.HwAddressSize + ); + + CopyMem ( + &Snp->Mode.BroadcastAddress, + &Db->BroadcastAddr, + Snp->Mode.HwAddressSize + ); + + CopyMem ( + &Snp->Mode.PermanentAddress, + &Db->PermanentAddr, + Snp->Mode.HwAddressSize + ); + + return EFI_SUCCESS; +} + + +/** + Call UNDI to set a new MAC address for the NIC. + + @param Snp Pointer to Snp driver structure. + @param NewMacAddr Pointer to a MAC address to be set for the NIC, if this is + NULL then this routine resets the mac address to the NIC's + original address. + + +**/ +EFI_STATUS +PxeSetStnAddr ( + SNP_DRIVER *Snp, + EFI_MAC_ADDRESS *NewMacAddr + ) +{ + PXE_CPB_STATION_ADDRESS *Cpb; + PXE_DB_STATION_ADDRESS *Db; + + Cpb = Snp->Cpb; + Db = Snp->Db; + Snp->Cdb.OpCode = PXE_OPCODE_STATION_ADDRESS; + + if (NewMacAddr == NULL) { + Snp->Cdb.OpFlags = PXE_OPFLAGS_STATION_ADDRESS_RESET; + Snp->Cdb.CPBsize = PXE_CPBSIZE_NOT_USED; + Snp->Cdb.CPBaddr = PXE_CPBADDR_NOT_USED; + } else { + Snp->Cdb.OpFlags = PXE_OPFLAGS_STATION_ADDRESS_WRITE; + // + // Supplying a new address in the CPB will make undi change the mac address to the new one. + // + CopyMem (&Cpb->StationAddr, NewMacAddr, Snp->Mode.HwAddressSize); + + Snp->Cdb.CPBsize = (UINT16) sizeof (PXE_CPB_STATION_ADDRESS); + Snp->Cdb.CPBaddr = (UINT64)(UINTN) Cpb; + } + + Snp->Cdb.DBsize = (UINT16) sizeof (PXE_DB_STATION_ADDRESS); + Snp->Cdb.DBaddr = (UINT64)(UINTN) Db; + + Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; + Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; + Snp->Cdb.IFnum = Snp->IfNum; + Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; + + // + // Issue UNDI command and check result. + // + DEBUG ((EFI_D_NET, "\nsnp->undi.station_addr() ")); + + (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); + + if (Snp->Cdb.StatCode != PXE_STATCODE_SUCCESS) { + DEBUG ( + (EFI_D_ERROR, + "\nsnp->undi.station_addr() %xh:%xh\n", + Snp->Cdb.StatFlags, + Snp->Cdb.StatCode) + ); + + // + // UNDI command failed. Return UNDI status to caller. + // + return EFI_DEVICE_ERROR; + } + // + // read the changed address and save it in SNP->Mode structure + // + PxeGetStnAddr (Snp); + + return EFI_SUCCESS; +} + + +/** + Modifies or resets the current station address, if supported. + + This function modifies or resets the current station address of a network + interface, if supported. If Reset is TRUE, then the current station address is + set to the network interface's permanent address. If Reset is FALSE, and the + network interface allows its station address to be modified, then the current + station address is changed to the address specified by New. If the network + interface does not allow its station address to be modified, then + EFI_INVALID_PARAMETER will be returned. If the station address is successfully + updated on the network interface, EFI_SUCCESS will be returned. If the driver + has not been initialized, EFI_DEVICE_ERROR will be returned. + + @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. + @param Reset Flag used to reset the station address to the network interface's + permanent address. + @param New New station address to be used for the network interface. + + + @retval EFI_SUCCESS The network interface's station address was updated. + @retval EFI_NOT_STARTED The Simple Network Protocol interface has not been + started by calling Start(). + @retval EFI_INVALID_PARAMETER The New station address was not accepted by the NIC. + @retval EFI_INVALID_PARAMETER Reset is FALSE and New is NULL. + @retval EFI_DEVICE_ERROR The Simple Network Protocol interface has not + been initialized by calling Initialize(). + @retval EFI_DEVICE_ERROR An error occurred attempting to set the new + station address. + @retval EFI_UNSUPPORTED The NIC does not support changing the network + interface's station address. + +**/ +EFI_STATUS +EFIAPI +SnpUndi32StationAddress ( + IN EFI_SIMPLE_NETWORK_PROTOCOL *This, + IN BOOLEAN Reset, + IN EFI_MAC_ADDRESS *New OPTIONAL + ) +{ + SNP_DRIVER *Snp; + EFI_STATUS Status; + EFI_TPL OldTpl; + + // + // Check for invalid parameter combinations. + // + if ((This == NULL) || + (!Reset && (New == NULL))) { + return EFI_INVALID_PARAMETER; + } + + Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This); + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + // + // Return error if the SNP is not initialized. + // + switch (Snp->Mode.State) { + case EfiSimpleNetworkInitialized: + break; + + case EfiSimpleNetworkStopped: + Status = EFI_NOT_STARTED; + goto ON_EXIT; + + default: + Status = EFI_DEVICE_ERROR; + goto ON_EXIT; + } + + if (Reset) { + Status = PxeSetStnAddr (Snp, NULL); + } else { + Status = PxeSetStnAddr (Snp, New); + } + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + + return Status; +} diff --git a/NetworkPkg/SnpDxe/Statistics.c b/NetworkPkg/SnpDxe/Statistics.c new file mode 100644 index 0000000000..480e261780 --- /dev/null +++ b/NetworkPkg/SnpDxe/Statistics.c @@ -0,0 +1,224 @@ +/** @file + Implementation of collecting the statistics on a network interface. + +Copyright (c) 2004 - 2010, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + + +#include "Snp.h" + + +/** + Resets or collects the statistics on a network interface. + + This function resets or collects the statistics on a network interface. If the + size of the statistics table specified by StatisticsSize is not big enough for + all the statistics that are collected by the network interface, then a partial + buffer of statistics is returned in StatisticsTable, StatisticsSize is set to + the size required to collect all the available statistics, and + EFI_BUFFER_TOO_SMALL is returned. + If StatisticsSize is big enough for all the statistics, then StatisticsTable + will be filled, StatisticsSize will be set to the size of the returned + StatisticsTable structure, and EFI_SUCCESS is returned. + If the driver has not been initialized, EFI_DEVICE_ERROR will be returned. + If Reset is FALSE, and both StatisticsSize and StatisticsTable are NULL, then + no operations will be performed, and EFI_SUCCESS will be returned. + If Reset is TRUE, then all of the supported statistics counters on this network + interface will be reset to zero. + + @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. + @param Reset Set to TRUE to reset the statistics for the network interface. + @param StatisticsSize On input the size, in bytes, of StatisticsTable. On output + the size, in bytes, of the resulting table of statistics. + @param StatisticsTable A pointer to the EFI_NETWORK_STATISTICS structure that + contains the statistics. Type EFI_NETWORK_STATISTICS is + defined in "Related Definitions" below. + + @retval EFI_SUCCESS The requested operation succeeded. + @retval EFI_NOT_STARTED The Simple Network Protocol interface has not been + started by calling Start(). + @retval EFI_BUFFER_TOO_SMALL StatisticsSize is not NULL and StatisticsTable is + NULL. The current buffer size that is needed to + hold all the statistics is returned in StatisticsSize. + @retval EFI_BUFFER_TOO_SMALL StatisticsSize is not NULL and StatisticsTable is + not NULL. The current buffer size that is needed + to hold all the statistics is returned in + StatisticsSize. A partial set of statistics is + returned in StatisticsTable. + @retval EFI_INVALID_PARAMETER StatisticsSize is NULL and StatisticsTable is not + NULL. + @retval EFI_DEVICE_ERROR The Simple Network Protocol interface has not + been initialized by calling Initialize(). + @retval EFI_DEVICE_ERROR An error was encountered collecting statistics + from the NIC. + @retval EFI_UNSUPPORTED The NIC does not support collecting statistics + from the network interface. + +**/ +EFI_STATUS +EFIAPI +SnpUndi32Statistics ( + IN EFI_SIMPLE_NETWORK_PROTOCOL *This, + IN BOOLEAN Reset, + IN OUT UINTN *StatisticsSize, OPTIONAL + IN OUT EFI_NETWORK_STATISTICS *StatisticsTable OPTIONAL + ) +{ + SNP_DRIVER *Snp; + PXE_DB_STATISTICS *Db; + UINT64 *Stp; + UINT64 Mask; + UINTN Size; + UINTN Index; + EFI_TPL OldTpl; + EFI_STATUS Status; + + // + // Get pointer to SNP driver instance for *This. + // + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This); + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + // + // Return error if the SNP is not initialized. + // + switch (Snp->Mode.State) { + case EfiSimpleNetworkInitialized: + break; + + case EfiSimpleNetworkStopped: + Status = EFI_NOT_STARTED; + goto ON_EXIT; + + default: + Status = EFI_DEVICE_ERROR; + goto ON_EXIT; + } + // + // if we are not resetting the counters, we have to have a valid stat table + // with >0 size. if no reset, no table and no size, return success. + // + if (!Reset && StatisticsSize == NULL) { + Status = (StatisticsTable != NULL) ? EFI_INVALID_PARAMETER : EFI_SUCCESS; + goto ON_EXIT; + } + // + // Initialize UNDI Statistics CDB + // + Snp->Cdb.OpCode = PXE_OPCODE_STATISTICS; + Snp->Cdb.CPBsize = PXE_CPBSIZE_NOT_USED; + Snp->Cdb.CPBaddr = PXE_CPBADDR_NOT_USED; + Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; + Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; + Snp->Cdb.IFnum = Snp->IfNum; + Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; + + if (Reset) { + Snp->Cdb.OpFlags = PXE_OPFLAGS_STATISTICS_RESET; + Snp->Cdb.DBsize = PXE_DBSIZE_NOT_USED; + Snp->Cdb.DBaddr = PXE_DBADDR_NOT_USED; + Db = Snp->Db; + } else { + Snp->Cdb.OpFlags = PXE_OPFLAGS_STATISTICS_READ; + Snp->Cdb.DBsize = (UINT16) sizeof (PXE_DB_STATISTICS); + Snp->Cdb.DBaddr = (UINT64)(UINTN) (Db = Snp->Db); + } + // + // Issue UNDI command and check result. + // + DEBUG ((EFI_D_NET, "\nsnp->undi.statistics() ")); + + (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); + + switch (Snp->Cdb.StatCode) { + case PXE_STATCODE_SUCCESS: + break; + + case PXE_STATCODE_UNSUPPORTED: + DEBUG ( + (EFI_D_ERROR, + "\nsnp->undi.statistics() %xh:%xh\n", + Snp->Cdb.StatFlags, + Snp->Cdb.StatCode) + ); + + Status = EFI_UNSUPPORTED; + goto ON_EXIT; + + default: + DEBUG ( + (EFI_D_ERROR, + "\nsnp->undi.statistics() %xh:%xh\n", + Snp->Cdb.StatFlags, + Snp->Cdb.StatCode) + ); + + Status = EFI_DEVICE_ERROR; + goto ON_EXIT; + } + + if (Reset) { + Status = EFI_SUCCESS; + goto ON_EXIT; + } + + if (StatisticsTable == NULL) { + *StatisticsSize = sizeof (EFI_NETWORK_STATISTICS); + Status = EFI_BUFFER_TOO_SMALL; + goto ON_EXIT; + } + // + // Convert the UNDI statistics information to SNP statistics + // information. + // + ZeroMem (StatisticsTable, *StatisticsSize); + Stp = (UINT64 *) StatisticsTable; + Size = 0; + + for (Index = 0, Mask = 1; Index < 64; Index++, Mask = LShiftU64 (Mask, 1), Stp++) { + // + // There must be room for a full UINT64. Partial + // numbers will not be stored. + // + if ((Index + 1) * sizeof (UINT64) > *StatisticsSize) { + break; + } + + if ((Db->Supported & Mask) != 0) { + *Stp = Db->Data[Index]; + Size = Index + 1; + } else { + SetMem (Stp, sizeof (UINT64), 0xFF); + } + } + // + // Compute size up to last supported statistic. + // + while (++Index < 64) { + if ((Db->Supported & (Mask = LShiftU64 (Mask, 1))) != 0) { + Size = Index; + } + } + + Size *= sizeof (UINT64); + + if (*StatisticsSize >= Size) { + *StatisticsSize = Size; + Status = EFI_SUCCESS; + } else { + *StatisticsSize = Size; + Status = EFI_BUFFER_TOO_SMALL; + } + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + + return Status; +} diff --git a/NetworkPkg/SnpDxe/Stop.c b/NetworkPkg/SnpDxe/Stop.c new file mode 100644 index 0000000000..f1c1bd847c --- /dev/null +++ b/NetworkPkg/SnpDxe/Stop.c @@ -0,0 +1,120 @@ +/** @file + Implementation of stopping a network interface. + +Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Snp.h" + + +/** + Call UNDI to stop the interface and changes the snp state. + + @param Snp Pointer to snp driver structure + + @retval EFI_SUCCESS The network interface was stopped. + @retval EFI_DEVICE_ERROR SNP is not initialized. + +**/ +EFI_STATUS +PxeStop ( + SNP_DRIVER *Snp + ) +{ + Snp->Cdb.OpCode = PXE_OPCODE_STOP; + Snp->Cdb.OpFlags = PXE_OPFLAGS_NOT_USED; + Snp->Cdb.CPBsize = PXE_CPBSIZE_NOT_USED; + Snp->Cdb.DBsize = PXE_DBSIZE_NOT_USED; + Snp->Cdb.CPBaddr = PXE_CPBADDR_NOT_USED; + Snp->Cdb.DBaddr = PXE_DBADDR_NOT_USED; + Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; + Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; + Snp->Cdb.IFnum = Snp->IfNum; + Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; + + // + // Issue UNDI command + // + DEBUG ((EFI_D_NET, "\nsnp->undi.stop() ")); + + (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb); + + if (Snp->Cdb.StatCode != PXE_STATCODE_SUCCESS) { + DEBUG ( + (EFI_D_WARN, + "\nsnp->undi.stop() %xh:%xh\n", + Snp->Cdb.StatFlags, + Snp->Cdb.StatCode) + ); + + return EFI_DEVICE_ERROR; + } + // + // Set simple network state to Started and return success. + // + Snp->Mode.State = EfiSimpleNetworkStopped; + return EFI_SUCCESS; +} + + +/** + Changes the state of a network interface from "started" to "stopped." + + This function stops a network interface. This call is only valid if the network + interface is in the started state. If the network interface was successfully + stopped, then EFI_SUCCESS will be returned. + + @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL + instance. + + + @retval EFI_SUCCESS The network interface was stopped. + @retval EFI_NOT_STARTED The network interface has not been started. + @retval EFI_INVALID_PARAMETER This parameter was NULL or did not point to a + valid EFI_SIMPLE_NETWORK_PROTOCOL structure. + @retval EFI_DEVICE_ERROR The command could not be sent to the network + interface. + @retval EFI_UNSUPPORTED This function is not supported by the network + interface. + +**/ +EFI_STATUS +EFIAPI +SnpUndi32Stop ( + IN EFI_SIMPLE_NETWORK_PROTOCOL *This + ) +{ + SNP_DRIVER *Snp; + EFI_TPL OldTpl; + EFI_STATUS Status; + + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This); + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + switch (Snp->Mode.State) { + case EfiSimpleNetworkStarted: + break; + + case EfiSimpleNetworkStopped: + Status = EFI_NOT_STARTED; + goto ON_EXIT; + + default: + Status = EFI_DEVICE_ERROR; + goto ON_EXIT; + } + + Status = PxeStop (Snp); + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + + return Status; +} diff --git a/NetworkPkg/SnpDxe/Transmit.c b/NetworkPkg/SnpDxe/Transmit.c new file mode 100644 index 0000000000..44fdd71f41 --- /dev/null +++ b/NetworkPkg/SnpDxe/Transmit.c @@ -0,0 +1,353 @@ +/** @file + Implementation of transmitting a packet. + +Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Snp.h" + + +/** + Call UNDI to create the meadia header for the given data buffer. + + @param Snp Pointer to SNP driver structure. + @param MacHeaderPtr Address where the media header will be filled in. + @param HeaderSize Size of the memory at MacHeaderPtr. + @param Buffer Data buffer pointer. + @param BufferSize Size of data in the Buffer + @param DestAddr Address of the destination mac address buffer. + @param SrcAddr Address of the source mac address buffer. + @param ProtocolPtr Address of the protocol type. + + @retval EFI_SUCCESS Successfully completed the undi call. + @retval Other Error return from undi call. + +**/ +EFI_STATUS +PxeFillHeader ( + SNP_DRIVER *Snp, + VOID *MacHeaderPtr, + UINTN HeaderSize, + VOID *Buffer, + UINTN BufferSize, + EFI_MAC_ADDRESS *DestAddr, + EFI_MAC_ADDRESS *SrcAddr, + UINT16 *ProtocolPtr + ) +{ + PXE_CPB_FILL_HEADER_FRAGMENTED *Cpb; + + Cpb = Snp->Cpb; + if (SrcAddr != NULL) { + CopyMem ( + (VOID *) Cpb->SrcAddr, + (VOID *) SrcAddr, + Snp->Mode.HwAddressSize + ); + } else { + CopyMem ( + (VOID *) Cpb->SrcAddr, + (VOID *) &(Snp->Mode.CurrentAddress), + Snp->Mode.HwAddressSize + ); + } + + CopyMem ( + (VOID *) Cpb->DestAddr, + (VOID *) DestAddr, + Snp->Mode.HwAddressSize + ); + + // + // we need to do the byte swapping + // + Cpb->Protocol = (UINT16) PXE_SWAP_UINT16 (*ProtocolPtr); + + Cpb->PacketLen = (UINT32) (BufferSize); + Cpb->MediaHeaderLen = (UINT16) HeaderSize; + + Cpb->FragCnt = 2; + Cpb->reserved = 0; + + Cpb->FragDesc[0].FragAddr = (UINT64)(UINTN) MacHeaderPtr; + Cpb->FragDesc[0].FragLen = (UINT32) HeaderSize; + Cpb->FragDesc[1].FragAddr = (UINT64)(UINTN) Buffer; + Cpb->FragDesc[1].FragLen = (UINT32) BufferSize; + + Cpb->FragDesc[0].reserved = Cpb->FragDesc[1].reserved = 0; + + Snp->Cdb.OpCode = PXE_OPCODE_FILL_HEADER; + Snp->Cdb.OpFlags = PXE_OPFLAGS_FILL_HEADER_FRAGMENTED; + + Snp->Cdb.DBsize = PXE_DBSIZE_NOT_USED; + Snp->Cdb.DBaddr = PXE_DBADDR_NOT_USED; + + Snp->Cdb.CPBsize = (UINT16) sizeof (PXE_CPB_FILL_HEADER_FRAGMENTED); + Snp->Cdb.CPBaddr = (UINT64)(UINTN) Cpb; + + Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; + Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; + Snp->Cdb.IFnum = Snp->IfNum; + Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; + + // + // Issue UNDI command and check result. + // + DEBUG ((EFI_D_NET, "\nSnp->undi.fill_header() ")); + + (*Snp->IssueUndi32Command) ((UINT64) (UINTN) &Snp->Cdb); + + switch (Snp->Cdb.StatCode) { + case PXE_STATCODE_SUCCESS: + return EFI_SUCCESS; + + case PXE_STATCODE_INVALID_PARAMETER: + DEBUG ( + (EFI_D_ERROR, + "\nSnp->undi.fill_header() %xh:%xh\n", + Snp->Cdb.StatFlags, + Snp->Cdb.StatCode) + ); + + return EFI_INVALID_PARAMETER; + + default: + DEBUG ( + (EFI_D_ERROR, + "\nSnp->undi.fill_header() %xh:%xh\n", + Snp->Cdb.StatFlags, + Snp->Cdb.StatCode) + ); + + return EFI_DEVICE_ERROR; + } +} + + +/** + This routine calls undi to transmit the given data buffer + + @param Snp pointer to SNP driver structure + @param Buffer data buffer pointer + @param BufferSize Size of data in the Buffer + + @retval EFI_SUCCESS if successfully completed the undi call + @retval Other error return from undi call. + +**/ +EFI_STATUS +PxeTransmit ( + SNP_DRIVER *Snp, + VOID *Buffer, + UINTN BufferSize + ) +{ + PXE_CPB_TRANSMIT *Cpb; + EFI_STATUS Status; + + Cpb = Snp->Cpb; + Cpb->FrameAddr = (UINT64) (UINTN) Buffer; + Cpb->DataLen = (UINT32) BufferSize; + + Cpb->MediaheaderLen = 0; + Cpb->reserved = 0; + + Snp->Cdb.OpFlags = PXE_OPFLAGS_TRANSMIT_WHOLE; + + Snp->Cdb.CPBsize = (UINT16) sizeof (PXE_CPB_TRANSMIT); + Snp->Cdb.CPBaddr = (UINT64)(UINTN) Cpb; + + Snp->Cdb.OpCode = PXE_OPCODE_TRANSMIT; + Snp->Cdb.DBsize = PXE_DBSIZE_NOT_USED; + Snp->Cdb.DBaddr = PXE_DBADDR_NOT_USED; + + Snp->Cdb.StatCode = PXE_STATCODE_INITIALIZE; + Snp->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; + Snp->Cdb.IFnum = Snp->IfNum; + Snp->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; + + // + // Issue UNDI command and check result. + // + DEBUG ((EFI_D_NET, "\nSnp->undi.transmit() ")); + DEBUG ((EFI_D_NET, "\nSnp->Cdb.OpCode == %x", Snp->Cdb.OpCode)); + DEBUG ((EFI_D_NET, "\nSnp->Cdb.CPBaddr == %LX", Snp->Cdb.CPBaddr)); + DEBUG ((EFI_D_NET, "\nSnp->Cdb.DBaddr == %LX", Snp->Cdb.DBaddr)); + DEBUG ((EFI_D_NET, "\nCpb->FrameAddr == %LX\n", Cpb->FrameAddr)); + + (*Snp->IssueUndi32Command) ((UINT64) (UINTN) &Snp->Cdb); + + DEBUG ((EFI_D_NET, "\nexit Snp->undi.transmit() ")); + + // + // we will unmap the buffers in get_status call, not here + // + switch (Snp->Cdb.StatCode) { + case PXE_STATCODE_SUCCESS: + return EFI_SUCCESS; + + case PXE_STATCODE_BUFFER_FULL: + case PXE_STATCODE_QUEUE_FULL: + case PXE_STATCODE_BUSY: + Status = EFI_NOT_READY; + DEBUG ( + (EFI_D_NET, + "\nSnp->undi.transmit() %xh:%xh\n", + Snp->Cdb.StatFlags, + Snp->Cdb.StatCode) + ); + break; + + default: + DEBUG ( + (EFI_D_ERROR, + "\nSnp->undi.transmit() %xh:%xh\n", + Snp->Cdb.StatFlags, + Snp->Cdb.StatCode) + ); + Status = EFI_DEVICE_ERROR; + } + + return Status; +} + +/** + Places a packet in the transmit queue of a network interface. + + This function places the packet specified by Header and Buffer on the transmit + queue. If HeaderSize is nonzero and HeaderSize is not equal to + This->Mode->MediaHeaderSize, then EFI_INVALID_PARAMETER will be returned. If + BufferSize is less than This->Mode->MediaHeaderSize, then EFI_BUFFER_TOO_SMALL + will be returned. If Buffer is NULL, then EFI_INVALID_PARAMETER will be + returned. If HeaderSize is nonzero and DestAddr or Protocol is NULL, then + EFI_INVALID_PARAMETER will be returned. If the transmit engine of the network + interface is busy, then EFI_NOT_READY will be returned. If this packet can be + accepted by the transmit engine of the network interface, the packet contents + specified by Buffer will be placed on the transmit queue of the network + interface, and EFI_SUCCESS will be returned. GetStatus() can be used to + determine when the packet has actually been transmitted. The contents of the + Buffer must not be modified until the packet has actually been transmitted. + The Transmit() function performs nonblocking I/O. A caller who wants to perform + blocking I/O, should call Transmit(), and then GetStatus() until the + transmitted buffer shows up in the recycled transmit buffer. + If the driver has not been initialized, EFI_DEVICE_ERROR will be returned. + + @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance. + @param HeaderSize The size, in bytes, of the media header to be filled in by the + Transmit() function. If HeaderSize is nonzero, then it must + be equal to This->Mode->MediaHeaderSize and the DestAddr and + Protocol parameters must not be NULL. + @param BufferSize The size, in bytes, of the entire packet (media header and + data) to be transmitted through the network interface. + @param Buffer A pointer to the packet (media header followed by data) to be + transmitted. This parameter cannot be NULL. If HeaderSize is + zero, then the media header in Buffer must already be filled + in by the caller. If HeaderSize is nonzero, then the media + header will be filled in by the Transmit() function. + @param SrcAddr The source HW MAC address. If HeaderSize is zero, then this + parameter is ignored. If HeaderSize is nonzero and SrcAddr + is NULL, then This->Mode->CurrentAddress is used for the + source HW MAC address. + @param DestAddr The destination HW MAC address. If HeaderSize is zero, then + this parameter is ignored. + @param Protocol The type of header to build. If HeaderSize is zero, then this + parameter is ignored. See RFC 1700, section "Ether Types," + for examples. + + @retval EFI_SUCCESS The packet was placed on the transmit queue. + @retval EFI_NOT_STARTED The network interface has not been started. + @retval EFI_NOT_READY The network interface is too busy to accept this + transmit request. + @retval EFI_BUFFER_TOO_SMALL The BufferSize parameter is too small. + @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported + value. + @retval EFI_DEVICE_ERROR The command could not be sent to the network interface. + @retval EFI_UNSUPPORTED This function is not supported by the network interface. + +**/ +EFI_STATUS +EFIAPI +SnpUndi32Transmit ( + IN EFI_SIMPLE_NETWORK_PROTOCOL *This, + IN UINTN HeaderSize, + IN UINTN BufferSize, + IN VOID *Buffer, + IN EFI_MAC_ADDRESS *SrcAddr, OPTIONAL + IN EFI_MAC_ADDRESS *DestAddr, OPTIONAL + IN UINT16 *Protocol OPTIONAL + ) +{ + SNP_DRIVER *Snp; + EFI_STATUS Status; + EFI_TPL OldTpl; + + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This); + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + if (Snp == NULL) { + return EFI_DEVICE_ERROR; + } + + switch (Snp->Mode.State) { + case EfiSimpleNetworkInitialized: + break; + + case EfiSimpleNetworkStopped: + Status = EFI_NOT_STARTED; + goto ON_EXIT; + + default: + Status = EFI_DEVICE_ERROR; + goto ON_EXIT; + } + + if (Buffer == NULL) { + Status = EFI_INVALID_PARAMETER; + goto ON_EXIT; + } + + if (BufferSize < Snp->Mode.MediaHeaderSize) { + Status = EFI_BUFFER_TOO_SMALL; + goto ON_EXIT; + } + + // + // if the HeaderSize is non-zero, we need to fill up the header and for that + // we need the destination address and the protocol + // + if (HeaderSize != 0) { + if (HeaderSize != Snp->Mode.MediaHeaderSize || DestAddr == 0 || Protocol == 0) { + Status = EFI_INVALID_PARAMETER; + goto ON_EXIT; + } + + Status = PxeFillHeader ( + Snp, + Buffer, + HeaderSize, + (UINT8 *) Buffer + HeaderSize, + BufferSize - HeaderSize, + DestAddr, + SrcAddr, + Protocol + ); + + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } + } + + Status = PxeTransmit (Snp, Buffer, BufferSize); + +ON_EXIT: + gBS->RestoreTPL (OldTpl); + + return Status; +} diff --git a/NetworkPkg/SnpDxe/WaitForPacket.c b/NetworkPkg/SnpDxe/WaitForPacket.c new file mode 100644 index 0000000000..866a1e8c0e --- /dev/null +++ b/NetworkPkg/SnpDxe/WaitForPacket.c @@ -0,0 +1,86 @@ +/** @file + Event handler to check for available packet. + +Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Snp.h" + + +/** + Nofication call back function for WaitForPacket event. + + @param Event EFI Event. + @param SnpPtr Pointer to SNP_DRIVER structure. + +**/ +VOID +EFIAPI +SnpWaitForPacketNotify ( + EFI_EVENT Event, + VOID *SnpPtr + ) +{ + PXE_DB_GET_STATUS PxeDbGetStatus; + + // + // Do nothing if either parameter is a NULL pointer. + // + if (Event == NULL || SnpPtr == NULL) { + return ; + } + // + // Do nothing if the SNP interface is not initialized. + // + switch (((SNP_DRIVER *) SnpPtr)->Mode.State) { + case EfiSimpleNetworkInitialized: + break; + + case EfiSimpleNetworkStopped: + case EfiSimpleNetworkStarted: + default: + return ; + } + // + // Fill in CDB for UNDI GetStatus(). + // + ((SNP_DRIVER *) SnpPtr)->Cdb.OpCode = PXE_OPCODE_GET_STATUS; + ((SNP_DRIVER *) SnpPtr)->Cdb.OpFlags = 0; + ((SNP_DRIVER *) SnpPtr)->Cdb.CPBsize = PXE_CPBSIZE_NOT_USED; + ((SNP_DRIVER *) SnpPtr)->Cdb.CPBaddr = PXE_CPBADDR_NOT_USED; + ((SNP_DRIVER *) SnpPtr)->Cdb.DBsize = (UINT16) (sizeof (UINT32) * 2); + ((SNP_DRIVER *) SnpPtr)->Cdb.DBaddr = (UINT64)(UINTN) (((SNP_DRIVER *) SnpPtr)->Db); + ((SNP_DRIVER *) SnpPtr)->Cdb.StatCode = PXE_STATCODE_INITIALIZE; + ((SNP_DRIVER *) SnpPtr)->Cdb.StatFlags = PXE_STATFLAGS_INITIALIZE; + ((SNP_DRIVER *) SnpPtr)->Cdb.IFnum = ((SNP_DRIVER *) SnpPtr)->IfNum; + ((SNP_DRIVER *) SnpPtr)->Cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST; + + // + // Clear contents of DB buffer. + // + ZeroMem (((SNP_DRIVER *) SnpPtr)->Db, sizeof (UINT32) * 2); + + // + // Issue UNDI command and check result. + // + (*((SNP_DRIVER *) SnpPtr)->IssueUndi32Command) ((UINT64)(UINTN) &((SNP_DRIVER *) SnpPtr)->Cdb); + + if (((SNP_DRIVER *) SnpPtr)->Cdb.StatCode != EFI_SUCCESS) { + return ; + } + // + // We might have a packet. Check the receive length and signal + // the event if the length is not zero. + // + CopyMem ( + &PxeDbGetStatus, + ((SNP_DRIVER *) SnpPtr)->Db, + sizeof (UINT32) * 2 + ); + + if (PxeDbGetStatus.RxFrameLen != 0) { + gBS->SignalEvent (Event); + } +} diff --git a/NetworkPkg/Udp4Dxe/ComponentName.c b/NetworkPkg/Udp4Dxe/ComponentName.c new file mode 100644 index 0000000000..41bd834c6d --- /dev/null +++ b/NetworkPkg/Udp4Dxe/ComponentName.c @@ -0,0 +1,429 @@ +/** @file + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + + +#include "Udp4Impl.h" + +// +// EFI Component Name Functions +// +/** + Retrieves a Unicode string that is the user readable name of the driver. + + This function retrieves the user readable name of a driver in the form of a + Unicode string. If the driver specified by This has a user readable name in + the language specified by Language, then a pointer to the driver name is + returned in DriverName, and EFI_SUCCESS is returned. If the driver specified + by This does not support the language specified by Language, + then EFI_UNSUPPORTED is returned. + + @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param[in] Language A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified + in RFC 4646 or ISO 639-2 language code format. + + @param[out] DriverName A pointer to the Unicode string to return. + This Unicode string is the name of the + driver specified by This in the language + specified by Language. + + @retval EFI_SUCCESS The Unicode string for the Driver specified by + This and the language specified by Language was + returned in DriverName. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER DriverName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +UdpComponentNameGetDriverName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN CHAR8 *Language, + OUT CHAR16 **DriverName + ); + + +/** + Retrieves a Unicode string that is the user readable name of the controller + that is being managed by a driver. + + This function retrieves the user readable name of the controller specified by + ControllerHandle and ChildHandle in the form of a Unicode string. If the + driver specified by This has a user readable name in the language specified by + Language, then a pointer to the controller name is returned in ControllerName, + and EFI_SUCCESS is returned. If the driver specified by This is not currently + managing the controller specified by ControllerHandle and ChildHandle, + then EFI_UNSUPPORTED is returned. If the driver specified by This does not + support the language specified by Language, then EFI_UNSUPPORTED is returned. + + @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param[in] ControllerHandle The handle of a controller that the driver + specified by This is managing. This handle + specifies the controller whose name is to be + returned. + + @param[in] ChildHandle The handle of the child controller to retrieve + the name of. This is an optional parameter that + may be NULL. It will be NULL for device + drivers. It will also be NULL for a bus drivers + that wish to retrieve the name of the bus + controller. It will not be NULL for a bus + driver that wishes to retrieve the name of a + child controller. + + @param[in] Language A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified in + RFC 4646 or ISO 639-2 language code format. + + @param[out] ControllerName A pointer to the Unicode string to return. + This Unicode string is the name of the + controller specified by ControllerHandle and + ChildHandle in the language specified by + Language from the point of view of the driver + specified by This. + + @retval EFI_SUCCESS The Unicode string for the user readable name in + the language specified by Language for the + driver specified by This was returned in + DriverName. + + @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. + + @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid + EFI_HANDLE. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER ControllerName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This is not currently + managing the controller specified by + ControllerHandle and ChildHandle. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +UdpComponentNameGetControllerName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_HANDLE ChildHandle OPTIONAL, + IN CHAR8 *Language, + OUT CHAR16 **ControllerName + ); + + +// +// EFI Component Name Protocol +// +GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gUdp4ComponentName = { + UdpComponentNameGetDriverName, + UdpComponentNameGetControllerName, + "eng" +}; + +// +// EFI Component Name 2 Protocol +// +GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gUdp4ComponentName2 = { + (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) UdpComponentNameGetDriverName, + (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) UdpComponentNameGetControllerName, + "en" +}; + + +GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mUdpDriverNameTable[] = { + { + "eng;en", + L"UDP Network Service Driver" + }, + { + NULL, + NULL + } +}; + +GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE *gUdpControllerNameTable = NULL; + +/** + Retrieves a Unicode string that is the user readable name of the driver. + + This function retrieves the user readable name of a driver in the form of a + Unicode string. If the driver specified by This has a user readable name in + the language specified by Language, then a pointer to the driver name is + returned in DriverName, and EFI_SUCCESS is returned. If the driver specified + by This does not support the language specified by Language, + then EFI_UNSUPPORTED is returned. + + @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param[in] Language A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified + in RFC 4646 or ISO 639-2 language code format. + + @param[out] DriverName A pointer to the Unicode string to return. + This Unicode string is the name of the + driver specified by This in the language + specified by Language. + + @retval EFI_SUCCESS The Unicode string for the Driver specified by + This and the language specified by Language was + returned in DriverName. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER DriverName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +UdpComponentNameGetDriverName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN CHAR8 *Language, + OUT CHAR16 **DriverName + ) +{ + return LookupUnicodeString2 ( + Language, + This->SupportedLanguages, + mUdpDriverNameTable, + DriverName, + (BOOLEAN)(This == &gUdp4ComponentName) + ); +} + +/** + Update the component name for the Udp4 child handle. + + @param Udp4[in] A pointer to the EFI_UDP4_PROTOCOL. + + + @retval EFI_SUCCESS Update the ControllerNameTable of this instance successfully. + @retval EFI_INVALID_PARAMETER The input parameter is invalid. + +**/ +EFI_STATUS +UpdateName ( + EFI_UDP4_PROTOCOL *Udp4 + ) +{ + EFI_STATUS Status; + CHAR16 HandleName[64]; + EFI_UDP4_CONFIG_DATA Udp4ConfigData; + + if (Udp4 == NULL) { + return EFI_INVALID_PARAMETER; + } + + // + // Format the child name into the string buffer as: + // UDPv4 (SrcPort=59, DestPort=60) + // + Status = Udp4->GetModeData (Udp4, &Udp4ConfigData, NULL, NULL, NULL); + if (!EFI_ERROR (Status)) { + UnicodeSPrint (HandleName, sizeof (HandleName), + L"UDPv4 (SrcPort=%d, DestPort=%d)", + Udp4ConfigData.StationPort, + Udp4ConfigData.RemotePort + ); + } else if (Status == EFI_NOT_STARTED) { + UnicodeSPrint ( + HandleName, + sizeof (HandleName), + L"UDPv4 (Not started)" + ); + } else { + return Status; + } + + if (gUdpControllerNameTable != NULL) { + FreeUnicodeStringTable (gUdpControllerNameTable); + gUdpControllerNameTable = NULL; + } + + Status = AddUnicodeString2 ( + "eng", + gUdp4ComponentName.SupportedLanguages, + &gUdpControllerNameTable, + HandleName, + TRUE + ); + if (EFI_ERROR (Status)) { + return Status; + } + + return AddUnicodeString2 ( + "en", + gUdp4ComponentName2.SupportedLanguages, + &gUdpControllerNameTable, + HandleName, + FALSE + ); +} + +/** + Retrieves a Unicode string that is the user readable name of the controller + that is being managed by a driver. + + This function retrieves the user readable name of the controller specified by + ControllerHandle and ChildHandle in the form of a Unicode string. If the + driver specified by This has a user readable name in the language specified by + Language, then a pointer to the controller name is returned in ControllerName, + and EFI_SUCCESS is returned. If the driver specified by This is not currently + managing the controller specified by ControllerHandle and ChildHandle, + then EFI_UNSUPPORTED is returned. If the driver specified by This does not + support the language specified by Language, then EFI_UNSUPPORTED is returned. + + @param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + + @param[in] ControllerHandle The handle of a controller that the driver + specified by This is managing. This handle + specifies the controller whose name is to be + returned. + + @param[in] ChildHandle The handle of the child controller to retrieve + the name of. This is an optional parameter that + may be NULL. It will be NULL for device + drivers. It will also be NULL for a bus drivers + that wish to retrieve the name of the bus + controller. It will not be NULL for a bus + driver that wishes to retrieve the name of a + child controller. + + @param[in] Language A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified in + RFC 4646 or ISO 639-2 language code format. + + @param[out] ControllerName A pointer to the Unicode string to return. + This Unicode string is the name of the + controller specified by ControllerHandle and + ChildHandle in the language specified by + Language from the point of view of the driver + specified by This. + + @retval EFI_SUCCESS The Unicode string for the user readable name in + the language specified by Language for the + driver specified by This was returned in + DriverName. + + @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. + + @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid + EFI_HANDLE. + + @retval EFI_INVALID_PARAMETER Language is NULL. + + @retval EFI_INVALID_PARAMETER ControllerName is NULL. + + @retval EFI_UNSUPPORTED The driver specified by This is not currently + managing the controller specified by + ControllerHandle and ChildHandle. + + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +UdpComponentNameGetControllerName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_HANDLE ChildHandle OPTIONAL, + IN CHAR8 *Language, + OUT CHAR16 **ControllerName + ) +{ + EFI_STATUS Status; + EFI_UDP4_PROTOCOL *Udp4; + + // + // Only provide names for child handles. + // + if (ChildHandle == NULL) { + return EFI_UNSUPPORTED; + } + + // + // Make sure this driver produced ChildHandle + // + Status = EfiTestChildHandle ( + ControllerHandle, + ChildHandle, + &gEfiIp4ProtocolGuid + ); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Retrieve an instance of a produced protocol from ChildHandle + // + Status = gBS->OpenProtocol ( + ChildHandle, + &gEfiUdp4ProtocolGuid, + (VOID **)&Udp4, + NULL, + NULL, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Update the component name for this child handle. + // + Status = UpdateName (Udp4); + if (EFI_ERROR (Status)) { + return Status; + } + + return LookupUnicodeString2 ( + Language, + This->SupportedLanguages, + gUdpControllerNameTable, + ControllerName, + (BOOLEAN)(This == &gUdp4ComponentName) + ); +} + diff --git a/NetworkPkg/Udp4Dxe/Udp4Driver.c b/NetworkPkg/Udp4Dxe/Udp4Driver.c new file mode 100644 index 0000000000..63b103b8ef --- /dev/null +++ b/NetworkPkg/Udp4Dxe/Udp4Driver.c @@ -0,0 +1,584 @@ +/** @file + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + + +#include "Udp4Impl.h" + +EFI_DRIVER_BINDING_PROTOCOL gUdp4DriverBinding = { + Udp4DriverBindingSupported, + Udp4DriverBindingStart, + Udp4DriverBindingStop, + 0xa, + NULL, + NULL +}; + +EFI_SERVICE_BINDING_PROTOCOL mUdp4ServiceBinding = { + Udp4ServiceBindingCreateChild, + Udp4ServiceBindingDestroyChild +}; + +/** + Callback function which provided by user to remove one node in NetDestroyLinkList process. + + @param[in] Entry The entry to be removed. + @param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList. + + @retval EFI_SUCCESS The entry has been removed successfully. + @retval Others Fail to remove the entry. + +**/ +EFI_STATUS +EFIAPI +Udp4DestroyChildEntryInHandleBuffer ( + IN LIST_ENTRY *Entry, + IN VOID *Context + ) +{ + UDP4_INSTANCE_DATA *Instance; + EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; + UINTN NumberOfChildren; + EFI_HANDLE *ChildHandleBuffer; + + if (Entry == NULL || Context == NULL) { + return EFI_INVALID_PARAMETER; + } + + Instance = NET_LIST_USER_STRUCT_S (Entry, UDP4_INSTANCE_DATA, Link, UDP4_INSTANCE_DATA_SIGNATURE); + ServiceBinding = ((UDP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *) Context)->ServiceBinding; + NumberOfChildren = ((UDP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *) Context)->NumberOfChildren; + ChildHandleBuffer = ((UDP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT *) Context)->ChildHandleBuffer; + + if (!NetIsInHandleBuffer (Instance->ChildHandle, NumberOfChildren, ChildHandleBuffer)) { + return EFI_SUCCESS; + } + + return ServiceBinding->DestroyChild (ServiceBinding, Instance->ChildHandle); +} + + +/** + Test to see if this driver supports ControllerHandle. This service + is called by the EFI boot service ConnectController(). In + order to make drivers as small as possible, there are a few calling + restrictions for this service. ConnectController() must + follow these calling restrictions. If any other agent wishes to call + Supported() it must also follow these calling restrictions. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to test + @param[in] RemainingDevicePath Optional parameter use to pick a specific child + device to start. + + @retval EFI_SUCCESS This driver supports this device + @retval EFI_ALREADY_STARTED This driver is already running on this device + @retval other This driver does not support this device + +**/ +EFI_STATUS +EFIAPI +Udp4DriverBindingSupported ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL + ) +{ + EFI_STATUS Status; + + // + // Test for the Udp4ServiceBinding Protocol + // + Status = gBS->OpenProtocol ( + ControllerHandle, + &gEfiUdp4ServiceBindingProtocolGuid, + NULL, + This->DriverBindingHandle, + ControllerHandle, + EFI_OPEN_PROTOCOL_TEST_PROTOCOL + ); + if (!EFI_ERROR (Status)) { + return EFI_ALREADY_STARTED; + } + + // + // Test for the Ip4 Protocol + // + Status = gBS->OpenProtocol ( + ControllerHandle, + &gEfiIp4ServiceBindingProtocolGuid, + NULL, + This->DriverBindingHandle, + ControllerHandle, + EFI_OPEN_PROTOCOL_TEST_PROTOCOL + ); + + return Status; +} + + +/** + Start this driver on ControllerHandle. This service is called by the + EFI boot service ConnectController(). In order to make + drivers as small as possible, there are a few calling restrictions for + this service. ConnectController() must follow these + calling restrictions. If any other agent wishes to call Start() it + must also follow these calling restrictions. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to bind driver to + @param[in] RemainingDevicePath Optional parameter use to pick a specific child + device to start. + + @retval EFI_SUCCESS This driver is added to ControllerHandle + @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle + @retval other This driver does not support this device + +**/ +EFI_STATUS +EFIAPI +Udp4DriverBindingStart ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL + ) +{ + EFI_STATUS Status; + UDP4_SERVICE_DATA *Udp4Service; + + // + // Allocate Private Context Data Structure. + // + Udp4Service = AllocatePool (sizeof (UDP4_SERVICE_DATA)); + if (Udp4Service == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + Status = Udp4CreateService (Udp4Service, This->DriverBindingHandle, ControllerHandle); + if (EFI_ERROR (Status)) { + FreePool (Udp4Service); + return Status; + } + + // + // Install the Udp4ServiceBindingProtocol on the ControllerHandle. + // + Status = gBS->InstallMultipleProtocolInterfaces ( + &ControllerHandle, + &gEfiUdp4ServiceBindingProtocolGuid, + &Udp4Service->ServiceBinding, + NULL + ); + if (EFI_ERROR (Status)) { + Udp4CleanService (Udp4Service); + FreePool (Udp4Service); + } + + return Status; +} + + +/** + Stop this driver on ControllerHandle. This service is called by the + EFI boot service DisconnectController(). In order to + make drivers as small as possible, there are a few calling + restrictions for this service. DisconnectController() + must follow these calling restrictions. If any other agent wishes + to call Stop() it must also follow these calling restrictions. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to stop driver on + @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number of + children is zero stop the entire bus driver. + @param[in] ChildHandleBuffer List of Child Handles to Stop. + + @retval EFI_SUCCESS This driver is removed ControllerHandle + @retval other This driver was not removed from this device + +**/ +EFI_STATUS +EFIAPI +Udp4DriverBindingStop ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN UINTN NumberOfChildren, + IN EFI_HANDLE *ChildHandleBuffer + ) +{ + EFI_STATUS Status; + EFI_HANDLE NicHandle; + EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; + UDP4_SERVICE_DATA *Udp4Service; + UDP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT Context; + LIST_ENTRY *List; + + // + // Find the NicHandle where UDP4 ServiceBinding Protocol is installed. + // + NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiIp4ProtocolGuid); + if (NicHandle == NULL) { + return EFI_SUCCESS; + } + + // + // Retrieve the UDP4 ServiceBinding Protocol. + // + Status = gBS->OpenProtocol ( + NicHandle, + &gEfiUdp4ServiceBindingProtocolGuid, + (VOID **) &ServiceBinding, + This->DriverBindingHandle, + NicHandle, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + if (EFI_ERROR (Status)) { + return EFI_DEVICE_ERROR; + } + + Udp4Service = UDP4_SERVICE_DATA_FROM_THIS (ServiceBinding); + if (NumberOfChildren != 0) { + // + // NumberOfChildren is not zero, destroy the children instances in ChildHandleBuffer. + // + List = &Udp4Service->ChildrenList; + Context.ServiceBinding = ServiceBinding; + Context.NumberOfChildren = NumberOfChildren; + Context.ChildHandleBuffer = ChildHandleBuffer; + Status = NetDestroyLinkList ( + List, + Udp4DestroyChildEntryInHandleBuffer, + &Context, + NULL + ); + } else { + gBS->UninstallMultipleProtocolInterfaces ( + NicHandle, + &gEfiUdp4ServiceBindingProtocolGuid, + &Udp4Service->ServiceBinding, + NULL + ); + + Udp4CleanService (Udp4Service); + + if (gUdpControllerNameTable != NULL) { + FreeUnicodeStringTable (gUdpControllerNameTable); + gUdpControllerNameTable = NULL; + } + FreePool (Udp4Service); + } + + return Status; +} + + +/** + Creates a child handle and installs a protocol. + + The CreateChild() function installs a protocol on ChildHandle. + If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. + If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle. + + @param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. + @param[in] ChildHandle Pointer to the handle of the child to create. If it is NULL, + then a new handle is created. If it is a pointer to an existing UEFI handle, + then the protocol is added to the existing UEFI handle. + + @retval EFI_SUCCES The protocol was added to ChildHandle. + @retval EFI_INVALID_PARAMETER ChildHandle is NULL. + @retval EFI_OUT_OF_RESOURCES There are not enough resources available to create + the child + @retval other The child handle was not created + +**/ +EFI_STATUS +EFIAPI +Udp4ServiceBindingCreateChild ( + IN EFI_SERVICE_BINDING_PROTOCOL *This, + IN EFI_HANDLE *ChildHandle + ) +{ + EFI_STATUS Status; + UDP4_SERVICE_DATA *Udp4Service; + UDP4_INSTANCE_DATA *Instance; + EFI_TPL OldTpl; + VOID *Ip4; + + if ((This == NULL) || (ChildHandle == NULL)) { + return EFI_INVALID_PARAMETER; + } + + Udp4Service = UDP4_SERVICE_DATA_FROM_THIS (This); + + // + // Allocate the instance private data structure. + // + Instance = AllocateZeroPool (sizeof (UDP4_INSTANCE_DATA)); + if (Instance == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + Udp4InitInstance (Udp4Service, Instance); + + // + // Add an IpInfo for this instance. + // + Instance->IpInfo = IpIoAddIp (Udp4Service->IpIo); + if (Instance->IpInfo == NULL) { + Status = EFI_OUT_OF_RESOURCES; + goto ON_ERROR; + } + + // + // Install the Udp4Protocol for this instance. + // + Status = gBS->InstallMultipleProtocolInterfaces ( + ChildHandle, + &gEfiUdp4ProtocolGuid, + &Instance->Udp4Proto, + NULL + ); + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + Instance->ChildHandle = *ChildHandle; + + // + // Open the default Ip4 protocol in the IP_IO BY_CHILD. + // + Status = gBS->OpenProtocol ( + Udp4Service->IpIo->ChildHandle, + &gEfiIp4ProtocolGuid, + (VOID **) &Ip4, + gUdp4DriverBinding.DriverBindingHandle, + Instance->ChildHandle, + EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER + ); + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + // + // Open this instance's Ip4 protocol in the IpInfo BY_CHILD. + // + Status = gBS->OpenProtocol ( + Instance->IpInfo->ChildHandle, + &gEfiIp4ProtocolGuid, + (VOID **) &Ip4, + gUdp4DriverBinding.DriverBindingHandle, + Instance->ChildHandle, + EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER + ); + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + // + // Link this instance into the service context data and increase the ChildrenNumber. + // + InsertTailList (&Udp4Service->ChildrenList, &Instance->Link); + Udp4Service->ChildrenNumber++; + + gBS->RestoreTPL (OldTpl); + + return EFI_SUCCESS; + +ON_ERROR: + + if (Instance->ChildHandle != NULL) { + gBS->UninstallMultipleProtocolInterfaces ( + Instance->ChildHandle, + &gEfiUdp4ProtocolGuid, + &Instance->Udp4Proto, + NULL + ); + } + + if (Instance->IpInfo != NULL) { + IpIoRemoveIp (Udp4Service->IpIo, Instance->IpInfo); + } + + Udp4CleanInstance (Instance); + + FreePool (Instance); + + return Status; +} + + +/** + Destroys a child handle with a protocol installed on it. + + The DestroyChild() function does the opposite of CreateChild(). It removes a protocol + that was installed by CreateChild() from ChildHandle. If the removed protocol is the + last protocol on ChildHandle, then ChildHandle is destroyed. + + @param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. + @param[in] ChildHandle Handle of the child to destroy + + @retval EFI_SUCCES The protocol was removed from ChildHandle. + @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed. + @retval EFI_INVALID_PARAMETER Child handle is NULL. + @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle + because its services are being used. + @retval other The child handle was not destroyed + +**/ +EFI_STATUS +EFIAPI +Udp4ServiceBindingDestroyChild ( + IN EFI_SERVICE_BINDING_PROTOCOL *This, + IN EFI_HANDLE ChildHandle + ) +{ + EFI_STATUS Status; + UDP4_SERVICE_DATA *Udp4Service; + EFI_UDP4_PROTOCOL *Udp4Proto; + UDP4_INSTANCE_DATA *Instance; + EFI_TPL OldTpl; + + if ((This == NULL) || (ChildHandle == NULL)) { + return EFI_INVALID_PARAMETER; + } + + Udp4Service = UDP4_SERVICE_DATA_FROM_THIS (This); + + // + // Try to get the Udp4 protocol from the ChildHandle. + // + Status = gBS->OpenProtocol ( + ChildHandle, + &gEfiUdp4ProtocolGuid, + (VOID **) &Udp4Proto, + gUdp4DriverBinding.DriverBindingHandle, + ChildHandle, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + if (EFI_ERROR (Status)) { + return EFI_UNSUPPORTED; + } + + Instance = UDP4_INSTANCE_DATA_FROM_THIS (Udp4Proto); + + if (Instance->InDestroy) { + return EFI_SUCCESS; + } + + // + // Use the Destroyed flag to avoid the re-entering of the following code. + // + Instance->InDestroy = TRUE; + + // + // Close the Ip4 protocol. + // + gBS->CloseProtocol ( + Udp4Service->IpIo->ChildHandle, + &gEfiIp4ProtocolGuid, + gUdp4DriverBinding.DriverBindingHandle, + Instance->ChildHandle + ); + // + // Close the Ip4 protocol on this instance's IpInfo. + // + gBS->CloseProtocol ( + Instance->IpInfo->ChildHandle, + &gEfiIp4ProtocolGuid, + gUdp4DriverBinding.DriverBindingHandle, + Instance->ChildHandle + ); + + // + // Uninstall the Udp4Protocol previously installed on the ChildHandle. + // + Status = gBS->UninstallMultipleProtocolInterfaces ( + ChildHandle, + &gEfiUdp4ProtocolGuid, + (VOID *) &Instance->Udp4Proto, + NULL + ); + if (EFI_ERROR (Status)) { + Instance->InDestroy = FALSE; + return Status; + } + + // + // Reset the configuration in case the instance's consumer forgets to do this. + // + Udp4Proto->Configure (Udp4Proto, NULL); + + // + // Remove the IpInfo this instance consumes. + // + IpIoRemoveIp (Udp4Service->IpIo, Instance->IpInfo); + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + // + // Remove this instance from the service context data's ChildrenList. + // + RemoveEntryList (&Instance->Link); + Udp4Service->ChildrenNumber--; + + // + // Clean the instance. + // + Udp4CleanInstance (Instance); + + gBS->RestoreTPL (OldTpl); + + FreePool (Instance); + + return EFI_SUCCESS; +} + +/** + This is the declaration of an EFI image entry point. This entry point is + the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including + both device drivers and bus drivers. + + The entry point for Udp4 driver which installs the driver binding + and component name protocol on its ImageHandle. + + @param[in] ImageHandle The firmware allocated handle for the UEFI image. + @param[in] SystemTable A pointer to the EFI System Table. + + @retval EFI_SUCCESS The operation completed successfully. + @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. + +**/ +EFI_STATUS +EFIAPI +Udp4DriverEntryPoint ( + IN EFI_HANDLE ImageHandle, + IN EFI_SYSTEM_TABLE *SystemTable + ) +{ + EFI_STATUS Status; + + // + // Install the Udp4DriverBinding and Udp4ComponentName protocols. + // + Status = EfiLibInstallDriverBindingComponentName2 ( + ImageHandle, + SystemTable, + &gUdp4DriverBinding, + ImageHandle, + &gUdp4ComponentName, + &gUdp4ComponentName2 + ); + if (!EFI_ERROR (Status)) { + // + // Initialize the UDP random port. + // + mUdp4RandomPort = (UINT16) (((UINT16) NetRandomInitSeed ()) % UDP4_PORT_KNOWN + UDP4_PORT_KNOWN); + } + + return Status; +} + diff --git a/NetworkPkg/Udp4Dxe/Udp4Driver.h b/NetworkPkg/Udp4Dxe/Udp4Driver.h new file mode 100644 index 0000000000..4e9a0c7356 --- /dev/null +++ b/NetworkPkg/Udp4Dxe/Udp4Driver.h @@ -0,0 +1,148 @@ +/** @file + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef _UDP4_DRIVER_H_ +#define _UDP4_DRIVER_H_ + +#include +#include +#include +#include +#include + +/** + Test to see if this driver supports ControllerHandle. This service + is called by the EFI boot service ConnectController(). In + order to make drivers as small as possible, there are a few calling + restrictions for this service. ConnectController() must + follow these calling restrictions. If any other agent wishes to call + Supported() it must also follow these calling restrictions. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to test + @param[in] RemainingDevicePath Optional parameter use to pick a specific child + device to start. + + @retval EFI_SUCCESS This driver supports this device + @retval EFI_ALREADY_STARTED This driver is already running on this device + @retval other This driver does not support this device + +**/ +EFI_STATUS +EFIAPI +Udp4DriverBindingSupported ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL + ); + +/** + Start this driver on ControllerHandle. This service is called by the + EFI boot service ConnectController(). In order to make + drivers as small as possible, there are a few calling restrictions for + this service. ConnectController() must follow these + calling restrictions. If any other agent wishes to call Start() it + must also follow these calling restrictions. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to bind driver to + @param[in] RemainingDevicePath Optional parameter use to pick a specific child + device to start. + + @retval EFI_SUCCESS This driver is added to ControllerHandle + @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle + @retval other This driver does not support this device + +**/ +EFI_STATUS +EFIAPI +Udp4DriverBindingStart ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL + ); + +/** + Stop this driver on ControllerHandle. This service is called by the + EFI boot service DisconnectController(). In order to + make drivers as small as possible, there are a few calling + restrictions for this service. DisconnectController() + must follow these calling restrictions. If any other agent wishes + to call Stop() it must also follow these calling restrictions. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to stop driver on + @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number of + children is zero stop the entire bus driver. + @param[in] ChildHandleBuffer List of Child Handles to Stop. + + @retval EFI_SUCCESS This driver is removed ControllerHandle + @retval other This driver was not removed from this device + +**/ +EFI_STATUS +EFIAPI +Udp4DriverBindingStop ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN UINTN NumberOfChildren, + IN EFI_HANDLE *ChildHandleBuffer + ); + +/** + Creates a child handle and installs a protocol. + + The CreateChild() function installs a protocol on ChildHandle. + If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle. + If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle. + + @param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. + @param[in] ChildHandle Pointer to the handle of the child to create. If it is NULL, + then a new handle is created. If it is a pointer to an existing UEFI handle, + then the protocol is added to the existing UEFI handle. + + @retval EFI_SUCCES The protocol was added to ChildHandle. + @retval EFI_INVALID_PARAMETER ChildHandle is NULL. + @retval EFI_OUT_OF_RESOURCES There are not enough resources available to create + the child + @retval other The child handle was not created + +**/ +EFI_STATUS +EFIAPI +Udp4ServiceBindingCreateChild ( + IN EFI_SERVICE_BINDING_PROTOCOL *This, + IN EFI_HANDLE *ChildHandle + ); + +/** + Destroys a child handle with a protocol installed on it. + + The DestroyChild() function does the opposite of CreateChild(). It removes a protocol + that was installed by CreateChild() from ChildHandle. If the removed protocol is the + last protocol on ChildHandle, then ChildHandle is destroyed. + + @param[in] This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance. + @param[in] ChildHandle Handle of the child to destroy + + @retval EFI_SUCCES The protocol was removed from ChildHandle. + @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed. + @retval EFI_INVALID_PARAMETER Child handle is NULL. + @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle + because its services are being used. + @retval other The child handle was not destroyed + +**/ +EFI_STATUS +EFIAPI +Udp4ServiceBindingDestroyChild ( + IN EFI_SERVICE_BINDING_PROTOCOL *This, + IN EFI_HANDLE ChildHandle + ); + +#endif + diff --git a/NetworkPkg/Udp4Dxe/Udp4Dxe.inf b/NetworkPkg/Udp4Dxe/Udp4Dxe.inf new file mode 100644 index 0000000000..ba623a6637 --- /dev/null +++ b/NetworkPkg/Udp4Dxe/Udp4Dxe.inf @@ -0,0 +1,64 @@ +## @file +# This module produces EFI UDP Protocol and EFI UDPv4 Service Binding Protocol. +# +# This module produces EFI UDP(User Datagram Protocol) Protocol upon EFI IPv4 +# Protocol, to provide basic UDPv4 I/O services. +# +# Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+# SPDX-License-Identifier: BSD-2-Clause-Patent +# +# +## + +[Defines] + INF_VERSION = 0x00010005 + BASE_NAME = Udp4Dxe + MODULE_UNI_FILE = Udp4Dxe.uni + FILE_GUID = 6d6963ab-906d-4a65-a7ca-bd40e5d6af2b + MODULE_TYPE = UEFI_DRIVER + VERSION_STRING = 1.0 + ENTRY_POINT = Udp4DriverEntryPoint + UNLOAD_IMAGE = NetLibDefaultUnload +# +# The following information is for reference only and not required by the build tools. +# +# VALID_ARCHITECTURES = IA32 X64 EBC +# +# DRIVER_BINDING = gUdp4DriverBinding +# COMPONENT_NAME = gUdp4ComponentName +# COMPONENT_NAME2 = gUdp4ComponentName2 +# + +[Sources] + Udp4Impl.h + Udp4Main.c + ComponentName.c + Udp4Impl.c + Udp4Driver.h + Udp4Driver.c + + +[Packages] + MdePkg/MdePkg.dec + MdeModulePkg/MdeModulePkg.dec + + +[LibraryClasses] + UefiLib + BaseLib + UefiBootServicesTableLib + UefiDriverEntryPoint + UefiRuntimeServicesTableLib + DebugLib + IpIoLib + NetLib + DpcLib + +[Protocols] + gEfiUdp4ServiceBindingProtocolGuid ## BY_START + gEfiIp4ServiceBindingProtocolGuid ## TO_START + gEfiUdp4ProtocolGuid ## BY_START + gEfiIp4ProtocolGuid ## TO_START + +[UserExtensions.TianoCore."ExtraFiles"] + Udp4DxeExtra.uni diff --git a/NetworkPkg/Udp4Dxe/Udp4Dxe.uni b/NetworkPkg/Udp4Dxe/Udp4Dxe.uni new file mode 100644 index 0000000000..1e3e4aafe7 --- /dev/null +++ b/NetworkPkg/Udp4Dxe/Udp4Dxe.uni @@ -0,0 +1,17 @@ +// /** @file +// This module produces EFI UDP Protocol and EFI UDPv4 Service Binding Protocol. +// +// This module produces EFI UDP(User Datagram Protocol) Protocol upon EFI IPv4 +// Protocol, to provide basic UDPv4 I/O services. +// +// Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+// +// SPDX-License-Identifier: BSD-2-Clause-Patent +// +// **/ + + +#string STR_MODULE_ABSTRACT #language en-US "Produces EFI UDP Protocol and EFI UDPv4 Service Binding Protocol" + +#string STR_MODULE_DESCRIPTION #language en-US "This module produces EFI UDP(User Datagram Protocol) Protocol upon EFI IPv4 Protocol to provide basic UDPv4 I/O services." + diff --git a/NetworkPkg/Udp4Dxe/Udp4DxeExtra.uni b/NetworkPkg/Udp4Dxe/Udp4DxeExtra.uni new file mode 100644 index 0000000000..b048ce31a5 --- /dev/null +++ b/NetworkPkg/Udp4Dxe/Udp4DxeExtra.uni @@ -0,0 +1,14 @@ +// /** @file +// Udp4Dxe Localized Strings and Content +// +// Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.
+// +// SPDX-License-Identifier: BSD-2-Clause-Patent +// +// **/ + +#string STR_PROPERTIES_MODULE_NAME +#language en-US +"UDP v4 DXE Driver" + + diff --git a/NetworkPkg/Udp4Dxe/Udp4Impl.c b/NetworkPkg/Udp4Dxe/Udp4Impl.c new file mode 100644 index 0000000000..fb1951fb13 --- /dev/null +++ b/NetworkPkg/Udp4Dxe/Udp4Impl.c @@ -0,0 +1,1908 @@ +/** @file + The implementation of the Udp4 protocol. + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + + +#include "Udp4Impl.h" + +UINT16 mUdp4RandomPort; + +/** + This function checks and timeouts the I/O datagrams holding by the corresponding + service context. + + @param[in] Event The event this function registered to. + @param[in] Context The context data registered during the creation of + the Event. + +**/ +VOID +EFIAPI +Udp4CheckTimeout ( + IN EFI_EVENT Event, + IN VOID *Context + ); + +/** + This function finds the udp instance by the specified pair. + + @param[in] InstanceList Pointer to the head of the list linking the udp + instances. + @param[in] Address Pointer to the specified IPv4 address. + @param[in] Port The udp port number. + + @retval TRUE The specified pair is found. + @retval FALSE Otherwise. + +**/ +BOOLEAN +Udp4FindInstanceByPort ( + IN LIST_ENTRY *InstanceList, + IN EFI_IPv4_ADDRESS *Address, + IN UINT16 Port + ); + +/** + This function is the packet transmitting notify function registered to the IpIo + interface. It's called to signal the udp TxToken when IpIo layer completes the + transmitting of the udp datagram. + + @param[in] Status The completion status of the output udp datagram. + @param[in] Context Pointer to the context data. + @param[in] Sender Specify a pointer of EFI_IP4_PROTOCOL for sending. + @param[in] NotifyData Pointer to the notify data. + +**/ +VOID +EFIAPI +Udp4DgramSent ( + IN EFI_STATUS Status, + IN VOID *Context, + IN IP_IO_IP_PROTOCOL Sender, + IN VOID *NotifyData + ); + +/** + This function processes the received datagram passed up by the IpIo layer. + + @param[in] Status The status of this udp datagram. + @param[in] IcmpError The IcmpError code, only available when Status is + EFI_ICMP_ERROR. + @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA. + @param[in] Packet Pointer to the NET_BUF containing the received udp + datagram. + @param[in] Context Pointer to the context data. + +**/ +VOID +EFIAPI +Udp4DgramRcvd ( + IN EFI_STATUS Status, + IN UINT8 IcmpError, + IN EFI_NET_SESSION_DATA *NetSession, + IN NET_BUF *Packet, + IN VOID *Context + ); + +/** + This function cancels the token specified by Arg in the Map. This is a callback + used by Udp4InstanceCancelToken(). + + @param[in] Map Pointer to the NET_MAP. + @param[in] Item Pointer to the NET_MAP_ITEM. + @param[in] Arg Pointer to the token to be cancelled, if NULL, + the token specified by Item is cancelled. + + @retval EFI_SUCCESS The token is cancelled if Arg is NULL or the token + is not the same as that in the Item if Arg is not + NULL. + @retval EFI_ABORTED Arg is not NULL, and the token specified by Arg is + cancelled. + +**/ +EFI_STATUS +EFIAPI +Udp4CancelTokens ( + IN NET_MAP *Map, + IN NET_MAP_ITEM *Item, + IN VOID *Arg OPTIONAL + ); + +/** + This function matches the received udp datagram with the Instance. + + @param[in] Instance Pointer to the udp instance context data. + @param[in] Udp4Session Pointer to the EFI_UDP4_SESSION_DATA abstracted + from the received udp datagram. + + @retval TRUE The udp datagram matches the receiving requirments of the + udp Instance. + @retval FALSE Otherwise. + +**/ +BOOLEAN +Udp4MatchDgram ( + IN UDP4_INSTANCE_DATA *Instance, + IN EFI_UDP4_SESSION_DATA *Udp4Session + ); + +/** + This function removes the Wrap specified by Context and release relevant resources. + + @param[in] Event The Event this notify function registered to. + @param[in] Context Pointer to the context data. + +**/ +VOID +EFIAPI +Udp4RecycleRxDataWrap ( + IN EFI_EVENT Event, + IN VOID *Context + ); + +/** + This function wraps the Packet and the RxData. + + @param[in] Instance Pointer to the instance context data. + @param[in] Packet Pointer to the buffer containing the received + datagram. + @param[in] RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this + datagram. + + @return Pointer to the structure wrapping the RxData and the Packet. + +**/ +UDP4_RXDATA_WRAP * +Udp4WrapRxData ( + IN UDP4_INSTANCE_DATA *Instance, + IN NET_BUF *Packet, + IN EFI_UDP4_RECEIVE_DATA *RxData + ); + +/** + This function enqueues the received datagram into the instances' receiving queues. + + @param[in] Udp4Service Pointer to the udp service context data. + @param[in] Packet Pointer to the buffer containing the received + datagram. + @param[in] RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this + datagram. + + @return The times this datagram is enqueued. + +**/ +UINTN +Udp4EnqueueDgram ( + IN UDP4_SERVICE_DATA *Udp4Service, + IN NET_BUF *Packet, + IN EFI_UDP4_RECEIVE_DATA *RxData + ); + +/** + This function delivers the datagrams enqueued in the instances. + + @param[in] Udp4Service Pointer to the udp service context data. + +**/ +VOID +Udp4DeliverDgram ( + IN UDP4_SERVICE_DATA *Udp4Service + ); + +/** + This function demultiplexes the received udp datagram to the appropriate instances. + + @param[in] Udp4Service Pointer to the udp service context data. + @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA abstracted from + the received datagram. + @param[in] Packet Pointer to the buffer containing the received udp + datagram. + +**/ +VOID +Udp4Demultiplex ( + IN UDP4_SERVICE_DATA *Udp4Service, + IN EFI_NET_SESSION_DATA *NetSession, + IN NET_BUF *Packet + ); + +/** + This function handles the received Icmp Error message and demultiplexes it to the + instance. + + @param[in] Udp4Service Pointer to the udp service context data. + @param[in] IcmpError The icmp error code. + @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA abstracted + from the received Icmp Error packet. + @param[in] Packet Pointer to the Icmp Error packet. + +**/ +VOID +Udp4IcmpHandler ( + IN UDP4_SERVICE_DATA *Udp4Service, + IN UINT8 IcmpError, + IN EFI_NET_SESSION_DATA *NetSession, + IN NET_BUF *Packet + ); + +/** + This function builds and sends out a icmp port unreachable message. + + @param[in] IpIo Pointer to the IP_IO instance. + @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA of the packet + causes this icmp error message. + @param[in] Udp4Header Pointer to the udp header of the datagram causes + this icmp error message. + +**/ +VOID +Udp4SendPortUnreach ( + IN IP_IO *IpIo, + IN EFI_NET_SESSION_DATA *NetSession, + IN VOID *Udp4Header + ); + + +/** + Create the Udp service context data. + + @param[in, out] Udp4Service Pointer to the UDP4_SERVICE_DATA. + @param[in] ImageHandle The image handle of this udp4 driver. + @param[in] ControllerHandle The controller handle this udp4 driver binds on. + + @retval EFI_SUCCESS The udp4 service context data is created and + initialized. + @retval EFI_OUT_OF_RESOURCES Cannot allocate memory. + @retval other Other error occurs. + +**/ +EFI_STATUS +Udp4CreateService ( + IN OUT UDP4_SERVICE_DATA *Udp4Service, + IN EFI_HANDLE ImageHandle, + IN EFI_HANDLE ControllerHandle + ) +{ + EFI_STATUS Status; + IP_IO_OPEN_DATA OpenData; + EFI_IP4_CONFIG_DATA *Ip4ConfigData; + + ZeroMem (Udp4Service, sizeof (UDP4_SERVICE_DATA)); + + Udp4Service->Signature = UDP4_SERVICE_DATA_SIGNATURE; + Udp4Service->ServiceBinding = mUdp4ServiceBinding; + Udp4Service->ImageHandle = ImageHandle; + Udp4Service->ControllerHandle = ControllerHandle; + Udp4Service->ChildrenNumber = 0; + + InitializeListHead (&Udp4Service->ChildrenList); + + // + // Create the IpIo for this service context. + // + Udp4Service->IpIo = IpIoCreate (ImageHandle, ControllerHandle, IP_VERSION_4); + if (Udp4Service->IpIo == NULL) { + return EFI_OUT_OF_RESOURCES; + } + + // + // Set the OpenData used to open the IpIo. + // + Ip4ConfigData = &OpenData.IpConfigData.Ip4CfgData; + CopyMem (Ip4ConfigData, &mIp4IoDefaultIpConfigData, sizeof (EFI_IP4_CONFIG_DATA)); + Ip4ConfigData->AcceptBroadcast = TRUE; + OpenData.RcvdContext = (VOID *) Udp4Service; + OpenData.SndContext = NULL; + OpenData.PktRcvdNotify = Udp4DgramRcvd; + OpenData.PktSentNotify = Udp4DgramSent; + + // + // Configure and start the IpIo. + // + Status = IpIoOpen (Udp4Service->IpIo, &OpenData); + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + // + // Create the event for Udp timeout checking. + // + Status = gBS->CreateEvent ( + EVT_TIMER | EVT_NOTIFY_SIGNAL, + TPL_CALLBACK, + Udp4CheckTimeout, + Udp4Service, + &Udp4Service->TimeoutEvent + ); + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + // + // Start the timeout timer event. + // + Status = gBS->SetTimer ( + Udp4Service->TimeoutEvent, + TimerPeriodic, + UDP4_TIMEOUT_INTERVAL + ); + if (EFI_ERROR (Status)) { + goto ON_ERROR; + } + + return EFI_SUCCESS; + +ON_ERROR: + + if (Udp4Service->TimeoutEvent != NULL) { + gBS->CloseEvent (Udp4Service->TimeoutEvent); + } + + IpIoDestroy (Udp4Service->IpIo); + + return Status; +} + + +/** + Clean the Udp service context data. + + @param[in] Udp4Service Pointer to the UDP4_SERVICE_DATA. + +**/ +VOID +Udp4CleanService ( + IN UDP4_SERVICE_DATA *Udp4Service + ) +{ + // + // Cancel the TimeoutEvent timer. + // + gBS->SetTimer (Udp4Service->TimeoutEvent, TimerCancel, 0); + + // + // Close the TimeoutEvent timer. + // + gBS->CloseEvent (Udp4Service->TimeoutEvent); + + // + // Destroy the IpIo. + // + IpIoDestroy (Udp4Service->IpIo); +} + + +/** + This function checks and timeouts the I/O datagrams holding by the corresponding + service context. + + @param[in] Event The event this function registered to. + @param[in] Context The context data registered during the creation of + the Event. + +**/ +VOID +EFIAPI +Udp4CheckTimeout ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + UDP4_SERVICE_DATA *Udp4Service; + LIST_ENTRY *Entry; + UDP4_INSTANCE_DATA *Instance; + LIST_ENTRY *WrapEntry; + LIST_ENTRY *NextEntry; + UDP4_RXDATA_WRAP *Wrap; + + Udp4Service = (UDP4_SERVICE_DATA *) Context; + NET_CHECK_SIGNATURE (Udp4Service, UDP4_SERVICE_DATA_SIGNATURE); + + NET_LIST_FOR_EACH (Entry, &Udp4Service->ChildrenList) { + // + // Iterate all the instances belonging to this service context. + // + Instance = NET_LIST_USER_STRUCT (Entry, UDP4_INSTANCE_DATA, Link); + NET_CHECK_SIGNATURE (Instance, UDP4_INSTANCE_DATA_SIGNATURE); + + if (!Instance->Configured || (Instance->ConfigData.ReceiveTimeout == 0)) { + // + // Skip this instance if it's not configured or no receive timeout. + // + continue; + } + + NET_LIST_FOR_EACH_SAFE (WrapEntry, NextEntry, &Instance->RcvdDgramQue) { + // + // Iterate all the rxdatas belonging to this udp instance. + // + Wrap = NET_LIST_USER_STRUCT (WrapEntry, UDP4_RXDATA_WRAP, Link); + + // + // TimeoutTick unit is microsecond, MNP_TIMEOUT_CHECK_INTERVAL unit is 100ns. + // + if (Wrap->TimeoutTick < (UDP4_TIMEOUT_INTERVAL / 10)) { + // + // Remove this RxData if it timeouts. + // + Udp4RecycleRxDataWrap (NULL, (VOID *) Wrap); + } else { + Wrap->TimeoutTick -= (UDP4_TIMEOUT_INTERVAL / 10); + } + } + } +} + + +/** + This function intializes the new created udp instance. + + @param[in] Udp4Service Pointer to the UDP4_SERVICE_DATA. + @param[in, out] Instance Pointer to the un-initialized UDP4_INSTANCE_DATA. + +**/ +VOID +Udp4InitInstance ( + IN UDP4_SERVICE_DATA *Udp4Service, + IN OUT UDP4_INSTANCE_DATA *Instance + ) +{ + // + // Set the signature. + // + Instance->Signature = UDP4_INSTANCE_DATA_SIGNATURE; + + // + // Init the lists. + // + InitializeListHead (&Instance->Link); + InitializeListHead (&Instance->RcvdDgramQue); + InitializeListHead (&Instance->DeliveredDgramQue); + + // + // Init the NET_MAPs. + // + NetMapInit (&Instance->TxTokens); + NetMapInit (&Instance->RxTokens); + NetMapInit (&Instance->McastIps); + + // + // Save the pointer to the UDP4_SERVICE_DATA, and initialize other members. + // + Instance->Udp4Service = Udp4Service; + CopyMem (&Instance->Udp4Proto, &mUdp4Protocol, sizeof (Instance->Udp4Proto)); + Instance->IcmpError = EFI_SUCCESS; + Instance->Configured = FALSE; + Instance->IsNoMapping = FALSE; + Instance->InDestroy = FALSE; +} + + +/** + This function cleans the udp instance. + + @param[in] Instance Pointer to the UDP4_INSTANCE_DATA to clean. + +**/ +VOID +Udp4CleanInstance ( + IN UDP4_INSTANCE_DATA *Instance + ) +{ + NetMapClean (&Instance->McastIps); + NetMapClean (&Instance->RxTokens); + NetMapClean (&Instance->TxTokens); +} + + +/** + This function finds the udp instance by the specified pair. + + @param[in] InstanceList Pointer to the head of the list linking the udp + instances. + @param[in] Address Pointer to the specified IPv4 address. + @param[in] Port The udp port number. + + @retval TRUE The specified pair is found. + @retval FALSE Otherwise. + +**/ +BOOLEAN +Udp4FindInstanceByPort ( + IN LIST_ENTRY *InstanceList, + IN EFI_IPv4_ADDRESS *Address, + IN UINT16 Port + ) +{ + LIST_ENTRY *Entry; + UDP4_INSTANCE_DATA *Instance; + EFI_UDP4_CONFIG_DATA *ConfigData; + + NET_LIST_FOR_EACH (Entry, InstanceList) { + // + // Iterate all the udp instances. + // + Instance = NET_LIST_USER_STRUCT (Entry, UDP4_INSTANCE_DATA, Link); + ConfigData = &Instance->ConfigData; + + if (!Instance->Configured || ConfigData->AcceptAnyPort) { + // + // If the instance is not configured or the configdata of the instance indicates + // this instance accepts any port, skip it. + // + continue; + } + + if (EFI_IP4_EQUAL (&ConfigData->StationAddress, Address) && + (ConfigData->StationPort == Port)) { + // + // if both the address and the port are the same, return TRUE. + // + return TRUE; + } + } + + // + // return FALSE when matching fails. + // + return FALSE; +} + + +/** + This function tries to bind the udp instance according to the configured port + allocation strategy. + + @param[in] InstanceList Pointer to the head of the list linking the udp + instances. + @param[in, out] ConfigData Pointer to the ConfigData of the instance to be + bound. ConfigData->StationPort will be assigned + with an available port value on success. + + @retval EFI_SUCCESS The bound operation is completed successfully. + @retval EFI_ACCESS_DENIED The specified by the ConfigData is + already used by other instance. + @retval EFI_OUT_OF_RESOURCES No available port resources. + +**/ +EFI_STATUS +Udp4Bind ( + IN LIST_ENTRY *InstanceList, + IN OUT EFI_UDP4_CONFIG_DATA *ConfigData + ) +{ + EFI_IPv4_ADDRESS *StationAddress; + UINT16 StartPort; + + if (ConfigData->AcceptAnyPort) { + return EFI_SUCCESS; + } + + StationAddress = &ConfigData->StationAddress; + + if (ConfigData->StationPort != 0) { + + if (!ConfigData->AllowDuplicatePort && + Udp4FindInstanceByPort (InstanceList, StationAddress, ConfigData->StationPort)) { + // + // Do not allow duplicate port and the port is already used by other instance. + // + return EFI_ACCESS_DENIED; + } + } else { + // + // select a random port for this instance; + // + + if (ConfigData->AllowDuplicatePort) { + // + // Just pick up the random port if the instance allows duplicate port. + // + ConfigData->StationPort = mUdp4RandomPort; + } else { + + StartPort = mUdp4RandomPort; + + while (Udp4FindInstanceByPort(InstanceList, StationAddress, mUdp4RandomPort)) { + + mUdp4RandomPort++; + if (mUdp4RandomPort == 0) { + mUdp4RandomPort = UDP4_PORT_KNOWN; + } + + if (mUdp4RandomPort == StartPort) { + // + // No available port. + // + return EFI_OUT_OF_RESOURCES; + } + } + + ConfigData->StationPort = mUdp4RandomPort; + } + + mUdp4RandomPort++; + if (mUdp4RandomPort == 0) { + mUdp4RandomPort = UDP4_PORT_KNOWN; + } + } + + return EFI_SUCCESS; +} + + +/** + This function is used to check whether the NewConfigData has any un-reconfigurable + parameters changed compared to the OldConfigData. + + @param[in] OldConfigData Pointer to the current ConfigData the udp instance + uses. + @param[in] NewConfigData Pointer to the new ConfigData. + + @retval TRUE The instance is reconfigurable. + @retval FALSE Otherwise. + +**/ +BOOLEAN +Udp4IsReconfigurable ( + IN EFI_UDP4_CONFIG_DATA *OldConfigData, + IN EFI_UDP4_CONFIG_DATA *NewConfigData + ) +{ + if ((NewConfigData->AcceptAnyPort != OldConfigData->AcceptAnyPort) || + (NewConfigData->AcceptBroadcast != OldConfigData->AcceptBroadcast) || + (NewConfigData->AcceptPromiscuous != OldConfigData->AcceptPromiscuous) || + (NewConfigData->AllowDuplicatePort != OldConfigData->AllowDuplicatePort) + ) { + // + // The receiving filter parameters cannot be changed. + // + return FALSE; + } + + if ((!NewConfigData->AcceptAnyPort) && + (NewConfigData->StationPort != OldConfigData->StationPort) + ) { + // + // The port is not changeable. + // + return FALSE; + } + + if (!NewConfigData->AcceptPromiscuous) { + + if (NewConfigData->UseDefaultAddress != OldConfigData->UseDefaultAddress) { + // + // The NewConfigData differs to the old one on the UseDefaultAddress. + // + return FALSE; + } + + if (!NewConfigData->UseDefaultAddress && + (!EFI_IP4_EQUAL (&NewConfigData->StationAddress, &OldConfigData->StationAddress) || + !EFI_IP4_EQUAL (&NewConfigData->SubnetMask, &OldConfigData->SubnetMask)) + ) { + // + // If the instance doesn't use the default address, and the new address or + // new subnet mask is different from the old values. + // + return FALSE; + } + } + + if (!EFI_IP4_EQUAL (&NewConfigData->RemoteAddress, &OldConfigData->RemoteAddress)) { + // + // The remoteaddress is not the same. + // + return FALSE; + } + + if (!EFI_IP4_EQUAL (&NewConfigData->RemoteAddress, &mZeroIp4Addr) && + NewConfigData->RemotePort != OldConfigData->RemotePort + ) { + // + // The RemotePort differs if it's designated in the configdata. + // + return FALSE; + } + + // + // All checks pass, return TRUE. + // + return TRUE; +} + + +/** + This function builds the Ip4 configdata from the Udp4ConfigData. + + @param[in] Udp4ConfigData Pointer to the EFI_UDP4_CONFIG_DATA. + @param[in, out] Ip4ConfigData Pointer to the EFI_IP4_CONFIG_DATA. + +**/ +VOID +Udp4BuildIp4ConfigData ( + IN EFI_UDP4_CONFIG_DATA *Udp4ConfigData, + IN OUT EFI_IP4_CONFIG_DATA *Ip4ConfigData + ) +{ + CopyMem (Ip4ConfigData, &mIp4IoDefaultIpConfigData, sizeof (*Ip4ConfigData)); + + Ip4ConfigData->DefaultProtocol = EFI_IP_PROTO_UDP; + Ip4ConfigData->AcceptBroadcast = Udp4ConfigData->AcceptBroadcast; + Ip4ConfigData->AcceptPromiscuous = Udp4ConfigData->AcceptPromiscuous; + Ip4ConfigData->UseDefaultAddress = Udp4ConfigData->UseDefaultAddress; + CopyMem (&Ip4ConfigData->StationAddress, &Udp4ConfigData->StationAddress, sizeof (EFI_IPv4_ADDRESS)); + CopyMem (&Ip4ConfigData->SubnetMask, &Udp4ConfigData->SubnetMask, sizeof (EFI_IPv4_ADDRESS)); + + // + // use the -1 magic number to disable the receiving process of the ip instance. + // + Ip4ConfigData->ReceiveTimeout = (UINT32) (-1); +} + + +/** + This function validates the TxToken, it returns the error code according to the spec. + + @param[in] Instance Pointer to the udp instance context data. + @param[in] TxToken Pointer to the token to be checked. + + @retval EFI_SUCCESS The TxToken is valid. + @retval EFI_INVALID_PARAMETER One or more of the following are TRUE: This is + NULL. Token is NULL. Token.Event is NULL. + Token.Packet.TxData is NULL. + Token.Packet.TxData.FragmentCount is zero. + Token.Packet.TxData.DataLength is not equal to the + sum of fragment lengths. One or more of the + Token.Packet.TxData.FragmentTable[]. + FragmentLength fields is zero. One or more of the + Token.Packet.TxData.FragmentTable[]. + FragmentBuffer fields is NULL. + Token.Packet.TxData. GatewayAddress is not a + unicast IPv4 address if it is not NULL. One or + more IPv4 addresses in Token.Packet.TxData. + UdpSessionData are not valid unicast IPv4 + addresses if the UdpSessionData is not NULL. + @retval EFI_BAD_BUFFER_SIZE The data length is greater than the maximum UDP + packet size. + +**/ +EFI_STATUS +Udp4ValidateTxToken ( + IN UDP4_INSTANCE_DATA *Instance, + IN EFI_UDP4_COMPLETION_TOKEN *TxToken + ) +{ + EFI_UDP4_TRANSMIT_DATA *TxData; + UINT32 Index; + UINT32 TotalLen; + EFI_UDP4_CONFIG_DATA *ConfigData; + EFI_UDP4_SESSION_DATA *UdpSessionData; + IP4_ADDR SourceAddress; + IP4_ADDR GatewayAddress; + + if (TxToken->Event == NULL) { + return EFI_INVALID_PARAMETER; + } + + TxData = TxToken->Packet.TxData; + + if ((TxData == NULL) || (TxData->FragmentCount == 0)) { + return EFI_INVALID_PARAMETER; + } + + TotalLen = 0; + for (Index = 0; Index < TxData->FragmentCount; Index++) { + + if ((TxData->FragmentTable[Index].FragmentBuffer == NULL) || + (TxData->FragmentTable[Index].FragmentLength == 0)) { + // + // if the FragmentBuffer is NULL or the FragmentLeng is zero. + // + return EFI_INVALID_PARAMETER; + } + + TotalLen += TxData->FragmentTable[Index].FragmentLength; + } + + if (TotalLen != TxData->DataLength) { + // + // The TotalLen calculated by adding all the FragmentLeng doesn't equal to the + // DataLength. + // + return EFI_INVALID_PARAMETER; + } + + if (TxData->GatewayAddress != NULL) { + CopyMem (&GatewayAddress, TxData->GatewayAddress, sizeof (IP4_ADDR)); + + if (!Instance->ConfigData.UseDefaultAddress && + (EFI_NTOHL(Instance->ConfigData.SubnetMask) != 0) && + !NetIp4IsUnicast (NTOHL (GatewayAddress), EFI_NTOHL(Instance->ConfigData.SubnetMask))) { + // + // The specified GatewayAddress is not a unicast IPv4 address while it's not 0. + // + return EFI_INVALID_PARAMETER; + } + } + + ConfigData = &Instance->ConfigData; + UdpSessionData = TxData->UdpSessionData; + + if (UdpSessionData != NULL) { + + CopyMem (&SourceAddress, &UdpSessionData->SourceAddress, sizeof (IP4_ADDR)); + + if ((SourceAddress != 0) && + !Instance->ConfigData.UseDefaultAddress && + (EFI_NTOHL(Instance->ConfigData.SubnetMask) != 0) && + !NetIp4IsUnicast (HTONL (SourceAddress), EFI_NTOHL(Instance->ConfigData.SubnetMask))) { + // + // Check whether SourceAddress is a valid IPv4 address in case it's not zero. + // The configured station address is used if SourceAddress is zero. + // + return EFI_INVALID_PARAMETER; + } + + if ((UdpSessionData->DestinationPort == 0) && (ConfigData->RemotePort == 0)) { + // + // Ambiguous, no avalaible DestinationPort for this token. + // + return EFI_INVALID_PARAMETER; + } + + if (EFI_IP4_EQUAL (&UdpSessionData->DestinationAddress, &mZeroIp4Addr)) { + // + // The DestinationAddress specified in the UdpSessionData is 0. + // + return EFI_INVALID_PARAMETER; + } + } else if (EFI_IP4_EQUAL (&ConfigData->RemoteAddress, &mZeroIp4Addr)) { + // + // the configured RemoteAddress is all zero, and the user doens't override the + // destination address. + // + return EFI_INVALID_PARAMETER; + } + + if (TxData->DataLength > UDP4_MAX_DATA_SIZE) { + return EFI_BAD_BUFFER_SIZE; + } + + return EFI_SUCCESS; +} + + +/** + This function checks whether the specified Token duplicates with the one in the Map. + + @param[in] Map Pointer to the NET_MAP. + @param[in] Item Pointer to the NET_MAP_ITEM contain the pointer to + the Token. + @param[in] Context Pointer to the Token to be checked. + + @retval EFI_SUCCESS The Token specified by Context differs from the + one in the Item. + @retval EFI_ACCESS_DENIED The Token duplicates with the one in the Item. + +**/ +EFI_STATUS +EFIAPI +Udp4TokenExist ( + IN NET_MAP *Map, + IN NET_MAP_ITEM *Item, + IN VOID *Context + ) +{ + EFI_UDP4_COMPLETION_TOKEN *Token; + EFI_UDP4_COMPLETION_TOKEN *TokenInItem; + + Token = (EFI_UDP4_COMPLETION_TOKEN*) Context; + TokenInItem = (EFI_UDP4_COMPLETION_TOKEN*) Item->Key; + + if ((Token == TokenInItem) || (Token->Event == TokenInItem->Event)) { + // + // The Token duplicates with the TokenInItem in case either the two pointers are the + // same or the Events of these two tokens are the same. + // + return EFI_ACCESS_DENIED; + } + + return EFI_SUCCESS; +} + + +/** + This function calculates the checksum for the Packet, utilizing the pre-calculated + pseudo HeadSum to reduce some overhead. + + @param[in] Packet Pointer to the NET_BUF contains the udp datagram. + @param[in] HeadSum Checksum of the pseudo header execpt the length + field. + + @retval The 16-bit checksum of this udp datagram. + +**/ +UINT16 +Udp4Checksum ( + IN NET_BUF *Packet, + IN UINT16 HeadSum + ) +{ + UINT16 Checksum; + + Checksum = NetbufChecksum (Packet); + Checksum = NetAddChecksum (Checksum, HeadSum); + + Checksum = NetAddChecksum (Checksum, HTONS ((UINT16) Packet->TotalSize)); + + return (UINT16) ~Checksum; +} + + +/** + This function removes the specified Token from the TokenMap. + + @param[in, out] TokenMap Pointer to the NET_MAP containing the tokens. + @param[in] Token Pointer to the Token to be removed. + + @retval EFI_SUCCESS The specified Token is removed from the TokenMap. + @retval EFI_NOT_FOUND The specified Token is not found in the TokenMap. + +**/ +EFI_STATUS +Udp4RemoveToken ( + IN OUT NET_MAP *TokenMap, + IN EFI_UDP4_COMPLETION_TOKEN *Token + ) +{ + NET_MAP_ITEM *Item; + + // + // Find the Token first. + // + Item = NetMapFindKey (TokenMap, (VOID *) Token); + + if (Item != NULL) { + // + // Remove the token if it's found in the map. + // + NetMapRemoveItem (TokenMap, Item, NULL); + + return EFI_SUCCESS; + } + + return EFI_NOT_FOUND; +} + + +/** + This function is the packet transmitting notify function registered to the IpIo + interface. It's called to signal the udp TxToken when IpIo layer completes the + transmitting of the udp datagram. + + @param[in] Status The completion status of the output udp datagram. + @param[in] Context Pointer to the context data. + @param[in] Sender Specify a pointer of EFI_IP4_PROTOCOL for sending. + @param[in] NotifyData Pointer to the notify data. + +**/ +VOID +EFIAPI +Udp4DgramSent ( + IN EFI_STATUS Status, + IN VOID *Context, + IN IP_IO_IP_PROTOCOL Sender, + IN VOID *NotifyData + ) +{ + UDP4_INSTANCE_DATA *Instance; + EFI_UDP4_COMPLETION_TOKEN *Token; + + Instance = (UDP4_INSTANCE_DATA *) Context; + Token = (EFI_UDP4_COMPLETION_TOKEN *) NotifyData; + + if (Udp4RemoveToken (&Instance->TxTokens, Token) == EFI_SUCCESS) { + // + // The token may be cancelled. Only signal it if the remove operation succeeds. + // + Token->Status = Status; + gBS->SignalEvent (Token->Event); + DispatchDpc (); + } +} + + +/** + This function processes the received datagram passed up by the IpIo layer. + + @param[in] Status The status of this udp datagram. + @param[in] IcmpError The IcmpError code, only available when Status is + EFI_ICMP_ERROR. + @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA. + @param[in] Packet Pointer to the NET_BUF containing the received udp + datagram. + @param[in] Context Pointer to the context data. + +**/ +VOID +EFIAPI +Udp4DgramRcvd ( + IN EFI_STATUS Status, + IN UINT8 IcmpError, + IN EFI_NET_SESSION_DATA *NetSession, + IN NET_BUF *Packet, + IN VOID *Context + ) +{ + NET_CHECK_SIGNATURE (Packet, NET_BUF_SIGNATURE); + + // + // IpIo only passes received packets with Status EFI_SUCCESS or EFI_ICMP_ERROR. + // + if (Status == EFI_SUCCESS) { + // + // Demultiplex the received datagram. + // + Udp4Demultiplex ((UDP4_SERVICE_DATA *) Context, NetSession, Packet); + } else { + // + // Handle the ICMP_ERROR packet. + // + Udp4IcmpHandler ((UDP4_SERVICE_DATA *) Context, IcmpError, NetSession, Packet); + } + + // + // Dispatch the DPC queued by the NotifyFunction of the rx token's events + // which are signaled with received data. + // + DispatchDpc (); +} + + +/** + This function removes the multicast group specified by Arg from the Map. + + @param[in, out] Map Pointer to the NET_MAP. + @param[in] Item Pointer to the NET_MAP_ITEM. + @param[in] Arg Pointer to the Arg, it's the pointer to a + multicast IPv4 Address. + + @retval EFI_SUCCESS The multicast address is removed. + @retval EFI_ABORTED The specified multicast address is removed and the + Arg is not NULL. + +**/ +EFI_STATUS +EFIAPI +Udp4LeaveGroup ( + IN OUT NET_MAP *Map, + IN NET_MAP_ITEM *Item, + IN VOID *Arg OPTIONAL + ) +{ + EFI_IPv4_ADDRESS *McastIp; + + McastIp = Arg; + + if ((McastIp != NULL) && (!EFI_IP4_EQUAL (McastIp, &(Item->Key)))) { + // + // McastIp is not NULL and the multicast address contained in the Item + // is not the same as McastIp. + // + return EFI_SUCCESS; + } + + // + // Remove this Item. + // + NetMapRemoveItem (Map, Item, NULL); + + if (McastIp != NULL) { + // + // Return EFI_ABORTED in case McastIp is not NULL to terminate the iteration. + // + return EFI_ABORTED; + } + + return EFI_SUCCESS; +} + + +/** + This function cancels the token specified by Arg in the Map. This is a callback + used by Udp4InstanceCancelToken(). + + @param[in] Map Pointer to the NET_MAP. + @param[in] Item Pointer to the NET_MAP_ITEM. + @param[in] Arg Pointer to the token to be cancelled, if NULL, + the token specified by Item is cancelled. + + @retval EFI_SUCCESS The token is cancelled if Arg is NULL or the token + is not the same as that in the Item if Arg is not + NULL. + @retval EFI_ABORTED Arg is not NULL, and the token specified by Arg is + cancelled. + +**/ +EFI_STATUS +EFIAPI +Udp4CancelTokens ( + IN NET_MAP *Map, + IN NET_MAP_ITEM *Item, + IN VOID *Arg OPTIONAL + ) +{ + EFI_UDP4_COMPLETION_TOKEN *TokenToCancel; + NET_BUF *Packet; + IP_IO *IpIo; + + if ((Arg != NULL) && (Item->Key != Arg)) { + return EFI_SUCCESS; + } + + if (Item->Value != NULL) { + // + // If the token is a transmit token, the corresponding Packet is recorded in + // Item->Value, invoke IpIo to cancel this packet first. The IpIoCancelTxToken + // will invoke Udp4DgramSent, the token will be signaled and this Item will + // be removed from the Map there. + // + Packet = (NET_BUF *) (Item->Value); + IpIo = (IP_IO *) (*((UINTN *) &Packet->ProtoData[0])); + + IpIoCancelTxToken (IpIo, Packet); + } else { + // + // The token is a receive token. Abort it and remove it from the Map. + // + TokenToCancel = (EFI_UDP4_COMPLETION_TOKEN *) Item->Key; + NetMapRemoveItem (Map, Item, NULL); + + TokenToCancel->Status = EFI_ABORTED; + gBS->SignalEvent (TokenToCancel->Event); + } + + if (Arg != NULL) { + return EFI_ABORTED; + } + + return EFI_SUCCESS; +} + + +/** + This function removes all the Wrap datas in the RcvdDgramQue. + + @param[in] Instance Pointer to the udp instance context data. + +**/ +VOID +Udp4FlushRcvdDgram ( + IN UDP4_INSTANCE_DATA *Instance + ) +{ + UDP4_RXDATA_WRAP *Wrap; + + while (!IsListEmpty (&Instance->RcvdDgramQue)) { + // + // Iterate all the Wraps in the RcvdDgramQue. + // + Wrap = NET_LIST_HEAD (&Instance->RcvdDgramQue, UDP4_RXDATA_WRAP, Link); + + // + // The Wrap will be removed from the RcvdDgramQue by this function call. + // + Udp4RecycleRxDataWrap (NULL, (VOID *) Wrap); + } +} + + + +/** + Cancel Udp4 tokens from the Udp4 instance. + + @param[in] Instance Pointer to the udp instance context data. + @param[in] Token Pointer to the token to be canceled, if NULL, all + tokens in this instance will be cancelled. + + @retval EFI_SUCCESS The Token is cancelled. + @retval EFI_NOT_FOUND The Token is not found. + +**/ +EFI_STATUS +Udp4InstanceCancelToken ( + IN UDP4_INSTANCE_DATA *Instance, + IN EFI_UDP4_COMPLETION_TOKEN *Token OPTIONAL + ) +{ + EFI_STATUS Status; + + // + // Cancel this token from the TxTokens map. + // + Status = NetMapIterate (&Instance->TxTokens, Udp4CancelTokens, Token); + + if ((Token != NULL) && (Status == EFI_ABORTED)) { + // + // If Token isn't NULL and Status is EFI_ABORTED, the token is cancelled from + // the TxTokens, just return success. + // + return EFI_SUCCESS; + } + + // + // Try to cancel this token from the RxTokens map in condition either the Token + // is NULL or the specified Token is not in TxTokens. + // + Status = NetMapIterate (&Instance->RxTokens, Udp4CancelTokens, Token); + + if ((Token != NULL) && (Status == EFI_SUCCESS)) { + // + // If Token isn't NULL and Status is EFI_SUCCESS, the token is neither in the + // TxTokens nor the RxTokens, or say, it's not found. + // + return EFI_NOT_FOUND; + } + + ASSERT ((Token != NULL) || ((0 == NetMapGetCount (&Instance->TxTokens)) + && (0 == NetMapGetCount (&Instance->RxTokens)))); + + return EFI_SUCCESS; +} + + +/** + This function matches the received udp datagram with the Instance. + + @param[in] Instance Pointer to the udp instance context data. + @param[in] Udp4Session Pointer to the EFI_UDP4_SESSION_DATA abstracted + from the received udp datagram. + + @retval TRUE The udp datagram matches the receiving requirments of the + udp Instance. + @retval FALSE Otherwise. + +**/ +BOOLEAN +Udp4MatchDgram ( + IN UDP4_INSTANCE_DATA *Instance, + IN EFI_UDP4_SESSION_DATA *Udp4Session + ) +{ + EFI_UDP4_CONFIG_DATA *ConfigData; + IP4_ADDR Destination; + + ConfigData = &Instance->ConfigData; + + if (ConfigData->AcceptPromiscuous) { + // + // Always matches if this instance is in the promiscuous state. + // + return TRUE; + } + + if ((!ConfigData->AcceptAnyPort && (Udp4Session->DestinationPort != ConfigData->StationPort)) || + ((ConfigData->RemotePort != 0) && (Udp4Session->SourcePort != ConfigData->RemotePort)) + ) { + // + // The local port or the remote port doesn't match. + // + return FALSE; + } + + if (!EFI_IP4_EQUAL (&ConfigData->RemoteAddress, &mZeroIp4Addr) && + !EFI_IP4_EQUAL (&ConfigData->RemoteAddress, &Udp4Session->SourceAddress) + ) { + // + // This datagram doesn't come from the instance's specified sender. + // + return FALSE; + } + + if (EFI_IP4_EQUAL (&ConfigData->StationAddress, &mZeroIp4Addr) || + EFI_IP4_EQUAL (&Udp4Session->DestinationAddress, &ConfigData->StationAddress) + ) { + // + // The instance is configured to receive datagrams destined to any station IP or + // the destination address of this datagram matches the configured station IP. + // + return TRUE; + } + + CopyMem (&Destination, &Udp4Session->DestinationAddress, sizeof (IP4_ADDR)); + + if (IP4_IS_LOCAL_BROADCAST (Destination) && ConfigData->AcceptBroadcast) { + // + // The instance is configured to receive broadcast and this is a broadcast packet. + // + return TRUE; + } + + if (IP4_IS_MULTICAST (NTOHL (Destination)) && + NetMapFindKey (&Instance->McastIps, (VOID *) (UINTN) Destination) != NULL + ) { + // + // It's a multicast packet and the multicast address is accepted by this instance. + // + return TRUE; + } + + return FALSE; +} + + +/** + This function removes the Wrap specified by Context and release relevant resources. + + @param[in] Event The Event this notify function registered to. + @param[in] Context Pointer to the context data. + +**/ +VOID +EFIAPI +Udp4RecycleRxDataWrap ( + IN EFI_EVENT Event, + IN VOID *Context + ) +{ + UDP4_RXDATA_WRAP *Wrap; + + Wrap = (UDP4_RXDATA_WRAP *) Context; + + // + // Remove the Wrap from the list it belongs to. + // + RemoveEntryList (&Wrap->Link); + + // + // Free the Packet associated with this Wrap. + // + NetbufFree (Wrap->Packet); + + // + // Close the event. + // + gBS->CloseEvent (Wrap->RxData.RecycleSignal); + + FreePool (Wrap); +} + + +/** + This function wraps the Packet and the RxData. + + @param[in] Instance Pointer to the instance context data. + @param[in] Packet Pointer to the buffer containing the received + datagram. + @param[in] RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this + datagram. + + @return Pointer to the structure wrapping the RxData and the Packet. + +**/ +UDP4_RXDATA_WRAP * +Udp4WrapRxData ( + IN UDP4_INSTANCE_DATA *Instance, + IN NET_BUF *Packet, + IN EFI_UDP4_RECEIVE_DATA *RxData + ) +{ + EFI_STATUS Status; + UDP4_RXDATA_WRAP *Wrap; + + // + // Allocate buffer for the Wrap. + // + Wrap = AllocatePool (sizeof (UDP4_RXDATA_WRAP) + + (Packet->BlockOpNum - 1) * sizeof (EFI_UDP4_FRAGMENT_DATA)); + if (Wrap == NULL) { + return NULL; + } + + InitializeListHead (&Wrap->Link); + + CopyMem (&Wrap->RxData, RxData, sizeof (Wrap->RxData)); + + // + // Create the Recycle event. + // + Status = gBS->CreateEvent ( + EVT_NOTIFY_SIGNAL, + TPL_NOTIFY, + Udp4RecycleRxDataWrap, + Wrap, + &Wrap->RxData.RecycleSignal + ); + if (EFI_ERROR (Status)) { + FreePool (Wrap); + return NULL; + } + + Wrap->Packet = Packet; + Wrap->TimeoutTick = Instance->ConfigData.ReceiveTimeout; + + return Wrap; +} + + +/** + This function enqueues the received datagram into the instances' receiving queues. + + @param[in] Udp4Service Pointer to the udp service context data. + @param[in] Packet Pointer to the buffer containing the received + datagram. + @param[in] RxData Pointer to the EFI_UDP4_RECEIVE_DATA of this + datagram. + + @return The times this datagram is enqueued. + +**/ +UINTN +Udp4EnqueueDgram ( + IN UDP4_SERVICE_DATA *Udp4Service, + IN NET_BUF *Packet, + IN EFI_UDP4_RECEIVE_DATA *RxData + ) +{ + LIST_ENTRY *Entry; + UDP4_INSTANCE_DATA *Instance; + UDP4_RXDATA_WRAP *Wrap; + UINTN Enqueued; + + Enqueued = 0; + + NET_LIST_FOR_EACH (Entry, &Udp4Service->ChildrenList) { + // + // Iterate the instances. + // + Instance = NET_LIST_USER_STRUCT (Entry, UDP4_INSTANCE_DATA, Link); + + if (!Instance->Configured) { + continue; + } + + if (Udp4MatchDgram (Instance, &RxData->UdpSession)) { + // + // Wrap the RxData and put this Wrap into the instances RcvdDgramQue. + // + Wrap = Udp4WrapRxData (Instance, Packet, RxData); + if (Wrap == NULL) { + continue; + } + + NET_GET_REF (Packet); + + InsertTailList (&Instance->RcvdDgramQue, &Wrap->Link); + + Enqueued++; + } + } + + return Enqueued; +} + + +/** + This function delivers the received datagrams for the specified instance. + + @param[in] Instance Pointer to the instance context data. + +**/ +VOID +Udp4InstanceDeliverDgram ( + IN UDP4_INSTANCE_DATA *Instance + ) +{ + UDP4_RXDATA_WRAP *Wrap; + EFI_UDP4_COMPLETION_TOKEN *Token; + NET_BUF *Dup; + EFI_UDP4_RECEIVE_DATA *RxData; + EFI_TPL OldTpl; + + if (!IsListEmpty (&Instance->RcvdDgramQue) && + !NetMapIsEmpty (&Instance->RxTokens)) { + + Wrap = NET_LIST_HEAD (&Instance->RcvdDgramQue, UDP4_RXDATA_WRAP, Link); + + if (NET_BUF_SHARED (Wrap->Packet)) { + // + // Duplicate the Packet if it is shared between instances. + // + Dup = NetbufDuplicate (Wrap->Packet, NULL, 0); + if (Dup == NULL) { + return; + } + + NetbufFree (Wrap->Packet); + + Wrap->Packet = Dup; + } + + NetListRemoveHead (&Instance->RcvdDgramQue); + + Token = (EFI_UDP4_COMPLETION_TOKEN *) NetMapRemoveHead (&Instance->RxTokens, NULL); + + // + // Build the FragmentTable and set the FragmentCount in RxData. + // + RxData = &Wrap->RxData; + RxData->FragmentCount = Wrap->Packet->BlockOpNum; + + NetbufBuildExt ( + Wrap->Packet, + (NET_FRAGMENT *) RxData->FragmentTable, + &RxData->FragmentCount + ); + + Token->Status = EFI_SUCCESS; + Token->Packet.RxData = &Wrap->RxData; + + OldTpl = gBS->RaiseTPL (TPL_NOTIFY); + InsertTailList (&Instance->DeliveredDgramQue, &Wrap->Link); + gBS->RestoreTPL (OldTpl); + + gBS->SignalEvent (Token->Event); + } +} + + +/** + This function delivers the datagrams enqueued in the instances. + + @param[in] Udp4Service Pointer to the udp service context data. + +**/ +VOID +Udp4DeliverDgram ( + IN UDP4_SERVICE_DATA *Udp4Service + ) +{ + LIST_ENTRY *Entry; + UDP4_INSTANCE_DATA *Instance; + + NET_LIST_FOR_EACH (Entry, &Udp4Service->ChildrenList) { + // + // Iterate the instances. + // + Instance = NET_LIST_USER_STRUCT (Entry, UDP4_INSTANCE_DATA, Link); + + if (!Instance->Configured) { + continue; + } + + // + // Deliver the datagrams of this instance. + // + Udp4InstanceDeliverDgram (Instance); + } +} + + +/** + This function demultiplexes the received udp datagram to the appropriate instances. + + @param[in] Udp4Service Pointer to the udp service context data. + @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA abstracted from + the received datagram. + @param[in] Packet Pointer to the buffer containing the received udp + datagram. + +**/ +VOID +Udp4Demultiplex ( + IN UDP4_SERVICE_DATA *Udp4Service, + IN EFI_NET_SESSION_DATA *NetSession, + IN NET_BUF *Packet + ) +{ + EFI_UDP_HEADER *Udp4Header; + UINT16 HeadSum; + EFI_UDP4_RECEIVE_DATA RxData; + EFI_UDP4_SESSION_DATA *Udp4Session; + UINTN Enqueued; + + if (Packet->TotalSize < sizeof (EFI_UDP_HEADER)) { + NetbufFree (Packet); + return; + } + + // + // Get the datagram header from the packet buffer. + // + Udp4Header = (EFI_UDP_HEADER *) NetbufGetByte (Packet, 0, NULL); + ASSERT (Udp4Header != NULL); + + if (Udp4Header->Checksum != 0) { + // + // check the checksum. + // + HeadSum = NetPseudoHeadChecksum ( + NetSession->Source.Addr[0], + NetSession->Dest.Addr[0], + EFI_IP_PROTO_UDP, + 0 + ); + + if (Udp4Checksum (Packet, HeadSum) != 0) { + // + // Wrong checksum. + // + NetbufFree (Packet); + return; + } + } + + Udp4Session = &RxData.UdpSession; + Udp4Session->SourcePort = NTOHS (Udp4Header->SrcPort); + Udp4Session->DestinationPort = NTOHS (Udp4Header->DstPort); + + CopyMem (&Udp4Session->SourceAddress, &NetSession->Source, sizeof (EFI_IPv4_ADDRESS)); + CopyMem (&Udp4Session->DestinationAddress, &NetSession->Dest, sizeof (EFI_IPv4_ADDRESS)); + + // + // Trim the UDP header. + // + NetbufTrim (Packet, UDP4_HEADER_SIZE, TRUE); + + RxData.DataLength = (UINT32) Packet->TotalSize; + + // + // Try to enqueue this datagram into the instances. + // + Enqueued = Udp4EnqueueDgram (Udp4Service, Packet, &RxData); + + if (Enqueued == 0) { + // + // Send the port unreachable ICMP packet before we free this NET_BUF + // + Udp4SendPortUnreach (Udp4Service->IpIo, NetSession, Udp4Header); + } + + // + // Try to free the packet before deliver it. + // + NetbufFree (Packet); + + if (Enqueued > 0) { + // + // Deliver the datagram. + // + Udp4DeliverDgram (Udp4Service); + } +} + + +/** + This function builds and sends out a icmp port unreachable message. + + @param[in] IpIo Pointer to the IP_IO instance. + @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA of the packet + causes this icmp error message. + @param[in] Udp4Header Pointer to the udp header of the datagram causes + this icmp error message. + +**/ +VOID +Udp4SendPortUnreach ( + IN IP_IO *IpIo, + IN EFI_NET_SESSION_DATA *NetSession, + IN VOID *Udp4Header + ) +{ + NET_BUF *Packet; + UINT32 Len; + IP4_ICMP_ERROR_HEAD *IcmpErrHdr; + EFI_IP4_HEADER *IpHdr; + UINT8 *Ptr; + IP_IO_OVERRIDE Override; + IP_IO_IP_INFO *IpSender; + + IpSender = IpIoFindSender (&IpIo, NetSession->IpVersion, &NetSession->Dest); + if (IpSender == NULL) { + // + // No appropriate sender, since we cannot send out the ICMP message through + // the default zero station address IP instance, abort. + // + return; + } + + IpHdr = NetSession->IpHdr.Ip4Hdr; + + // + // Calculate the required length of the icmp error message. + // + Len = sizeof (IP4_ICMP_ERROR_HEAD) + (EFI_IP4_HEADER_LEN (IpHdr) - + sizeof (IP4_HEAD)) + ICMP_ERROR_PACKET_LENGTH; + + // + // Allocate buffer for the icmp error message. + // + Packet = NetbufAlloc (Len); + if (Packet == NULL) { + return; + } + + // + // Allocate space for the IP4_ICMP_ERROR_HEAD. + // + IcmpErrHdr = (IP4_ICMP_ERROR_HEAD *) NetbufAllocSpace (Packet, Len, FALSE); + ASSERT (IcmpErrHdr != NULL); + + // + // Set the required fields for the icmp port unreachable message. + // + IcmpErrHdr->Head.Type = ICMP_TYPE_UNREACH; + IcmpErrHdr->Head.Code = ICMP_CODE_UNREACH_PORT; + IcmpErrHdr->Head.Checksum = 0; + IcmpErrHdr->Fourth = 0; + + // + // Copy the IP header of the datagram tragged the error. + // + CopyMem (&IcmpErrHdr->IpHead, IpHdr, EFI_IP4_HEADER_LEN (IpHdr)); + + // + // Copy the UDP header. + // + Ptr = (UINT8 *) &IcmpErrHdr->IpHead + EFI_IP4_HEADER_LEN (IpHdr); + CopyMem (Ptr, Udp4Header, ICMP_ERROR_PACKET_LENGTH); + + // + // Calculate the checksum. + // + IcmpErrHdr->Head.Checksum = (UINT16) ~(NetbufChecksum (Packet)); + + // + // Fill the override data. + // + Override.Ip4OverrideData.DoNotFragment = FALSE; + Override.Ip4OverrideData.TypeOfService = 0; + Override.Ip4OverrideData.TimeToLive = 255; + Override.Ip4OverrideData.Protocol = EFI_IP_PROTO_ICMP; + + CopyMem (&Override.Ip4OverrideData.SourceAddress, &NetSession->Dest, sizeof (EFI_IPv4_ADDRESS)); + ZeroMem (&Override.Ip4OverrideData.GatewayAddress, sizeof (EFI_IPv4_ADDRESS)); + + // + // Send out this icmp packet. + // + IpIoSend (IpIo, Packet, IpSender, NULL, NULL, &NetSession->Source, &Override); + + NetbufFree (Packet); +} + + +/** + This function handles the received Icmp Error message and demultiplexes it to the + instance. + + @param[in] Udp4Service Pointer to the udp service context data. + @param[in] IcmpError The icmp error code. + @param[in] NetSession Pointer to the EFI_NET_SESSION_DATA abstracted + from the received Icmp Error packet. + @param[in] Packet Pointer to the Icmp Error packet. + +**/ +VOID +Udp4IcmpHandler ( + IN UDP4_SERVICE_DATA *Udp4Service, + IN UINT8 IcmpError, + IN EFI_NET_SESSION_DATA *NetSession, + IN NET_BUF *Packet + ) +{ + EFI_UDP_HEADER *Udp4Header; + EFI_UDP4_SESSION_DATA Udp4Session; + LIST_ENTRY *Entry; + UDP4_INSTANCE_DATA *Instance; + + if (Packet->TotalSize < sizeof (EFI_UDP_HEADER)) { + NetbufFree (Packet); + return; + } + + Udp4Header = (EFI_UDP_HEADER *) NetbufGetByte (Packet, 0, NULL); + ASSERT (Udp4Header != NULL); + + CopyMem (&Udp4Session.SourceAddress, &NetSession->Source, sizeof (EFI_IPv4_ADDRESS)); + CopyMem (&Udp4Session.DestinationAddress, &NetSession->Dest, sizeof (EFI_IPv4_ADDRESS)); + + Udp4Session.SourcePort = NTOHS (Udp4Header->DstPort); + Udp4Session.DestinationPort = NTOHS (Udp4Header->SrcPort); + + NET_LIST_FOR_EACH (Entry, &Udp4Service->ChildrenList) { + // + // Iterate all the instances. + // + Instance = NET_LIST_USER_STRUCT (Entry, UDP4_INSTANCE_DATA, Link); + + if (!Instance->Configured) { + continue; + } + + if (Udp4MatchDgram (Instance, &Udp4Session)) { + // + // Translate the Icmp Error code according to the udp spec. + // + Instance->IcmpError = IpIoGetIcmpErrStatus (IcmpError, IP_VERSION_4, NULL, NULL); + + if (IcmpError > ICMP_ERR_UNREACH_PORT) { + Instance->IcmpError = EFI_ICMP_ERROR; + } + + // + // Notify the instance with the received Icmp Error. + // + Udp4ReportIcmpError (Instance); + + break; + } + } + + NetbufFree (Packet); +} + + +/** + This function reports the received ICMP error. + + @param[in] Instance Pointer to the udp instance context data. + +**/ +VOID +Udp4ReportIcmpError ( + IN UDP4_INSTANCE_DATA *Instance + ) +{ + EFI_UDP4_COMPLETION_TOKEN *Token; + + if (NetMapIsEmpty (&Instance->RxTokens)) { + // + // There are no receive tokens to deliver the ICMP error. + // + return; + } + + if (EFI_ERROR (Instance->IcmpError)) { + // + // Try to get a RxToken from the RxTokens map. + // + Token = (EFI_UDP4_COMPLETION_TOKEN *) NetMapRemoveHead (&Instance->RxTokens, NULL); + + if (Token != NULL) { + // + // Report the error through the Token. + // + Token->Status = Instance->IcmpError; + gBS->SignalEvent (Token->Event); + + // + // Clear the IcmpError. + // + Instance->IcmpError = EFI_SUCCESS; + } + } +} + + +/** + This function is a dummy ext-free function for the NET_BUF created for the output + udp datagram. + + @param[in] Context Pointer to the context data. + +**/ +VOID +EFIAPI +Udp4NetVectorExtFree ( + VOID *Context + ) +{ +} + diff --git a/NetworkPkg/Udp4Dxe/Udp4Impl.h b/NetworkPkg/Udp4Dxe/Udp4Impl.h new file mode 100644 index 0000000000..a5dd1ecabe --- /dev/null +++ b/NetworkPkg/Udp4Dxe/Udp4Impl.h @@ -0,0 +1,689 @@ +/** @file + EFI UDPv4 protocol implementation. + +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef _UDP4_IMPL_H_ +#define _UDP4_IMPL_H_ + +#include + +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "Udp4Driver.h" + + +extern EFI_COMPONENT_NAME_PROTOCOL gUdp4ComponentName; +extern EFI_COMPONENT_NAME2_PROTOCOL gUdp4ComponentName2; +extern EFI_UNICODE_STRING_TABLE *gUdpControllerNameTable; +extern EFI_SERVICE_BINDING_PROTOCOL mUdp4ServiceBinding; +extern EFI_UDP4_PROTOCOL mUdp4Protocol; +extern UINT16 mUdp4RandomPort; + +#define ICMP_ERROR_PACKET_LENGTH 8 + +#define UDP4_TIMEOUT_INTERVAL (50 * TICKS_PER_MS) // 50 milliseconds + +#define UDP4_HEADER_SIZE sizeof (EFI_UDP_HEADER) +#define UDP4_MAX_DATA_SIZE 65507 + +#define UDP4_PORT_KNOWN 1024 + +#define UDP4_SERVICE_DATA_SIGNATURE SIGNATURE_32('U', 'd', 'p', '4') + +#define UDP4_SERVICE_DATA_FROM_THIS(a) \ + CR ( \ + (a), \ + UDP4_SERVICE_DATA, \ + ServiceBinding, \ + UDP4_SERVICE_DATA_SIGNATURE \ + ) + +typedef struct _UDP4_SERVICE_DATA_ { + UINT32 Signature; + EFI_SERVICE_BINDING_PROTOCOL ServiceBinding; + EFI_HANDLE ImageHandle; + EFI_HANDLE ControllerHandle; + LIST_ENTRY ChildrenList; + UINTN ChildrenNumber; + IP_IO *IpIo; + + EFI_EVENT TimeoutEvent; +} UDP4_SERVICE_DATA; + +#define UDP4_INSTANCE_DATA_SIGNATURE SIGNATURE_32('U', 'd', 'p', 'I') + +#define UDP4_INSTANCE_DATA_FROM_THIS(a) \ + CR ( \ + (a), \ + UDP4_INSTANCE_DATA, \ + Udp4Proto, \ + UDP4_INSTANCE_DATA_SIGNATURE \ + ) + +typedef struct _UDP4_INSTANCE_DATA_ { + UINT32 Signature; + LIST_ENTRY Link; + + UDP4_SERVICE_DATA *Udp4Service; + EFI_UDP4_PROTOCOL Udp4Proto; + EFI_UDP4_CONFIG_DATA ConfigData; + EFI_HANDLE ChildHandle; + BOOLEAN Configured; + BOOLEAN IsNoMapping; + + NET_MAP TxTokens; + NET_MAP RxTokens; + + NET_MAP McastIps; + + LIST_ENTRY RcvdDgramQue; + LIST_ENTRY DeliveredDgramQue; + + UINT16 HeadSum; + + EFI_STATUS IcmpError; + + IP_IO_IP_INFO *IpInfo; + + BOOLEAN InDestroy; +} UDP4_INSTANCE_DATA; + +typedef struct _UDP4_RXDATA_WRAP_ { + LIST_ENTRY Link; + NET_BUF *Packet; + UINT32 TimeoutTick; + EFI_UDP4_RECEIVE_DATA RxData; +} UDP4_RXDATA_WRAP; + +typedef struct { + EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; + UINTN NumberOfChildren; + EFI_HANDLE *ChildHandleBuffer; +} UDP4_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT; + +/** + Reads the current operational settings. + + The GetModeData() function copies the current operational settings of this EFI + UDPv4 Protocol instance into user-supplied buffers. This function is used + optionally to retrieve the operational mode data of underlying networks or + drivers. + + @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. + @param[out] Udp4ConfigData Pointer to the buffer to receive the current configuration data. + @param[out] Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure. + @param[out] MnpConfigData Pointer to the managed network configuration data structure. + @param[out] SnpModeData Pointer to the simple network mode data structure. + + @retval EFI_SUCCESS The mode data was read. + @retval EFI_NOT_STARTED When Udp4ConfigData is queried, no configuration data is + available because this instance has not been started. + @retval EFI_INVALID_PARAMETER This is NULL. + +**/ +EFI_STATUS +EFIAPI +Udp4GetModeData ( + IN EFI_UDP4_PROTOCOL *This, + OUT EFI_UDP4_CONFIG_DATA *Udp4ConfigData OPTIONAL, + OUT EFI_IP4_MODE_DATA *Ip4ModeData OPTIONAL, + OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL, + OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL + ); + +/** + Initializes, changes, or resets the operational parameters for this instance of the EFI UDPv4 + Protocol. + + The Configure() function is used to do the following: + * Initialize and start this instance of the EFI UDPv4 Protocol. + * Change the filtering rules and operational parameters. + * Reset this instance of the EFI UDPv4 Protocol. + Until these parameters are initialized, no network traffic can be sent or + received by this instance. This instance can be also reset by calling Configure() + with UdpConfigData set to NULL. Once reset, the receiving queue and transmitting + queue are flushed and no traffic is allowed through this instance. + With different parameters in UdpConfigData, Configure() can be used to bind + this instance to specified port. + + @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. + @param[in] UdpConfigData Pointer to the buffer to receive the current configuration data. + + @retval EFI_SUCCESS The configuration settings were set, changed, or reset successfully. + @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, + RARP, etc.) is not finished yet. + @retval EFI_INVALID_PARAMETER One or more following conditions are TRUE: + @retval EFI_ALREADY_STARTED The EFI UDPv4 Protocol instance is already started/configured + and must be stopped/reset before it can be reconfigured. + @retval EFI_ACCESS_DENIED UdpConfigData. AllowDuplicatePort is FALSE + and UdpConfigData.StationPort is already used by + other instance. + @retval EFI_OUT_OF_RESOURCES The EFI UDPv4 Protocol driver cannot allocate memory for this + EFI UDPv4 Protocol instance. + @retval EFI_DEVICE_ERROR An unexpected network or system error occurred and this instance + was not opened. + +**/ +EFI_STATUS +EFIAPI +Udp4Configure ( + IN EFI_UDP4_PROTOCOL *This, + IN EFI_UDP4_CONFIG_DATA *UdpConfigData OPTIONAL + ); + +/** + Joins and leaves multicast groups. + + The Groups() function is used to enable and disable the multicast group + filtering. If the JoinFlag is FALSE and the MulticastAddress is NULL, then all + currently joined groups are left. + + @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. + @param[in] JoinFlag Set to TRUE to join a multicast group. Set to FALSE to leave one + or all multicast groups. + @param[in] MulticastAddress Pointer to multicast group address to join or leave. + + @retval EFI_SUCCESS The operation completed successfully. + @retval EFI_NOT_STARTED The EFI UDPv4 Protocol instance has not been started. + @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, + RARP, etc.) is not finished yet. + @retval EFI_OUT_OF_RESOURCES Could not allocate resources to join the group. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + - This is NULL. + - JoinFlag is TRUE and MulticastAddress is NULL. + - JoinFlag is TRUE and *MulticastAddress is not + a valid multicast address. + @retval EFI_ALREADY_STARTED The group address is already in the group table (when + JoinFlag is TRUE). + @retval EFI_NOT_FOUND The group address is not in the group table (when JoinFlag is + FALSE). + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. + +**/ +EFI_STATUS +EFIAPI +Udp4Groups ( + IN EFI_UDP4_PROTOCOL *This, + IN BOOLEAN JoinFlag, + IN EFI_IPv4_ADDRESS *MulticastAddress OPTIONAL + ); + +/** + Adds and deletes routing table entries. + + The Routes() function adds a route to or deletes a route from the routing table. + Routes are determined by comparing the SubnetAddress with the destination IP + address and arithmetically AND-ing it with the SubnetMask. The gateway address + must be on the same subnet as the configured station address. + The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0. + The default route matches all destination IP addresses that do not match any + other routes. + A zero GatewayAddress is a nonroute. Packets are sent to the destination IP + address if it can be found in the Address Resolution Protocol (ARP) cache or + on the local subnet. One automatic nonroute entry will be inserted into the + routing table for outgoing packets that are addressed to a local subnet + (gateway address of 0.0.0.0). + Each instance of the EFI UDPv4 Protocol has its own independent routing table. + Instances of the EFI UDPv4 Protocol that use the default IP address will also + have copies of the routing table provided by the EFI_IP4_CONFIG_PROTOCOL. These + copies will be updated automatically whenever the IP driver reconfigures its + instances; as a result, the previous modification to these copies will be lost. + + @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. + @param[in] DeleteRoute Set to TRUE to delete this route from the routing table. + Set to FALSE to add this route to the routing table. + @param[in] SubnetAddress The destination network address that needs to be routed. + @param[in] SubnetMask The subnet mask of SubnetAddress. + @param[in] GatewayAddress The gateway IP address for this route. + + @retval EFI_SUCCESS The operation completed successfully. + @retval EFI_NOT_STARTED The EFI UDPv4 Protocol instance has not been started. + @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, + - RARP, etc.) is not finished yet. + @retval EFI_INVALID_PARAMETER One or more parameters are invalid. + @retval EFI_OUT_OF_RESOURCES Could not add the entry to the routing table. + @retval EFI_NOT_FOUND This route is not in the routing table. + @retval EFI_ACCESS_DENIED The route is already defined in the routing table. + +**/ +EFI_STATUS +EFIAPI +Udp4Routes ( + IN EFI_UDP4_PROTOCOL *This, + IN BOOLEAN DeleteRoute, + IN EFI_IPv4_ADDRESS *SubnetAddress, + IN EFI_IPv4_ADDRESS *SubnetMask, + IN EFI_IPv4_ADDRESS *GatewayAddress + ); + +/** + Queues outgoing data packets into the transmit queue. + + The Transmit() function places a sending request to this instance of the EFI + UDPv4 Protocol, alongside the transmit data that was filled by the user. Whenever + the packet in the token is sent out or some errors occur, the Token.Event will + be signaled and Token.Status is updated. Providing a proper notification function + and context for the event will enable the user to receive the notification and + transmitting status. + + @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. + @param[in] Token Pointer to the completion token that will be placed into the + transmit queue. + + @retval EFI_SUCCESS The data has been queued for transmission. + @retval EFI_NOT_STARTED This EFI UDPv4 Protocol instance has not been started. + @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, + RARP, etc.) is not finished yet. + @retval EFI_INVALID_PARAMETER One or more parameters are invalid. + @retval EFI_ACCESS_DENIED The transmit completion token with the same + Token.Event was already in the transmit queue. + @retval EFI_NOT_READY The completion token could not be queued because the + transmit queue is full. + @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data. + @retval EFI_NOT_FOUND There is no route to the destination network or address. + @retval EFI_BAD_BUFFER_SIZE The data length is greater than the maximum UDP packet + size. Or the length of the IP header + UDP header + data + length is greater than MTU if DoNotFragment is TRUE. + +**/ +EFI_STATUS +EFIAPI +Udp4Transmit ( + IN EFI_UDP4_PROTOCOL *This, + IN EFI_UDP4_COMPLETION_TOKEN *Token + ); + +/** + Places an asynchronous receive request into the receiving queue. + + The Receive() function places a completion token into the receive packet queue. + This function is always asynchronous. + The caller must fill in the Token.Event field in the completion token, and this + field cannot be NULL. When the receive operation completes, the EFI UDPv4 Protocol + driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event + is signaled. Providing a proper notification function and context for the event + will enable the user to receive the notification and receiving status. That + notification function is guaranteed to not be re-entered. + + @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. + @param[in] Token Pointer to a token that is associated with + the receive data descriptor. + + @retval EFI_SUCCESS The receive completion token was cached. + @retval EFI_NOT_STARTED This EFI UDPv4 Protocol instance has not been started. + @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, RARP, etc.) + is not finished yet. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system + resources (usually memory). + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. + @retval EFI_ACCESS_DENIED A receive completion token with the same Token.Event was already in + the receive queue. + @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full. + +**/ +EFI_STATUS +EFIAPI +Udp4Receive ( + IN EFI_UDP4_PROTOCOL *This, + IN EFI_UDP4_COMPLETION_TOKEN *Token + ); + +/** + Aborts an asynchronous transmit or receive request. + + The Cancel() function is used to abort a pending transmit or receive request. + If the token is in the transmit or receive request queues, after calling this + function, Token.Status will be set to EFI_ABORTED and then Token.Event will be + signaled. If the token is not in one of the queues, which usually means that + the asynchronous operation has completed, this function will not signal the + token and EFI_NOT_FOUND is returned. + + @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. + @param[in] Token Pointer to a token that has been issued by + EFI_UDP4_PROTOCOL.Transmit() or + EFI_UDP4_PROTOCOL.Receive().If NULL, all pending + tokens are aborted. + + @retval EFI_SUCCESS The asynchronous I/O request was aborted and Token.Event + was signaled. When Token is NULL, all pending requests are + aborted and their events are signaled. + @retval EFI_INVALID_PARAMETER This is NULL. + @retval EFI_NOT_STARTED This instance has not been started. + @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, + RARP, etc.) is not finished yet. + @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O request was + not found in the transmit or receive queue. It has either completed + or was not issued by Transmit() and Receive(). + +**/ +EFI_STATUS +EFIAPI +Udp4Cancel ( + IN EFI_UDP4_PROTOCOL *This, + IN EFI_UDP4_COMPLETION_TOKEN *Token OPTIONAL + ); + +/** + Polls for incoming data packets and processes outgoing data packets. + + The Poll() function can be used by network drivers and applications to increase + the rate that data packets are moved between the communications device and the + transmit and receive queues. + In some systems, the periodic timer event in the managed network driver may not + poll the underlying communications device fast enough to transmit and/or receive + all data packets without missing incoming packets or dropping outgoing packets. + Drivers and applications that are experiencing packet loss should try calling + the Poll() function more often. + + @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. + + @retval EFI_SUCCESS Incoming or outgoing data was processed. + @retval EFI_INVALID_PARAMETER This is NULL. + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. + @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue. + +**/ +EFI_STATUS +EFIAPI +Udp4Poll ( + IN EFI_UDP4_PROTOCOL *This + ); + +/** + Create the Udp service context data. + + @param[in, out] Udp4Service Pointer to the UDP4_SERVICE_DATA. + @param[in] ImageHandle The image handle of this udp4 driver. + @param[in] ControllerHandle The controller handle this udp4 driver binds on. + + @retval EFI_SUCCESS The udp4 service context data is created and + initialized. + @retval EFI_OUT_OF_RESOURCES Cannot allocate memory. + @retval other Other error occurs. + +**/ +EFI_STATUS +Udp4CreateService ( + IN OUT UDP4_SERVICE_DATA *Udp4Service, + IN EFI_HANDLE ImageHandle, + IN EFI_HANDLE ControllerHandle + ); + +/** + Clean the Udp service context data. + + @param[in] Udp4Service Pointer to the UDP4_SERVICE_DATA. + +**/ +VOID +Udp4CleanService ( + IN UDP4_SERVICE_DATA *Udp4Service + ); + +/** + This function intializes the new created udp instance. + + @param[in] Udp4Service Pointer to the UDP4_SERVICE_DATA. + @param[in, out] Instance Pointer to the un-initialized UDP4_INSTANCE_DATA. + +**/ +VOID +Udp4InitInstance ( + IN UDP4_SERVICE_DATA *Udp4Service, + IN OUT UDP4_INSTANCE_DATA *Instance + ); + +/** + This function cleans the udp instance. + + @param[in] Instance Pointer to the UDP4_INSTANCE_DATA to clean. + +**/ +VOID +Udp4CleanInstance ( + IN UDP4_INSTANCE_DATA *Instance + ); + +/** + This function tries to bind the udp instance according to the configured port + allocation strategy. + + @param[in] InstanceList Pointer to the head of the list linking the udp + instances. + @param[in, out] ConfigData Pointer to the ConfigData of the instance to be + bound. ConfigData->StationPort will be assigned + with an available port value on success. + + @retval EFI_SUCCESS The bound operation is completed successfully. + @retval EFI_ACCESS_DENIED The specified by the ConfigData is + already used by other instance. + @retval EFI_OUT_OF_RESOURCES No available port resources. + +**/ +EFI_STATUS +Udp4Bind ( + IN LIST_ENTRY *InstanceList, + IN OUT EFI_UDP4_CONFIG_DATA *ConfigData + ); + +/** + This function is used to check whether the NewConfigData has any un-reconfigurable + parameters changed compared to the OldConfigData. + + @param[in] OldConfigData Pointer to the current ConfigData the udp instance + uses. + @param[in] NewConfigData Pointer to the new ConfigData. + + @retval TRUE The instance is reconfigurable. + @retval FALSE Otherwise. + +**/ +BOOLEAN +Udp4IsReconfigurable ( + IN EFI_UDP4_CONFIG_DATA *OldConfigData, + IN EFI_UDP4_CONFIG_DATA *NewConfigData + ); + +/** + This function builds the Ip4 configdata from the Udp4ConfigData. + + @param[in] Udp4ConfigData Pointer to the EFI_UDP4_CONFIG_DATA. + @param[in, out] Ip4ConfigData Pointer to the EFI_IP4_CONFIG_DATA. + +**/ +VOID +Udp4BuildIp4ConfigData ( + IN EFI_UDP4_CONFIG_DATA *Udp4ConfigData, + IN OUT EFI_IP4_CONFIG_DATA *Ip4ConfigData + ); + +/** + This function validates the TxToken, it returns the error code according to the spec. + + @param[in] Instance Pointer to the udp instance context data. + @param[in] TxToken Pointer to the token to be checked. + + @retval EFI_SUCCESS The TxToken is valid. + @retval EFI_INVALID_PARAMETER One or more of the following are TRUE: This is + NULL. Token is NULL. Token.Event is NULL. + Token.Packet.TxData is NULL. + Token.Packet.TxData.FragmentCount is zero. + Token.Packet.TxData.DataLength is not equal to the + sum of fragment lengths. One or more of the + Token.Packet.TxData.FragmentTable[]. + FragmentLength fields is zero. One or more of the + Token.Packet.TxData.FragmentTable[]. + FragmentBuffer fields is NULL. + Token.Packet.TxData. GatewayAddress is not a + unicast IPv4 address if it is not NULL. One or + more IPv4 addresses in Token.Packet.TxData. + UdpSessionData are not valid unicast IPv4 + addresses if the UdpSessionData is not NULL. + @retval EFI_BAD_BUFFER_SIZE The data length is greater than the maximum UDP + packet size. + +**/ +EFI_STATUS +Udp4ValidateTxToken ( + IN UDP4_INSTANCE_DATA *Instance, + IN EFI_UDP4_COMPLETION_TOKEN *TxToken + ); + +/** + This function checks whether the specified Token duplicates with the one in the Map. + + @param[in] Map Pointer to the NET_MAP. + @param[in] Item Pointer to the NET_MAP_ITEM contain the pointer to + the Token. + @param[in] Context Pointer to the Token to be checked. + + @retval EFI_SUCCESS The Token specified by Context differs from the + one in the Item. + @retval EFI_ACCESS_DENIED The Token duplicates with the one in the Item. + +**/ +EFI_STATUS +EFIAPI +Udp4TokenExist ( + IN NET_MAP *Map, + IN NET_MAP_ITEM *Item, + IN VOID *Context + ); + +/** + This function calculates the checksum for the Packet, utilizing the pre-calculated + pseudo HeadSum to reduce some overhead. + + @param[in] Packet Pointer to the NET_BUF contains the udp datagram. + @param[in] HeadSum Checksum of the pseudo header execpt the length + field. + + @retval The 16-bit checksum of this udp datagram. + +**/ +UINT16 +Udp4Checksum ( + IN NET_BUF *Packet, + IN UINT16 HeadSum + ); + +/** + This function removes the specified Token from the TokenMap. + + @param[in, out] TokenMap Pointer to the NET_MAP containing the tokens. + @param[in] Token Pointer to the Token to be removed. + + @retval EFI_SUCCESS The specified Token is removed from the TokenMap. + @retval EFI_NOT_FOUND The specified Token is not found in the TokenMap. + +**/ +EFI_STATUS +Udp4RemoveToken ( + IN OUT NET_MAP *TokenMap, + IN EFI_UDP4_COMPLETION_TOKEN *Token + ); + +/** + This function removes the multicast group specified by Arg from the Map. + + @param[in, out] Map Pointer to the NET_MAP. + @param[in] Item Pointer to the NET_MAP_ITEM. + @param[in] Arg Pointer to the Arg, it's the pointer to a + multicast IPv4 Address. + + @retval EFI_SUCCESS The multicast address is removed. + @retval EFI_ABORTED The specified multicast address is removed and the + Arg is not NULL. + +**/ +EFI_STATUS +EFIAPI +Udp4LeaveGroup ( + IN OUT NET_MAP *Map, + IN NET_MAP_ITEM *Item, + IN VOID *Arg OPTIONAL + ); + +/** + This function removes all the Wrap datas in the RcvdDgramQue. + + @param[in] Instance Pointer to the udp instance context data. + +**/ +VOID +Udp4FlushRcvdDgram ( + IN UDP4_INSTANCE_DATA *Instance + ); + +/** + Cancel Udp4 tokens from the Udp4 instance. + + @param[in] Instance Pointer to the udp instance context data. + @param[in] Token Pointer to the token to be canceled, if NULL, all + tokens in this instance will be cancelled. + + @retval EFI_SUCCESS The Token is cancelled. + @retval EFI_NOT_FOUND The Token is not found. + +**/ +EFI_STATUS +Udp4InstanceCancelToken ( + IN UDP4_INSTANCE_DATA *Instance, + IN EFI_UDP4_COMPLETION_TOKEN *Token OPTIONAL + ); + +/** + This function delivers the received datagrams for the specified instance. + + @param[in] Instance Pointer to the instance context data. + +**/ +VOID +Udp4InstanceDeliverDgram ( + IN UDP4_INSTANCE_DATA *Instance + ); + +/** + This function reports the received ICMP error. + + @param[in] Instance Pointer to the udp instance context data. + +**/ +VOID +Udp4ReportIcmpError ( + IN UDP4_INSTANCE_DATA *Instance + ); + +/** + This function is a dummy ext-free function for the NET_BUF created for the output + udp datagram. + + @param[in] Context Pointer to the context data. + +**/ +VOID +EFIAPI +Udp4NetVectorExtFree ( + VOID *Context + ); + +#endif diff --git a/NetworkPkg/Udp4Dxe/Udp4Main.c b/NetworkPkg/Udp4Dxe/Udp4Main.c new file mode 100644 index 0000000000..aa1956cd4b --- /dev/null +++ b/NetworkPkg/Udp4Dxe/Udp4Main.c @@ -0,0 +1,902 @@ +/** @file + +(C) Copyright 2014 Hewlett-Packard Development Company, L.P.
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "Udp4Impl.h" + +EFI_UDP4_PROTOCOL mUdp4Protocol = { + Udp4GetModeData, + Udp4Configure, + Udp4Groups, + Udp4Routes, + Udp4Transmit, + Udp4Receive, + Udp4Cancel, + Udp4Poll +}; + + +/** + Reads the current operational settings. + + The GetModeData() function copies the current operational settings of this EFI + UDPv4 Protocol instance into user-supplied buffers. This function is used + optionally to retrieve the operational mode data of underlying networks or + drivers. + + @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. + @param[out] Udp4ConfigData Pointer to the buffer to receive the current configuration data. + @param[out] Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure. + @param[out] MnpConfigData Pointer to the managed network configuration data structure. + @param[out] SnpModeData Pointer to the simple network mode data structure. + + @retval EFI_SUCCESS The mode data was read. + @retval EFI_NOT_STARTED When Udp4ConfigData is queried, no configuration data is + available because this instance has not been started. + @retval EFI_INVALID_PARAMETER This is NULL. + +**/ +EFI_STATUS +EFIAPI +Udp4GetModeData ( + IN EFI_UDP4_PROTOCOL *This, + OUT EFI_UDP4_CONFIG_DATA *Udp4ConfigData OPTIONAL, + OUT EFI_IP4_MODE_DATA *Ip4ModeData OPTIONAL, + OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL, + OUT EFI_SIMPLE_NETWORK_MODE *SnpModeData OPTIONAL + ) +{ + UDP4_INSTANCE_DATA *Instance; + EFI_IP4_PROTOCOL *Ip; + EFI_TPL OldTpl; + EFI_STATUS Status; + + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + Instance = UDP4_INSTANCE_DATA_FROM_THIS (This); + + if (!Instance->Configured && (Udp4ConfigData != NULL)) { + return EFI_NOT_STARTED; + } + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + if (Udp4ConfigData != NULL) { + // + // Set the Udp4ConfigData. + // + CopyMem (Udp4ConfigData, &Instance->ConfigData, sizeof (*Udp4ConfigData)); + } + + Ip = Instance->IpInfo->Ip.Ip4; + + // + // Get the underlying Ip4ModeData, MnpConfigData and SnpModeData. + // + Status = Ip->GetModeData (Ip, Ip4ModeData, MnpConfigData, SnpModeData); + + gBS->RestoreTPL (OldTpl); + + return Status; +} + + +/** + Initializes, changes, or resets the operational parameters for this instance of the EFI UDPv4 + Protocol. + + The Configure() function is used to do the following: + * Initialize and start this instance of the EFI UDPv4 Protocol. + * Change the filtering rules and operational parameters. + * Reset this instance of the EFI UDPv4 Protocol. + Until these parameters are initialized, no network traffic can be sent or + received by this instance. This instance can be also reset by calling Configure() + with UdpConfigData set to NULL. Once reset, the receiving queue and transmitting + queue are flushed and no traffic is allowed through this instance. + With different parameters in UdpConfigData, Configure() can be used to bind + this instance to specified port. + + @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. + @param[in] UdpConfigData Pointer to the buffer to receive the current configuration data. + + @retval EFI_SUCCESS The configuration settings were set, changed, or reset successfully. + @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, + RARP, etc.) is not finished yet. + @retval EFI_INVALID_PARAMETER One or more following conditions are TRUE: + @retval EFI_ALREADY_STARTED The EFI UDPv4 Protocol instance is already started/configured + and must be stopped/reset before it can be reconfigured. + @retval EFI_ACCESS_DENIED UdpConfigData. AllowDuplicatePort is FALSE + and UdpConfigData.StationPort is already used by + other instance. + @retval EFI_OUT_OF_RESOURCES The EFI UDPv4 Protocol driver cannot allocate memory for this + EFI UDPv4 Protocol instance. + @retval EFI_DEVICE_ERROR An unexpected network or system error occurred and this instance + was not opened. + +**/ +EFI_STATUS +EFIAPI +Udp4Configure ( + IN EFI_UDP4_PROTOCOL *This, + IN EFI_UDP4_CONFIG_DATA *UdpConfigData OPTIONAL + ) +{ + EFI_STATUS Status; + UDP4_INSTANCE_DATA *Instance; + UDP4_SERVICE_DATA *Udp4Service; + EFI_TPL OldTpl; + IP4_ADDR StationAddress; + IP4_ADDR SubnetMask; + IP4_ADDR RemoteAddress; + EFI_IP4_CONFIG_DATA Ip4ConfigData; + IP4_ADDR LocalAddr; + IP4_ADDR RemoteAddr; + + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + Instance = UDP4_INSTANCE_DATA_FROM_THIS (This); + + if (!Instance->Configured && (UdpConfigData == NULL)) { + return EFI_SUCCESS; + } + + Udp4Service = Instance->Udp4Service; + Status = EFI_SUCCESS; + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + if (UdpConfigData != NULL) { + + CopyMem (&StationAddress, &UdpConfigData->StationAddress, sizeof (IP4_ADDR)); + CopyMem (&SubnetMask, &UdpConfigData->SubnetMask, sizeof (IP4_ADDR)); + CopyMem (&RemoteAddress, &UdpConfigData->RemoteAddress, sizeof (IP4_ADDR)); + + StationAddress = NTOHL (StationAddress); + SubnetMask = NTOHL (SubnetMask); + RemoteAddress = NTOHL (RemoteAddress); + + + if (!UdpConfigData->UseDefaultAddress && + (!IP4_IS_VALID_NETMASK (SubnetMask) || + !((StationAddress == 0) || (SubnetMask != 0 && NetIp4IsUnicast (StationAddress, SubnetMask))) || + IP4_IS_LOCAL_BROADCAST (RemoteAddress))) { + // + // Don't use default address, and subnet mask is invalid or StationAddress is not + // a valid unicast IPv4 address or RemoteAddress is not a valid unicast IPv4 address + // if it is not 0. + // + Status = EFI_INVALID_PARAMETER; + goto ON_EXIT; + } + + if (Instance->Configured) { + // + // The instance is already configured, try to do the re-configuration. + // + if (!Udp4IsReconfigurable (&Instance->ConfigData, UdpConfigData)) { + // + // If the new configuration data wants to change some unreconfigurable + // settings, return EFI_ALREADY_STARTED. + // + Status = EFI_ALREADY_STARTED; + goto ON_EXIT; + } + + // + // Save the reconfigurable parameters. + // + Instance->ConfigData.TypeOfService = UdpConfigData->TypeOfService; + Instance->ConfigData.TimeToLive = UdpConfigData->TimeToLive; + Instance->ConfigData.DoNotFragment = UdpConfigData->DoNotFragment; + Instance->ConfigData.ReceiveTimeout = UdpConfigData->ReceiveTimeout; + Instance->ConfigData.TransmitTimeout = UdpConfigData->TransmitTimeout; + } else { + // + // Construct the Ip configuration data from the UdpConfigData. + // + Udp4BuildIp4ConfigData (UdpConfigData, &Ip4ConfigData); + + // + // Configure the Ip instance wrapped in the IpInfo. + // + Status = IpIoConfigIp (Instance->IpInfo, &Ip4ConfigData); + if (EFI_ERROR (Status)) { + if (Status == EFI_NO_MAPPING) { + Instance->IsNoMapping = TRUE; + } + + goto ON_EXIT; + } + + Instance->IsNoMapping = FALSE; + + // + // Save the configuration data. + // + CopyMem (&Instance->ConfigData, UdpConfigData, sizeof (Instance->ConfigData)); + IP4_COPY_ADDRESS (&Instance->ConfigData.StationAddress, &Ip4ConfigData.StationAddress); + IP4_COPY_ADDRESS (&Instance->ConfigData.SubnetMask, &Ip4ConfigData.SubnetMask); + + // + // Try to allocate the required port resource. + // + Status = Udp4Bind (&Udp4Service->ChildrenList, &Instance->ConfigData); + if (EFI_ERROR (Status)) { + // + // Reset the ip instance if bind fails. + // + IpIoConfigIp (Instance->IpInfo, NULL); + goto ON_EXIT; + } + + // + // Pre calculate the checksum for the pseudo head, ignore the UDP length first. + // + CopyMem (&LocalAddr, &Instance->ConfigData.StationAddress, sizeof (IP4_ADDR)); + CopyMem (&RemoteAddr, &Instance->ConfigData.RemoteAddress, sizeof (IP4_ADDR)); + Instance->HeadSum = NetPseudoHeadChecksum ( + LocalAddr, + RemoteAddr, + EFI_IP_PROTO_UDP, + 0 + ); + + Instance->Configured = TRUE; + } + } else { + // + // UdpConfigData is NULL, reset the instance. + // + Instance->Configured = FALSE; + Instance->IsNoMapping = FALSE; + + // + // Reset the Ip instance wrapped in the IpInfo. + // + IpIoConfigIp (Instance->IpInfo, NULL); + + // + // Cancel all the user tokens. + // + Instance->Udp4Proto.Cancel (&Instance->Udp4Proto, NULL); + + // + // Remove the buffered RxData for this instance. + // + Udp4FlushRcvdDgram (Instance); + + ASSERT (IsListEmpty (&Instance->DeliveredDgramQue)); + } + +ON_EXIT: + + gBS->RestoreTPL (OldTpl); + + return Status; +} + + +/** + Joins and leaves multicast groups. + + The Groups() function is used to enable and disable the multicast group + filtering. If the JoinFlag is FALSE and the MulticastAddress is NULL, then all + currently joined groups are left. + + @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. + @param[in] JoinFlag Set to TRUE to join a multicast group. Set to FALSE to leave one + or all multicast groups. + @param[in] MulticastAddress Pointer to multicast group address to join or leave. + + @retval EFI_SUCCESS The operation completed successfully. + @retval EFI_NOT_STARTED The EFI UDPv4 Protocol instance has not been started. + @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, + RARP, etc.) is not finished yet. + @retval EFI_OUT_OF_RESOURCES Could not allocate resources to join the group. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + - This is NULL. + - JoinFlag is TRUE and MulticastAddress is NULL. + - JoinFlag is TRUE and *MulticastAddress is not + a valid multicast address. + @retval EFI_ALREADY_STARTED The group address is already in the group table (when + JoinFlag is TRUE). + @retval EFI_NOT_FOUND The group address is not in the group table (when JoinFlag is + FALSE). + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. + +**/ +EFI_STATUS +EFIAPI +Udp4Groups ( + IN EFI_UDP4_PROTOCOL *This, + IN BOOLEAN JoinFlag, + IN EFI_IPv4_ADDRESS *MulticastAddress OPTIONAL + ) +{ + EFI_STATUS Status; + UDP4_INSTANCE_DATA *Instance; + EFI_IP4_PROTOCOL *Ip; + EFI_TPL OldTpl; + IP4_ADDR McastIp; + + if ((This == NULL) || (JoinFlag && (MulticastAddress == NULL))) { + return EFI_INVALID_PARAMETER; + } + + McastIp = 0; + if (JoinFlag) { + CopyMem (&McastIp, MulticastAddress, sizeof (IP4_ADDR)); + + if (!IP4_IS_MULTICAST (NTOHL (McastIp))) { + return EFI_INVALID_PARAMETER; + } + } + + Instance = UDP4_INSTANCE_DATA_FROM_THIS (This); + + if (Instance->IsNoMapping) { + return EFI_NO_MAPPING; + } + + if (!Instance->Configured) { + return EFI_NOT_STARTED; + } + + Ip = Instance->IpInfo->Ip.Ip4; + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + // + // Invoke the Ip instance the Udp4 instance consumes to do the group operation. + // + Status = Ip->Groups (Ip, JoinFlag, MulticastAddress); + + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } + + // + // Keep a local copy of the configured multicast IPs because IpIo receives + // datagrams from the 0 station address IP instance and then UDP delivers to + // the matched instance. This copy of multicast IPs is used to avoid receive + // the mutlicast datagrams destined to multicast IPs the other instances configured. + // + if (JoinFlag) { + + NetMapInsertTail (&Instance->McastIps, (VOID *) (UINTN) McastIp, NULL); + } else { + + NetMapIterate (&Instance->McastIps, Udp4LeaveGroup, MulticastAddress); + } + +ON_EXIT: + + gBS->RestoreTPL (OldTpl); + + return Status; +} + + +/** + Adds and deletes routing table entries. + + The Routes() function adds a route to or deletes a route from the routing table. + Routes are determined by comparing the SubnetAddress with the destination IP + address and arithmetically AND-ing it with the SubnetMask. The gateway address + must be on the same subnet as the configured station address. + The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0. + The default route matches all destination IP addresses that do not match any + other routes. + A zero GatewayAddress is a nonroute. Packets are sent to the destination IP + address if it can be found in the Address Resolution Protocol (ARP) cache or + on the local subnet. One automatic nonroute entry will be inserted into the + routing table for outgoing packets that are addressed to a local subnet + (gateway address of 0.0.0.0). + Each instance of the EFI UDPv4 Protocol has its own independent routing table. + Instances of the EFI UDPv4 Protocol that use the default IP address will also + have copies of the routing table provided by the EFI_IP4_CONFIG_PROTOCOL. These + copies will be updated automatically whenever the IP driver reconfigures its + instances; as a result, the previous modification to these copies will be lost. + + @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. + @param[in] DeleteRoute Set to TRUE to delete this route from the routing table. + Set to FALSE to add this route to the routing table. + @param[in] SubnetAddress The destination network address that needs to be routed. + @param[in] SubnetMask The subnet mask of SubnetAddress. + @param[in] GatewayAddress The gateway IP address for this route. + + @retval EFI_SUCCESS The operation completed successfully. + @retval EFI_NOT_STARTED The EFI UDPv4 Protocol instance has not been started. + @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, + - RARP, etc.) is not finished yet. + @retval EFI_INVALID_PARAMETER One or more parameters are invalid. + @retval EFI_OUT_OF_RESOURCES Could not add the entry to the routing table. + @retval EFI_NOT_FOUND This route is not in the routing table. + @retval EFI_ACCESS_DENIED The route is already defined in the routing table. + +**/ +EFI_STATUS +EFIAPI +Udp4Routes ( + IN EFI_UDP4_PROTOCOL *This, + IN BOOLEAN DeleteRoute, + IN EFI_IPv4_ADDRESS *SubnetAddress, + IN EFI_IPv4_ADDRESS *SubnetMask, + IN EFI_IPv4_ADDRESS *GatewayAddress + ) +{ + UDP4_INSTANCE_DATA *Instance; + EFI_IP4_PROTOCOL *Ip; + + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + Instance = UDP4_INSTANCE_DATA_FROM_THIS (This); + + if (Instance->IsNoMapping) { + return EFI_NO_MAPPING; + } + + if (!Instance->Configured) { + return EFI_NOT_STARTED; + } + + Ip = Instance->IpInfo->Ip.Ip4; + + // + // Invoke the Ip instance the Udp4 instance consumes to do the actual operation. + // + return Ip->Routes (Ip, DeleteRoute, SubnetAddress, SubnetMask, GatewayAddress); +} + + +/** + Queues outgoing data packets into the transmit queue. + + The Transmit() function places a sending request to this instance of the EFI + UDPv4 Protocol, alongside the transmit data that was filled by the user. Whenever + the packet in the token is sent out or some errors occur, the Token.Event will + be signaled and Token.Status is updated. Providing a proper notification function + and context for the event will enable the user to receive the notification and + transmitting status. + + @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. + @param[in] Token Pointer to the completion token that will be placed into the + transmit queue. + + @retval EFI_SUCCESS The data has been queued for transmission. + @retval EFI_NOT_STARTED This EFI UDPv4 Protocol instance has not been started. + @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, + RARP, etc.) is not finished yet. + @retval EFI_INVALID_PARAMETER One or more parameters are invalid. + @retval EFI_ACCESS_DENIED The transmit completion token with the same + Token.Event was already in the transmit queue. + @retval EFI_NOT_READY The completion token could not be queued because the + transmit queue is full. + @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data. + @retval EFI_NOT_FOUND There is no route to the destination network or address. + @retval EFI_BAD_BUFFER_SIZE The data length is greater than the maximum UDP packet + size. Or the length of the IP header + UDP header + data + length is greater than MTU if DoNotFragment is TRUE. + +**/ +EFI_STATUS +EFIAPI +Udp4Transmit ( + IN EFI_UDP4_PROTOCOL *This, + IN EFI_UDP4_COMPLETION_TOKEN *Token + ) +{ + EFI_STATUS Status; + UDP4_INSTANCE_DATA *Instance; + EFI_TPL OldTpl; + NET_BUF *Packet; + EFI_UDP_HEADER *Udp4Header; + EFI_UDP4_CONFIG_DATA *ConfigData; + IP4_ADDR Source; + IP4_ADDR Destination; + EFI_UDP4_TRANSMIT_DATA *TxData; + EFI_UDP4_SESSION_DATA *UdpSessionData; + UDP4_SERVICE_DATA *Udp4Service; + IP_IO_OVERRIDE Override; + UINT16 HeadSum; + EFI_IP_ADDRESS IpDestAddr; + + if ((This == NULL) || (Token == NULL)) { + return EFI_INVALID_PARAMETER; + } + + Instance = UDP4_INSTANCE_DATA_FROM_THIS (This); + + if (Instance->IsNoMapping) { + return EFI_NO_MAPPING; + } + + if (!Instance->Configured) { + return EFI_NOT_STARTED; + } + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + // + // Validate the Token, if the token is invalid return the error code. + // + Status = Udp4ValidateTxToken (Instance, Token); + if (EFI_ERROR (Status)) { + goto ON_EXIT; + } + + if (EFI_ERROR (NetMapIterate (&Instance->TxTokens, Udp4TokenExist, Token)) || + EFI_ERROR (NetMapIterate (&Instance->RxTokens, Udp4TokenExist, Token))) { + // + // Try to find a duplicate token in the two token maps, if found, return + // EFI_ACCESS_DENIED. + // + Status = EFI_ACCESS_DENIED; + goto ON_EXIT; + } + + TxData = Token->Packet.TxData; + + // + // Create a net buffer to hold the user buffer and the udp header. + // + Packet = NetbufFromExt ( + (NET_FRAGMENT *)TxData->FragmentTable, + TxData->FragmentCount, + UDP4_HEADER_SIZE, + 0, + Udp4NetVectorExtFree, + NULL + ); + if (Packet == NULL) { + Status = EFI_OUT_OF_RESOURCES; + goto ON_EXIT; + } + + // + // Store the IpIo in ProtoData. + // + Udp4Service = Instance->Udp4Service; + *((UINTN *) &Packet->ProtoData[0]) = (UINTN) (Udp4Service->IpIo); + + Udp4Header = (EFI_UDP_HEADER *) NetbufAllocSpace (Packet, UDP4_HEADER_SIZE, TRUE); + ASSERT (Udp4Header != NULL); + + ConfigData = &Instance->ConfigData; + + // + // Fill the udp header. + // + Udp4Header->SrcPort = HTONS (ConfigData->StationPort); + Udp4Header->DstPort = HTONS (ConfigData->RemotePort); + Udp4Header->Length = HTONS ((UINT16) Packet->TotalSize); + Udp4Header->Checksum = 0; + + UdpSessionData = TxData->UdpSessionData; + IP4_COPY_ADDRESS (&Override.Ip4OverrideData.SourceAddress, &ConfigData->StationAddress); + + if (UdpSessionData != NULL) { + // + // Set the SourceAddress, SrcPort and Destination according to the specified + // UdpSessionData. + // + if (!EFI_IP4_EQUAL (&UdpSessionData->SourceAddress, &mZeroIp4Addr)) { + IP4_COPY_ADDRESS (&Override.Ip4OverrideData.SourceAddress, &UdpSessionData->SourceAddress); + } + + if (UdpSessionData->SourcePort != 0) { + Udp4Header->SrcPort = HTONS (UdpSessionData->SourcePort); + } + + if (UdpSessionData->DestinationPort != 0) { + Udp4Header->DstPort = HTONS (UdpSessionData->DestinationPort); + } + + CopyMem (&Source, &Override.Ip4OverrideData.SourceAddress, sizeof (IP4_ADDR)); + CopyMem (&Destination, &UdpSessionData->DestinationAddress, sizeof (IP4_ADDR)); + + // + // calculate the pseudo head checksum using the overridden parameters. + // + HeadSum = NetPseudoHeadChecksum ( + Source, + Destination, + EFI_IP_PROTO_UDP, + 0 + ); + } else { + // + // UdpSessionData is NULL, use the address and port information previously configured. + // + CopyMem (&Destination, &ConfigData->RemoteAddress, sizeof (IP4_ADDR)); + + HeadSum = Instance->HeadSum; + } + + // + // calculate the checksum. + // + Udp4Header->Checksum = Udp4Checksum (Packet, HeadSum); + if (Udp4Header->Checksum == 0) { + // + // If the calculated checksum is 0, fill the Checksum field with all ones. + // + Udp4Header->Checksum = 0xffff; + } + + // + // Fill the IpIo Override data. + // + if (TxData->GatewayAddress != NULL) { + IP4_COPY_ADDRESS (&Override.Ip4OverrideData.GatewayAddress, TxData->GatewayAddress); + } else { + ZeroMem (&Override.Ip4OverrideData.GatewayAddress, sizeof (EFI_IPv4_ADDRESS)); + } + + Override.Ip4OverrideData.Protocol = EFI_IP_PROTO_UDP; + Override.Ip4OverrideData.TypeOfService = ConfigData->TypeOfService; + Override.Ip4OverrideData.TimeToLive = ConfigData->TimeToLive; + Override.Ip4OverrideData.DoNotFragment = ConfigData->DoNotFragment; + + // + // Save the token into the TxToken map. + // + Status = NetMapInsertTail (&Instance->TxTokens, Token, Packet); + if (EFI_ERROR (Status)) { + goto FREE_PACKET; + } + + // + // Send out this datagram through IpIo. + // + IpDestAddr.Addr[0] = Destination; + Status = IpIoSend ( + Udp4Service->IpIo, + Packet, + Instance->IpInfo, + Instance, + Token, + &IpDestAddr, + &Override + ); + if (EFI_ERROR (Status)) { + // + // Remove this token from the TxTokens. + // + Udp4RemoveToken (&Instance->TxTokens, Token); + } + +FREE_PACKET: + + NetbufFree (Packet); + +ON_EXIT: + + gBS->RestoreTPL (OldTpl); + + return Status; +} + + +/** + Places an asynchronous receive request into the receiving queue. + + The Receive() function places a completion token into the receive packet queue. + This function is always asynchronous. + The caller must fill in the Token.Event field in the completion token, and this + field cannot be NULL. When the receive operation completes, the EFI UDPv4 Protocol + driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event + is signaled. Providing a proper notification function and context for the event + will enable the user to receive the notification and receiving status. That + notification function is guaranteed to not be re-entered. + + @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. + @param[in] Token Pointer to a token that is associated with + the receive data descriptor. + + @retval EFI_SUCCESS The receive completion token was cached. + @retval EFI_NOT_STARTED This EFI UDPv4 Protocol instance has not been started. + @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, RARP, etc.) + is not finished yet. + @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE: + @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system + resources (usually memory). + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. + @retval EFI_ACCESS_DENIED A receive completion token with the same Token.Event was already in + the receive queue. + @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full. + +**/ +EFI_STATUS +EFIAPI +Udp4Receive ( + IN EFI_UDP4_PROTOCOL *This, + IN EFI_UDP4_COMPLETION_TOKEN *Token + ) +{ + EFI_STATUS Status; + UDP4_INSTANCE_DATA *Instance; + EFI_TPL OldTpl; + + if ((This == NULL) || (Token == NULL) || (Token->Event == NULL)) { + return EFI_INVALID_PARAMETER; + } + + Instance = UDP4_INSTANCE_DATA_FROM_THIS (This); + + if (Instance->IsNoMapping) { + return EFI_NO_MAPPING; + } + + if (!Instance->Configured) { + return EFI_NOT_STARTED; + } + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + if (EFI_ERROR (NetMapIterate (&Instance->RxTokens, Udp4TokenExist, Token))|| + EFI_ERROR (NetMapIterate (&Instance->TxTokens, Udp4TokenExist, Token))) { + // + // Return EFI_ACCESS_DENIED if the specified token is already in the TxTokens or + // RxTokens map. + // + Status = EFI_ACCESS_DENIED; + goto ON_EXIT; + } + + Token->Packet.RxData = NULL; + + // + // Save the token into the RxTokens map. + // + Status = NetMapInsertTail (&Instance->RxTokens, Token, NULL); + if (EFI_ERROR (Status)) { + Status = EFI_NOT_READY; + goto ON_EXIT; + } + + // + // If there is an icmp error, report it. + // + Udp4ReportIcmpError (Instance); + + // + // Try to deliver the received datagrams. + // + Udp4InstanceDeliverDgram (Instance); + + // + // Dispatch the DPC queued by the NotifyFunction of Token->Event. + // + DispatchDpc (); + +ON_EXIT: + + gBS->RestoreTPL (OldTpl); + + return Status; +} + + +/** + Aborts an asynchronous transmit or receive request. + + The Cancel() function is used to abort a pending transmit or receive request. + If the token is in the transmit or receive request queues, after calling this + function, Token.Status will be set to EFI_ABORTED and then Token.Event will be + signaled. If the token is not in one of the queues, which usually means that + the asynchronous operation has completed, this function will not signal the + token and EFI_NOT_FOUND is returned. + + @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. + @param[in] Token Pointer to a token that has been issued by + EFI_UDP4_PROTOCOL.Transmit() or + EFI_UDP4_PROTOCOL.Receive().If NULL, all pending + tokens are aborted. + + @retval EFI_SUCCESS The asynchronous I/O request was aborted and Token.Event + was signaled. When Token is NULL, all pending requests are + aborted and their events are signaled. + @retval EFI_INVALID_PARAMETER This is NULL. + @retval EFI_NOT_STARTED This instance has not been started. + @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, + RARP, etc.) is not finished yet. + @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O request was + not found in the transmit or receive queue. It has either completed + or was not issued by Transmit() and Receive(). + +**/ +EFI_STATUS +EFIAPI +Udp4Cancel ( + IN EFI_UDP4_PROTOCOL *This, + IN EFI_UDP4_COMPLETION_TOKEN *Token OPTIONAL + ) +{ + EFI_STATUS Status; + UDP4_INSTANCE_DATA *Instance; + EFI_TPL OldTpl; + + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + Instance = UDP4_INSTANCE_DATA_FROM_THIS (This); + + if (Instance->IsNoMapping) { + return EFI_NO_MAPPING; + } + + if (!Instance->Configured) { + return EFI_NOT_STARTED; + } + + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); + + // + // Cancle the tokens specified by Token for this instance. + // + Status = Udp4InstanceCancelToken (Instance, Token); + + // + // Dispatch the DPC queued by the NotifyFunction of the cancelled token's events. + // + DispatchDpc (); + + gBS->RestoreTPL (OldTpl); + + return Status; +} + + +/** + Polls for incoming data packets and processes outgoing data packets. + + The Poll() function can be used by network drivers and applications to increase + the rate that data packets are moved between the communications device and the + transmit and receive queues. + In some systems, the periodic timer event in the managed network driver may not + poll the underlying communications device fast enough to transmit and/or receive + all data packets without missing incoming packets or dropping outgoing packets. + Drivers and applications that are experiencing packet loss should try calling + the Poll() function more often. + + @param[in] This Pointer to the EFI_UDP4_PROTOCOL instance. + + @retval EFI_SUCCESS Incoming or outgoing data was processed. + @retval EFI_INVALID_PARAMETER This is NULL. + @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. + @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue. + +**/ +EFI_STATUS +EFIAPI +Udp4Poll ( + IN EFI_UDP4_PROTOCOL *This + ) +{ + UDP4_INSTANCE_DATA *Instance; + EFI_IP4_PROTOCOL *Ip; + + if (This == NULL) { + return EFI_INVALID_PARAMETER; + } + + Instance = UDP4_INSTANCE_DATA_FROM_THIS (This); + Ip = Instance->IpInfo->Ip.Ip4; + + // + // Invode the Ip instance consumed by the udp instance to do the poll operation. + // + return Ip->Poll (Ip); +} diff --git a/NetworkPkg/VlanConfigDxe/ComponentName.c b/NetworkPkg/VlanConfigDxe/ComponentName.c new file mode 100644 index 0000000000..f36d29f8bd --- /dev/null +++ b/NetworkPkg/VlanConfigDxe/ComponentName.c @@ -0,0 +1,164 @@ +/** @file + UEFI Component Name(2) protocol implementation for VlanConfigDxe driver. + +Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "VlanConfigImpl.h" + +// +// EFI Component Name Protocol +// +GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gVlanConfigComponentName = { + VlanConfigComponentNameGetDriverName, + VlanConfigComponentNameGetControllerName, + "eng" +}; + +// +// EFI Component Name 2 Protocol +// +GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gVlanConfigComponentName2 = { + (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) VlanConfigComponentNameGetDriverName, + (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) VlanConfigComponentNameGetControllerName, + "en" +}; + +GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mVlanConfigDriverNameTable[] = { + { + "eng;en", + L"VLAN Configuration Driver" + }, + { + NULL, + NULL + } +}; + +// +// EFI Component Name Functions +// + +/** + Retrieves a Unicode string that is the user readable name of the driver. + + This function retrieves the user readable name of a driver in the form of a + Unicode string. If the driver specified by This has a user readable name in + the language specified by Language, then a pointer to the driver name is + returned in DriverName, and EFI_SUCCESS is returned. If the driver specified + by This does not support the language specified by Language, + then EFI_UNSUPPORTED is returned. + + @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + @param Language[in] A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified + in RFC 4646 or ISO 639-2 language code format. + @param DriverName[out] A pointer to the Unicode string to return. + This Unicode string is the name of the + driver specified by This in the language + specified by Language. + + @retval EFI_SUCCESS The Unicode string for the Driver specified by + This and the language specified by Language was + returned in DriverName. + @retval EFI_INVALID_PARAMETER Language is NULL. + @retval EFI_INVALID_PARAMETER DriverName is NULL. + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +VlanConfigComponentNameGetDriverName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN CHAR8 *Language, + OUT CHAR16 **DriverName + ) +{ + return LookupUnicodeString2 ( + Language, + This->SupportedLanguages, + mVlanConfigDriverNameTable, + DriverName, + (BOOLEAN)(This == &gVlanConfigComponentName) + ); +} + +/** + Retrieves a Unicode string that is the user readable name of the controller + that is being managed by a driver. + + This function retrieves the user readable name of the controller specified by + ControllerHandle and ChildHandle in the form of a Unicode string. If the + driver specified by This has a user readable name in the language specified by + Language, then a pointer to the controller name is returned in ControllerName, + and EFI_SUCCESS is returned. If the driver specified by This is not currently + managing the controller specified by ControllerHandle and ChildHandle, + then EFI_UNSUPPORTED is returned. If the driver specified by This does not + support the language specified by Language, then EFI_UNSUPPORTED is returned. + + @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + @param ControllerHandle[in] The handle of a controller that the driver + specified by This is managing. This handle + specifies the controller whose name is to be + returned. + @param ChildHandle[in] The handle of the child controller to retrieve + the name of. This is an optional parameter that + may be NULL. It will be NULL for device + drivers. It will also be NULL for a bus drivers + that wish to retrieve the name of the bus + controller. It will not be NULL for a bus + driver that wishes to retrieve the name of a + child controller. + @param Language[in] A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified in + RFC 4646 or ISO 639-2 language code format. + @param ControllerName[out] A pointer to the Unicode string to return. + This Unicode string is the name of the + controller specified by ControllerHandle and + ChildHandle in the language specified by + Language from the point of view of the driver + specified by This. + + @retval EFI_SUCCESS The Unicode string for the user readable name in + the language specified by Language for the + driver specified by This was returned in + DriverName. + @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. + @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid + EFI_HANDLE. + @retval EFI_INVALID_PARAMETER Language is NULL. + @retval EFI_INVALID_PARAMETER ControllerName is NULL. + @retval EFI_UNSUPPORTED The driver specified by This is not currently + managing the controller specified by + ControllerHandle and ChildHandle. + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +VlanConfigComponentNameGetControllerName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_HANDLE ChildHandle OPTIONAL, + IN CHAR8 *Language, + OUT CHAR16 **ControllerName + ) +{ + return EFI_UNSUPPORTED; +} diff --git a/NetworkPkg/VlanConfigDxe/VlanConfig.vfr b/NetworkPkg/VlanConfigDxe/VlanConfig.vfr new file mode 100644 index 0000000000..e493325295 --- /dev/null +++ b/NetworkPkg/VlanConfigDxe/VlanConfig.vfr @@ -0,0 +1,72 @@ +///** @file +// VLAN configuration formset. +// +// Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.
+// SPDX-License-Identifier: BSD-2-Clause-Patent +// +//**/ + +#include "VlanConfigNvData.h" + +formset + guid = VLAN_CONFIG_FORM_SET_GUID, + title = STRING_TOKEN(STR_VLAN_FORM_SET_TITLE), + help = STRING_TOKEN(STR_VLAN_FORM_SET_TITLE_HELP), + classguid = EFI_HII_PLATFORM_SETUP_FORMSET_GUID, + + varstore VLAN_CONFIGURATION, + varid = VLAN_CONFIGURATION_VARSTORE_ID, + name = VlanNvData, + guid = VLAN_CONFIG_FORM_SET_GUID; + + form formid = VLAN_HEAD_FORM_ID, + title = STRING_TOKEN(STR_VLAN_FORM_TITLE); + + goto VLAN_CONFIGURATION_FORM_ID, + prompt = STRING_TOKEN (STR_GET_CURRENT_SETTING), + help = STRING_TOKEN (STR_GET_CURRENT_SETTING_HELP), + flags = INTERACTIVE, + key = VLAN_UPDATE_QUESTION_ID; + + endform; + + form formid = VLAN_CONFIGURATION_FORM_ID, + title = STRING_TOKEN(STR_VLAN_FORM_TITLE); + + subtitle text = STRING_TOKEN(STR_VLAN_CREATE_VLAN); + + numeric varid = VlanNvData.VlanId, + prompt = STRING_TOKEN(STR_VLAN_VID_PROMPT), + help = STRING_TOKEN(STR_VLAN_VID_HELP), + minimum = 0, + maximum = 4094, + endnumeric; + + numeric varid = VlanNvData.Priority, + prompt = STRING_TOKEN(STR_VLAN_PRIORITY_PROMPT), + help = STRING_TOKEN(STR_VLAN_PRIORITY_HELP), + minimum = 0, + maximum = 7, + endnumeric; + + text + help = STRING_TOKEN(STR_VLAN_ADD_VLAN_HELP), + text = STRING_TOKEN(STR_VLAN_ADD_VLAN_PROMPT), + flags = INTERACTIVE, + key = VLAN_ADD_QUESTION_ID; + + subtitle text = STRING_TOKEN(STR_VLAN_NULL_STRING); + subtitle text = STRING_TOKEN(STR_VLAN_VLAN_LIST); + + label LABEL_VLAN_LIST; + label LABEL_END; + + text + help = STRING_TOKEN(STR_VLAN_REMOVE_VLAN_HELP), + text = STRING_TOKEN(STR_VLAN_REMOVE_VLAN_PROMPT), + flags = INTERACTIVE, + key = VLAN_REMOVE_QUESTION_ID; + + endform; + +endformset; diff --git a/NetworkPkg/VlanConfigDxe/VlanConfigDriver.c b/NetworkPkg/VlanConfigDxe/VlanConfigDriver.c new file mode 100644 index 0000000000..c717d9ea52 --- /dev/null +++ b/NetworkPkg/VlanConfigDxe/VlanConfigDriver.c @@ -0,0 +1,299 @@ +/** @file + The driver binding for VLAN configuration module. + +Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "VlanConfigImpl.h" + +EFI_DRIVER_BINDING_PROTOCOL gVlanConfigDriverBinding = { + VlanConfigDriverBindingSupported, + VlanConfigDriverBindingStart, + VlanConfigDriverBindingStop, + 0xa, + NULL, + NULL +}; + +/** + The entry point for IP4 config driver which install the driver + binding and component name protocol on its image. + + @param[in] ImageHandle The image handle of the driver. + @param[in] SystemTable The system table. + + @retval EFI_SUCCES All the related protocols are installed on the driver. + @retval Others Failed to install protocols. + +**/ +EFI_STATUS +EFIAPI +VlanConfigDriverEntryPoint ( + IN EFI_HANDLE ImageHandle, + IN EFI_SYSTEM_TABLE *SystemTable + ) +{ + return EfiLibInstallDriverBindingComponentName2 ( + ImageHandle, + SystemTable, + &gVlanConfigDriverBinding, + ImageHandle, + &gVlanConfigComponentName, + &gVlanConfigComponentName2 + ); +} + + +/** + Test to see if this driver supports ControllerHandle. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to test + @param[in] RemainingDevicePath Optional parameter use to pick a specific child + device to start. + + @retval EFI_SUCCES This driver supports this device + @retval EFI_ALREADY_STARTED This driver is already running on this device + @retval other This driver does not support this device + +**/ +EFI_STATUS +EFIAPI +VlanConfigDriverBindingSupported ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL + ) +{ + EFI_STATUS Status; + EFI_VLAN_CONFIG_PROTOCOL *VlanConfig; + + Status = gBS->OpenProtocol ( + ControllerHandle, + &gEfiVlanConfigProtocolGuid, + (VOID **) &VlanConfig, + This->DriverBindingHandle, + ControllerHandle, + EFI_OPEN_PROTOCOL_BY_DRIVER + ); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Close the VlanConfig protocol opened for supported test + // + gBS->CloseProtocol ( + ControllerHandle, + &gEfiVlanConfigProtocolGuid, + This->DriverBindingHandle, + ControllerHandle + ); + + return Status; +} + + +/** + Start this driver on ControllerHandle. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to bind driver to + @param[in] RemainingDevicePath Optional parameter use to pick a specific child + device to start. + + @retval EFI_SUCCES This driver is added to ControllerHandle + @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle + @retval other This driver does not support this device + +**/ +EFI_STATUS +EFIAPI +VlanConfigDriverBindingStart ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL + ) +{ + EFI_STATUS Status; + EFI_VLAN_CONFIG_PROTOCOL *VlanConfig; + EFI_DEVICE_PATH_PROTOCOL *DevicePath; + VLAN_CONFIG_PRIVATE_DATA *PrivateData; + + // + // Check for multiple start + // + Status = gBS->OpenProtocol ( + ControllerHandle, + &gEfiCallerIdGuid, + (VOID **) &PrivateData, + This->DriverBindingHandle, + ControllerHandle, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + if (!EFI_ERROR (Status)) { + return EFI_ALREADY_STARTED; + } + + // + // Open VlanConfig protocol by driver + // + Status = gBS->OpenProtocol ( + ControllerHandle, + &gEfiVlanConfigProtocolGuid, + (VOID **) &VlanConfig, + This->DriverBindingHandle, + ControllerHandle, + EFI_OPEN_PROTOCOL_BY_DRIVER + ); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Get parent device path + // + Status = gBS->OpenProtocol ( + ControllerHandle, + &gEfiDevicePathProtocolGuid, + (VOID **) &DevicePath, + This->DriverBindingHandle, + ControllerHandle, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + if (EFI_ERROR (Status)) { + goto ErrorExit; + } + + // + // Create a private data for this network device + // + PrivateData = AllocateCopyPool (sizeof (VLAN_CONFIG_PRIVATE_DATA), &mVlanConfigPrivateDateTemplate); + if (PrivateData == NULL) { + Status = EFI_OUT_OF_RESOURCES; + goto ErrorExit; + } + + PrivateData->ImageHandle = This->DriverBindingHandle; + PrivateData->ControllerHandle = ControllerHandle; + PrivateData->VlanConfig = VlanConfig; + PrivateData->ParentDevicePath = DevicePath; + + // + // Install VLAN configuration form + // + Status = InstallVlanConfigForm (PrivateData); + if (EFI_ERROR (Status)) { + goto ErrorExit; + } + + // + // Install private GUID + // + Status = gBS->InstallMultipleProtocolInterfaces ( + &ControllerHandle, + &gEfiCallerIdGuid, + PrivateData, + NULL + ); + if (EFI_ERROR (Status)) { + goto ErrorExit; + } + return Status; + +ErrorExit: + gBS->CloseProtocol ( + ControllerHandle, + &gEfiVlanConfigProtocolGuid, + This->DriverBindingHandle, + ControllerHandle + ); + + gBS->CloseProtocol ( + ControllerHandle, + &gEfiDevicePathProtocolGuid, + This->DriverBindingHandle, + ControllerHandle + ); + + if (PrivateData != NULL) { + UninstallVlanConfigForm (PrivateData); + FreePool (PrivateData); + } + + return Status; +} + + +/** + Stop this driver on ControllerHandle. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to stop driver on + @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number + of children is zero stop the entire bus driver. + @param[in] ChildHandleBuffer List of Child Handles to Stop. + + @retval EFI_SUCCES This driver is removed ControllerHandle + @retval other This driver was not removed from this device + +**/ +EFI_STATUS +EFIAPI +VlanConfigDriverBindingStop ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN UINTN NumberOfChildren, + IN EFI_HANDLE *ChildHandleBuffer + ) +{ + EFI_STATUS Status; + VLAN_CONFIG_PRIVATE_DATA *PrivateData; + + // + // Retrieve the PrivateData from ControllerHandle + // + Status = gBS->OpenProtocol ( + ControllerHandle, + &gEfiCallerIdGuid, + (VOID **) &PrivateData, + This->DriverBindingHandle, + ControllerHandle, + EFI_OPEN_PROTOCOL_GET_PROTOCOL + ); + if (EFI_ERROR (Status)) { + return Status; + } + ASSERT (PrivateData->Signature == VLAN_CONFIG_PRIVATE_DATA_SIGNATURE); + + if (NumberOfChildren != 0) { + if (NumberOfChildren != 1 || ChildHandleBuffer[0] != PrivateData->DriverHandle) { + return EFI_DEVICE_ERROR; + } + + return UninstallVlanConfigForm (PrivateData); + } + + // + // Uninstall the private GUID + // + Status = gBS->UninstallMultipleProtocolInterfaces ( + ControllerHandle, + &gEfiCallerIdGuid, + PrivateData, + NULL + ); + if (EFI_ERROR (Status)) { + return Status; + } + + Status = gBS->CloseProtocol ( + ControllerHandle, + &gEfiVlanConfigProtocolGuid, + This->DriverBindingHandle, + ControllerHandle + ); + return Status; +} diff --git a/NetworkPkg/VlanConfigDxe/VlanConfigDxe.inf b/NetworkPkg/VlanConfigDxe/VlanConfigDxe.inf new file mode 100644 index 0000000000..72af88d695 --- /dev/null +++ b/NetworkPkg/VlanConfigDxe/VlanConfigDxe.inf @@ -0,0 +1,66 @@ +## @file +# This module provides one way to configurate VALN setting. +# +# This module produces EFI HII Configuration Access Protocol to provide one way to +# configurate VALN setting +# +# Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.
+# SPDX-License-Identifier: BSD-2-Clause-Patent +# +## + +[Defines] + INF_VERSION = 0x00010005 + BASE_NAME = VlanConfigDxe + MODULE_UNI_FILE = VlanConfigDxe.uni + FILE_GUID = E4F61863-FE2C-4b56-A8F4-08519BC439DF + MODULE_TYPE = UEFI_DRIVER + VERSION_STRING = 1.0 + ENTRY_POINT = VlanConfigDriverEntryPoint + UNLOAD_IMAGE = NetLibDefaultUnload + + +# +# VALID_ARCHITECTURES = IA32 X64 EBC +# + +[Sources] + ComponentName.c + VlanConfigDriver.c + VlanConfigImpl.c + VlanConfigImpl.h + VlanConfig.vfr + VlanConfigStrings.uni + VlanConfigNvData.h + +[Packages] + MdePkg/MdePkg.dec + MdeModulePkg/MdeModulePkg.dec + +[LibraryClasses] + BaseLib + BaseMemoryLib + MemoryAllocationLib + UefiLib + UefiBootServicesTableLib + UefiDriverEntryPoint + DebugLib + NetLib + HiiLib + +[Guids] + gEfiIfrTianoGuid ## SOMETIMES_PRODUCES ## UNDEFINED + ## SOMETIMES_CONSUMES ## UNDEFINED # HiiIsConfigHdrMatch mVlanStorageName + ## SOMETIMES_PRODUCES ## UNDEFINED # HiiConstructConfigHdr mVlanStorageName + ## SOMETIMES_PRODUCES ## UNDEFINED # HiiGetBrowserData mVlanStorageName + ## SOMETIMES_CONSUMES ## UNDEFINED # HiiSetBrowserData mVlanStorageName + ## SOMETIMES_CONSUMES ## HII + gVlanConfigFormSetGuid + +[Protocols] + gEfiHiiConfigAccessProtocolGuid ## BY_START + gEfiHiiConfigRoutingProtocolGuid ## CONSUMES + gEfiVlanConfigProtocolGuid ## TO_START + +[UserExtensions.TianoCore."ExtraFiles"] + VlanConfigDxeExtra.uni diff --git a/NetworkPkg/VlanConfigDxe/VlanConfigDxe.uni b/NetworkPkg/VlanConfigDxe/VlanConfigDxe.uni new file mode 100644 index 0000000000..abc5a1ade1 --- /dev/null +++ b/NetworkPkg/VlanConfigDxe/VlanConfigDxe.uni @@ -0,0 +1,17 @@ +// /** @file +// This module provides one way to configurate VALN setting. +// +// This module produces EFI HII Configuration Access Protocol to provide one way to +// configurate VALN setting +// +// Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.
+// +// SPDX-License-Identifier: BSD-2-Clause-Patent +// +// **/ + + +#string STR_MODULE_ABSTRACT #language en-US "Provides a way to configure VLAN settings" + +#string STR_MODULE_DESCRIPTION #language en-US "This module produces EFI HII Configuration Access Protocol to provide a way to configure VLAN settings." + diff --git a/NetworkPkg/VlanConfigDxe/VlanConfigDxeExtra.uni b/NetworkPkg/VlanConfigDxe/VlanConfigDxeExtra.uni new file mode 100644 index 0000000000..0c4eada240 --- /dev/null +++ b/NetworkPkg/VlanConfigDxe/VlanConfigDxeExtra.uni @@ -0,0 +1,14 @@ +// /** @file +// VlanConfigDxe Localized Strings and Content +// +// Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.
+// +// SPDX-License-Identifier: BSD-2-Clause-Patent +// +// **/ + +#string STR_PROPERTIES_MODULE_NAME +#language en-US +"VLAN Configuration DXE Driver" + + diff --git a/NetworkPkg/VlanConfigDxe/VlanConfigImpl.c b/NetworkPkg/VlanConfigDxe/VlanConfigImpl.c new file mode 100644 index 0000000000..24d844cbf1 --- /dev/null +++ b/NetworkPkg/VlanConfigDxe/VlanConfigImpl.c @@ -0,0 +1,664 @@ +/** @file + HII Config Access protocol implementation of VLAN configuration module. + +Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "VlanConfigImpl.h" + +CHAR16 mVlanStorageName[] = L"VlanNvData"; +EFI_HII_CONFIG_ROUTING_PROTOCOL *mHiiConfigRouting = NULL; + +VLAN_CONFIG_PRIVATE_DATA mVlanConfigPrivateDateTemplate = { + VLAN_CONFIG_PRIVATE_DATA_SIGNATURE, + { + VlanExtractConfig, + VlanRouteConfig, + VlanCallback + } +}; + +VENDOR_DEVICE_PATH mHiiVendorDevicePathNode = { + { + HARDWARE_DEVICE_PATH, + HW_VENDOR_DP, + { + (UINT8) (sizeof (VENDOR_DEVICE_PATH)), + (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8) + } + }, + VLAN_CONFIG_FORM_SET_GUID +}; + +/** + This function allows a caller to extract the current configuration for one + or more named elements from the target driver. + + @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL. + @param[in] Request A null-terminated Unicode string in + format. + @param[out] Progress On return, points to a character in the Request + string. Points to the string's null terminator if + request was successful. Points to the most recent + '&' before the first failing name/value pair (or + the beginning of the string if the failure is in + the first name/value pair) if the request was not + successful. + @param[out] Results A null-terminated Unicode string in + format which has all values filled + in for the names in the Request string. String to + be allocated by the called function. + + @retval EFI_SUCCESS The Results is filled with the requested values. + @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results. + @retval EFI_INVALID_PARAMETER Request is illegal syntax, or unknown name. + @retval EFI_NOT_FOUND Routing data doesn't match any storage in this + driver. + +**/ +EFI_STATUS +EFIAPI +VlanExtractConfig ( + IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This, + IN CONST EFI_STRING Request, + OUT EFI_STRING *Progress, + OUT EFI_STRING *Results + ) +{ + EFI_STATUS Status; + UINTN BufferSize; + VLAN_CONFIGURATION Configuration; + VLAN_CONFIG_PRIVATE_DATA *PrivateData; + EFI_STRING ConfigRequestHdr; + EFI_STRING ConfigRequest; + BOOLEAN AllocatedRequest; + UINTN Size; + + if (Progress == NULL || Results == NULL) { + return EFI_INVALID_PARAMETER; + } + + *Progress = Request; + if ((Request != NULL) && !HiiIsConfigHdrMatch (Request, &gVlanConfigFormSetGuid, mVlanStorageName)) { + return EFI_NOT_FOUND; + } + + ConfigRequestHdr = NULL; + ConfigRequest = NULL; + AllocatedRequest = FALSE; + Size = 0; + + // + // Retrieve the pointer to the UEFI HII Config Routing Protocol + // + if (mHiiConfigRouting == NULL) { + gBS->LocateProtocol (&gEfiHiiConfigRoutingProtocolGuid, NULL, (VOID **) &mHiiConfigRouting); + } + ASSERT (mHiiConfigRouting != NULL); + + // + // Convert buffer data to by helper function BlockToConfig() + // + PrivateData = VLAN_CONFIG_PRIVATE_DATA_FROM_THIS (This); + ZeroMem (&Configuration, sizeof (VLAN_CONFIGURATION)); + BufferSize = sizeof (Configuration); + ConfigRequest = Request; + if ((Request == NULL) || (StrStr (Request, L"OFFSET") == NULL)) { + // + // Request has no request element, construct full request string. + // Allocate and fill a buffer large enough to hold the template + // followed by "&OFFSET=0&WIDTH=WWWWWWWWWWWWWWWW" followed by a Null-terminator + // + ConfigRequestHdr = HiiConstructConfigHdr (&gVlanConfigFormSetGuid, mVlanStorageName, PrivateData->DriverHandle); + Size = (StrLen (ConfigRequestHdr) + 32 + 1) * sizeof (CHAR16); + ConfigRequest = AllocateZeroPool (Size); + ASSERT (ConfigRequest != NULL); + AllocatedRequest = TRUE; + UnicodeSPrint (ConfigRequest, Size, L"%s&OFFSET=0&WIDTH=%016LX", ConfigRequestHdr, (UINT64)BufferSize); + FreePool (ConfigRequestHdr); + } + + Status = mHiiConfigRouting->BlockToConfig ( + mHiiConfigRouting, + ConfigRequest, + (UINT8 *) &Configuration, + BufferSize, + Results, + Progress + ); + // + // Free the allocated config request string. + // + if (AllocatedRequest) { + FreePool (ConfigRequest); + ConfigRequest = NULL; + } + // + // Set Progress string to the original request string. + // + if (Request == NULL) { + *Progress = NULL; + } else if (StrStr (Request, L"OFFSET") == NULL) { + *Progress = Request + StrLen (Request); + } + + return Status; +} + + +/** + This function processes the results of changes in configuration. + + @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL. + @param[in] Configuration A null-terminated Unicode string in + format. + @param[out] Progress A pointer to a string filled in with the offset of + the most recent '&' before the first failing + name/value pair (or the beginning of the string if + the failure is in the first name/value pair) or + the terminating NULL if all was successful. + + @retval EFI_SUCCESS The Results is processed successfully. + @retval EFI_INVALID_PARAMETER Configuration is NULL. + @retval EFI_NOT_FOUND Routing data doesn't match any storage in this + driver. + +**/ +EFI_STATUS +EFIAPI +VlanRouteConfig ( + IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This, + IN CONST EFI_STRING Configuration, + OUT EFI_STRING *Progress + ) +{ + if (Configuration == NULL || Progress == NULL) { + return EFI_INVALID_PARAMETER; + } + + *Progress = Configuration; + if (!HiiIsConfigHdrMatch (Configuration, &gVlanConfigFormSetGuid, mVlanStorageName)) { + return EFI_NOT_FOUND; + } + + *Progress = Configuration + StrLen (Configuration); + return EFI_SUCCESS; +} + +/** + This function processes the results of changes in configuration. + + @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL. + @param[in] Action Specifies the type of action taken by the browser. + @param[in] QuestionId A unique value which is sent to the original + exporting driver so that it can identify the type + of data to expect. + @param[in] Type The type of value for the question. + @param[in] Value A pointer to the data being sent to the original + exporting driver. + @param[out] ActionRequest On return, points to the action requested by the + callback function. + + @retval EFI_SUCCESS The callback successfully handled the action. + @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the + variable and its data. + @retval EFI_DEVICE_ERROR The variable could not be saved. + @retval EFI_UNSUPPORTED The specified Action is not supported by the + callback. + +**/ +EFI_STATUS +EFIAPI +VlanCallback ( + IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This, + IN EFI_BROWSER_ACTION Action, + IN EFI_QUESTION_ID QuestionId, + IN UINT8 Type, + IN EFI_IFR_TYPE_VALUE *Value, + OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest + ) +{ + VLAN_CONFIG_PRIVATE_DATA *PrivateData; + VLAN_CONFIGURATION *Configuration; + EFI_VLAN_CONFIG_PROTOCOL *VlanConfig; + UINTN Index; + EFI_HANDLE VlanHandle; + + PrivateData = VLAN_CONFIG_PRIVATE_DATA_FROM_THIS (This); + + if ((Action == EFI_BROWSER_ACTION_FORM_OPEN) || (Action == EFI_BROWSER_ACTION_FORM_CLOSE)) { + return EFI_SUCCESS; + } + + if ((Action != EFI_BROWSER_ACTION_CHANGED) && (Action != EFI_BROWSER_ACTION_CHANGING)) { + // + // All other action return unsupported. + // + return EFI_UNSUPPORTED; + } + + // + // Get Browser data + // + Configuration = AllocateZeroPool (sizeof (VLAN_CONFIGURATION)); + ASSERT (Configuration != NULL); + HiiGetBrowserData (&gVlanConfigFormSetGuid, mVlanStorageName, sizeof (VLAN_CONFIGURATION), (UINT8 *) Configuration); + + VlanConfig = PrivateData->VlanConfig; + + if (Action == EFI_BROWSER_ACTION_CHANGED) { + switch (QuestionId) { + case VLAN_ADD_QUESTION_ID: + // + // Add a VLAN + // + VlanConfig->Set (VlanConfig, Configuration->VlanId, Configuration->Priority); + VlanUpdateForm (PrivateData); + + // + // Connect the newly created VLAN device + // + VlanHandle = NetLibGetVlanHandle (PrivateData->ControllerHandle, Configuration->VlanId); + if (VlanHandle == NULL) { + // + // There may be no child handle created for VLAN ID 0, connect the parent handle + // + VlanHandle = PrivateData->ControllerHandle; + } + gBS->ConnectController (VlanHandle, NULL, NULL, TRUE); + + // + // Clear UI data + // + *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_APPLY; + Configuration->VlanId = 0; + Configuration->Priority = 0; + break; + + case VLAN_REMOVE_QUESTION_ID: + // + // Remove VLAN + // + ASSERT (PrivateData->NumberOfVlan <= MAX_VLAN_NUMBER); + for (Index = 0; Index < PrivateData->NumberOfVlan; Index++) { + if (Configuration->VlanList[Index] != 0) { + // + // Checkbox is selected, need remove this VLAN + // + VlanConfig->Remove (VlanConfig, PrivateData->VlanId[Index]); + } + } + + VlanUpdateForm (PrivateData); + if (PrivateData->NumberOfVlan == 0) { + // + // No VLAN device now, connect the physical NIC handle. + // Note: PrivateData->NumberOfVlan has been updated by VlanUpdateForm() + // + gBS->ConnectController (PrivateData->ControllerHandle, NULL, NULL, TRUE); + } + + *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_APPLY; + ZeroMem (Configuration->VlanList, MAX_VLAN_NUMBER); + break; + + default: + break; + } + } else if (Action == EFI_BROWSER_ACTION_CHANGING) { + switch (QuestionId) { + case VLAN_UPDATE_QUESTION_ID: + // + // Update current VLAN list into Form. + // + VlanUpdateForm (PrivateData); + break; + + default: + break; + } + } + + HiiSetBrowserData (&gVlanConfigFormSetGuid, mVlanStorageName, sizeof (VLAN_CONFIGURATION), (UINT8 *) Configuration, NULL); + FreePool (Configuration); + return EFI_SUCCESS; +} + + +/** + This function update VLAN list in the VLAN configuration Form. + + @param[in, out] PrivateData Points to VLAN configuration private data. + +**/ +VOID +VlanUpdateForm ( + IN OUT VLAN_CONFIG_PRIVATE_DATA *PrivateData + ) +{ + EFI_VLAN_CONFIG_PROTOCOL *VlanConfig; + UINT16 NumberOfVlan; + UINTN Index; + EFI_VLAN_FIND_DATA *VlanData; + VOID *StartOpCodeHandle; + EFI_IFR_GUID_LABEL *StartLabel; + VOID *EndOpCodeHandle; + EFI_IFR_GUID_LABEL *EndLabel; + CHAR16 *String; + CHAR16 VlanStr[30]; + CHAR16 VlanIdStr[6]; + UINTN DigitalCount; + EFI_STRING_ID StringId; + + // + // Find current VLAN configuration + // + VlanData = NULL; + NumberOfVlan = 0; + VlanConfig = PrivateData->VlanConfig; + VlanConfig->Find (VlanConfig, NULL, &NumberOfVlan, &VlanData); + + // + // Update VLAN configuration in PrivateData + // + if (NumberOfVlan > MAX_VLAN_NUMBER) { + NumberOfVlan = MAX_VLAN_NUMBER; + } + PrivateData->NumberOfVlan = NumberOfVlan; + + // + // Init OpCode Handle + // + StartOpCodeHandle = HiiAllocateOpCodeHandle (); + ASSERT (StartOpCodeHandle != NULL); + + EndOpCodeHandle = HiiAllocateOpCodeHandle (); + ASSERT (EndOpCodeHandle != NULL); + + // + // Create Hii Extend Label OpCode as the start opcode + // + StartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode ( + StartOpCodeHandle, + &gEfiIfrTianoGuid, + NULL, + sizeof (EFI_IFR_GUID_LABEL) + ); + StartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL; + StartLabel->Number = LABEL_VLAN_LIST; + + // + // Create Hii Extend Label OpCode as the end opcode + // + EndLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode ( + EndOpCodeHandle, + &gEfiIfrTianoGuid, + NULL, + sizeof (EFI_IFR_GUID_LABEL) + ); + EndLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL; + EndLabel->Number = LABEL_END; + + ZeroMem (PrivateData->VlanId, MAX_VLAN_NUMBER); + for (Index = 0; Index < NumberOfVlan; Index++) { + String = VlanStr; + + StrCpyS (String, (sizeof (VlanStr) /sizeof (CHAR16)), L" VLAN ID:"); + String += 10; + // + // Pad VlanId string up to 4 characters with space + // + UnicodeValueToStringS (VlanIdStr, sizeof (VlanIdStr), 0, VlanData[Index].VlanId, 5); + DigitalCount = StrnLenS (VlanIdStr, ARRAY_SIZE (VlanIdStr)); + SetMem16 (String, (4 - DigitalCount) * sizeof (CHAR16), L' '); + StrCpyS (String + 4 - DigitalCount, (sizeof (VlanStr) /sizeof (CHAR16)) - 10 - (4 - DigitalCount), VlanIdStr); + String += 4; + + StrCpyS (String, (sizeof (VlanStr) /sizeof (CHAR16)) - 10 - (4 - DigitalCount) - 4, L", Priority:"); + String += 11; + UnicodeValueToStringS ( + String, + sizeof (VlanStr) - ((UINTN)String - (UINTN)VlanStr), + 0, + VlanData[Index].Priority, + 4 + ); + String += StrnLenS (String, ARRAY_SIZE (VlanStr) - ((UINTN)String - (UINTN)VlanStr) / sizeof (CHAR16)); + *String = 0; + + StringId = HiiSetString (PrivateData->HiiHandle, 0, VlanStr, NULL); + ASSERT (StringId != 0); + + HiiCreateCheckBoxOpCode ( + StartOpCodeHandle, + (EFI_QUESTION_ID) (VLAN_LIST_VAR_OFFSET + Index), + VLAN_CONFIGURATION_VARSTORE_ID, + (UINT16) (VLAN_LIST_VAR_OFFSET + Index), + StringId, + STRING_TOKEN (STR_VLAN_VLAN_LIST_HELP), + 0, + 0, + NULL + ); + + // + // Save VLAN id to private data + // + PrivateData->VlanId[Index] = VlanData[Index].VlanId; + } + + HiiUpdateForm ( + PrivateData->HiiHandle, // HII handle + &gVlanConfigFormSetGuid, // Formset GUID + VLAN_CONFIGURATION_FORM_ID, // Form ID + StartOpCodeHandle, // Label for where to insert opcodes + EndOpCodeHandle // Replace data + ); + + HiiFreeOpCodeHandle (StartOpCodeHandle); + HiiFreeOpCodeHandle (EndOpCodeHandle); + + if (VlanData != NULL) { + FreePool (VlanData); + } +} + + +/** + This function publish the VLAN configuration Form for a network device. The + HII Config Access protocol will be installed on a child handle of the network + device. + + @param[in, out] PrivateData Points to VLAN configuration private data. + + @retval EFI_SUCCESS HII Form is installed for this network device. + @retval EFI_OUT_OF_RESOURCES Not enough resource for HII Form installation. + @retval Others Other errors as indicated. + +**/ +EFI_STATUS +InstallVlanConfigForm ( + IN OUT VLAN_CONFIG_PRIVATE_DATA *PrivateData + ) +{ + EFI_STATUS Status; + EFI_HII_HANDLE HiiHandle; + EFI_HANDLE DriverHandle; + CHAR16 Str[26 + sizeof (EFI_MAC_ADDRESS) * 2 + 1]; + CHAR16 *MacString; + EFI_DEVICE_PATH_PROTOCOL *ChildDevicePath; + EFI_HII_CONFIG_ACCESS_PROTOCOL *ConfigAccess; + EFI_VLAN_CONFIG_PROTOCOL *VlanConfig; + + // + // Create child handle and install HII Config Access Protocol + // + ChildDevicePath = AppendDevicePathNode ( + PrivateData->ParentDevicePath, + (CONST EFI_DEVICE_PATH_PROTOCOL *) &mHiiVendorDevicePathNode + ); + if (ChildDevicePath == NULL) { + return EFI_OUT_OF_RESOURCES; + } + PrivateData->ChildDevicePath = ChildDevicePath; + + DriverHandle = NULL; + ConfigAccess = &PrivateData->ConfigAccess; + Status = gBS->InstallMultipleProtocolInterfaces ( + &DriverHandle, + &gEfiDevicePathProtocolGuid, + ChildDevicePath, + &gEfiHiiConfigAccessProtocolGuid, + ConfigAccess, + NULL + ); + if (EFI_ERROR (Status)) { + return Status; + } + PrivateData->DriverHandle = DriverHandle; + + // + // Establish the parent-child relationship between the new created + // child handle and the ControllerHandle. + // + Status = gBS->OpenProtocol ( + PrivateData->ControllerHandle, + &gEfiVlanConfigProtocolGuid, + (VOID **)&VlanConfig, + PrivateData->ImageHandle, + PrivateData->DriverHandle, + EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER + ); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Publish the HII package list + // + HiiHandle = HiiAddPackages ( + &gVlanConfigFormSetGuid, + DriverHandle, + VlanConfigDxeStrings, + VlanConfigBin, + NULL + ); + if (HiiHandle == NULL) { + return EFI_OUT_OF_RESOURCES; + } + PrivateData->HiiHandle = HiiHandle; + + // + // Update formset title help string. + // + MacString = NULL; + Status = NetLibGetMacString (PrivateData->ControllerHandle, PrivateData->ImageHandle, &MacString); + if (EFI_ERROR (Status)) { + return Status; + } + PrivateData->MacString = MacString; + + StrCpyS (Str, sizeof (Str) / sizeof (CHAR16), L"VLAN Configuration (MAC:"); + StrCatS (Str, sizeof (Str) / sizeof (CHAR16), MacString); + StrCatS (Str, sizeof (Str) / sizeof (CHAR16), L")"); + HiiSetString ( + HiiHandle, + STRING_TOKEN (STR_VLAN_FORM_SET_TITLE_HELP), + Str, + NULL + ); + + // + // Update form title help string. + // + HiiSetString ( + HiiHandle, + STRING_TOKEN (STR_VLAN_FORM_HELP), + Str, + NULL + ); + + return EFI_SUCCESS; +} + +/** + This function remove the VLAN configuration Form for a network device. The + child handle for HII Config Access protocol will be destroyed. + + @param[in, out] PrivateData Points to VLAN configuration private data. + + @retval EFI_SUCCESS HII Form has been uninstalled successfully. + @retval Others Other errors as indicated. + +**/ +EFI_STATUS +UninstallVlanConfigForm ( + IN OUT VLAN_CONFIG_PRIVATE_DATA *PrivateData + ) +{ + EFI_STATUS Status; + EFI_VLAN_CONFIG_PROTOCOL *VlanConfig; + + // + // End the parent-child relationship. + // + Status = gBS->CloseProtocol ( + PrivateData->ControllerHandle, + &gEfiVlanConfigProtocolGuid, + PrivateData->ImageHandle, + PrivateData->DriverHandle + ); + if (EFI_ERROR (Status)) { + return Status; + } + + // + // Uninstall HII Config Access Protocol + // + if (PrivateData->DriverHandle != NULL) { + Status = gBS->UninstallMultipleProtocolInterfaces ( + PrivateData->DriverHandle, + &gEfiDevicePathProtocolGuid, + PrivateData->ChildDevicePath, + &gEfiHiiConfigAccessProtocolGuid, + &PrivateData->ConfigAccess, + NULL + ); + if (EFI_ERROR (Status)) { + gBS->OpenProtocol ( + PrivateData->ControllerHandle, + &gEfiVlanConfigProtocolGuid, + (VOID **)&VlanConfig, + PrivateData->ImageHandle, + PrivateData->DriverHandle, + EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER + ); + return Status; + } + PrivateData->DriverHandle = NULL; + + if (PrivateData->ChildDevicePath != NULL) { + FreePool (PrivateData->ChildDevicePath); + PrivateData->ChildDevicePath = NULL; + } + } + + // + // Free MAC string + // + if (PrivateData->MacString != NULL) { + FreePool (PrivateData->MacString); + PrivateData->MacString = NULL; + } + + // + // Uninstall HII package list + // + if (PrivateData->HiiHandle != NULL) { + HiiRemovePackages (PrivateData->HiiHandle); + PrivateData->HiiHandle = NULL; + } + return EFI_SUCCESS; +} diff --git a/NetworkPkg/VlanConfigDxe/VlanConfigImpl.h b/NetworkPkg/VlanConfigDxe/VlanConfigImpl.h new file mode 100644 index 0000000000..14f99c03b7 --- /dev/null +++ b/NetworkPkg/VlanConfigDxe/VlanConfigImpl.h @@ -0,0 +1,381 @@ +/** @file + Header file for driver binding protocol and HII config access protocol. + +Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef __VLAN_CONFIG_IMPL_H__ +#define __VLAN_CONFIG_IMPL_H__ + +#include + +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include + +#include "VlanConfigNvData.h" + +extern EFI_COMPONENT_NAME2_PROTOCOL gVlanConfigComponentName2; +extern EFI_COMPONENT_NAME_PROTOCOL gVlanConfigComponentName; + +// +// Tool generated IFR binary data and String package data +// +extern UINT8 VlanConfigBin[]; +extern UINT8 VlanConfigDxeStrings[]; + +#define VLAN_LIST_VAR_OFFSET ((UINT16) OFFSET_OF (VLAN_CONFIGURATION, VlanList)) + +typedef struct { + UINTN Signature; + + EFI_HII_CONFIG_ACCESS_PROTOCOL ConfigAccess; + EFI_HII_HANDLE HiiHandle; + EFI_HANDLE DriverHandle; + EFI_DEVICE_PATH_PROTOCOL *ChildDevicePath; + + EFI_HANDLE ControllerHandle; + EFI_HANDLE ImageHandle; + EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath; + EFI_VLAN_CONFIG_PROTOCOL *VlanConfig; + CHAR16 *MacString; + + UINT16 NumberOfVlan; + UINT16 VlanId[MAX_VLAN_NUMBER]; +} VLAN_CONFIG_PRIVATE_DATA; + +#define VLAN_CONFIG_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('V', 'C', 'P', 'D') +#define VLAN_CONFIG_PRIVATE_DATA_FROM_THIS(a) CR (a, VLAN_CONFIG_PRIVATE_DATA, ConfigAccess, VLAN_CONFIG_PRIVATE_DATA_SIGNATURE) + +extern VLAN_CONFIG_PRIVATE_DATA mVlanConfigPrivateDateTemplate; + + +/** + Retrieves a Unicode string that is the user readable name of the driver. + + This function retrieves the user readable name of a driver in the form of a + Unicode string. If the driver specified by This has a user readable name in + the language specified by Language, then a pointer to the driver name is + returned in DriverName, and EFI_SUCCESS is returned. If the driver specified + by This does not support the language specified by Language, + then EFI_UNSUPPORTED is returned. + + @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + @param Language[in] A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified + in RFC 4646 or ISO 639-2 language code format. + @param DriverName[out] A pointer to the Unicode string to return. + This Unicode string is the name of the + driver specified by This in the language + specified by Language. + + @retval EFI_SUCCESS The Unicode string for the Driver specified by + This and the language specified by Language was + returned in DriverName. + @retval EFI_INVALID_PARAMETER Language is NULL. + @retval EFI_INVALID_PARAMETER DriverName is NULL. + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +VlanConfigComponentNameGetDriverName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN CHAR8 *Language, + OUT CHAR16 **DriverName + ); + +/** + Retrieves a Unicode string that is the user readable name of the controller + that is being managed by a driver. + + This function retrieves the user readable name of the controller specified by + ControllerHandle and ChildHandle in the form of a Unicode string. If the + driver specified by This has a user readable name in the language specified by + Language, then a pointer to the controller name is returned in ControllerName, + and EFI_SUCCESS is returned. If the driver specified by This is not currently + managing the controller specified by ControllerHandle and ChildHandle, + then EFI_UNSUPPORTED is returned. If the driver specified by This does not + support the language specified by Language, then EFI_UNSUPPORTED is returned. + + @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or + EFI_COMPONENT_NAME_PROTOCOL instance. + @param ControllerHandle[in] The handle of a controller that the driver + specified by This is managing. This handle + specifies the controller whose name is to be + returned. + @param ChildHandle[in] The handle of the child controller to retrieve + the name of. This is an optional parameter that + may be NULL. It will be NULL for device + drivers. It will also be NULL for a bus drivers + that wish to retrieve the name of the bus + controller. It will not be NULL for a bus + driver that wishes to retrieve the name of a + child controller. + @param Language[in] A pointer to a Null-terminated ASCII string + array indicating the language. This is the + language of the driver name that the caller is + requesting, and it must match one of the + languages specified in SupportedLanguages. The + number of languages supported by a driver is up + to the driver writer. Language is specified in + RFC 4646 or ISO 639-2 language code format. + @param ControllerName[out] A pointer to the Unicode string to return. + This Unicode string is the name of the + controller specified by ControllerHandle and + ChildHandle in the language specified by + Language from the point of view of the driver + specified by This. + + @retval EFI_SUCCESS The Unicode string for the user readable name in + the language specified by Language for the + driver specified by This was returned in + DriverName. + @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. + @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid + EFI_HANDLE. + @retval EFI_INVALID_PARAMETER Language is NULL. + @retval EFI_INVALID_PARAMETER ControllerName is NULL. + @retval EFI_UNSUPPORTED The driver specified by This is not currently + managing the controller specified by + ControllerHandle and ChildHandle. + @retval EFI_UNSUPPORTED The driver specified by This does not support + the language specified by Language. + +**/ +EFI_STATUS +EFIAPI +VlanConfigComponentNameGetControllerName ( + IN EFI_COMPONENT_NAME_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_HANDLE ChildHandle OPTIONAL, + IN CHAR8 *Language, + OUT CHAR16 **ControllerName + ); + +/** + Test to see if this driver supports ControllerHandle. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to test + @param[in] RemainingDevicePath Optional parameter use to pick a specific child + device to start. + + @retval EFI_SUCCES This driver supports this device + @retval EFI_ALREADY_STARTED This driver is already running on this device + @retval other This driver does not support this device + +**/ +EFI_STATUS +EFIAPI +VlanConfigDriverBindingSupported ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL + ); + +/** + Start this driver on ControllerHandle. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to bind driver to + @param[in] RemainingDevicePath Optional parameter use to pick a specific child + device to start. + + @retval EFI_SUCCES This driver is added to ControllerHandle + @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle + @retval other This driver does not support this device + +**/ +EFI_STATUS +EFIAPI +VlanConfigDriverBindingStart ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL + ); + +/** + Stop this driver on ControllerHandle. + + @param[in] This Protocol instance pointer. + @param[in] ControllerHandle Handle of device to stop driver on + @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number + of children is zero stop the entire bus driver. + @param[in] ChildHandleBuffer List of Child Handles to Stop. + + @retval EFI_SUCCES This driver is removed ControllerHandle + @retval other This driver was not removed from this device + +**/ +EFI_STATUS +EFIAPI +VlanConfigDriverBindingStop ( + IN EFI_DRIVER_BINDING_PROTOCOL *This, + IN EFI_HANDLE ControllerHandle, + IN UINTN NumberOfChildren, + IN EFI_HANDLE *ChildHandleBuffer + ); + +/** + This function update VLAN list in the VLAN configuration Form. + + @param[in, out] PrivateData Points to VLAN configuration private data. + +**/ +VOID +VlanUpdateForm ( + IN OUT VLAN_CONFIG_PRIVATE_DATA *PrivateData + ); + +/** + This function publish the VLAN configuration Form for a network device. The + HII Config Access protocol will be installed on a child handle of the network + device. + + @param[in, out] PrivateData Points to VLAN configuration private data. + + @retval EFI_SUCCESS HII Form is installed for this network device. + @retval EFI_OUT_OF_RESOURCES Not enough resource for HII Form installation. + @retval Others Other errors as indicated. + +**/ +EFI_STATUS +InstallVlanConfigForm ( + IN OUT VLAN_CONFIG_PRIVATE_DATA *PrivateData + ); + +/** + This function remove the VLAN configuration Form for a network device. The + child handle for HII Config Access protocol will be destroyed. + + @param[in, out] PrivateData Points to VLAN configuration private data. + + @retval EFI_SUCCESS HII Form has been uninstalled successfully. + @retval Others Other errors as indicated. + +**/ +EFI_STATUS +UninstallVlanConfigForm ( + IN OUT VLAN_CONFIG_PRIVATE_DATA *PrivateData + ); + +/** + This function allows a caller to extract the current configuration for one + or more named elements from the target driver. + + @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL. + @param[in] Request A null-terminated Unicode string in + format. + @param[out] Progress On return, points to a character in the Request + string. Points to the string's null terminator if + request was successful. Points to the most recent + '&' before the first failing name/value pair (or + the beginning of the string if the failure is in + the first name/value pair) if the request was not + successful. + @param[out] Results A null-terminated Unicode string in + format which has all values filled + in for the names in the Request string. String to + be allocated by the called function. + + @retval EFI_SUCCESS The Results is filled with the requested values. + @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results. + @retval EFI_INVALID_PARAMETER Request is NULL, illegal syntax, or unknown name. + @retval EFI_NOT_FOUND Routing data doesn't match any storage in this + driver. + +**/ +EFI_STATUS +EFIAPI +VlanExtractConfig ( + IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This, + IN CONST EFI_STRING Request, + OUT EFI_STRING *Progress, + OUT EFI_STRING *Results + ); + +/** + This function processes the results of changes in configuration. + + @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL. + @param[in] Configuration A null-terminated Unicode string in + format. + @param[out] Progress A pointer to a string filled in with the offset of + the most recent '&' before the first failing + name/value pair (or the beginning of the string if + the failure is in the first name/value pair) or + the terminating NULL if all was successful. + + @retval EFI_SUCCESS The Results is processed successfully. + @retval EFI_INVALID_PARAMETER Configuration is NULL. + @retval EFI_NOT_FOUND Routing data doesn't match any storage in this + driver. + +**/ +EFI_STATUS +EFIAPI +VlanRouteConfig ( + IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This, + IN CONST EFI_STRING Configuration, + OUT EFI_STRING *Progress + ); + +/** + This function processes the results of changes in configuration. + + @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL. + @param[in] Action Specifies the type of action taken by the browser. + @param[in] QuestionId A unique value which is sent to the original + exporting driver so that it can identify the type + of data to expect. + @param[in] Type The type of value for the question. + @param[in] Value A pointer to the data being sent to the original + exporting driver. + @param[out] ActionRequest On return, points to the action requested by the + callback function. + + @retval EFI_SUCCESS The callback successfully handled the action. + @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the + variable and its data. + @retval EFI_DEVICE_ERROR The variable could not be saved. + @retval EFI_UNSUPPORTED The specified Action is not supported by the + callback. + +**/ +EFI_STATUS +EFIAPI +VlanCallback ( + IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This, + IN EFI_BROWSER_ACTION Action, + IN EFI_QUESTION_ID QuestionId, + IN UINT8 Type, + IN EFI_IFR_TYPE_VALUE *Value, + OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest + ); + +#endif diff --git a/NetworkPkg/VlanConfigDxe/VlanConfigNvData.h b/NetworkPkg/VlanConfigDxe/VlanConfigNvData.h new file mode 100644 index 0000000000..00b5486901 --- /dev/null +++ b/NetworkPkg/VlanConfigDxe/VlanConfigNvData.h @@ -0,0 +1,40 @@ +/** @file + Header file for NV data structure definition. + +Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef __VLAN_CONFIG_NV_DATA_H__ +#define __VLAN_CONFIG_NV_DATA_H__ + +#include +#include + +#define VLAN_CONFIGURATION_VARSTORE_ID 0x0001 +#define VLAN_CONFIGURATION_FORM_ID 0x0001 +#define VLAN_HEAD_FORM_ID 0x0002 + +#define VLAN_ADD_QUESTION_ID 0x1000 +#define VLAN_REMOVE_QUESTION_ID 0x2000 +#define VLAN_UPDATE_QUESTION_ID 0x3000 + +#define LABEL_VLAN_LIST 0x0001 +#define LABEL_END 0xffff + +// +// The maximum number of VLAN that will be displayed on the menu +// +#define MAX_VLAN_NUMBER 100 + +// +// Nv Data structure referenced by IFR +// +typedef struct { + UINT16 VlanId; + UINT8 Priority; + UINT8 VlanList[MAX_VLAN_NUMBER]; +} VLAN_CONFIGURATION; + +#endif diff --git a/NetworkPkg/VlanConfigDxe/VlanConfigStrings.uni b/NetworkPkg/VlanConfigDxe/VlanConfigStrings.uni new file mode 100644 index 0000000000..1ccfd60016 --- /dev/null +++ b/NetworkPkg/VlanConfigDxe/VlanConfigStrings.uni @@ -0,0 +1,31 @@ +///** @file +// String definitions for VLAN Configuration Form. +// +// Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.
+// SPDX-License-Identifier: BSD-2-Clause-Patent +// +//**/ + +/=# + +#langdef en-US "English" + +#string STR_VLAN_FORM_SET_TITLE #language en-US "VLAN Configuration" +#string STR_VLAN_FORM_SET_TITLE_HELP #language en-US "VLAN configuration for this network device" +#string STR_VLAN_FORM_TITLE #language en-US "VLAN Configuration" +#string STR_VLAN_FORM_HELP #language en-US "VLAN Configuration Help" +#string STR_VLAN_CREATE_VLAN #language en-US "Create new VLAN" + +#string STR_VLAN_VID_PROMPT #language en-US " VLAN ID" +#string STR_VLAN_VID_HELP #language en-US "VLAN ID of new VLAN or existing VLAN, valid value is 0~4094" +#string STR_VLAN_PRIORITY_PROMPT #language en-US " Priority" +#string STR_VLAN_PRIORITY_HELP #language en-US "802.1Q Priority, valid value is 0~7" +#string STR_VLAN_ADD_VLAN_PROMPT #language en-US "Add VLAN" +#string STR_VLAN_ADD_VLAN_HELP #language en-US "Create a new VLAN or update existing VLAN" +#string STR_VLAN_VLAN_LIST #language en-US "Configured VLAN List" +#string STR_VLAN_VLAN_LIST_HELP #language en-US "Select for remove" +#string STR_VLAN_REMOVE_VLAN_PROMPT #language en-US "Remove VLAN" +#string STR_VLAN_REMOVE_VLAN_HELP #language en-US "Remove selected VLANs" +#string STR_VLAN_NULL_STRING #language en-US "" +#string STR_GET_CURRENT_SETTING #language en-US "Enter Configuration Menu" +#string STR_GET_CURRENT_SETTING_HELP #language en-US "Press ENTER to enter configuration menu for VLAN configuration."