/** @file\r
This file implement the EFI_DHCP4_PROTOCOL interface.\r
- \r
-Copyright (c) 2006 - 2009, Intel Corporation.<BR>\r
-All rights reserved. This program and the accompanying materials\r
+\r
+Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
/**\r
Returns the current operating mode and cached data packet for the EFI DHCPv4 Protocol driver.\r
- \r
+\r
The GetModeData() function returns the current operating mode and cached data\r
packet for the EFI DHCPv4 Protocol driver.\r
\r
EfiDhcp4Configure (\r
IN EFI_DHCP4_PROTOCOL *This,\r
IN EFI_DHCP4_CONFIG_DATA *Dhcp4CfgData OPTIONAL\r
- ); \r
+ );\r
\r
/**\r
Starts the DHCP configuration process.\r
time when each event occurs in this process, the callback function that was set\r
by EFI_DHCP4_PROTOCOL.Configure() will be called and the user can take this\r
opportunity to control the process.\r
- \r
+\r
@param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
@param[in] CompletionEvent If not NULL, indicates the event that will be signaled when the\r
EFI DHCPv4 Protocol driver is transferred into the\r
\r
/**\r
Extends the lease time by sending a request packet.\r
- \r
+\r
The RenewRebind() function is used to manually extend the lease time when the\r
EFI DHCPv4 Protocol driver is in the Dhcp4Bound state and the lease time has\r
not expired yet. This function will send a request packet to the previously\r
\r
/**\r
Stops the current address configuration.\r
- \r
+\r
The Stop() function is used to stop the DHCP configuration process. After this\r
function is called successfully, the EFI DHCPv4 Protocol driver is transferred\r
into the Dhcp4Stopped state. EFI_DHCP4_PROTOCOL.Configure() needs to be called\r
IN EFI_DHCP4_PACKET_OPTION *AppendList[] OPTIONAL,\r
OUT EFI_DHCP4_PACKET **NewPacket\r
);\r
- \r
+\r
/**\r
Transmits a DHCP formatted packet and optionally waits for responses.\r
- \r
+\r
The TransmitReceive() function is used to transmit a DHCP packet and optionally\r
wait for the response from servers. This function does not change the state of\r
the EFI DHCPv4 Protocol driver and thus can be used at any time.\r
\r
/**\r
Parses the packed DHCP option data.\r
- \r
+\r
The Parse() function is used to retrieve the option list from a DHCP packet.\r
If *OptionCount isn't zero, and there is enough space for all the DHCP options\r
in the Packet, each element of PacketOptionList is set to point to somewhere in\r
\r
/**\r
Returns the current operating mode and cached data packet for the EFI DHCPv4 Protocol driver.\r
- \r
+\r
The GetModeData() function returns the current operating mode and cached data\r
packet for the EFI DHCPv4 Protocol driver.\r
\r
UINT32 Index;\r
\r
if (Config->DiscoverTimeout != NULL) {\r
- gBS->FreePool (Config->DiscoverTimeout);\r
+ FreePool (Config->DiscoverTimeout);\r
}\r
\r
if (Config->RequestTimeout != NULL) {\r
- gBS->FreePool (Config->RequestTimeout);\r
+ FreePool (Config->RequestTimeout);\r
}\r
\r
if (Config->OptionList != NULL) {\r
for (Index = 0; Index < Config->OptionCount; Index++) {\r
if (Config->OptionList[Index] != NULL) {\r
- gBS->FreePool (Config->OptionList[Index]);\r
+ FreePool (Config->OptionList[Index]);\r
}\r
}\r
\r
- gBS->FreePool (Config->OptionList);\r
+ FreePool (Config->OptionList);\r
}\r
\r
ZeroMem (Config, sizeof (EFI_DHCP4_CONFIG_DATA));\r
{\r
EFI_DHCP4_PACKET_OPTION **DstOptions;\r
EFI_DHCP4_PACKET_OPTION **SrcOptions;\r
- INTN Len;\r
+ UINTN Len;\r
UINT32 Index;\r
\r
CopyMem (Dst, Src, sizeof (*Dst));\r
DhcpSb->ActiveChild = NULL;\r
\r
if (Config->DiscoverTimeout != NULL) {\r
- gBS->FreePool (Config->DiscoverTimeout);\r
+ FreePool (Config->DiscoverTimeout);\r
\r
Config->DiscoverTryCount = 0;\r
Config->DiscoverTimeout = NULL;\r
}\r
\r
if (Config->RequestTimeout != NULL) {\r
- gBS->FreePool (Config->RequestTimeout);\r
+ FreePool (Config->RequestTimeout);\r
\r
Config->RequestTryCount = 0;\r
Config->RequestTimeout = NULL;\r
}\r
\r
if (Dhcp4CfgData != NULL) {\r
- if (Dhcp4CfgData->DiscoverTryCount && (Dhcp4CfgData->DiscoverTimeout == NULL)) {\r
+ if ((Dhcp4CfgData->DiscoverTryCount != 0) && (Dhcp4CfgData->DiscoverTimeout == NULL)) {\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
- if (Dhcp4CfgData->RequestTryCount && (Dhcp4CfgData->RequestTimeout == NULL)) {\r
+ if ((Dhcp4CfgData->RequestTryCount != 0) && (Dhcp4CfgData->RequestTimeout == NULL)) {\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
- if (Dhcp4CfgData->OptionCount && (Dhcp4CfgData->OptionList == NULL)) {\r
+ if ((Dhcp4CfgData->OptionCount != 0) && (Dhcp4CfgData->OptionList == NULL)) {\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
CopyMem (&Ip, &Dhcp4CfgData->ClientAddress, sizeof (IP4_ADDR));\r
\r
- if ((Ip != 0) && !Ip4IsUnicast (NTOHL (Ip), 0)) {\r
+ if ((Ip != 0) && !NetIp4IsUnicast (NTOHL (Ip), 0)) {\r
\r
return EFI_INVALID_PARAMETER;\r
}\r
time when each event occurs in this process, the callback function that was set\r
by EFI_DHCP4_PROTOCOL.Configure() will be called and the user can take this\r
opportunity to control the process.\r
- \r
+\r
@param[in] This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
@param[in] CompletionEvent If not NULL, indicates the event that will be signaled when the\r
EFI DHCPv4 Protocol driver is transferred into the\r
@retval EFI_ALREADY_STARTED Some other EFI DHCPv4 Protocol instance already started the\r
DHCP process.\r
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
+ @retval EFI_NO_MEDIA There was a media error.\r
\r
**/\r
EFI_STATUS\r
goto ON_ERROR;\r
}\r
\r
- //\r
- // Start/Restart the receiving.\r
- //\r
- Status = UdpIoRecvDatagram (DhcpSb->UdpIo, DhcpInput, DhcpSb, 0);\r
-\r
- if (EFI_ERROR (Status) && (Status != EFI_ALREADY_STARTED)) {\r
- goto ON_ERROR;\r
- }\r
\r
Instance->CompletionEvent = CompletionEvent;\r
\r
\r
if (CompletionEvent == NULL) {\r
while (DhcpSb->IoStatus == EFI_ALREADY_STARTED) {\r
- DhcpSb->UdpIo->Udp->Poll (DhcpSb->UdpIo->Udp);\r
+ DhcpSb->UdpIo->Protocol.Udp4->Poll (DhcpSb->UdpIo->Protocol.Udp4);\r
}\r
\r
return DhcpSb->IoStatus;\r
\r
/**\r
Extends the lease time by sending a request packet.\r
- \r
+\r
The RenewRebind() function is used to manually extend the lease time when the\r
EFI DHCPv4 Protocol driver is in the Dhcp4Bound state and the lease time has\r
not expired yet. This function will send a request packet to the previously\r
\r
if (DhcpSb->DhcpState == Dhcp4Stopped) {\r
Status = EFI_NOT_STARTED;\r
- goto ON_ERROR;\r
+ goto ON_EXIT;\r
}\r
\r
if (DhcpSb->DhcpState != Dhcp4Bound) {\r
Status = EFI_ACCESS_DENIED;\r
- goto ON_ERROR;\r
+ goto ON_EXIT;\r
}\r
\r
if (DHCP_IS_BOOTP (DhcpSb->Para)) {\r
- return EFI_SUCCESS;\r
+ Status = EFI_SUCCESS;\r
+ goto ON_EXIT;\r
}\r
\r
//\r
DhcpSetState (DhcpSb, Dhcp4Rebinding, FALSE);\r
}\r
\r
+ //\r
+ // Clear initial time to make sure that elapsed-time\r
+ // is set to 0 for first REQUEST in renewal process.\r
+ //\r
+ Instance->ElaspedTime = 0;\r
+\r
Status = DhcpSendMessage (\r
DhcpSb,\r
DhcpSb->Selected,\r
\r
if (EFI_ERROR (Status)) {\r
DhcpSetState (DhcpSb, Dhcp4Bound, FALSE);\r
- goto ON_ERROR;\r
+ goto ON_EXIT;\r
}\r
\r
DhcpSb->ExtraRefresh = TRUE;\r
\r
if (CompletionEvent == NULL) {\r
while (DhcpSb->IoStatus == EFI_ALREADY_STARTED) {\r
- DhcpSb->UdpIo->Udp->Poll (DhcpSb->UdpIo->Udp);\r
+ DhcpSb->UdpIo->Protocol.Udp4->Poll (DhcpSb->UdpIo->Protocol.Udp4);\r
+\r
}\r
\r
return DhcpSb->IoStatus;\r
\r
return EFI_SUCCESS;\r
\r
-ON_ERROR:\r
+ON_EXIT:\r
gBS->RestoreTPL (OldTpl);\r
return Status;\r
}\r
\r
/**\r
Stops the current address configuration.\r
- \r
+\r
The Stop() function is used to stop the DHCP configuration process. After this\r
function is called successfully, the EFI DHCPv4 Protocol driver is transferred\r
into the Dhcp4Stopped state. EFI_DHCP4_PROTOCOL.Configure() needs to be called\r
\r
/**\r
Callback by UdpIoCreatePort() when creating UdpIo for this Dhcp4 instance.\r
- \r
+\r
@param[in] UdpIo The UdpIo being created.\r
@param[in] Context Dhcp4 instance.\r
- \r
+\r
@retval EFI_SUCCESS UdpIo is configured successfully.\r
@retval other Other error occurs.\r
**/\r
EFI_STATUS\r
+EFIAPI\r
Dhcp4InstanceConfigUdpIo (\r
- IN UDP_IO_PORT *UdpIo,\r
+ IN UDP_IO *UdpIo,\r
IN VOID *Context\r
)\r
{\r
DHCP_SERVICE *DhcpSb;\r
EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN *Token;\r
EFI_UDP4_CONFIG_DATA UdpConfigData;\r
- IP4_ADDR Ip;\r
+ IP4_ADDR ClientAddr;\r
+ IP4_ADDR Ip; \r
+ INTN Class; \r
+ IP4_ADDR SubnetMask;\r
\r
Instance = (DHCP_PROTOCOL *) Context;\r
DhcpSb = Instance->Service;\r
UdpConfigData.TimeToLive = 64;\r
UdpConfigData.DoNotFragment = TRUE;\r
\r
- Ip = HTONL (DhcpSb->ClientAddr);\r
+ ClientAddr = EFI_NTOHL (Token->Packet->Dhcp4.Header.ClientAddr);\r
+ Ip = HTONL (ClientAddr);\r
CopyMem (&UdpConfigData.StationAddress, &Ip, sizeof (EFI_IPv4_ADDRESS));\r
-\r
- Ip = HTONL (DhcpSb->Netmask);\r
+ \r
+ Class = NetGetIpClass (ClientAddr);\r
+ ASSERT (Class < IP4_ADDR_CLASSE);\r
+ SubnetMask = gIp4AllMasks[Class << 3];\r
+ Ip = HTONL (SubnetMask);\r
CopyMem (&UdpConfigData.SubnetMask, &Ip, sizeof (EFI_IPv4_ADDRESS));\r
\r
if ((Token->ListenPointCount == 0) || (Token->ListenPoints[0].ListenPort == 0)) {\r
UdpConfigData.StationPort = Token->ListenPoints[0].ListenPort;\r
}\r
\r
- return UdpIo->Udp->Configure (UdpIo->Udp, &UdpConfigData);\r
+ return UdpIo->Protocol.Udp4->Configure (UdpIo->Protocol.Udp4, &UdpConfigData);\r
}\r
\r
/**\r
Create UdpIo for this Dhcp4 instance.\r
- \r
+\r
@param Instance The Dhcp4 instance.\r
- \r
+\r
@retval EFI_SUCCESS UdpIo is created successfully.\r
@retval EFI_OUT_OF_RESOURCES Fails to create UdpIo because of limited\r
resources or configuration failure.\r
)\r
{\r
DHCP_SERVICE *DhcpSb;\r
+ EFI_STATUS Status;\r
+ VOID *Udp4;\r
\r
ASSERT (Instance->Token != NULL);\r
\r
DhcpSb = Instance->Service;\r
- Instance->UdpIo = UdpIoCreatePort (DhcpSb->Controller, DhcpSb->Image, Dhcp4InstanceConfigUdpIo, Instance);\r
+ Instance->UdpIo = UdpIoCreateIo (\r
+ DhcpSb->Controller,\r
+ DhcpSb->Image,\r
+ Dhcp4InstanceConfigUdpIo,\r
+ UDP_IO_UDP4_VERSION,\r
+ Instance\r
+ );\r
if (Instance->UdpIo == NULL) {\r
return EFI_OUT_OF_RESOURCES;\r
} else {\r
- return EFI_SUCCESS;\r
+ Status = gBS->OpenProtocol (\r
+ Instance->UdpIo->UdpHandle,\r
+ &gEfiUdp4ProtocolGuid,\r
+ (VOID **) &Udp4,\r
+ Instance->Service->Image,\r
+ Instance->Handle,\r
+ EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ UdpIoFreeIo (Instance->UdpIo);\r
+ Instance->UdpIo = NULL;\r
+ }\r
+ return Status;\r
}\r
}\r
\r
/**\r
Callback of Dhcp packet. Does nothing.\r
- \r
+\r
@param Arg The context.\r
\r
**/\r
VOID\r
+EFIAPI\r
DhcpDummyExtFree (\r
IN VOID *Arg\r
)\r
\r
/**\r
Callback of UdpIoRecvDatagram() that handles a Dhcp4 packet.\r
- \r
+\r
Only BOOTP responses will be handled that correspond to the Xid of the request\r
sent out. The packet will be queued to the response queue.\r
- \r
+\r
@param UdpPacket The Dhcp4 packet.\r
- @param Points Udp4 address pair.\r
+ @param EndPoint Udp4 address pair.\r
@param IoStatus Status of the input.\r
@param Context Extra info for the input.\r
- \r
+\r
**/\r
VOID\r
+EFIAPI\r
PxeDhcpInput (\r
NET_BUF *UdpPacket,\r
- UDP_POINTS *Points,\r
+ UDP_END_POINT *EndPoint,\r
EFI_STATUS IoStatus,\r
VOID *Context\r
)\r
//\r
if ((Head->OpCode != BOOTP_REPLY) ||\r
(Head->Xid != Token->Packet->Dhcp4.Header.Xid) ||\r
- (CompareMem (DhcpSb->ClientAddressSendOut, Head->ClientHwAddr, Head->HwAddrLen) != 0)) {\r
+ (CompareMem (&Token->Packet->Dhcp4.Header.ClientHwAddr[0], Head->ClientHwAddr, Head->HwAddrLen) != 0)) {\r
goto RESTART;\r
}\r
\r
\r
/**\r
Complete a Dhcp4 transaction and signal the upper layer.\r
- \r
+\r
@param Instance Dhcp4 instance.\r
\r
**/\r
// Clean up the resources dedicated for this transmit receive transaction.\r
//\r
NetbufQueFlush (&Instance->ResponseQueue);\r
- UdpIoCleanPort (Instance->UdpIo);\r
- UdpIoFreePort (Instance->UdpIo);\r
+ UdpIoCleanIo (Instance->UdpIo);\r
+ gBS->CloseProtocol (\r
+ Instance->UdpIo->UdpHandle,\r
+ &gEfiUdp4ProtocolGuid,\r
+ Instance->Service->Image,\r
+ Instance->Handle\r
+ );\r
+ UdpIoFreeIo (Instance->UdpIo);\r
Instance->UdpIo = NULL;\r
Instance->Token = NULL;\r
\r
\r
/**\r
Transmits a DHCP formatted packet and optionally waits for responses.\r
- \r
+\r
The TransmitReceive() function is used to transmit a DHCP packet and optionally\r
wait for the response from servers. This function does not change the state of\r
the EFI DHCPv4 Protocol driver and thus can be used at any time.\r
EFI_STATUS Status;\r
NET_FRAGMENT Frag;\r
NET_BUF *Wrap;\r
- UDP_POINTS EndPoint;\r
+ UDP_END_POINT EndPoint;\r
IP4_ADDR Ip;\r
DHCP_SERVICE *DhcpSb;\r
- IP4_ADDR Gateway;\r
+ EFI_IP_ADDRESS Gateway;\r
+ IP4_ADDR ClientAddr;\r
+ INTN Class;\r
IP4_ADDR SubnetMask;\r
\r
if ((This == NULL) || (Token == NULL) || (Token->Packet == NULL)) {\r
\r
Instance = DHCP_INSTANCE_FROM_THIS (This);\r
DhcpSb = Instance->Service;\r
+ DhcpSb->ActiveChild = Instance;\r
\r
if (Instance->Token != NULL) {\r
//\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
- if (DhcpSb->ClientAddr == 0) {\r
-\r
+ ClientAddr = EFI_NTOHL (Token->Packet->Dhcp4.Header.ClientAddr);\r
+ \r
+ if (ClientAddr == 0) {\r
return EFI_NO_MAPPING;\r
}\r
\r
}\r
\r
//\r
- // Set the local address and local port.\r
+ // Set the local address and local port to ZERO.\r
//\r
- EndPoint.LocalAddr = 0;\r
- EndPoint.LocalPort = 0;\r
+ ZeroMem (&EndPoint, sizeof (UDP_END_POINT));\r
\r
//\r
// Set the destination address and destination port.\r
//\r
CopyMem (&Ip, &Token->RemoteAddress, sizeof (EFI_IPv4_ADDRESS));\r
- EndPoint.RemoteAddr = NTOHL (Ip);\r
+ EndPoint.RemoteAddr.Addr[0] = NTOHL (Ip);\r
\r
if (Token->RemotePort == 0) {\r
EndPoint.RemotePort = DHCP_SERVER_PORT;\r
//\r
// Get the gateway.\r
//\r
- SubnetMask = DhcpSb->Netmask;\r
- Gateway = 0;\r
- if (!IP4_NET_EQUAL (DhcpSb->ClientAddr, EndPoint.RemoteAddr, SubnetMask)) {\r
- CopyMem (&Gateway, &Token->GatewayAddress, sizeof (EFI_IPv4_ADDRESS));\r
- Gateway = NTOHL (Gateway);\r
+ Class = NetGetIpClass (ClientAddr);\r
+ ASSERT (Class < IP4_ADDR_CLASSE);\r
+ SubnetMask = gIp4AllMasks[Class << 3];\r
+ ZeroMem (&Gateway, sizeof (Gateway));\r
+ if (!IP4_NET_EQUAL (ClientAddr, EndPoint.RemoteAddr.Addr[0], SubnetMask)) {\r
+ CopyMem (&Gateway.v4, &Token->GatewayAddress, sizeof (EFI_IPv4_ADDRESS));\r
+ Gateway.Addr[0] = NTOHL (Gateway.Addr[0]);\r
}\r
\r
//\r
// Transmit the DHCP packet.\r
//\r
- Status = UdpIoSendDatagram (Instance->UdpIo, Wrap, &EndPoint, Gateway, DhcpOnPacketSent, NULL);\r
+ Status = UdpIoSendDatagram (Instance->UdpIo, Wrap, &EndPoint, &Gateway, DhcpOnPacketSent, NULL);\r
if (EFI_ERROR (Status)) {\r
NetbufFree (Wrap);\r
goto ON_ERROR;\r
ON_ERROR:\r
\r
if (EFI_ERROR (Status) && (Instance->UdpIo != NULL)) {\r
- UdpIoCleanPort (Instance->UdpIo);\r
- UdpIoFreePort (Instance->UdpIo);\r
+ UdpIoCleanIo (Instance->UdpIo);\r
+ gBS->CloseProtocol (\r
+ Instance->UdpIo->UdpHandle,\r
+ &gEfiUdp4ProtocolGuid,\r
+ Instance->Service->Image,\r
+ Instance->Handle\r
+ );\r
+ UdpIoFreeIo (Instance->UdpIo);\r
Instance->UdpIo = NULL;\r
Instance->Token = NULL;\r
}\r
// Keep polling until timeout if no error happens and the CompletionEvent\r
// is NULL.\r
//\r
- while (Instance->Timeout != 0) {\r
- Instance->UdpIo->Udp->Poll (Instance->UdpIo->Udp);\r
+ while (TRUE) {\r
+ OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
+ //\r
+ // Raise TPL to protect the UDPIO in instance, in case that DhcpOnTimerTick\r
+ // free it when timeout.\r
+ //\r
+ if (Instance->Timeout > 0) {\r
+ Instance->UdpIo->Protocol.Udp4->Poll (Instance->UdpIo->Protocol.Udp4);\r
+ gBS->RestoreTPL (OldTpl);\r
+ } else {\r
+ gBS->RestoreTPL (OldTpl);\r
+ break;\r
+ }\r
}\r
}\r
\r
\r
/**\r
Parses the packed DHCP option data.\r
- \r
+\r
The Parse() function is used to retrieve the option list from a DHCP packet.\r
If *OptionCount isn't zero, and there is enough space for all the DHCP options\r
in the Packet, each element of PacketOptionList is set to point to somewhere in\r
\r
return EFI_SUCCESS;\r
}\r
+\r
+/**\r
+ Set the elapsed time based on the given instance and the pointer to the\r
+ elapsed time option.\r
+\r
+ @param[in] Elapsed The pointer to the position to append.\r
+ @param[in] Instance The pointer to the Dhcp4 instance.\r
+**/\r
+VOID\r
+SetElapsedTime (\r
+ IN UINT16 *Elapsed,\r
+ IN DHCP_PROTOCOL *Instance\r
+ )\r
+{\r
+ WriteUnaligned16 (Elapsed, HTONS(Instance->ElaspedTime));\r
+}\r
projects / mirror_edk2.git / blobdiff