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

 /** @file
   The header file of UEFI Component Name(2) protocol.

 Copyright (c) 2004 - 2007, 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 _COMPONENT_NAME_H_
 #define _COMPONENT_NAME_H_

 #include <Protocol/ComponentName.h>
 #include <Protocol/ComponentName2.h>

 extern EFI_COMPONENT_NAME2_PROTOCOL       gIScsiComponentName2;
 extern EFI_COMPONENT_NAME_PROTOCOL        gIScsiComponentName;

 //
 // EFI Component Name Protocol for iSCSI driver.
 //

 /**
   Retrieves a Unicode string that is the user readable name of the EFI Driver.

   This function retrieves the user readable name of a driver in the form of a
   Unicode string. If the driver specified by This has a user readable name in
   the language specified by Language, then a pointer to the driver name is
   returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
   by This does not support the language specified by Language,
   then EFI_UNSUPPORTED is returned.

   @param[in]  This        A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
   @param[in]  Language    A pointer to a three characters ISO 639-2 language identifier.
                           This is the language of the driver name that that the caller
                           is requesting, and it must match one of the languages specified
                           in SupportedLanguages.  The number of languages supported by a
                           driver is up to the driver writer.
   @param[out]  DriverName A pointer to the Unicode string to return.  This Unicode string
                           is the name of the driver specified by This in the language
                           specified by Language.

   @retval EFI_SUCCESS           The Unicode string for the Driver specified by This
                                 and the language specified by Language was returned
                                 in DriverName.
   @retval EFI_INVALID_PARAMETER Language is NULL.
   @retval EFI_INVALID_PARAMETER DriverName is NULL.
   @retval EFI_UNSUPPORTED       The driver specified by This does not support the
                                 language specified by Language.
 **/
 EFI_STATUS
 EFIAPI
 IScsiComponentNameGetDriverName (
   IN  EFI_COMPONENT_NAME_PROTOCOL   *This,
   IN  CHAR8                         *Language,
   OUT CHAR16                        **DriverName
   );

 /**
   Retrieves a Unicode string that is the user readable name of the controller
   that is being managed by an EFI Driver. Currently not implemented.

   @param[in]  This             A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
   @param[in]  ControllerHandle The handle of a controller that the driver specified by
                                This is managing.  This handle specifies the controller
                                whose name is to be returned.
   @param[in]  ChildHandle      The handle of the child controller to retrieve the name
                                of.  This is an optional parameter that may be NULL.  It
                                will be NULL for device drivers.  It will also be NULL
                                for a bus drivers that wish to retrieve the name of the
                                bus controller.  It will not be NULL for a bus driver
                                that wishes to retrieve the name of a child controller.
   @param[in]  Language         A pointer to a three characters ISO 639-2 language
                                identifier.  This is the language of the controller name
                                that that the caller is requesting, and it must match one
                                of the languages specified in SupportedLanguages.  The
                                number of languages supported by a driver is up to the
                                driver writer.
   @param[out]  ControllerName  A pointer to the Unicode string to return.  This Unicode
                                string is the name of the controller specified by
                                ControllerHandle and ChildHandle in the language specified
                                by Language from the point of view of the driver specified
                                by This.

   @retval EFI_SUCCESS           The Unicode string for the user readable name in the
                                 language specified by Language for the driver
                                 specified by This was returned in DriverName.
   @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
   @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.
   @retval EFI_INVALID_PARAMETER Language is NULL.
   @retval EFI_INVALID_PARAMETER ControllerName is NULL.
   @retval EFI_UNSUPPORTED       The driver specified by This is not currently managing
                                 the controller specified by ControllerHandle and
                                 ChildHandle.
   @retval EFI_UNSUPPORTED       The driver specified by This does not support the
                                 language specified by Language.
 **/
 EFI_STATUS
 EFIAPI
 IScsiComponentNameGetControllerName (
   IN  EFI_COMPONENT_NAME_PROTOCOL   *This,
   IN  EFI_HANDLE                    ControllerHandle,
   IN  EFI_HANDLE                    ChildHandle        OPTIONAL,
   IN  CHAR8                         *Language,
   OUT CHAR16                        **ControllerName
   );

 //
 // EFI iSCSI Initiator Name Protocol for IScsi driver.
 //

 /**
   Retrieves the current set value of iSCSI Initiator Name.

   @param[in]       This       Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.
   @param[in, out]  BufferSize Size of the buffer in bytes pointed to by Buffer / Actual size of the
                               variable data buffer.
   @param[out]      Buffer     Pointer to the buffer for data to be read.

   @retval EFI_SUCCESS           Data was successfully retrieved into the provided buffer and the
                                 BufferSize was sufficient to handle the iSCSI initiator name
   @retval EFI_BUFFER_TOO_SMALL  BufferSize is too small for the result.
   @retval EFI_INVALID_PARAMETER BufferSize or Buffer is NULL.
   @retval EFI_DEVICE_ERROR      The iSCSI initiator name could not be retrieved due to a hardware error.
   @retval Others                Other errors as indicated.
 **/
 EFI_STATUS
 EFIAPI
 IScsiGetInitiatorName (
   IN     EFI_ISCSI_INITIATOR_NAME_PROTOCOL  *This,
   IN OUT UINTN                              *BufferSize,
   OUT    VOID                               *Buffer
   );

 /**
   Sets the iSCSI Initiator Name.

   @param[in]       This       Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.
   @param[in, out]  BufferSize Size of the buffer in bytes pointed to by Buffer.
   @param[in]       Buffer     Pointer to the buffer for data to be written.

   @retval EFI_SUCCESS           Data was successfully stored by the protocol.
   @retval EFI_UNSUPPORTED       Platform policies do not allow for data to be written.
                                 Currently not implemented.
   @retval EFI_INVALID_PARAMETER BufferSize or Buffer is NULL, or BufferSize exceeds the maximum allowed limit.
   @retval EFI_DEVICE_ERROR      The data could not be stored due to a hardware error.
   @retval EFI_OUT_OF_RESOURCES  Not enough storage is available to hold the data.
   @retval EFI_PROTOCOL_ERROR    Input iSCSI initiator name does not adhere to RFC 3720
                                 (and other related protocols)
   @retval Others                Other errors as indicated.
 **/
 EFI_STATUS
 EFIAPI
 IScsiSetInitiatorName (
   IN     EFI_ISCSI_INITIATOR_NAME_PROTOCOL  *This,
   IN OUT UINTN                              *BufferSize,
   IN     VOID                               *Buffer
   );

 #endif
	/** @file
	The header file of UEFI Component Name(2) protocol.

	Copyright (c) 2004 - 2007, 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 _COMPONENT_NAME_H_
	#define _COMPONENT_NAME_H_

	#include <Protocol/ComponentName.h>
	#include <Protocol/ComponentName2.h>

	extern EFI_COMPONENT_NAME2_PROTOCOL gIScsiComponentName2;
	extern EFI_COMPONENT_NAME_PROTOCOL gIScsiComponentName;

	//
	// EFI Component Name Protocol for iSCSI driver.
	//

	/**
	Retrieves a Unicode string that is the user readable name of the EFI Driver.

	This function retrieves the user readable name of a driver in the form of a
	Unicode string. If the driver specified by This has a user readable name in
	the language specified by Language, then a pointer to the driver name is
	returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
	by This does not support the language specified by Language,
	then EFI_UNSUPPORTED is returned.

	@param[in] This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
	@param[in] Language A pointer to a three characters ISO 639-2 language identifier.
	This is the language of the driver name that that the caller
	is requesting, and it must match one of the languages specified
	in SupportedLanguages. The number of languages supported by a
	driver is up to the driver writer.
	@param[out] DriverName A pointer to the Unicode string to return. This Unicode string
	is the name of the driver specified by This in the language
	specified by Language.

	@retval EFI_SUCCESS The Unicode string for the Driver specified by This
	and the language specified by Language was returned
	in DriverName.
	@retval EFI_INVALID_PARAMETER Language is NULL.
	@retval EFI_INVALID_PARAMETER DriverName is NULL.
	@retval EFI_UNSUPPORTED The driver specified by This does not support the
	language specified by Language.
	**/
	EFI_STATUS
	EFIAPI
	IScsiComponentNameGetDriverName (
	IN EFI_COMPONENT_NAME_PROTOCOL *This,
	IN CHAR8 *Language,
	OUT CHAR16 **DriverName
	);

	/**
	Retrieves a Unicode string that is the user readable name of the controller
	that is being managed by an EFI Driver. Currently not implemented.

	@param[in] This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
	@param[in] ControllerHandle The handle of a controller that the driver specified by
	This is managing. This handle specifies the controller
	whose name is to be returned.
	@param[in] ChildHandle The handle of the child controller to retrieve the name
	of. This is an optional parameter that may be NULL. It
	will be NULL for device drivers. It will also be NULL
	for a bus drivers that wish to retrieve the name of the
	bus controller. It will not be NULL for a bus driver
	that wishes to retrieve the name of a child controller.
	@param[in] Language A pointer to a three characters ISO 639-2 language
	identifier. This is the language of the controller name
	that that the caller is requesting, and it must match one
	of the languages specified in SupportedLanguages. The
	number of languages supported by a driver is up to the
	driver writer.
	@param[out] ControllerName A pointer to the Unicode string to return. This Unicode
	string is the name of the controller specified by
	ControllerHandle and ChildHandle in the language specified
	by Language from the point of view of the driver specified
	by This.

	@retval EFI_SUCCESS The Unicode string for the user readable name in the
	language specified by Language for the driver
	specified by This was returned in DriverName.
	@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
	@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.
	@retval EFI_INVALID_PARAMETER Language is NULL.
	@retval EFI_INVALID_PARAMETER ControllerName is NULL.
	@retval EFI_UNSUPPORTED The driver specified by This is not currently managing
	the controller specified by ControllerHandle and
	ChildHandle.
	@retval EFI_UNSUPPORTED The driver specified by This does not support the
	language specified by Language.
	**/
	EFI_STATUS
	EFIAPI
	IScsiComponentNameGetControllerName (
	IN EFI_COMPONENT_NAME_PROTOCOL *This,
	IN EFI_HANDLE ControllerHandle,
	IN EFI_HANDLE ChildHandle OPTIONAL,
	IN CHAR8 *Language,
	OUT CHAR16 **ControllerName
	);

	//
	// EFI iSCSI Initiator Name Protocol for IScsi driver.
	//

	/**
	Retrieves the current set value of iSCSI Initiator Name.

	@param[in] This Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.
	@param[in, out] BufferSize Size of the buffer in bytes pointed to by Buffer / Actual size of the
	variable data buffer.
	@param[out] Buffer Pointer to the buffer for data to be read.

	@retval EFI_SUCCESS Data was successfully retrieved into the provided buffer and the
	BufferSize was sufficient to handle the iSCSI initiator name
	@retval EFI_BUFFER_TOO_SMALL BufferSize is too small for the result.
	@retval EFI_INVALID_PARAMETER BufferSize or Buffer is NULL.
	@retval EFI_DEVICE_ERROR The iSCSI initiator name could not be retrieved due to a hardware error.
	@retval Others Other errors as indicated.
	**/
	EFI_STATUS
	EFIAPI
	IScsiGetInitiatorName (
	IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL *This,
	IN OUT UINTN *BufferSize,
	OUT VOID *Buffer
	);

	/**
	Sets the iSCSI Initiator Name.

	@param[in] This Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.
	@param[in, out] BufferSize Size of the buffer in bytes pointed to by Buffer.
	@param[in] Buffer Pointer to the buffer for data to be written.

	@retval EFI_SUCCESS Data was successfully stored by the protocol.
	@retval EFI_UNSUPPORTED Platform policies do not allow for data to be written.
	Currently not implemented.
	@retval EFI_INVALID_PARAMETER BufferSize or Buffer is NULL, or BufferSize exceeds the maximum allowed limit.
	@retval EFI_DEVICE_ERROR The data could not be stored due to a hardware error.
	@retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the data.
	@retval EFI_PROTOCOL_ERROR Input iSCSI initiator name does not adhere to RFC 3720
	(and other related protocols)
	@retval Others Other errors as indicated.
	**/
	EFI_STATUS
	EFIAPI
	IScsiSetInitiatorName (
	IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL *This,
	IN OUT UINTN *BufferSize,
	IN VOID *Buffer
	);

	#endif