/** @file\r
- UEFI Component Name(2) protocol implementation.\r
+ UEFI Component Name(2) protocol implementation for iSCSI.\r
\r
-Copyright (c) 2004 - 2008, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2004 - 2015, Intel Corporation. All rights reserved.<BR>\r
+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
http://opensource.org/licenses/bsd-license.php\r
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
- ComponentName.c\r
-\r
-Abstract:\r
-\r
- ComponentName protocol for iSCSI.\r
-\r
**/\r
\r
#include "IScsiImpl.h"\r
{NULL, NULL}\r
};\r
\r
+GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE *mIScsiControllerNameTable = NULL;\r
+\r
/**\r
Retrieves a Unicode string that is the user readable name of the EFI Driver.\r
\r
returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r
by This does not support the language specified by Language,\r
then EFI_UNSUPPORTED is returned.\r
-\r
- @param This[in] A pointer to the EFI_COMPONENT_NAME_PROTOCOL\r
- instance.\r
-\r
- @param Language[in] A pointer to a three character ISO 639-2 language\r
- identifier.\r
- This is the language of the driver name that that\r
- the caller is requesting, and it must match one of\r
- the languages specified in SupportedLanguages. \r
- The number of languages supported by a driver is up\r
- to the driver writer.\r
-\r
- @param DriverName[out] A pointer to the Unicode string to return.\r
- This Unicode string is the name of the\r
- driver specified by This in the language\r
- specified by Language.\r
-\r
- @retval EFI_SUCCESS The Unicode string for the Driver specified by\r
- This and the language specified by Language was\r
- returned in DriverName.\r
-\r
+ \r
+ @param[in] This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r
+ @param[in] Language A pointer to a three character ISO 639-2 language identifier.\r
+ This is the language of the driver name that that the caller\r
+ is requesting, and it must match one of the languages specified\r
+ in SupportedLanguages. The number of languages supported by a\r
+ driver is up to the driver writer.\r
+ @param[out] DriverName A pointer to the Unicode string to return. This Unicode string\r
+ is the name of the driver specified by This in the language\r
+ specified by Language.\r
+\r
+ @retval EFI_SUCCESS The Unicode string for the Driver specified by This\r
+ and the language specified by Language was returned\r
+ in DriverName.\r
@retval EFI_INVALID_PARAMETER Language is NULL.\r
-\r
@retval EFI_INVALID_PARAMETER DriverName is NULL.\r
-\r
- @retval EFI_UNSUPPORTED The driver specified by This does not support\r
- the language specified by Language.\r
-\r
+ @retval EFI_UNSUPPORTED The driver specified by This does not support the\r
+ language specified by Language.\r
**/\r
EFI_STATUS\r
EFIAPI\r
}\r
\r
/**\r
- Retrieves a Unicode string that is the user readable name of the controller\r
- that is being managed by an EFI Driver.\r
-\r
- @param This[in] A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r
-\r
- @param ControllerHandle[in] The handle of a controller that the driver specified by\r
- This is managing. This handle specifies the controller\r
- whose name is to be returned.\r
-\r
- @param ChildHandle[in] The handle of the child controller to retrieve the name\r
- of. This is an optional parameter that may be NULL. It\r
- will be NULL for device drivers. It will also be NULL\r
- for a bus drivers that wish to retrieve the name of the\r
- bus controller. It will not be NULL for a bus driver\r
- that wishes to retrieve the name of a child controller.\r
-\r
- @param Language[in] A pointer to a three character ISO 639-2 language \r
- identifier. This is the language of the controller name\r
- that that the caller is requesting, and it must match one\r
- of the languages specified in SupportedLanguages. The\r
- number of languages supported by a driver is up to the\r
- driver writer.\r
-\r
- @param ControllerName[out] A pointer to the Unicode string to return. This Unicode\r
- string is the name of the controller specified by \r
- ControllerHandle and ChildHandle in the language \r
- specified by Language from the point of view of the \r
- driver specified by This. \r
-\r
- @retval EFI_SUCCESS The Unicode string for the user readable name in the \r
- language specified by Language for the driver \r
- specified by This was returned in DriverName.\r
-\r
- @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
+ Update the component name for the iSCSI instance.\r
+\r
+ @param[in] IScsiExtScsiPassThru A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.\r
+ \r
+ @retval EFI_SUCCESS Update the ControllerNameTable of this instance successfully.\r
+ @retval EFI_INVALID_PARAMETER The input parameter is invalid.\r
+ @retval EFI_UNSUPPORTED Can't get the corresponding NIC info from the Controller handle.\r
+ \r
+**/\r
+EFI_STATUS\r
+UpdateName (\r
+ IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *IScsiExtScsiPassThru\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ CHAR16 HandleName[150];\r
+ ISCSI_DRIVER_DATA *Private;\r
+ EFI_MAC_ADDRESS MacAddress;\r
+ UINTN HwAddressSize;\r
+ UINT16 VlanId;\r
+ CHAR16 MacString[70];\r
+\r
+ if (IScsiExtScsiPassThru == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ \r
+ Private = ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU (IScsiExtScsiPassThru);\r
+\r
+ //\r
+ // Get the mac string, it's the name of various variable\r
+ //\r
+ Status = NetLibGetMacAddress (Private->Controller, &MacAddress, &HwAddressSize);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+ VlanId = NetLibGetVlanId (Private->Controller);\r
+ IScsiMacAddrToStr (&MacAddress, (UINT32) HwAddressSize, VlanId, MacString);\r
+ \r
+ UnicodeSPrint (\r
+ HandleName,\r
+ sizeof (HandleName),\r
+ L"iSCSI IPv4 (MacString=%s)",\r
+ MacString\r
+ );\r
+\r
+ if (mIScsiControllerNameTable != NULL) {\r
+ FreeUnicodeStringTable (mIScsiControllerNameTable);\r
+ mIScsiControllerNameTable = NULL;\r
+ }\r
+\r
+ Status = AddUnicodeString2 (\r
+ "eng",\r
+ gIScsiComponentName.SupportedLanguages,\r
+ &mIScsiControllerNameTable,\r
+ HandleName,\r
+ TRUE\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ return AddUnicodeString2 (\r
+ "en",\r
+ gIScsiComponentName2.SupportedLanguages,\r
+ &mIScsiControllerNameTable,\r
+ HandleName,\r
+ FALSE\r
+ );\r
+}\r
\r
+/**\r
+ Retrieves a Unicode string that is the user readable name of the controller\r
+ that is being managed by an EFI Driver.Currently not implemented.\r
+\r
+ @param[in] This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r
+ @param[in] ControllerHandle The handle of a controller that the driver specified by\r
+ This is managing. This handle specifies the controller\r
+ whose name is to be returned.\r
+ @param[in] ChildHandle The handle of the child controller to retrieve the name\r
+ of. This is an optional parameter that may be NULL. It\r
+ will be NULL for device drivers. It will also be NULL\r
+ for a bus drivers that wish to retrieve the name of the\r
+ bus controller. It will not be NULL for a bus driver\r
+ that wishes to retrieve the name of a child controller.\r
+ @param[in] Language A pointer to a three character ISO 639-2 language\r
+ identifier. This is the language of the controller name\r
+ that that the caller is requesting, and it must match one\r
+ of the languages specified in SupportedLanguages. The\r
+ number of languages supported by a driver is up to the\r
+ driver writer.\r
+ @param[out] ControllerName A pointer to the Unicode string to return. This Unicode\r
+ string is the name of the controller specified by\r
+ ControllerHandle and ChildHandle in the language specified\r
+ by Language from the point of view of the driver specified\r
+ by This.\r
+\r
+ @retval EFI_SUCCESS The Unicode string for the user readable name in the\r
+ language specified by Language for the driver\r
+ specified by This was returned in DriverName. \r
+ @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.\r
-\r
@retval EFI_INVALID_PARAMETER Language is NULL.\r
-\r
@retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
-\r
@retval EFI_UNSUPPORTED The driver specified by This is not currently managing\r
- the controller specified by ControllerHandle and ChildHandle.\r
-\r
- @retval EFI_UNSUPPORTED The driver specified by This does not support the \r
+ the controller specified by ControllerHandle and\r
+ ChildHandle.\r
+ @retval EFI_UNSUPPORTED The driver specified by This does not support the\r
language specified by Language.\r
-\r
**/\r
EFI_STATUS\r
EFIAPI\r
OUT CHAR16 **ControllerName\r
)\r
{\r
- return EFI_UNSUPPORTED;\r
+ EFI_STATUS Status;\r
+\r
+ EFI_HANDLE IScsiController;\r
+ ISCSI_PRIVATE_PROTOCOL *IScsiIdentifier;\r
+\r
+ EFI_EXT_SCSI_PASS_THRU_PROTOCOL *IScsiExtScsiPassThru;\r
+\r
+ if (ControllerHandle == NULL) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+\r
+ //\r
+ // Get the handle of the controller we are controling.\r
+ //\r
+ IScsiController = NetLibGetNicHandle (ControllerHandle, &gEfiTcp4ProtocolGuid);\r
+ if (IScsiController == NULL) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+\r
+ Status = gBS->OpenProtocol (\r
+ IScsiController,\r
+ &gEfiCallerIdGuid,\r
+ (VOID **)&IScsiIdentifier,\r
+ NULL,\r
+ NULL,\r
+ EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ if (ChildHandle != NULL) {\r
+ //\r
+ // Make sure this driver produced ChildHandle\r
+ //\r
+ Status = EfiTestChildHandle (\r
+ ControllerHandle,\r
+ ChildHandle,\r
+ &gEfiTcp4ProtocolGuid\r
+ );\r
+ if (!EFI_ERROR (Status)) {\r
+ //\r
+ // Retrieve an instance of a produced protocol from ChildHandle\r
+ //\r
+ Status = gBS->OpenProtocol (\r
+ ChildHandle,\r
+ &gEfiExtScsiPassThruProtocolGuid,\r
+ (VOID **)&IScsiExtScsiPassThru,\r
+ NULL,\r
+ NULL,\r
+ EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ //\r
+ // Update the component name for this child handle.\r
+ //\r
+ Status = UpdateName (IScsiExtScsiPassThru);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+ } else {\r
+ return Status;\r
+ }\r
+ }\r
+ \r
+ return LookupUnicodeString2 (\r
+ Language,\r
+ This->SupportedLanguages,\r
+ mIScsiControllerNameTable,\r
+ ControllerName,\r
+ (BOOLEAN)(This == &gIScsiComponentName)\r
+ );\r
}\r
+\r
projects / mirror_edk2.git / blobdiff