/** @file\r
UEFI DriverBinding Protocol is defined in UEFI specification.\r
- \r
- This protocol is produced by every driver that follows the UEFI Driver Model, \r
+\r
+ This protocol is produced by every driver that follows the UEFI Driver Model,\r
and it is the central component that allows drivers and controllers to be managed.\r
\r
- Copyright (c) 2006 - 2009, Intel Corporation \r
- All rights reserved. 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) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
+The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php.\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
+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
\r
**/\r
\r
#define __EFI_DRIVER_BINDING_H__\r
\r
///\r
-/// Global ID for the ControllerHandle Driver Protocol\r
+/// The global ID for the ControllerHandle Driver Protocol.\r
///\r
#define EFI_DRIVER_BINDING_PROTOCOL_GUID \\r
{ \\r
typedef struct _EFI_DRIVER_BINDING_PROTOCOL EFI_DRIVER_BINDING_PROTOCOL;\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 further 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 will 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
+ Because 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. \r
- This parameter is ignored by device drivers, and is optional for bus drivers.\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 device specified by ControllerHandle and\r
RemainingDevicePath is supported by the driver specified by This.\r
specified by This.\r
@retval EFI_ACCESS_DENIED The device specified by ControllerHandle and\r
RemainingDevicePath is already being managed by a different\r
- driver or an application that requires exclusive acces.\r
+ driver or an application that requires exclusive access.\r
Currently not implemented.\r
@retval EFI_UNSUPPORTED The device specified by ControllerHandle and\r
RemainingDevicePath is not supported by the driver specified by This.\r
);\r
\r
/**\r
- Start this driver on ControllerHandle. The Start() function is designed to be \r
- invoked from the EFI boot service ConnectController(). As a result, much of \r
- 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
+ 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
+ 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. \r
- This parameter is ignored by device drivers, and is optional for bus drivers.\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
+ the End of Device Path Node, no child handle is created by this\r
+ driver.\r
\r
@retval EFI_SUCCESS The device was started.\r
@retval EFI_DEVICE_ERROR The device could not be started due to a device error.Currently not implemented.\r
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r
@retval Others The driver failded to start the device.\r
+\r
**/\r
typedef\r
EFI_STATUS\r
);\r
\r
/**\r
- Stop this driver on ControllerHandle. \r
- \r
- Release the control of this controller and remove the IScsi functions. The Stop()\r
- 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
+ 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
+ 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
2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid\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.Not used.\r
- @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL \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
if NumberOfChildren is 0.\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
+\r
**/\r
typedef\r
EFI_STATUS\r
);\r
\r
///\r
-/// This protocol provides the services required to determine if a driver supports a given controller. \r
+/// This protocol provides the services required to determine if a driver supports a given controller.\r
/// If a controller is supported, then it also provides routines to start and stop the controller.\r
///\r
struct _EFI_DRIVER_BINDING_PROTOCOL {\r
EFI_DRIVER_BINDING_SUPPORTED Supported;\r
EFI_DRIVER_BINDING_START Start;\r
EFI_DRIVER_BINDING_STOP Stop;\r
- \r
+\r
///\r
/// The version number of the UEFI driver that produced the\r
/// EFI_DRIVER_BINDING_PROTOCOL. This field is used by\r
/// 0xffffffef are reserved for IHV-developed drivers.\r
///\r
UINT32 Version;\r
- \r
+\r
///\r
/// The image handle of the UEFI driver that produced this instance\r
/// of the EFI_DRIVER_BINDING_PROTOCOL.\r
///\r
EFI_HANDLE ImageHandle;\r
- \r
+\r
///\r
/// The handle on which this instance of the\r
/// EFI_DRIVER_BINDING_PROTOCOL is installed. In most\r
/// cases, this is the same handle as ImageHandle. However, for\r
/// UEFI drivers that produce more than one instance of the\r
/// EFI_DRIVER_BINDING_PROTOCOL, this value may not be\r
- /// the same as ImageHandle. \r
+ /// the same as ImageHandle.\r
///\r
EFI_HANDLE DriverBindingHandle;\r
};\r
projects / mirror_edk2.git / blobdiff