/** @file\r
+ ARP driver functions.\r
\r
-Copyright (c) 2006 - 2007, Intel Corporation \r
-All rights reserved. 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
-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
- ArpDriver.c\r
-\r
-Abstract:\r
-\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
-\r
#include "ArpDriver.h"\r
#include "ArpImpl.h"\r
\r
/**\r
Create and initialize the arp service context data.\r
\r
- @param ImageHandle The image handle representing the loaded driver\r
- image.\r
- @param ControllerHandle The controller handle the driver binds to.\r
- @param ArpService Pointer to the buffer containing the arp service\r
- context data.\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, 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
- @retval other Failed to initialize the arp service context.\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
-STATIC\r
EFI_STATUS\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
//\r
Status = gBS->CreateEvent (\r
EVT_NOTIFY_SIGNAL,\r
- NET_TPL_EVENT,\r
+ TPL_NOTIFY,\r
ArpOnFrameRcvd,\r
ArpService,\r
&ArpService->RxToken.Event\r
//\r
Status = gBS->CreateEvent (\r
EVT_NOTIFY_SIGNAL | EVT_TIMER,\r
- NET_TPL_TIMER,\r
+ TPL_CALLBACK,\r
ArpTimerHandler,\r
ArpService,\r
&ArpService->PeriodicTimer\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
- NetListInit (&ArpService->ChildrenList);\r
- NetListInit (&ArpService->PendingRequestTable);\r
- NetListInit (&ArpService->DeniedCacheTable);\r
- NetListInit (&ArpService->ResolvedCacheTable);\r
\r
ERROR_EXIT:\r
\r
/**\r
Clean the arp service context data.\r
\r
- @param ArpService Pointer to the buffer containing the arp service\r
- context data.\r
+ @param[in, out] ArpService Pointer to the buffer containing the arp service\r
+ context data.\r
\r
@return None.\r
\r
**/\r
-STATIC\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
-\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
+ @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
+EFIAPI\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
+ 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
- @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
+ return ServiceBinding->DestroyChild (ServiceBinding, Instance->Handle);\r
+}\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
+/**\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
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
+ 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
//\r
// Allocate a zero pool for ArpService.\r
//\r
- ArpService = NetAllocateZeroPool (sizeof(ARP_SERVICE_DATA));\r
+ ArpService = AllocateZeroPool (sizeof(ARP_SERVICE_DATA));\r
if (ArpService == NULL) {\r
return EFI_OUT_OF_RESOURCES;\r
}\r
// On error, clean the arp service context data, and free the memory allocated.\r
//\r
ArpCleanService (ArpService);\r
- NetFreePool (ArpService);\r
+ FreePool (ArpService);\r
\r
return Status;\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
+ 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 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
EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
);\r
if (EFI_ERROR (Status)) {\r
- ARP_DEBUG_ERROR (("ArpDriverBindingStop: Open ArpSb failed, %r.\n", Status));\r
+ DEBUG ((EFI_D_ERROR, "ArpDriverBindingStop: Open ArpSb failed, %r.\n", Status));\r
return EFI_DEVICE_ERROR;\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
- NetFreePool (ArpService);\r
- } else {\r
-\r
- while (!NetListIsEmpty (&ArpService->ChildrenList)) {\r
- Instance = NET_LIST_HEAD (&ArpService->ChildrenList, ARP_INSTANCE_DATA, List);\r
-\r
- ServiceBinding->DestroyChild (ServiceBinding, Instance->Handle);\r
- }\r
-\r
- ASSERT (NetListIsEmpty (&ArpService->PendingRequestTable));\r
- ASSERT (NetListIsEmpty (&ArpService->DeniedCacheTable));\r
- ASSERT (NetListIsEmpty (&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
+ 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 is\r
- not NULL, then the I/O services are added to the\r
- 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\r
+ in ChildHandle. If ChildHandle is not a pointer to NULL, then the protocol\r
+ installs on the existing ChildHandle.\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
+ @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 available to create\r
+ the child\r
+ @retval other The child handle was not created\r
\r
**/\r
EFI_STATUS\r
//\r
// Allocate memory for the instance context data.\r
//\r
- Instance = NetAllocateZeroPool (sizeof(ARP_INSTANCE_DATA));\r
+ Instance = AllocateZeroPool (sizeof(ARP_INSTANCE_DATA));\r
if (Instance == NULL) {\r
- ARP_DEBUG_ERROR (("ArpSBCreateChild: Failed to allocate memory for Instance.\n"));\r
+ DEBUG ((EFI_D_ERROR, "ArpSBCreateChild: Failed to allocate memory for Instance.\n"));\r
\r
return EFI_OUT_OF_RESOURCES;\r
}\r
NULL\r
);\r
if (EFI_ERROR (Status)) {\r
- ARP_DEBUG_ERROR (("ArpSBCreateChild: faild to install ARP protocol, %r.\n", Status));\r
+ DEBUG ((EFI_D_ERROR, "ArpSBCreateChild: faild to install ARP protocol, %r.\n", Status));\r
\r
- NetFreePool (Instance);\r
+ FreePool (Instance);\r
return Status;\r
}\r
\r
goto ERROR;\r
}\r
\r
- OldTpl = NET_RAISE_TPL (NET_TPL_LOCK);\r
+ OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
\r
//\r
// Insert the instance into children list managed by the arp service context data.\r
//\r
- NetListInsertTail (&ArpService->ChildrenList, &Instance->List);\r
+ InsertTailList (&ArpService->ChildrenList, &Instance->List);\r
ArpService->ChildrenNumber++;\r
\r
- NET_RESTORE_TPL (OldTpl);\r
+ gBS->RestoreTPL (OldTpl);\r
\r
ERROR:\r
\r
//\r
// Free the allocated memory.\r
//\r
- NetFreePool (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 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\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
NULL\r
);\r
if (EFI_ERROR (Status)) {\r
- ARP_DEBUG_ERROR (("ArpSBDestroyChild: Failed to uninstall the arp protocol, %r.\n",\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
- OldTpl = NET_RAISE_TPL (NET_TPL_LOCK);\r
+ OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
\r
if (Instance->Configured) {\r
//\r
//\r
// Remove this instance from the ChildrenList.\r
//\r
- NetListRemoveEntry (&Instance->List);\r
+ RemoveEntryList (&Instance->List);\r
ArpService->ChildrenNumber--;\r
\r
- NET_RESTORE_TPL (OldTpl);\r
+ gBS->RestoreTPL (OldTpl);\r
\r
- NetFreePool (Instance);\r
+ FreePool (Instance);\r
\r
return Status;\r
}\r
\r
+/**\r
+ The entry point for Arp driver which installs the driver binding and component name\r
+ protocol on its ImageHandle.\r
+\r
+ @param[in] ImageHandle The image handle of the driver.\r
+ @param[in] SystemTable The system table.\r
\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
EFI_STATUS\r
EFIAPI\r
ArpDriverEntryPoint (\r
IN EFI_HANDLE ImageHandle,\r
IN EFI_SYSTEM_TABLE *SystemTable\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- The entry point for Arp driver which installs the driver binding and component name\r
- protocol on its ImageHandle.\r
-\r
-Arguments:\r
-\r
- ImageHandle - The image handle of the driver.\r
- SystemTable - The system table.\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - if the driver binding and component name protocols are successfully\r
- installed, otherwise if failed.\r
-\r
---*/\r
{\r
return EfiLibInstallDriverBindingComponentName2 (\r
ImageHandle,\r
projects / mirror_edk2.git / blobdiff