| /** @file | |
| Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR> | |
| 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_SUCCESS 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_SUCCESS 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; | |
| } |