]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/Network/MnpDxe/MnpDriver.c
fix code style issue and add function header
[mirror_edk2.git] / MdeModulePkg / Universal / Network / MnpDxe / MnpDriver.c
index 946ace1f66a25178cdccb0913adf31d8007970fc..b6c0138b517ed54b29131c052f51e193a3ef3876 100644 (file)
@@ -1,6 +1,6 @@
 /** @file\r
 \r
-Copyright (c) 2005 - 2007, Intel Corporation\r
+Copyright (c) 2005 - 2008, 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
@@ -19,7 +19,6 @@ Abstract:
 **/\r
 \r
 #include "MnpDriver.h"\r
-#include "MnpDebug.h"\r
 #include "MnpImpl.h"\r
 \r
 \r
@@ -32,18 +31,22 @@ EFI_DRIVER_BINDING_PROTOCOL gMnpDriverBinding = {
   NULL\r
 };\r
 \r
-\r
 /**\r
-  Test to see if this driver supports ControllerHandle.\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
-\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
+  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  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
+\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
@@ -54,7 +57,8 @@ MnpDriverBindingSupported (
   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
   )\r
 {\r
-  EFI_STATUS  Status;\r
+  EFI_STATUS                   Status;\r
+  EFI_SIMPLE_NETWORK_PROTOCOL  *Snp;\r
 \r
   //\r
   // Test to see if MNP is already installed.\r
@@ -68,38 +72,55 @@ MnpDriverBindingSupported (
                   EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
                   );\r
   if (!EFI_ERROR (Status)) {\r
-\r
     return EFI_ALREADY_STARTED;\r
   }\r
 \r
   //\r
-  // Test to see if SNP is installed.\r
+  // Test to open the Simple Network protocol BY_DRIVER.\r
   //\r
   Status = gBS->OpenProtocol (\r
                   ControllerHandle,\r
                   &gEfiSimpleNetworkProtocolGuid,\r
-                  NULL,\r
+                  (VOID **) &Snp,\r
                   This->DriverBindingHandle,\r
                   ControllerHandle,\r
-                  EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
+                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                   );\r
 \r
-  return Status;\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
-/**\r
-  Start this driver on ControllerHandle.\r
+  return EFI_SUCCESS;\r
+}\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\r
-                                 ControllerHandle.\r
-  @retval other                  This driver does not support this device.\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  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_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
@@ -116,10 +137,9 @@ MnpDriverBindingStart (
 \r
   MnpInitialized  = FALSE;\r
 \r
-  MnpServiceData  = NetAllocateZeroPool (sizeof (MNP_SERVICE_DATA));\r
+  MnpServiceData  = AllocateZeroPool (sizeof (MNP_SERVICE_DATA));\r
   if (MnpServiceData == NULL) {\r
-    MNP_DEBUG_ERROR (("MnpDriverBindingStart(): Failed to allocate the "\r
-      L"Mnp Service Data.\n"));\r
+    DEBUG ((EFI_D_ERROR, "MnpDriverBindingStart(): Failed to allocate the Mnp Service Data.\n"));\r
 \r
     return EFI_OUT_OF_RESOURCES;\r
   }\r
@@ -130,8 +150,7 @@ MnpDriverBindingStart (
   Status = MnpInitializeServiceData (MnpServiceData, This->DriverBindingHandle, ControllerHandle);\r
   if (EFI_ERROR (Status)) {\r
 \r
-    MNP_DEBUG_ERROR (("MnpDriverBindingStart: MnpInitializeServiceData "\r
-      L"failed, %r.\n",Status));\r
+    DEBUG ((EFI_D_ERROR, "MnpDriverBindingStart: MnpInitializeServiceData failed, %r.\n",Status));\r
     goto ErrorExit;\r
   }\r
 \r
@@ -155,37 +174,31 @@ ErrorExit:
       //\r
       // Flush the Mnp Service Data.\r
       //\r
-      MnpFlushServiceData (MnpServiceData);\r
+      MnpFlushServiceData (MnpServiceData, This->DriverBindingHandle);\r
     }\r
 \r
-    //\r
-    // Close the Simple Network Protocol.\r
-    //\r
-    gBS->CloseProtocol (\r
-          ControllerHandle,\r
-          &gEfiSimpleNetworkProtocolGuid,\r
-          This->DriverBindingHandle,\r
-          ControllerHandle\r
-          );\r
-\r
-    NetFreePool (MnpServiceData);\r
+    gBS->FreePool (MnpServiceData);\r
   }\r
 \r
   return Status;\r
 }\r
 \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
+  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  This              Protocol instance pointer.\r
+  @param  ControllerHandle  Handle of device to stop driver on\r
+  @param  NumberOfChildren  Number of Handles in ChildHandleBuffer. If number of\r
+                            children is zero stop the entire bus driver.\r
+  @param  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
@@ -215,8 +228,9 @@ MnpDriverBindingStop (
                   );\r
   if (EFI_ERROR (Status)) {\r
 \r
-    MNP_DEBUG_ERROR (\r
-      ("MnpDriverBindingStop: Locate MNP Service Binding Protocol failed, %r.\n",\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
@@ -235,24 +249,14 @@ MnpDriverBindingStop (
            NULL\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
     //\r
     // Flush the Mnp service data.\r
     //\r
-    MnpFlushServiceData (MnpServiceData);\r
+    MnpFlushServiceData (MnpServiceData, This->DriverBindingHandle);\r
 \r
-    NetFreePool (MnpServiceData);\r
+    gBS->FreePool (MnpServiceData);\r
   } else {\r
-    while (!NetListIsEmpty (&MnpServiceData->ChildrenList)) {\r
+    while (!IsListEmpty (&MnpServiceData->ChildrenList)) {\r
       //\r
       // Don't use NetListRemoveHead here, the remove opreration will be done\r
       // in ServiceBindingDestroyChild.\r
@@ -310,10 +314,10 @@ MnpServiceBindingCreateChild (
   //\r
   // Allocate buffer for the new instance.\r
   //\r
-  Instance = NetAllocateZeroPool (sizeof (MNP_INSTANCE_DATA));\r
+  Instance = AllocateZeroPool (sizeof (MNP_INSTANCE_DATA));\r
   if (Instance == NULL) {\r
 \r
-    MNP_DEBUG_ERROR (("MnpServiceBindingCreateChild: Faild to allocate memory for the new instance.\n"));\r
+    DEBUG ((EFI_D_ERROR, "MnpServiceBindingCreateChild: Faild to allocate memory for the new instance.\n"));\r
     return EFI_OUT_OF_RESOURCES;\r
   }\r
 \r
@@ -330,8 +334,9 @@ MnpServiceBindingCreateChild (
                   );\r
   if (EFI_ERROR (Status)) {\r
 \r
-    MNP_DEBUG_ERROR (\r
-      ("MnpServiceBindingCreateChild: Failed to install the MNP protocol, %r.\n",\r
+    DEBUG (\r
+      (EFI_D_ERROR,\r
+      "MnpServiceBindingCreateChild: Failed to install the MNP protocol, %r.\n",\r
       Status)\r
       );\r
     goto ErrorExit;\r
@@ -357,12 +362,12 @@ MnpServiceBindingCreateChild (
   //\r
   // Add the child instance into ChildrenList.\r
   //\r
-  OldTpl = NET_RAISE_TPL (NET_TPL_LOCK);\r
+  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
 \r
-  NetListInsertTail (&MnpServiceData->ChildrenList, &Instance->InstEntry);\r
+  InsertTailList (&MnpServiceData->ChildrenList, &Instance->InstEntry);\r
   MnpServiceData->ChildrenNumber++;\r
 \r
-  NET_RESTORE_TPL (OldTpl);\r
+  gBS->RestoreTPL (OldTpl);\r
 \r
 ErrorExit:\r
 \r
@@ -377,7 +382,7 @@ ErrorExit:
             );\r
     }\r
 \r
-    NetFreePool (Instance);\r
+    gBS->FreePool (Instance);\r
   }\r
 \r
   return Status;\r
@@ -472,8 +477,9 @@ MnpServiceBindingDestroyChild (
                   );\r
   if (EFI_ERROR (Status)) {\r
 \r
-    MNP_DEBUG_ERROR (\r
-      ("MnpServiceBindingDestroyChild: Failed to uninstall the ManagedNetwork protocol, %r.\n",\r
+    DEBUG (\r
+      (EFI_D_ERROR,\r
+      "MnpServiceBindingDestroyChild: Failed to uninstall the ManagedNetwork protocol, %r.\n",\r
       Status)\r
       );\r
 \r
@@ -481,7 +487,7 @@ MnpServiceBindingDestroyChild (
     return Status;\r
   }\r
 \r
-  OldTpl = NET_RAISE_TPL (NET_TPL_LOCK);\r
+  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
 \r
   //\r
   // Reset the configuration.\r
@@ -501,41 +507,34 @@ MnpServiceBindingDestroyChild (
   //\r
   // Remove this instance from the ChildrenList.\r
   //\r
-  NetListRemoveEntry (&Instance->InstEntry);\r
+  RemoveEntryList (&Instance->InstEntry);\r
   MnpServiceData->ChildrenNumber--;\r
 \r
-  NET_RESTORE_TPL (OldTpl);\r
+  gBS->RestoreTPL (OldTpl);\r
 \r
-  NetFreePool (Instance);\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  ImageHandle   The image handle of the driver.\r
+  @param  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
-\r
-Routine Description:\r
-\r
-  The entry point for Mnp 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