/** @file\r
- Abstract:\r
+ ARP driver functions.\r
\r
-Copyright (c) 2006 - 2008, Intel Corporation.<BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2006 - 2012, 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<BR>\r
http://opensource.org/licenses/bsd-license.php\r
/**\r
Create and initialize the arp service context data.\r
\r
- @param[in] ImageHandle The image handle representing the loaded driver\r
+ @param[in] ImageHandle The image handle representing the loaded driver\r
image.\r
- @param[in] ControllerHandle The controller handle the driver binds to.\r
- @param[in] ArpService Pointer to the buffer containing the arp service\r
+ @param[in] ControllerHandle The controller handle the driver binds to.\r
+ @param[in, out] ArpService Pointer to the buffer containing the arp service\r
context data.\r
\r
@retval EFI_SUCCESS The arp service context is initialized.\r
+ \r
+ @retval EFI_UNSUPPORTED The underlayer Snp mode type is not ethernet.\r
+ Failed to initialize the service context.\r
@retval other Failed to initialize the arp service context.\r
\r
**/\r
ArpCreateService (\r
IN EFI_HANDLE ImageHandle,\r
IN EFI_HANDLE ControllerHandle,\r
- IN ARP_SERVICE_DATA *ArpService\r
+ IN OUT ARP_SERVICE_DATA *ArpService\r
)\r
{\r
EFI_STATUS Status;\r
\r
ArpService->Signature = ARP_SERVICE_DATA_SIGNATURE;\r
\r
+ //\r
+ // Init the lists.\r
+ //\r
+ InitializeListHead (&ArpService->ChildrenList);\r
+ InitializeListHead (&ArpService->PendingRequestTable);\r
+ InitializeListHead (&ArpService->DeniedCacheTable);\r
+ InitializeListHead (&ArpService->ResolvedCacheTable);\r
+\r
//\r
// Init the servicebinding protocol members.\r
//\r
TimerPeriodic,\r
ARP_PERIODIC_TIMER_INTERVAL\r
);\r
- if (EFI_ERROR (Status)) {\r
- goto ERROR_EXIT;\r
- }\r
-\r
- //\r
- // Init the lists.\r
- //\r
- InitializeListHead (&ArpService->ChildrenList);\r
- InitializeListHead (&ArpService->PendingRequestTable);\r
- InitializeListHead (&ArpService->DeniedCacheTable);\r
- InitializeListHead (&ArpService->ResolvedCacheTable);\r
\r
ERROR_EXIT:\r
\r
/**\r
Clean the arp service context data.\r
\r
- @param[in] ArpService Pointer to the buffer containing the arp service\r
+ @param[in, out] ArpService Pointer to the buffer containing the arp service\r
context data.\r
\r
@return None.\r
**/\r
VOID\r
ArpCleanService (\r
- IN ARP_SERVICE_DATA *ArpService\r
+ IN OUT ARP_SERVICE_DATA *ArpService\r
)\r
{\r
NET_CHECK_SIGNATURE (ArpService, ARP_SERVICE_DATA_SIGNATURE);\r
}\r
\r
/**\r
- Test to see if this driver supports ControllerHandle.\r
+ Callback function which provided by user to remove one node in NetDestroyLinkList process.\r
\r
- This service 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
+ @param[in] Entry The entry to be removed.\r
+ @param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList.\r
+\r
+ @retval EFI_SUCCESS The entry has been removed successfully.\r
+ @retval Others Fail to remove the entry.\r
+\r
+**/\r
+EFI_STATUS\r
+ArpDestroyChildEntryInHandleBuffer (\r
+ IN LIST_ENTRY *Entry,\r
+ IN VOID *Context\r
+)\r
+{\r
+ ARP_INSTANCE_DATA *Instance;\r
+ EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding;\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
+ if (Entry == NULL || Context == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ Instance = NET_LIST_USER_STRUCT_S (Entry, ARP_INSTANCE_DATA, List, ARP_INSTANCE_DATA_SIGNATURE);\r
+ ServiceBinding = (EFI_SERVICE_BINDING_PROTOCOL *) Context;\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
+ return ServiceBinding->DestroyChild (ServiceBinding, Instance->Handle);\r
+}\r
+\r
+/**\r
+ Tests to see if this driver supports a given controller. \r
+ \r
+ If a child device is provided, it further tests to see if this driver supports \r
+ creating a handle for the specified child device.\r
+\r
+ @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
+ @param[in] ControllerHandle The handle of the controller to test. This handle \r
+ must support a protocol interface that supplies \r
+ an I/O abstraction to the driver.\r
+ @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. \r
+ This parameter is ignored by device drivers, \r
+ and is optional for bus drivers.\r
+\r
+ @retval EFI_SUCCESS The device specified by ControllerHandle and\r
+ RemainingDevicePath is supported by the driver \r
+ specified by This.\r
+ @retval EFI_ALREADY_STARTED The device specified by ControllerHandle and\r
+ RemainingDevicePath is already being managed \r
+ by the driver specified by This.\r
+ @retval EFI_ACCESS_DENIED The device specified by ControllerHandle and\r
+ RemainingDevicePath is already being managed by \r
+ a different driver or an application that \r
+ requires exclusive acces. Currently not implemented.\r
+ @retval EFI_UNSUPPORTED The device specified by ControllerHandle and\r
+ RemainingDevicePath is not supported by the \r
+ driver specified by This.\r
\r
**/\r
EFI_STATUS\r
\r
\r
/**\r
- Start this driver on ControllerHandle.\r
+ Start this driver on ControllerHandle. \r
\r
- This service is called by the 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_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
+ The Start() function is designed to be invoked from the EFI boot service ConnectController(). \r
+ As a result, much of the error checking on the parameters to Start() has been \r
+ moved into this common boot service. It is legal to call Start() from other locations, \r
+ but the following calling restrictions must be followed or the system behavior \r
+ will not be deterministic.\r
+ 1. ControllerHandle must be a valid EFI_HANDLE.\r
+ 2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally \r
+ aligned EFI_DEVICE_PATH_PROTOCOL.\r
+ 3. Prior to calling Start(), the Supported() function for the driver specified \r
+ by This must have been called with the same calling parameters, and Supported() \r
+ must have returned EFI_SUCCESS. \r
+\r
+ @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
+ @param[in] ControllerHandle The handle of the controller to start. This handle \r
+ must support a protocol interface that supplies \r
+ an I/O abstraction to the driver.\r
+ @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. \r
+ This parameter is ignored by device drivers, \r
+ and is optional for bus drivers.\r
+\r
+ @retval EFI_SUCCESS The device was started.\r
+ @retval EFI_DEVICE_ERROR The device could not be started due to a device error.\r
+ Currently not implemented.\r
+ @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of \r
+ resources.\r
+ @retval Others The driver failded to start the device.\r
\r
**/\r
EFI_STATUS\r
// On error, clean the arp service context data, and free the memory allocated.\r
//\r
ArpCleanService (ArpService);\r
- gBS->FreePool (ArpService);\r
+ FreePool (ArpService);\r
\r
return Status;\r
}\r
\r
\r
/**\r
- Stop this driver on ControllerHandle.\r
+ Stop this driver on ControllerHandle. \r
\r
- This service is called by the 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
+ Release the control of this controller and remove the IScsi functions. The Stop()\r
+ function is designed to be invoked from the EFI boot service DisconnectController(). \r
+ As a result, much of the error checking on the parameters to Stop() has been moved \r
+ into this common boot service. It is legal to call Stop() from other locations, \r
+ but the following calling restrictions must be followed or the system behavior \r
+ will not be deterministic.\r
+ 1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this\r
+ same driver's Start() function.\r
+ 2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid\r
+ EFI_HANDLE. In addition, all of these handles must have been created in this driver's\r
+ Start() function, and the Start() function must have called OpenProtocol() on\r
+ ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.\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_SUCCES This driver is removed ControllerHandle\r
- @retval other This driver was not removed from this device\r
+ @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
+ @param[in] ControllerHandle A handle to the device being stopped. The handle must \r
+ support a bus specific I/O protocol for the driver \r
+ to use to stop the device.\r
+ @param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer.\r
+ Not used.\r
+ @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL \r
+ if NumberOfChildren is 0.Not used.\r
+\r
+ @retval EFI_SUCCESS The device was stopped.\r
+ @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.\r
\r
**/\r
EFI_STATUS\r
EFI_HANDLE NicHandle;\r
EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding;\r
ARP_SERVICE_DATA *ArpService;\r
- ARP_INSTANCE_DATA *Instance;\r
+ LIST_ENTRY *List;\r
\r
//\r
// Get the NicHandle which the arp servicebinding is installed on.\r
//\r
NicHandle = NetLibGetNicHandle (ControllerHandle, &gEfiManagedNetworkProtocolGuid);\r
if (NicHandle == NULL) {\r
- return EFI_DEVICE_ERROR;\r
+ return EFI_SUCCESS;\r
}\r
\r
//\r
\r
ArpService = ARP_SERVICE_DATA_FROM_THIS (ServiceBinding);\r
\r
- if (NumberOfChildren == 0) {\r
+ if (NumberOfChildren != 0) {\r
+ //\r
+ // NumberOfChildren is not zero, destroy all the ARP children instances.\r
+ //\r
+ List = &ArpService->ChildrenList;\r
+ Status = NetDestroyLinkList (\r
+ List,\r
+ ArpDestroyChildEntryInHandleBuffer,\r
+ ServiceBinding,\r
+ NULL\r
+ );\r
+ ASSERT (IsListEmpty (&ArpService->PendingRequestTable));\r
+ ASSERT (IsListEmpty (&ArpService->DeniedCacheTable));\r
+ ASSERT (IsListEmpty (&ArpService->ResolvedCacheTable));\r
+ } else if (IsListEmpty (&ArpService->ChildrenList)) {\r
//\r
// Uninstall the ARP ServiceBinding protocol.\r
//\r
//\r
ArpCleanService (ArpService);\r
\r
- gBS->FreePool (ArpService);\r
- } else {\r
-\r
- while (!IsListEmpty (&ArpService->ChildrenList)) {\r
- Instance = NET_LIST_HEAD (&ArpService->ChildrenList, ARP_INSTANCE_DATA, List);\r
-\r
- ServiceBinding->DestroyChild (ServiceBinding, Instance->Handle);\r
- }\r
-\r
- ASSERT (IsListEmpty (&ArpService->PendingRequestTable));\r
- ASSERT (IsListEmpty (&ArpService->DeniedCacheTable));\r
- ASSERT (IsListEmpty (&ArpService->ResolvedCacheTable));\r
+ FreePool (ArpService);\r
}\r
\r
return EFI_SUCCESS;\r
}\r
\r
/**\r
- Creates a child handle with a set of I/O services.\r
-\r
- @param[in] This Protocol instance pointer.\r
- @param[in] ChildHandle Pointer to the handle of the child to create. If\r
- it is NULL, then a new handle is created. If it is\r
- not NULL, then the I/O services are added to the\r
- existing child handle.\r
-\r
- @retval EFI_SUCCES The child handle was created with the I/O\r
- 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
+ Creates a child handle and installs a protocol.\r
+ \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 \r
+ in ChildHandle. If ChildHandle is not a pointer to NULL, then the protocol \r
+ installs on the existing ChildHandle.\r
+\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 \r
+ UEFI handle, 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
if (EFI_ERROR (Status)) {\r
DEBUG ((EFI_D_ERROR, "ArpSBCreateChild: faild to install ARP protocol, %r.\n", Status));\r
\r
- gBS->FreePool (Instance);\r
+ FreePool (Instance);\r
return Status;\r
}\r
\r
//\r
// Free the allocated memory.\r
//\r
- gBS->FreePool (Instance);\r
+ FreePool (Instance);\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[in] This Protocol instance pointer.\r
- @param[in] 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 \r
+ being removed.\r
+ @retval EFI_INVALID_PARAMETER Child handle is NULL.\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
Instance = ARP_INSTANCE_DATA_FROM_THIS (Arp);\r
\r
- if (Instance->Destroyed) {\r
+ if (Instance->InDestroy) {\r
return EFI_SUCCESS;\r
}\r
\r
//\r
- // Use the Destroyed as a flag to avoid re-entrance.\r
+ // Use the InDestroy as a flag to avoid re-entrance.\r
//\r
- Instance->Destroyed = TRUE;\r
+ Instance->InDestroy = TRUE;\r
\r
//\r
// Close the Managed Network protocol.\r
DEBUG ((EFI_D_ERROR, "ArpSBDestroyChild: Failed to uninstall the arp protocol, %r.\n",\r
Status));\r
\r
- Instance->Destroyed = FALSE;\r
+ Instance->InDestroy = FALSE;\r
return Status;\r
}\r
\r
\r
gBS->RestoreTPL (OldTpl);\r
\r
- gBS->FreePool (Instance);\r
+ FreePool (Instance);\r
\r
return Status;\r
}\r
@param[in] ImageHandle The image handle of the driver.\r
@param[in] SystemTable The system table.\r
\r
- @retval EFI_SUCCES if the driver binding and component name protocols are successfully\r
+ @retval EFI_SUCCESS if the driver binding and component name protocols \r
+ are successfully\r
@retval Others Failed to install the protocols.\r
\r
**/\r
projects / mirror_edk2.git / blobdiff