tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

1. Add EfiLibInstallDriverBindingComponentName2() to install DriverBinding Protocol and optional ComponentName Protocol and ComponentName2 Protocol. This new API should cover most cases in our UEFI drivers. 

2. Refine the function headers for this driver model APIs

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@3862 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
qhuang8 2007-09-17 03:39:25 +00:00
parent 90374bc8fd
commit f662c19489
2 changed files with 224 additions and 126 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

139
MdePkg/Include/Library/UefiLib.h
View File

@ -854,20 +854,20 @@ AsciiErrorPrint (
); );
/** /**
Intialize a driver by installing the Driver Binding Protocol onto the Intialize a driver by installing the Driver Binding Protocol onto the driver's
driver's DriverBindingHandle. This is typically the same as the driver's DriverBindingHandle. This is typically the same as the driver's ImageHandle, but
ImageHandle, but it can be different if the driver produces multiple it can be different if the driver produces multiple DriverBinding Protocols.
DriverBinding Protocols. This function also initializes the EFI Driver If the Drvier Binding Protocol interface is NULL, then ASSERT ().
Library that initializes the global variables gST, gBS, gRT. If the installation fails, then ASSERT ().
@param ImageHandle The image handle of the driver @param ImageHandle The image handle of the driver.
@param SystemTable The EFI System Table that was passed to the driver's entry point @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 DriverBinding A Driver Binding Protocol instance that this driver is producing.
@param DriverBindingHandle The handle that DriverBinding is to be installe onto. If this @param DriverBindingHandle The handle that DriverBinding is to be installe onto. If this
parameter is NULL, then a new handle is created. parameter is NULL, then a new handle is created.
@retval EFI_SUCCESS DriverBinding is installed onto DriverBindingHandle @retval EFI_SUCCESS The protocol installation is completed successfully.
@retval Other Status from gBS->InstallProtocolInterface() @retval Others Status from gBS->InstallMultipleProtocolInterfaces().
**/ **/
EFI_STATUS EFI_STATUS
@ -879,24 +879,26 @@ EfiLibInstallDriverBinding (
IN EFI_HANDLE DriverBindingHandle IN EFI_HANDLE DriverBindingHandle
); );
/** /**
Intialize a driver by installing the Driver Binding Protocol onto the Intialize a driver by installing the Driver Binding Protocol together with the optional Component Name,
driver's DriverBindingHandle. This is typically the same as the driver's Driver Configure and Driver Diagnostic Protocols onto the driver's DriverBindingHandle. This is
ImageHandle, but it can be different if the driver produces multiple typically the same as the driver's ImageHandle, but it can be different if the driver produces multiple
DriverBinding Protocols. This function also initializes the EFI Driver DriverBinding Protocols.
Library that initializes the global variables gST, gBS, gRT. If the Drvier Binding Protocol interface is NULL, then ASSERT ().
If the installation fails, then ASSERT ().
@ImageHandle The image handle of the driver @param ImageHandle The image handle of the driver.
@SystemTable The EFI System Table that was passed to the driver's entry point @param SystemTable The EFI System Table that was passed to the driver's entry point.
@DriverBinding A Driver Binding Protocol instance that this driver is producing @param DriverBinding A Driver Binding Protocol instance that this driver is producing.
@DriverBindingHandle The handle that DriverBinding is to be installe onto. If this @param DriverBindingHandle The handle that DriverBinding is to be installe onto. If this
parameter is NULL, then a new handle is created. parameter is NULL, then a new handle is created.
@ComponentName A Component Name Protocol instance that this driver is producing @param ComponentName A Component Name Protocol instance that this driver is producing.
@DriverConfiguration A Driver Configuration Protocol instance that this driver is producing @param DriverConfiguration A Driver Configuration Protocol instance that this driver is producing.
@DriverDiagnostics A Driver Diagnostics Protocol instance that this driver is producing @param DriverDiagnostics A Driver Diagnostics Protocol instance that this driver is producing.
@retval EFI_SUCCESS DriverBinding is installed onto DriverBindingHandle @retval EFI_SUCCESS The protocol installation is completed successfully.
@retval Other Status from gBS->InstallProtocolInterface() @retval Others Status from gBS->InstallMultipleProtocolInterfaces().
**/ **/
EFI_STATUS EFI_STATUS
@ -912,51 +914,59 @@ EfiLibInstallAllDriverProtocols (
); );
/** /**
Intialize a driver by installing the Driver Binding Protocol Intialize a driver by installing the Driver Binding Protocol together with the optional Component Name,
onto the driver's DriverBindingHandle. This is typically the Component Name 2 onto the driver's DriverBindingHandle. This is typically the same as the driver's
same as the driver's ImageHandle, but it can be different if ImageHandle, but it can be different if the driver produces multiple DriverBinding Protocols.
the driver produces multiple DriverBinding Protocols. This If the Drvier Binding Protocol interface is NULL, then ASSERT ().
function also initializes the EFI Driver Library that If the installation fails, then ASSERT ().
initializes the global variables gST, gBS, gRT.
@ImageHandle The image handle of the driver @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 installe 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.
@SystemTable The EFI System Table that was @retval EFI_SUCCESS The protocol installation is completed successfully.
passed to the driver's entry @retval Others Status from gBS->InstallMultipleProtocolInterfaces().
point
@DriverBinding A Driver Binding Protocol **/
instance that this driver is EFI_STATUS
producing EFIAPI
EfiLibInstallDriverBindingComponentName2 (
IN CONST EFI_HANDLE ImageHandle,
IN CONST EFI_SYSTEM_TABLE *SystemTable,
IN EFI_DRIVER_BINDING_PROTOCOL *DriverBinding,
IN EFI_HANDLE DriverBindingHandle,
IN CONST EFI_COMPONENT_NAME_PROTOCOL *ComponentName, OPTIONAL
IN CONST EFI_COMPONENT_NAME2_PROTOCOL *ComponentName2 OPTIONAL
);
@DriverBindingHandle The handle that DriverBinding is
to be installe onto. If this
parameter is NULL, then a new
handle is created.
@ComponentName A Component Name Protocol /**
instance that this driver is Intialize a driver by installing the Driver Binding Protocol together with the optional Component Name,
producing Component Name 2, Driver Configure, Driver Diagnostic and Driver Diagnostic 2 Protocols onto the driver's
DriverBindingHandle. This is typically the same as the driver's ImageHandle, but it can be different if
the driver produces multiple DriverBinding Protocols.
If the Drvier Binding Protocol interface is NULL, then ASSERT ().
If the installation fails, then ASSERT ().
@ComponentName2 A Component Name 2 Protocol @param ImageHandle The image handle of the driver.
instance that this driver is @param SystemTable The EFI System Table that was passed to the driver's entry point.
producing @param DriverBinding A Driver Binding Protocol instance that this driver is producing.
@param DriverBindingHandle The handle that DriverBinding is to be installe 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 DriverDiagnostics A Driver Diagnostics Protocol instance that this driver is producing.
@param DriverDiagnostics2 A Driver Diagnostics Protocol 2 instance that this driver is producing.
@DriverConfiguration A Driver Configuration Protocol @retval EFI_SUCCESS The protocol installation is completed successfully.
instance that this driver is @retval Others Status from gBS->InstallMultipleProtocolInterfaces().
producing
@DriverDiagnostics A Driver Diagnostics Protocol
instance that this driver is
producing
@DriverDiagnostics2 A Driver Diagnostics 2 Protocol
instance that this driver is
producing
@retval EFI_SUCCESS DriverBinding is installed onto DriverBindingHandle
@retval Other Status from gBS->InstallProtocolInterface()
**/ **/
EFI_STATUS EFI_STATUS
@ -973,5 +983,4 @@ EfiLibInstallAllDriverProtocols2 (
IN CONST EFI_DRIVER_DIAGNOSTICS2_PROTOCOL *DriverDiagnostics2 OPTIONAL IN CONST EFI_DRIVER_DIAGNOSTICS2_PROTOCOL *DriverDiagnostics2 OPTIONAL
); );
#endif #endif

201
MdePkg/Library/UefiLib/UefiDriverModel.c
View File

@ -19,27 +19,27 @@
#include "UefiLibInternal.h" #include "UefiLibInternal.h"
/** /**
Intialize a driver by installing the Driver Binding Protocol onto the Intialize a driver by installing the Driver Binding Protocol onto the driver's
driver's DriverBindingHandle. This is typically the same as the driver's DriverBindingHandle. This is typically the same as the driver's ImageHandle, but
ImageHandle, but it can be different if the driver produces multiple it can be different if the driver produces multiple DriverBinding Protocols.
DriverBinding Protocols. This function also initializes the EFI Driver If the Drvier Binding Protocol interface is NULL, then ASSERT ().
Library that initializes the global variables gST, gBS, gRT. If the installation fails, then ASSERT ().
@param ImageHandle The image handle of the driver @param ImageHandle The image handle of the driver.
@param SystemTable The EFI System Table that was passed to the driver's entry point @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 DriverBinding A Driver Binding Protocol instance that this driver is producing.
@param DriverBindingHandle The handle that DriverBinding is to be installe onto. If this @param DriverBindingHandle The handle that DriverBinding is to be installe onto. If this
parameter is NULL, then a new handle is created. parameter is NULL, then a new handle is created.
@retval EFI_SUCCESS DriverBinding is installed onto DriverBindingHandle @retval EFI_SUCCESS The protocol installation is completed successfully.
@retval Other Status from gBS->InstallProtocolInterface() @retval Others Status from gBS->InstallMultipleProtocolInterfaces().
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
EfiLibInstallDriverBinding ( EfiLibInstallDriverBinding (
IN const EFI_HANDLE ImageHandle, IN CONST EFI_HANDLE ImageHandle,
IN const EFI_SYSTEM_TABLE *SystemTable, IN CONST EFI_SYSTEM_TABLE *SystemTable,
IN EFI_DRIVER_BINDING_PROTOCOL *DriverBinding, IN EFI_DRIVER_BINDING_PROTOCOL *DriverBinding,
IN EFI_HANDLE DriverBindingHandle IN EFI_HANDLE DriverBindingHandle
) )
@ -67,36 +67,38 @@ EfiLibInstallDriverBinding (
return Status; return Status;
} }
/** /**
Intialize a driver by installing the Driver Binding Protocol onto the Intialize a driver by installing the Driver Binding Protocol together with the optional Component Name,
driver's DriverBindingHandle. This is typically the same as the driver's Driver Configure and Driver Diagnostic Protocols onto the driver's DriverBindingHandle. This is
ImageHandle, but it can be different if the driver produces multiple typically the same as the driver's ImageHandle, but it can be different if the driver produces multiple
DriverBinding Protocols. This function also initializes the EFI Driver DriverBinding Protocols.
Library that initializes the global variables gST, gBS, gRT. If the Drvier Binding Protocol interface is NULL, then ASSERT ().
If the installation fails, then ASSERT ().
@ImageHandle The image handle of the driver @param ImageHandle The image handle of the driver.
@SystemTable The EFI System Table that was passed to the driver's entry point @param SystemTable The EFI System Table that was passed to the driver's entry point.
@DriverBinding A Driver Binding Protocol instance that this driver is producing @param DriverBinding A Driver Binding Protocol instance that this driver is producing.
@DriverBindingHandle The handle that DriverBinding is to be installe onto. If this @param DriverBindingHandle The handle that DriverBinding is to be installe onto. If this
parameter is NULL, then a new handle is created. parameter is NULL, then a new handle is created.
@ComponentName A Component Name Protocol instance that this driver is producing @param ComponentName A Component Name Protocol instance that this driver is producing.
@DriverConfiguration A Driver Configuration Protocol instance that this driver is producing @param DriverConfiguration A Driver Configuration Protocol instance that this driver is producing.
@DriverDiagnostics A Driver Diagnostics Protocol instance that this driver is producing @param DriverDiagnostics A Driver Diagnostics Protocol instance that this driver is producing.
@retval EFI_SUCCESS DriverBinding is installed onto DriverBindingHandle @retval EFI_SUCCESS The protocol installation is completed successfully.
@retval Other Status from gBS->InstallProtocolInterface() @retval Others Status from gBS->InstallMultipleProtocolInterfaces().
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
EfiLibInstallAllDriverProtocols ( EfiLibInstallAllDriverProtocols (
IN const EFI_HANDLE ImageHandle, IN CONST EFI_HANDLE ImageHandle,
IN const EFI_SYSTEM_TABLE *SystemTable, IN CONST EFI_SYSTEM_TABLE *SystemTable,
IN EFI_DRIVER_BINDING_PROTOCOL *DriverBinding, IN EFI_DRIVER_BINDING_PROTOCOL *DriverBinding,
IN EFI_HANDLE DriverBindingHandle, IN EFI_HANDLE DriverBindingHandle,
IN const EFI_COMPONENT_NAME_PROTOCOL *ComponentName, OPTIONAL IN CONST EFI_COMPONENT_NAME_PROTOCOL *ComponentName, OPTIONAL
IN const EFI_DRIVER_CONFIGURATION_PROTOCOL *DriverConfiguration, OPTIONAL IN CONST EFI_DRIVER_CONFIGURATION_PROTOCOL *DriverConfiguration, OPTIONAL
IN const EFI_DRIVER_DIAGNOSTICS_PROTOCOL *DriverDiagnostics OPTIONAL IN CONST EFI_DRIVER_DIAGNOSTICS_PROTOCOL *DriverDiagnostics OPTIONAL
) )
{ {
EFI_STATUS Status; EFI_STATUS Status;
@ -192,38 +194,125 @@ EfiLibInstallAllDriverProtocols (
} }
/** /**
Intialize a driver by installing the Driver Binding Protocol onto the Intialize a driver by installing the Driver Binding Protocol together with the optional Component Name,
driver's DriverBindingHandle. This is typically the same as the driver's Component Name 2 onto the driver's DriverBindingHandle. This is typically the same as the driver's
ImageHandle, but it can be different if the driver produces multiple ImageHandle, but it can be different if the driver produces multiple DriverBinding Protocols.
DriverBinding Protocols. This function also initializes the EFI Driver If the Drvier Binding Protocol interface is NULL, then ASSERT ().
Library that initializes the global variables gST, gBS, gRT. If the installation fails, then ASSERT ().
@ImageHandle The image handle of the driver @param ImageHandle The image handle of the driver.
@SystemTable The EFI System Table that was passed to the driver's entry point @param SystemTable The EFI System Table that was passed to the driver's entry point.
@DriverBinding A Driver Binding Protocol instance that this driver is producing @param DriverBinding A Driver Binding Protocol instance that this driver is producing.
@DriverBindingHandle The handle that DriverBinding is to be installe onto. If this @param DriverBindingHandle The handle that DriverBinding is to be installe onto. If this
parameter is NULL, then a new handle is created. parameter is NULL, then a new handle is created.
@ComponentName A Component Name Protocol instance that this driver is producing @param ComponentName A Component Name Protocol instance that this driver is producing.
@DriverConfiguration A Driver Configuration Protocol instance that this driver is producing @param ComponentName2 A Component Name 2 Protocol instance that this driver is producing.
@DriverDiagnostics A Driver Diagnostics Protocol instance that this driver is producing
@retval EFI_SUCCESS DriverBinding is installed onto DriverBindingHandle @retval EFI_SUCCESS The protocol installation is completed successfully.
@retval Other Status from gBS->InstallProtocolInterface() @retval Others Status from gBS->InstallMultipleProtocolInterfaces().
**/
EFI_STATUS
EFIAPI
EfiLibInstallDriverBindingComponentName2 (
IN CONST EFI_HANDLE ImageHandle,
IN CONST EFI_SYSTEM_TABLE *SystemTable,
IN EFI_DRIVER_BINDING_PROTOCOL *DriverBinding,
IN EFI_HANDLE DriverBindingHandle,
IN CONST EFI_COMPONENT_NAME_PROTOCOL *ComponentName, OPTIONAL
IN CONST EFI_COMPONENT_NAME2_PROTOCOL *ComponentName2 OPTIONAL
)
{
EFI_STATUS Status;
ASSERT (NULL != DriverBinding);
if (ComponentName == NULL || FeaturePcdGet(PcdComponentNameDisable)) {
if (ComponentName2 == NULL || FeaturePcdGet(PcdComponentName2Disable)) {
Status = gBS->InstallMultipleProtocolInterfaces (
&DriverBindingHandle,
&gEfiDriverBindingProtocolGuid, DriverBinding,
NULL
);
} else {
Status = gBS->InstallMultipleProtocolInterfaces (
&DriverBindingHandle,
&gEfiDriverBindingProtocolGuid, DriverBinding,
&gEfiComponentName2ProtocolGuid, ComponentName2,
NULL
);
}
} else {
if (ComponentName2 == NULL || FeaturePcdGet(PcdComponentName2Disable)) {
Status = gBS->InstallMultipleProtocolInterfaces (
&DriverBindingHandle,
&gEfiDriverBindingProtocolGuid, DriverBinding,
&gEfiComponentNameProtocolGuid, ComponentName,
NULL
);
} else {
Status = gBS->InstallMultipleProtocolInterfaces (
&DriverBindingHandle,
&gEfiDriverBindingProtocolGuid, DriverBinding,
&gEfiComponentNameProtocolGuid, ComponentName,
&gEfiComponentName2ProtocolGuid, ComponentName2,
NULL
);
}
}
//
// ASSERT if the call to InstallMultipleProtocolInterfaces() failed
//
ASSERT_EFI_ERROR (Status);
//
// Update the ImageHandle and DriverBindingHandle fields of the Driver Binding Protocol
//
DriverBinding->ImageHandle = ImageHandle;
DriverBinding->DriverBindingHandle = DriverBindingHandle;
return Status;
}
/**
Intialize a driver by installing the Driver Binding Protocol together with the optional Component Name,
Component Name 2, Driver Configure, Driver Diagnostic and Driver Diagnostic 2 Protocols onto the driver's
DriverBindingHandle. This is typically the same as the driver's ImageHandle, but it can be different if
the driver produces multiple DriverBinding Protocols.
If the Drvier Binding Protocol interface 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 installe 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 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 is completed successfully.
@retval Others Status from gBS->InstallMultipleProtocolInterfaces().
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
EfiLibInstallAllDriverProtocols2 ( EfiLibInstallAllDriverProtocols2 (
IN const EFI_HANDLE ImageHandle, IN CONST EFI_HANDLE ImageHandle,
IN const EFI_SYSTEM_TABLE *SystemTable, IN CONST EFI_SYSTEM_TABLE *SystemTable,
IN EFI_DRIVER_BINDING_PROTOCOL *DriverBinding, IN EFI_DRIVER_BINDING_PROTOCOL *DriverBinding,
IN EFI_HANDLE DriverBindingHandle, IN EFI_HANDLE DriverBindingHandle,
IN const EFI_COMPONENT_NAME_PROTOCOL *ComponentName, OPTIONAL IN CONST EFI_COMPONENT_NAME_PROTOCOL *ComponentName, OPTIONAL
IN const EFI_COMPONENT_NAME2_PROTOCOL *ComponentName2, OPTIONAL IN CONST EFI_COMPONENT_NAME2_PROTOCOL *ComponentName2, OPTIONAL
IN const EFI_DRIVER_CONFIGURATION_PROTOCOL *DriverConfiguration, OPTIONAL IN CONST EFI_DRIVER_CONFIGURATION_PROTOCOL *DriverConfiguration, OPTIONAL
IN const EFI_DRIVER_DIAGNOSTICS_PROTOCOL *DriverDiagnostics, OPTIONAL IN CONST EFI_DRIVER_DIAGNOSTICS_PROTOCOL *DriverDiagnostics, OPTIONAL
IN const EFI_DRIVER_DIAGNOSTICS2_PROTOCOL *DriverDiagnostics2 OPTIONAL IN CONST EFI_DRIVER_DIAGNOSTICS2_PROTOCOL *DriverDiagnostics2 OPTIONAL
) )
{ {
EFI_STATUS Status; EFI_STATUS Status;