/** @file\r
The header file for ISA bus driver\r
- \r
-Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>\r
+\r
+Copyright (c) 2006 - 2018, 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
// EFI Driver Binding Protocol Interface Functions\r
//\r
\r
-/** \r
- Tests to see if a controller can be managed by the ISA Bus Driver. If a child device is provided, \r
+/**\r
+ Tests to see if a controller can be managed by the ISA Bus Driver. 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
Note that the ISA Bus driver always creates all of its child handles on the first call to Start().\r
How the Start() function of a driver is implemented can affect how the Supported() function is implemented.\r
\r
- @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. \r
+ @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
@param[in] Controller The handle of the controller to test.\r
@param[in] RemainingDevicePath A pointer to the remaining portion of a device path.\r
- \r
+\r
@retval EFI_SUCCESS The device is supported by this driver.\r
@retval EFI_ALREADY_STARTED The device is already being managed by this driver.\r
- @retval EFI_ACCESS_DENIED The device is already being managed by a different driver \r
+ @retval EFI_ACCESS_DENIED The device is already being managed by a different driver\r
or an application that requires exclusive access.\r
@retval EFI_UNSUPPORTED The device is is not supported by this driver.\r
\r
);\r
\r
/**\r
- Start this driver on ControllerHandle. \r
- \r
+ Start this driver on ControllerHandle.\r
+\r
Note that the ISA Bus driver always creates all of its child handles on the first call to Start().\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, but the following calling \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, but the following calling\r
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
+ @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
@retval EFI_SUCCESS The device was started.\r
);\r
\r
/**\r
- Stop this driver on ControllerHandle. \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
+ Stop this driver on ControllerHandle.\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
- Create EFI Handle for a ISA device found via ISA ACPI Protocol \r
+ Create EFI Handle for a ISA device found via ISA ACPI Protocol\r
\r
@param[in] This The EFI_DRIVER_BINDING_PROTOCOL instance.\r
@param[in] Controller The handle of ISA bus controller(PCI to ISA bridge)\r
- @param[in] PciIo The Pointer to the PCI protocol \r
+ @param[in] PciIo The Pointer to the PCI protocol\r
@param[in] ParentDevicePath Device path of the ISA bus controller\r
@param[in] IsaDeviceResourceList The resource list of the ISA device\r
@param[out] ChildDevicePath The pointer to the child device.\r
\r
@param[in] IsaIoDevice The iso device to be initialized.\r
@param[in] IsaDeviceResourceList The resource list.\r
- \r
+\r
**/\r
VOID\r
InitializeIsaIoInstance (\r
projects / mirror_edk2.git / blobdiff