update file header
authorywu21 <ywu21@6f19259b-4bc3-4df7-8a09-765794883524>
Wed, 10 Dec 2008 02:34:43 +0000 (02:34 +0000)
committerywu21 <ywu21@6f19259b-4bc3-4df7-8a09-765794883524>
Wed, 10 Dec 2008 02:34:43 +0000 (02:34 +0000)
update function header according to <Protocol/DriverBinding.h>

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

MdeModulePkg/Universal/Network/IScsiDxe/IScsiDriver.c

index beee62c..b23289f 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
-  The entry point of IScsi driver\r
+  The entry point of IScsi driver.\r
 \r
-Copyright (c) 2004 - 2008, Intel Corporation\r
+Copyright (c) 2004 - 2008, Intel Corporation.<BR>\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
@@ -10,13 +10,6 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-Module Name:\r
-\r
-  IScsiDriver.c\r
-\r
-Abstract:\r
-  The entry point of IScsi driver\r
-\r
 **/\r
 \r
 #include "IScsiImpl.h"\r
@@ -32,28 +25,37 @@ EFI_DRIVER_BINDING_PROTOCOL gIScsiDriverBinding = {
 \r
 EFI_GUID                    mIScsiPrivateGuid   = ISCSI_PRIVATE_GUID;\r
 \r
-/**\r
-  Test to see if IScsi driver supports the given controller. \r
-\r
-  @param  This[in]                Protocol instance pointer.\r
-\r
-  @param  ControllerHandle[in]    Handle of controller to test.\r
-\r
-  @param  RemainingDevicePath[in] Optional parameter use to pick a specific child device to start.\r
-\r
-  @retval EFI_SUCCES              This driver supports the controller.\r
-\r
-  @retval EFI_ALREADY_STARTED     This driver is already running on this device.\r
-\r
-  @retval EFI_UNSUPPORTED         This driver doesn't support the controller.\r
 \r
+/**\r
+  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[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
 EFI_STATUS\r
 EFIAPI\r
 IScsiDriverBindingSupported (\r
-  IN EFI_DRIVER_BINDING_PROTOCOL  * This,\r
+  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
   IN EFI_HANDLE                   ControllerHandle,\r
-  IN EFI_DEVICE_PATH_PROTOCOL     * RemainingDevicePath OPTIONAL\r
+  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
   )\r
 {\r
   EFI_STATUS                Status;\r
@@ -100,25 +102,36 @@ IScsiDriverBindingSupported (
 }\r
 \r
 /**\r
-  Start to manage the controller. \r
-\r
-  @param  This[in]                Protocol instance pointer.\r
-\r
-  @param  ControllerHandle[in]    Handle of the controller.\r
-\r
-  @param  RemainingDevicePath[in] Optional parameter use to pick a specific child device to start.\r
-\r
-  @retval EFI_SUCCES              This driver supports this device.\r
-\r
-  @retval EFI_ALREADY_STARTED     This driver is already running on this device.\r
-\r
+  Start this driver on ControllerHandle. The Start() function is designed to be \r
+  invoked from the EFI boot service ConnectController(). As a result, much of \r
+  the error checking on the parameters to Start() has been moved into this \r
+  common boot service. It is legal to call Start() from other locations, \r
+  but the following calling restrictions must be followed or the system behavior will not be deterministic.\r
+  1. ControllerHandle must be a valid EFI_HANDLE.\r
+  2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned\r
+     EFI_DEVICE_PATH_PROTOCOL.\r
+  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[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.\r
+                                   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
 EFI_STATUS\r
 EFIAPI\r
 IScsiDriverBindingStart (\r
-  IN EFI_DRIVER_BINDING_PROTOCOL  * This,\r
+  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
   IN EFI_HANDLE                   ControllerHandle,\r
-  IN EFI_DEVICE_PATH_PROTOCOL     * RemainingDevicePath OPTIONAL\r
+  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
   )\r
 {\r
   EFI_STATUS        Status;\r
@@ -205,18 +218,30 @@ ON_ERROR:
 }\r
 \r
 /**\r
-  Release the control of this controller and remove the IScsi functions.\r
-\r
-  @param  This[in]              Protocol instance pointer.\r
-\r
-  @param  ControllerHandle[in]  Handle of controller to stop.\r
-\r
-  @param  NumberOfChildren[in]  Not used.\r
-\r
-  @param  ChildHandleBuffer[in] Not used.\r
-\r
-  @retval EFI_SUCCES            This driver supports this device.\r
-\r
+  Stop this driver on ControllerHandle. \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
+  1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this\r
+     same driver's Start() function.\r
+  2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid\r
+     EFI_HANDLE. In addition, all of these handles must have been created in this driver's\r
+     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[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
 EFI_STATUS\r
 EFIAPI\r
@@ -307,14 +332,12 @@ IScsiDriverBindingStop (
 }\r
 \r
 /**\r
-  Unload the iSCSI driver.\r
-\r
-  @param  ImageHandle[in]  The handle of the driver image.\r
+  Unloads an image(the iSCSI driver).\r
 \r
-  @retval EFI_SUCCESS      The driver is unloaded.\r
-\r
-  @retval EFI_DEVICE_ERROR Some unexpected error happened.\r
+  @param[in]  ImageHandle       Handle that identifies the image to be unloaded.\r
 \r
+  @retval EFI_SUCCESS           The image has been unloaded.\r
+  @retval Others                Some unexpected errors happened.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -375,16 +398,17 @@ EfiIScsiUnload (
 }\r
 \r
 /**\r
-  Initialize the global variables publish the driver binding protocol.\r
-\r
-  @param  ImageHandle[in]  The handle of the driver image.\r
-\r
-  @param  SystemTable[in]  The EFI system table.\r
-\r
-  @retval EFI_SUCCESS      The protocols are installed.\r
+  This is the declaration of an EFI image entry point. This entry point is\r
+  the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including\r
+  both device drivers and bus drivers. It initialize the global variables and \r
+  publish the driver binding protocol.\r
 \r
-  @retval EFI_DEVICE_ERROR Some unexpected error happened.\r
+  @param[in]   ImageHandle      The firmware allocated handle for the UEFI image.\r
+  @param[in]   SystemTable      A pointer to the EFI System Table.\r
 \r
+  @retval EFI_SUCCESS           The operation completed successfully.\r
+  @retval EFI_ACCESS_DENIED     EFI_ISCSI_INITIATOR_NAME_PROTOCOL was installed unexpectedly.\r
+  @retval Others                Some unexpected error happened.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r