X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdeModulePkg%2FUniversal%2FNetwork%2FUdp4Dxe%2FUdp4Driver.c;h=faf9ca5e287cb702e466a0c76750cd6f93d628fc;hb=241993480e8e9ff4526e206ba8e4fa97e695ed4a;hp=7b47ef44a92a8bf84c6b8daa530114c0c62e30f7;hpb=8a67d61da4d5a8f08a656cbeea2d902d0ad9042a;p=mirror_edk2.git diff --git a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Driver.c b/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Driver.c index 7b47ef44a9..faf9ca5e28 100644 --- a/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Driver.c +++ b/MdeModulePkg/Universal/Network/Udp4Dxe/Udp4Driver.c @@ -1,7 +1,7 @@ /** @file -Copyright (c) 2006, Intel Corporation -All rights reserved. This program and the accompanying materials +Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.
+This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php @@ -9,13 +9,6 @@ http://opensource.org/licenses/bsd-license.php THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. -Module Name: - - Udp4Driver.c - -Abstract: - - **/ @@ -35,17 +28,61 @@ EFI_SERVICE_BINDING_PROTOCOL mUdp4ServiceBinding = { Udp4ServiceBindingDestroyChild }; - /** - Test to see if this driver supports ControllerHandle. + 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; - @param This Protocol instance pointer. - @param ControllerHandle Handle of device to test. - @param RemainingDevicePath Optional parameter use to pick a specific child - device to start. + if (Entry == NULL || Context == NULL) { + return EFI_INVALID_PARAMETER; + } - @retval EFI_SUCCES This driver supports this device. - @retval EFI_ALREADY_STARTED This driver is already running on this device. + 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 @@ -90,16 +127,21 @@ Udp4DriverBindingSupported ( /** - Start this driver on ControllerHandle. - - @param This Protocol instance pointer. - @param ControllerHandle Handle of device to bind driver to - @param RemainingDevicePath Optional parameter use to pick a specific child - device to start. - - @retval EFI_SUCCES 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 + 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 @@ -116,14 +158,15 @@ Udp4DriverBindingStart ( // // Allocate Private Context Data Structure. // - Udp4Service = NetAllocatePool (sizeof (UDP4_SERVICE_DATA)); + Udp4Service = AllocatePool (sizeof (UDP4_SERVICE_DATA)); if (Udp4Service == NULL) { return EFI_OUT_OF_RESOURCES; } Status = Udp4CreateService (Udp4Service, This->DriverBindingHandle, ControllerHandle); if (EFI_ERROR (Status)) { - goto FREE_SERVICE; + FreePool (Udp4Service); + return Status; } // @@ -136,36 +179,30 @@ Udp4DriverBindingStart ( NULL ); if (EFI_ERROR (Status)) { - goto CLEAN_SERVICE; + Udp4CleanService (Udp4Service); + FreePool (Udp4Service); } - Udp4SetVariableData (Udp4Service); - - return Status; - -CLEAN_SERVICE: - - Udp4CleanService (Udp4Service); - -FREE_SERVICE: - - NetFreePool (Udp4Service); - return Status; } /** - Stop this driver on ControllerHandle. - - @param This Protocol instance pointer. - @param ControllerHandle Handle of device to stop driver on - @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number - of children is zero stop the entire bus driver. - @param ChildHandleBuffer List of Child Handles to Stop. - - @retval EFI_SUCCES This driver is removed ControllerHandle. - @retval other This driver was not removed from this device. + 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 @@ -177,11 +214,12 @@ Udp4DriverBindingStop ( IN EFI_HANDLE *ChildHandleBuffer ) { - EFI_STATUS Status; - EFI_HANDLE NicHandle; - EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding; - UDP4_SERVICE_DATA *Udp4Service; - UDP4_INSTANCE_DATA *Instance; + 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. @@ -207,52 +245,58 @@ Udp4DriverBindingStop ( } Udp4Service = UDP4_SERVICE_DATA_FROM_THIS (ServiceBinding); - - // - // Uninstall the UDP4 ServiceBinding Protocol. - // - Status = gBS->UninstallMultipleProtocolInterfaces ( - NicHandle, - &gEfiUdp4ServiceBindingProtocolGuid, - &Udp4Service->ServiceBinding, - NULL - ); - if (EFI_ERROR (Status)) { - return EFI_DEVICE_ERROR; - } - - while (!NetListIsEmpty (&Udp4Service->ChildrenList)) { + if (NumberOfChildren != 0) { // - // Destroy all instances. + // NumberOfChildren is not zero, destroy the children instances in ChildHandleBuffer. // - Instance = NET_LIST_HEAD (&Udp4Service->ChildrenList, UDP4_INSTANCE_DATA, Link); - - ServiceBinding->DestroyChild (ServiceBinding, Instance->ChildHandle); + 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); } - Udp4ClearVariableData (Udp4Service); - - Udp4CleanService (Udp4Service); - - NetFreePool (Udp4Service); - - return EFI_SUCCESS; + return Status; } /** - Creates a child handle with a set of I/O services. - - @param This Protocol instance pointer. - @param ChildHandle Pointer to the handle of the child to create. If - it is NULL, then a new handle is created. If it - is not NULL, then the I/O services are added to - the existing child handle. - - @retval EFI_SUCCES The child handle was created with the I/O services - @retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create - the child - @retval other The child handle was not created + 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_SUCCES The protocol was added to ChildHandle. + @retval EFI_INVALID_PARAMETER ChildHandle is NULL. + @retval EFI_OUT_OF_RESOURCES There are not enough resources availabe to create + the child + @retval other The child handle was not created **/ EFI_STATUS @@ -277,7 +321,7 @@ Udp4ServiceBindingCreateChild ( // // Allocate the instance private data structure. // - Instance = NetAllocatePool (sizeof (UDP4_INSTANCE_DATA)); + Instance = AllocateZeroPool (sizeof (UDP4_INSTANCE_DATA)); if (Instance == NULL) { return EFI_OUT_OF_RESOURCES; } @@ -290,7 +334,7 @@ Udp4ServiceBindingCreateChild ( Instance->IpInfo = IpIoAddIp (Udp4Service->IpIo); if (Instance->IpInfo == NULL) { Status = EFI_OUT_OF_RESOURCES; - goto FREE_INSTANCE; + goto ON_ERROR; } // @@ -303,7 +347,7 @@ Udp4ServiceBindingCreateChild ( NULL ); if (EFI_ERROR (Status)) { - goto REMOVE_IPINFO; + goto ON_ERROR; } Instance->ChildHandle = *ChildHandle; @@ -320,58 +364,75 @@ Udp4ServiceBindingCreateChild ( EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER ); if (EFI_ERROR (Status)) { - goto UNINSTALL_PROTOCOL; + 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 = NET_RAISE_TPL (NET_TPL_LOCK); + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); // // Link this instance into the service context data and increase the ChildrenNumber. // - NetListInsertTail (&Udp4Service->ChildrenList, &Instance->Link); + InsertTailList (&Udp4Service->ChildrenList, &Instance->Link); Udp4Service->ChildrenNumber++; - NET_RESTORE_TPL (OldTpl); + gBS->RestoreTPL (OldTpl); - return Status; - -UNINSTALL_PROTOCOL: - - gBS->UninstallMultipleProtocolInterfaces ( - Instance->ChildHandle, - &gEfiUdp4ProtocolGuid, - &Instance->Udp4Proto, - NULL - ); + return EFI_SUCCESS; -REMOVE_IPINFO: +ON_ERROR: - IpIoRemoveIp (Udp4Service->IpIo, Instance->IpInfo); + if (Instance->ChildHandle != NULL) { + gBS->UninstallMultipleProtocolInterfaces ( + Instance->ChildHandle, + &gEfiUdp4ProtocolGuid, + &Instance->Udp4Proto, + NULL + ); + } -FREE_INSTANCE: + if (Instance->IpInfo != NULL) { + IpIoRemoveIp (Udp4Service->IpIo, Instance->IpInfo); + } Udp4CleanInstance (Instance); - NetFreePool (Instance); + FreePool (Instance); return Status; } /** - Destroys a child handle with a set of I/O services. - - @param This Protocol instance pointer. - @param ChildHandle Handle of the child to destroy - - @retval EFI_SUCCES The I/O services were removed from the child - handle - @retval EFI_UNSUPPORTED The child handle does not support the I/O services - that are being removed - @retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle. - @retval EFI_ACCESS_DENIED The child handle could not be destroyed because - its I/O services are being used. - @retval other The child handle was not destroyed + 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_SUCCES 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 @@ -410,14 +471,14 @@ Udp4ServiceBindingDestroyChild ( Instance = UDP4_INSTANCE_DATA_FROM_THIS (Udp4Proto); - if (Instance->Destroyed) { + if (Instance->InDestroy) { return EFI_SUCCESS; } // // Use the Destroyed flag to avoid the re-entering of the following code. // - Instance->Destroyed = TRUE; + Instance->InDestroy = TRUE; // // Close the Ip4 protocol. @@ -428,6 +489,15 @@ Udp4ServiceBindingDestroyChild ( 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. @@ -439,7 +509,7 @@ Udp4ServiceBindingDestroyChild ( NULL ); if (EFI_ERROR (Status)) { - Instance->Destroyed = FALSE; + Instance->InDestroy = FALSE; return Status; } @@ -453,12 +523,12 @@ Udp4ServiceBindingDestroyChild ( // IpIoRemoveIp (Udp4Service->IpIo, Instance->IpInfo); - OldTpl = NET_RAISE_TPL (NET_TPL_LOCK); + OldTpl = gBS->RaiseTPL (TPL_CALLBACK); // // Remove this instance from the service context data's ChildrenList. // - NetListRemoveEntry (&Instance->Link); + RemoveEntryList (&Instance->Link); Udp4Service->ChildrenNumber--; // @@ -466,59 +536,53 @@ Udp4ServiceBindingDestroyChild ( // Udp4CleanInstance (Instance); - NET_RESTORE_TPL (OldTpl); + gBS->RestoreTPL (OldTpl); - NetFreePool (Instance); + FreePool (Instance); return EFI_SUCCESS; } -//@MT: EFI_DRIVER_ENTRY_POINT (Udp4DriverEntryPoint) +/** + 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 ) -/*++ - -Routine Description: - - The entry point for Udp4 driver which installs the driver binding - and component name protocol on its ImageHandle. - -Arguments: - - ImageHandle - The image handle of the driver. - SystemTable - The system table. - -Returns: - - EFI_SUCCESS - if the driver binding and component name protocols are - successfully installed, otherwise if failed. - ---*/ { EFI_STATUS Status; // // Install the Udp4DriverBinding and Udp4ComponentName protocols. // - Status = NetLibInstallAllDriverProtocols ( + Status = EfiLibInstallDriverBindingComponentName2 ( ImageHandle, SystemTable, &gUdp4DriverBinding, ImageHandle, &gUdp4ComponentName, - NULL, - NULL + &gUdp4ComponentName2 ); if (!EFI_ERROR (Status)) { // // Initialize the UDP random port. // - mUdp4RandomPort = ((UINT16) NetRandomInitSeed ()) % UDP4_PORT_KNOWN + UDP4_PORT_KNOWN; + mUdp4RandomPort = (UINT16) (((UINT16) NetRandomInitSeed ()) % UDP4_PORT_KNOWN + UDP4_PORT_KNOWN); } return Status;