Add CONSTRUCTOR to BaseDebugLibSerialPort to call SerialPortInitialize() in the Seria...

[mirror_edk2.git] / NetworkPkg / IpSecDxe / IpSecDriver.c

/** @file\r
  Driver Binding Protocol for IPsec Driver.\r
\r
  Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
\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
\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
**/\r
\r
#include <Library/UdpIoLib.h>\r
#include "IpSecConfigImpl.h"\r
#include "IpSecDebug.h"\r
\r
/**\r
  Test to see if this driver supports ControllerHandle.\r
\r
  @param[in]  This                 Protocol instance pointer.\r
  @param[in]  ControllerHandle     Handle of device to test.\r
  @param[in]  RemainingDevicePath  Optional parameter used 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
\r
**/\r
EFI_STATUS\r
EFIAPI\r
IpSecDriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath  OPTIONAL\r
  )\r
{\r
  //\r
  //TODO: Add Udp4Protocol and Udp6Protocol testing.\r
  //\r
  return EFI_UNSUPPORTED;\r
}\r
\r
/**\r
  Start this driver on ControllerHandle.\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 used 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 EFI_DEVICE_ERROR     The device could not be started due to a device error.\r
                               Currently not implemented.\r
  @retval other                This driver does not support this device\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
IpSecDriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
  )\r
{\r
  //\r
  //TODO: Add Udp4Io and Udp6Io creation for the IKE.\r
  //\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Stop this driver on ControllerHandle.\r
\r
  @param[in]  This                 Protocol instance pointer.\r
  @param[in]  ControllerHandle     Handle of a device to stop the driver on.\r
  @param[in]  NumberOfChildren     Number of Handles in ChildHandleBuffer. If the number of\r
                                   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 removed ControllerHandle.\r
  @retval other                This driver was not removed from this device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
IpSecDriverBindingStop (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN UINTN                        NumberOfChildren,\r
  IN EFI_HANDLE                   *ChildHandleBuffer\r
  )\r
{\r
  //\r
  //TODO: Add UdpIo4 and UdpIo6 destruction when the Udp driver unload or stop.\r
  //\r
  return EFI_UNSUPPORTED;\r
}\r
\r
EFI_DRIVER_BINDING_PROTOCOL gIpSecDriverBinding = {\r
  IpSecDriverBindingSupported,\r
  IpSecDriverBindingStart,\r
  IpSecDriverBindingStop,\r
  0xa,\r
  NULL,\r
  NULL\r
};\r
\r
/**\r
  This is a callback function when the mIpSecInstance.DisabledEvent is signaled.\r
\r
  @param[in]  Event        Event whose notification function is being invoked.\r
  @param[in]  Context      Pointer to the notification function's context.\r
\r
**/\r
VOID\r
EFIAPI\r
IpSecCleanupAllSa (\r
  IN  EFI_EVENT     Event,\r
  IN  VOID          *Context\r
  )\r
{\r
  IPSEC_PRIVATE_DATA  *Private;\r
  UINT8               Value;\r
  EFI_STATUS          Status;\r
\r
  Private = (IPSEC_PRIVATE_DATA *) Context;\r
\r
  //\r
  // Set the Status Variable\r
  //\r
  Value  = IPSEC_STATUS_DISABLED;\r
  Status = gRT->SetVariable (\r
                  IPSECCONFIG_STATUS_NAME,\r
                  &gEfiIpSecConfigProtocolGuid,\r
                  EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r
                  sizeof (Value),\r
                  &Value\r
                  );\r
  if (!EFI_ERROR (Status)) {\r
    Private->IpSec.DisabledFlag = TRUE;\r
  }\r
\r
}\r
\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 IPsec driver which installs the driver binding,\r
  component name protocol, IPsec Config protcolon, and IPsec protocol in\r
  its ImageHandle.\r
\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
  @retval EFI_SUCCESS           The operation completed successfully.\r
  @retval EFI_ALREADY_STARTED   The IPsec driver has been already loaded.\r
  @retval EFI_OUT_OF_RESOURCES  The request could not be completed due to a lack of resources.\r
  @retval Others                The operation is failed.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
IpSecDriverEntryPoint (\r
  IN EFI_HANDLE              ImageHandle,\r
  IN EFI_SYSTEM_TABLE        *SystemTable\r
  )\r
{\r
  EFI_STATUS          Status;\r
  IPSEC_PRIVATE_DATA  *Private;\r
  EFI_IPSEC2_PROTOCOL *IpSec;\r
\r
  //\r
  // Check whether ipsec protocol has already been installed.\r
  //\r
  Status = gBS->LocateProtocol (&gEfiIpSecProtocolGuid, NULL, (VOID **) &IpSec);\r
\r
  if (!EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_WARN, "_ModuleEntryPoint: IpSec has been already loaded\n"));\r
    Status = EFI_ALREADY_STARTED;\r
    goto ON_EXIT;\r
  }\r
\r
  Status = gBS->LocateProtocol (&gEfiDpcProtocolGuid, NULL, (VOID **) &mDpc);\r
\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "_ModuleEntryPoint: Failed to locate EfiDpcProtocol\n"));\r
    goto ON_EXIT;\r
  }\r
\r
  Private = AllocateZeroPool (sizeof (IPSEC_PRIVATE_DATA));\r
\r
  if (Private == NULL) {\r
    DEBUG ((DEBUG_ERROR, "_ModuleEntryPoint: Failed to allocate private data\n"));\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto ON_EXIT;\r
  }\r
  //\r
  // Create disable event to cleanup all sa when ipsec disabled by user.\r
  //\r
  Status = gBS->CreateEvent (\r
                  EVT_NOTIFY_SIGNAL,\r
                  TPL_CALLBACK,\r
                  IpSecCleanupAllSa,\r
                  Private,\r
                  &mIpSecInstance.DisabledEvent\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "_ModuleEntryPoint: Failed to create disable event\n"));\r
    goto ON_FREE_PRIVATE;\r
  }\r
\r
  Private->Signature    = IPSEC_PRIVATE_DATA_SIGNATURE;\r
  Private->ImageHandle  = ImageHandle;\r
  CopyMem (&Private->IpSec, &mIpSecInstance, sizeof (EFI_IPSEC2_PROTOCOL));\r
\r
  //\r
  // Initilize Private's members. Thess members is used for IKE.\r
  //\r
  InitializeListHead (&Private->Udp4List);\r
  InitializeListHead (&Private->Udp6List);\r
  InitializeListHead (&Private->Ikev1SessionList);\r
  InitializeListHead (&Private->Ikev1EstablishedList);\r
  InitializeListHead (&Private->Ikev2SessionList);\r
  InitializeListHead (&Private->Ikev2EstablishedList);\r
\r
  //\r
  // Initialize the ipsec config data and restore it from variable.\r
  //\r
  Status = IpSecConfigInitialize (Private);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "_ModuleEntryPoint: Failed to initialize IpSecConfig\n"));\r
    goto ON_CLOSE_EVENT;\r
  }\r
  //\r
  // Install ipsec protocol which is used by ip driver to process ipsec header.\r
  //\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &Private->Handle,\r
                  &gEfiIpSecProtocolGuid,\r
                  &Private->IpSec,\r
                  NULL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_UNINSTALL_CONFIG;\r
  }\r
\r
  Status = EfiLibInstallDriverBindingComponentName2 (\r
             ImageHandle,\r
             SystemTable,\r
             &gIpSecDriverBinding,\r
             ImageHandle,\r
             &gIpSecComponentName,\r
             &gIpSecComponentName2\r
             );\r
  if (EFI_ERROR (Status)) {\r
    goto ON_UNINSTALL_CONFIG;\r
  }\r
\r
  return Status;\r
\r
ON_UNINSTALL_CONFIG:\r
  gBS->UninstallProtocolInterface (\r
        Private->Handle,\r
        &gEfiIpSecConfigProtocolGuid,\r
        &Private->IpSecConfig\r
        );\r
ON_CLOSE_EVENT:\r
  gBS->CloseEvent (mIpSecInstance.DisabledEvent);\r
  mIpSecInstance.DisabledEvent = NULL;\r
ON_FREE_PRIVATE:\r
  FreePool (Private);\r
ON_EXIT:\r
  return Status;\r
}\r
\r