/** @file\r
The entry point of IScsi driver.\r
\r
-Copyright (c) 2004 - 2014, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
+Copyright (c) 2019, NVIDIA Corporation. All rights reserved.\r
+Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>\r
+(C) Copyright 2017 Hewlett Packard Enterprise Development LP<BR>\r
\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
ISCSI_PRIVATE_DATA *mPrivate = NULL;\r
\r
/**\r
- Tests to see if this driver supports the RemainingDevicePath. \r
-\r
- @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This \r
- parameter is ignored by device drivers, and is optional for bus \r
- drivers. For bus drivers, if this parameter is not NULL, then \r
- the bus driver must determine if the bus controller specified \r
- by ControllerHandle and the child controller specified \r
- by RemainingDevicePath are both supported by this \r
+ Tests to see if this driver supports the RemainingDevicePath.\r
+\r
+ @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This\r
+ parameter is ignored by device drivers, and is optional for bus\r
+ drivers. For bus drivers, if this parameter is not NULL, then\r
+ the bus driver must determine if the bus controller specified\r
+ by ControllerHandle and the child controller specified\r
+ by RemainingDevicePath are both supported by this\r
bus driver.\r
\r
@retval EFI_SUCCESS The RemainingDevicePath is supported or NULL.\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Check whether an iSCSI HBA adapter already installs an AIP instance with\r
+ network boot policy matching the value specified in PcdIScsiAIPNetworkBootPolicy.\r
+ If yes, return EFI_SUCCESS.\r
+\r
+ @retval EFI_SUCCESS Found an AIP with matching network boot policy.\r
+ @retval EFI_NOT_FOUND AIP is unavailable or the network boot policy\r
+ not matched.\r
+**/\r
+EFI_STATUS\r
+IScsiCheckAip (\r
+ VOID\r
+ )\r
+{\r
+ UINTN AipHandleCount;\r
+ EFI_HANDLE *AipHandleBuffer;\r
+ UINTN AipIndex;\r
+ EFI_ADAPTER_INFORMATION_PROTOCOL *Aip;\r
+ EFI_EXT_SCSI_PASS_THRU_PROTOCOL *ExtScsiPassThru;\r
+ EFI_GUID *InfoTypesBuffer;\r
+ UINTN InfoTypeBufferCount;\r
+ UINTN TypeIndex;\r
+ VOID *InfoBlock;\r
+ UINTN InfoBlockSize;\r
+ BOOLEAN Supported;\r
+ EFI_ADAPTER_INFO_NETWORK_BOOT *NetworkBoot;\r
+ EFI_STATUS Status;\r
+ UINT8 NetworkBootPolicy;\r
+\r
+ //\r
+ // Check any AIP instances exist in system.\r
+ //\r
+ AipHandleCount = 0;\r
+ AipHandleBuffer = NULL;\r
+ Status = gBS->LocateHandleBuffer (\r
+ ByProtocol,\r
+ &gEfiAdapterInformationProtocolGuid,\r
+ NULL,\r
+ &AipHandleCount,\r
+ &AipHandleBuffer\r
+ );\r
+ if (EFI_ERROR (Status) || AipHandleCount == 0) {\r
+ return EFI_NOT_FOUND;\r
+ }\r
+\r
+ ASSERT (AipHandleBuffer != NULL);\r
+\r
+ InfoBlock = NULL;\r
+\r
+ for (AipIndex = 0; AipIndex < AipHandleCount; AipIndex++) {\r
+ Status = gBS->HandleProtocol (\r
+ AipHandleBuffer[AipIndex],\r
+ &gEfiAdapterInformationProtocolGuid,\r
+ (VOID *) &Aip\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+ ASSERT (Aip != NULL);\r
+\r
+ Status = gBS->HandleProtocol (\r
+ AipHandleBuffer[AipIndex],\r
+ &gEfiExtScsiPassThruProtocolGuid,\r
+ (VOID *) &ExtScsiPassThru\r
+ );\r
+ if (EFI_ERROR (Status) || ExtScsiPassThru == NULL) {\r
+ continue;\r
+ }\r
+\r
+ InfoTypesBuffer = NULL;\r
+ InfoTypeBufferCount = 0;\r
+ Status = Aip->GetSupportedTypes (Aip, &InfoTypesBuffer, &InfoTypeBufferCount);\r
+ if (EFI_ERROR (Status) || InfoTypesBuffer == NULL) {\r
+ continue;\r
+ }\r
+ //\r
+ // Check whether the AIP instance has Network boot information block.\r
+ //\r
+ Supported = FALSE;\r
+ for (TypeIndex = 0; TypeIndex < InfoTypeBufferCount; TypeIndex++) {\r
+ if (CompareGuid (&InfoTypesBuffer[TypeIndex], &gEfiAdapterInfoNetworkBootGuid)) {\r
+ Supported = TRUE;\r
+ break;\r
+ }\r
+ }\r
+\r
+ FreePool (InfoTypesBuffer);\r
+ if (!Supported) {\r
+ continue;\r
+ }\r
+\r
+ //\r
+ // We now have network boot information block.\r
+ //\r
+ InfoBlock = NULL;\r
+ InfoBlockSize = 0;\r
+ Status = Aip->GetInformation (Aip, &gEfiAdapterInfoNetworkBootGuid, &InfoBlock, &InfoBlockSize);\r
+ if (EFI_ERROR (Status) || InfoBlock == NULL) {\r
+ continue;\r
+ }\r
+\r
+ //\r
+ // Check whether the network boot policy matches.\r
+ //\r
+ NetworkBoot = (EFI_ADAPTER_INFO_NETWORK_BOOT *) InfoBlock;\r
+ NetworkBootPolicy = PcdGet8 (PcdIScsiAIPNetworkBootPolicy);\r
+\r
+ if (NetworkBootPolicy == STOP_UEFI_ISCSI_IF_HBA_INSTALL_AIP) {\r
+ Status = EFI_SUCCESS;\r
+ goto Exit;\r
+ }\r
+ if (((NetworkBootPolicy & STOP_UEFI_ISCSI_IF_AIP_SUPPORT_IP4) != 0 &&\r
+ !NetworkBoot->iScsiIpv4BootCapablity) ||\r
+ ((NetworkBootPolicy & STOP_UEFI_ISCSI_IF_AIP_SUPPORT_IP6) != 0 &&\r
+ !NetworkBoot->iScsiIpv6BootCapablity) ||\r
+ ((NetworkBootPolicy & STOP_UEFI_ISCSI_IF_AIP_SUPPORT_OFFLOAD) != 0 &&\r
+ !NetworkBoot->OffloadCapability) ||\r
+ ((NetworkBootPolicy & STOP_UEFI_ISCSI_IF_AIP_SUPPORT_MPIO) != 0 &&\r
+ !NetworkBoot->iScsiMpioCapability) ||\r
+ ((NetworkBootPolicy & STOP_UEFI_ISCSI_IF_AIP_CONFIGURED_IP4) != 0 &&\r
+ !NetworkBoot->iScsiIpv4Boot) ||\r
+ ((NetworkBootPolicy & STOP_UEFI_ISCSI_IF_AIP_CONFIGURED_IP6) != 0 &&\r
+ !NetworkBoot->iScsiIpv6Boot)) {\r
+ FreePool (InfoBlock);\r
+ continue;\r
+ }\r
+\r
+ Status = EFI_SUCCESS;\r
+ goto Exit;\r
+ }\r
+\r
+ Status = EFI_NOT_FOUND;\r
+\r
+Exit:\r
+ if (InfoBlock != NULL) {\r
+ FreePool (InfoBlock);\r
+ }\r
+ if (AipHandleBuffer != NULL) {\r
+ FreePool (AipHandleBuffer);\r
+ }\r
+ return Status;\r
+}\r
\r
/**\r
Tests to see if this driver supports a given controller. This is the worker function for\r
IScsiIp4(6)DriverBindingSupported.\r
\r
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
- @param[in] ControllerHandle The handle of the controller to test. This handle \r
- must support a protocol interface that supplies \r
+ @param[in] ControllerHandle The handle of the controller to test. This handle\r
+ must support a protocol interface that supplies\r
an I/O abstraction to the driver.\r
- @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This \r
- parameter is ignored by device drivers, and is optional for bus \r
- drivers. For bus drivers, if this parameter is not NULL, then \r
- the bus driver must determine if the bus controller specified \r
- by ControllerHandle and the child controller specified \r
- by RemainingDevicePath are both supported by this \r
+ @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This\r
+ parameter is ignored by device drivers, and is optional for bus\r
+ drivers. For bus drivers, if this parameter is not NULL, then\r
+ the bus driver must determine if the bus controller specified\r
+ by ControllerHandle and the child controller specified\r
+ by RemainingDevicePath are both supported by this\r
bus driver.\r
@param[in] IpVersion IP_VERSION_4 or IP_VERSION_6.\r
\r
EFI_GUID *IScsiServiceBindingGuid;\r
EFI_GUID *TcpServiceBindingGuid;\r
EFI_GUID *DhcpServiceBindingGuid;\r
+ EFI_GUID *DnsServiceBindingGuid;\r
\r
if (IpVersion == IP_VERSION_4) {\r
IScsiServiceBindingGuid = &gIScsiV4PrivateGuid;\r
TcpServiceBindingGuid = &gEfiTcp4ServiceBindingProtocolGuid;\r
DhcpServiceBindingGuid = &gEfiDhcp4ServiceBindingProtocolGuid;\r
+ DnsServiceBindingGuid = &gEfiDns4ServiceBindingProtocolGuid;\r
+\r
} else {\r
IScsiServiceBindingGuid = &gIScsiV6PrivateGuid;\r
TcpServiceBindingGuid = &gEfiTcp6ServiceBindingProtocolGuid;\r
DhcpServiceBindingGuid = &gEfiDhcp6ServiceBindingProtocolGuid;\r
+ DnsServiceBindingGuid = &gEfiDns6ServiceBindingProtocolGuid;\r
}\r
\r
Status = gBS->OpenProtocol (\r
return EFI_UNSUPPORTED;\r
}\r
}\r
- \r
+\r
+ if (IScsiDnsIsConfigured (ControllerHandle)) {\r
+ Status = gBS->OpenProtocol (\r
+ ControllerHandle,\r
+ DnsServiceBindingGuid,\r
+ NULL,\r
+ This->DriverBindingHandle,\r
+ ControllerHandle,\r
+ EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+ }\r
+\r
return EFI_SUCCESS;\r
}\r
\r
@retval EFI_INVALID_PARAMETER Any input parameter is invalid.\r
@retval EFI_NOT_FOUND There is no sufficient information to establish\r
the iScsi session.\r
- @retval EFI_DEVICE_ERROR Failed to get TCP connection device path. \r
+ @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
+ @retval EFI_DEVICE_ERROR Failed to get TCP connection device path.\r
+ @retval EFI_ACCESS_DENIED The protocol could not be removed from the Handle\r
+ because its interfaces are being used.\r
\r
**/\r
EFI_STATUS\r
EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
EFI_GUID *IScsiPrivateGuid;\r
EFI_GUID *TcpServiceBindingGuid;\r
- CHAR16 MacString[ISCSI_MAX_MAC_STRING_LEN];\r
BOOLEAN NeedUpdate;\r
VOID *Interface;\r
EFI_GUID *ProtocolGuid;\r
+ UINT8 NetworkBootPolicy;\r
+ ISCSI_SESSION_CONFIG_NVDATA *NvData;\r
\r
//\r
// Test to see if iSCSI driver supports the given controller.\r
return EFI_UNSUPPORTED;\r
}\r
\r
+ NetworkBootPolicy = PcdGet8 (PcdIScsiAIPNetworkBootPolicy);\r
+ if (NetworkBootPolicy == ALWAYS_USE_ISCSI_HBA_AND_IGNORE_UEFI_ISCSI) {\r
+ return EFI_ABORTED;\r
+ }\r
+\r
+ if (NetworkBootPolicy != ALWAYS_USE_UEFI_ISCSI_AND_IGNORE_ISCSI_HBA) {\r
+ //\r
+ // Check existing iSCSI AIP.\r
+ //\r
+ Status = IScsiCheckAip ();\r
+ if (!EFI_ERROR (Status)) {\r
+ //\r
+ // Find iSCSI AIP with specified network boot policy. return EFI_ABORTED.\r
+ //\r
+ return EFI_ABORTED;\r
+ }\r
+ }\r
+\r
//\r
// Record the incoming NIC info.\r
//\r
- Status = IScsiAddNic (ControllerHandle);\r
+ Status = IScsiAddNic (ControllerHandle, Image);\r
if (EFI_ERROR (Status)) {\r
return Status;\r
}\r
}\r
\r
Status = gBS->OpenProtocol (\r
- Private->ChildHandle,\r
+ Private->ChildHandle, /// Default Tcp child\r
ProtocolGuid,\r
&Interface,\r
Image,\r
ControllerHandle,\r
EFI_OPEN_PROTOCOL_BY_DRIVER\r
);\r
- \r
+\r
if (EFI_ERROR (Status)) {\r
goto ON_ERROR;\r
}\r
\r
//\r
- // Always install private protocol no matter what happens later. We need to \r
+ // Always install private protocol no matter what happens later. We need to\r
// keep the relationship between ControllerHandle and ChildHandle.\r
//\r
Status = gBS->InstallProtocolInterface (\r
if (EFI_ERROR (Status)) {\r
goto ON_ERROR;\r
}\r
- \r
+\r
if (IpVersion == IP_VERSION_4) {\r
mPrivate->Ipv6Flag = FALSE;\r
} else {\r
// Don't process the autoconfigure path if it is already established.\r
//\r
if (AttemptConfigData->SessionConfigData.IpMode == IP_MODE_AUTOCONFIG &&\r
- AttemptConfigData->AutoConfigureMode == IP_MODE_AUTOCONFIG_SUCCESS) {\r
+ AttemptConfigData->AutoConfigureSuccess) {\r
continue;\r
}\r
\r
Session->ConfigData = AttemptConfigData;\r
Session->AuthType = AttemptConfigData->AuthenticationType;\r
\r
- AsciiStrToUnicodeStr (AttemptConfigData->MacString, MacString);\r
UnicodeSPrint (\r
mPrivate->PortString,\r
(UINTN) ISCSI_NAME_IFR_MAX_SIZE,\r
- L"%s%d",\r
- MacString,\r
+ L"Attempt %d",\r
(UINTN) AttemptConfigData->AttemptConfigIndex\r
);\r
\r
Status = IScsiSessionReLogin (Session);\r
}\r
\r
+ //\r
+ // Restore the origial user setting which specifies the proxy/virtual iSCSI target to NV region.\r
+ //\r
+ NvData = &AttemptConfigData->SessionConfigData;\r
+ if (NvData->RedirectFlag) {\r
+ NvData->TargetPort = NvData->OriginalTargetPort;\r
+ CopyMem (&NvData->TargetIp, &NvData->OriginalTargetIp, sizeof (EFI_IP_ADDRESS));\r
+ NvData->RedirectFlag = FALSE;\r
+\r
+ gRT->SetVariable (\r
+ mPrivate->PortString,\r
+ &gEfiIScsiInitiatorNameProtocolGuid,\r
+ ISCSI_CONFIG_VAR_ATTR,\r
+ sizeof (ISCSI_ATTEMPT_CONFIG_NVDATA),\r
+ AttemptConfigData\r
+ );\r
+ }\r
+\r
if (EFI_ERROR (Status)) {\r
//\r
// In Single path mode, only the successful attempt will be recorded in iBFT;\r
// IScsi session success. Update the attempt state to NVR.\r
//\r
if (AttemptConfigData->SessionConfigData.IpMode == IP_MODE_AUTOCONFIG) {\r
- AttemptConfigData->AutoConfigureMode = IP_MODE_AUTOCONFIG_SUCCESS;\r
+ AttemptConfigData->AutoConfigureSuccess = TRUE;\r
}\r
\r
gRT->SetVariable (\r
&gIScsiConfigGuid,\r
&AttemptConfigOrderSize\r
);\r
- ASSERT (AttemptConfigOrder != NULL);\r
+ if (AttemptConfigOrder == NULL) {\r
+ goto ON_ERROR;\r
+ }\r
for (Index = 0; Index < AttemptConfigOrderSize / sizeof (UINT8); Index++) {\r
if (AttemptConfigOrder[Index] == mPrivate->BootSelectedIndex ||\r
AttemptConfigOrder[Index] == BootSelected) {\r
\r
goto ON_EXIT;\r
} else {\r
- ASSERT (AttemptConfigOrder[Index] == BootSelected);\r
+ if (AttemptConfigOrder[Index] != BootSelected) {\r
+ goto ON_ERROR;\r
+ }\r
mPrivate->BootSelectedIndex = BootSelected;\r
//\r
// Clear the resource in ExistPrivate.\r
ExistPrivate->Controller,\r
IScsiPrivateGuid,\r
&ExistPrivate->IScsiIdentifier\r
- ); \r
- \r
+ );\r
+\r
IScsiRemoveNic (ExistPrivate->Controller);\r
if (ExistPrivate->Session != NULL) {\r
IScsiSessionAbort (ExistPrivate->Session);\r
}\r
\r
- IScsiCleanDriverData (ExistPrivate);\r
+ if (ExistPrivate->DevicePath != NULL) {\r
+ Status = gBS->UninstallProtocolInterface (\r
+ ExistPrivate->ExtScsiPassThruHandle,\r
+ &gEfiDevicePathProtocolGuid,\r
+ ExistPrivate->DevicePath\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ goto ON_ERROR;\r
+ }\r
+\r
+ FreePool (ExistPrivate->DevicePath);\r
+ }\r
+\r
+ gBS->CloseEvent (ExistPrivate->ExitBootServiceEvent);\r
+ FreePool (ExistPrivate);\r
+\r
}\r
} else {\r
//\r
goto ON_ERROR;\r
}\r
\r
+ //\r
+ // ISCSI children should share the default Tcp child, just open the default Tcp child via BY_CHILD_CONTROLLER.\r
+ //\r
+ Status = gBS->OpenProtocol (\r
+ Private->ChildHandle, /// Default Tcp child\r
+ ProtocolGuid,\r
+ &Interface,\r
+ Image,\r
+ Private->ExtScsiPassThruHandle,\r
+ EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ gBS->UninstallMultipleProtocolInterfaces (\r
+ Private->ExtScsiPassThruHandle,\r
+ &gEfiExtScsiPassThruProtocolGuid,\r
+ &Private->IScsiExtScsiPassThru,\r
+ &gEfiDevicePathProtocolGuid,\r
+ Private->DevicePath,\r
+ NULL\r
+ );\r
+\r
+ goto ON_ERROR;\r
+ }\r
+\r
ON_EXIT:\r
\r
//\r
/**\r
Stops a device controller or a bus controller. This is the worker function for\r
IScsiIp4(6)DriverBindingStop.\r
- \r
+\r
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
- @param[in] ControllerHandle A handle to the device being stopped. The handle must \r
- support a bus specific I/O protocol for the driver \r
+ @param[in] ControllerHandle A handle to the device being stopped. The handle must\r
+ support a bus specific I/O protocol for the driver\r
to use to stop the device.\r
@param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer.\r
- @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL \r
+ @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL\r
if NumberOfChildren is 0.\r
@param[in] IpVersion IP_VERSION_4 or IP_VERSION_6.\r
- \r
+\r
@retval EFI_SUCCESS The device was stopped.\r
@retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.\r
+ @retval EFI_INVALID_PARAMETER Child handle is NULL.\r
+ @retval EFI_ACCESS_DENIED The protocol could not be removed from the Handle\r
+ because its interfaces are being used.\r
\r
**/\r
EFI_STATUS\r
ProtocolGuid = &gEfiTcp6ProtocolGuid;\r
}\r
\r
+ gBS->CloseProtocol (\r
+ Private->ChildHandle,\r
+ ProtocolGuid,\r
+ Private->Image,\r
+ Private->ExtScsiPassThruHandle\r
+ );\r
+\r
gBS->CloseProtocol (\r
Conn->TcpIo.Handle,\r
ProtocolGuid,\r
\r
return EFI_SUCCESS;\r
}\r
+\r
//\r
// Get the handle of the controller we are controling.\r
//\r
This->DriverBindingHandle,\r
IScsiController\r
);\r
- \r
+\r
ASSERT (!EFI_ERROR (Status));\r
\r
Status = NetLibDestroyServiceChild (\r
IScsiController,\r
ProtocolGuid,\r
&Private->IScsiIdentifier\r
- ); \r
+ );\r
\r
//\r
// Remove this NIC.\r
IScsiSessionAbort (Private->Session);\r
}\r
\r
- IScsiCleanDriverData (Private);\r
+ Status = IScsiCleanDriverData (Private);\r
+\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
\r
return EFI_SUCCESS;\r
}\r
\r
/**\r
- Tests to see if this driver supports a given controller. If a child device is provided, \r
+ Tests to see if this driver supports a given controller. If a child device is provided,\r
it tests to see if this driver supports creating a handle for the specified child device.\r
\r
- This function checks to see if the driver specified by This supports the device specified by \r
- ControllerHandle. Drivers typically use the device path attached to \r
- ControllerHandle and/or the services from the bus I/O abstraction attached to \r
- ControllerHandle to determine if the driver supports ControllerHandle. This function \r
- may be called many times during platform initialization. In order to reduce boot times, the tests \r
- performed by this function must be very small and take as little time as possible to execute. This \r
- function must not change the state of any hardware devices, and this function must be aware that the \r
- device specified by ControllerHandle may already be managed by the same driver or a \r
- different driver. This function must match its calls to AllocatePages() with FreePages(), \r
- AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol(). \r
- Since ControllerHandle may have been previously started by the same driver, if a protocol is \r
- already in the opened state, then it must not be closed with CloseProtocol(). This is required \r
+ This function checks to see if the driver specified by This supports the device specified by\r
+ ControllerHandle. Drivers typically use the device path attached to\r
+ ControllerHandle and/or the services from the bus I/O abstraction attached to\r
+ ControllerHandle to determine if the driver supports ControllerHandle. This function\r
+ may be called many times during platform initialization. In order to reduce boot times, the tests\r
+ performed by this function must be very small and take as little time as possible to execute. This\r
+ function must not change the state of any hardware devices, and this function must be aware that the\r
+ device specified by ControllerHandle may already be managed by the same driver or a\r
+ different driver. This function must match its calls to AllocatePages() with FreePages(),\r
+ AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol().\r
+ Since ControllerHandle may have been previously started by the same driver, if a protocol is\r
+ already in the opened state, then it must not be closed with CloseProtocol(). This is required\r
to guarantee the state of ControllerHandle is not modified by this function.\r
\r
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
- @param[in] ControllerHandle The handle of the controller to test. This handle \r
- must support a protocol interface that supplies \r
+ @param[in] ControllerHandle The handle of the controller to test. This handle\r
+ must support a protocol interface that supplies\r
an I/O abstraction to the driver.\r
- @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This \r
- parameter is ignored by device drivers, and is optional for bus \r
- drivers. For bus drivers, if this parameter is not NULL, then \r
- the bus driver must determine if the bus controller specified \r
- by ControllerHandle and the child controller specified \r
- by RemainingDevicePath are both supported by this \r
+ @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This\r
+ parameter is ignored by device drivers, and is optional for bus\r
+ drivers. For bus drivers, if this parameter is not NULL, then\r
+ the bus driver must determine if the bus controller specified\r
+ by ControllerHandle and the child controller specified\r
+ by RemainingDevicePath are both supported by this\r
bus driver.\r
\r
@retval EFI_SUCCESS The device specified by ControllerHandle and\r
Starts a device controller or a bus controller.\r
\r
The Start() function is designed to be invoked from the EFI boot service ConnectController().\r
- As a result, much of the error checking on the parameters to Start() has been moved into this \r
- common boot service. It is legal to call Start() from other locations, \r
+ As a result, much of the error checking on the parameters to Start() has been moved into this\r
+ common boot service. It is legal to call Start() from other locations,\r
but the following calling restrictions must be followed or the system behavior will not be deterministic.\r
1. ControllerHandle must be a valid EFI_HANDLE.\r
2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned\r
EFI_DEVICE_PATH_PROTOCOL.\r
3. Prior to calling Start(), the Supported() function for the driver specified by This must\r
- have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS. \r
+ have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.\r
\r
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
- @param[in] ControllerHandle The handle of the controller to start. This handle \r
- must support a protocol interface that supplies \r
+ @param[in] ControllerHandle The handle of the controller to start. This handle\r
+ must support a protocol interface that supplies\r
an I/O abstraction to the driver.\r
- @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This \r
- parameter is ignored by device drivers, and is optional for bus \r
- drivers. For a bus driver, if this parameter is NULL, then handles \r
- for all the children of Controller are created by this driver. \r
- If this parameter is not NULL and the first Device Path Node is \r
- not the End of Device Path Node, then only the handle for the \r
- child device specified by the first Device Path Node of \r
+ @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This\r
+ parameter is ignored by device drivers, and is optional for bus\r
+ drivers. For a bus driver, if this parameter is NULL, then handles\r
+ for all the children of Controller are created by this driver.\r
+ If this parameter is not NULL and the first Device Path Node is\r
+ not the End of Device Path Node, then only the handle for the\r
+ child device specified by the first Device Path Node of\r
RemainingDevicePath is created by this driver.\r
- If the first Device Path Node of RemainingDevicePath is \r
+ If the first Device Path Node of RemainingDevicePath is\r
the End of Device Path Node, no child handle is created by this\r
driver.\r
\r
\r
/**\r
Stops a device controller or a bus controller.\r
- \r
- The Stop() function is designed to be invoked from the EFI boot service DisconnectController(). \r
- As a result, much of the error checking on the parameters to Stop() has been moved \r
- into this common boot service. It is legal to call Stop() from other locations, \r
+\r
+ The Stop() function is designed to be invoked from the EFI boot service DisconnectController().\r
+ As a result, much of the error checking on the parameters to Stop() has been moved\r
+ into this common boot service. It is legal to call Stop() from other locations,\r
but the following calling restrictions must be followed or the system behavior will not be deterministic.\r
1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this\r
same driver's Start() function.\r
EFI_HANDLE. In addition, all of these handles must have been created in this driver's\r
Start() function, and the Start() function must have called OpenProtocol() on\r
ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.\r
- \r
+\r
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
- @param[in] ControllerHandle A handle to the device being stopped. The handle must \r
- support a bus specific I/O protocol for the driver \r
+ @param[in] ControllerHandle A handle to the device being stopped. The handle must\r
+ support a bus specific I/O protocol for the driver\r
to use to stop the device.\r
@param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer.\r
- @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL \r
+ @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL\r
if NumberOfChildren is 0.\r
\r
@retval EFI_SUCCESS The device was stopped.\r
}\r
\r
/**\r
- Tests to see if this driver supports a given controller. If a child device is provided, \r
+ Tests to see if this driver supports a given controller. If a child device is provided,\r
it tests to see if this driver supports creating a handle for the specified child device.\r
\r
- This function checks to see if the driver specified by This supports the device specified by \r
- ControllerHandle. Drivers typically use the device path attached to \r
- ControllerHandle and/or the services from the bus I/O abstraction attached to \r
- ControllerHandle to determine if the driver supports ControllerHandle. This function \r
- may be called many times during platform initialization. In order to reduce boot times, the tests \r
- performed by this function must be very small and take as little time as possible to execute. This \r
- function must not change the state of any hardware devices, and this function must be aware that the \r
- device specified by ControllerHandle may already be managed by the same driver or a \r
- different driver. This function must match its calls to AllocatePages() with FreePages(), \r
- AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol(). \r
- Since ControllerHandle may have been previously started by the same driver, if a protocol is \r
- already in the opened state, then it must not be closed with CloseProtocol(). This is required \r
+ This function checks to see if the driver specified by This supports the device specified by\r
+ ControllerHandle. Drivers typically use the device path attached to\r
+ ControllerHandle and/or the services from the bus I/O abstraction attached to\r
+ ControllerHandle to determine if the driver supports ControllerHandle. This function\r
+ may be called many times during platform initialization. In order to reduce boot times, the tests\r
+ performed by this function must be very small and take as little time as possible to execute. This\r
+ function must not change the state of any hardware devices, and this function must be aware that the\r
+ device specified by ControllerHandle may already be managed by the same driver or a\r
+ different driver. This function must match its calls to AllocatePages() with FreePages(),\r
+ AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol().\r
+ Since ControllerHandle may have been previously started by the same driver, if a protocol is\r
+ already in the opened state, then it must not be closed with CloseProtocol(). This is required\r
to guarantee the state of ControllerHandle is not modified by this function.\r
\r
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
- @param[in] ControllerHandle The handle of the controller to test. This handle \r
- must support a protocol interface that supplies \r
+ @param[in] ControllerHandle The handle of the controller to test. This handle\r
+ must support a protocol interface that supplies\r
an I/O abstraction to the driver.\r
- @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This \r
- parameter is ignored by device drivers, and is optional for bus \r
- drivers. For bus drivers, if this parameter is not NULL, then \r
- the bus driver must determine if the bus controller specified \r
- by ControllerHandle and the child controller specified \r
- by RemainingDevicePath are both supported by this \r
+ @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This\r
+ parameter is ignored by device drivers, and is optional for bus\r
+ drivers. For bus drivers, if this parameter is not NULL, then\r
+ the bus driver must determine if the bus controller specified\r
+ by ControllerHandle and the child controller specified\r
+ by RemainingDevicePath are both supported by this\r
bus driver.\r
\r
@retval EFI_SUCCESS The device specified by ControllerHandle and\r
Starts a device controller or a bus controller.\r
\r
The Start() function is designed to be invoked from the EFI boot service ConnectController().\r
- As a result, much of the error checking on the parameters to Start() has been moved into this \r
- common boot service. It is legal to call Start() from other locations, \r
+ As a result, much of the error checking on the parameters to Start() has been moved into this\r
+ common boot service. It is legal to call Start() from other locations,\r
but the following calling restrictions must be followed or the system behavior will not be deterministic.\r
1. ControllerHandle must be a valid EFI_HANDLE.\r
2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned\r
EFI_DEVICE_PATH_PROTOCOL.\r
3. Prior to calling Start(), the Supported() function for the driver specified by This must\r
- have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS. \r
+ have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.\r
\r
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
- @param[in] ControllerHandle The handle of the controller to start. This handle \r
- must support a protocol interface that supplies \r
+ @param[in] ControllerHandle The handle of the controller to start. This handle\r
+ must support a protocol interface that supplies\r
an I/O abstraction to the driver.\r
- @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This \r
- parameter is ignored by device drivers, and is optional for bus \r
- drivers. For a bus driver, if this parameter is NULL, then handles \r
- for all the children of Controller are created by this driver. \r
- If this parameter is not NULL and the first Device Path Node is \r
- not the End of Device Path Node, then only the handle for the \r
- child device specified by the first Device Path Node of \r
+ @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This\r
+ parameter is ignored by device drivers, and is optional for bus\r
+ drivers. For a bus driver, if this parameter is NULL, then handles\r
+ for all the children of Controller are created by this driver.\r
+ If this parameter is not NULL and the first Device Path Node is\r
+ not the End of Device Path Node, then only the handle for the\r
+ child device specified by the first Device Path Node of\r
RemainingDevicePath is created by this driver.\r
- If the first Device Path Node of RemainingDevicePath is \r
+ If the first Device Path Node of RemainingDevicePath is\r
the End of Device Path Node, no child handle is created by this\r
driver.\r
\r
\r
/**\r
Stops a device controller or a bus controller.\r
- \r
- The Stop() function is designed to be invoked from the EFI boot service DisconnectController(). \r
- As a result, much of the error checking on the parameters to Stop() has been moved \r
- into this common boot service. It is legal to call Stop() from other locations, \r
+\r
+ The Stop() function is designed to be invoked from the EFI boot service DisconnectController().\r
+ As a result, much of the error checking on the parameters to Stop() has been moved\r
+ into this common boot service. It is legal to call Stop() from other locations,\r
but the following calling restrictions must be followed or the system behavior will not be deterministic.\r
1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this\r
same driver's Start() function.\r
EFI_HANDLE. In addition, all of these handles must have been created in this driver's\r
Start() function, and the Start() function must have called OpenProtocol() on\r
ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.\r
- \r
+\r
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
- @param[in] ControllerHandle A handle to the device being stopped. The handle must \r
- support a bus specific I/O protocol for the driver \r
+ @param[in] ControllerHandle A handle to the device being stopped. The handle must\r
+ support a bus specific I/O protocol for the driver\r
to use to stop the device.\r
@param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer.\r
- @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL \r
+ @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL\r
if NumberOfChildren is 0.\r
\r
@retval EFI_SUCCESS The device was stopped.\r
if (EFI_ERROR (Status)) {\r
goto ON_EXIT;\r
}\r
- \r
+\r
//\r
// Uninstall the protocols installed by iSCSI driver.\r
//\r
if (EFI_ERROR (Status)) {\r
goto ON_EXIT;\r
}\r
- \r
+\r
if (gIScsiControllerNameTable!= NULL) {\r
Status = FreeUnicodeStringTable (gIScsiControllerNameTable);\r
if (EFI_ERROR (Status)) {\r
goto ON_EXIT;\r
}\r
}\r
- \r
+\r
Status = gBS->HandleProtocol (\r
gIScsiIp4DriverBinding.DriverBindingHandle,\r
&gEfiComponentName2ProtocolGuid,\r
goto ON_EXIT;\r
}\r
}\r
- \r
+\r
Status = gBS->HandleProtocol (\r
gIScsiIp6DriverBinding.DriverBindingHandle,\r
&gEfiComponentName2ProtocolGuid,\r
if (DeviceHandleBuffer != NULL) {\r
FreePool (DeviceHandleBuffer);\r
}\r
- \r
+\r
return Status;\r
}\r
\r
This is the declaration of an EFI image entry point. This entry point is\r
the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including\r
both device drivers and bus drivers.\r
- \r
+\r
The entry point for iSCSI driver which initializes the global variables and\r
installs the driver binding, component name protocol, iSCSI initiator name\r
protocol and Authentication Info protocol on its image.\r
- \r
+\r
@param[in] ImageHandle The firmware allocated handle for the UEFI image.\r
@param[in] SystemTable A pointer to the EFI System Table.\r
\r
if (EFI_ERROR (Status)) {\r
goto Error1;\r
}\r
- \r
+\r
//\r
// Install the iSCSI Initiator Name Protocol.\r
//\r
);\r
if (EFI_ERROR (Status)) {\r
goto Error2;\r
- } \r
+ }\r
\r
//\r
// Create the private data structures.\r
goto Error4;\r
}\r
\r
+ //\r
+ // Create the Maximum Attempts.\r
+ //\r
+ Status = IScsiCreateAttempts (PcdGet8 (PcdMaxIScsiAttemptNumber));\r
+ if (EFI_ERROR (Status)) {\r
+ goto Error5;\r
+ }\r
+\r
+ //\r
+ // Create Keywords for all the Attempts.\r
+ //\r
+ Status = IScsiCreateKeywords (PcdGet8 (PcdMaxIScsiAttemptNumber));\r
+ if (EFI_ERROR (Status)) {\r
+ goto Error6;\r
+ }\r
+\r
//\r
// There should be only one EFI_AUTHENTICATION_INFO_PROTOCOL. If already exists,\r
// do not produce the protocol instance.\r
&gIScsiAuthenticationInfo\r
);\r
if (EFI_ERROR (Status)) {\r
- goto Error5;\r
- } \r
+ goto Error6;\r
+ }\r
}\r
\r
return EFI_SUCCESS;\r
\r
+Error6:\r
+ IScsiCleanAttemptVariable ();\r
+\r
Error5:\r
IScsiConfigFormUnload (gIScsiIp4DriverBinding.DriverBindingHandle);\r
\r
Error4:\r
- FreePool (mPrivate);\r
+ if (mPrivate != NULL) {\r
+ FreePool (mPrivate);\r
+ mPrivate = NULL;\r
+ }\r
\r
Error3:\r
gBS->UninstallMultipleProtocolInterfaces (\r
);\r
\r
Error2:\r
- gBS->UninstallMultipleProtocolInterfaces (\r
- gIScsiIp6DriverBinding.DriverBindingHandle,\r
- &gEfiDriverBindingProtocolGuid,\r
- &gIScsiIp6DriverBinding,\r
- &gEfiComponentName2ProtocolGuid,\r
- &gIScsiComponentName2,\r
- &gEfiComponentNameProtocolGuid,\r
- &gIScsiComponentName,\r
- NULL\r
- );\r
+ EfiLibUninstallDriverBindingComponentName2 (\r
+ &gIScsiIp6DriverBinding,\r
+ &gIScsiComponentName,\r
+ &gIScsiComponentName2\r
+ );\r
\r
Error1:\r
- gBS->UninstallMultipleProtocolInterfaces (\r
- ImageHandle,\r
- &gEfiDriverBindingProtocolGuid,\r
- &gIScsiIp4DriverBinding,\r
- &gEfiComponentName2ProtocolGuid,\r
- &gIScsiComponentName2,\r
- &gEfiComponentNameProtocolGuid,\r
- &gIScsiComponentName,\r
- NULL\r
- );\r
+ EfiLibUninstallDriverBindingComponentName2 (\r
+ &gIScsiIp4DriverBinding,\r
+ &gIScsiComponentName,\r
+ &gIScsiComponentName2\r
+ );\r
\r
return Status;\r
}\r
projects / mirror_edk2.git / blobdiff