remove some internal functions and allocate some FIFO data structure instead of decla...

[mirror_edk2.git] / MdeModulePkg / Universal / Network / MnpDxe / MnpDriver.c

/** @file\r
    Implementation of driver entry point and driver binding protocol.\r
\r
Copyright (c) 2005 - 2008, Intel Corporation.<BR>\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
**/\r
\r
#include "MnpDriver.h"\r
#include "MnpImpl.h"\r
\r
\r
EFI_DRIVER_BINDING_PROTOCOL gMnpDriverBinding = {\r
  MnpDriverBindingSupported,\r
  MnpDriverBindingStart,\r
  MnpDriverBindingStop,\r
  0xa,\r
  NULL,\r
  NULL\r
};\r
\r
/**\r
  Test to see if this driver supports ControllerHandle. This service\r
  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
\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
\r
  @retval EFI_SUCCESS         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
MnpDriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
  )\r
{\r
  EFI_STATUS                   Status;\r
  EFI_SIMPLE_NETWORK_PROTOCOL  *Snp;\r
\r
  //\r
  // Test to see if MNP is already installed.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiManagedNetworkServiceBindingProtocolGuid,\r
                  NULL,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
                  );\r
  if (!EFI_ERROR (Status)) {\r
    return EFI_ALREADY_STARTED;\r
  }\r
\r
  //\r
  // Test to open the Simple Network protocol BY_DRIVER.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiSimpleNetworkProtocolGuid,\r
                  (VOID **) &Snp,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Close the openned SNP protocol.\r
  //\r
  gBS->CloseProtocol (\r
         ControllerHandle,\r
         &gEfiSimpleNetworkProtocolGuid,\r
         This->DriverBindingHandle,\r
         ControllerHandle\r
         );\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Start this driver on ControllerHandle. This service is called by the\r
  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_SUCCESS          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
\r
**/\r
EFI_STATUS\r
EFIAPI\r
MnpDriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
  )\r
{\r
  EFI_STATUS        Status;\r
  MNP_SERVICE_DATA  *MnpServiceData;\r
  BOOLEAN           MnpInitialized;\r
\r
  MnpInitialized  = FALSE;\r
\r
  MnpServiceData  = AllocateZeroPool (sizeof (MNP_SERVICE_DATA));\r
  if (MnpServiceData == NULL) {\r
    DEBUG ((EFI_D_ERROR, "MnpDriverBindingStart(): Failed to allocate the Mnp Service Data.\n"));\r
\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  //\r
  // Initialize the Mnp Service Data.\r
  //\r
  Status = MnpInitializeServiceData (MnpServiceData, This->DriverBindingHandle, ControllerHandle);\r
  if (EFI_ERROR (Status)) {\r
\r
    DEBUG ((EFI_D_ERROR, "MnpDriverBindingStart: MnpInitializeServiceData failed, %r.\n",Status));\r
    goto ErrorExit;\r
  }\r
\r
  MnpInitialized = TRUE;\r
\r
  //\r
  // Install the MNP Service Binding Protocol.\r
  //\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &ControllerHandle,\r
                  &gEfiManagedNetworkServiceBindingProtocolGuid,\r
                  &MnpServiceData->ServiceBinding,\r
                  NULL\r
                  );\r
\r
ErrorExit:\r
\r
  if (EFI_ERROR (Status)) {\r
\r
    if (MnpInitialized) {\r
      //\r
      // Flush the Mnp Service Data.\r
      //\r
      MnpFlushServiceData (MnpServiceData, This->DriverBindingHandle);\r
    }\r
\r
    gBS->FreePool (MnpServiceData);\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Stop this driver on ControllerHandle. This service is called by the\r
  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
  \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 of\r
                                children is zero stop the entire bus driver.\r
  @param[in]  ChildHandleBuffer List of Child Handles to Stop.\r
\r
  @retval EFI_SUCCESS       This driver is removed ControllerHandle\r
  @retval other             This driver was not removed from this device\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
MnpDriverBindingStop (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN UINTN                        NumberOfChildren,\r
  IN EFI_HANDLE                   *ChildHandleBuffer\r
  )\r
{\r
  EFI_STATUS                    Status;\r
  EFI_SERVICE_BINDING_PROTOCOL  *ServiceBinding;\r
  MNP_SERVICE_DATA              *MnpServiceData;\r
  MNP_INSTANCE_DATA             *Instance;\r
\r
  //\r
  // Retrieve the MNP service binding protocol from the ControllerHandle.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiManagedNetworkServiceBindingProtocolGuid,\r
                  (VOID **) &ServiceBinding,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
\r
    DEBUG (\r
      (EFI_D_ERROR,\r
      "MnpDriverBindingStop: Locate MNP Service Binding Protocol failed, %r.\n",\r
      Status)\r
      );\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  MnpServiceData = MNP_SERVICE_DATA_FROM_THIS (ServiceBinding);\r
\r
  if (NumberOfChildren == 0) {\r
    //\r
    // Uninstall the MNP Service Binding Protocol.\r
    //\r
    gBS->UninstallMultipleProtocolInterfaces (\r
           ControllerHandle,\r
           &gEfiManagedNetworkServiceBindingProtocolGuid,\r
           ServiceBinding,\r
           NULL\r
           );\r
\r
    //\r
    // Flush the Mnp service data.\r
    //\r
    MnpFlushServiceData (MnpServiceData, This->DriverBindingHandle);\r
\r
    gBS->FreePool (MnpServiceData);\r
  } else {\r
    while (!IsListEmpty (&MnpServiceData->ChildrenList)) {\r
      //\r
      // Don't use NetListRemoveHead here, the remove opreration will be done\r
      // in ServiceBindingDestroyChild.\r
      //\r
      Instance = NET_LIST_HEAD (\r
                   &MnpServiceData->ChildrenList,\r
                   MNP_INSTANCE_DATA,\r
                   InstEntry\r
                   );\r
\r
      ServiceBinding->DestroyChild (ServiceBinding, Instance->Handle);\r
    }\r
  }\r
\r
  return Status;\r
}\r
\r
\r
/**\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 in ChildHandle. \r
  If ChildHandle is not a pointer to NULL, then the protocol 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 UEFI handle, \r
                      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
EFIAPI\r
MnpServiceBindingCreateChild (\r
  IN EFI_SERVICE_BINDING_PROTOCOL  *This,\r
  IN OUT EFI_HANDLE                *ChildHandle\r
  )\r
{\r
  EFI_STATUS         Status;\r
  MNP_SERVICE_DATA   *MnpServiceData;\r
  MNP_INSTANCE_DATA  *Instance;\r
  VOID               *Snp;\r
  EFI_TPL            OldTpl;\r
\r
  if ((This == NULL) || (ChildHandle == NULL)) {\r
\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  MnpServiceData = MNP_SERVICE_DATA_FROM_THIS (This);\r
\r
  //\r
  // Allocate buffer for the new instance.\r
  //\r
  Instance = AllocateZeroPool (sizeof (MNP_INSTANCE_DATA));\r
  if (Instance == NULL) {\r
\r
    DEBUG ((EFI_D_ERROR, "MnpServiceBindingCreateChild: Faild to allocate memory for the new instance.\n"));\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  //\r
  // Init the instance data.\r
  //\r
  MnpInitializeInstanceData (MnpServiceData, Instance);\r
\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  ChildHandle,\r
                  &gEfiManagedNetworkProtocolGuid,\r
                  &Instance->ManagedNetwork,\r
                  NULL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
\r
    DEBUG (\r
      (EFI_D_ERROR,\r
      "MnpServiceBindingCreateChild: Failed to install the MNP protocol, %r.\n",\r
      Status)\r
      );\r
    goto ErrorExit;\r
  }\r
\r
  //\r
  // Save the instance's childhandle.\r
  //\r
  Instance->Handle = *ChildHandle;\r
\r
  Status = gBS->OpenProtocol (\r
                  MnpServiceData->ControllerHandle,\r
                  &gEfiSimpleNetworkProtocolGuid,\r
                  (VOID **) &Snp,\r
                  gMnpDriverBinding.DriverBindingHandle,\r
                  Instance->Handle,\r
                  EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto ErrorExit;\r
  }\r
\r
  //\r
  // Add the child instance into ChildrenList.\r
  //\r
  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
\r
  InsertTailList (&MnpServiceData->ChildrenList, &Instance->InstEntry);\r
  MnpServiceData->ChildrenNumber++;\r
\r
  gBS->RestoreTPL (OldTpl);\r
\r
ErrorExit:\r
\r
  if (EFI_ERROR (Status)) {\r
\r
    if (Instance->Handle != NULL) {\r
\r
      gBS->UninstallMultipleProtocolInterfaces (\r
            &gEfiManagedNetworkProtocolGuid,\r
            &Instance->ManagedNetwork,\r
            NULL\r
            );\r
    }\r
\r
    gBS->FreePool (Instance);\r
  }\r
\r
  return Status;\r
}\r
\r
\r
/**\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        Pointer to the EFI_SERVICE_BINDING_PROTOCOL instance.\r
  @param  ChildHandle Handle of the child to destroy\r
\r
  @retval EFI_SUCCES            The protocol was removed from ChildHandle.\r
  @retval EFI_UNSUPPORTED       ChildHandle does not support the protocol that is being removed.\r
  @retval EFI_INVALID_PARAMETER Child handle is not a valid UEFI Handle.\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
EFIAPI\r
MnpServiceBindingDestroyChild (\r
  IN EFI_SERVICE_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                    ChildHandle\r
  )\r
{\r
  EFI_STATUS                    Status;\r
  MNP_SERVICE_DATA              *MnpServiceData;\r
  EFI_MANAGED_NETWORK_PROTOCOL  *ManagedNetwork;\r
  MNP_INSTANCE_DATA             *Instance;\r
  EFI_TPL                       OldTpl;\r
\r
  if ((This == NULL) || (ChildHandle == NULL)) {\r
\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  MnpServiceData = MNP_SERVICE_DATA_FROM_THIS (This);\r
\r
  //\r
  // Try to retrieve ManagedNetwork Protocol from ChildHandle.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ChildHandle,\r
                  &gEfiManagedNetworkProtocolGuid,\r
                  (VOID **) &ManagedNetwork,\r
                  gMnpDriverBinding.DriverBindingHandle,\r
                  ChildHandle,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  Instance = MNP_INSTANCE_DATA_FROM_THIS (ManagedNetwork);\r
\r
  //\r
  // MnpServiceBindingDestroyChild may be called twice: first called by\r
  // MnpServiceBindingStop, second called by uninstalling the MNP protocol\r
  // in this ChildHandle. Use destroyed to make sure the resource clean code\r
  // will only excecute once.\r
  //\r
  if (Instance->Destroyed) {\r
\r
    return EFI_SUCCESS;\r
  }\r
\r
  Instance->Destroyed = TRUE;\r
\r
  //\r
  // Close the Simple Network protocol.\r
  //\r
  gBS->CloseProtocol (\r
         MnpServiceData->ControllerHandle,\r
         &gEfiSimpleNetworkProtocolGuid,\r
         gMnpDriverBinding.DriverBindingHandle,\r
         ChildHandle\r
         );\r
\r
  //\r
  // Uninstall the ManagedNetwork protocol.\r
  //\r
  Status = gBS->UninstallMultipleProtocolInterfaces (\r
                  ChildHandle,\r
                  &gEfiManagedNetworkProtocolGuid,\r
                  &Instance->ManagedNetwork,\r
                  NULL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
\r
    DEBUG (\r
      (EFI_D_ERROR,\r
      "MnpServiceBindingDestroyChild: Failed to uninstall the ManagedNetwork protocol, %r.\n",\r
      Status)\r
      );\r
\r
    Instance->Destroyed = FALSE;\r
    return Status;\r
  }\r
\r
  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
\r
  //\r
  // Reset the configuration.\r
  //\r
  ManagedNetwork->Configure (ManagedNetwork, NULL);\r
\r
  //\r
  // Try to flush the RcvdPacketQueue.\r
  //\r
  MnpFlushRcvdDataQueue (Instance);\r
\r
  //\r
  // Clean the RxTokenMap.\r
  //\r
  NetMapClean (&Instance->RxTokenMap);\r
\r
  //\r
  // Remove this instance from the ChildrenList.\r
  //\r
  RemoveEntryList (&Instance->InstEntry);\r
  MnpServiceData->ChildrenNumber--;\r
\r
  gBS->RestoreTPL (OldTpl);\r
\r
  gBS->FreePool (Instance);\r
\r
  return Status;\r
}\r
\r
/**\r
  The entry point for Mnp driver which installs the driver binding and component\r
  name 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_SUCCES       The driver binding and component name protocols are \r
                           successfully installed.\r
  @retval other            failed.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
MnpDriverEntryPoint (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  return EfiLibInstallDriverBindingComponentName2 (\r
           ImageHandle,\r
           SystemTable,\r
           &gMnpDriverBinding,\r
           ImageHandle,\r
           &gMnpComponentName,\r
           &gMnpComponentName2\r
           );\r
}\r