/** @file\r
+ The driver binding and service binding protocol for IP4 driver.\r
\r
-Copyright (c) 2005 - 2006, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2005 - 2010, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
-Module Name:\r
-\r
- Ip4Driver.c\r
-\r
-Abstract:\r
-\r
- The driver binding and service binding protocol for IP4 driver.\r
-\r
-\r
**/\r
\r
#include "Ip4Impl.h"\r
NULL\r
};\r
\r
-EFI_STATUS\r
-EFIAPI\r
-Ip4DriverEntryPoint (\r
- IN EFI_HANDLE ImageHandle,\r
- IN EFI_SYSTEM_TABLE *SystemTable\r
- )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
+ This is the declaration of an EFI image entry point. This entry point is\r
+ the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including\r
+ both device drivers and bus drivers.\r
\r
The entry point for IP4 driver which install the driver\r
binding and component name protocol on its image.\r
\r
-Arguments:\r
+ @param[in] ImageHandle The firmware allocated handle for the UEFI image.\r
+ @param[in] SystemTable A pointer to the EFI System Table.\r
\r
- ImageHandle - The image handle of the driver\r
- SystemTable - The system table\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
+ @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r
\r
-Returns:\r
-\r
- EFI_SUCCESS if the driver binding and component name protocols\r
- are successfully installed, otherwise if failed.\r
-\r
---*/\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+Ip4DriverEntryPoint (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ )\r
{\r
return EfiLibInstallDriverBindingComponentName2 (\r
ImageHandle,\r
);\r
}\r
\r
-\r
/**\r
- Test to see if this driver supports ControllerHandle.\r
-\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to test\r
- @param RemainingDevicePath Optional parameter use to pick a specific child\r
- device to start.\r
-\r
- @retval EFI_SUCCES This driver supports this device\r
- @retval EFI_ALREADY_STARTED This driver is already running on this device\r
- @retval other This driver does not support this device\r
+ Test to see if this driver supports ControllerHandle. This service\r
+ is called by the EFI boot service ConnectController(). In\r
+ order to make drivers as small as possible, there are a few calling\r
+ restrictions for this service. ConnectController() must\r
+ follow these calling restrictions. If any other agent wishes to call\r
+ Supported() it must also follow these calling restrictions.\r
+\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to test\r
+ @param[in] RemainingDevicePath Optional parameter use to pick a specific child\r
+ device to start.\r
+\r
+ @retval EFI_SUCCESS This driver supports this device\r
+ @retval EFI_ALREADY_STARTED This driver is already running on this device\r
+ @retval other This driver does not support this device\r
\r
**/\r
EFI_STATUS\r
return Status;\r
}\r
\r
+/**\r
+ Clean up a IP4 service binding instance. It will release all\r
+ the resource allocated by the instance. The instance may be\r
+ partly initialized, or partly destroyed. If a resource is\r
+ destroyed, it is marked as that in case the destory failed and\r
+ being called again later.\r
+\r
+ @param[in] IpSb The IP4 serviceing binding instance to clean up\r
+\r
+ @retval EFI_SUCCESS The resource used by the instance are cleaned up\r
+ @retval other Failed to clean up some of the resources.\r
+\r
+**/\r
EFI_STATUS\r
Ip4CleanService (\r
IN IP4_SERVICE *IpSb\r
\r
\r
/**\r
- Create a new IP4 driver service binding protocol\r
+ Create a new IP4 driver service binding private instance.\r
\r
- @param Controller The controller that has MNP service binding\r
- installed\r
- @param ImageHandle The IP4 driver's image handle\r
- @param Service The variable to receive the newly created IP4\r
- service.\r
+ @param Controller The controller that has MNP service binding\r
+ installed\r
+ @param ImageHandle The IP4 driver's image handle\r
+ @param Service The variable to receive the newly created IP4\r
+ service.\r
\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate some resource\r
@retval EFI_SUCCESS A new IP4 service binding private is created.\r
+ @retval other Other error occurs.\r
\r
**/\r
EFI_STATUS\r
\r
InsertHeadList (&IpSb->Interfaces, &IpSb->DefaultInterface->Link);\r
\r
+ IpSb->MaxPacketSize = IpSb->SnpMode.MaxPacketSize - sizeof (IP4_HEAD);\r
+ if (NetLibGetVlanId (IpSb->Controller) != 0) {\r
+ //\r
+ // This is a VLAN device, reduce MTU by VLAN tag length\r
+ //\r
+ IpSb->MaxPacketSize -= NET_VLAN_TAG_LEN;\r
+ }\r
+ IpSb->OldMaxPacketSize = IpSb->MaxPacketSize;\r
IpSb->MacString = NULL;\r
\r
*Service = IpSb;\r
\r
ON_ERROR:\r
Ip4CleanService (IpSb);\r
- gBS->FreePool (IpSb);\r
+ FreePool (IpSb);\r
\r
return Status;\r
}\r
/**\r
Clean up a IP4 service binding instance. It will release all\r
the resource allocated by the instance. The instance may be\r
- partly initialized, or partly destoried. If a resource is\r
- destoried, it is marked as that in case the destory failed and\r
+ partly initialized, or partly destroyed. If a resource is\r
+ destroyed, it is marked as that in case the destory failed and\r
being called again later.\r
\r
- @param IpSb The IP4 serviceing binding instance to clean up\r
+ @param[in] IpSb The IP4 serviceing binding instance to clean up\r
\r
@retval EFI_SUCCESS The resource used by the instance are cleaned up\r
- @retval Others Failed to clean up some of the resources.\r
+ @retval other Failed to clean up some of the resources.\r
\r
**/\r
EFI_STATUS\r
Ip4CleanAssembleTable (&IpSb->Assemble);\r
\r
if (IpSb->MnpChildHandle != NULL) {\r
- if (IpSb->Mnp) {\r
+ if (IpSb->Mnp != NULL) {\r
gBS->CloseProtocol (\r
- IpSb->MnpChildHandle,\r
- &gEfiManagedNetworkProtocolGuid,\r
- IpSb->Image,\r
- IpSb->Controller\r
- );\r
+ IpSb->MnpChildHandle,\r
+ &gEfiManagedNetworkProtocolGuid,\r
+ IpSb->Image,\r
+ IpSb->Controller\r
+ );\r
\r
IpSb->Mnp = NULL;\r
}\r
\r
\r
/**\r
- Start this driver on ControllerHandle.\r
-\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to bind driver to\r
- @param RemainingDevicePath Optional parameter use to pick a specific child\r
- device to start.\r
-\r
- @retval EFI_SUCCES This driver is added to ControllerHandle\r
- @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle\r
- @retval other This driver does not support this device\r
+ Start this driver on ControllerHandle. This service is called by the\r
+ EFI boot service ConnectController(). In order to make\r
+ drivers as small as possible, there are a few calling restrictions for\r
+ this service. ConnectController() must follow these\r
+ calling restrictions. If any other agent wishes to call Start() it\r
+ must also follow these calling restrictions.\r
+\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to bind driver to\r
+ @param[in] RemainingDevicePath Optional parameter use to pick a specific child\r
+ device to start.\r
+\r
+ @retval EFI_SUCCESS This driver is added to ControllerHandle\r
+ @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle\r
+ @retval other This driver does not support this device\r
\r
**/\r
EFI_STATUS\r
if (EFI_ERROR (Status)) {\r
return Status;\r
}\r
+ ASSERT (IpSb != NULL);\r
\r
//\r
// Install the Ip4ServiceBinding Protocol onto ControlerHandle\r
\r
FREE_SERVICE:\r
Ip4CleanService (IpSb);\r
- gBS->FreePool (IpSb);\r
+ FreePool (IpSb);\r
\r
return Status;\r
}\r
\r
\r
/**\r
- Stop this driver on ControllerHandle.\r
-\r
- @param This Protocol instance pointer.\r
- @param ControllerHandle Handle of device to stop driver on\r
- @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number\r
- of children is zero stop the entire bus driver.\r
- @param ChildHandleBuffer List of Child Handles to Stop.\r
-\r
- @retval EFI_SUCCES This driver is removed ControllerHandle\r
- @retval other This driver was not removed from this device\r
+ Stop this driver on ControllerHandle. This service is called by the\r
+ EFI boot service DisconnectController(). In order to\r
+ make drivers as small as possible, there are a few calling\r
+ restrictions for this service. DisconnectController()\r
+ must follow these calling restrictions. If any other agent wishes\r
+ to call Stop() it must also follow these calling restrictions.\r
+\r
+ @param[in] This Protocol instance pointer.\r
+ @param[in] ControllerHandle Handle of device to stop driver on\r
+ @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer. If number\r
+ of children is zero stop the entire bus driver.\r
+ @param[in] ChildHandleBuffer List of Child Handles to Stop.\r
+\r
+ @retval EFI_SUCCESS This driver is removed ControllerHandle\r
+ @retval other This driver was not removed from this device\r
\r
**/\r
EFI_STATUS\r
\r
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
\r
- if (IpSb->Ip4Config && (IpSb->State != IP4_SERVICE_DESTORY)) {\r
+ if (IpSb->Ip4Config != NULL && (IpSb->State != IP4_SERVICE_DESTORY)) {\r
\r
IpSb->Ip4Config->Stop (IpSb->Ip4Config);\r
\r
ServiceBinding\r
);\r
\r
- gBS->FreePool (IpSb);\r
+ FreePool (IpSb);\r
} else if (NumberOfChildren == 0) {\r
IpSb->InDestory = TRUE;\r
\r
ServiceBinding\r
);\r
\r
- gBS->FreePool (IpSb);\r
+ FreePool (IpSb);\r
} else {\r
\r
while (!IsListEmpty (&IpSb->Children)) {\r
\r
\r
/**\r
- Creates a child handle with a set of I/O services.\r
+ Creates a child handle and installs a protocol.\r
\r
- @param This Protocol instance pointer.\r
- @param ChildHandle Pointer to the handle of the child to create. If\r
- it is NULL, then a new handle is created. If it\r
- is not NULL, then the I/O services are added to\r
- the existing child handle.\r
+ The CreateChild() function installs a protocol on ChildHandle.\r
+ If ChildHandle is a pointer to NULL, then a new handle is created and returned in ChildHandle.\r
+ If ChildHandle is not a pointer to NULL, then the protocol installs on the existing ChildHandle.\r
\r
- @retval EFI_SUCCES The child handle was created with the I/O services\r
- @retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create\r
- the child\r
- @retval other The child handle was not created\r
+ @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
+ @param ChildHandle Pointer to the handle of the child to create. If it is NULL,\r
+ then a new handle is created. If it is a pointer to an existing UEFI handle,\r
+ then the protocol is added to the existing UEFI handle.\r
+\r
+ @retval EFI_SUCCES The protocol was added to ChildHandle.\r
+ @retval EFI_INVALID_PARAMETER ChildHandle is NULL.\r
+ @retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create\r
+ the child\r
+ @retval other The child handle was not created\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Ip4ServiceBindingCreateChild (\r
IN EFI_SERVICE_BINDING_PROTOCOL *This,\r
- IN EFI_HANDLE *ChildHandle\r
+ IN OUT EFI_HANDLE *ChildHandle\r
)\r
{\r
IP4_SERVICE *IpSb;\r
\r
Ip4CleanProtocol (IpInstance);\r
\r
- gBS->FreePool (IpInstance);\r
+ FreePool (IpInstance);\r
}\r
\r
return Status;\r
\r
\r
/**\r
- Destroys a child handle with a set of I/O services.\r
+ Destroys a child handle with a protocol installed on it.\r
+\r
+ The DestroyChild() function does the opposite of CreateChild(). It removes a protocol\r
+ that was installed by CreateChild() from ChildHandle. If the removed protocol is the\r
+ last protocol on ChildHandle, then ChildHandle is destroyed.\r
\r
- @param This Protocol instance pointer.\r
- @param ChildHandle Handle of the child to destroy\r
+ @param This Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
+ @param ChildHandle Handle of the child to destroy\r
\r
- @retval EFI_SUCCES The I/O services were removed from the child\r
- handle\r
- @retval EFI_UNSUPPORTED The child handle does not support the I/O services\r
- that are being removed\r
- @retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle.\r
- @retval EFI_ACCESS_DENIED The child handle could not be destroyed because\r
- its I/O services are being used.\r
- @retval other The child handle was not destroyed\r
+ @retval EFI_SUCCES The protocol was removed from ChildHandle.\r
+ @retval EFI_UNSUPPORTED ChildHandle does not support the protocol that is being removed.\r
+ @retval EFI_INVALID_PARAMETER Child handle is not a valid UEFI Handle.\r
+ @retval EFI_ACCESS_DENIED The protocol could not be removed from the ChildHandle\r
+ because its services are being used.\r
+ @retval other The child handle was not destroyed\r
\r
**/\r
EFI_STATUS\r
\r
gBS->RestoreTPL (OldTpl);\r
\r
- gBS->FreePool (IpInstance);\r
+ FreePool (IpInstance);\r
return EFI_SUCCESS;\r
\r
ON_ERROR:\r