\r
@param ConfigRequest The Config request string. If set to NULL, all the\r
configurable elements will be extracted from BlockNameArray.\r
- @param ConfigAltResp The returned <ConfigAltResp>.\r
@param Progress On return, points to a character in the Request.\r
+ @param ConfigAltResp The returned <ConfigAltResp>.\r
@param Guid GUID of the buffer storage.\r
@param Name Name of the buffer storage.\r
@param DriverHandle The DriverHandle which is used to invoke HiiDatabase\r
The sequential input parameters will be number of\r
AltCfgId and DefaultValueArray pairs. When set to 0,\r
there will be no <AltResp>.\r
-\r
+ @param ... Variable argument list. \r
+ \r
retval EFI_OUT_OF_RESOURCES Run out of memory resource.\r
retval EFI_INVALID_PARAMETER ConfigAltResp is NULL.\r
retval EFI_SUCCESS Operation successful.\r
@param Protocol The protocol type in the IP header.\r
@param UseDefaultAddress Whether this instance is using default address or not.\r
\r
- @retval None\r
**/\r
VOID\r
EFIAPI\r
/**\r
Register Crc32 section handler.\r
\r
+ @param ImageHandle ImageHandle of the loaded driver.\r
+ @param SystemTable Pointer to the EFI System Table.\r
+\r
@retval RETURN_SUCCESS Register successfully.\r
@retval RETURN_OUT_OF_RESOURCES No enough memory to register this handler.\r
**/\r
} DEVICE_PATH_STACK_ITEM;\r
\r
/**\r
- Push a controller device path into a globle device path list\r
+ Push a controller device path into a globle device path list.\r
\r
@param DevicePath The controller device path to push into stack\r
\r
);\r
\r
/**\r
+ Update the FV file device path if it is not valid.\r
+\r
According to a file GUID, check a Fv file device path is valid. If it is invalid,\r
try to return the valid device path.\r
FV address maybe changes for memory layout adjust from time to time, use this funciton\r
);\r
\r
/**\r
+ Gets the data and size of a variable.\r
+\r
Read the EFI variable (VendorGuid/Name) and return a dynamically allocated\r
buffer, and the size of the buffer. If failure return NULL.\r
\r
);\r
\r
/**\r
+ Connect to the handle to a device on the device path.\r
+\r
This function will create all handles associate with every device\r
path node. If the handle associate with one device path node can not\r
be created success, then still give one chance to do the dispatch,\r
/** @file \r
- PCD PEIM manage PCD database to manage all dynamic PCD in PEI phase. PCD PEIM\r
- also produce PCD_PPI.\r
+PCD PEIM produces PCD database to manage all dynamic PCD in PEI phase and install Pcd Ppi.\r
\r
-Copyright (c) 2006, Intel Corporation \r
+Copyright (c) 2006 - 2008, 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
#/** @file\r
-# Component description file for Pcd Database PEIM module\r
+# PCD PEIM produces PCD database to manage all dynamic PCD in PEI phase and install Pcd Ppi.\r
#\r
-# This PEIM driver implement and produce PCD PPI.\r
-# Copyright (c) 2006 - 2007, Intel Corporation\r
+# Copyright (c) 2006 - 2008, Intel Corporation\r
#\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
/** @file\r
Private functions used by PCD PEIM.\r
\r
-Copyright (c) 2006, Intel Corporation\r
+Copyright (c) 2006 - 2008, 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
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
-Module Name: Service.c\r
-\r
**/\r
\r
#include "Service.h"\r
/** @file\r
Private functions used by PCD PEIM.\r
\r
-Copyright (c) 2006, Intel Corporation\r
+Copyright (c) 2006 - 2008, 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
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
-Module Name: Service.h\r
-\r
**/\r
\r
#ifndef _PEI_PCD_SERVICE_H_\r
IN PEI_PCD_DATABASE *Database\r
);\r
\r
-\r
extern EFI_GUID gPcdDataBaseHobGuid;\r
\r
extern EFI_GUID gPcdPeiCallbackFnTableHobGuid;\r
\r
+//\r
+// The init Database created by PCD Database generation tool\r
+//\r
extern PEI_PCD_DATABASE_INIT gPEIPcdDbInit;\r
\r
#endif\r
IN EFI_PEI_PCI_CFG_PPI_WIDTH Width,\r
IN UINT64 Address,\r
IN OUT VOID *Buffer\r
-);\r
+ );\r
\r
/**\r
Write to a given location in the PCI configuration space.\r
IN EFI_PEI_PCI_CFG_PPI_WIDTH Width,\r
IN UINT64 Address,\r
IN OUT VOID *Buffer\r
-);\r
+ );\r
\r
\r
/**\r
IN UINT64 Address,\r
IN VOID *SetBits,\r
IN VOID *ClearBits\r
-);\r
+ );\r
\r
\r
\r
IN EFI_PEI_PCI_CFG_PPI_WIDTH Width,\r
IN UINT64 Address,\r
IN OUT VOID *Buffer\r
-)\r
+ )\r
{\r
UINTN PciLibAddress;\r
\r
IN EFI_PEI_PCI_CFG_PPI_WIDTH Width,\r
IN UINT64 Address,\r
IN OUT VOID *Buffer\r
-)\r
+ )\r
{\r
UINTN PciLibAddress;\r
\r
IN UINT64 Address,\r
IN VOID *SetBits,\r
IN VOID *ClearBits\r
-)\r
+ )\r
{\r
UINTN PciLibAddress;\r
UINT16 ClearValue16;\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Module's entry function. \r
+ This routine will install EFI_PEI_PCI_CFG2_PPI.\r
+ \r
+ @param FileHandle Handle of the file being invoked.\r
+ @param PeiServices Describes the list of possible PEI Services.\r
\r
+ @return Whether success to install service.\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PeimInitializePciCfg (\r
**/\r
CHAR16 *\r
GetImageName (\r
- EFI_LOADED_IMAGE_PROTOCOL *Image\r
+ IN EFI_LOADED_IMAGE_PROTOCOL *Image\r
)\r
{\r
EFI_STATUS Status;\r
UINTN BufferSize;\r
UINT32 AuthenticationStatus;\r
EFI_GUID *NameGuid;\r
- EFI_FIRMWARE_VOLUME2_PROTOCOL *FV2;\r
+ EFI_FIRMWARE_VOLUME2_PROTOCOL *Fv2;\r
\r
- FV2 = NULL;\r
+ Fv2 = NULL;\r
Buffer = NULL;\r
BufferSize = 0;\r
\r
Status = gBS->HandleProtocol (\r
Image->DeviceHandle,\r
&gEfiFirmwareVolume2ProtocolGuid,\r
- (VOID **) &FV2\r
+ (VOID **) &Fv2\r
);\r
if (!EFI_ERROR (Status)) {\r
- Status = FV2->ReadSection (\r
- FV2,\r
+ Status = Fv2->ReadSection (\r
+ Fv2,\r
&FvFilePath->FvFileName,\r
EFI_SECTION_USER_INTERFACE,\r
0,\r
/**\r
This function processes the results of changes in configuration.\r
\r
- @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
- @param Request A null-terminated Unicode string in <ConfigRequest> format.\r
- @param Progress A pointer to a string filled in with the offset of the most\r
- recent '&' before the first failing name/value pair (or the\r
- beginning of the string if the failure is in the first\r
- name/value pair) or the terminating NULL if all was successful.\r
+ @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
+ @param Configuration A null-terminated Unicode string in <ConfigRequest> format.\r
+ @param Progress A pointer to a string filled in with the offset of the most\r
+ recent '&' before the first failing name/value pair (or the\r
+ beginning of the string if the failure is in the first\r
+ name/value pair) or the terminating NULL if all was successful.\r
\r
@retval EFI_SUCCESS The Results is processed successfully.\r
@retval EFI_INVALID_PARAMETER Configuration is NULL.\r
EFI_STRING_ID DescriptionToken;\r
} CFG_PROTOCOL_INVOKER_CHOICE;\r
\r
+/**\r
+ This function allows a caller to extract the current configuration for one\r
+ or more named elements from the target driver.\r
+\r
+ @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
+ @param Request A null-terminated Unicode string in <ConfigRequest> format.\r
+ @param Progress On return, points to a character in the Request string.\r
+ Points to the string's null terminator if request was successful.\r
+ Points to the most recent '&' before the first failing name/value\r
+ pair (or the beginning of the string if the failure is in the\r
+ first name/value pair) if the request was not successful.\r
+ @param Results A null-terminated Unicode string in <ConfigAltResp> format which\r
+ has all values filled in for the names in the Request string.\r
+ String to be allocated by the called function.\r
+\r
+ @retval EFI_SUCCESS The Results is filled with the requested values.\r
+ @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.\r
+ @retval EFI_INVALID_PARAMETER Request is NULL, illegal syntax, or unknown name.\r
+ @retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PlatOverMngrExtractConfig (\r
- IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r
+ IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r
IN CONST EFI_STRING Request,\r
OUT EFI_STRING *Progress,\r
OUT EFI_STRING *Results\r
);\r
\r
+/**\r
+ This function processes the results of changes in configuration.\r
+\r
+ @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
+ @param Configuration A null-terminated Unicode string in <ConfigRequest> format.\r
+ @param Progress A pointer to a string filled in with the offset of the most\r
+ recent '&' before the first failing name/value pair (or the\r
+ beginning of the string if the failure is in the first\r
+ name/value pair) or the terminating NULL if all was successful.\r
+\r
+ @retval EFI_SUCCESS The Results is processed successfully.\r
+ @retval EFI_INVALID_PARAMETER Configuration is NULL.\r
+ @retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PlatOverMngrRouteConfig (\r
OUT EFI_STRING *Progress\r
);\r
\r
+/**\r
+ This is the function that is called to provide results data to the driver. This data\r
+ consists of a unique key which is used to identify what data is either being passed back\r
+ or being asked for.\r
+\r
+ @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
+ @param Action A null-terminated Unicode string in <ConfigRequest> format.\r
+ @param KeyValue A unique Goto OpCode callback value which record user's selection.\r
+ 0x100 <= KeyValue <0x500 : user select a controller item in the first page;\r
+ KeyValue == 0x1234 : user select 'Refresh' in first page, or user select 'Go to Previous Menu' in second page\r
+ KeyValue == 0x1235 : user select 'Pci device filter' in first page\r
+ KeyValue == 0x1500 : user select 'order ... priority' item in second page\r
+ KeyValue == 0x1800 : user select 'commint changes' in third page\r
+ KeyValue == 0x2000 : user select 'Go to Previous Menu' in third page\r
+ @param Type The type of value for the question.\r
+ @param Value A pointer to the data being sent to the original exporting driver.\r
+ @param ActionRequest On return, points to the action requested by the callback function.\r
+\r
+ @retval EFI_SUCCESS Always returned.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PlatOverMngrCallback (\r
OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest\r
);\r
\r
+/**\r
+ Get the image name\r
+\r
+ @param Image Image to search.\r
+\r
+ @retval !NULL Pointer into the image name if the image name is found,\r
+ @retval NULL Pointer to NULL if the image name is not found.\r
+\r
+**/\r
CHAR16 *\r
GetImageName (\r
- IN EFI_LOADED_IMAGE_PROTOCOL *Image\r
+ IN EFI_LOADED_IMAGE_PROTOCOL *Image\r
);\r
\r
-CHAR16 *\r
+/**\r
+ Get the description string by device path.\r
+\r
+ @param DevPath The input device path.\r
+\r
+ @retval !NULL The description string retured.\r
+ @retval NULL The description string cannot be found.\r
+\r
+**/\r
+CHAR16 *\r
DevicePathToStr (\r
- EFI_DEVICE_PATH_PROTOCOL *DevPath\r
+ IN EFI_DEVICE_PATH_PROTOCOL *DevPath\r
);\r
\r
#endif\r
BOOLEAN mEnvironmentVariableRead = FALSE;\r
EFI_HANDLE mCallerImageHandle;\r
\r
+/**\r
+ Platform Driver Override driver entry point, install the Platform Driver Override Protocol\r
+\r
+ @param ImageHandle ImageHandle of the loaded driver.\r
+ @param SystemTable Pointer to the EFI System Table.\r
\r
+ @retval EFI_SUCCESS The DXE Driver, DXE Runtime Driver, DXE SMM Driver,\r
+ or UEFI Driver exited normally.\r
+ @retval EFI_INCOMPATIBLE_VERSION _gUefiDriverRevision is greater than SystemTable->Hdr.Revision.\r
+ @retval Other Return value from ProcessModuleEntryPointList().\r
+**/\r
EFI_STATUS\r
EFIAPI\r
PlatformDriverOverrideEntry (\r
IN EFI_HANDLE ImageHandle,\r
IN EFI_SYSTEM_TABLE *SystemTable\r
)\r
-/*++\r
-\r
-Routine Description:\r
- Platform Driver Override driver entry point, install the Platform Driver Override Protocol\r
-\r
-Arguments:\r
- (Standard EFI Image entry - EFI_IMAGE_ENTRY_POINT)\r
-\r
-Returns:\r
- EFI_STATUS\r
-\r
---*/\r
{\r
mEnvironmentVariableRead = FALSE;\r
mCallerImageHandle = ImageHandle;\r
\r
\r
/**\r
- For the use of the ControllerHandle parameter in the GetDriverPath() and DriverLoaded() APIs\r
- makes those APIs very difficult to use, so not support.\r
-\r
-\r
+ For the use of the ControllerHandle parameter in the GetDriverPath()\r
+ But this API is very difficult to use, so not support.\r
\r
+ @param This A pointer to the\r
+ EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL instance.\r
+ @param ControllerHandle The device handle of the controller to check if a\r
+ driver override exists.\r
+ @param DriverImagePath The device path for this Image.\r
+ \r
+ @retval EFI_UNSUPPORTED\r
**/\r
EFI_STATUS\r
EFIAPI\r
\r
\r
/**\r
- For the use of the ControllerHandle parameter in the GetDriverPath() and DriverLoaded() APIs\r
- makes those APIs very difficult to use, so not support.\r
-\r
-\r
+ For the use of the ControllerHandle parameter in the DriverLoaded()\r
+ But this API is very difficult to use, so not support.\r
\r
+ @param This A pointer to the\r
+ EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL instance.\r
+ @param ControllerHandle The device handle of the controller to check if a\r
+ driver override exists.\r
+ @param DriverImagePath The device path for this Image.\r
+ @param DriverImageHandle On input, a pointer to the previous driver image\r
+ handle returned by GetDriver(). On output, a\r
+ pointer to the next driver image handle. Passing\r
+ in a NULL, will return the first driver image\r
+ handle for ControllerHandle.\r
+ \r
+ @retval EFI_UNSUPPORTED\r
**/\r
EFI_STATUS\r
EFIAPI\r
\r
**/\r
\r
-#ifndef PLATFORM_DRI_OVERRIDE_H_\r
-#define PLATFORM_DRI_OVERRIDE_H_\r
+#ifndef _PLATFORM_DRI_OVERRIDE_H_\r
+#define _PLATFORM_DRI_OVERRIDE_H_\r
\r
#include <Uefi.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/PlatDriOverLib.h>\r
\r
+/**\r
+ Retrieves the image handle of the platform override driver for a controller in the system.\r
+\r
+ @param This A pointer to the\r
+ EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL instance.\r
+ @param ControllerHandle The device handle of the controller to check if a\r
+ driver override exists.\r
+ @param DriverImageHandle On input, a pointer to the previous driver image\r
+ handle returned by GetDriver(). On output, a\r
+ pointer to the next driver image handle. Passing\r
+ in a NULL, will return the first driver image\r
+ handle for ControllerHandle.\r
+\r
+ @retval EFI_SUCCESS The driver override for ControllerHandle was\r
+ returned in DriverImageHandle.\r
+ @retval EFI_NOT_FOUND A driver override for ControllerHandle was not\r
+ found.\r
+ @retval EFI_INVALID_PARAMETER The handle specified by ControllerHandle is not a\r
+ valid handle. DriverImageHandle is not a handle\r
+ that was returned on a previous call to\r
+ GetDriver().\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
GetDriver (\r
IN OUT EFI_HANDLE * DriverImageHandle\r
);\r
\r
+/**\r
+ For the use of the ControllerHandle parameter in the GetDriverPath()\r
+ But this API is very difficult to use, so not support.\r
+\r
+ @param This A pointer to the\r
+ EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL instance.\r
+ @param ControllerHandle The device handle of the controller to check if a\r
+ driver override exists.\r
+ @param DriverImagePath The device path for this Image.\r
+ \r
+ @retval EFI_UNSUPPORTED\r
+**/\r
EFI_STATUS\r
EFIAPI\r
GetDriverPath (\r
IN OUT EFI_DEVICE_PATH_PROTOCOL **DriverImagePath\r
);\r
\r
+/**\r
+ For the use of the ControllerHandle parameter in the DriverLoaded()\r
+ But this API is very difficult to use, so not support.\r
+\r
+ @param This A pointer to the\r
+ EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL instance.\r
+ @param ControllerHandle The device handle of the controller to check if a\r
+ driver override exists.\r
+ @param DriverImagePath The device path for this Image.\r
+ @param DriverImageHandle On input, a pointer to the previous driver image\r
+ handle returned by GetDriver(). On output, a\r
+ pointer to the next driver image handle. Passing\r
+ in a NULL, will return the first driver image\r
+ handle for ControllerHandle.\r
+ \r
+ @retval EFI_UNSUPPORTED\r
+**/\r
EFI_STATUS\r
EFIAPI\r
DriverLoaded (\r
projects / mirror_edk2.git / commitdiff