add [in] [out] in comment

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6859 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdePkg/Include/Protocol/DriverBinding.h b/MdePkg/Include/Protocol/DriverBinding.h
index b2720d7048ccc505598d78d4c26baeae39225d31..475988c90414c56ab428d8a40b9f790774d638e5 100644 (file)
--- a/MdePkg/Include/Protocol/DriverBinding.h
+++ b/MdePkg/Include/Protocol/DriverBinding.h
@@ -33,24 +33,25 @@ typedef struct _EFI_DRIVER_BINDING_PROTOCOL  EFI_DRIVER_BINDING_PROTOCOL;
   Tests to see if this driver supports a given controller. If a child device is provided, \r
   it further tests to see if this driver supports creating a handle for the specified child device.\r
 \r
-  @param  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
-  @param  ControllerHandle     The handle of the controller to test. This handle \r
-                               must support a protocol interface that supplies \r
-                               an I/O abstraction to the driver.\r
-  @param  RemainingDevicePath  A pointer to the remaining portion of a device path. \r
-                               This parameter is ignored by device drivers, and is optional for bus drivers.\r
-\r
-\r
-  @retval EFI_SUCCESS         The device specified by ControllerHandle and\r
-                              RemainingDevicePath is supported by the driver specified by This.\r
-  @retval EFI_ALREADY_STARTED The device specified by ControllerHandle and\r
-                              RemainingDevicePath is already being managed by the driver\r
-                              specified by This.\r
-  @retval EFI_ACCESS_DENIED   The device specified by ControllerHandle and\r
-                              RemainingDevicePath is already being managed by a different\r
-                              driver or an application that requires exclusive acces.\r
-  @retval EFI_UNSUPPORTED     The device specified by ControllerHandle and\r
-                              RemainingDevicePath is not supported by the driver specified by This.\r
+  @param[in]  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
+  @param[in]  ControllerHandle     The handle of the controller to test. This handle \r
+                                   must support a protocol interface that supplies \r
+                                   an I/O abstraction to the driver.\r
+  @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path. \r
+                                   This parameter is ignored by device drivers, and is optional for bus drivers.\r
+\r
+\r
+  @retval EFI_SUCCESS              The device specified by ControllerHandle and\r
+                                   RemainingDevicePath is supported by the driver specified by This.\r
+  @retval EFI_ALREADY_STARTED      The device specified by ControllerHandle and\r
+                                   RemainingDevicePath is already being managed by the driver\r
+                                   specified by This.\r
+  @retval EFI_ACCESS_DENIED        The device specified by ControllerHandle and\r
+                                   RemainingDevicePath is already being managed by a different\r
+                                   driver or an application that requires exclusive acces.\r
+                                   Currently not implemented.\r
+  @retval EFI_UNSUPPORTED          The device specified by ControllerHandle and\r
+                                   RemainingDevicePath is not supported by the driver specified by This.\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -72,17 +73,17 @@ EFI_STATUS
   3. Prior to calling Start(), the Supported() function for the driver specified by This must\r
      have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.  \r
 \r
-  @param  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
-  @param  ControllerHandle     The handle of the controller to start. This handle \r
-                               must support a protocol interface that supplies \r
-                               an I/O abstraction to the driver.\r
-  @param  RemainingDevicePath  A pointer to the remaining portion of a device path. \r
-                               This parameter is ignored by device drivers, and is optional for bus drivers.\r
-\r
-  @retval EFI_SUCCESS          The device was started.\r
-  @retval EFI_DEVICE_ERROR     The device could not be started due to a device error.\r
-  @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r
-\r
+  @param[in]  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
+  @param[in]  ControllerHandle     The handle of the controller to start. This handle \r
+                                   must support a protocol interface that supplies \r
+                                   an I/O abstraction to the driver.\r
+  @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path. \r
+                                   This parameter is ignored by device drivers, and is optional for bus drivers.\r
+\r
+  @retval EFI_SUCCESS              The device was started.\r
+  @retval EFI_DEVICE_ERROR         The device could not be started due to a device error.Currently not implemented.\r
+  @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of resources.\r
+  @retval Others                   The driver failded to start the device.\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -94,7 +95,9 @@ EFI_STATUS
 \r
 /**\r
   Stop this driver on ControllerHandle. \r
-  The Stop() function is designed to be invoked from the EFI boot service DisconnectController(). \r
+  \r
+  Release the control of this controller and remove the IScsi functions. The Stop()\r
+  function is designed to be invoked from the EFI boot service DisconnectController(). \r
   As a result, much of the error checking on the parameters to Stop() has been moved \r
   into this common boot service. It is legal to call Stop() from other locations, \r
   but the following calling restrictions must be followed or the system behavior will not be deterministic.\r
@@ -105,16 +108,16 @@ EFI_STATUS
      Start() function, and the Start() function must have called OpenProtocol() on\r
      ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.\r
   \r
-  @param  This              A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
-  @param  ControllerHandle  A handle to the device being stopped. The handle must \r
-                            support a bus specific I/O protocol for the driver \r
-                            to use to stop the device.\r
-  @param  NumberOfChildren  The number of child device handles in ChildHandleBuffer.\r
-  @param  ChildHandleBuffer An array of child handles to be freed. May be NULL if NumberOfChildren is 0.\r
-\r
-  @retval EFI_SUCCESS       The device was stopped.\r
-  @retval EFI_DEVICE_ERROR  The device could not be stopped due to a device error.\r
-\r
+  @param[in]  This              A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
+  @param[in]  ControllerHandle  A handle to the device being stopped. The handle must \r
+                                support a bus specific I/O protocol for the driver \r
+                                to use to stop the device.\r
+  @param[in]  NumberOfChildren  The number of child device handles in ChildHandleBuffer.Not used.\r
+  @param[in]  ChildHandleBuffer An array of child handles to be freed. May be NULL \r
+                                if NumberOfChildren is 0.Not used.\r
+\r
+  @retval EFI_SUCCESS           The device was stopped.\r
+  @retval EFI_DEVICE_ERROR      The device could not be stopped due to a device error.\r
 **/\r
 typedef\r
 EFI_STATUS\r