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.
1012 IScsiGetConfigData (
1013 IN ISCSI_DRIVER_DATA
*Private
1017 CHAR16 MacString
[ISCSI_MAX_MAC_STRING_LEN
];
1019 ISCSI_NIC_INFO
*NicInfo
;
1020 ISCSI_ATTEMPT_CONFIG_NVDATA
*AttemptConfigData
;
1021 ISCSI_ATTEMPT_CONFIG_NVDATA
*AttemptTmp
;
1022 UINT8
*AttemptConfigOrder
;
1023 UINTN AttemptConfigOrderSize
;
1024 CHAR16 IScsiMode
[64];
1028 // There should be at least one attempt configured.
1030 AttemptConfigOrder
= IScsiGetVariableAndSize (
1033 &AttemptConfigOrderSize
1035 if (AttemptConfigOrder
== NULL
|| AttemptConfigOrderSize
== 0) {
1036 return EFI_NOT_FOUND
;
1040 // Get the iSCSI Initiator Name.
1042 mPrivate
->InitiatorNameLength
= ISCSI_NAME_MAX_SIZE
;
1043 Status
= gIScsiInitiatorName
.Get (
1044 &gIScsiInitiatorName
,
1045 &mPrivate
->InitiatorNameLength
,
1046 mPrivate
->InitiatorName
1048 if (EFI_ERROR (Status
)) {
1053 // Get the normal configuration.
1055 for (Index
= 0; Index
< AttemptConfigOrderSize
/ sizeof (UINT8
); Index
++) {
1058 // Check whether the attempt exists in AttemptConfig.
1060 AttemptTmp
= IScsiConfigGetAttemptByConfigIndex (AttemptConfigOrder
[Index
]);
1061 if (AttemptTmp
!= NULL
&& AttemptTmp
->SessionConfigData
.Enabled
== ISCSI_DISABLED
) {
1063 } else if (AttemptTmp
!= NULL
&& AttemptTmp
->SessionConfigData
.Enabled
!= ISCSI_DISABLED
) {
1065 // Check the autoconfig path to see whether it should be retried.
1067 if (AttemptTmp
->SessionConfigData
.IpMode
== IP_MODE_AUTOCONFIG
&&
1068 !AttemptTmp
->AutoConfigureSuccess
) {
1069 if (mPrivate
->Ipv6Flag
&&
1070 AttemptTmp
->AutoConfigureMode
== IP_MODE_AUTOCONFIG_IP6
) {
1072 // Autoconfigure for IP6 already attempted but failed. Do not try again.
1075 } else if (!mPrivate
->Ipv6Flag
&&
1076 AttemptTmp
->AutoConfigureMode
== IP_MODE_AUTOCONFIG_IP4
) {
1078 // Autoconfigure for IP4 already attempted but failed. Do not try again.
1083 // Try another approach for this autoconfigure path.
1085 AttemptTmp
->AutoConfigureMode
=
1086 (UINT8
) (mPrivate
->Ipv6Flag
? IP_MODE_AUTOCONFIG_IP6
: IP_MODE_AUTOCONFIG_IP4
);
1087 AttemptTmp
->SessionConfigData
.InitiatorInfoFromDhcp
= TRUE
;
1088 AttemptTmp
->SessionConfigData
.TargetInfoFromDhcp
= TRUE
;
1089 AttemptTmp
->DhcpSuccess
= FALSE
;
1092 // Get some information from the dhcp server.
1094 if (!mPrivate
->Ipv6Flag
) {
1095 Status
= IScsiDoDhcp (Private
->Image
, Private
->Controller
, AttemptTmp
);
1096 if (!EFI_ERROR (Status
)) {
1097 AttemptTmp
->DhcpSuccess
= TRUE
;
1100 Status
= IScsiDoDhcp6 (Private
->Image
, Private
->Controller
, AttemptTmp
);
1101 if (!EFI_ERROR (Status
)) {
1102 AttemptTmp
->DhcpSuccess
= TRUE
;
1107 // Refresh the state of this attempt to NVR.
1109 AsciiStrToUnicodeStr (AttemptTmp
->MacString
, MacString
);
1111 mPrivate
->PortString
,
1112 (UINTN
) ISCSI_NAME_IFR_MAX_SIZE
,
1115 (UINTN
) AttemptTmp
->AttemptConfigIndex
1119 mPrivate
->PortString
,
1120 &gEfiIScsiInitiatorNameProtocolGuid
,
1121 ISCSI_CONFIG_VAR_ATTR
,
1122 sizeof (ISCSI_ATTEMPT_CONFIG_NVDATA
),
1128 } else if (AttemptTmp
->SessionConfigData
.InitiatorInfoFromDhcp
&& !AttemptTmp
->ValidPath
) {
1130 // Get DHCP information for already added, but failed, attempt.
1132 AttemptTmp
->DhcpSuccess
= FALSE
;
1133 if (!mPrivate
->Ipv6Flag
&& (AttemptTmp
->SessionConfigData
.IpMode
== IP_MODE_IP4
)) {
1134 Status
= IScsiDoDhcp (Private
->Image
, Private
->Controller
, AttemptTmp
);
1135 if (!EFI_ERROR (Status
)) {
1136 AttemptTmp
->DhcpSuccess
= TRUE
;
1138 } else if (mPrivate
->Ipv6Flag
&& (AttemptTmp
->SessionConfigData
.IpMode
== IP_MODE_IP6
)) {
1139 Status
= IScsiDoDhcp6 (Private
->Image
, Private
->Controller
, AttemptTmp
);
1140 if (!EFI_ERROR (Status
)) {
1141 AttemptTmp
->DhcpSuccess
= TRUE
;
1146 // Refresh the state of this attempt to NVR.
1148 AsciiStrToUnicodeStr (AttemptTmp
->MacString
, MacString
);
1150 mPrivate
->PortString
,
1151 (UINTN
) ISCSI_NAME_IFR_MAX_SIZE
,
1154 (UINTN
) AttemptTmp
->AttemptConfigIndex
1158 mPrivate
->PortString
,
1159 &gEfiIScsiInitiatorNameProtocolGuid
,
1160 ISCSI_CONFIG_VAR_ATTR
,
1161 sizeof (ISCSI_ATTEMPT_CONFIG_NVDATA
),
1173 // This attempt does not exist in AttemptConfig. Try to add a new one.
1176 NicInfo
= IScsiGetNicInfoByIndex (mPrivate
->CurrentNic
);
1177 ASSERT (NicInfo
!= NULL
);
1178 IScsiMacAddrToStr (&NicInfo
->PermanentAddress
, NicInfo
->HwAddressSize
, NicInfo
->VlanId
, MacString
);
1180 mPrivate
->PortString
,
1184 (UINTN
) AttemptConfigOrder
[Index
]
1188 mPrivate
->PortString
,
1189 &gEfiIScsiInitiatorNameProtocolGuid
,
1190 (VOID
**)&AttemptConfigData
,
1194 if (AttemptConfigData
== NULL
) {
1198 ASSERT (AttemptConfigOrder
[Index
] == AttemptConfigData
->AttemptConfigIndex
);
1200 AttemptConfigData
->NicIndex
= NicInfo
->NicIndex
;
1201 AttemptConfigData
->DhcpSuccess
= FALSE
;
1202 AttemptConfigData
->ValidiBFTPath
= (BOOLEAN
) (mPrivate
->EnableMpio
? TRUE
: FALSE
);
1203 AttemptConfigData
->ValidPath
= FALSE
;
1205 if (AttemptConfigData
->SessionConfigData
.IpMode
== IP_MODE_AUTOCONFIG
) {
1206 AttemptConfigData
->SessionConfigData
.InitiatorInfoFromDhcp
= TRUE
;
1207 AttemptConfigData
->SessionConfigData
.TargetInfoFromDhcp
= TRUE
;
1209 AttemptConfigData
->AutoConfigureMode
=
1210 (UINT8
) (mPrivate
->Ipv6Flag
? IP_MODE_AUTOCONFIG_IP6
: IP_MODE_AUTOCONFIG_IP4
);
1211 AttemptConfigData
->AutoConfigureSuccess
= FALSE
;
1215 // Get some information from dhcp server.
1217 if (AttemptConfigData
->SessionConfigData
.Enabled
!= ISCSI_DISABLED
&&
1218 AttemptConfigData
->SessionConfigData
.InitiatorInfoFromDhcp
) {
1220 if (!mPrivate
->Ipv6Flag
&&
1221 (AttemptConfigData
->SessionConfigData
.IpMode
== IP_MODE_IP4
||
1222 AttemptConfigData
->AutoConfigureMode
== IP_MODE_AUTOCONFIG_IP4
)) {
1223 Status
= IScsiDoDhcp (Private
->Image
, Private
->Controller
, AttemptConfigData
);
1224 if (!EFI_ERROR (Status
)) {
1225 AttemptConfigData
->DhcpSuccess
= TRUE
;
1227 } else if (mPrivate
->Ipv6Flag
&&
1228 (AttemptConfigData
->SessionConfigData
.IpMode
== IP_MODE_IP6
||
1229 AttemptConfigData
->AutoConfigureMode
== IP_MODE_AUTOCONFIG_IP6
)) {
1230 Status
= IScsiDoDhcp6 (Private
->Image
, Private
->Controller
, AttemptConfigData
);
1231 if (!EFI_ERROR (Status
)) {
1232 AttemptConfigData
->DhcpSuccess
= TRUE
;
1237 // Refresh the state of this attempt to NVR.
1239 AsciiStrToUnicodeStr (AttemptConfigData
->MacString
, MacString
);
1241 mPrivate
->PortString
,
1242 (UINTN
) ISCSI_NAME_IFR_MAX_SIZE
,
1245 (UINTN
) AttemptConfigData
->AttemptConfigIndex
1249 mPrivate
->PortString
,
1250 &gEfiIScsiInitiatorNameProtocolGuid
,
1251 ISCSI_CONFIG_VAR_ATTR
,
1252 sizeof (ISCSI_ATTEMPT_CONFIG_NVDATA
),
1258 // Update Attempt Help Info.
1261 if (AttemptConfigData
->SessionConfigData
.Enabled
== ISCSI_DISABLED
) {
1262 UnicodeSPrint (IScsiMode
, 64, L
"Disabled");
1263 } else if (AttemptConfigData
->SessionConfigData
.Enabled
== ISCSI_ENABLED
) {
1264 UnicodeSPrint (IScsiMode
, 64, L
"Enabled");
1265 } else if (AttemptConfigData
->SessionConfigData
.Enabled
== ISCSI_ENABLED_FOR_MPIO
) {
1266 UnicodeSPrint (IScsiMode
, 64, L
"Enabled for MPIO");
1269 if (AttemptConfigData
->SessionConfigData
.IpMode
== IP_MODE_IP4
) {
1270 UnicodeSPrint (IpMode
, 64, L
"IP4");
1271 } else if (AttemptConfigData
->SessionConfigData
.IpMode
== IP_MODE_IP6
) {
1272 UnicodeSPrint (IpMode
, 64, L
"IP6");
1273 } else if (AttemptConfigData
->SessionConfigData
.IpMode
== IP_MODE_AUTOCONFIG
) {
1274 UnicodeSPrint (IpMode
, 64, L
"Autoconfigure");
1278 mPrivate
->PortString
,
1279 (UINTN
) ISCSI_NAME_IFR_MAX_SIZE
,
1280 L
"MAC: %s, PFA: Bus %d | Dev %d | Func %d, iSCSI mode: %s, IP version: %s",
1283 NicInfo
->DeviceNumber
,
1284 NicInfo
->FunctionNumber
,
1289 AttemptConfigData
->AttemptTitleHelpToken
= HiiSetString (
1290 mCallbackInfo
->RegisteredHandle
,
1292 mPrivate
->PortString
,
1295 ASSERT (AttemptConfigData
->AttemptTitleHelpToken
!= 0);
1298 // Record the attempt in global link list.
1300 InsertTailList (&mPrivate
->AttemptConfigs
, &AttemptConfigData
->Link
);
1301 mPrivate
->AttemptCount
++;
1303 if (AttemptConfigData
->SessionConfigData
.Enabled
== ISCSI_ENABLED_FOR_MPIO
) {
1304 mPrivate
->MpioCount
++;
1305 mPrivate
->EnableMpio
= TRUE
;
1307 if (AttemptConfigData
->AuthenticationType
== ISCSI_AUTH_TYPE_KRB
) {
1308 mPrivate
->Krb5MpioCount
++;
1310 } else if (AttemptConfigData
->SessionConfigData
.Enabled
== ISCSI_ENABLED
) {
1311 mPrivate
->SinglePathCount
++;
1316 // Reorder the AttemptConfig by the configured order.
1318 for (Index
= 0; Index
< AttemptConfigOrderSize
/ sizeof (UINT8
); Index
++) {
1319 AttemptConfigData
= IScsiConfigGetAttemptByConfigIndex (AttemptConfigOrder
[Index
]);
1320 if (AttemptConfigData
== NULL
) {
1324 RemoveEntryList (&AttemptConfigData
->Link
);
1325 InsertTailList (&mPrivate
->AttemptConfigs
, &AttemptConfigData
->Link
);
1329 // Update the Main Form.
1331 IScsiConfigUpdateAttempt ();
1333 FreePool (AttemptConfigOrder
);
1336 // There should be at least one attempt configuration.
1338 if (!mPrivate
->EnableMpio
) {
1339 if (mPrivate
->SinglePathCount
== 0) {
1340 return EFI_NOT_FOUND
;
1342 mPrivate
->ValidSinglePathCount
= mPrivate
->SinglePathCount
;
1350 Get the device path of the iSCSI tcp connection and update it.
1352 @param Session The iSCSI session.
1354 @return The updated device path.
1355 @retval NULL Other errors as indicated.
1358 EFI_DEVICE_PATH_PROTOCOL
*
1359 IScsiGetTcpConnDevicePath (
1360 IN ISCSI_SESSION
*Session
1363 ISCSI_CONNECTION
*Conn
;
1364 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1366 EFI_DEV_PATH
*DPathNode
;
1369 if (Session
->State
!= SESSION_STATE_LOGGED_IN
) {
1373 Conn
= NET_LIST_USER_STRUCT_S (
1374 Session
->Conns
.ForwardLink
,
1377 ISCSI_CONNECTION_SIGNATURE
1380 Status
= gBS
->HandleProtocol (
1382 &gEfiDevicePathProtocolGuid
,
1383 (VOID
**) &DevicePath
1385 if (EFI_ERROR (Status
)) {
1391 DevicePath
= DuplicateDevicePath (DevicePath
);
1392 if (DevicePath
== NULL
) {
1396 DPathNode
= (EFI_DEV_PATH
*) DevicePath
;
1398 while (!IsDevicePathEnd (&DPathNode
->DevPath
)) {
1399 if (DevicePathType (&DPathNode
->DevPath
) == MESSAGING_DEVICE_PATH
) {
1400 if (!Conn
->Ipv6Flag
&& DevicePathSubType (&DPathNode
->DevPath
) == MSG_IPv4_DP
) {
1401 DPathNode
->Ipv4
.LocalPort
= 0;
1403 DPathNode
->Ipv4
.StaticIpAddress
=
1404 (BOOLEAN
) (!Session
->ConfigData
->SessionConfigData
.InitiatorInfoFromDhcp
);
1407 // Add a judgement here to support previous versions of IPv4_DEVICE_PATH.
1408 // In previous versions of IPv4_DEVICE_PATH, GatewayIpAddress and SubnetMask
1410 // In new version of IPv4_DEVICE_PATH, structcure length is 27.
1413 PathLen
= DevicePathNodeLength (&DPathNode
->Ipv4
);
1415 if (PathLen
== IP4_NODE_LEN_NEW_VERSIONS
) {
1418 &DPathNode
->Ipv4
.GatewayIpAddress
,
1419 &Session
->ConfigData
->SessionConfigData
.Gateway
1423 &DPathNode
->Ipv4
.SubnetMask
,
1424 &Session
->ConfigData
->SessionConfigData
.SubnetMask
1429 } else if (Conn
->Ipv6Flag
&& DevicePathSubType (&DPathNode
->DevPath
) == MSG_IPv6_DP
) {
1430 DPathNode
->Ipv6
.LocalPort
= 0;
1433 // Add a judgement here to support previous versions of IPv6_DEVICE_PATH.
1434 // In previous versions of IPv6_DEVICE_PATH, IpAddressOrigin, PrefixLength
1435 // and GatewayIpAddress do not exist.
1436 // In new version of IPv6_DEVICE_PATH, structure length is 60, while in
1437 // old versions, the length is 43.
1440 PathLen
= DevicePathNodeLength (&DPathNode
->Ipv6
);
1442 if (PathLen
== IP6_NODE_LEN_NEW_VERSIONS
) {
1444 DPathNode
->Ipv6
.IpAddressOrigin
= 0;
1445 DPathNode
->Ipv6
.PrefixLength
= IP6_PREFIX_LENGTH
;
1446 ZeroMem (&DPathNode
->Ipv6
.GatewayIpAddress
, sizeof (EFI_IPv6_ADDRESS
));
1448 else if (PathLen
== IP6_NODE_LEN_OLD_VERSIONS
) {
1451 // StaticIPAddress is a field in old versions of IPv6_DEVICE_PATH, while ignored in new
1452 // version. Set StaticIPAddress through its' offset in old IPv6_DEVICE_PATH.
1454 *((UINT8
*)(&DPathNode
->Ipv6
) + IP6_OLD_IPADDRESS_OFFSET
) =
1455 (BOOLEAN
) (!Session
->ConfigData
->SessionConfigData
.InitiatorInfoFromDhcp
);
1462 DPathNode
= (EFI_DEV_PATH
*) NextDevicePathNode (&DPathNode
->DevPath
);
1470 Abort the session when the transition from BS to RT is initiated.
1472 @param[in] Event The event signaled.
1473 @param[in] Context The iSCSI driver data.
1478 IScsiOnExitBootService (
1483 ISCSI_DRIVER_DATA
*Private
;
1485 Private
= (ISCSI_DRIVER_DATA
*) Context
;
1486 gBS
->CloseEvent (Private
->ExitBootServiceEvent
);
1488 if (Private
->Session
!= NULL
) {
1489 IScsiSessionAbort (Private
->Session
);
1494 Tests whether a controller handle is being managed by IScsi driver.
1496 This function tests whether the driver specified by DriverBindingHandle is
1497 currently managing the controller specified by ControllerHandle. This test
1498 is performed by evaluating if the the protocol specified by ProtocolGuid is
1499 present on ControllerHandle and is was opened by DriverBindingHandle and Nic
1500 Device handle with an attribute of EFI_OPEN_PROTOCOL_BY_DRIVER.
1501 If ProtocolGuid is NULL, then ASSERT().
1503 @param ControllerHandle A handle for a controller to test.
1504 @param DriverBindingHandle Specifies the driver binding handle for the
1506 @param ProtocolGuid Specifies the protocol that the driver specified
1507 by DriverBindingHandle opens in its Start()
1510 @retval EFI_SUCCESS ControllerHandle is managed by the driver
1511 specified by DriverBindingHandle.
1512 @retval EFI_UNSUPPORTED ControllerHandle is not managed by the driver
1513 specified by DriverBindingHandle.
1518 IScsiTestManagedDevice (
1519 IN EFI_HANDLE ControllerHandle
,
1520 IN EFI_HANDLE DriverBindingHandle
,
1521 IN EFI_GUID
*ProtocolGuid
1525 VOID
*ManagedInterface
;
1526 EFI_HANDLE NicControllerHandle
;
1528 ASSERT (ProtocolGuid
!= NULL
);
1530 NicControllerHandle
= NetLibGetNicHandle (ControllerHandle
, ProtocolGuid
);
1531 if (NicControllerHandle
== NULL
) {
1532 return EFI_UNSUPPORTED
;
1535 Status
= gBS
->OpenProtocol (
1537 (EFI_GUID
*) ProtocolGuid
,
1539 DriverBindingHandle
,
1540 NicControllerHandle
,
1541 EFI_OPEN_PROTOCOL_BY_DRIVER
1543 if (!EFI_ERROR (Status
)) {
1544 gBS
->CloseProtocol (
1546 (EFI_GUID
*) ProtocolGuid
,
1547 DriverBindingHandle
,
1550 return EFI_UNSUPPORTED
;
1553 if (Status
!= EFI_ALREADY_STARTED
) {
1554 return EFI_UNSUPPORTED
;