IScsiDriver.c revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
@retval EFI_SUCCESS The RemainingDevicePath is supported or NULL. @retval EFI_UNSUPPORTED The device specified by ControllerHandle and RemainingDevicePath is not supported by the driver specified by This. Tests to see if this driver supports a given controller. If a child device is provided, it further tests to see if this driver supports creating a handle for the specified child device. This function checks to see if the driver specified by This supports the device specified by ControllerHandle. Drivers typically use the device path attached to ControllerHandle and/or the services from the bus I/O abstraction attached to ControllerHandle to determine if the driver supports ControllerHandle. This function may be called many times during platform initialization. In order to reduce boot times, the tests performed by this function must be very small and take as little time as possible to execute. This function must not change the state of any hardware devices, and this function must be aware that the device specified by ControllerHandle may already be managed by the same driver or a different driver. This function must match its calls to AllocatePages() with FreePages(), AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol(). Since ControllerHandle may have been previously started by the same driver, if a protocol is already in the opened state, then it must not be closed with CloseProtocol(). This is required to guarantee the state of ControllerHandle is not modified by this function. @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. @param[in] ControllerHandle The handle of the controller to test. This handle must support a protocol interface that supplies an I/O abstraction to the driver. @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This parameter is ignored by device drivers, and is optional for bus drivers. For bus drivers, if this parameter is not NULL, then the bus driver must determine if the bus controller specified by ControllerHandle and the child controller specified by RemainingDevicePath are both supported by this @retval EFI_SUCCESS The device specified by ControllerHandle and RemainingDevicePath is supported by the driver specified by This. @retval EFI_ALREADY_STARTED The device specified by ControllerHandle and RemainingDevicePath is already being managed by the driver @retval EFI_ACCESS_DENIED The device specified by ControllerHandle and RemainingDevicePath is already being managed by a different driver or an application that requires exclusive access. Currently not implemented. @retval EFI_UNSUPPORTED The device specified by ControllerHandle and RemainingDevicePath is not supported by the driver specified by This. Start to manage the controller. This is the worker function for @param[in] Image Handle of the image. @param[in] ControllerHandle Handle of the controller. @param[in] IpVersion Ip4 or Ip6 @retval EFI_SUCCES This driver supports this device. @retval EFI_ALREADY_STARTED This driver is already running on this device. @retval EFI_INVALID_PARAMETER Any input parameter is invalid. @retval EFI_NOT_FOUND There is no sufficient information to establish @retval EFI_DEVICE_ERROR Failed to get TCP connection device path. // Test to see if iSCSI driver supports the given controller. // Record the incoming NIC info. // Create the instance private data. // Create a underlayer child instance, but not need to configure it. Just open ChildHandle // via BY_DRIVER. That is, establishing the relationship between ControllerHandle and ChildHandle. // Therefore, when DisconnectController(), especially VLAN virtual controller handle, // IScsiDriverBindingStop() will be called. // Always install private protocol no matter what happens later. We need to // keep the relationship between ControllerHandle and ChildHandle. // Get the current iSCSI configuration data. // If there is already a successul attempt, check whether this attempt is the // first "enabled for MPIO" attempt. If not, still try the first attempt. // In single path mode, try all attempts. // Uninstall the original ExtScsiPassThru first. // Locate all ExtScsiPassThru protocol instances. // Find ExtScsiPassThru protocol instance produced by this driver. // Get the ExtScsiPassThru protocol instance. // Install the Ext SCSI PASS THRU protocol. // Don't process the attempt that does not associate with the current NIC or // this attempt is disabled or established. // In multipath mode, don't process attempts configured for single path. // In default single path mode, don't process attempts configured for multipath. // Don't process the attempt that fails to get the init/target information from DHCP. // Don't process the autoconfigure path if it is already established. // Don't process the attempt if its IP mode is not in the current IP version. // Fill in the Session and init it. // Try to login and create an iSCSI session according to the configuration. // The specified target is not available, and the redirection information is // received. Login the session again with the updated target address. // In Single path mode, only the successful attempt will be recorded in iBFT; // in multi-path mode, all the attempt entries in MPIO will be recorded in iBFT. // Do not record the attempt in iBFT if it login with KRB5. // TODO: record KRB5 attempt information in the iSCSI device path. // IScsi session success. Update the attempt state to NVR. // Select the first login session. Abort others. // Don't validate other attempt in multipath mode if one is success. // All attempts configured for this driver instance are not valid. // Reinstall the original ExtScsiPassThru back. // More than one attempt successes. // Use the attempt in earlier order. Abort the later one in MPIO. // Reinstall the original ExtScsiPassThru back. // Clear the resource in ExistPrivate. // Use the attempt in earlier order as boot selected in single path mode. // Duplicate the Session's tcp connection device path. The source port field // will be set to zero as one iSCSI session is comprised of several iSCSI // Install the updated device path onto the ExtScsiPassThruHandle. Starts a device controller or a bus controller. The Start() function is designed to be invoked from the EFI boot service ConnectController(). As a result, much of the error checking on the parameters to Start() has been moved into this common boot service. It is legal to call Start() from other locations, but the following calling restrictions must be followed or the system behavior will not be deterministic. 1. ControllerHandle must be a valid EFI_HANDLE. 2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned EFI_DEVICE_PATH_PROTOCOL. 3. Prior to calling Start(), the Supported() function for the driver specified by This must have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS. @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. @param[in] ControllerHandle The handle of the controller to start. This handle must support a protocol interface that supplies an I/O abstraction to the driver. @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This parameter is ignored by device drivers, and is optional for bus drivers. For a bus driver, if this parameter is NULL, then handles for all the children of Controller are created by this driver. If this parameter is not NULL and the first Device Path Node is not the End of Device Path Node, then only the handle for the child device specified by the first Device Path Node of RemainingDevicePath is created by this driver. If the first Device Path Node of RemainingDevicePath is the End of Device Path Node, no child handle is created by this @retval EFI_SUCCESS The device was started. @retval EFI_DEVICE_ERROR The device could not be started due to a device error.Currently not implemented. @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. @retval Others The driver failed to start the device. Stops a device controller or a bus controller. The Stop() function is designed to be invoked from the EFI boot service DisconnectController(). As a result, much of the error checking on the parameters to Stop() has been moved into this common boot service. It is legal to call Stop() from other locations, but the following calling restrictions must be followed or the system behavior will not be deterministic. 1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this same driver's Start() function. 2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid EFI_HANDLE. In addition, all of these handles must have been created in this driver's Start() function, and the Start() function must have called OpenProtocol() on ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER. @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. @param[in] ControllerHandle A handle to the device being stopped. The handle must support a bus specific I/O protocol for the driver to use to stop the device. @param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer. @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL if NumberOfChildren is 0. @retval EFI_SUCCESS The device was stopped. @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error. // We should have only one child. // Previously the TCP protocol is opened BY_CHILD_CONTROLLER. Just close // the protocol here, but do not uninstall the device path protocol and // EXT SCSI PASS THRU protocol installed on ExtScsiPassThruHandle. // Get the handle of the controller we are controling. // Update the iSCSI Boot Firware Table. @param[in] ImageHandle The handle of the driver image. @retval EFI_SUCCESS The driver is unloaded. @retval EFI_DEVICE_ERROR An unexpected error occurred. // Try to disonnect the driver from the devices it's controlling. // Unload the iSCSI configuration form. // Uninstall the protocols installed by iSCSI driver. This is the declaration of an EFI image entry point. This entry point is the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including both device drivers and bus drivers. The entry point for iSCSI driver which initializes the global variables and installs the driver binding, component name protocol, iSCSI initiator name protocol and Authentication Info protocol on its image. @param[in] ImageHandle The firmware allocated handle for the UEFI image. @param[in] SystemTable A pointer to the EFI System Table. @retval EFI_SUCCESS The operation completed successfully. @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. // There should be only one EFI_ISCSI_INITIATOR_NAME_PROTOCOL. // Initialize the EFI Driver Library. // Install the iSCSI Initiator Name Protocol. // Create the private data structures. // Initialize the configuration form of iSCSI. // There should be only one EFI_AUTHENTICATION_INFO_PROTOCOL. If already exists, // do not produce the protocol instance.