X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdeModulePkg%2FUniversal%2FNetwork%2FIScsiDxe%2FIScsiConfig.c;h=cb1eff1b690cc8494bc631e6f3e2c0497f64e992;hp=8982a3b99fc0e06ba2d0ae66d6bf8b0265810bad;hb=d1102dba7210b95e41d06c2338a22ba6af248645;hpb=e1f1fb16580a6e5a835e9e1574006561addac297 diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiConfig.c b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiConfig.c index 8982a3b99f..cb1eff1b69 100644 --- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiConfig.c +++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiConfig.c @@ -1,8 +1,8 @@ /** @file Helper functions for configuring or getting the parameters relating to iSCSI. -Copyright (c) 2004 - 2008, Intel Corporation.
-All rights reserved. This program and the accompanying materials +Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
+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 @@ -14,7 +14,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #include "IScsiImpl.h" -EFI_GUID mVendorGuid = ISCSI_CONFIG_GUID; CHAR16 mVendorStorageName[] = L"ISCSI_CONFIG_IFR_NVDATA"; BOOLEAN mIScsiDeviceListUpdated = FALSE; UINTN mNumberOfIScsiDevices = 0; @@ -35,15 +34,12 @@ HII_VENDOR_DEVICE_PATH mIScsiHiiVendorDevicePath = { (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8) } }, - // - // {49D7B73E-143D-4716-977B-C45F1CB038CC} - // - { 0x49d7b73e, 0x143d, 0x4716, { 0x97, 0x7b, 0xc4, 0x5f, 0x1c, 0xb0, 0x38, 0xcc } } + IP4_ISCSI_CONFIG_GUID }, { END_DEVICE_PATH_TYPE, END_ENTIRE_DEVICE_PATH_SUBTYPE, - { + { (UINT8) (END_DEVICE_PATH_LENGTH), (UINT8) ((END_DEVICE_PATH_LENGTH) >> 8) } @@ -65,11 +61,126 @@ IScsiIpToStr ( UnicodeSPrint ( Str, 2 * IP4_STR_MAX_SIZE, L"%d.%d.%d.%d", Ip->Addr[0], Ip->Addr[1], Ip->Addr[2], Ip->Addr[3]); } + +/** + Parse IsId in string format and convert it to binary. + + @param[in] String The buffer of the string to be parsed. + @param[in, out] IsId The buffer to store IsId. + + @retval EFI_SUCCESS The operation finished successfully. + @retval EFI_INVALID_PARAMETER Any input parameter is invalid. + +**/ +EFI_STATUS +IScsiParseIsIdFromString ( + IN CONST CHAR16 *String, + IN OUT UINT8 *IsId + ) +{ + UINT8 Index; + CHAR16 *IsIdStr; + CHAR16 TempStr[3]; + UINTN NodeVal; + CHAR16 PortString[ISCSI_NAME_IFR_MAX_SIZE]; + EFI_INPUT_KEY Key; + + if ((String == NULL) || (IsId == NULL)) { + return EFI_INVALID_PARAMETER; + } + + IsIdStr = (CHAR16 *) String; + + if (StrLen (IsIdStr) != 6) { + UnicodeSPrint ( + PortString, + (UINTN) sizeof (PortString), + L"Error! Input is incorrect, please input 6 hex numbers!\n" + ); + + CreatePopUp ( + EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, + &Key, + PortString, + NULL + ); + + return EFI_INVALID_PARAMETER; + } + + for (Index = 3; Index < 6; Index++) { + CopyMem (TempStr, IsIdStr, sizeof (TempStr)); + TempStr[2] = L'\0'; + + // + // Convert the string to IsId. StrHexToUintn stops at the first character + // that is not a valid hex character, '\0' here. + // + NodeVal = StrHexToUintn (TempStr); + + IsId[Index] = (UINT8) NodeVal; + + IsIdStr = IsIdStr + 2; + } + + return EFI_SUCCESS; +} + +/** + Convert IsId from binary to string format. + + @param[out] String The buffer to store the converted string. + @param[in] IsId The buffer to store IsId. + + @retval EFI_SUCCESS The string converted successfully. + @retval EFI_INVALID_PARAMETER Any input parameter is invalid. + +**/ +EFI_STATUS +IScsiConvertIsIdToString ( + OUT CHAR16 *String, + IN UINT8 *IsId + ) +{ + UINT8 Index; + UINTN Number; + + if ((String == NULL) || (IsId == NULL)) { + return EFI_INVALID_PARAMETER; + } + + for (Index = 0; Index < 6; Index++) { + if (IsId[Index] <= 0xF) { + Number = UnicodeSPrint ( + String, + 2 * ISID_CONFIGURABLE_STORAGE, + L"0%X", + (UINTN) IsId[Index] + ); + } else { + Number = UnicodeSPrint ( + String, + 2 * ISID_CONFIGURABLE_STORAGE, + L"%X", + (UINTN) IsId[Index] + ); + + } + + String = String + Number; + } + + *String = L'\0'; + + return EFI_SUCCESS; +} + + /** Update the list of iSCSI devices the iSCSI driver is controlling. - + @retval EFI_SUCCESS The callback successfully handled the action. - @retval Others Other errors as indicated. + @retval Others Other errors as indicated. **/ EFI_STATUS IScsiUpdateDeviceList ( @@ -84,19 +195,20 @@ IScsiUpdateDeviceList ( UINTN HandleIndex; UINTN Index; UINTN LastDeviceIndex; - EFI_SIMPLE_NETWORK_PROTOCOL *Snp; - EFI_SIMPLE_NETWORK_MODE *Mode; + EFI_MAC_ADDRESS MacAddress; + UINTN HwAddressSize; + UINT16 VlanId; ISCSI_MAC_INFO *CurMacInfo; ISCSI_MAC_INFO TempMacInfo; - CHAR16 MacString[65]; + CHAR16 MacString[70]; UINTN DeviceListSize; // - // Dump all the handles the Simple Network Protocol is installed on. + // Dump all the handles the Managed Network Service Binding Protocol is installed on. // Status = gBS->LocateHandleBuffer ( ByProtocol, - &gEfiSimpleNetworkProtocolGuid, + &gEfiManagedNetworkServiceBindingProtocolGuid, NULL, &NumHandles, &Handles @@ -108,17 +220,18 @@ IScsiUpdateDeviceList ( DataSize = 0; Status = gRT->GetVariable ( L"iSCSIDeviceList", - &mVendorGuid, + &gIp4IScsiConfigGuid, NULL, &DataSize, NULL ); if (Status == EFI_BUFFER_TOO_SMALL) { DeviceList = (ISCSI_DEVICE_LIST *) AllocatePool (DataSize); + ASSERT (DeviceList != NULL); gRT->GetVariable ( L"iSCSIDeviceList", - &mVendorGuid, + &gIp4IScsiConfigGuid, NULL, &DataSize, DeviceList @@ -127,14 +240,15 @@ IScsiUpdateDeviceList ( LastDeviceIndex = 0; for (HandleIndex = 0; HandleIndex < NumHandles; HandleIndex++) { - gBS->HandleProtocol (Handles[HandleIndex], &gEfiSimpleNetworkProtocolGuid, (VOID **)&Snp); - - Mode = Snp->Mode; + Status = NetLibGetMacAddress (Handles[HandleIndex], &MacAddress, &HwAddressSize); + ASSERT (Status == EFI_SUCCESS); + VlanId = NetLibGetVlanId (Handles[HandleIndex]); for (Index = LastDeviceIndex; Index < DeviceList->NumDevice; Index++) { CurMacInfo = &DeviceList->MacInfo[Index]; - if ((CurMacInfo->Len == Mode->HwAddressSize) && - (NET_MAC_EQUAL (&CurMacInfo->Mac, &Mode->PermanentAddress, Mode->HwAddressSize)) + if ((CurMacInfo->Len == HwAddressSize) && + (CurMacInfo->VlanId == VlanId) && + (NET_MAC_EQUAL (&CurMacInfo->Mac, MacAddress.Addr, HwAddressSize)) ) { // // The previous configured NIC is still here. @@ -163,14 +277,14 @@ IScsiUpdateDeviceList ( // delete the variables // CurMacInfo = &DeviceList->MacInfo[Index]; - IScsiMacAddrToStr (&CurMacInfo->Mac, CurMacInfo->Len, MacString); + IScsiMacAddrToStr (&CurMacInfo->Mac, CurMacInfo->Len, CurMacInfo->VlanId, MacString); gRT->SetVariable (MacString, &gEfiIScsiInitiatorNameProtocolGuid, 0, 0, NULL); - gRT->SetVariable (MacString, &mIScsiCHAPAuthInfoGuid, 0, 0, NULL); + gRT->SetVariable (MacString, &gIScsiCHAPAuthInfoGuid, 0, 0, NULL); } - gBS->FreePool (DeviceList); + FreePool (DeviceList); } else if (Status != EFI_NOT_FOUND) { - gBS->FreePool (Handles); + FreePool (Handles); return Status; } // @@ -178,27 +292,28 @@ IScsiUpdateDeviceList ( // DeviceListSize = sizeof (ISCSI_DEVICE_LIST) + (NumHandles - 1) * sizeof (ISCSI_MAC_INFO); DeviceList = (ISCSI_DEVICE_LIST *) AllocatePool (DeviceListSize); + ASSERT (DeviceList != NULL); DeviceList->NumDevice = (UINT8) NumHandles; for (Index = 0; Index < NumHandles; Index++) { - gBS->HandleProtocol (Handles[Index], &gEfiSimpleNetworkProtocolGuid, (VOID **)&Snp); - Mode = Snp->Mode; + NetLibGetMacAddress (Handles[Index], &MacAddress, &HwAddressSize); CurMacInfo = &DeviceList->MacInfo[Index]; - CopyMem (&CurMacInfo->Mac, &Mode->PermanentAddress, Mode->HwAddressSize); - CurMacInfo->Len = (UINT8) Mode->HwAddressSize; + CopyMem (&CurMacInfo->Mac, MacAddress.Addr, HwAddressSize); + CurMacInfo->Len = (UINT8) HwAddressSize; + CurMacInfo->VlanId = NetLibGetVlanId (Handles[Index]); } gRT->SetVariable ( L"iSCSIDeviceList", - &mVendorGuid, + &gIp4IScsiConfigGuid, ISCSI_CONFIG_VAR_ATTR, DeviceListSize, DeviceList ); - gBS->FreePool (DeviceList); - gBS->FreePool (Handles); + FreePool (DeviceList); + FreePool (Handles); return Status; } @@ -239,6 +354,7 @@ IScsiGetConfigFormEntryByIndex ( @param[in] ConfigFormEntry The iSCSI configuration form entry. @param[out] IfrNvData The IFR nv data. + **/ VOID IScsiConvertDeviceConfigDataToIfrNvData ( @@ -268,6 +384,8 @@ IScsiConvertDeviceConfigDataToIfrNvData ( IScsiLunToUnicodeStr (SessionConfigData->BootLun, IfrNvData->BootLun); + IScsiConvertIsIdToString (IfrNvData->IsId, SessionConfigData->IsId); + // // CHAP authentication parameters. // @@ -327,7 +445,7 @@ IScsiConvertDeviceConfigDataToIfrNvData ( would result in this type of error. In this case, the Progress parameter would be - set to NULL. + set to NULL. @retval EFI_NOT_FOUND Routing data doesn't match any known driver. Progress set to the first character in the routing header. @@ -353,16 +471,30 @@ IScsiFormExtractConfig ( ) { EFI_STATUS Status; - CHAR8 InitiatorName[ISCSI_NAME_IFR_MAX_SIZE]; + CHAR8 InitiatorName[ISCSI_NAME_MAX_SIZE]; UINTN BufferSize; ISCSI_CONFIG_IFR_NVDATA *IfrNvData; ISCSI_FORM_CALLBACK_INFO *Private; EFI_HII_CONFIG_ROUTING_PROTOCOL *HiiConfigRouting; + EFI_STRING ConfigRequestHdr; + EFI_STRING ConfigRequest; + BOOLEAN AllocatedRequest; + UINTN Size; - if (Request == NULL) { + if (Progress == NULL || Results == NULL) { return EFI_INVALID_PARAMETER; } + *Progress = Request; + if ((Request != NULL) && !HiiIsConfigHdrMatch (Request, &gIp4IScsiConfigGuid, mVendorStorageName)) { + return EFI_NOT_FOUND; + } + + ConfigRequestHdr = NULL; + ConfigRequest = NULL; + AllocatedRequest = FALSE; + Size = 0; + if (!mIScsiDeviceListUpdated) { // // Update the device list. @@ -378,7 +510,7 @@ IScsiFormExtractConfig ( IScsiConvertDeviceConfigDataToIfrNvData (Private->Current, IfrNvData); } - BufferSize = ISCSI_NAME_IFR_MAX_SIZE; + BufferSize = ISCSI_NAME_MAX_SIZE; Status = gIScsiInitiatorName.Get (&gIScsiInitiatorName, &BufferSize, InitiatorName); if (EFI_ERROR (Status)) { IfrNvData->InitiatorName[0] = L'\0'; @@ -391,15 +523,47 @@ IScsiFormExtractConfig ( // HiiConfigRouting = Private->ConfigRouting; BufferSize = sizeof (ISCSI_CONFIG_IFR_NVDATA); + ConfigRequest = Request; + if ((Request == NULL) || (StrStr (Request, L"OFFSET") == NULL)) { + // + // Request has no request element, construct full request string. + // Allocate and fill a buffer large enough to hold the template + // followed by "&OFFSET=0&WIDTH=WWWWWWWWWWWWWWWW" followed by a Null-terminator + // + ConfigRequestHdr = HiiConstructConfigHdr (&gIp4IScsiConfigGuid, mVendorStorageName, Private->DriverHandle); + Size = (StrLen (ConfigRequestHdr) + 32 + 1) * sizeof (CHAR16); + ConfigRequest = AllocateZeroPool (Size); + ASSERT (ConfigRequest != NULL); + AllocatedRequest = TRUE; + UnicodeSPrint (ConfigRequest, Size, L"%s&OFFSET=0&WIDTH=%016LX", ConfigRequestHdr, (UINT64)BufferSize); + FreePool (ConfigRequestHdr); + } Status = HiiConfigRouting->BlockToConfig ( HiiConfigRouting, - Request, + ConfigRequest, (UINT8 *) IfrNvData, BufferSize, Results, Progress ); - gBS->FreePool (IfrNvData); + FreePool (IfrNvData); + // + // Free the allocated config request string. + // + if (AllocatedRequest) { + FreePool (ConfigRequest); + ConfigRequest = NULL; + } + + // + // Set Progress string to the original request string. + // + if (Request == NULL) { + *Progress = NULL; + } else if (StrStr (Request, L"OFFSET") == NULL) { + *Progress = Request + StrLen (Request); + } + return Status; } @@ -415,7 +579,7 @@ IScsiFormExtractConfig ( @param[in] This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL. @param[in] Configuration A null-terminated Unicode string in - format. + format. @param[out] Progress A pointer to a string filled in with the offset of the most recent '&' before the first failing name / value pair (or the @@ -425,7 +589,7 @@ IScsiFormExtractConfig ( successful. @retval EFI_SUCCESS The results have been distributed or are - awaiting distribution. + awaiting distribution. @retval EFI_OUT_OF_RESOURCES Not enough memory to store the parts of the results that must be stored awaiting possible future @@ -444,6 +608,20 @@ IScsiFormRouteConfig ( OUT EFI_STRING *Progress ) { + if (Configuration == NULL || Progress == NULL) { + return EFI_INVALID_PARAMETER; + } + + // + // Check routing data in . + // Note: if only one Storage is used, then this checking could be skipped. + // + if (!HiiIsConfigHdrMatch (Configuration, &gIp4IScsiConfigGuid, mVendorStorageName)) { + *Progress = Configuration; + return EFI_NOT_FOUND; + } + + *Progress = Configuration + StrLen (Configuration); return EFI_SUCCESS; } @@ -456,7 +634,7 @@ IScsiFormRouteConfig ( @param[in] Action Specifies the type of action taken by the browser. @param[in] QuestionId A unique value which is sent to the original exporting driver so that it can identify the type - of data to expect. The format of the data tends to + of data to expect. The format of the data tends to vary based on the opcode that enerated the callback. @param[in] Type The type of value for the question. @param[in] Value A pointer to the data being sent to the original @@ -470,8 +648,8 @@ IScsiFormRouteConfig ( @retval EFI_DEVICE_ERROR The variable could not be saved. @retval EFI_UNSUPPORTED The specified Action is not supported by the callback.Currently not implemented. - @retval EFI_INVALID_PARAMETERS Passing in wrong parameter. - @retval Others Other errors as indicated. + @retval EFI_INVALID_PARAMETERS Passing in wrong parameter. + @retval Others Other errors as indicated. **/ EFI_STATUS EFIAPI @@ -486,7 +664,7 @@ IScsiFormCallback ( { ISCSI_FORM_CALLBACK_INFO *Private; UINTN BufferSize; - CHAR8 IScsiName[ISCSI_NAME_IFR_MAX_SIZE]; + CHAR8 IScsiName[ISCSI_NAME_MAX_SIZE]; CHAR16 PortString[128]; CHAR8 Ip4String[IP4_STR_MAX_SIZE]; CHAR8 LunString[ISCSI_LUN_STR_MAX_LEN]; @@ -500,241 +678,275 @@ IScsiFormCallback ( EFI_STATUS Status; EFI_INPUT_KEY Key; - Private = ISCSI_FORM_CALLBACK_INFO_FROM_FORM_CALLBACK (This); + if (Action != EFI_BROWSER_ACTION_CHANGING && Action != EFI_BROWSER_ACTION_CHANGED) { + return EFI_UNSUPPORTED; + } + Private = ISCSI_FORM_CALLBACK_INFO_FROM_FORM_CALLBACK (This); // - // Retrive uncommitted data from Browser + // Retrieve uncommitted data from Browser // IfrNvData = AllocateZeroPool (sizeof (ISCSI_CONFIG_IFR_NVDATA)); ASSERT (IfrNvData != NULL); - if (!HiiGetBrowserData (&mVendorGuid, mVendorStorageName, sizeof (ISCSI_CONFIG_IFR_NVDATA), (UINT8 *) IfrNvData)) { + if (!HiiGetBrowserData (&gIp4IScsiConfigGuid, mVendorStorageName, sizeof (ISCSI_CONFIG_IFR_NVDATA), (UINT8 *) IfrNvData)) { FreePool (IfrNvData); return EFI_NOT_FOUND; } - Status = EFI_SUCCESS; - switch (QuestionId) { - case KEY_INITIATOR_NAME: - IScsiUnicodeStrToAsciiStr (IfrNvData->InitiatorName, IScsiName); - BufferSize = AsciiStrLen (IScsiName) + 1; + if (Action == EFI_BROWSER_ACTION_CHANGING) { + if ((QuestionId >= KEY_DEVICE_ENTRY_BASE) && (QuestionId < (mNumberOfIScsiDevices + KEY_DEVICE_ENTRY_BASE))) { + // + // In case goto the device configuration form, update the device form title. + // + ConfigFormEntry = IScsiGetConfigFormEntryByIndex ((UINT32) (QuestionId - KEY_DEVICE_ENTRY_BASE)); + ASSERT (ConfigFormEntry != NULL); - Status = gIScsiInitiatorName.Set (&gIScsiInitiatorName, &BufferSize, IScsiName); - if (EFI_ERROR (Status)) { - CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid iSCSI Name!", NULL); - } + UnicodeSPrint (PortString, (UINTN) sizeof (PortString), L"Port %s", ConfigFormEntry->MacString); + DeviceFormTitleToken = (EFI_STRING_ID) STR_ISCSI_DEVICE_FORM_TITLE; + HiiSetString (Private->RegisteredHandle, DeviceFormTitleToken, PortString, NULL); - break; + IScsiConvertDeviceConfigDataToIfrNvData (ConfigFormEntry, IfrNvData); - case KEY_LOCAL_IP: - IScsiUnicodeStrToAsciiStr (IfrNvData->LocalIp, Ip4String); - Status = IScsiAsciiStrToIp (Ip4String, &HostIp.v4); - if (EFI_ERROR (Status) || !Ip4IsUnicast (NTOHL (HostIp.Addr[0]), 0)) { - CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid IP address!", NULL); - Status = EFI_INVALID_PARAMETER; - } else { - CopyMem (&Private->Current->SessionConfigData.LocalIp, &HostIp.v4, sizeof (HostIp.v4)); + Private->Current = ConfigFormEntry; } + } else if (Action == EFI_BROWSER_ACTION_CHANGED) { + switch (QuestionId) { + case KEY_INITIATOR_NAME: + IScsiUnicodeStrToAsciiStr (IfrNvData->InitiatorName, IScsiName); + BufferSize = AsciiStrSize (IScsiName); - break; + Status = gIScsiInitiatorName.Set (&gIScsiInitiatorName, &BufferSize, IScsiName); + if (EFI_ERROR (Status)) { + CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid iSCSI Name!", NULL); + } - case KEY_SUBNET_MASK: - IScsiUnicodeStrToAsciiStr (IfrNvData->SubnetMask, Ip4String); - Status = IScsiAsciiStrToIp (Ip4String, &SubnetMask.v4); - if (EFI_ERROR (Status) || ((SubnetMask.Addr[0] != 0) && (IScsiGetSubnetMaskPrefixLength (&SubnetMask.v4) == 0))) { - CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid Subnet Mask!", NULL); - Status = EFI_INVALID_PARAMETER; - } else { - CopyMem (&Private->Current->SessionConfigData.SubnetMask, &SubnetMask.v4, sizeof (SubnetMask.v4)); - } + *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_APPLY; + break; - break; + case KEY_LOCAL_IP: + IScsiUnicodeStrToAsciiStr (IfrNvData->LocalIp, Ip4String); + Status = IScsiAsciiStrToIp (Ip4String, &HostIp.v4); + if (EFI_ERROR (Status) || + ((Private->Current->SessionConfigData.SubnetMask.Addr[0] != 0) && + !NetIp4IsUnicast (NTOHL (HostIp.Addr[0]), NTOHL(*(UINT32*)Private->Current->SessionConfigData.SubnetMask.Addr)))) { + CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid IP address!", NULL); + Status = EFI_INVALID_PARAMETER; + } else { + CopyMem (&Private->Current->SessionConfigData.LocalIp, &HostIp.v4, sizeof (HostIp.v4)); + } - case KEY_GATE_WAY: - IScsiUnicodeStrToAsciiStr (IfrNvData->Gateway, Ip4String); - Status = IScsiAsciiStrToIp (Ip4String, &Gateway.v4); - if (EFI_ERROR (Status) || ((Gateway.Addr[0] != 0) && !Ip4IsUnicast (NTOHL (Gateway.Addr[0]), 0))) { - CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid Gateway!", NULL); - Status = EFI_INVALID_PARAMETER; - } else { - CopyMem (&Private->Current->SessionConfigData.Gateway, &Gateway.v4, sizeof (Gateway.v4)); - } + break; - break; + case KEY_SUBNET_MASK: + IScsiUnicodeStrToAsciiStr (IfrNvData->SubnetMask, Ip4String); + Status = IScsiAsciiStrToIp (Ip4String, &SubnetMask.v4); + if (EFI_ERROR (Status) || ((SubnetMask.Addr[0] != 0) && (IScsiGetSubnetMaskPrefixLength (&SubnetMask.v4) == 0))) { + CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid Subnet Mask!", NULL); + Status = EFI_INVALID_PARAMETER; + } else { + CopyMem (&Private->Current->SessionConfigData.SubnetMask, &SubnetMask.v4, sizeof (SubnetMask.v4)); + } - case KEY_TARGET_IP: - IScsiUnicodeStrToAsciiStr (IfrNvData->TargetIp, Ip4String); - Status = IScsiAsciiStrToIp (Ip4String, &HostIp.v4); - if (EFI_ERROR (Status) || !Ip4IsUnicast (NTOHL (HostIp.Addr[0]), 0)) { - CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid IP address!", NULL); - Status = EFI_INVALID_PARAMETER; - } else { - CopyMem (&Private->Current->SessionConfigData.TargetIp, &HostIp.v4, sizeof (HostIp.v4)); - } + break; - break; + case KEY_GATE_WAY: + IScsiUnicodeStrToAsciiStr (IfrNvData->Gateway, Ip4String); + Status = IScsiAsciiStrToIp (Ip4String, &Gateway.v4); + if (EFI_ERROR (Status) || + ((Gateway.Addr[0] != 0) && + (Private->Current->SessionConfigData.SubnetMask.Addr[0] != 0) && + !NetIp4IsUnicast (NTOHL (Gateway.Addr[0]), NTOHL(*(UINT32*)Private->Current->SessionConfigData.SubnetMask.Addr)))) { + CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid Gateway!", NULL); + Status = EFI_INVALID_PARAMETER; + } else { + CopyMem (&Private->Current->SessionConfigData.Gateway, &Gateway.v4, sizeof (Gateway.v4)); + } - case KEY_TARGET_NAME: - IScsiUnicodeStrToAsciiStr (IfrNvData->TargetName, IScsiName); - Status = IScsiNormalizeName (IScsiName, AsciiStrLen (IScsiName)); - if (EFI_ERROR (Status)) { - CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid iSCSI Name!", NULL); - } else { - AsciiStrCpy (Private->Current->SessionConfigData.TargetName, IScsiName); - } + break; - break; + case KEY_TARGET_IP: + IScsiUnicodeStrToAsciiStr (IfrNvData->TargetIp, Ip4String); + Status = IScsiAsciiStrToIp (Ip4String, &HostIp.v4); + if (EFI_ERROR (Status) || IP4_IS_LOCAL_BROADCAST (EFI_NTOHL(HostIp.v4)) || IP4_IS_UNSPECIFIED (EFI_NTOHL(HostIp.v4))) { + CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid IP address!", NULL); + Status = EFI_INVALID_PARAMETER; + } else { + CopyMem (&Private->Current->SessionConfigData.TargetIp, &HostIp.v4, sizeof (HostIp.v4)); + } - case KEY_DHCP_ENABLE: - if (IfrNvData->InitiatorInfoFromDhcp == 0) { - IfrNvData->TargetInfoFromDhcp = 0; - } + break; - break; + case KEY_TARGET_NAME: + IScsiUnicodeStrToAsciiStr (IfrNvData->TargetName, IScsiName); + Status = IScsiNormalizeName (IScsiName, AsciiStrLen (IScsiName)); + if (EFI_ERROR (Status)) { + CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid iSCSI Name!", NULL); + } else { + AsciiStrCpyS (Private->Current->SessionConfigData.TargetName, ISCSI_NAME_MAX_SIZE, IScsiName); + } - case KEY_BOOT_LUN: - IScsiUnicodeStrToAsciiStr (IfrNvData->BootLun, LunString); - Status = IScsiAsciiStrToLun (LunString, (UINT8 *) &Lun); - if (EFI_ERROR (Status)) { - CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid LUN string!", NULL); - } else { - CopyMem (Private->Current->SessionConfigData.BootLun, &Lun, sizeof (Lun)); - } + break; - break; + case KEY_DHCP_ENABLE: + if (IfrNvData->InitiatorInfoFromDhcp == 0) { + IfrNvData->TargetInfoFromDhcp = 0; + } - case KEY_CHAP_NAME: - IScsiUnicodeStrToAsciiStr (IfrNvData->CHAPName, Private->Current->AuthConfigData.CHAPName); - break; + break; - case KEY_CHAP_SECRET: - IScsiUnicodeStrToAsciiStr (IfrNvData->CHAPSecret, Private->Current->AuthConfigData.CHAPSecret); - break; + case KEY_BOOT_LUN: + IScsiUnicodeStrToAsciiStr (IfrNvData->BootLun, LunString); + Status = IScsiAsciiStrToLun (LunString, (UINT8 *) &Lun); + if (EFI_ERROR (Status)) { + CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Invalid LUN string!", NULL); + } else { + CopyMem (Private->Current->SessionConfigData.BootLun, &Lun, sizeof (Lun)); + } - case KEY_REVERSE_CHAP_NAME: - IScsiUnicodeStrToAsciiStr (IfrNvData->ReverseCHAPName, Private->Current->AuthConfigData.ReverseCHAPName); - break; + break; - case KEY_REVERSE_CHAP_SECRET: - IScsiUnicodeStrToAsciiStr (IfrNvData->ReverseCHAPSecret, Private->Current->AuthConfigData.ReverseCHAPSecret); - break; + case KEY_CHAP_NAME: + IScsiUnicodeStrToAsciiStr (IfrNvData->CHAPName, Private->Current->AuthConfigData.CHAPName); + break; - case KEY_SAVE_CHANGES: - // - // First, update those fields which don't have INTERACTIVE set. - // - Private->Current->SessionConfigData.Enabled = IfrNvData->Enabled; - Private->Current->SessionConfigData.InitiatorInfoFromDhcp = IfrNvData->InitiatorInfoFromDhcp; - Private->Current->SessionConfigData.TargetPort = IfrNvData->TargetPort; - if (Private->Current->SessionConfigData.TargetPort == 0) { - Private->Current->SessionConfigData.TargetPort = ISCSI_WELL_KNOWN_PORT; - } + case KEY_CHAP_SECRET: + IScsiUnicodeStrToAsciiStr (IfrNvData->CHAPSecret, Private->Current->AuthConfigData.CHAPSecret); + break; - Private->Current->SessionConfigData.TargetInfoFromDhcp = IfrNvData->TargetInfoFromDhcp; - Private->Current->AuthConfigData.CHAPType = IfrNvData->CHAPType; + case KEY_REVERSE_CHAP_NAME: + IScsiUnicodeStrToAsciiStr (IfrNvData->ReverseCHAPName, Private->Current->AuthConfigData.ReverseCHAPName); + break; - // - // Only do full parameter validation if iSCSI is enabled on this device. - // - if (Private->Current->SessionConfigData.Enabled) { + case KEY_REVERSE_CHAP_SECRET: + IScsiUnicodeStrToAsciiStr (IfrNvData->ReverseCHAPSecret, Private->Current->AuthConfigData.ReverseCHAPSecret); + break; + + case KEY_CONFIG_ISID: + IScsiParseIsIdFromString (IfrNvData->IsId, Private->Current->SessionConfigData.IsId); + IScsiConvertIsIdToString (IfrNvData->IsId, Private->Current->SessionConfigData.IsId); + + break; + + case KEY_SAVE_CHANGES: // - // Validate the address configuration of the Initiator if DHCP isn't - // deployed. + // First, update those fields which don't have INTERACTIVE set. // - if (!Private->Current->SessionConfigData.InitiatorInfoFromDhcp) { - CopyMem (&HostIp.v4, &Private->Current->SessionConfigData.LocalIp, sizeof (HostIp.v4)); - CopyMem (&SubnetMask.v4, &Private->Current->SessionConfigData.SubnetMask, sizeof (SubnetMask.v4)); - CopyMem (&Gateway.v4, &Private->Current->SessionConfigData.Gateway, sizeof (Gateway.v4)); - - if ((Gateway.Addr[0] != 0)) { - if (SubnetMask.Addr[0] == 0) { - CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Gateway address is set but subnet mask is zero.", NULL); + Private->Current->SessionConfigData.Enabled = IfrNvData->Enabled; + Private->Current->SessionConfigData.InitiatorInfoFromDhcp = IfrNvData->InitiatorInfoFromDhcp; + Private->Current->SessionConfigData.TargetPort = IfrNvData->TargetPort; + if (Private->Current->SessionConfigData.TargetPort == 0) { + Private->Current->SessionConfigData.TargetPort = ISCSI_WELL_KNOWN_PORT; + } + + Private->Current->SessionConfigData.TargetInfoFromDhcp = IfrNvData->TargetInfoFromDhcp; + Private->Current->AuthConfigData.CHAPType = IfrNvData->CHAPType; + + // + // Only do full parameter validation if iSCSI is enabled on this device. + // + if (Private->Current->SessionConfigData.Enabled) { + // + // Validate the address configuration of the Initiator if DHCP isn't + // deployed. + // + if (!Private->Current->SessionConfigData.InitiatorInfoFromDhcp) { + CopyMem (&HostIp.v4, &Private->Current->SessionConfigData.LocalIp, sizeof (HostIp.v4)); + CopyMem (&SubnetMask.v4, &Private->Current->SessionConfigData.SubnetMask, sizeof (SubnetMask.v4)); + CopyMem (&Gateway.v4, &Private->Current->SessionConfigData.Gateway, sizeof (Gateway.v4)); + + if ((Gateway.Addr[0] != 0)) { + if (SubnetMask.Addr[0] == 0) { + CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Gateway address is set but subnet mask is zero.", NULL); + Status = EFI_INVALID_PARAMETER; + break; + } else if (!IP4_NET_EQUAL (HostIp.Addr[0], Gateway.Addr[0], SubnetMask.Addr[0])) { + CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Local IP and Gateway are not in the same subnet.", NULL); + Status = EFI_INVALID_PARAMETER; + break; + } + } + } + // + // Validate target configuration if DHCP isn't deployed. + // + if (!Private->Current->SessionConfigData.TargetInfoFromDhcp) { + CopyMem (&HostIp.v4, &Private->Current->SessionConfigData.TargetIp, sizeof (HostIp.v4)); + if (IP4_IS_UNSPECIFIED (NTOHL (HostIp.Addr[0])) || IP4_IS_LOCAL_BROADCAST (NTOHL (HostIp.Addr[0]))) { + CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Target IP is invalid!", NULL); Status = EFI_INVALID_PARAMETER; break; - } else if (!IP4_NET_EQUAL (HostIp.Addr[0], Gateway.Addr[0], SubnetMask.Addr[0])) { - CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Local IP and Gateway are not in the same subnet.", NULL); + } + + // + // Validate iSCSI target name configuration again: + // The format of iSCSI target name is already verified when user input the name; + // here we only check the case user does not input the name. + // + if (Private->Current->SessionConfigData.TargetName[0] == '\0') { + CreatePopUp ( + EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, + &Key, + L"iSCSI target name is NULL!", + NULL + ); Status = EFI_INVALID_PARAMETER; break; } - } - } - // - // Validate target configuration if DHCP isn't deployed. - // - if (!Private->Current->SessionConfigData.TargetInfoFromDhcp) { - CopyMem (&HostIp.v4, &Private->Current->SessionConfigData.TargetIp, sizeof (HostIp.v4)); - if (!Ip4IsUnicast (NTOHL (HostIp.Addr[0]), 0)) { - CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Target IP is invalid!", NULL); - Status = EFI_INVALID_PARAMETER; - break; - } - } - if (IfrNvData->CHAPType != ISCSI_CHAP_NONE) { - if ((IfrNvData->CHAPName[0] == '\0') || (IfrNvData->CHAPSecret[0] == '\0')) { - CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"CHAP Name or CHAP Secret is invalid!", NULL); - Status = EFI_INVALID_PARAMETER; - break; } - if ((IfrNvData->CHAPType == ISCSI_CHAP_MUTUAL) && - ((IfrNvData->ReverseCHAPName[0] == '\0') || (IfrNvData->ReverseCHAPSecret[0] == '\0')) - ) { - CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Reverse CHAP Name or Reverse CHAP Secret is invalid!", NULL); - Status = EFI_INVALID_PARAMETER; - break; + if (IfrNvData->CHAPType != ISCSI_CHAP_NONE) { + if ((IfrNvData->CHAPName[0] == '\0') || (IfrNvData->CHAPSecret[0] == '\0')) { + CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"CHAP Name or CHAP Secret is invalid!", NULL); + Status = EFI_INVALID_PARAMETER; + break; + } + + if ((IfrNvData->CHAPType == ISCSI_CHAP_MUTUAL) && + ((IfrNvData->ReverseCHAPName[0] == '\0') || (IfrNvData->ReverseCHAPSecret[0] == '\0')) + ) { + CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Reverse CHAP Name or Reverse CHAP Secret is invalid!", NULL); + Status = EFI_INVALID_PARAMETER; + break; + } } } - } - BufferSize = sizeof (Private->Current->SessionConfigData); - gRT->SetVariable ( - Private->Current->MacString, - &gEfiIScsiInitiatorNameProtocolGuid, - ISCSI_CONFIG_VAR_ATTR, - BufferSize, - &Private->Current->SessionConfigData - ); - - BufferSize = sizeof (Private->Current->AuthConfigData); - gRT->SetVariable ( - Private->Current->MacString, - &mIScsiCHAPAuthInfoGuid, - ISCSI_CONFIG_VAR_ATTR, - BufferSize, - &Private->Current->AuthConfigData - ); - *ActionRequest = EFI_BROWSER_ACTION_REQUEST_SUBMIT; - break; - - default: - if ((QuestionId >= KEY_DEVICE_ENTRY_BASE) && (QuestionId < (mNumberOfIScsiDevices + KEY_DEVICE_ENTRY_BASE))) { - // - // In case goto the device configuration form, update the device form title. - // - ConfigFormEntry = IScsiGetConfigFormEntryByIndex ((UINT32) (QuestionId - KEY_DEVICE_ENTRY_BASE)); - ASSERT (ConfigFormEntry != NULL); - - UnicodeSPrint (PortString, (UINTN) 128, L"Port %s", ConfigFormEntry->MacString); - DeviceFormTitleToken = (EFI_STRING_ID) STR_ISCSI_DEVICE_FORM_TITLE; - HiiSetString (Private->RegisteredHandle, DeviceFormTitleToken, PortString, NULL); - - IScsiConvertDeviceConfigDataToIfrNvData (ConfigFormEntry, IfrNvData); + BufferSize = sizeof (Private->Current->SessionConfigData); + gRT->SetVariable ( + Private->Current->MacString, + &gEfiIScsiInitiatorNameProtocolGuid, + ISCSI_CONFIG_VAR_ATTR, + BufferSize, + &Private->Current->SessionConfigData + ); + + BufferSize = sizeof (Private->Current->AuthConfigData); + gRT->SetVariable ( + Private->Current->MacString, + &gIScsiCHAPAuthInfoGuid, + ISCSI_CONFIG_VAR_ATTR, + BufferSize, + &Private->Current->AuthConfigData + ); + *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_APPLY; + break; - Private->Current = ConfigFormEntry; + default: + break; } - - break; } if (!EFI_ERROR (Status)) { // // Pass changed uncommitted data back to Form Browser // - HiiSetBrowserData (&mVendorGuid, mVendorStorageName, sizeof (ISCSI_CONFIG_IFR_NVDATA), (UINT8 *) IfrNvData, NULL); + HiiSetBrowserData (&gIp4IScsiConfigGuid, mVendorStorageName, sizeof (ISCSI_CONFIG_IFR_NVDATA), (UINT8 *) IfrNvData, NULL); } FreePool (IfrNvData); + return Status; } @@ -761,7 +973,9 @@ IScsiConfigUpdateForm ( ISCSI_CONFIG_FORM_ENTRY *ConfigFormEntry; BOOLEAN EntryExisted; EFI_STATUS Status; - EFI_SIMPLE_NETWORK_PROTOCOL *Snp; + EFI_MAC_ADDRESS MacAddress; + UINTN HwAddressSize; + UINT16 VlanId; CHAR16 PortString[128]; UINT16 FormIndex; UINTN BufferSize; @@ -798,17 +1012,13 @@ IScsiConfigUpdateForm ( ConfigFormEntry->Controller = Controller; // - // Get the simple network protocol and convert the MAC address into - // the formatted string. + // Get the MAC address and convert it into the formatted string. // - Status = gBS->HandleProtocol ( - Controller, - &gEfiSimpleNetworkProtocolGuid, - (VOID **)&Snp - ); + Status = NetLibGetMacAddress (Controller, &MacAddress, &HwAddressSize); ASSERT (Status == EFI_SUCCESS); + VlanId = NetLibGetVlanId (Controller); - IScsiMacAddrToStr (&Snp->Mode->PermanentAddress, Snp->Mode->HwAddressSize, ConfigFormEntry->MacString); + IScsiMacAddrToStr (&MacAddress, (UINT32) HwAddressSize, VlanId, ConfigFormEntry->MacString); // // Get the normal session configuration data. @@ -823,6 +1033,13 @@ IScsiConfigUpdateForm ( ); if (EFI_ERROR (Status)) { ZeroMem (&ConfigFormEntry->SessionConfigData, sizeof (ConfigFormEntry->SessionConfigData)); + + // + // Generate OUI-format ISID based on MAC address. + // + CopyMem (ConfigFormEntry->SessionConfigData.IsId, &MacAddress, 6); + ConfigFormEntry->SessionConfigData.IsId[0] = + (UINT8) (ConfigFormEntry->SessionConfigData.IsId[0] & 0x3F); } // // Get the CHAP authentication configuration data. @@ -830,7 +1047,7 @@ IScsiConfigUpdateForm ( BufferSize = sizeof (ConfigFormEntry->AuthConfigData); Status = gRT->GetVariable ( ConfigFormEntry->MacString, - &mIScsiCHAPAuthInfoGuid, + &gIScsiCHAPAuthInfoGuid, NULL, &BufferSize, &ConfigFormEntry->AuthConfigData @@ -841,13 +1058,13 @@ IScsiConfigUpdateForm ( // // Compose the Port string and create a new EFI_STRING_ID. // - UnicodeSPrint (PortString, 128, L"Port %s", ConfigFormEntry->MacString); + UnicodeSPrint (PortString, sizeof (PortString), L"Port %s", ConfigFormEntry->MacString); ConfigFormEntry->PortTitleToken = HiiSetString (mCallbackInfo->RegisteredHandle, 0, PortString, NULL); // // Compose the help string of this port and create a new EFI_STRING_ID. // - UnicodeSPrint (PortString, 128, L"Set the iSCSI parameters on port %s", ConfigFormEntry->MacString); + UnicodeSPrint (PortString, sizeof (PortString), L"Set the iSCSI parameters on port %s", ConfigFormEntry->MacString); ConfigFormEntry->PortTitleHelpToken = HiiSetString (mCallbackInfo->RegisteredHandle, 0, PortString, NULL); InsertTailList (&mIScsiConfigFormList, &ConfigFormEntry->Link); @@ -858,7 +1075,8 @@ IScsiConfigUpdateForm ( mNumberOfIScsiDevices--; RemoveEntryList (&ConfigFormEntry->Link); - gBS->FreePool (ConfigFormEntry); + FreePool (ConfigFormEntry); + mCallbackInfo->Current = NULL; } // // Allocate space for creation of Buffer @@ -905,7 +1123,7 @@ IScsiConfigUpdateForm ( HiiUpdateForm ( mCallbackInfo->RegisteredHandle, - &mVendorGuid, + &gIp4IScsiConfigGuid, FORMID_MAIN_FORM, StartOpCodeHandle, // Label DEVICE_ENTRY_LABEL EndOpCodeHandle // LABEL_END @@ -971,14 +1189,14 @@ IScsiConfigFormInit ( NULL ); ASSERT_EFI_ERROR (Status); - + // // Publish our HII data // CallbackInfo->RegisteredHandle = HiiAddPackages ( - &mVendorGuid, + &gIp4IScsiConfigGuid, CallbackInfo->DriverHandle, - IScsiDxeStrings, + IScsi4DxeStrings, IScsiConfigDxeBin, NULL ); @@ -998,7 +1216,7 @@ IScsiConfigFormInit ( free the resources used. @param[in] DriverBindingHandle The iSCSI driverbinding handle. - + @retval EFI_SUCCESS The iSCSI configuration form is unloaded. @retval EFI_OUT_OF_RESOURCES Failed to allocate memory. **/ @@ -1040,7 +1258,7 @@ IScsiConfigFormUnload ( &mCallbackInfo->ConfigAccess, NULL ); - gBS->FreePool (mCallbackInfo); + FreePool (mCallbackInfo); return EFI_SUCCESS; }