2 Miscellaneous routines for iSCSI driver.
4 Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #include "IScsiImpl.h"
17 GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8 IScsiHexString
[] = "0123456789ABCDEFabcdef";
20 Removes (trims) specified leading and trailing characters from a string.
22 @param[in, out] Str Pointer to the null-terminated string to be trimmed.
23 On return, Str will hold the trimmed string.
25 @param[in] CharC Character will be trimmed from str.
42 // Trim off the leading and trailing characters c
44 for (Pointer1
= Str
; (*Pointer1
!= 0) && (*Pointer1
== CharC
); Pointer1
++) {
49 if (Pointer2
== Pointer1
) {
50 while (*Pointer1
!= 0) {
55 while (*Pointer1
!= 0) {
56 *Pointer2
= *Pointer1
;
64 for (Pointer1
= Str
+ StrLen(Str
) - 1; Pointer1
>= Str
&& *Pointer1
== CharC
; Pointer1
--) {
67 if (Pointer1
!= Str
+ StrLen(Str
) - 1) {
73 Calculate the prefix length of the IPv4 subnet mask.
75 @param[in] SubnetMask The IPv4 subnet mask.
77 @return The prefix length of the subnet mask.
78 @retval 0 Other errors as indicated.
82 IScsiGetSubnetMaskPrefixLength (
83 IN EFI_IPv4_ADDRESS
*SubnetMask
90 // The SubnetMask is in network byte order.
92 ReverseMask
= (SubnetMask
->Addr
[0] << 24) | (SubnetMask
->Addr
[1] << 16) | (SubnetMask
->Addr
[2] << 8) | (SubnetMask
->Addr
[3]);
97 ReverseMask
= ~ReverseMask
;
99 if ((ReverseMask
& (ReverseMask
+ 1)) != 0) {
105 while (ReverseMask
!= 0) {
106 ReverseMask
= ReverseMask
>> 1;
110 return (UINT8
) (32 - Len
);
115 Convert the hexadecimal encoded LUN string into the 64-bit LUN.
117 @param[in] Str The hexadecimal encoded LUN string.
118 @param[out] Lun Storage to return the 64-bit LUN.
120 @retval EFI_SUCCESS The 64-bit LUN is stored in Lun.
121 @retval EFI_INVALID_PARAMETER The string is malformatted.
130 UINTN Index
, IndexValue
, IndexNum
, SizeStr
;
137 ZeroMem ((UINT8
*) Value
, sizeof (Value
));
138 SizeStr
= AsciiStrLen (Str
);
142 for (Index
= 0; Index
< SizeStr
; Index
++) {
143 TemStr
[0] = Str
[Index
];
144 TemValue
= (UINT8
) AsciiStrHexToUint64 (TemStr
);
145 if (TemValue
== 0 && TemStr
[0] != '0') {
146 if ((TemStr
[0] != '-') || (IndexNum
== 0)) {
150 return EFI_INVALID_PARAMETER
;
154 if ((TemValue
== 0) && (TemStr
[0] == '-')) {
158 if (++IndexValue
>= 4) {
162 return EFI_INVALID_PARAMETER
;
165 // Restart str index for the next lun value.
171 if (++IndexNum
> 4) {
173 // Each Lun Str can't exceed size 4, because it will be as UINT16 value.
175 return EFI_INVALID_PARAMETER
;
179 // Combine UINT16 value.
181 Value
[IndexValue
] = (UINT16
) ((Value
[IndexValue
] << 4) + TemValue
);
184 for (Index
= 0; Index
<= IndexValue
; Index
++) {
185 *((UINT16
*) &Lun
[Index
* 2]) = HTONS (Value
[Index
]);
192 Convert the 64-bit LUN into the hexadecimal encoded LUN string.
194 @param[in] Lun The 64-bit LUN.
195 @param[out] Str The storage to return the hexadecimal encoded LUN string.
199 IScsiLunToUnicodeStr (
209 for (Index
= 0; Index
< 4; Index
++) {
211 if ((Lun
[2 * Index
] | Lun
[2 * Index
+ 1]) == 0) {
212 CopyMem (TempStr
, L
"0-", sizeof (L
"0-"));
214 TempStr
[0] = (CHAR16
) IScsiHexString
[Lun
[2 * Index
] >> 4];
215 TempStr
[1] = (CHAR16
) IScsiHexString
[Lun
[2 * Index
] & 0x0F];
216 TempStr
[2] = (CHAR16
) IScsiHexString
[Lun
[2 * Index
+ 1] >> 4];
217 TempStr
[3] = (CHAR16
) IScsiHexString
[Lun
[2 * Index
+ 1] & 0x0F];
221 IScsiStrTrim (TempStr
, L
'0');
224 TempStr
+= StrLen (TempStr
);
227 // Remove the last '-'
229 ASSERT (StrLen(Str
) >= 1);
230 Str
[StrLen (Str
) - 1] = 0;
232 for (Index
= StrLen (Str
) - 1; Index
> 1; Index
= Index
- 2) {
233 if ((Str
[Index
] == L
'0') && (Str
[Index
- 1] == L
'-')) {
242 Convert the formatted IP address into the binary IP address.
244 @param[in] Str The UNICODE string.
245 @param[in] IpMode Indicates whether the IP address is v4 or v6.
246 @param[out] Ip The storage to return the ASCII string.
248 @retval EFI_SUCCESS The binary IP address is returned in Ip.
249 @retval EFI_INVALID_PARAMETER The IP string is malformatted or IpMode is
257 OUT EFI_IP_ADDRESS
*Ip
262 if (IpMode
== IP_MODE_IP4
|| IpMode
== IP_MODE_AUTOCONFIG_IP4
) {
263 return NetLibAsciiStrToIp4 (Str
, &Ip
->v4
);
265 } else if (IpMode
== IP_MODE_IP6
|| IpMode
== IP_MODE_AUTOCONFIG_IP6
) {
266 return NetLibAsciiStrToIp6 (Str
, &Ip
->v6
);
268 } else if (IpMode
== IP_MODE_AUTOCONFIG
) {
269 Status
= NetLibAsciiStrToIp4 (Str
, &Ip
->v4
);
270 if (!EFI_ERROR (Status
)) {
273 return NetLibAsciiStrToIp6 (Str
, &Ip
->v6
);
277 return EFI_INVALID_PARAMETER
;
281 Convert the mac address into a hexadecimal encoded "-" seperated string.
283 @param[in] Mac The mac address.
284 @param[in] Len Length in bytes of the mac address.
285 @param[in] VlanId VLAN ID of the network device.
286 @param[out] Str The storage to return the mac string.
291 IN EFI_MAC_ADDRESS
*Mac
,
300 for (Index
= 0; Index
< Len
; Index
++) {
301 Str
[3 * Index
] = (CHAR16
) IScsiHexString
[(Mac
->Addr
[Index
] >> 4) & 0x0F];
302 Str
[3 * Index
+ 1] = (CHAR16
) IScsiHexString
[Mac
->Addr
[Index
] & 0x0F];
303 Str
[3 * Index
+ 2] = L
':';
306 String
= &Str
[3 * Index
- 1] ;
308 String
+= UnicodeSPrint (String
, 6 * sizeof (CHAR16
), L
"\\%04x", (UINTN
) VlanId
);
315 Convert the binary encoded buffer into a hexadecimal encoded string.
317 @param[in] BinBuffer The buffer containing the binary data.
318 @param[in] BinLength Length of the binary buffer.
319 @param[in, out] HexStr Pointer to the string.
320 @param[in, out] HexLength The length of the string.
322 @retval EFI_SUCCESS The binary data is converted to the hexadecimal string
323 and the length of the string is updated.
324 @retval EFI_BUFFER_TOO_SMALL The string is too small.
325 @retval EFI_INVALID_PARAMETER The IP string is malformatted.
332 IN OUT CHAR8
*HexStr
,
333 IN OUT UINT32
*HexLength
338 if ((HexStr
== NULL
) || (BinBuffer
== NULL
) || (BinLength
== 0)) {
339 return EFI_INVALID_PARAMETER
;
342 if (((*HexLength
) - 3) < BinLength
* 2) {
343 *HexLength
= BinLength
* 2 + 3;
344 return EFI_BUFFER_TOO_SMALL
;
347 *HexLength
= BinLength
* 2 + 3;
349 // Prefix for Hex String.
354 for (Index
= 0; Index
< BinLength
; Index
++) {
355 HexStr
[Index
* 2 + 2] = IScsiHexString
[BinBuffer
[Index
] >> 4];
356 HexStr
[Index
* 2 + 3] = IScsiHexString
[BinBuffer
[Index
] & 0xf];
359 HexStr
[Index
* 2 + 2] = '\0';
366 Convert the hexadecimal string into a binary encoded buffer.
368 @param[in, out] BinBuffer The binary buffer.
369 @param[in, out] BinLength Length of the binary buffer.
370 @param[in] HexStr The hexadecimal string.
372 @retval EFI_SUCCESS The hexadecimal string is converted into a binary
374 @retval EFI_BUFFER_TOO_SMALL The binary buffer is too small to hold the converted data.
379 IN OUT UINT8
*BinBuffer
,
380 IN OUT UINT32
*BinLength
,
389 ZeroMem (TemStr
, sizeof (TemStr
));
392 // Find out how many hex characters the string has.
394 if ((HexStr
[0] == '0') && ((HexStr
[1] == 'x') || (HexStr
[1] == 'X'))) {
398 Length
= AsciiStrLen (HexStr
);
400 for (Index
= 0; Index
< Length
; Index
++) {
401 TemStr
[0] = HexStr
[Index
];
402 Digit
= (UINT8
) AsciiStrHexToUint64 (TemStr
);
403 if (Digit
== 0 && TemStr
[0] != '0') {
409 if ((Index
& 1) == 0) {
410 BinBuffer
[Index
/2] = Digit
;
412 BinBuffer
[Index
/2] = (UINT8
) ((BinBuffer
[Index
/2] << 4) + Digit
);
416 *BinLength
= (UINT32
) ((Index
+ 1)/2);
423 Convert the decimal-constant string or hex-constant string into a numerical value.
425 @param[in] Str String in decimal or hex.
427 @return The numerical value.
435 if ((Str
[0] == '0') && ((Str
[1] == 'x') || (Str
[1] == 'X'))) {
438 return AsciiStrHexToUintn (Str
);
441 return AsciiStrDecimalToUintn (Str
);
446 Generate random numbers.
448 @param[in, out] Rand The buffer to contain random numbers.
449 @param[in] RandLength The length of the Rand buffer.
460 while (RandLength
> 0) {
461 Random
= NET_RANDOM (NetRandomInitSeed ());
462 *Rand
++ = (UINT8
) (Random
);
469 Record the NIC info in global structure.
471 @param[in] Controller The handle of the controller.
473 @retval EFI_SUCCESS The operation is completed.
474 @retval EFI_OUT_OF_RESOURCES Do not have sufficient resources to finish this
480 IN EFI_HANDLE Controller
484 ISCSI_NIC_INFO
*NicInfo
;
486 EFI_MAC_ADDRESS MacAddr
;
491 // Get MAC address of this network device.
493 Status
= NetLibGetMacAddress (Controller
, &MacAddr
, &HwAddressSize
);
494 if (EFI_ERROR (Status
)) {
499 // Get VLAN ID of this network device.
501 VlanId
= NetLibGetVlanId (Controller
);
504 // Check whether the NIC info already exists. Return directly if so.
506 NET_LIST_FOR_EACH (Entry
, &mPrivate
->NicInfoList
) {
507 NicInfo
= NET_LIST_USER_STRUCT (Entry
, ISCSI_NIC_INFO
, Link
);
508 if (NicInfo
->HwAddressSize
== HwAddressSize
&&
509 CompareMem (&NicInfo
->PermanentAddress
, MacAddr
.Addr
, HwAddressSize
) == 0 &&
510 NicInfo
->VlanId
== VlanId
) {
511 mPrivate
->CurrentNic
= NicInfo
->NicIndex
;
515 if (mPrivate
->MaxNic
< NicInfo
->NicIndex
) {
516 mPrivate
->MaxNic
= NicInfo
->NicIndex
;
521 // Record the NIC info in private structure.
523 NicInfo
= AllocateZeroPool (sizeof (ISCSI_NIC_INFO
));
524 if (NicInfo
== NULL
) {
525 return EFI_OUT_OF_RESOURCES
;
528 CopyMem (&NicInfo
->PermanentAddress
, MacAddr
.Addr
, HwAddressSize
);
529 NicInfo
->HwAddressSize
= (UINT32
) HwAddressSize
;
530 NicInfo
->VlanId
= VlanId
;
531 NicInfo
->NicIndex
= (UINT8
) (mPrivate
->MaxNic
+ 1);
532 mPrivate
->MaxNic
= NicInfo
->NicIndex
;
535 // Get the PCI location.
537 IScsiGetNICPciLocation (
540 &NicInfo
->DeviceNumber
,
541 &NicInfo
->FunctionNumber
544 InsertTailList (&mPrivate
->NicInfoList
, &NicInfo
->Link
);
545 mPrivate
->NicCount
++;
547 mPrivate
->CurrentNic
= NicInfo
->NicIndex
;
553 Delete the recorded NIC info from global structure. Also delete corresponding
556 @param[in] Controller The handle of the controller.
558 @retval EFI_SUCCESS The operation is completed.
559 @retval EFI_NOT_FOUND The NIC info to be deleted is not recorded.
564 IN EFI_HANDLE Controller
568 ISCSI_NIC_INFO
*NicInfo
;
570 LIST_ENTRY
*NextEntry
;
571 ISCSI_ATTEMPT_CONFIG_NVDATA
*AttemptConfigData
;
572 ISCSI_NIC_INFO
*ThisNic
;
573 EFI_MAC_ADDRESS MacAddr
;
578 // Get MAC address of this network device.
580 Status
= NetLibGetMacAddress (Controller
, &MacAddr
, &HwAddressSize
);
581 if (EFI_ERROR (Status
)) {
586 // Get VLAN ID of this network device.
588 VlanId
= NetLibGetVlanId (Controller
);
591 // Check whether the NIC information exists.
595 NET_LIST_FOR_EACH (Entry
, &mPrivate
->NicInfoList
) {
596 NicInfo
= NET_LIST_USER_STRUCT (Entry
, ISCSI_NIC_INFO
, Link
);
597 if (NicInfo
->HwAddressSize
== HwAddressSize
&&
598 CompareMem (&NicInfo
->PermanentAddress
, MacAddr
.Addr
, HwAddressSize
) == 0 &&
599 NicInfo
->VlanId
== VlanId
) {
606 if (ThisNic
== NULL
) {
607 return EFI_NOT_FOUND
;
610 mPrivate
->CurrentNic
= ThisNic
->NicIndex
;
612 RemoveEntryList (&ThisNic
->Link
);
614 mPrivate
->NicCount
--;
617 // Remove all attempts related to this NIC.
619 NET_LIST_FOR_EACH_SAFE (Entry
, NextEntry
, &mPrivate
->AttemptConfigs
) {
620 AttemptConfigData
= NET_LIST_USER_STRUCT (Entry
, ISCSI_ATTEMPT_CONFIG_NVDATA
, Link
);
621 if (AttemptConfigData
->NicIndex
== mPrivate
->CurrentNic
) {
622 RemoveEntryList (&AttemptConfigData
->Link
);
623 mPrivate
->AttemptCount
--;
625 if (AttemptConfigData
->SessionConfigData
.Enabled
== ISCSI_ENABLED_FOR_MPIO
&& mPrivate
->MpioCount
> 0) {
626 if (--mPrivate
->MpioCount
== 0) {
627 mPrivate
->EnableMpio
= FALSE
;
630 if (AttemptConfigData
->AuthenticationType
== ISCSI_AUTH_TYPE_KRB
&& mPrivate
->Krb5MpioCount
> 0) {
631 mPrivate
->Krb5MpioCount
--;
634 } else if (AttemptConfigData
->SessionConfigData
.Enabled
== ISCSI_ENABLED
&& mPrivate
->SinglePathCount
> 0) {
635 mPrivate
->SinglePathCount
--;
637 if (mPrivate
->ValidSinglePathCount
> 0) {
638 mPrivate
->ValidSinglePathCount
--;
642 FreePool (AttemptConfigData
);
647 // Free attempt is created but not saved to system.
649 if (mPrivate
->NewAttempt
!= NULL
) {
650 FreePool (mPrivate
->NewAttempt
);
651 mPrivate
->NewAttempt
= NULL
;
659 Get the recorded NIC info from global structure by the Index.
661 @param[in] NicIndex The index indicates the position of NIC info.
663 @return Pointer to the NIC info, or NULL if not found.
667 IScsiGetNicInfoByIndex (
672 ISCSI_NIC_INFO
*NicInfo
;
674 NET_LIST_FOR_EACH (Entry
, &mPrivate
->NicInfoList
) {
675 NicInfo
= NET_LIST_USER_STRUCT (Entry
, ISCSI_NIC_INFO
, Link
);
676 if (NicInfo
->NicIndex
== NicIndex
) {
686 Get the NIC's PCI location and return it according to the composited
687 format defined in iSCSI Boot Firmware Table.
689 @param[in] Controller The handle of the controller.
690 @param[out] Bus The bus number.
691 @param[out] Device The device number.
692 @param[out] Function The function number.
694 @return The composited representation of the NIC PCI location.
698 IScsiGetNICPciLocation (
699 IN EFI_HANDLE Controller
,
706 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
707 EFI_HANDLE PciIoHandle
;
708 EFI_PCI_IO_PROTOCOL
*PciIo
;
711 Status
= gBS
->HandleProtocol (
713 &gEfiDevicePathProtocolGuid
,
714 (VOID
**) &DevicePath
716 if (EFI_ERROR (Status
)) {
720 Status
= gBS
->LocateDevicePath (
721 &gEfiPciIoProtocolGuid
,
725 if (EFI_ERROR (Status
)) {
729 Status
= gBS
->HandleProtocol (PciIoHandle
, &gEfiPciIoProtocolGuid
, (VOID
**) &PciIo
);
730 if (EFI_ERROR (Status
)) {
734 Status
= PciIo
->GetLocation (PciIo
, &Segment
, Bus
, Device
, Function
);
735 if (EFI_ERROR (Status
)) {
739 return (UINT16
) ((*Bus
<< 8) | (*Device
<< 3) | *Function
);
744 Read the EFI variable (VendorGuid/Name) and return a dynamically allocated
745 buffer, and the size of the buffer. If failure, return NULL.
747 @param[in] Name String part of EFI variable name.
748 @param[in] VendorGuid GUID part of EFI variable name.
749 @param[out] VariableSize Returns the size of the EFI variable that was read.
751 @return Dynamically allocated memory that contains a copy of the EFI variable.
752 @return Caller is responsible freeing the buffer.
753 @retval NULL Variable was not read.
757 IScsiGetVariableAndSize (
759 IN EFI_GUID
*VendorGuid
,
760 OUT UINTN
*VariableSize
770 // Pass in a zero size buffer to find the required buffer size.
773 Status
= gRT
->GetVariable (Name
, VendorGuid
, NULL
, &BufferSize
, Buffer
);
774 if (Status
== EFI_BUFFER_TOO_SMALL
) {
776 // Allocate the buffer to return
778 Buffer
= AllocateZeroPool (BufferSize
);
779 if (Buffer
== NULL
) {
783 // Read variable into the allocated buffer.
785 Status
= gRT
->GetVariable (Name
, VendorGuid
, NULL
, &BufferSize
, Buffer
);
786 if (EFI_ERROR (Status
)) {
791 *VariableSize
= BufferSize
;
797 Create the iSCSI driver data.
799 @param[in] Image The handle of the driver image.
800 @param[in] Controller The handle of the controller.
802 @return The iSCSI driver data created.
803 @retval NULL Other errors as indicated.
807 IScsiCreateDriverData (
809 IN EFI_HANDLE Controller
812 ISCSI_DRIVER_DATA
*Private
;
815 Private
= AllocateZeroPool (sizeof (ISCSI_DRIVER_DATA
));
816 if (Private
== NULL
) {
820 Private
->Signature
= ISCSI_DRIVER_DATA_SIGNATURE
;
821 Private
->Image
= Image
;
822 Private
->Controller
= Controller
;
823 Private
->Session
= NULL
;
826 // Create an event to be signaled when the BS to RT transition is triggerd so
827 // as to abort the iSCSI session.
829 Status
= gBS
->CreateEventEx (
832 IScsiOnExitBootService
,
834 &gEfiEventExitBootServicesGuid
,
835 &Private
->ExitBootServiceEvent
837 if (EFI_ERROR (Status
)) {
842 Private
->ExtScsiPassThruHandle
= NULL
;
843 CopyMem(&Private
->IScsiExtScsiPassThru
, &gIScsiExtScsiPassThruProtocolTemplate
, sizeof(EFI_EXT_SCSI_PASS_THRU_PROTOCOL
));
846 // 0 is designated to the TargetId, so use another value for the AdapterId.
848 Private
->ExtScsiPassThruMode
.AdapterId
= 2;
849 Private
->ExtScsiPassThruMode
.Attributes
= EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL
| EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL
;
850 Private
->ExtScsiPassThruMode
.IoAlign
= 4;
851 Private
->IScsiExtScsiPassThru
.Mode
= &Private
->ExtScsiPassThruMode
;
858 Clean the iSCSI driver data.
860 @param[in] Private The iSCSI driver data.
862 @retval EFI_SUCCESS The clean operation is successful.
863 @retval Others Other errors as indicated.
867 IScsiCleanDriverData (
868 IN ISCSI_DRIVER_DATA
*Private
873 Status
= EFI_SUCCESS
;
875 if (Private
->DevicePath
!= NULL
) {
876 Status
= gBS
->UninstallProtocolInterface (
877 Private
->ExtScsiPassThruHandle
,
878 &gEfiDevicePathProtocolGuid
,
881 if (EFI_ERROR (Status
)) {
885 FreePool (Private
->DevicePath
);
888 if (Private
->ExtScsiPassThruHandle
!= NULL
) {
889 Status
= gBS
->UninstallProtocolInterface (
890 Private
->ExtScsiPassThruHandle
,
891 &gEfiExtScsiPassThruProtocolGuid
,
892 &Private
->IScsiExtScsiPassThru
894 if (!EFI_ERROR (Status
)) {
895 mPrivate
->OneSessionEstablished
= FALSE
;
901 gBS
->CloseEvent (Private
->ExitBootServiceEvent
);
908 Check wheather the Controller handle is configured to use DHCP protocol.
910 @param[in] Controller The handle of the controller.
911 @param[in] IpVersion IP_VERSION_4 or IP_VERSION_6.
913 @retval TRUE The handle of the controller need the Dhcp protocol.
914 @retval FALSE The handle of the controller does not need the Dhcp protocol.
918 IScsiDhcpIsConfigured (
919 IN EFI_HANDLE Controller
,
923 ISCSI_ATTEMPT_CONFIG_NVDATA
*AttemptTmp
;
924 UINT8
*AttemptConfigOrder
;
925 UINTN AttemptConfigOrderSize
;
928 EFI_MAC_ADDRESS MacAddr
;
931 CHAR16 MacString
[ISCSI_MAX_MAC_STRING_LEN
];
932 CHAR16 AttemptName
[ISCSI_NAME_IFR_MAX_SIZE
];
934 AttemptConfigOrder
= IScsiGetVariableAndSize (
937 &AttemptConfigOrderSize
939 if (AttemptConfigOrder
== NULL
|| AttemptConfigOrderSize
== 0) {
944 // Get MAC address of this network device.
946 Status
= NetLibGetMacAddress (Controller
, &MacAddr
, &HwAddressSize
);
947 if(EFI_ERROR (Status
)) {
951 // Get VLAN ID of this network device.
953 VlanId
= NetLibGetVlanId (Controller
);
954 IScsiMacAddrToStr (&MacAddr
, (UINT32
) HwAddressSize
, VlanId
, MacString
);
956 for (Index
= 0; Index
< AttemptConfigOrderSize
/ sizeof (UINT8
); Index
++) {
962 (UINTN
) AttemptConfigOrder
[Index
]
964 Status
= GetVariable2 (
966 &gEfiIScsiInitiatorNameProtocolGuid
,
970 if(AttemptTmp
== NULL
|| EFI_ERROR (Status
)) {
974 ASSERT (AttemptConfigOrder
[Index
] == AttemptTmp
->AttemptConfigIndex
);
976 if (AttemptTmp
->SessionConfigData
.Enabled
== ISCSI_DISABLED
) {
977 FreePool (AttemptTmp
);
981 if (AttemptTmp
->SessionConfigData
.IpMode
!= IP_MODE_AUTOCONFIG
&&
982 AttemptTmp
->SessionConfigData
.IpMode
!= ((IpVersion
== IP_VERSION_4
) ? IP_MODE_IP4
: IP_MODE_IP6
)) {
983 FreePool (AttemptTmp
);
987 if(AttemptTmp
->SessionConfigData
.IpMode
== IP_MODE_AUTOCONFIG
||
988 AttemptTmp
->SessionConfigData
.InitiatorInfoFromDhcp
== TRUE
||
989 AttemptTmp
->SessionConfigData
.TargetInfoFromDhcp
== TRUE
) {
990 FreePool (AttemptTmp
);
991 FreePool (AttemptConfigOrder
);
995 FreePool (AttemptTmp
);
998 FreePool (AttemptConfigOrder
);
1003 Get the various configuration data.
1005 @param[in] Private The iSCSI driver data.
1007 @retval EFI_SUCCESS The configuration data is retrieved.
1008 @retval EFI_NOT_FOUND This iSCSI driver is not configured yet.
1009 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
1013 IScsiGetConfigData (
1014 IN ISCSI_DRIVER_DATA
*Private
1018 CHAR16 MacString
[ISCSI_MAX_MAC_STRING_LEN
];
1020 ISCSI_NIC_INFO
*NicInfo
;
1021 ISCSI_ATTEMPT_CONFIG_NVDATA
*AttemptConfigData
;
1022 ISCSI_ATTEMPT_CONFIG_NVDATA
*AttemptTmp
;
1023 UINT8
*AttemptConfigOrder
;
1024 UINTN AttemptConfigOrderSize
;
1025 CHAR16 IScsiMode
[64];
1029 // There should be at least one attempt configured.
1031 AttemptConfigOrder
= IScsiGetVariableAndSize (
1034 &AttemptConfigOrderSize
1036 if (AttemptConfigOrder
== NULL
|| AttemptConfigOrderSize
== 0) {
1037 return EFI_NOT_FOUND
;
1041 // Get the iSCSI Initiator Name.
1043 mPrivate
->InitiatorNameLength
= ISCSI_NAME_MAX_SIZE
;
1044 Status
= gIScsiInitiatorName
.Get (
1045 &gIScsiInitiatorName
,
1046 &mPrivate
->InitiatorNameLength
,
1047 mPrivate
->InitiatorName
1049 if (EFI_ERROR (Status
)) {
1054 // Get the normal configuration.
1056 for (Index
= 0; Index
< AttemptConfigOrderSize
/ sizeof (UINT8
); Index
++) {
1059 // Check whether the attempt exists in AttemptConfig.
1061 AttemptTmp
= IScsiConfigGetAttemptByConfigIndex (AttemptConfigOrder
[Index
]);
1062 if (AttemptTmp
!= NULL
&& AttemptTmp
->SessionConfigData
.Enabled
== ISCSI_DISABLED
) {
1064 } else if (AttemptTmp
!= NULL
&& AttemptTmp
->SessionConfigData
.Enabled
!= ISCSI_DISABLED
) {
1066 // Check the autoconfig path to see whether it should be retried.
1068 if (AttemptTmp
->SessionConfigData
.IpMode
== IP_MODE_AUTOCONFIG
&&
1069 !AttemptTmp
->AutoConfigureSuccess
) {
1070 if (mPrivate
->Ipv6Flag
&&
1071 AttemptTmp
->AutoConfigureMode
== IP_MODE_AUTOCONFIG_IP6
) {
1073 // Autoconfigure for IP6 already attempted but failed. Do not try again.
1076 } else if (!mPrivate
->Ipv6Flag
&&
1077 AttemptTmp
->AutoConfigureMode
== IP_MODE_AUTOCONFIG_IP4
) {
1079 // Autoconfigure for IP4 already attempted but failed. Do not try again.
1084 // Try another approach for this autoconfigure path.
1086 AttemptTmp
->AutoConfigureMode
=
1087 (UINT8
) (mPrivate
->Ipv6Flag
? IP_MODE_AUTOCONFIG_IP6
: IP_MODE_AUTOCONFIG_IP4
);
1088 AttemptTmp
->SessionConfigData
.InitiatorInfoFromDhcp
= TRUE
;
1089 AttemptTmp
->SessionConfigData
.TargetInfoFromDhcp
= TRUE
;
1090 AttemptTmp
->DhcpSuccess
= FALSE
;
1093 // Get some information from the dhcp server.
1095 if (!mPrivate
->Ipv6Flag
) {
1096 Status
= IScsiDoDhcp (Private
->Image
, Private
->Controller
, AttemptTmp
);
1097 if (!EFI_ERROR (Status
)) {
1098 AttemptTmp
->DhcpSuccess
= TRUE
;
1101 Status
= IScsiDoDhcp6 (Private
->Image
, Private
->Controller
, AttemptTmp
);
1102 if (!EFI_ERROR (Status
)) {
1103 AttemptTmp
->DhcpSuccess
= TRUE
;
1108 // Refresh the state of this attempt to NVR.
1110 AsciiStrToUnicodeStrS (AttemptTmp
->MacString
, MacString
, sizeof (MacString
) / sizeof (MacString
[0]));
1112 mPrivate
->PortString
,
1113 (UINTN
) ISCSI_NAME_IFR_MAX_SIZE
,
1116 (UINTN
) AttemptTmp
->AttemptConfigIndex
1120 mPrivate
->PortString
,
1121 &gEfiIScsiInitiatorNameProtocolGuid
,
1122 ISCSI_CONFIG_VAR_ATTR
,
1123 sizeof (ISCSI_ATTEMPT_CONFIG_NVDATA
),
1129 } else if (AttemptTmp
->SessionConfigData
.InitiatorInfoFromDhcp
&& !AttemptTmp
->ValidPath
) {
1131 // Get DHCP information for already added, but failed, attempt.
1133 AttemptTmp
->DhcpSuccess
= FALSE
;
1134 if (!mPrivate
->Ipv6Flag
&& (AttemptTmp
->SessionConfigData
.IpMode
== IP_MODE_IP4
)) {
1135 Status
= IScsiDoDhcp (Private
->Image
, Private
->Controller
, AttemptTmp
);
1136 if (!EFI_ERROR (Status
)) {
1137 AttemptTmp
->DhcpSuccess
= TRUE
;
1139 } else if (mPrivate
->Ipv6Flag
&& (AttemptTmp
->SessionConfigData
.IpMode
== IP_MODE_IP6
)) {
1140 Status
= IScsiDoDhcp6 (Private
->Image
, Private
->Controller
, AttemptTmp
);
1141 if (!EFI_ERROR (Status
)) {
1142 AttemptTmp
->DhcpSuccess
= TRUE
;
1147 // Refresh the state of this attempt to NVR.
1149 AsciiStrToUnicodeStrS (AttemptTmp
->MacString
, MacString
, sizeof (MacString
) / sizeof (MacString
[0]));
1151 mPrivate
->PortString
,
1152 (UINTN
) ISCSI_NAME_IFR_MAX_SIZE
,
1155 (UINTN
) AttemptTmp
->AttemptConfigIndex
1159 mPrivate
->PortString
,
1160 &gEfiIScsiInitiatorNameProtocolGuid
,
1161 ISCSI_CONFIG_VAR_ATTR
,
1162 sizeof (ISCSI_ATTEMPT_CONFIG_NVDATA
),
1174 // This attempt does not exist in AttemptConfig. Try to add a new one.
1177 NicInfo
= IScsiGetNicInfoByIndex (mPrivate
->CurrentNic
);
1178 ASSERT (NicInfo
!= NULL
);
1179 IScsiMacAddrToStr (&NicInfo
->PermanentAddress
, NicInfo
->HwAddressSize
, NicInfo
->VlanId
, MacString
);
1181 mPrivate
->PortString
,
1185 (UINTN
) AttemptConfigOrder
[Index
]
1189 mPrivate
->PortString
,
1190 &gEfiIScsiInitiatorNameProtocolGuid
,
1191 (VOID
**)&AttemptConfigData
,
1195 if (AttemptConfigData
== NULL
) {
1199 ASSERT (AttemptConfigOrder
[Index
] == AttemptConfigData
->AttemptConfigIndex
);
1201 AttemptConfigData
->NicIndex
= NicInfo
->NicIndex
;
1202 AttemptConfigData
->DhcpSuccess
= FALSE
;
1203 AttemptConfigData
->ValidiBFTPath
= (BOOLEAN
) (mPrivate
->EnableMpio
? TRUE
: FALSE
);
1204 AttemptConfigData
->ValidPath
= FALSE
;
1206 if (AttemptConfigData
->SessionConfigData
.IpMode
== IP_MODE_AUTOCONFIG
) {
1207 AttemptConfigData
->SessionConfigData
.InitiatorInfoFromDhcp
= TRUE
;
1208 AttemptConfigData
->SessionConfigData
.TargetInfoFromDhcp
= TRUE
;
1210 AttemptConfigData
->AutoConfigureMode
=
1211 (UINT8
) (mPrivate
->Ipv6Flag
? IP_MODE_AUTOCONFIG_IP6
: IP_MODE_AUTOCONFIG_IP4
);
1212 AttemptConfigData
->AutoConfigureSuccess
= FALSE
;
1216 // Get some information from dhcp server.
1218 if (AttemptConfigData
->SessionConfigData
.Enabled
!= ISCSI_DISABLED
&&
1219 AttemptConfigData
->SessionConfigData
.InitiatorInfoFromDhcp
) {
1221 if (!mPrivate
->Ipv6Flag
&&
1222 (AttemptConfigData
->SessionConfigData
.IpMode
== IP_MODE_IP4
||
1223 AttemptConfigData
->AutoConfigureMode
== IP_MODE_AUTOCONFIG_IP4
)) {
1224 Status
= IScsiDoDhcp (Private
->Image
, Private
->Controller
, AttemptConfigData
);
1225 if (!EFI_ERROR (Status
)) {
1226 AttemptConfigData
->DhcpSuccess
= TRUE
;
1228 } else if (mPrivate
->Ipv6Flag
&&
1229 (AttemptConfigData
->SessionConfigData
.IpMode
== IP_MODE_IP6
||
1230 AttemptConfigData
->AutoConfigureMode
== IP_MODE_AUTOCONFIG_IP6
)) {
1231 Status
= IScsiDoDhcp6 (Private
->Image
, Private
->Controller
, AttemptConfigData
);
1232 if (!EFI_ERROR (Status
)) {
1233 AttemptConfigData
->DhcpSuccess
= TRUE
;
1238 // Refresh the state of this attempt to NVR.
1240 AsciiStrToUnicodeStrS (AttemptConfigData
->MacString
, MacString
, sizeof (MacString
) / sizeof (MacString
[0]));
1242 mPrivate
->PortString
,
1243 (UINTN
) ISCSI_NAME_IFR_MAX_SIZE
,
1246 (UINTN
) AttemptConfigData
->AttemptConfigIndex
1250 mPrivate
->PortString
,
1251 &gEfiIScsiInitiatorNameProtocolGuid
,
1252 ISCSI_CONFIG_VAR_ATTR
,
1253 sizeof (ISCSI_ATTEMPT_CONFIG_NVDATA
),
1259 // Update Attempt Help Info.
1262 if (AttemptConfigData
->SessionConfigData
.Enabled
== ISCSI_DISABLED
) {
1263 UnicodeSPrint (IScsiMode
, 64, L
"Disabled");
1264 } else if (AttemptConfigData
->SessionConfigData
.Enabled
== ISCSI_ENABLED
) {
1265 UnicodeSPrint (IScsiMode
, 64, L
"Enabled");
1266 } else if (AttemptConfigData
->SessionConfigData
.Enabled
== ISCSI_ENABLED_FOR_MPIO
) {
1267 UnicodeSPrint (IScsiMode
, 64, L
"Enabled for MPIO");
1270 if (AttemptConfigData
->SessionConfigData
.IpMode
== IP_MODE_IP4
) {
1271 UnicodeSPrint (IpMode
, 64, L
"IP4");
1272 } else if (AttemptConfigData
->SessionConfigData
.IpMode
== IP_MODE_IP6
) {
1273 UnicodeSPrint (IpMode
, 64, L
"IP6");
1274 } else if (AttemptConfigData
->SessionConfigData
.IpMode
== IP_MODE_AUTOCONFIG
) {
1275 UnicodeSPrint (IpMode
, 64, L
"Autoconfigure");
1279 mPrivate
->PortString
,
1280 (UINTN
) ISCSI_NAME_IFR_MAX_SIZE
,
1281 L
"MAC: %s, PFA: Bus %d | Dev %d | Func %d, iSCSI mode: %s, IP version: %s",
1284 NicInfo
->DeviceNumber
,
1285 NicInfo
->FunctionNumber
,
1290 AttemptConfigData
->AttemptTitleHelpToken
= HiiSetString (
1291 mCallbackInfo
->RegisteredHandle
,
1293 mPrivate
->PortString
,
1296 if (AttemptConfigData
->AttemptTitleHelpToken
== 0) {
1297 return EFI_OUT_OF_RESOURCES
;
1301 // Record the attempt in global link list.
1303 InsertTailList (&mPrivate
->AttemptConfigs
, &AttemptConfigData
->Link
);
1304 mPrivate
->AttemptCount
++;
1306 if (AttemptConfigData
->SessionConfigData
.Enabled
== ISCSI_ENABLED_FOR_MPIO
) {
1307 mPrivate
->MpioCount
++;
1308 mPrivate
->EnableMpio
= TRUE
;
1310 if (AttemptConfigData
->AuthenticationType
== ISCSI_AUTH_TYPE_KRB
) {
1311 mPrivate
->Krb5MpioCount
++;
1313 } else if (AttemptConfigData
->SessionConfigData
.Enabled
== ISCSI_ENABLED
) {
1314 mPrivate
->SinglePathCount
++;
1319 // Reorder the AttemptConfig by the configured order.
1321 for (Index
= 0; Index
< AttemptConfigOrderSize
/ sizeof (UINT8
); Index
++) {
1322 AttemptConfigData
= IScsiConfigGetAttemptByConfigIndex (AttemptConfigOrder
[Index
]);
1323 if (AttemptConfigData
== NULL
) {
1327 RemoveEntryList (&AttemptConfigData
->Link
);
1328 InsertTailList (&mPrivate
->AttemptConfigs
, &AttemptConfigData
->Link
);
1332 // Update the Main Form.
1334 IScsiConfigUpdateAttempt ();
1336 FreePool (AttemptConfigOrder
);
1339 // There should be at least one attempt configuration.
1341 if (!mPrivate
->EnableMpio
) {
1342 if (mPrivate
->SinglePathCount
== 0) {
1343 return EFI_NOT_FOUND
;
1345 mPrivate
->ValidSinglePathCount
= mPrivate
->SinglePathCount
;
1353 Get the device path of the iSCSI tcp connection and update it.
1355 @param Session The iSCSI session.
1357 @return The updated device path.
1358 @retval NULL Other errors as indicated.
1361 EFI_DEVICE_PATH_PROTOCOL
*
1362 IScsiGetTcpConnDevicePath (
1363 IN ISCSI_SESSION
*Session
1366 ISCSI_CONNECTION
*Conn
;
1367 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1369 EFI_DEV_PATH
*DPathNode
;
1372 if (Session
->State
!= SESSION_STATE_LOGGED_IN
) {
1376 Conn
= NET_LIST_USER_STRUCT_S (
1377 Session
->Conns
.ForwardLink
,
1380 ISCSI_CONNECTION_SIGNATURE
1383 Status
= gBS
->HandleProtocol (
1385 &gEfiDevicePathProtocolGuid
,
1386 (VOID
**) &DevicePath
1388 if (EFI_ERROR (Status
)) {
1394 DevicePath
= DuplicateDevicePath (DevicePath
);
1395 if (DevicePath
== NULL
) {
1399 DPathNode
= (EFI_DEV_PATH
*) DevicePath
;
1401 while (!IsDevicePathEnd (&DPathNode
->DevPath
)) {
1402 if (DevicePathType (&DPathNode
->DevPath
) == MESSAGING_DEVICE_PATH
) {
1403 if (!Conn
->Ipv6Flag
&& DevicePathSubType (&DPathNode
->DevPath
) == MSG_IPv4_DP
) {
1404 DPathNode
->Ipv4
.LocalPort
= 0;
1406 DPathNode
->Ipv4
.StaticIpAddress
=
1407 (BOOLEAN
) (!Session
->ConfigData
->SessionConfigData
.InitiatorInfoFromDhcp
);
1410 // Add a judgement here to support previous versions of IPv4_DEVICE_PATH.
1411 // In previous versions of IPv4_DEVICE_PATH, GatewayIpAddress and SubnetMask
1413 // In new version of IPv4_DEVICE_PATH, structcure length is 27.
1416 PathLen
= DevicePathNodeLength (&DPathNode
->Ipv4
);
1418 if (PathLen
== IP4_NODE_LEN_NEW_VERSIONS
) {
1421 &DPathNode
->Ipv4
.GatewayIpAddress
,
1422 &Session
->ConfigData
->SessionConfigData
.Gateway
1426 &DPathNode
->Ipv4
.SubnetMask
,
1427 &Session
->ConfigData
->SessionConfigData
.SubnetMask
1432 } else if (Conn
->Ipv6Flag
&& DevicePathSubType (&DPathNode
->DevPath
) == MSG_IPv6_DP
) {
1433 DPathNode
->Ipv6
.LocalPort
= 0;
1436 // Add a judgement here to support previous versions of IPv6_DEVICE_PATH.
1437 // In previous versions of IPv6_DEVICE_PATH, IpAddressOrigin, PrefixLength
1438 // and GatewayIpAddress do not exist.
1439 // In new version of IPv6_DEVICE_PATH, structure length is 60, while in
1440 // old versions, the length is 43.
1443 PathLen
= DevicePathNodeLength (&DPathNode
->Ipv6
);
1445 if (PathLen
== IP6_NODE_LEN_NEW_VERSIONS
) {
1447 DPathNode
->Ipv6
.IpAddressOrigin
= 0;
1448 DPathNode
->Ipv6
.PrefixLength
= IP6_PREFIX_LENGTH
;
1449 ZeroMem (&DPathNode
->Ipv6
.GatewayIpAddress
, sizeof (EFI_IPv6_ADDRESS
));
1451 else if (PathLen
== IP6_NODE_LEN_OLD_VERSIONS
) {
1454 // StaticIPAddress is a field in old versions of IPv6_DEVICE_PATH, while ignored in new
1455 // version. Set StaticIPAddress through its' offset in old IPv6_DEVICE_PATH.
1457 *((UINT8
*)(&DPathNode
->Ipv6
) + IP6_OLD_IPADDRESS_OFFSET
) =
1458 (BOOLEAN
) (!Session
->ConfigData
->SessionConfigData
.InitiatorInfoFromDhcp
);
1465 DPathNode
= (EFI_DEV_PATH
*) NextDevicePathNode (&DPathNode
->DevPath
);
1473 Abort the session when the transition from BS to RT is initiated.
1475 @param[in] Event The event signaled.
1476 @param[in] Context The iSCSI driver data.
1481 IScsiOnExitBootService (
1486 ISCSI_DRIVER_DATA
*Private
;
1488 Private
= (ISCSI_DRIVER_DATA
*) Context
;
1489 gBS
->CloseEvent (Private
->ExitBootServiceEvent
);
1491 if (Private
->Session
!= NULL
) {
1492 IScsiSessionAbort (Private
->Session
);
1497 Tests whether a controller handle is being managed by IScsi driver.
1499 This function tests whether the driver specified by DriverBindingHandle is
1500 currently managing the controller specified by ControllerHandle. This test
1501 is performed by evaluating if the the protocol specified by ProtocolGuid is
1502 present on ControllerHandle and is was opened by DriverBindingHandle and Nic
1503 Device handle with an attribute of EFI_OPEN_PROTOCOL_BY_DRIVER.
1504 If ProtocolGuid is NULL, then ASSERT().
1506 @param ControllerHandle A handle for a controller to test.
1507 @param DriverBindingHandle Specifies the driver binding handle for the
1509 @param ProtocolGuid Specifies the protocol that the driver specified
1510 by DriverBindingHandle opens in its Start()
1513 @retval EFI_SUCCESS ControllerHandle is managed by the driver
1514 specified by DriverBindingHandle.
1515 @retval EFI_UNSUPPORTED ControllerHandle is not managed by the driver
1516 specified by DriverBindingHandle.
1521 IScsiTestManagedDevice (
1522 IN EFI_HANDLE ControllerHandle
,
1523 IN EFI_HANDLE DriverBindingHandle
,
1524 IN EFI_GUID
*ProtocolGuid
1528 VOID
*ManagedInterface
;
1529 EFI_HANDLE NicControllerHandle
;
1531 ASSERT (ProtocolGuid
!= NULL
);
1533 NicControllerHandle
= NetLibGetNicHandle (ControllerHandle
, ProtocolGuid
);
1534 if (NicControllerHandle
== NULL
) {
1535 return EFI_UNSUPPORTED
;
1538 Status
= gBS
->OpenProtocol (
1540 (EFI_GUID
*) ProtocolGuid
,
1542 DriverBindingHandle
,
1543 NicControllerHandle
,
1544 EFI_OPEN_PROTOCOL_BY_DRIVER
1546 if (!EFI_ERROR (Status
)) {
1547 gBS
->CloseProtocol (
1549 (EFI_GUID
*) ProtocolGuid
,
1550 DriverBindingHandle
,
1553 return EFI_UNSUPPORTED
;
1556 if (Status
!= EFI_ALREADY_STARTED
) {
1557 return EFI_UNSUPPORTED
;