Code have been checked with spec

[mirror_edk2.git] / MdePkg / Include / Protocol / ServiceBinding.h

diff --git a/MdePkg/Include/Protocol/ServiceBinding.h b/MdePkg/Include/Protocol/ServiceBinding.h
index 5f37727d6e7907787768a6d27ba9b2c452855577..5a1896392a662f61eb0b164326c71a4af3b28bb7 100644 (file)
--- a/MdePkg/Include/Protocol/ServiceBinding.h
+++ b/MdePkg/Include/Protocol/ServiceBinding.h
@@ -1,4 +1,5 @@
-/** @file\r
+/** @file  \r
+  UEFI Service Binding Protocol is defined in UEFI specification.\r
 \r
   The file defines the generic Service Binding Protocol functions.\r
   It provides services that are required to create and destroy child \r
@@ -24,14 +25,17 @@
 typedef struct _EFI_SERVICE_BINDING_PROTOCOL EFI_SERVICE_BINDING_PROTOCOL;\r
 \r
 /**\r
-  Creates a child handle with a set of I/O services.\r
+  Creates a child handle and installs a protocol.\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        Protocol instance pointer.\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 not NULL, then the\r
-                      I/O services are added to the existing child handle.\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 child handle was created with the I/O services\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
@@ -43,21 +47,22 @@ EFI_STATUS
 (EFIAPI *EFI_SERVICE_BINDING_CREATE_CHILD)(\r
   IN     EFI_SERVICE_BINDING_PROTOCOL  *This,\r
   IN OUT EFI_HANDLE                    *ChildHandle\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
-  Destroys a child handle with a set of I/O services.\r
+  Destroys a child handle with a protocol installed on it.\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        Protocol instance pointer.\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 I/O services were removed from the child handle\r
-  @retval EFI_UNSUPPORTED       The child handle does not support the I/O services\r
-                                that are being removed.\r
-  @retval EFI_INVALID_PARAMETER Child handle is not a valid EFI Handle.\r
-  @retval EFI_ACCESS_DENIED     The child handle could not be destroyed because its\r
-                                I/O services are being used.\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
@@ -66,27 +71,19 @@ EFI_STATUS
 (EFIAPI *EFI_SERVICE_BINDING_DESTROY_CHILD)(\r
   IN EFI_SERVICE_BINDING_PROTOCOL          *This,\r
   IN EFI_HANDLE                            ChildHandle\r
-  )\r
-;\r
-\r
-/**  \r
-  @par Protocol Description:\r
-  The EFI_SERVICE_BINDING_PROTOCOL provides member functions to create and destroy \r
-  child handles. A driver is responsible for adding protocols to the child handle \r
-  in CreateChild() and removing protocols in DestroyChild(). It is also required \r
-  that the CreateChild() function opens the parent protocol BY_CHILD_CONTROLLER \r
-  to establish the parent-child relationship, and closes the protocol in DestroyChild().\r
-  The pseudo code for CreateChild() and DestroyChild() is provided to specify the \r
-  required behavior, not to specify the required implementation. Each consumer of \r
-  a software protocol is responsible for calling CreateChild() when it requires the \r
-  protocol and calling DestroyChild() when it is finished with that protocol.\r
-\r
-  @param CreateChild\r
-  Creates a child handle and installs a protocol.\r
+  );\r
 \r
-  @param DestroyChild\r
-  Destroys a child handle with a protocol installed on it.\r
-**/\r
+///\r
+/// The EFI_SERVICE_BINDING_PROTOCOL provides member functions to create and destroy \r
+/// child handles. A driver is responsible for adding protocols to the child handle \r
+/// in CreateChild() and removing protocols in DestroyChild(). It is also required \r
+/// that the CreateChild() function opens the parent protocol BY_CHILD_CONTROLLER \r
+/// to establish the parent-child relationship, and closes the protocol in DestroyChild().\r
+/// The pseudo code for CreateChild() and DestroyChild() is provided to specify the \r
+/// required behavior, not to specify the required implementation. Each consumer of \r
+/// a software protocol is responsible for calling CreateChild() when it requires the \r
+/// protocol and calling DestroyChild() when it is finished with that protocol.\r
+///\r
 struct _EFI_SERVICE_BINDING_PROTOCOL {\r
   EFI_SERVICE_BINDING_CREATE_CHILD         CreateChild;\r
   EFI_SERVICE_BINDING_DESTROY_CHILD        DestroyChild;\r