MdeModulePkg/Universal/Network/IScsiDxe/IScsiDriver.h - edk2 - Git at Google

 /** @file
   The header file of IScsiDriver.c.

 Copyright (c) 2004 - 2008, Intel Corporation. All rights reserved.<BR>
 This program and the accompanying materials
 are licensed and made available under the terms and conditions of the BSD License
 which accompanies this distribution.  The full text of the license may be found at
 http://opensource.org/licenses/bsd-license.php

 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 **/

 #ifndef _ISCSI_DRIVER_H_
 #define _ISCSI_DRIVER_H_

 #include <Uefi.h>
 #include <Protocol/DevicePath.h>
 #include <Protocol/LoadedImage.h>
 #include <Protocol/HiiConfigAccess.h>
 #include <Protocol/HiiDatabase.h>
 #include <Library/UefiDriverEntryPoint.h>
 #include <Library/UefiBootServicesTableLib.h>
 #include <Library/UefiLib.h>
 #include <Library/DevicePathLib.h>
 #include <Protocol/DriverBinding.h>
 #include <Protocol/ScsiPassThruExt.h>

 #define ISCSI_PRIVATE_GUID \
   { 0xfa3cde4c, 0x87c2, 0x427d, {0xae, 0xde, 0x7d, 0xd0, 0x96, 0xc8, 0x8c, 0x58} }

 #define ISCSI_INITIATOR_NAME_VAR_NAME L"I_NAME"

 extern EFI_GUID                           gIScsiPrivateGuid;

 typedef struct _ISCSI_PRIVATE_PROTOCOL {
   UINT32  Reserved;
 } ISCSI_PRIVATE_PROTOCOL;

 //
 // EFI Driver Binding Protocol for iSCSI driver.
 //

 /**
   Tests to see if this driver supports a given controller. If a child device is provided,
   it further tests to see if this driver supports creating a handle for the specified child device.

   @param[in]  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
   @param[in]  ControllerHandle     The handle of the controller to test. This handle
                                    must support a protocol interface that supplies
                                    an I/O abstraction to the driver.
   @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path.
                                    This parameter is ignored by device drivers, and is optional for bus drivers.


   @retval EFI_SUCCESS              The device specified by ControllerHandle and
                                    RemainingDevicePath is supported by the driver specified by This.
   @retval EFI_ALREADY_STARTED      The device specified by ControllerHandle and
                                    RemainingDevicePath is already being managed by the driver
                                    specified by This.
   @retval EFI_ACCESS_DENIED        The device specified by ControllerHandle and
                                    RemainingDevicePath is already being managed by a different
                                    driver or an application that requires exclusive acces.
                                    Currently not implemented.
   @retval EFI_UNSUPPORTED          The device specified by ControllerHandle and
                                    RemainingDevicePath is not supported by the driver specified by This.
 **/
 EFI_STATUS
 EFIAPI
 IScsiDriverBindingSupported (
   IN EFI_DRIVER_BINDING_PROTOCOL  *This,
   IN EFI_HANDLE                   ControllerHandle,
   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL
   );

 /**
   Start this driver on ControllerHandle. The Start() function is designed to be
   invoked from the EFI boot service ConnectController(). As a result, much of
   the error checking on the parameters to Start() has been moved into this
   common boot service. It is legal to call Start() from other locations,
   but the following calling restrictions must be followed or the system behavior will not be deterministic.
   1. ControllerHandle must be a valid EFI_HANDLE.
   2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned
      EFI_DEVICE_PATH_PROTOCOL.
   3. Prior to calling Start(), the Supported() function for the driver specified by This must
      have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.

   @param[in]  This                 A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
   @param[in]  ControllerHandle     The handle of the controller to start. This handle
                                    must support a protocol interface that supplies
                                    an I/O abstraction to the driver.
   @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path.
                                    This parameter is ignored by device drivers, and is optional for bus drivers.

   @retval EFI_SUCCESS              The device was started.
   @retval EFI_DEVICE_ERROR         The device could not be started due to a device error.
                                    Currently not implemented.
   @retval EFI_OUT_OF_RESOURCES     The request could not be completed due to a lack of resources.
   @retval Others                   The driver failded to start the device.
 **/
 EFI_STATUS
 EFIAPI
 IScsiDriverBindingStart (
   IN EFI_DRIVER_BINDING_PROTOCOL  *This,
   IN EFI_HANDLE                   ControllerHandle,
   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL
   );

 /**
   Stop this driver on ControllerHandle.

   Release the control of this controller and remove the IScsi functions. The Stop()
   function is designed to be invoked from the EFI boot service DisconnectController().
   As a result, much of the error checking on the parameters to Stop() has been moved
   into this common boot service. It is legal to call Stop() from other locations,
   but the following calling restrictions must be followed or the system behavior will not be deterministic.
   1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this
      same driver's Start() function.
   2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid
      EFI_HANDLE. In addition, all of these handles must have been created in this driver's
      Start() function, and the Start() function must have called OpenProtocol() on
      ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.

   @param[in]  This              A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
   @param[in]  ControllerHandle  A handle to the device being stopped. The handle must
                                 support a bus specific I/O protocol for the driver
                                 to use to stop the device.
   @param[in]  NumberOfChildren  The number of child device handles in ChildHandleBuffer.Not used.
   @param[in]  ChildHandleBuffer An array of child handles to be freed. May be NULL
                                 if NumberOfChildren is 0.Not used.

   @retval EFI_SUCCESS           The device was stopped.
   @retval EFI_DEVICE_ERROR      The device could not be stopped due to a device error.
 **/
 EFI_STATUS
 EFIAPI
 IScsiDriverBindingStop (
   IN EFI_DRIVER_BINDING_PROTOCOL  *This,
   IN EFI_HANDLE                   ControllerHandle,
   IN UINTN                        NumberOfChildren,
   IN EFI_HANDLE                   *ChildHandleBuffer OPTIONAL
   );

 #endif
	/** @file
	The header file of IScsiDriver.c.

	Copyright (c) 2004 - 2008, Intel Corporation. All rights reserved.<BR>
	This program and the accompanying materials
	are licensed and made available under the terms and conditions of the BSD License
	which accompanies this distribution. The full text of the license may be found at
	http://opensource.org/licenses/bsd-license.php

	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

	**/

	#ifndef _ISCSI_DRIVER_H_
	#define _ISCSI_DRIVER_H_

	#include <Uefi.h>
	#include <Protocol/DevicePath.h>
	#include <Protocol/LoadedImage.h>
	#include <Protocol/HiiConfigAccess.h>
	#include <Protocol/HiiDatabase.h>
	#include <Library/UefiDriverEntryPoint.h>
	#include <Library/UefiBootServicesTableLib.h>
	#include <Library/UefiLib.h>
	#include <Library/DevicePathLib.h>
	#include <Protocol/DriverBinding.h>
	#include <Protocol/ScsiPassThruExt.h>

	#define ISCSI_PRIVATE_GUID \
	{ 0xfa3cde4c, 0x87c2, 0x427d, {0xae, 0xde, 0x7d, 0xd0, 0x96, 0xc8, 0x8c, 0x58} }

	#define ISCSI_INITIATOR_NAME_VAR_NAME L"I_NAME"

	extern EFI_GUID gIScsiPrivateGuid;

	typedef struct _ISCSI_PRIVATE_PROTOCOL {
	UINT32 Reserved;
	} ISCSI_PRIVATE_PROTOCOL;

	//
	// EFI Driver Binding Protocol for iSCSI driver.
	//

	/**
	Tests to see if this driver supports a given controller. If a child device is provided,
	it further tests to see if this driver supports creating a handle for the specified child device.

	@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
	@param[in] ControllerHandle The handle of the controller to test. This handle
	must support a protocol interface that supplies
	an I/O abstraction to the driver.
	@param[in] RemainingDevicePath A pointer to the remaining portion of a device path.
	This parameter is ignored by device drivers, and is optional for bus drivers.


	@retval EFI_SUCCESS The device specified by ControllerHandle and
	RemainingDevicePath is supported by the driver specified by This.
	@retval EFI_ALREADY_STARTED The device specified by ControllerHandle and
	RemainingDevicePath is already being managed by the driver
	specified by This.
	@retval EFI_ACCESS_DENIED The device specified by ControllerHandle and
	RemainingDevicePath is already being managed by a different
	driver or an application that requires exclusive acces.
	Currently not implemented.
	@retval EFI_UNSUPPORTED The device specified by ControllerHandle and
	RemainingDevicePath is not supported by the driver specified by This.
	**/
	EFI_STATUS
	EFIAPI
	IScsiDriverBindingSupported (
	IN EFI_DRIVER_BINDING_PROTOCOL *This,
	IN EFI_HANDLE ControllerHandle,
	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
	);

	/**
	Start this driver on ControllerHandle. The Start() function is designed to be
	invoked from the EFI boot service ConnectController(). As a result, much of
	the error checking on the parameters to Start() has been moved into this
	common boot service. It is legal to call Start() from other locations,
	but the following calling restrictions must be followed or the system behavior will not be deterministic.
	1. ControllerHandle must be a valid EFI_HANDLE.
	2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned
	EFI_DEVICE_PATH_PROTOCOL.
	3. Prior to calling Start(), the Supported() function for the driver specified by This must
	have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.

	@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
	@param[in] ControllerHandle The handle of the controller to start. This handle
	must support a protocol interface that supplies
	an I/O abstraction to the driver.
	@param[in] RemainingDevicePath A pointer to the remaining portion of a device path.
	This parameter is ignored by device drivers, and is optional for bus drivers.

	@retval EFI_SUCCESS The device was started.
	@retval EFI_DEVICE_ERROR The device could not be started due to a device error.
	Currently not implemented.
	@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
	@retval Others The driver failded to start the device.
	**/
	EFI_STATUS
	EFIAPI
	IScsiDriverBindingStart (
	IN EFI_DRIVER_BINDING_PROTOCOL *This,
	IN EFI_HANDLE ControllerHandle,
	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
	);

	/**
	Stop this driver on ControllerHandle.

	Release the control of this controller and remove the IScsi functions. The Stop()
	function is designed to be invoked from the EFI boot service DisconnectController().
	As a result, much of the error checking on the parameters to Stop() has been moved
	into this common boot service. It is legal to call Stop() from other locations,
	but the following calling restrictions must be followed or the system behavior will not be deterministic.
	1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this
	same driver's Start() function.
	2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid
	EFI_HANDLE. In addition, all of these handles must have been created in this driver's
	Start() function, and the Start() function must have called OpenProtocol() on
	ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.

	@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
	@param[in] ControllerHandle A handle to the device being stopped. The handle must
	support a bus specific I/O protocol for the driver
	to use to stop the device.
	@param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer.Not used.
	@param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL
	if NumberOfChildren is 0.Not used.

	@retval EFI_SUCCESS The device was stopped.
	@retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.
	**/
	EFI_STATUS
	EFIAPI
	IScsiDriverBindingStop (
	IN EFI_DRIVER_BINDING_PROTOCOL *This,
	IN EFI_HANDLE ControllerHandle,
	IN UINTN NumberOfChildren,
	IN EFI_HANDLE *ChildHandleBuffer OPTIONAL
	);

	#endif