mirror of
https://github.com/CloverHackyColor/CloverBootloader.git
synced 2024-11-24 11:45:27 +01:00
339 lines
12 KiB
C
339 lines
12 KiB
C
|
/** @file
|
||
|
|
UEFI Component Name(2) protocol implementation for iSCSI.
|
||
|
|
|
||
|
|
Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>
|
||
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
||
|
|
|
||
|
|
**/
|
||
|
|
|
||
|
|
#include "IScsiImpl.h"
|
||
|
|
|
||
|
|
//
|
||
|
|
// EFI Component Name Protocol
|
||
|
|
//
|
||
|
|
GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gIScsiComponentName = {
|
||
|
|
IScsiComponentNameGetDriverName,
|
||
|
|
IScsiComponentNameGetControllerName,
|
||
|
|
"eng"
|
||
|
|
};
|
||
|
|
|
||
|
|
//
|
||
|
|
// EFI Component Name 2 Protocol
|
||
|
|
//
|
||
|
|
GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gIScsiComponentName2 = {
|
||
|
|
(EFI_COMPONENT_NAME2_GET_DRIVER_NAME) IScsiComponentNameGetDriverName,
|
||
|
|
(EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) IScsiComponentNameGetControllerName,
|
||
|
|
"en"
|
||
|
|
};
|
||
|
|
|
||
|
|
GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mIScsiDriverNameTable[] = {
|
||
|
|
{
|
||
|
|
"eng;en",
|
||
|
|
L"iSCSI Driver"
|
||
|
|
},
|
||
|
|
{
|
||
|
|
NULL,
|
||
|
|
NULL
|
||
|
|
}
|
||
|
|
};
|
||
|
|
|
||
|
|
GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE *gIScsiControllerNameTable = NULL;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Retrieves a Unicode string that is the user readable name of the 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_NAME2_PROTOCOL or
|
||
|
|
EFI_COMPONENT_NAME_PROTOCOL instance.
|
||
|
|
|
||
|
|
@param[in] Language A pointer to a Null-terminated ASCII string
|
||
|
|
array indicating the language. This is the
|
||
|
|
language of the driver name 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. Language is specified
|
||
|
|
in RFC 4646 or ISO 639-2 language code format.
|
||
|
|
|
||
|
|
@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
|
||
|
|
)
|
||
|
|
{
|
||
|
|
return LookupUnicodeString2 (
|
||
|
|
Language,
|
||
|
|
This->SupportedLanguages,
|
||
|
|
mIScsiDriverNameTable,
|
||
|
|
DriverName,
|
||
|
|
(BOOLEAN) (This == &gIScsiComponentName)
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
Update the component name for the iSCSI instance.
|
||
|
|
|
||
|
|
@param[in] IScsiExtScsiPassThru A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
|
||
|
|
@param[in] Ipv6Flag TRUE if IP6 network stack is used.
|
||
|
|
|
||
|
|
@retval EFI_SUCCESS Update the ControllerNameTable of this instance successfully.
|
||
|
|
@retval EFI_INVALID_PARAMETER The input parameter is invalid.
|
||
|
|
@retval EFI_UNSUPPORTED Can't get the corresponding NIC info from the Controller handle.
|
||
|
|
|
||
|
|
**/
|
||
|
|
EFI_STATUS
|
||
|
|
UpdateName (
|
||
|
|
IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *IScsiExtScsiPassThru,
|
||
|
|
IN BOOLEAN Ipv6Flag
|
||
|
|
)
|
||
|
|
{
|
||
|
|
EFI_STATUS Status;
|
||
|
|
CHAR16 HandleName[80];
|
||
|
|
ISCSI_DRIVER_DATA *Private;
|
||
|
|
UINT8 NicIndex;
|
||
|
|
|
||
|
|
if (IScsiExtScsiPassThru == NULL) {
|
||
|
|
return EFI_INVALID_PARAMETER;
|
||
|
|
}
|
||
|
|
|
||
|
|
Private = ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU (IScsiExtScsiPassThru);
|
||
|
|
NicIndex = Private->Session->ConfigData->NicIndex;
|
||
|
|
|
||
|
|
UnicodeSPrint (
|
||
|
|
HandleName,
|
||
|
|
sizeof (HandleName),
|
||
|
|
L"iSCSI (%s, NicIndex=%d)",
|
||
|
|
Ipv6Flag ? L"IPv6" : L"IPv4",
|
||
|
|
NicIndex
|
||
|
|
);
|
||
|
|
|
||
|
|
if (gIScsiControllerNameTable != NULL) {
|
||
|
|
FreeUnicodeStringTable (gIScsiControllerNameTable);
|
||
|
|
gIScsiControllerNameTable = NULL;
|
||
|
|
}
|
||
|
|
|
||
|
|
Status = AddUnicodeString2 (
|
||
|
|
"eng",
|
||
|
|
gIScsiComponentName.SupportedLanguages,
|
||
|
|
&gIScsiControllerNameTable,
|
||
|
|
HandleName,
|
||
|
|
TRUE
|
||
|
|
);
|
||
|
|
if (EFI_ERROR (Status)) {
|
||
|
|
return Status;
|
||
|
|
}
|
||
|
|
|
||
|
|
return AddUnicodeString2 (
|
||
|
|
"en",
|
||
|
|
gIScsiComponentName2.SupportedLanguages,
|
||
|
|
&gIScsiControllerNameTable,
|
||
|
|
HandleName,
|
||
|
|
FALSE
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
Retrieves a Unicode string that is the user readable name of the controller
|
||
|
|
that is being managed by a driver.
|
||
|
|
|
||
|
|
This function retrieves the user readable name of the controller specified by
|
||
|
|
ControllerHandle and ChildHandle 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 controller name is returned in ControllerName,
|
||
|
|
and EFI_SUCCESS is returned. If the driver specified by This is not currently
|
||
|
|
managing the controller specified by ControllerHandle and ChildHandle,
|
||
|
|
then EFI_UNSUPPORTED 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_NAME2_PROTOCOL or
|
||
|
|
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 Null-terminated ASCII string
|
||
|
|
array indicating the language. This is the
|
||
|
|
language of the driver name 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. Language is specified in
|
||
|
|
RFC 4646 or ISO 639-2 language code format.
|
||
|
|
|
||
|
|
@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 NULL.
|
||
|
|
|
||
|
|
@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_STATUS Status;
|
||
|
|
|
||
|
|
EFI_HANDLE IScsiController;
|
||
|
|
BOOLEAN Ipv6Flag;
|
||
|
|
EFI_GUID *IScsiPrivateGuid;
|
||
|
|
ISCSI_PRIVATE_PROTOCOL *IScsiIdentifier;
|
||
|
|
|
||
|
|
EFI_EXT_SCSI_PASS_THRU_PROTOCOL *IScsiExtScsiPassThru;
|
||
|
|
|
||
|
|
if (ControllerHandle == NULL) {
|
||
|
|
return EFI_UNSUPPORTED;
|
||
|
|
}
|
||
|
|
|
||
|
|
//
|
||
|
|
// Get the handle of the controller we are controling.
|
||
|
|
//
|
||
|
|
IScsiController = NetLibGetNicHandle (ControllerHandle, &gEfiTcp4ProtocolGuid);
|
||
|
|
if (IScsiController != NULL) {
|
||
|
|
IScsiPrivateGuid = &gIScsiV4PrivateGuid;
|
||
|
|
Ipv6Flag = FALSE;
|
||
|
|
} else {
|
||
|
|
IScsiController = NetLibGetNicHandle (ControllerHandle, &gEfiTcp6ProtocolGuid);
|
||
|
|
if (IScsiController != NULL) {
|
||
|
|
IScsiPrivateGuid = &gIScsiV6PrivateGuid;
|
||
|
|
Ipv6Flag = TRUE;
|
||
|
|
} else {
|
||
|
|
return EFI_UNSUPPORTED;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
Status = gBS->OpenProtocol (
|
||
|
|
IScsiController,
|
||
|
|
IScsiPrivateGuid,
|
||
|
|
(VOID **) &IScsiIdentifier,
|
||
|
|
NULL,
|
||
|
|
NULL,
|
||
|
|
EFI_OPEN_PROTOCOL_GET_PROTOCOL
|
||
|
|
);
|
||
|
|
if (EFI_ERROR (Status)) {
|
||
|
|
return Status;
|
||
|
|
}
|
||
|
|
|
||
|
|
if(ChildHandle != NULL) {
|
||
|
|
if(!Ipv6Flag) {
|
||
|
|
//
|
||
|
|
// Make sure this driver produced ChildHandle
|
||
|
|
//
|
||
|
|
Status = EfiTestChildHandle (
|
||
|
|
ControllerHandle,
|
||
|
|
ChildHandle,
|
||
|
|
&gEfiTcp4ProtocolGuid
|
||
|
|
);
|
||
|
|
if (EFI_ERROR (Status)) {
|
||
|
|
return Status;
|
||
|
|
}
|
||
|
|
} else {
|
||
|
|
//
|
||
|
|
// Make sure this driver produced ChildHandle
|
||
|
|
//
|
||
|
|
Status = EfiTestChildHandle (
|
||
|
|
ControllerHandle,
|
||
|
|
ChildHandle,
|
||
|
|
&gEfiTcp6ProtocolGuid
|
||
|
|
);
|
||
|
|
if (EFI_ERROR (Status)) {
|
||
|
|
return Status;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
//
|
||
|
|
// Retrieve an instance of a produced protocol from ChildHandle
|
||
|
|
//
|
||
|
|
Status = gBS->OpenProtocol (
|
||
|
|
ChildHandle,
|
||
|
|
&gEfiExtScsiPassThruProtocolGuid,
|
||
|
|
(VOID **)&IScsiExtScsiPassThru,
|
||
|
|
NULL,
|
||
|
|
NULL,
|
||
|
|
EFI_OPEN_PROTOCOL_GET_PROTOCOL
|
||
|
|
);
|
||
|
|
if (EFI_ERROR (Status)) {
|
||
|
|
return Status;
|
||
|
|
}
|
||
|
|
|
||
|
|
//
|
||
|
|
// Update the component name for this child handle.
|
||
|
|
//
|
||
|
|
Status = UpdateName (IScsiExtScsiPassThru, Ipv6Flag);
|
||
|
|
if (EFI_ERROR (Status)) {
|
||
|
|
return Status;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return LookupUnicodeString2 (
|
||
|
|
Language,
|
||
|
|
This->SupportedLanguages,
|
||
|
|
gIScsiControllerNameTable,
|
||
|
|
ControllerName,
|
||
|
|
(BOOLEAN)(This == &gIScsiComponentName)
|
||
|
|
);
|
||
|
|
}
|