/** @file\r
The header file of IScsiDriver.c.\r
\r
-Copyright (c) 2004 - 2017, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>\r
(C) Copyright 2017 Hewlett Packard Enterprise Development LP<BR>\r
\r
This program and the accompanying materials\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
language of the driver name that the caller is\r
requesting, and it must match one of the\r
languages specified in SupportedLanguages. The\r
- number of languages supported by a driver is \r
- determined by the driver writer. Language is \r
- specified inRFC 4646 or ISO 639-2 language code \r
+ number of languages supported by a driver is\r
+ determined by the driver writer. Language is\r
+ specified inRFC 4646 or ISO 639-2 language code\r
format.\r
- \r
+\r
@param[out] ControllerName A pointer to the Unicode string to return.\r
This Unicode string is the name of the\r
controller specified by ControllerHandle and\r
/**\r
Sends a SCSI Request Packet to a SCSI device that is attached to the SCSI channel.\r
This function supports both blocking I/O and nonblocking I/O. The blocking I/O\r
- functionality is required, and the nonblocking I/O functionality is optional. \r
+ functionality is required, and the nonblocking I/O functionality is optional.\r
\r
@param[in] This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.\r
@param[in] Target The Target is an array of size TARGET_MAX_BYTES and it\r
represents the id of the SCSI device to send the SCSI\r
Request Packet. Each transport driver may choose to\r
utilize a subset of this size to suit the needs\r
- of transport target representation. For example, a \r
+ of transport target representation. For example, a\r
Fibre Channel driver may use only 8 bytes (WWN)\r
to represent an FC target.\r
@param[in] Lun The LUN of the SCSI device to send the SCSI Request Packet.\r
@param[in, out] Packet A pointer to the SCSI Request Packet to send to the\r
- SCSI device specified by Target and Lun. \r
+ SCSI device specified by Target and Lun.\r
@param[in] Event If nonblocking I/O is not supported then Event is ignored,\r
and blocking I/O is performed. If Event is NULL, then\r
blocking I/O is performed. If Event is not NULL and non\r
completes.\r
\r
@retval EFI_SUCCESS The SCSI Request Packet was sent by the host. For\r
- bi-directional commands, InTransferLength bytes \r
+ bi-directional commands, InTransferLength bytes\r
were transferred from InDataBuffer.\r
For write and bi-directional commands, OutTransferLength\r
bytes were transferred by OutDataBuffer.\r
there are too many SCSI Request Packets already\r
queued. The caller may retry later.\r
@retval EFI_DEVICE_ERROR A device error occurred while attempting to send\r
- the SCSI Request Packet. \r
+ the SCSI Request Packet.\r
@retval EFI_INVALID_PARAMETER Target, Lun, or the contents of ScsiRequestPacket\r
are invalid.\r
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet\r
Used to retrieve the list of legal Target IDs and LUNs for SCSI devices on\r
a SCSI channel. These can either be the list SCSI devices that are actually\r
present on the SCSI channel, or the list of legal Target Ids and LUNs for the\r
- SCSI channel. Regardless, the caller of this function must probe the Target ID \r
- and LUN returned to see if a SCSI device is actually present at that location \r
- on the SCSI channel. \r
+ SCSI channel. Regardless, the caller of this function must probe the Target ID\r
+ and LUN returned to see if a SCSI device is actually present at that location\r
+ on the SCSI channel.\r
\r
@param[in] This The EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.\r
@param[in, out] Target On input, a pointer to the Target ID of a SCSI\r
);\r
\r
/**\r
- Retrieve the list of legal Target IDs for SCSI devices on a SCSI channel. \r
+ Retrieve the list of legal Target IDs for SCSI devices on a SCSI channel.\r
\r
@param[in] This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL\r
instance.\r
next SCSI device present on a SCSI channel.\r
An input value of 0xF(all bytes in the array are 0xF)\r
in the Target array retrieves the Target ID of the\r
- first SCSI device present on a SCSI channel. \r
+ first SCSI device present on a SCSI channel.\r
\r
@retval EFI_SUCCESS The Target ID of the next SCSI device on the SCSI\r
channel was returned in Target.\r
projects / mirror_edk2.git / blobdiff