]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Core/Dxe/Hand/Handle.c
Fix the typo in InstallMultipleProtocolInterfaces comments
[mirror_edk2.git] / MdeModulePkg / Core / Dxe / Hand / Handle.c
index cfa103c0e5bcac1f01e2f3baa22137516a79c886..6708ef8729ace640424f08c2296a90785c25798f 100644 (file)
@@ -1,8 +1,8 @@
 /** @file\r
   UEFI handle & protocol handling.\r
 \r
-Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>\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
@@ -13,6 +13,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 **/\r
 \r
 #include "DxeMain.h"\r
+#include "Handle.h"\r
 \r
 \r
 //\r
@@ -22,9 +23,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 // gHandleDatabaseKey    -  The Key to show that the handle has been created/modified\r
 //\r
 LIST_ENTRY      mProtocolDatabase     = INITIALIZE_LIST_HEAD_VARIABLE (mProtocolDatabase);\r
-LIST_ENTRY             gHandleList           = INITIALIZE_LIST_HEAD_VARIABLE (gHandleList);\r
-EFI_LOCK               gProtocolDatabaseLock = EFI_INITIALIZE_LOCK_VARIABLE (TPL_NOTIFY);\r
-UINT64                 gHandleDatabaseKey    = 0;\r
+LIST_ENTRY      gHandleList           = INITIALIZE_LIST_HEAD_VARIABLE (gHandleList);\r
+EFI_LOCK        gProtocolDatabaseLock = EFI_INITIALIZE_LOCK_VARIABLE (TPL_NOTIFY);\r
+UINT64          gHandleDatabaseKey    = 0;\r
 \r
 \r
 \r
@@ -364,13 +365,13 @@ CoreInstallProtocolInterfaceNotify (
   //\r
   // Print debug message\r
   //\r
-  DEBUG((DEBUG_LOAD | DEBUG_INFO, "InstallProtocolInterface: %g %p\n", Protocol, Interface));\r
+  DEBUG((DEBUG_INFO, "InstallProtocolInterface: %g %p\n", Protocol, Interface));\r
 \r
   Status = EFI_OUT_OF_RESOURCES;\r
   Prot = NULL;\r
   Handle = NULL;\r
 \r
-  if (*UserHandle != NULL_HANDLE) {\r
+  if (*UserHandle != NULL) {\r
     Status = CoreHandleProtocol (*UserHandle, Protocol, (VOID **)&ExistingInterface);\r
     if (!EFI_ERROR (Status)) {\r
       return EFI_INVALID_PARAMETER;\r
@@ -504,8 +505,9 @@ Done:
   occures all the protocols added by this function are removed. This is\r
   basically a lib function to save space.\r
 \r
-  @param  Handle                 The handle to install the protocol handlers on,\r
-                                 or NULL if a new handle is to be allocated\r
+  @param  Handle                 The pointer to a handle to install the new\r
+                                 protocol interfaces on, or a pointer to NULL\r
+                                 if a new handle is to be allocated.\r
   @param  ...                    EFI_GUID followed by protocol instance. A NULL\r
                                  terminates the  list. The pairs are the\r
                                  arguments to InstallProtocolInterface(). All the\r
@@ -564,7 +566,7 @@ CoreInstallMultipleProtocolInterfaces (
       DeviceHandle = NULL;\r
       DevicePath   = Interface;\r
       Status = CoreLocateDevicePath (&gEfiDevicePathProtocolGuid, &DevicePath, &DeviceHandle);\r
-      if (!EFI_ERROR (Status) && (DeviceHandle != NULL_HANDLE) && IsDevicePathEnd(DevicePath)) {\r
+      if (!EFI_ERROR (Status) && (DeviceHandle != NULL) && IsDevicePathEnd(DevicePath)) {\r
         Status = EFI_ALREADY_STARTED;\r
         continue;\r
       }\r
@@ -575,6 +577,7 @@ CoreInstallMultipleProtocolInterfaces (
     //\r
     Status = CoreInstallProtocolInterface (Handle, Protocol, EFI_NATIVE_INTERFACE, Interface);\r
   }\r
+  VA_END (Args);\r
 \r
   //\r
   // If there was an error, remove all the interfaces that were installed without any errors\r
@@ -589,6 +592,8 @@ CoreInstallMultipleProtocolInterfaces (
       Interface = VA_ARG (Args, VOID *);\r
       CoreUninstallProtocolInterface (*Handle, Protocol, Interface);\r
     }\r
+    VA_END (Args);\r
+    \r
     *Handle = OldHandle;\r
   }\r
 \r
@@ -636,7 +641,7 @@ CoreDisconnectControllersUsingProtocolInterface (
           (Link != &Prot->OpenList) && !ItemFound;\r
           Link = Link->ForwardLink ) {\r
       OpenData = CR (Link, OPEN_PROTOCOL_DATA, Link, OPEN_PROTOCOL_DATA_SIGNATURE);\r
-      if (OpenData->Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) {\r
+      if ((OpenData->Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) != 0) {\r
         ItemFound = TRUE;\r
         CoreReleaseProtocolLock ();\r
         Status = CoreDisconnectController (UserHandle, OpenData->AgentHandle, NULL);\r
@@ -659,8 +664,8 @@ CoreDisconnectControllersUsingProtocolInterface (
             (Link != &Prot->OpenList) && !ItemFound;\r
             Link = Link->ForwardLink ) {\r
         OpenData = CR (Link, OPEN_PROTOCOL_DATA, Link, OPEN_PROTOCOL_DATA_SIGNATURE);\r
-        if (OpenData->Attributes &\r
-            (EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL | EFI_OPEN_PROTOCOL_GET_PROTOCOL | EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) {\r
+        if ((OpenData->Attributes &\r
+            (EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL | EFI_OPEN_PROTOCOL_GET_PROTOCOL | EFI_OPEN_PROTOCOL_TEST_PROTOCOL)) != 0) {\r
           ItemFound = TRUE;\r
           RemoveEntryList (&OpenData->Link);\r
           Prot->OpenListCount--;\r
@@ -844,6 +849,7 @@ CoreUninstallMultipleProtocolInterfaces (
     //\r
     Status = CoreUninstallProtocolInterface (Handle, Protocol, Interface);\r
   }\r
+  VA_END (Args);\r
 \r
   //\r
   // If there was an error, add all the interfaces that were\r
@@ -859,6 +865,7 @@ CoreUninstallMultipleProtocolInterfaces (
       Interface = VA_ARG(Args, VOID *);\r
       CoreInstallProtocolInterface (&Handle, Protocol, EFI_NATIVE_INTERFACE, Interface);\r
     }\r
+    VA_END (Args);\r
   }\r
 \r
   return Status;\r
@@ -916,7 +923,11 @@ CoreGetProtocolInterface (
   @param  Interface              Supplies the address where a pointer to the\r
                                  corresponding Protocol Interface is returned.\r
 \r
-  @return The requested protocol interface for the handle\r
+  @retval EFI_SUCCESS            The interface information for the specified protocol was returned.\r
+  @retval EFI_UNSUPPORTED        The device does not support the specified protocol.\r
+  @retval EFI_INVALID_PARAMETER  Handle is NULL..\r
+  @retval EFI_INVALID_PARAMETER  Protocol is NULL.\r
+  @retval EFI_INVALID_PARAMETER  Interface is NULL.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1076,14 +1087,14 @@ CoreOpenProtocol (
     ExactMatch =  (BOOLEAN)((OpenData->AgentHandle == ImageHandle) &&\r
                             (OpenData->Attributes == Attributes)  &&\r
                             (OpenData->ControllerHandle == ControllerHandle));\r
-    if (OpenData->Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) {\r
+    if ((OpenData->Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) != 0) {\r
       ByDriver = TRUE;\r
       if (ExactMatch) {\r
         Status = EFI_ALREADY_STARTED;\r
         goto Done;\r
       }\r
     }\r
-    if (OpenData->Attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) {\r
+    if ((OpenData->Attributes & EFI_OPEN_PROTOCOL_EXCLUSIVE) != 0) {\r
       Exclusive = TRUE;\r
     } else if (ExactMatch) {\r
       OpenData->OpenCount++;\r
@@ -1117,7 +1128,7 @@ CoreOpenProtocol (
         Disconnect = FALSE;\r
         for ( Link = Prot->OpenList.ForwardLink; (Link != &Prot->OpenList) && (!Disconnect); Link = Link->ForwardLink) {\r
           OpenData = CR (Link, OPEN_PROTOCOL_DATA, Link, OPEN_PROTOCOL_DATA_SIGNATURE);\r
-          if (OpenData->Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) {\r
+          if ((OpenData->Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) != 0) {\r
             Disconnect = TRUE;\r
             CoreReleaseProtocolLock ();\r
             Status = CoreDisconnectController (UserHandle, OpenData->AgentHandle, NULL);\r
@@ -1219,7 +1230,7 @@ CoreCloseProtocol (
   if (EFI_ERROR (Status)) {\r
     return Status;\r
   }\r
-  if (ControllerHandle != NULL_HANDLE) {\r
+  if (ControllerHandle != NULL) {\r
     Status = CoreValidateHandle (ControllerHandle);\r
     if (EFI_ERROR (Status)) {\r
       return Status;\r
@@ -1274,11 +1285,15 @@ Done:
 \r
   @param  UserHandle             The handle to close the protocol interface on\r
   @param  Protocol               The ID of the protocol\r
-  @param  EntryBuffer            A pointer to a buffer of open protocol\r
-                                 information in the form of\r
-                                 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY structures.\r
+  @param  EntryBuffer            A pointer to a buffer of open protocol information in the\r
+                                 form of EFI_OPEN_PROTOCOL_INFORMATION_ENTRY structures.\r
   @param  EntryCount             Number of EntryBuffer entries\r
 \r
+  @retval EFI_SUCCESS            The open protocol information was returned in EntryBuffer, \r
+                                 and the number of entries was returned EntryCount.\r
+  @retval EFI_NOT_FOUND          Handle does not support the protocol specified by Protocol.\r
+  @retval EFI_OUT_OF_RESOURCES   There are not enough resources available to allocate EntryBuffer.\r
+\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r