#include <Guid/DxeServices.h>\r
#include <Guid/MemoryAllocationHob.h>\r
#include <Protocol/StatusCode.h>\r
-#include <Protocol/CustomizedDecompress.h>\r
#include <Protocol/Decompress.h>\r
#include <Protocol/LoadPe32Image.h>\r
#include <Protocol/FirmwareVolumeDispatch.h>\r
#include <Protocol/Ebc.h>\r
#include <Guid/EventLegacyBios.h>\r
#include <Protocol/Reset.h>\r
-#include <Protocol/EdkDecompress.h>\r
#include <Protocol/Cpu.h>\r
#include <Guid/EventGroup.h>\r
#include <Protocol/Metronome.h>\r
[Protocols]\r
gEfiStatusCodeRuntimeProtocolGuid # PROTOCOL SOMETIMES_CONSUMED\r
gEfiCapsuleArchProtocolGuid # PROTOCOL ALWAYS_CONSUMED\r
- gEfiTianoDecompressProtocolGuid # PROTOCOL ALWAYS_CONSUMED\r
- gEfiCustomizedDecompressProtocolGuid # PROTOCOL ALWAYS_CONSUMED\r
gEfiDecompressProtocolGuid # PROTOCOL ALWAYS_CONSUMED\r
gEfiLoadPeImageProtocolGuid # PROTOCOL ALWAYS_PRODUCED\r
gEfiSimpleFileSystemProtocolGuid # PROTOCOL ALWAYS_CONSUMED\r
\r
#include <PiPei.h>\r
#include <Ppi/DxeIpl.h>\r
-#include <Protocol/EdkDecompress.h>\r
#include <Ppi/EndOfPeiPhase.h>\r
-#include <Protocol/CustomizedDecompress.h>\r
-#include <Protocol/Decompress.h>\r
#include <Ppi/MemoryDiscovered.h>\r
#include <Ppi/ReadOnlyVariable2.h>\r
#include <Guid/MemoryTypeInformation.h>\r
/** @file\r
\r
- Tiano Guid used to define the Alternate Firmware Volume Block Guid.\r
+ This file defines the Alternate Firmware Volume Block Guid, which is \r
+ used to specify that the additional FVB protocol is installed into FVB handle.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
/** @file\r
This file defines header data structures for BMP file and default\r
- BMP file GUID. \r
+ GUID for BMP logo file. \r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
All rights reserved. This program and the accompanying materials\r
/** @file\r
\r
- Capsule update Guid definitions for capsule varialbe and capsule hob.\r
+ This file defines capsule update guid, capsule variable name and \r
+ capsule guid hob data strucutre, which are required by capsule update feature.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
#define __EFI_CAPSULE_VENDOR_GUID_H__\r
\r
//\r
-// Note -- This guid is used as a vendor GUID (depending on implementation)\r
+// Note -- This guid is used as a variable GUID (depending on implementation)\r
// for the capsule variable if the capsule pointer is passes through reset\r
// via a variable.\r
//\r
-/*++\r
+/** @file\r
+ This guid is used to specifiy the device is the console in device.\r
+ If the device is the console in device, this guid as the protocol guid\r
+ will be installed into this device handle.\r
\r
-Copyright (c) 2006 - 2007, 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
-Module Name:\r
-\r
- ConsoleInDevice.h\r
-\r
-Abstract:\r
-\r
-\r
---*/\r
+**/\r
\r
#ifndef __CONSOLE_IN_DEVICE_H__\r
#define __CONSOLE_IN_DEVICE_H__\r
-/*++\r
+/** @file\r
+ This guid is used to specifiy the device is the console out device.\r
+ If the device is the console out device, this guid as the protocol guid\r
+ will be installed into this device handle.\r
\r
-Copyright (c) 2006 - 2007, 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
-Module Name:\r
-\r
- ConsoleOutDevice.h\r
-\r
-Abstract:\r
-\r
-\r
---*/\r
+**/\r
\r
#ifndef __CONSOLE_OUT_DEVICE_H__\r
#define __CONSOLE_OUT_DEVICE_H__\r
/** @file\r
- The variable space Guid to pair with a Unicode string name to tag an EFI variable.\r
+ This file defines the genenic platform guid for EFI variable.\r
+ Common drivers can use this generic guid with its variable name to specify \r
+ its EFI variable without defining another new guid.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
All rights reserved. This program and the accompanying materials\r
#ifndef __GENERIC_PLATFORM_VARIABLE_H__\r
#define __GENERIC_PLATFORM_VARIABLE_H__\r
\r
+#define EFI_GENERIC_PLATFORM_VARIABLE_GUID \\r
+ { 0x59d1c24f, 0x50f1, 0x401a, { 0xb1, 0x01, 0xf3, 0x3e, 0x0d, 0xae, 0xd4, 0x43 }}\r
+\r
extern EFI_GUID gEfiGenericPlatformVariableGuid;\r
\r
#endif\r
-/*++\r
+/** @file\r
+ This guid is used to specifiy the device is the hot plug device.\r
+ If the device is the hot plug device, this guid as the protocol guid\r
+ will be installed into this device handle.\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
-Module Name:\r
-\r
- HotPlugDevice.h\r
-\r
-Abstract:\r
-\r
-\r
---*/\r
+**/\r
\r
#ifndef __HOT_PLUG_DEVICE_H__\r
#define __HOT_PLUG_DEVICE_H__\r
/** @file\r
- GUID used for Memory Type Information entries in the HOB list.\r
+ This file defines the memory type information guid, variable name and guid hob structure. \r
+ This guid is used for Memory Type Information entries in the HOB list and EFI variable.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
All rights reserved. This program and the accompanying materials\r
-/*++\r
+/** @file\r
+ This guid is used for Platform Override Variable named L"PlatDriOver".\r
\r
Copyright (c) 2008, Intel Corporation\r
All rights reserved. This program and the accompanying materials\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
-Module Name:\r
-\r
- OverrideVariable.h\r
-\r
-Abstract:\r
-\r
- Platform Override Variable Guid definitions\r
-\r
---*/\r
+**/\r
\r
#ifndef __EFI_OVERRIDE_VARIABLE_GUID_H__\r
#define __EFI_OVERRIDE_VARIABLE_GUID_H__\r
/** @file\r
- \r
- GUID for the PE/COFF Loader APIs shared between SEC, PEI and DXE\r
+ This file defines PeCoffLoader guid for PeCoffLoader entry in the HOB list.\r
+ It also defines PE/COFF Loader APIs in PeCoffLoader Hob entry shared between SEC, PEI and DXE\r
\r
Copyright (c) 2006 - 2008, Intel Corporation \r
All rights reserved. This program and the accompanying materials \r
typedef \r
RETURN_STATUS\r
(EFIAPI *EFI_PEI_PE_COFF_LOADER_UNLOAD_IMAGE) (\r
- IN EFI_PEI_PE_COFF_LOADER_PROTOCOL *This,\r
+ IN EFI_PEI_PE_COFF_LOADER_PROTOCOL *This,\r
IN PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
);\r
\r
/** @file\r
- GUIDs used for PEI Performance HOB data structures\r
+ This file defines performance guid for the performance entry in the HOB list, \r
+ and define the PEI Performance HOB data structures.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
All rights reserved. This program and the accompanying materials\r
-/*++\r
+/** @file\r
+ This guid is used to specify the primary console in device.\r
+ It will be installed into the virtual device handle for ConIn Splitter.\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
-Module Name:\r
-\r
- PrimaryConsoleInDevice.h\r
-\r
-Abstract:\r
-\r
-\r
---*/\r
+**/\r
\r
#ifndef __PRIMARY_CONSOLE_IN_DEVICE_H__\r
#define __PRIMARY_CONSOLE_IN_DEVICE_H__\r
-/*++\r
+/** @file\r
+ This guid is used to specify the primary console out device.\r
+ It will be installed into the virtual device handle for ConOut Splitter.\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
-Module Name:\r
-\r
- PrimaryConsoleOutDevice.h\r
-\r
-Abstract:\r
-\r
---*/\r
+**/\r
\r
#ifndef __PRIMARY_CONSOLE_OUT_DEVICE_H__\r
#define __PRIMARY_CONSOLE_OUT_DEVICE_H__\r
-/*++\r
+/** @file\r
+ This guid is used to specify the primary StdErr device.\r
+ It will be installed into the virtual device handle for StdErr Splitter.\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
-Module Name:\r
-\r
- PrimaryStandardErrorDevice.h\r
-\r
-Abstract:\r
-\r
---*/\r
+**/\r
\r
#ifndef __PRIMARY_STANDARD_ERROR_DEVICE_H__\r
#define __PRIMARY_STANDARD_ERROR_DEVICE_H__\r
-/*++\r
+/** @file\r
+ This guid is used to specifiy the device is the StdErr device.\r
+ If the device is the StdErr device, this guid as the protocol guid\r
+ will be installed into this device handle.\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
-Module Name:\r
-\r
- StandardErrorDevice.h\r
-\r
-Abstract:\r
-\r
-\r
---*/\r
+**/\r
\r
#ifndef __STANDARD_ERROR_DEVICE_H__\r
#define __STANDARD_ERROR_DEVICE_H__\r
/** @file\r
-\r
- GUIDs used for System Non Volatile HOB entries in the in the HOB list and FV Guids carrying\r
- the System specific information.\r
+ This file defines GUIDs used for System Non Volatile HOB entries in the HOB list,\r
+ and FV Guids that carrying the System specific information.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation \r
All rights reserved. This program and the accompanying materials \r
/** @file\r
-\r
- GUIDs used for variable list entries put in the EFI system table.\r
+ This file defines GUIDs used for variable list entries put in the EFI system table.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
/** @file\r
- This library includes the APIs that is specific to EDK II's implementation.\r
- It extended the UEFI Specification to define GUIDed device path.\r
+ This library includes two extended HII functions to \r
+ create and destory Hii Package by create the virtual Driver Handle.\r
\r
Copyright (c) 2008, Intel Corporation. <BR>\r
All rights reserved. This program and the accompanying materials\r
\r
**/\r
EFI_STATUS\r
+EFIAPI\r
CreateBannerOpCode (\r
IN EFI_STRING_ID Title,\r
IN UINT16 LineNumber,\r
\r
**/\r
EFI_STATUS\r
+EFIAPI\r
IfrLibUpdateForm (\r
IN EFI_HII_HANDLE Handle,\r
IN EFI_GUID *FormSetGuid, OPTIONAL\r
\r
**/\r
EFI_STATUS\r
+EFIAPI\r
IfrLibExtractClassFromHiiHandle (\r
IN EFI_HII_HANDLE Handle,\r
OUT UINT16 *Class,\r
\r
@param Buffer the start address of buffer.\r
@param BufferSize the size of buffer.\r
- @param Number the number of the strings.\r
+ @param Number the number of the ConfigBody strings.\r
+ @param ... the ConfigBody strings\r
\r
@retval EFI_BUFFER_TOO_SMALL the BufferSize is too small to operate.\r
@retval EFI_INVALID_PARAMETER Buffer is NULL or BufferSize is 0.\r
/** @file\r
- Generic BDS library definition, include the file and data structure\r
+ Generic BDS library definition, include the data structure and function.\r
\r
Copyright (c) 2004 - 2008, Intel Corporation. <BR>\r
All rights reserved. This program and the accompanying materials\r
//\r
// Constants which are variable names used to access variables\r
//\r
-#define VarLegacyDevOrder L"LegacyDevOrder"\r
+#define VAR_LEGACY_DEV_ORDER L"LegacyDevOrder"\r
\r
//\r
// Data structures and defines\r
//\r
\r
//\r
-// Bds boot relate lib functions\r
+// Bds boot related lib functions\r
//\r
/**\r
- Boot from the EFI1.1 spec defined "BootNext" variable\r
+ Boot from the UEFI spec defined "BootNext" variable.\r
\r
**/\r
VOID\r
);\r
\r
/**\r
- Process the boot option follow the EFI 1.1 specification and\r
+ Process the boot option follow the UEFI specification and\r
special treat the legacy boot option with BBS_DEVICE_PATH.\r
\r
@param Option The boot option need to be processed\r
@param DevicePath The device path which describe where to load the\r
boot image or the legcy BBS device path to boot\r
the legacy OS\r
- @param ExitDataSize Returned directly from gBS->StartImage ()\r
- @param ExitData Returned directly from gBS->StartImage ()\r
+ @param ExitDataSize The size of exit data.\r
+ @param ExitData Data returned when Boot image failed.\r
\r
- @retval EFI_SUCCESS Status from gBS->StartImage ()\r
+ @retval EFI_SUCCESS Boot from the input boot option successfully.\r
@retval EFI_NOT_FOUND If the Device Path is not found in the system\r
\r
**/\r
boot option\r
@param BdsBootOptionList The header of the link list which indexed all\r
current boot options\r
-\r
- @return VOID\r
+ @param String The description of the boot option.\r
\r
**/\r
VOID\r
\r
\r
/**\r
- Build the on flash shell boot option with the handle parsed in\r
+ Build the on flash shell boot option with the handle parsed in.\r
\r
@param Handle The handle which present the device path to create\r
on flash shell boot option\r
@param BdsBootOptionList The header of the link list which indexed all\r
current boot options\r
\r
- @return None\r
-\r
**/\r
VOID\r
EFIAPI\r
@param VendorGuid GUID part of EFI variable name\r
@param VariableSize Returns the size of the EFI variable that was read\r
\r
- @return Dynamically allocated memory that contains a copy of the EFI variable.\r
- @return Caller is responsible freeing the buffer.\r
+ @return Dynamically allocated memory that contains a copy of the EFI variable\r
+ Caller is responsible freeing the buffer.\r
@retval NULL Variable was not read\r
\r
**/\r
\r
/**\r
Build the boot#### or driver#### option from the VariableName, the\r
- build boot#### or driver#### will also be linked to BdsCommonOptionList\r
+ build boot#### or driver#### will also be linked to BdsCommonOptionList.\r
\r
@param BdsCommonOptionList The header of the boot#### or driver#### option\r
link list\r
);\r
\r
//\r
-// Bds console relate lib functions\r
+// Bds console related lib functions\r
//\r
/**\r
This function will search every simpletxt devive in current system,\r
\r
@retval EFI_SUCCESS At least one of the ConIn and ConOut device have\r
been connected success.\r
- @retval EFI_STATUS Return the status of\r
- BdsLibConnectConsoleVariable ().\r
+ @retval EFI_STATUS Return the status of BdsLibConnectConsoleVariable ().\r
\r
**/\r
EFI_STATUS\r
from the console variable ConVarName, this\r
parameter can not be multi-instance.\r
\r
- @retval EFI_UNSUPPORTED Add or remove the same device path.\r
+ @retval EFI_UNSUPPORTED The added device path is same to the removed one.\r
@retval EFI_SUCCESS Success add or remove the device path from the\r
console variable.\r
\r
);\r
\r
//\r
-// Bds device path relate lib functions\r
+// Bds device path related lib functions\r
//\r
/**\r
Function unpacks a device path data structure so that all the nodes\r
@param Single A pointer to a single-instance device path data\r
structure.\r
\r
- @retval TRUE If the Single is contained within Multi\r
- @retval FALSE The Single is not match within Multi\r
+ @retval TRUE If the Single device path is contained within Multi device path.\r
+ @retval FALSE The Single device path is not match within Multi device path.\r
\r
**/\r
BOOLEAN\r
//\r
#if defined (MDE_CPU_IPF)\r
#define EFI64_SHADOW_ALL_LEGACY_ROM() ShadowAllOptionRom ();\r
-VOID\r
-ShadowAllOptionRom();\r
#else\r
#define EFI64_SHADOW_ALL_LEGACY_ROM()\r
#endif\r
\r
+/**\r
+ Shadow all Legacy OptionRom. \r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+ShadowAllOptionRom (\r
+ VOID\r
+ );\r
+\r
//\r
// BBS support macros and functions\r
//\r
#define REFRESH_LEGACY_BOOT_OPTIONS\r
#endif\r
\r
+/**\r
+ Delete all the invalid legacy boot options.\r
+\r
+ @retval EFI_SUCCESS All invalide legacy boot options are deleted.\r
+ @retval EFI_OUT_OF_RESOURCES Fail to allocate necessary memory.\r
+ @retval EFI_NOT_FOUND Fail to retrive variable of boot order.\r
+\r
+**/\r
EFI_STATUS\r
+EFIAPI\r
BdsDeleteAllInvalidLegacyBootOptions (\r
VOID\r
);\r
\r
+/**\r
+\r
+ Add the legacy boot options from BBS table if they do not exist.\r
+\r
+ @retval EFI_SUCCESS The boot options are added successfully \r
+ or they are already in boot options.\r
+\r
+**/\r
EFI_STATUS\r
+EFIAPI\r
BdsAddNonExistingLegacyBootOptions (\r
VOID\r
);\r
\r
+/**\r
+\r
+ Add the legacy boot devices from BBS table into \r
+ the legacy device boot order.\r
+\r
+ @retval EFI_SUCCESS The boot devices are added successfully.\r
+\r
+**/\r
EFI_STATUS\r
+EFIAPI\r
BdsUpdateLegacyDevOrder (\r
VOID\r
);\r
\r
+/**\r
+\r
+ Set the boot priority for BBS entries based on boot option entry and boot order.\r
+\r
+ @param Entry The boot option is to be checked for refresh BBS table.\r
+ \r
+ @retval EFI_SUCCESS The boot priority for BBS entries is refreshed successfully.\r
+\r
+**/\r
EFI_STATUS\r
+EFIAPI\r
BdsRefreshBbsTableForBoot (\r
IN BDS_COMMON_OPTION *Entry\r
);\r
\r
+/**\r
+\r
+ Delete boot option specified by OptionNumber and adjust the boot order.\r
+\r
+ @param OptionNumber The boot option to be deleted.\r
+ @param BootOrder Boot order list to be adjusted by remove this boot option.\r
+ @param BootOrderSize The size of Boot order list will be modified.\r
+ \r
+ @retval EFI_SUCCESS The boot option is deleted successfully.\r
+\r
+**/\r
EFI_STATUS\r
+EFIAPI\r
BdsDeleteBootOption (\r
IN UINTN OptionNumber,\r
IN OUT UINT16 *BootOrder,\r
@param Device SimpleFileSystem device handle\r
@param FileName File name for the image\r
@param DosHeader Pointer to dos header\r
- @param ImageHeader Pointer to image header\r
- @param OptionalHeader Pointer to optional header\r
+ @param Hdr The buffer in which to return the PE32, PE32+, or TE header.\r
\r
@retval EFI_SUCCESS Successfully get the machine type.\r
@retval EFI_NOT_FOUND The file is not found.\r
@param HardDriveDevicePath A device path which starts with a hard drive media\r
device path.\r
\r
- @retval TRUE There is a matched device path instance FALSE\r
- -There is no matched device path instance\r
+ @retval TRUE There is a matched device path instance.\r
+ @retval FALSE There is no matched device path instance.\r
\r
**/\r
BOOLEAN\r
\r
@param DevicePath Device Path to a bootable device\r
\r
- @retval NULL The device path points to an EFI bootable Media\r
@retval NULL The media on the DevicePath is not bootable\r
\r
**/\r
Check whether the Device path in a boot option point to a valide bootable device,\r
And if CheckMedia is true, check the device is ready to boot now.\r
\r
- DevPath -- the Device path in a boot option\r
- CheckMedia -- if true, check the device is ready to boot now.\r
+ @param DevPath the Device path in a boot option\r
+ @param CheckMedia if true, check the device is ready to boot now.\r
\r
- @return TRUE -- the Device path is valide\r
- @return FALSE -- the Device path is invalide .\r
+ @retval TRUE the Device path is valide\r
+ @retval FALSE the Device path is invalide .\r
\r
**/\r
BOOLEAN\r
);\r
\r
/**\r
- For a bootable Device path, return its boot type\r
+ For a bootable Device path, return its boot type.\r
\r
@param DevicePath The bootable device Path to check\r
\r
\r
\r
/**\r
- This routine register a function to adjust the different type memory page number just before booting\r
- and save the updated info into the variable for next boot to use\r
+ This routine register a function to adjust the different type memory page number\r
+ just before booting and save the updated info into the variable for next boot to use.\r
\r
**/\r
VOID\r
@param HostControllerPI Uhci (0x00) or Ehci (0x20) or Both uhci and ehci\r
(0xFF)\r
@param RemainingDevicePath a short-form device path that starts with the first\r
- element being a USB WWID or a USB Class device\r
+ element being a USB WWID or a USB Class device\r
path\r
\r
- @return EFI_INVALID_PARAMETER\r
- @return EFI_SUCCESS\r
- @return EFI_NOT_FOUND\r
+ @retval EFI_SUCCESS The specific Usb device is connected successfully.\r
+ @retval EFI_INVALID_PARAMETER Invalid HostControllerPi (not 0x00, 0x20 or 0xFF) \r
+ or RemainingDevicePath is not the USB class device path.\r
+ @retval EFI_NOT_FOUND The device specified by device path is not found.\r
\r
**/\r
EFI_STATUS\r
// The implementation of this function is provided by Platform code.\r
//\r
/**\r
- Convert Vendor device path to device name\r
+ Convert Vendor device path to device name.\r
\r
@param Str The buffer store device name\r
@param DevPath Pointer to vendor device path\r
\r
- @return When it return, the device name have been stored in *Str.\r
-\r
**/\r
VOID\r
EFIAPI\r
Concatenates a formatted unicode string to allocated pool.\r
The caller must free the resulting buffer.\r
\r
- @param Str Tracks the allocated pool, size in use, and amount of pool\r
- allocated.\r
+ @param Str Tracks the allocated pool, size in use, and amount of pool allocated.\r
@param fmt The format string\r
+ @param ... The data will be printed.\r
\r
@return Allocated buffer with the formatted string printed in it.\r
- @return The caller must free the allocated buffer. The buffer\r
- @return allocation is not packed.\r
+ The caller must free the allocated buffer.\r
+ The buffer allocation is not packed.\r
\r
**/\r
CHAR16 *\r
packet.\r
@param Pkt Pointer to the IP packet to be sent.\r
@param Sender The IP protocol instance used for sending.\r
- @param NotifyData\r
+ @param Context
+ @param NotifyData \r
@param Dest The destination IP address to send this packet to.\r
@param OverrideData The data to override some configuration of the IP\r
instance used for sending.\r
);
/**\r
- Add a new IP instance for sending data.\r
-\r
- @param IpIo Pointer to a IP_IO instance to add a new IP\r
- instance for sending purpose.\r
-\r
- @return Pointer to the created IP_IO_IP_INFO structure, NULL is failed.\r
+ Cancel the IP transmit token which wraps this Packet.\r
\r
+ @param IpIo Pointer to the IP_IO instance.\r
+ @param Packet Pointer to the packet to cancel.\r
+
**/
VOID
EFIAPI
typedef UINT32 TCP_SEQNO;
typedef UINT16 TCP_PORTNO;
-enum {
+typedef enum {
NET_ETHER_ADDR_LEN = 6,
NET_IFTYPE_ETHERNET = 0x01,
IP4_ADDR_CLASSE,
IP4_MASK_NUM = 33
-};
+} IP4_CLASS_TYPE;
#pragma pack(1)
);
/**
- Insert the NewEntry after the PrevEntry
+ Insert the NewEntry after the PrevEntry.
@param PrevEntry The previous entry to insert after
@param NewEntry The new entry to insert
);
/**
- Insert the NewEntry before the PostEntry
+ Insert the NewEntry before the PostEntry.
@param PostEntry The entry to insert before
@param NewEntry The new entry to insert
);
/**
- Remove the first entry on the netmap
+ Remove the first entry on the netmap.
@param Map The netmap to remove the head from
@param Value The variable to receive the value if not NULL
);
/**
- Remove the last entry on the netmap
+ Remove the last entry on the netmap.
@param Map The netmap to remove the tail from
@param Value The variable to receive the value if not NULL
/**
Create a child of the service that is identified by ServiceBindingGuid.
- @param Controller The controller which has the service installed.
- @param Image The image handle used to open service.
+ @param ControllerHandle The controller which has the service installed.
+ @param ImageHandle The image handle used to open service.
@param ServiceBindingGuid The service's Guid.
@param ChildHandle The handle to receive the create child
/**
Destory a child of the service that is identified by ServiceBindingGuid.
- @param Controller The controller which has the service installed.
- @param Image The image handle used to open service.
+ @param ControllerHandle The controller which has the service installed.
+ @param ImageHandle The image handle used to open service.
@param ServiceBindingGuid The service's Guid.
@param ChildHandle The child to destory
/**
Add a Deferred Procedure Call to the end of the DPC queue.
- @DpcTpl The EFI_TPL that the DPC should be invoked.
- @DpcProcedure Pointer to the DPC's function.
- @DpcContext Pointer to the DPC's context. Passed to DpcProcedure
- when DpcProcedure is invoked.
+ @param DpcTpl The EFI_TPL that the DPC should be invoked.
+ @param DpcProcedure Pointer to the DPC's function.
+ @param DpcContext Pointer to the DPC's context. Passed to DpcProcedure
+ when DpcProcedure is invoked.
@retval EFI_SUCCESS The DPC was queued.
@retval EFI_INVALID_PARAMETER DpcTpl is not a valid EFI_TPL.
VOID
);
-/**
- The constructor function caches the pointer to DPC protocol.
-
- The constructor function locates DPC protocol from protocol database.
- It will ASSERT() if that operation fails and it will always return EFI_SUCCESS.
-
- @param ImageHandle The firmware allocated handle for the EFI image.
- @param SystemTable A pointer to the EFI System Table.
-
- @retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.
-
+/**\r
+ This is the default unload handle for all the network drivers.\r
+\r
+ @param ImageHandle The drivers' driver image.\r
+\r
+ @retval EFI_SUCCESS The image is unloaded.\r
+ @retval Others Failed to unload the image.\r
+\r
**/
EFI_STATUS
EFIAPI
IN EFI_HANDLE ImageHandle
);
-enum {
+typedef enum {
//
//Various signatures
//
NET_BUF_HEAD = 1, // Trim or allocate space from head
NET_BUF_TAIL = 0, // Trim or allocate space from tail
NET_VECTOR_OWN_FIRST = 0x01 // We allocated the 1st block in the vector
-};
+} NET_SIGNATURE_TYPE;
#define NET_CHECK_SIGNATURE(PData, SIGNATURE) \
ASSERT (((PData) != NULL) && ((PData)->Signature == (SIGNATURE)))
IN UINT8 *Dest
);
-/**
- Copy some data from the buffer queue to the destination.
-
- @param NbufQue Pointer to the net buffer queue.
- @param Offset The sequence number of the first byte to copy.
- @param Len Length of the data to copy.
- @param Dest The destination of the data to copy to.
-
- @retval UINTN The length of the copied data.
-
+/**\r
+ Trim some data from the queue header, release the buffer if\r
+ whole buffer is trimmed.\r
+\r
+ @param NbufQue Pointer to the net buffer queue.\r
+ @param Len Length of the data to trim.\r
+\r
+ @retval UINTN The length of the data trimmed.\r
+\r
**/
UINT32
EFIAPI
-/** @file
-
-Copyright (c) 2007, Intel Corporation
-All rights reserved. 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
-http://opensource.org/licenses/bsd-license.php
-
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
-Module Name:
-
- PlatDriOverLib.h
-
-Abstract:
-
-
-**/
-
-#ifndef _PLAT_DRI_OVER_LIB_H_
-#define _PLAT_DRI_OVER_LIB_H_
-
-#include <PiDxe.h>
-#include <Protocol/PlatformDriverOverride.h>
-#include <Protocol/DevicePath.h>
-#include <Protocol/DriverBinding.h>
-#include <Library/BaseLib.h>
-
-#include <VariableFormat.h>
-
+/** @file\r
+\r
+ This library provides basic platform driver override functions.\r
+\r
+Copyright (c) 2007 - 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
+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
+\r
+**/\r
+\r
+#ifndef _PLAT_DRI_OVER_LIB_H_\r
+#define _PLAT_DRI_OVER_LIB_H_\r
+\r
+#include <PiDxe.h>\r
+#include <Protocol/PlatformDriverOverride.h>\r
+#include <Protocol/DevicePath.h>\r
+#include <Protocol/DriverBinding.h>\r
+#include <Library/BaseLib.h>\r
+\r
+#include <VariableFormat.h>\r
+\r
/**\r
Install the Platform Driver Override Protocol, and ensure there is only one Platform Driver Override Protocol\r
in the system.\r
\r
@retval EFI_ALREADY_STARTED There has been a Platform Driver Override\r
Protocol in the system, cannot install it again.\r
- @retval Other Returned by InstallProtocolInterface\r
-\r
-**/
-EFI_STATUS
-EFIAPI
-InstallPlatformDriverOverrideProtocol (
- EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL *gPlatformDriverOverride
- );
-
+ @retval EFI_SUCCESS The protocol is installed successfully.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InstallPlatformDriverOverrideProtocol (\r
+ EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL *gPlatformDriverOverride\r
+ );\r
+\r
/**\r
- Free all the mapping database memory resource and initialize the mapping list entry\r
+ Free all the mapping database memory resource and initialize the mapping list entry.\r
\r
@param MappingDataBase Mapping database list entry pointer\r
\r
@retval EFI_INVALID_PARAMETER mapping database list entry is NULL\r
@retval EFI_SUCCESS Free success\r
\r
-**/
-EFI_STATUS
-EFIAPI
-FreeMappingDatabase (
- IN OUT LIST_ENTRY *MappingDataBase
- );
-
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+FreeMappingDatabase (\r
+ IN OUT LIST_ENTRY *MappingDataBase\r
+ );\r
+\r
/**\r
Read the environment variable(s) that contain the override mappings from Controller Device Path to\r
a set of Driver Device Paths, and create the mapping database in memory with those variable info.\r
- VariableLayout{\r
- //\r
- // NotEnd indicate whether the variable is the last one, and has no subsequent variable need to load.\r
- // Each variable has MaximumVariableSize limitation, so we maybe need multi variables to store\r
- // large mapping infos.\r
- // The variable(s) name rule is PlatDriOver, PlatDriOver1, PlatDriOver2, ....\r
- //\r
- UINT32 NotEnd;\r
- //\r
- // The entry which contains the mapping that Controller Device Path to a set of Driver Device Paths\r
- // There are often multi mapping entries in a variable.\r
- //\r
- UINT32 SIGNATURE; //EFI_SIGNATURE_32('p','d','o','i')\r
- UINT32 DriverNum;\r
- EFI_DEVICE_PATH_PROTOCOL ControllerDevicePath[];\r
- EFI_DEVICE_PATH_PROTOCOL DriverDevicePath[];\r
- EFI_DEVICE_PATH_PROTOCOL DriverDevicePath[];\r
- EFI_DEVICE_PATH_PROTOCOL DriverDevicePath[];\r
- ......\r
- UINT32 SIGNATURE;\r
- UINT32 DriverNum;\r
- EFI_DEVICE_PATH_PROTOCOL ControllerDevicePath[];\r
- EFI_DEVICE_PATH_PROTOCOL DriverDevicePath[];\r
- EFI_DEVICE_PATH_PROTOCOL DriverDevicePath[];\r
- EFI_DEVICE_PATH_PROTOCOL DriverDevicePath[];\r
- ......\r
- }\r
- typedef struct _PLATFORM_OVERRIDE_ITEM{\r
- UINTN Signature; //EFI_SIGNATURE_32('p','d','o','i')\r
- LIST_ENTRY Link;\r
- UINT32 DriverInfoNum;\r
- EFI_DEVICE_PATH_PROTOCOL *ControllerDevicePath;\r
- LIST_ENTRY DriverInfoList; //DRIVER_IMAGE_INFO List\r
- } PLATFORM_OVERRIDE_ITEM;\r
- typedef struct _DRIVER_IMAGE_INFO{\r
- UINTN Signature; //EFI_SIGNATURE_32('p','d','i','i')\r
- LIST_ENTRY Link;\r
- EFI_HANDLE ImageHandle;\r
- EFI_DEVICE_PATH_PROTOCOL *DriverImagePath;\r
- BOOLEAN UnLoadable;\r
- BOOLEAN UnStartable;\r
- } DRIVER_IMAGE_INFO;\r
\r
@param MappingDataBase Mapping database list entry pointer\r
\r
@retval EFI_INVALID_PARAMETER MappingDataBase pointer is null\r
@retval EFI_NOT_FOUND Cannot find the 'PlatDriOver' NV variable\r
@retval EFI_VOLUME_CORRUPTED The found NV variable is corrupted\r
- @retval EFI_SUCCESS Create the mapping database in memory\r
- successfully\r
-\r
-**/
-EFI_STATUS
-EFIAPI
-InitOverridesMapping (
- OUT LIST_ENTRY *MappingDataBase
- );
-
+ @retval EFI_SUCCESS Create the mapping database in memory successfully\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InitOverridesMapping (\r
+ OUT LIST_ENTRY *MappingDataBase\r
+ );\r
+\r
/**\r
- Save the memory mapping database into NV environment variable(s)\r
+ Save the memory mapping database into NV environment variable(s).\r
\r
@param MappingDataBase Mapping database list entry pointer\r
\r
@retval EFI_INVALID_PARAMETER MappingDataBase pointer is null\r
@retval EFI_SUCCESS Save memory mapping database successfully\r
\r
-**/
-EFI_STATUS
-EFIAPI
-SaveOverridesMapping (
- IN LIST_ENTRY *MappingDataBase
- );
-
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+SaveOverridesMapping (\r
+ IN LIST_ENTRY *MappingDataBase\r
+ );\r
+\r
/**\r
Retrieves the image handle of the platform override driver for a controller in the system from the memory mapping database.\r
\r
- @param This A pointer to the\r
- EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL instance.\r
+ @param This A pointer to the EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL instance.\r
@param ControllerHandle The device handle of the controller to check if\r
a driver override exists.\r
@param DriverImageHandle On output, a pointer to the next driver handle.\r
@retval EFI_SUCCESS The driver override for ControllerHandle was\r
returned in DriverImagePath.\r
\r
-**/
-EFI_STATUS
-EFIAPI
-GetDriverFromMapping (
- IN EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL * This,
- IN EFI_HANDLE ControllerHandle,
- IN OUT EFI_HANDLE * DriverImageHandle,
- IN LIST_ENTRY * MappingDataBase,
- IN EFI_HANDLE CallerImageHandle
- );
-
-EFI_STATUS
-EFIAPI
-DeleteOverridesVariables (
- VOID
- );
-
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+GetDriverFromMapping (\r
+ IN EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL * This,\r
+ IN EFI_HANDLE ControllerHandle,\r
+ IN OUT EFI_HANDLE * DriverImageHandle,\r
+ IN LIST_ENTRY * MappingDataBase,\r
+ IN EFI_HANDLE CallerImageHandle\r
+ );\r
+\r
+/**\r
+ Deletes all environment variable(s) that contain the override mappings from Controller Device Path to\r
+ a set of Driver Device Paths.\r
+\r
+ @retval EFI_SUCCESS Delete all variable(s) successfully.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+DeleteOverridesVariables (\r
+ VOID\r
+ );\r
+\r
/**\r
Check mapping database whether already has the mapping info which\r
records the input Controller to input DriverImage.\r
- If has, the controller's total override driver number and input DriverImage's order number is return.\r
\r
- @param ControllerDevicePath The controller device path need to add a\r
- override driver image item\r
- @param DriverImageDevicePath The driver image device path need to be insert\r
+ @param ControllerDevicePath The controller device path is to be check.\r
+ @param DriverImageDevicePath The driver image device path is to be check.\r
@param MappingDataBase Mapping database list entry pointer\r
@param DriverInfoNum the controller's total override driver number\r
- @param DriverImageNO The inserted order number\r
-\r
- @return EFI_INVALID_PARAMETER\r
- @return EFI_NOT_FOUND\r
- @return EFI_SUCCESS\r
-\r
-**/
-EFI_STATUS
-EFIAPI
-CheckMapping (
- IN EFI_DEVICE_PATH_PROTOCOL *ControllerDevicePath,
- IN EFI_DEVICE_PATH_PROTOCOL *DriverImageDevicePath,
- IN LIST_ENTRY * MappingDataBase,
- OUT UINT32 *DriverInfoNum,
- OUT UINT32 *DriverImageNO
- );
-
+ @param DriverImageNO The driver order number for the input DriverImage.\r
+ If the DriverImageDevicePath is NULL, DriverImageNO is not set.\r
+\r
+ @retval EFI_INVALID_PARAMETER ControllerDevicePath or MappingDataBase is NULL.\r
+ @retval EFI_NOT_FOUND ControllerDevicePath is not found in MappingDataBase or\r
+ DriverImageDevicePath is not found in the found DriverImage Info list. \r
+ @retval EFI_SUCCESS The controller's total override driver number and \r
+ input DriverImage's order number is correctly return.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+CheckMapping (\r
+ IN EFI_DEVICE_PATH_PROTOCOL *ControllerDevicePath,\r
+ IN EFI_DEVICE_PATH_PROTOCOL *DriverImageDevicePath,\r
+ IN LIST_ENTRY * MappingDataBase,\r
+ OUT UINT32 *DriverInfoNum,\r
+ OUT UINT32 *DriverImageNO\r
+ );\r
+\r
/**\r
Insert a driver image as a controller's override driver into the mapping database.\r
The driver image's order number is indicated by DriverImageNO.\r
override driver image item\r
@param DriverImageDevicePath The driver image device path need to be insert\r
@param MappingDataBase Mapping database list entry pointer\r
- @param DriverImageNO The inserted order number\r
-\r
- @return EFI_INVALID_PARAMETER\r
- @return EFI_ALREADY_STARTED\r
- @return EFI_SUCCESS\r
-\r
-**/
-EFI_STATUS
-EFIAPI
-InsertDriverImage (
- IN EFI_DEVICE_PATH_PROTOCOL *ControllerDevicePath,
- IN EFI_DEVICE_PATH_PROTOCOL *DriverImageDevicePath,
- IN LIST_ENTRY *MappingDataBase,
- IN UINT32 DriverImageNO
- );
-
+ @param DriverImageNO The inserted order number. If this number is taken, \r
+ the larger available number will be used.\r
+\r
+ @retval EFI_INVALID_PARAMETER ControllerDevicePath is NULL, or DriverImageDevicePath is NULL\r
+ or MappingDataBase is NULL\r
+ @retval EFI_ALREADY_STARTED The input Controller to input DriverImage has been \r
+ recorded into the mapping database.\r
+ @retval EFI_SUCCESS The Controller and DriverImage are inserted into \r
+ the mapping database successfully.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InsertDriverImage (\r
+ IN EFI_DEVICE_PATH_PROTOCOL *ControllerDevicePath,\r
+ IN EFI_DEVICE_PATH_PROTOCOL *DriverImageDevicePath,\r
+ IN LIST_ENTRY *MappingDataBase,\r
+ IN UINT32 DriverImageNO\r
+ );\r
+\r
/**\r
Delete a controller's override driver from the mapping database.\r
\r
- @param ControllerDevicePath The controller device path need to add a\r
- override driver image item\r
- @param DriverImageDevicePath The driver image device path need to be insert\r
+ @param ControllerDevicePath The controller device path will be deleted \r
+ when all drivers images on it are removed.\r
+ @param DriverImageDevicePath The driver image device path will be delete.\r
+ If NULL, all driver image will be delete.\r
@param MappingDataBase Mapping database list entry pointer\r
- @param DriverImageNO The inserted order number\r
-\r
- @return EFI_INVALID_PARAMETER\r
- @return EFI_NOT_FOUND\r
- @return EFI_SUCCESS\r
-\r
-**/
-EFI_STATUS
-EFIAPI
-DeleteDriverImage (
- IN EFI_DEVICE_PATH_PROTOCOL *ControllerDevicePath,
- IN EFI_DEVICE_PATH_PROTOCOL *DriverImageDevicePath,
- IN LIST_ENTRY *MappingDataBase
- );
-
+\r
+ @retval EFI_INVALID_PARAMETER ControllerDevicePath is NULL, or MappingDataBase is NULL\r
+ @retval EFI_NOT_FOUND ControllerDevicePath is not found in MappingDataBase or\r
+ DriverImageDevicePath is not found in the found DriverImage Info list. \r
+ @retval EFI_SUCCESS Delete the specified driver successfully.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+DeleteDriverImage (\r
+ IN EFI_DEVICE_PATH_PROTOCOL *ControllerDevicePath,\r
+ IN EFI_DEVICE_PATH_PROTOCOL *DriverImageDevicePath,\r
+ IN LIST_ENTRY *MappingDataBase\r
+ );\r
+\r
/**\r
Get the first Binding protocol which has the specific image handle\r
\r
- @param Image Image handle\r
+ @param ImageHandle The Image handle\r
+ @param BindingHandle The BindingHandle of the found Driver Binding protocol.\r
+ If Binding protocol is not found, it is set to NULL. \r
\r
- @return Pointer into the Binding Protocol interface\r
+ @return Pointer into the Binding Protocol interface\r
+ @retval NULL The paramter is not valid or the binding protocol is not found.\r
\r
**/\r
EFI_DRIVER_BINDING_PROTOCOL *\r
GetBindingProtocolFromImageHandle (\r
IN EFI_HANDLE ImageHandle,\r
OUT EFI_HANDLE *BindingHandle\r
- );
-
-#endif
+ );\r
+\r
+#endif\r
\r
@param PrivateData The EFI_BDS_ARCH_PROTOCOL_INSTANCE instance\r
\r
- @return None.\r
-\r
**/\r
VOID\r
EFIAPI\r
@param ExitData Exit data returned from failed boot.\r
@param ExitDataSize Exit data size returned from failed boot.\r
\r
- @return None.\r
-\r
**/\r
VOID\r
EFIAPI\r
The flash layout is platform specific.\r
\r
@retval EFI_SUCCESS The non-updatable flash areas.\r
- @retval Others Some error occurs when locking non-updatable flash areas.\r
**/\r
EFI_STATUS\r
EFIAPI\r
typedef struct _UDP_IO_PORT UDP_IO_PORT;
-enum {
+typedef enum {
UDP_IO_RX_SIGNATURE = EFI_SIGNATURE_32 ('U', 'D', 'P', 'R'),
UDP_IO_TX_SIGNATURE = EFI_SIGNATURE_32 ('U', 'D', 'P', 'T'),
UDP_IO_SIGNATURE = EFI_SIGNATURE_32 ('U', 'D', 'P', 'I')
-};
+} UDP_IO_SIGNATURE_TYPE;
typedef struct {
IP4_ADDR LocalAddr;
@param Controller The controller that has the UDP service binding
protocol installed.
- @param Image The image handle for the driver.
+ @param ImageHandle The image handle for the driver.
@param Configure The function to configure the created UDP child
@param Context The opaque parameter for the Configure funtion.
IN VOID *Context
);
-/**
- The selection function to cancel a single sent datagram.
-
- @param Token The UDP TX token to test againist.
- @param Context The context
-
- @return TRUE if the packet is to be cancelled, otherwise FALSE.
-
+/**\r
+ Cancel a single sent datagram.\r
+\r
+ @param UdpIo The UDP IO port to cancel the packet from\r
+ @param Packet The packet to cancel\r
+\r
+ @return None\r
+\r
**/
VOID
EFIAPI
\r
**/\r
\r
-#ifndef _MDEMODULE_HII_H\r
-#define _MDEMODULE_HII_H\r
+#ifndef __MDEMODULE_HII_H__\r
+#define __MDEMODULE_HII_H__\r
\r
#define NARROW_CHAR 0xFFF0\r
#define WIDE_CHAR 0xFFF1\r
/** @file\r
- Pei memory test PPI used to Perform memory test in PEI phase.\r
+ This file defines Pei memory test PPI used to Perform memory test in PEI phase.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
All rights reserved. This program and the accompanying materials\r
\r
typedef struct _PEI_BASE_MEMORY_TEST_PPI PEI_BASE_MEMORY_TEST_PPI;\r
\r
+//\r
+// 4 different test operations\r
+// Ignore op not test memory, Quick and Sparse op test memory quickly, Extensive op test memory detailedly.\r
+//\r
typedef enum {\r
Ignore,\r
Quick,\r
Extensive\r
} PEI_MEMORY_TEST_OP;\r
\r
+/**\r
+ Test a range memory space is ready to read and write.\r
+\r
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+ @param This Pointer to Pei memory test PPI instance.\r
+ @param BeginAddress Beginning of the memory address to be checked.\r
+ @param MemoryLength Bytes of memory range to be checked.\r
+ @param Operation Type of memory check operation to be performed.\r
+ @param ErrorAddress Address which has error when checked.\r
+\r
+ @retval EFI_SUCCESS Memory range pass basic read and write test.\r
+ @retval EFI_DEVICE_ERROR Memory is not ready to access.\r
+**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *PEI_BASE_MEMORY_TEST) (\r
EFI_STATUS\r
(EFIAPI *PEI_GET_FLASH_AREA_INFO) (\r
IN EFI_PEI_SERVICES **PeiServices,\r
- IN PEI_FLASH_MAP_PPI *This,\r
+ IN PEI_FLASH_MAP_PPI *This,\r
IN EFI_FLASH_AREA_TYPE AreaType,\r
IN EFI_GUID *AreaTypeGuid,\r
OUT UINT32 *NumEntries,\r
/** @file\r
- PPI published by the PEIM that is responsible for detecting operator presence.\r
+ This file defines OperatorPresent PPI responsible for detecting TPM operator presence.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
All rights reserved. This program and the accompanying materials\r
/** @file\r
\r
- Capsule Architectural Protocol is added to produce UEFI2.0 capsule runtime services.\r
+ Capsule Architectural Protocol is responsible to tag UEFI2.0 capsule runtime services\r
+ are ready in EFI_RUNTIME_SERVICES.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
-/*++ \r
+/** @file\r
\r
-Copyright (c) 2006 - 2007, Intel Corporation \r
+ This protocol provides the interfaces to Get/Set the current video mode for GOP/UGA screen\r
+\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
-Module Name:\r
-\r
- ConsoleControl.h\r
-\r
-Abstract:\r
-\r
- Abstraction of a Text mode or GOP/UGA screen\r
-\r
---*/\r
+**/\r
\r
#ifndef __CONSOLE_CONTROL_H__\r
#define __CONSOLE_CONTROL_H__\r
EfiConsoleControlScreenMaxValue\r
} EFI_CONSOLE_CONTROL_SCREEN_MODE;\r
\r
+/**\r
+ Return the current video mode information. Also returns info about existence\r
+ of Graphics Output devices or UGA Draw devices in system, and if the Std In device is locked. All the\r
+ arguments are optional and only returned if a non NULL pointer is passed in.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param Mode Are we in text of grahics mode.\r
+ @param GopExists TRUE if GOP Spliter has found a GOP/UGA device\r
+ @param StdInLocked TRUE if StdIn device is keyboard locked\r
\r
+ @retval EFI_SUCCESS Video mode information is returned.\r
+ @retval EFI_INVALID_PARAMETER Invalid parameters if Mode == NULL.\r
+\r
+**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_CONSOLE_CONTROL_PROTOCOL_GET_MODE) (\r
OUT BOOLEAN *GopUgaExists, OPTIONAL \r
OUT BOOLEAN *StdInLocked OPTIONAL\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Return the current video mode information. Also returns info about existence\r
- of Graphics Output devices or UGA Draw devices in system, and if the Std In\r
- device is locked. All the arguments are optional and only returned if a non\r
- NULL pointer is passed in.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- Mode - Are we in text of grahics mode.\r
- GopUgaExists - TRUE if Console Spliter has found a GOP or UGA device\r
- StdInLocked - TRUE if StdIn device is keyboard locked\r
+;\r
\r
- Returns:\r
- EFI_SUCCESS - Mode information returned.\r
+/**\r
+ Set the current video mode to either text or graphics. \r
\r
---*/\r
-;\r
+ @param This Protocol instance pointer.\r
+ @param Mode Mode is to be set.\r
\r
+ @retval EFI_SUCCESS Mode is set.\r
+ @retval EFI_INVALID_PARAMETER Mode is not the valid mode value.\r
+ @retval EFI_UNSUPPORTED Mode is unsupported by console device.\r
\r
+**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_CONSOLE_CONTROL_PROTOCOL_SET_MODE) (\r
IN EFI_CONSOLE_CONTROL_PROTOCOL *This,\r
OUT EFI_CONSOLE_CONTROL_SCREEN_MODE Mode\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Set the current mode to either text or graphics. Graphics is\r
- for Quiet Boot.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- Mode - Mode to set the \r
-\r
- Returns:\r
- EFI_SUCCESS - Mode information returned.\r
-\r
---*/\r
;\r
\r
+/**\r
+ Copy the Password and enable state variable and then arm the periodic timer\r
+\r
+ @retval EFI_SUCCESS Lock the StdIn device\r
+ @retval EFI_INVALID_PARAMETER Password is NULL\r
+ @retval EFI_OUT_OF_RESOURCES Buffer allocation to store the big password fails\r
\r
+**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_CONSOLE_CONTROL_PROTOCOL_LOCK_STD_IN) (\r
IN EFI_CONSOLE_CONTROL_PROTOCOL *This,\r
IN CHAR16 *Password\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Lock Std In devices until Password is typed.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- Password - Password needed to unlock screen. NULL means unlock keyboard\r
-\r
- Returns:\r
- EFI_SUCCESS - Mode information returned.\r
- EFI_DEVICE_ERROR - Std In not locked\r
-\r
---*/\r
;\r
\r
-\r
-\r
struct _EFI_CONSOLE_CONTROL_PROTOCOL {\r
EFI_CONSOLE_CONTROL_PROTOCOL_GET_MODE GetMode;\r
EFI_CONSOLE_CONTROL_PROTOCOL_SET_MODE SetMode;\r
/** @file\r
- This protocol implements a FV section extraction using a CRC32 encapsulation.\r
\r
- The GUID defins the encapsulation scheme and the data structures come from\r
- the SectionExtraction protocol definition.\r
+ This file can define the different guids to specify the different \r
+ encapsulation scheme for the guided section.\r
+ Now, only one guid is defined for CRC32 encapsulation scheme.\r
+ The related data structures come from the SectionExtraction protocol definition.\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
#define EFI_CRC32_GUIDED_SECTION_EXTRACTION_PROTOCOL_GUID \\r
{ 0xFC1BCDB0, 0x7D31, 0x49aa, {0x93, 0x6A, 0xA4, 0x60, 0x0D, 0x9D, 0xD0, 0x83 } }\r
\r
-//\r
-// Forward reference for pure ANSI compatability\r
-//\r
-typedef struct _EFI_CRC32_GUIDED_SECTION_EXTRACTION_PROTOCOL EFI_CRC32_GUID_SECTION_EXTRACTION_PROTOCOL;\r
-\r
//\r
// The data structures are the same as GuidedSectionExtraction protocol only the GUID's are different\r
//\r
+++ /dev/null
-/** @file\r
- \r
- The user Customized Decompress Protocol Interface\r
-\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
-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
-\r
-**/\r
-\r
-#ifndef __CUSTOMIZED_DECOMPRESS_H__\r
-#define __CUSTOMIZED_DECOMPRESS_H__\r
-\r
-#define EFI_CUSTOMIZED_DECOMPRESS_PROTOCOL_GUID \\r
- { 0x9a44198e, 0xa4a2, 0x44e6, {0x8a, 0x1f, 0x39, 0xbe, 0xfd, 0xac, 0x89, 0x6f } }\r
-\r
-typedef struct _EFI_CUSTOMIZED_DECOMPRESS_PROTOCOL EFI_CUSTOMIZED_DECOMPRESS_PROTOCOL;\r
-\r
-/**\r
-\r
- The GetInfo() function retrieves the size of the uncompressed buffer \r
- and the temporary scratch buffer required to decompress the buffer \r
- specified by Source and SourceSize. If the size of the uncompressed\r
- buffer or the size of the scratch buffer cannot be determined from \r
- the compressed data specified by Source and SourceData, then \r
- EFI_INVALID_PARAMETER is returned. Otherwise, the size of the uncompressed\r
- buffer is returned in DestinationSize, the size of the scratch buffer is \r
- returned in ScratchSize, and EFI_SUCCESS is returned.\r
- \r
- The GetInfo() function does not have scratch buffer available to perform \r
- a thorough checking of the validity of the source data. It just retrieves\r
- the 'Original Size' field from the beginning bytes of the source data and\r
- output it as DestinationSize. And ScratchSize is specific to the decompression\r
- implementation.\r
-\r
- @param This The protocol instance pointer\r
- @param Source The source buffer containing the compressed data.\r
- @param SourceSize The size, in bytes, of source buffer.\r
- @param DestinationSize A pointer to the size, in bytes, of the uncompressed buffer\r
- that will be generated when the compressed buffer specified \r
- by Source and SourceSize is decompressed.\r
- @param ScratchSize A pointer to the size, in bytes, of the scratch buffer that \r
- is required to decompress the compressed buffer specified by\r
- Source and SourceSize.\r
-\r
- @retval EFI_SUCCESS The size of the uncompressed data was returned in DestinationSize\r
- and the size of the scratch buffer was returned in ScratchSize.\r
- @retval EFI_INVALID_PARAMETER \r
- The size of the uncompressed data or the size of the scratch\r
- buffer cannot be determined from the compressed data specified by \r
- Source and SourceData.\r
-\r
---*/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_CUSTOMIZED_DECOMPRESS_GET_INFO) (\r
- IN EFI_CUSTOMIZED_DECOMPRESS_PROTOCOL *This,\r
- IN VOID *Source,\r
- IN UINT32 SourceSize,\r
- OUT UINT32 *DestinationSize,\r
- OUT UINT32 *ScratchSize\r
- );\r
-\r
-/**\r
-\r
- The Decompress() function extracts decompressed data to its original form.\r
- \r
- This protocol is designed so that the decompression algorithm can be \r
- implemented without using any memory services. As a result, the \r
- Decompress() function is not allowed to call AllocatePool() or \r
- AllocatePages() in its implementation. It is the caller's responsibility \r
- to allocate and free the Destination and Scratch buffers.\r
- \r
- If the compressed source data specified by Source and SourceSize is \r
- sucessfully decompressed into Destination, then EFI_SUCCESS is returned. \r
- If the compressed source data specified by Source and SourceSize is not in \r
- a valid compressed data format, then EFI_INVALID_PARAMETER is returned.\r
-\r
- @param This The protocol instance pointer\r
- @param Source The source buffer containing the compressed data.\r
- @param SourceSize The size of source data.\r
- @param Destination On output, the destination buffer that contains \r
- the uncompressed data.\r
- @param DestinationSize The size of destination buffer. The size of destination\r
- buffer needed is obtained from GetInfo().\r
- @param Scratch A temporary scratch buffer that is used to perform the \r
- decompression.\r
- @param ScratchSize The size of scratch buffer. The size of scratch buffer needed\r
- is obtained from GetInfo().\r
-\r
- @retval EFI_SUCCESS Decompression completed successfully, and the uncompressed \r
- buffer is returned in Destination.\r
- @retval EFI_INVALID_PARAMETER \r
- The source buffer specified by Source and SourceSize is \r
- corrupted (not in a valid compressed format).\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_CUSTOMIZED_DECOMPRESS_DECOMPRESS) (\r
- IN EFI_CUSTOMIZED_DECOMPRESS_PROTOCOL *This,\r
- IN VOID* Source,\r
- IN UINT32 SourceSize,\r
- IN OUT VOID* Destination,\r
- IN UINT32 DestinationSize,\r
- IN OUT VOID* Scratch,\r
- IN UINT32 ScratchSize\r
- );\r
-\r
-struct _EFI_CUSTOMIZED_DECOMPRESS_PROTOCOL {\r
- EFI_CUSTOMIZED_DECOMPRESS_GET_INFO GetInfo;\r
- EFI_CUSTOMIZED_DECOMPRESS_DECOMPRESS Decompress;\r
-};\r
-\r
-extern EFI_GUID gEfiCustomizedDecompressProtocolGuid;\r
-\r
-#endif\r
-/*++\r
+/** @file\r
\r
-Copyright (c) 2007, Intel Corporation\r
+ EFI Deferred Procedure Call Protocol\r
+\r
+Copyright (c) 2007 - 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
-Module Name:\r
-\r
- Dpc.h\r
-\r
-Abstract:\r
-\r
- EFI Deferred Procedure Call Protocol\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
\r
\r
#ifndef __DPC_H__\r
+++ /dev/null
-/** @file\r
-\r
- The Tiano Decompress Protocol Interface\r
-\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
-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
-\r
-**/\r
-\r
-#ifndef __EDK_DECOMPRESS_H__\r
-#define __EDK_DECOMPRESS_H__\r
-\r
-#define EFI_TIANO_DECOMPRESS_PROTOCOL_GUID \\r
- { 0xe84cf29c, 0x191f, 0x4eae, {0x96, 0xe1, 0xf4, 0x6a, 0xec, 0xea, 0xea, 0x0b } }\r
-\r
-typedef struct _EFI_TIANO_DECOMPRESS_PROTOCOL EFI_TIANO_DECOMPRESS_PROTOCOL;\r
-\r
-/**\r
-\r
- The GetInfo() function retrieves the size of the uncompressed buffer \r
- and the temporary scratch buffer required to decompress the buffer \r
- specified by Source and SourceSize. If the size of the uncompressed\r
- buffer or the size of the scratch buffer cannot be determined from \r
- the compressed data specified by Source and SourceData, then \r
- EFI_INVALID_PARAMETER is returned. Otherwise, the size of the uncompressed\r
- buffer is returned in DestinationSize, the size of the scratch buffer is \r
- returned in ScratchSize, and EFI_SUCCESS is returned.\r
- \r
- The GetInfo() function does not have scratch buffer available to perform \r
- a thorough checking of the validity of the source data. It just retrieves\r
- the 'Original Size' field from the beginning bytes of the source data and\r
- output it as DestinationSize. And ScratchSize is specific to the decompression\r
- implementation.\r
-\r
- @param This The protocol instance pointer\r
- @param Source The source buffer containing the compressed data.\r
- @param SourceSize The size, in bytes, of source buffer.\r
- @param DestinationSize A pointer to the size, in bytes, of the uncompressed buffer\r
- that will be generated when the compressed buffer specified \r
- by Source and SourceSize is decompressed.\r
- @param ScratchSize A pointer to the size, in bytes, of the scratch buffer that \r
- is required to decompress the compressed buffer specified by\r
- Source and SourceSize.\r
-\r
- @retval EFI_SUCCESS The size of the uncompressed data was returned in DestinationSize\r
- and the size of the scratch buffer was returned in ScratchSize.\r
- @retval EFI_INVALID_PARAMETER \r
- The size of the uncompressed data or the size of the scratch\r
- buffer cannot be determined from the compressed data specified by \r
- Source and SourceData.\r
-\r
---*/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_TIANO_DECOMPRESS_GET_INFO) (\r
- IN EFI_TIANO_DECOMPRESS_PROTOCOL *This,\r
- IN VOID *Source,\r
- IN UINT32 SourceSize,\r
- OUT UINT32 *DestinationSize,\r
- OUT UINT32 *ScratchSize\r
- );\r
-\r
-/**\r
-\r
- The Decompress() function extracts decompressed data to its original form.\r
- \r
- This protocol is designed so that the decompression algorithm can be \r
- implemented without using any memory services. As a result, the \r
- Decompress() function is not allowed to call AllocatePool() or \r
- AllocatePages() in its implementation. It is the caller's responsibility \r
- to allocate and free the Destination and Scratch buffers.\r
- \r
- If the compressed source data specified by Source and SourceSize is \r
- sucessfully decompressed into Destination, then EFI_SUCCESS is returned. \r
- If the compressed source data specified by Source and SourceSize is not in \r
- a valid compressed data format, then EFI_INVALID_PARAMETER is returned.\r
-\r
- @param This The protocol instance pointer\r
- @param Source The source buffer containing the compressed data.\r
- @param SourceSize The size of source data.\r
- @param Destination On output, the destination buffer that contains \r
- the uncompressed data.\r
- @param DestinationSize The size of destination buffer. The size of destination\r
- buffer needed is obtained from GetInfo().\r
- @param Scratch A temporary scratch buffer that is used to perform the \r
- decompression.\r
- @param ScratchSize The size of scratch buffer. The size of scratch buffer needed\r
- is obtained from GetInfo().\r
-\r
- @retval EFI_SUCCESS Decompression completed successfully, and the uncompressed \r
- buffer is returned in Destination.\r
- @retval EFI_INVALID_PARAMETER \r
- The source buffer specified by Source and SourceSize is \r
- corrupted (not in a valid compressed format).\r
-**/\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_TIANO_DECOMPRESS_DECOMPRESS) (\r
- IN EFI_TIANO_DECOMPRESS_PROTOCOL *This,\r
- IN VOID* Source,\r
- IN UINT32 SourceSize,\r
- IN OUT VOID* Destination,\r
- IN UINT32 DestinationSize,\r
- IN OUT VOID* Scratch,\r
- IN UINT32 ScratchSize\r
- );\r
-\r
-struct _EFI_TIANO_DECOMPRESS_PROTOCOL {\r
- EFI_TIANO_DECOMPRESS_GET_INFO GetInfo;\r
- EFI_TIANO_DECOMPRESS_DECOMPRESS Decompress;\r
-};\r
-\r
-extern EFI_GUID gEfiTianoDecompressProtocolGuid;\r
-\r
-#endif\r
/** @file\r
- This is a simple fault tolerant write driver, based on PlatformFd library.\r
- And it only supports write BufferSize <= SpareAreaLength.\r
+ Fault tolerant write lite protocol defines only one interface to write \r
+ the buffer to the fault tolerant storage.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
All rights reserved. This program and the accompanying materials\r
manner, ensuring at all times that either the original contents or\r
the modified contents are available.\r
\r
- @param This Calling context \r
+ @param This The pointer to this protocol instance. \r
@param FvBlockHandle The handle of FVB protocol that provides services \r
for reading, writing, and erasing the target \r
block. \r
\r
@retval EFI_SUCCESS The function completed successfully \r
@retval EFI_ABORTED The function could not complete successfully. \r
- @retval EFI_BAD_BUFFER_SIZE The write would span a block boundary, which is \r
- not a valid action. \r
+ @retval EFI_BAD_BUFFER_SIZE The input data can't fit within the target block. \r
@retval EFI_ACCESS_DENIED No writes have been allocated. \r
- @retval EFI_NOT_READY The last write has not been completed. Restart () \r
- must be called to complete it. \r
-\r
+ @retval EFI_OUT_OF_RESOURCES Cannot allocate enough memory resource.\r
+ @retval EFI_NOT_FOUND Cannot find FVB protocol by handle.\r
+ \r
**/\r
typedef\r
EFI_STATUS\r
/** @file\r
This file declares Firmware Volume Dispatch protocol.\r
\r
- Presence of this protocol tells the dispatch to dispatch from this Firmware\r
- Volume\r
+ Presence of this protocol tells the core dispatcher to dispatch this Firmware Volume.\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
//\r
// FVB Extension Function Prototypes\r
//\r
-/**
- Erases and initializes a specified range of a firmware volume\r
-
- @param[in] This Pointer to the FVB Extension protocol instance
- @param[in] StartLba The starting logical block index to be erased
+/**\r
+ Erases and initializes a specified range of a firmware volume block\r
+\r
+ @param[in] This Pointer to the FVB Extension protocol instance\r
+ @param[in] StartLba The starting logical block index to be erased\r
@param[in] OffsetStartLba Offset into the starting block at which to \r
- begin erasing
- @param[in] LastLba The last logical block index to be erased
- @param[in] OffsetLastLba Offset into the last block at which to end erasing
-
- @retval EFI_EFI_SUCCESS Range was erased
- @retval EFI_INVALID_PARAMETER invalid parameter
- @retval EFI_UNSUPPORTED Range can not be erased\r
-
+ begin erasing \r
+ @param[in] LastLba The last logical block index to be erased\r
+ @param[in] OffsetLastLba Offset into the last block at which to end erasing \r
+\r
+ @retval EFI_SUCCESS The specified range was erased successfully\r
+ @retval EFI_ACCESS_DENIED The firmware volume block is in the WriteDisabled state\r
+ @retval EFI_DEVICE_ERROR The block device is not functioning correctly and \r
+ could not be written. Firmware device may have been\r
+ partially erased\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI * EFI_FV_ERASE_CUSTOM_BLOCK) (\r
IN EFI_FVB_EXTENSION_PROTOCOL *This,\r
- IN EFI_LBA StartLba,\r
- IN UINTN OffsetStartLba,\r
- IN EFI_LBA LastLba,\r
- IN UINTN OffsetLastLba\r
+ IN EFI_LBA StartLba,\r
+ IN UINTN OffsetStartLba,\r
+ IN EFI_LBA LastLba,\r
+ IN UINTN OffsetLastLba\r
);\r
\r
//\r
/** @file\r
- The EFI generic memory test protocol interface.\r
- For more information please look at EfiMemoryTest.doc\r
+ This protocol defines the EFI generic memory test interfaces in Dxe phase.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
All rights reserved. This program and the accompanying materials\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_MEMORY_TEST_INIT) (\r
- IN EFI_GENERIC_MEMORY_TEST_PROTOCOL *This,\r
+ IN EFI_GENERIC_MEMORY_TEST_PROTOCOL *This,\r
IN EXTENDMEM_COVERAGE_LEVEL Level,\r
OUT BOOLEAN *RequireSoftECCInit\r
)\r
internally. \r
@retval EFI_NOT_FOUND Indicate all the non-tested memory blocks have \r
already go through. \r
+ @retval EFI_DEVICE_ERROR Mis-compare error, and no agent can handle it\r
\r
**/\r
typedef\r
@param StartAddress The start address of the memory range. \r
@param Length The memory range's length. \r
\r
- @retval EFI_SUCCESS The compatible memory range pass the memory test. \r
- @retval EFI_DEVICE_ERROR The compatible memory range test find memory error \r
- and also return return the error address. \r
+ @retval EFI_SUCCESS The compatible memory range pass the memory test. \r
+ @retval EFI_INVALID_PARAMETER The compatible memory range must be below 16M.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_MEMORY_TEST_COMPATIBLE_RANGE) (\r
- IN EFI_GENERIC_MEMORY_TEST_PROTOCOL *This,\r
+ IN EFI_GENERIC_MEMORY_TEST_PROTOCOL *This,\r
IN EFI_PHYSICAL_ADDRESS StartAddress,\r
IN UINT64 Length\r
)\r
/** @file\r
\r
- Load File protocol.\r
+ Load File protocol provides capability to load and unload EFI image into \r
+ memory and execute it.\r
\r
Load file protocol exists to supports the addition of new boot devices,\r
and to support booting from devices that do not map well to file system.\r
-/*++\r
+/** @file\r
+ This file defines NicIp4Config Protocol.\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
-Module Name:\r
-\r
- NicIp4Config.h\r
-\r
-Abstract:\r
-\r
---*/\r
+**/\r
\r
#ifndef __NIC_IP4_CONFIG_H__\r
#define __NIC_IP4_CONFIG_H__\r
\r
typedef struct _EFI_NIC_IP4_CONFIG_PROTOCOL EFI_NIC_IP4_CONFIG_PROTOCOL;\r
\r
-enum {\r
+typedef enum {\r
//\r
// Config source: dhcp or static\r
//\r
\r
IP4_NIC_NAME_LENGTH = 64,\r
MAX_IP4_CONFIG_IN_VARIABLE = 16\r
-};\r
+} IP4_CONFIG_TYPE;\r
\r
//\r
// The following structures are used by drivers/applications other\r
/** @file\r
- EFI OEM Badging Protocol definition header file\r
+ EFI OEM Badging Protocol defines the interface to get the OEM badging \r
+ image with the dispaly attribute. This protocol can be produced based on OEM images.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
All rights reserved. This program and the accompanying materials\r
EfiBadgingDisplayAttributeCustomized\r
} EFI_BADGING_DISPLAY_ATTRIBUTE;\r
\r
+/**\r
\r
+ Load an OEM image and return its data as well as attributes.\r
+\r
+ @param This Pointer to this protocol instance.\r
+ @param Instance The visiable image instance is founded and returned from the input instance.\r
+ @param Format Format of the image such as BMP,JPEG,etc.\r
+ @param ImageData Image data returned.\r
+ @param ImageSize Size of the image returned.\r
+ @param Attribute Display attributes of the image returned.\r
+ @param CoordinateX X coordinate of the image.\r
+ @param CoordinateY Y coordinate of the image.\r
+\r
+ @retval EFI_SUCCESS Image has been fetched successfully.\r
+ @retval EFI_NOT_FOUND The specified image could not be found.\r
+\r
+**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_BADGING_GET_IMAGE) (\r
/** @file\r
\r
- This file defines the Print protocol.\r
+ This print protocol defines six basic print functions to
+ print the format unicode and ascii string.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
-/*++\r
+/** @file\r
+ EFI PXE DHCPv4 protocol definition\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
-Module Name:\r
- PxeDhcp4.h\r
-\r
-Abstract:\r
- EFI PXE DHCPv4 protocol definition\r
-\r
---*/\r
+**/\r
\r
#ifndef _PXEDHCP4_H_\r
#define _PXEDHCP4_H_\r
#define DHCP4_NIS_SERVERS 41\r
#define DHCP4_NTP_SERVERS 42\r
#define DHCP4_VENDOR_SPECIFIC 43\r
-# define PXE_MTFTP_IP 1\r
-# define PXE_MTFTP_CPORT 2\r
-# define PXE_MTFTP_SPORT 3\r
-# define PXE_MTFTP_TMOUT 4\r
-# define PXE_MTFTP_DELAY 5\r
-# define PXE_DISCOVERY_CONTROL 6\r
-# define PXE_DISABLE_BROADCAST_DISCOVERY 0x01\r
-# define PXE_DISABLE_MULTICAST_DISCOVERY 0x02\r
-# define PXE_ACCEPT_ONLY_PXE_BOOT_SERVERS 0x04\r
-# define PXE_DO_NOT_PROMPT 0x08\r
-# define PXE_DISCOVERY_MCAST_ADDR 7\r
-# define PXE_BOOT_SERVERS 8\r
-# define PXE_BOOT_MENU 9\r
-# define PXE_BOOT_PROMPT 10\r
-# define PXE_MCAST_ADDRS_ALLOC 11\r
-# define PXE_CREDENTIAL_TYPES 12\r
-# define PXE_BOOT_ITEM 71\r
+#define PXE_MTFTP_IP 1\r
+#define PXE_MTFTP_CPORT 2\r
+#define PXE_MTFTP_SPORT 3\r
+#define PXE_MTFTP_TMOUT 4\r
+#define PXE_MTFTP_DELAY 5\r
+#define PXE_DISCOVERY_CONTROL 6\r
+#define PXE_DISABLE_BROADCAST_DISCOVERY 0x01\r
+#define PXE_DISABLE_MULTICAST_DISCOVERY 0x02\r
+#define PXE_ACCEPT_ONLY_PXE_BOOT_SERVERS 0x04\r
+#define PXE_DO_NOT_PROMPT 0x08\r
+#define PXE_DISCOVERY_MCAST_ADDR 7\r
+#define PXE_BOOT_SERVERS 8\r
+#define PXE_BOOT_MENU 9\r
+#define PXE_BOOT_PROMPT 10\r
+#define PXE_MCAST_ADDRS_ALLOC 11\r
+#define PXE_CREDENTIAL_TYPES 12\r
+#define PXE_BOOT_ITEM 71\r
#define DHCP4_NBNS_SERVERS 44\r
#define DHCP4_NBDD_SERVERS 45\r
#define DHCP4_NETBIOS_NODE_TYPE 46\r
#define DHCP4_REQUESTED_IP_ADDRESS 50\r
#define DHCP4_LEASE_TIME 51\r
#define DHCP4_OPTION_OVERLOAD 52\r
-# define DHCP4_OVERLOAD_FNAME 1\r
-# define DHCP4_OVERLOAD_SNAME 2\r
-# define DHCP4_OVERLOAD_FNAME_AND_SNAME 3\r
+#define DHCP4_OVERLOAD_FNAME 1\r
+#define DHCP4_OVERLOAD_SNAME 2\r
+#define DHCP4_OVERLOAD_FNAME_AND_SNAME 3\r
#define DHCP4_MESSAGE_TYPE 53\r
-# define DHCP4_MESSAGE_TYPE_DISCOVER 1\r
-# define DHCP4_MESSAGE_TYPE_OFFER 2\r
-# define DHCP4_MESSAGE_TYPE_REQUEST 3\r
-# define DHCP4_MESSAGE_TYPE_DECLINE 4\r
-# define DHCP4_MESSAGE_TYPE_ACK 5\r
-# define DHCP4_MESSAGE_TYPE_NAK 6\r
-# define DHCP4_MESSAGE_TYPE_RELEASE 7\r
-# define DHCP4_MESSAGE_TYPE_INFORM 8\r
+#define DHCP4_MESSAGE_TYPE_DISCOVER 1\r
+#define DHCP4_MESSAGE_TYPE_OFFER 2\r
+#define DHCP4_MESSAGE_TYPE_REQUEST 3\r
+#define DHCP4_MESSAGE_TYPE_DECLINE 4\r
+#define DHCP4_MESSAGE_TYPE_ACK 5\r
+#define DHCP4_MESSAGE_TYPE_NAK 6\r
+#define DHCP4_MESSAGE_TYPE_RELEASE 7\r
+#define DHCP4_MESSAGE_TYPE_INFORM 8\r
#define DHCP4_SERVER_IDENTIFIER 54\r
#define DHCP4_PARAMETER_REQUEST_LIST 55\r
#define DHCP4_ERROR_MESSAGE 56\r
#define DHCP4_MAX_MESSAGE_SIZE 57\r
-# define DHCP4_DEFAULT_MAX_MESSAGE_SIZE 576\r
+#define DHCP4_DEFAULT_MAX_MESSAGE_SIZE 576\r
#define DHCP4_RENEWAL_TIME 58\r
#define DHCP4_REBINDING_TIME 59\r
#define DHCP4_CLASS_IDENTIFIER 60\r
-/*++\r
+/** @file\r
+ EFI PXE DHCP4 Callback protocol definition.\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
-Module Name:\r
- PxeDhcp4Callback.h\r
-\r
-Abstract:\r
- EFI PXE DHCP4 Callback protocol definition.\r
-\r
---*/\r
+**/\r
\r
-#ifndef _PXE_DHCP4CALLBACK_H\r
-#define _PXE_DHCP4CALLBACK_H\r
+#ifndef __PXE_DHCP4CALLBACK_H__\r
+#define __PXE_DHCP4CALLBACK_H__\r
\r
#include <Protocol/PxeDhcp4.h>\r
//\r
-/*++\r
+/** @file\r
\r
-Copyright (c) 2004, Intel Corporation\r
+ This file defines EFI Transmission Control Protocol.\r
+\r
+Copyright (c) 2004 - 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
-Module Name:\r
-\r
- tcp.h\r
-\r
-Abstract:\r
-\r
- EFI Transmission Control Protocol\r
-\r
-\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
\r
\r
-#ifndef _EFITCP_H\r
-#define _EFITCP_H\r
+#ifndef __EFI_TCP_H__\r
+#define __EFI_TCP_H__\r
\r
\r
#include <Protocol/PxeBaseCode.h>\r
+++ /dev/null
-/*++\r
-\r
-Copyright (c) 2006 - 2007, 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
-\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
-Module Name:\r
-\r
- UsbAtapi.h\r
-\r
-Abstract:\r
-\r
- EFI Atapi Protocol definition.\r
-\r
-Revision History\r
-\r
---*/\r
-\r
-#ifndef __EFI_USB_ATAPI_H__\r
-#define __EFI_USB_ATAPI_H__\r
-\r
-//\r
-// Transfer protocol types\r
-//\r
-#define BOT 0x50\r
-#define CBI0 0x00\r
-#define CBI1 0x01\r
-\r
-//\r
-// SubClass Code (defines command set)\r
-//\r
-#define EFI_USB_SUBCLASS_RBC 0x01\r
-#define EFI_USB_SUBCLASS_ATAPI 0x02\r
-#define EFI_USB_SUBCLASS_QIC_157 0x03\r
-#define EFI_USB_SUBCLASS_UFI 0x04\r
-#define EFI_USB_SUBCLASS_SFF_8070i 0x05\r
-#define EFI_USB_SUBCLASS_SCSI 0x06\r
-#define EFI_USB_SUBCLASS_RESERVED_LOW 0x07\r
-#define EFI_USB_SUBCLASS_RESERVED_HIGH 0xff\r
-//\r
-// Global GUID for transfer protocol interface\r
-//\r
-#define EFI_USB_ATAPI_PROTOCOL_GUID \\r
- { 0x2B2F68DA, 0x0CD2, 0x44cf, {0x8E, 0x8B, 0xBB, 0xA2, 0x0B, 0x1B, 0x5B, 0x75 } }\r
-\r
-typedef struct _EFI_USB_ATAPI_PROTOCOL EFI_USB_ATAPI_PROTOCOL;\r
-\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_USB_ATAPI_PACKET_CMD) (\r
- IN EFI_USB_ATAPI_PROTOCOL *This,\r
- IN VOID *Command,\r
- IN UINT8 CommandSize,\r
- IN VOID *DataBuffer,\r
- IN UINT32 BufferLength,\r
- IN EFI_USB_DATA_DIRECTION Direction,\r
- IN UINT16 TimeOutInMilliSeconds\r
-);\r
-\r
-typedef\r
-EFI_STATUS\r
-(EFIAPI *EFI_USB_MASS_STORAGE_RESET) (\r
- IN EFI_USB_ATAPI_PROTOCOL *This,\r
- IN BOOLEAN ExtendedVerification\r
-);\r
-\r
-//\r
-// Protocol Interface Structure\r
-//\r
-struct _EFI_USB_ATAPI_PROTOCOL {\r
- EFI_USB_ATAPI_PACKET_CMD UsbAtapiPacketCmd;\r
- EFI_USB_MASS_STORAGE_RESET UsbAtapiReset;\r
- UINT32 CommandProtocol;\r
-};\r
-\r
-extern EFI_GUID gEfiUsbAtapiProtocolGuid;\r
-\r
-#endif\r
-/**@file\r
- Header file for EFI Variable Services.\r
+/** @file\r
+ EDK II specific implementation of UEFI variable depend on data structure.\r
\r
- Copyright (c) 2006 - 2007 Intel Corporation. <BR>\r
+ Copyright (c) 2006 - 2008 Intel Corporation. <BR>\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
\r
- Defines data structure that is the headers found at the runtime\r
- updatable firmware volumes.\r
The header structure of FTW working block region.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation\r
gEfiFaultTolerantWriteLiteProtocolGuid = { 0x3F557189, 0x8DAE, 0x45AE, { 0xA0, 0xB3, 0x2B, 0x99, 0xCA, 0x7A, 0xA7, 0xA0 }}\r
gEfiConsoleControlProtocolGuid = { 0xF42F7782, 0x012E, 0x4C12, { 0x99, 0x56, 0x49, 0xF9, 0x43, 0x04, 0xF7, 0x21 }}\r
gEfiOEMBadgingProtocolGuid = { 0x170E13C0, 0xBF1B, 0x4218, { 0x87, 0x1D, 0x2A, 0xBD, 0xC6, 0xF8, 0x87, 0xBC }}\r
- gEfiUsbAtapiProtocolGuid = { 0x2B2F68DA, 0x0CD2, 0x44CF, { 0x8E, 0x8B, 0xBB, 0xA2, 0x0B, 0x1B, 0x5B, 0x75 }}\r
gPerformanceProtocolGuid = { 0x76B6BDFA, 0x2ACD, 0x4462, { 0x9E, 0x3F, 0xCB, 0x58, 0xC9, 0x69, 0xD9, 0x37 }}\r
gEfiCrc32GuidedSectionExtractionProtocolGuid = { 0xFC1BCDB0, 0x7D31, 0x49aa, {0x93, 0x6A, 0xA4, 0x60, 0x0D, 0x9D, 0xD0, 0x83 } }\r
gEfiFirmwareVolumeDispatchProtocolGuid = { 0x7AA35A69, 0x506C, 0x444F, { 0xA7, 0xAF, 0x69, 0x4B, 0xF5, 0x6F, 0x71, 0xC8 }}\r
\r
- gEfiTianoDecompressProtocolGuid = { 0xE84CF29C, 0x191F, 0x4EAE, { 0x96, 0xE1, 0xF4, 0x6A, 0xEC, 0xEA, 0xEA, 0x0B }}\r
- gEfiCustomizedDecompressProtocolGuid = { 0x9A44198E, 0xA4A2, 0x44E6, { 0x8A, 0x1F, 0x39, 0xBE, 0xFD, 0xAC, 0x89, 0x6F }}\r
-\r
gEfiNicIp4ConfigProtocolGuid = {0xdca3d4d, 0x12da, 0x4728, { 0xbf, 0x7e, 0x86, 0xce, 0xb9, 0x28, 0xd0, 0x67 }}\r
gEfiNicIp4ConfigVariableGuid = {0xd8944553, 0xc4dd, 0x41f4, { 0x9b, 0x30, 0xe1, 0x39, 0x7c, 0xfb, 0x26, 0x7b }}\r
gEfiTcpProtocolGuid = {0x02b3d5f2, 0xac28, 0x11d3, { 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d }}\r
}\r
\r
Status = gRT->SetVariable (\r
- VarLegacyDevOrder,\r
+ VAR_LEGACY_DEV_ORDER,\r
&EfiLegacyDevOrderGuid,\r
VAR_FLAG,\r
TotalSize,\r
);\r
\r
DevOrder = (UINT8 *) BdsLibGetVariableAndSize (\r
- VarLegacyDevOrder,\r
+ VAR_LEGACY_DEV_ORDER,\r
&EfiLegacyDevOrderGuid,\r
&DevOrderSize\r
);\r
SafeFreePool (DevOrder);\r
\r
Status = gRT->SetVariable (\r
- VarLegacyDevOrder,\r
+ VAR_LEGACY_DEV_ORDER,\r
&EfiLegacyDevOrderGuid,\r
VAR_FLAG,\r
TotalSize,\r
UINTN Index;\r
\r
DevOrder = BdsLibGetVariableAndSize (\r
- VarLegacyDevOrder,\r
+ VAR_LEGACY_DEV_ORDER,\r
&EfiLegacyDevOrderGuid,\r
&DevOrderSize\r
);\r
// Get Device Order from variable\r
//\r
VarData = BdsLibGetVariableAndSize (\r
- VarLegacyDevOrder,\r
+ VAR_LEGACY_DEV_ORDER,\r
&EfiLegacyDevOrderGuid,\r
&VarSize\r
);\r
// Update the Variable "LegacyDevOrder"\r
//\r
VarData = (UINT8 *) BdsLibGetVariableAndSize (\r
- VarLegacyDevOrder,\r
+ VAR_LEGACY_DEV_ORDER,\r
&EfiLegacyDevOrderGuid,\r
&VarSize\r
);\r
SafeFreePool (NewOrder);\r
\r
Status = gRT->SetVariable (\r
- VarLegacyDevOrder,\r
+ VAR_LEGACY_DEV_ORDER,\r
&EfiLegacyDevOrderGuid,\r
VAR_FLAG,\r
VarSize,\r
projects / mirror_edk2.git / commitdiff