/** @file
Library functions that abstract driver model protocols
installation.
Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are
licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "UefiLibInternal.h"
/**
Installs and completes the initialization of a Driver Binding Protocol instance.
Installs the Driver Binding Protocol specified by DriverBinding onto the handle
specified by DriverBindingHandle. If DriverBindingHandle is NULL, then DriverBinding
is installed onto a newly created handle. DriverBindingHandle is typically the same
as the driver's ImageHandle, but it can be different if the driver produces multiple
Driver Binding Protocols.
If DriverBinding is NULL, then ASSERT().
If DriverBinding can not be installed onto a handle, then ASSERT().
@param ImageHandle The image handle of the driver.
@param SystemTable The EFI System Table that was passed to the driver's entry point.
@param DriverBinding A Driver Binding Protocol instance that this driver is producing.
@param DriverBindingHandle The handle that DriverBinding is to be installed onto. If this
parameter is NULL, then a new handle is created.
@retval EFI_SUCCESS The protocol installation successfully completed.
@retval EFI_OUT_OF_RESOURCES There was not enough system resources to install the protocol.
@retval Others Status from gBS->InstallMultipleProtocolInterfaces().
**/
)
{
);
//
// ASSERT if the call to InstallMultipleProtocolInterfaces() failed
//
//
// Update the ImageHandle and DriverBindingHandle fields of the Driver Binding Protocol
//
return Status;
}
/**
Installs and completes the initialization of a Driver Binding Protocol instance and
optionally installs the Component Name, Driver Configuration and Driver Diagnostics Protocols.
Initializes a driver by installing the Driver Binding Protocol together with the
optional Component Name, optional Driver Configure and optional Driver Diagnostic
Protocols onto the driver's DriverBindingHandle. If DriverBindingHandle is NULL,
then the protocols are installed onto a newly created handle. DriverBindingHandle
is typically the same as the driver's ImageHandle, but it can be different if the
driver produces multiple Driver Binding Protocols.
If DriverBinding is NULL, then ASSERT().
If the installation fails, then ASSERT().
@param ImageHandle The image handle of the driver.
@param SystemTable The EFI System Table that was passed to the driver's entry point.
@param DriverBinding A Driver Binding Protocol instance that this driver is producing.
@param DriverBindingHandle The handle that DriverBinding is to be installed onto. If this
parameter is NULL, then a new handle is created.
@param ComponentName A Component Name Protocol instance that this driver is producing.
@param DriverConfiguration A Driver Configuration Protocol instance that this driver is producing.
@param DriverDiagnostics A Driver Diagnostics Protocol instance that this driver is producing.
@retval EFI_SUCCESS The protocol installation successfully completed.
@retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.
**/
)
{
if (DriverConfiguration == NULL) {
);
} else {
);
}
} else {
);
} else {
);
}
}
} else {
if (DriverConfiguration == NULL) {
);
} else {
);
}
} else {
);
} else {
);
}
}
}
//
// ASSERT if the call to InstallMultipleProtocolInterfaces() failed
//
//
// Update the ImageHandle and DriverBindingHandle fields of the Driver Binding Protocol
//
return Status;
}
/**
Installs Driver Binding Protocol with optional Component Name and Component Name 2 Protocols.
Initializes a driver by installing the Driver Binding Protocol together with the
optional Component Name and optional Component Name 2 protocols onto the driver's
DriverBindingHandle. If DriverBindingHandle is NULL, then the protocols are installed
onto a newly created handle. DriverBindingHandle is typically the same as the driver's
ImageHandle, but it can be different if the driver produces multiple Driver Binding Protocols.
If DriverBinding is NULL, then ASSERT().
If the installation fails, then ASSERT().
@param ImageHandle The image handle of the driver.
@param SystemTable The EFI System Table that was passed to the driver's entry point.
@param DriverBinding A Driver Binding Protocol instance that this driver is producing.
@param DriverBindingHandle The handle that DriverBinding is to be installed onto. If this
parameter is NULL, then a new handle is created.
@param ComponentName A Component Name Protocol instance that this driver is producing.
@param ComponentName2 A Component Name 2 Protocol instance that this driver is producing.
@retval EFI_SUCCESS The protocol installation successfully completed.
@retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.
**/
)
{
);
} else {
);
}
} else {
);
} else {
);
}
}
//
// ASSERT if the call to InstallMultipleProtocolInterfaces() failed
//
//
// Update the ImageHandle and DriverBindingHandle fields of the Driver Binding Protocol
//
return Status;
}
/**
Installs Driver Binding Protocol with optional Component Name, Component Name 2, Driver
Configuration, Driver Configuration 2, Driver Diagnostics, and Driver Diagnostics 2 Protocols.
Initializes a driver by installing the Driver Binding Protocol together with the optional
Component Name, optional Component Name 2, optional Driver Configuration, optional Driver Configuration 2,
optional Driver Diagnostic, and optional Driver Diagnostic 2 Protocols onto the driver's DriverBindingHandle.
DriverBindingHandle is typically the same as the driver's ImageHandle, but it can be different if the driver
produces multiple Driver Binding Protocols.
If DriverBinding is NULL, then ASSERT().
If the installation fails, then ASSERT().
@param ImageHandle The image handle of the driver.
@param SystemTable The EFI System Table that was passed to the driver's entry point.
@param DriverBinding A Driver Binding Protocol instance that this driver is producing.
@param DriverBindingHandle The handle that DriverBinding is to be installed onto. If this
parameter is NULL, then a new handle is created.
@param ComponentName A Component Name Protocol instance that this driver is producing.
@param ComponentName2 A Component Name 2 Protocol instance that this driver is producing.
@param DriverConfiguration A Driver Configuration Protocol instance that this driver is producing.
@param DriverConfiguration2 A Driver Configuration Protocol 2 instance that this driver is producing.
@param DriverDiagnostics A Driver Diagnostics Protocol instance that this driver is producing.
@param DriverDiagnostics2 A Driver Diagnostics Protocol 2 instance that this driver is producing.
@retval EFI_SUCCESS The protocol installation successfully completed.
@retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.
**/
)
{
if (DriverConfiguration2 == NULL) {
if (DriverConfiguration == NULL) {
);
} else {
);
}
} else {
);
} else {
);
}
}
} else {
);
} else {
);
}
} else {
);
} else {
);
}
}
}
} else {
);
} else {
);
}
} else {
);
} else {
);
}
}
} else {
);
} else {
);
}
} else {
);
} else {
);
}
}
}
}
} else {
);
} else {
);
}
} else {
);
} else {
);
}
}
} else {
);
} else {
);
}
} else {
);
} else {
);
}
}
}
} else {
);
} else {
);
}
} else {
);
} else {
);
}
}
} else {
);
} else {
);
}
} else {
);
} else {
);
}
}
}
}
}
} else {
if (DriverConfiguration == NULL) {
);
} else {
);
}
} else {
);
} else {
);
}
}
} else {
);
} else {
);
}
} else {
);
} else {
);
}
}
}
} else {
);
} else {
);
}
} else {
);
} else {
);
}
}
} else {
);
} else {
);
}
} else {
);
} else {
);
}
}
}
}
} else {
);
} else {
);
}
} else {
);
} else {
);
}
}
} else {
);
} else {
);
}
} else {
);
} else {
);
}
}
}
} else {
);
} else {
);
}
} else {
);
} else {
);
}
}
} else {
);
} else {
);
}
} else {
);
} else {
);
}
}
}
}
}
}
//
// ASSERT if the call to InstallMultipleProtocolInterfaces() failed
//
//
// Update the ImageHandle and DriverBindingHandle fields of the Driver Binding Protocol
//
return Status;
}