Code Scrub for Protocol and Ppi Definition

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

diff --git a/MdePkg/Include/Protocol/ServiceBinding.h b/MdePkg/Include/Protocol/ServiceBinding.h
index cbaa8ea17f72eedb053679052003884318c984da..c0b5e832321c733c1abf0f57abf7b38987766973 100644 (file)
--- a/MdePkg/Include/Protocol/ServiceBinding.h
+++ b/MdePkg/Include/Protocol/ServiceBinding.h
@@ -1,10 +1,10 @@
 /** @file\r
 \r
-  The file defines the generic Service Binding Protocol\r
-  functions.\r
+  The file defines the generic Service Binding Protocol functions.\r
+  It provides services that are required to create and destroy child \r
+  handles that support a given set of protocols.\r
 \r
-\r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 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
@@ -69,6 +69,24 @@ EFI_STATUS
   )\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
+  @param DestroyChild\r
+  Destroys a child handle with a protocol installed on it.\r
+**/\r
 struct _EFI_SERVICE_BINDING_PROTOCOL {\r
   EFI_SERVICE_BINDING_CREATE_CHILD         CreateChild;\r
   EFI_SERVICE_BINDING_DESTROY_CHILD        DestroyChild;\r