-/*++\r
+/** @file \r
\r
-Copyright (c) 2006, Intel Corporation \r
+ Support functions for managing debug image info table when loading and unloading\r
+ images.\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
- DebugImageInfo.h\r
- \r
-Abstract:\r
-\r
- Support functions for managing debug image info table when loading and unloading\r
- images.\r
-\r
---*/\r
+**/\r
\r
#ifndef __DEBUG_IMAGE_INFO_H__\r
#define __DEBUG_IMAGE_INFO_H__\r
-/*++ \r
+/** @file\r
\r
-Copyright (c) 2006, Intel Corporation \r
+ DXE Dispatcher Dependency Evaluator\r
+\r
+ This routine evaluates a dependency expression (DEPENDENCY_EXPRESSION) to determine\r
+ if a driver can be scheduled for execution. The criteria for\r
+ schedulability is that the dependency expression is satisfied.\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
- dependency.c\r
-\r
-Abstract:\r
-\r
- DXE Dispatcher Dependency Evaluator\r
-\r
- This routine evaluates a dependency expression (DEPENDENCY_EXPRESSION) to determine\r
- if a driver can be scheduled for execution. The criteria for\r
- schedulability is that the dependency expression is satisfied.\r
-\r
---*/\r
+**/\r
\r
#include <DxeMain.h>\r
\r
/**@file\r
- Header file of DxeCore\r
+\r
+ The internal header file includes the common header files, defines\r
+ internal structure and functions used by DxeCore module.\r
\r
Copyright (c) 2006 - 2007, 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 file deals with Architecture Protocol (AP) registration in\r
+ the Dxe Core. The mArchProtocols[] array represents a list of\r
+ events that represent the Architectural Protocols.\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
- DxeProtocolNotify.c\r
-\r
-Abstract:\r
-\r
- This file deals with Architecture Protocol (AP) registration in\r
- the Dxe Core. The mArchProtocols[] array represents a list of\r
- events that represent the Architectural Protocols.\r
-\r
---*/\r
+**/\r
\r
#include <DxeMain.h>\r
\r
-/*++\r
+/** @file \r
+\r
+ UEFI Event support functions implemented in this file.\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
- event.c\r
-\r
-Abstract:\r
-\r
- EFI Event support\r
-\r
---*/\r
+**/\r
\r
\r
#include <DxeMain.h>\r
-/*++\r
+/** @file \r
\r
-Copyright (c) 2006, Intel Corporation \r
+ Event data is declared in this file. \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
- execdata.c\r
-\r
-Abstract:\r
-\r
-\r
-\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
\r
#include <DxeMain.h>\r
\r
-/*++\r
+/** @file \r
+\r
+ Core Timer Services\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
- timer.c\r
-\r
-Abstract:\r
-\r
- EFI Event support\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
\r
\r
#include <DxeMain.h>\r
-/*++\r
+/** @file \r
+\r
+ Task priority (TPL) function \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
- tpl.c\r
-\r
-Abstract:\r
-\r
- Task priority function \r
-\r
---*/\r
+**/\r
\r
#include <DxeMain.h>\r
\r
-/*++\r
+/** @file \r
+\r
+ UEFI Event support functions and structure.\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
- exec.h\r
-\r
-Abstract:\r
- \r
- EFI Event support\r
-\r
---*/\r
+**/\r
\r
#ifndef _EXEC_H_\r
#define _EXEC_H_\r
-/*++\r
+/** @file \r
+\r
+ FFS file access utilities.\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
- Ffs.c\r
-\r
-Abstract:\r
-\r
- FFS file access utilities.\r
-\r
---*/\r
+**/\r
\r
\r
#include <DxeMain.h>\r
-/*++\r
+/** @file \r
+\r
+ Implements get/set firmware volume attributes\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
- FwVolAttrib.c\r
-\r
-Abstract:\r
-\r
- Implements get/set firmware volume attributes\r
-\r
---*/\r
+**/\r
\r
#include <DxeMain.h>\r
\r
-/*++\r
+/** @file \r
+\r
+ Implements functions to read firmware file\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
- FwVolRead.c\r
-\r
-Abstract:\r
-\r
- Implements read firmware file\r
-\r
---*/\r
+**/\r
\r
#include <DxeMain.h>\r
\r
-/*++\r
+/** @file \r
+\r
+ Implements functions to write firmware file\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
- FwVolWrite.c\r
-\r
-Abstract:\r
-\r
- Implements write firmware file\r
-\r
---*/\r
+**/\r
\r
#include <DxeMain.h>\r
\r
-/*++\r
+/** @file \r
\r
-Copyright (c) 2006, Intel Corporation \r
+ Firmware Volume Block protocol functions. \r
+ Consumes FV hobs and creates appropriate block protocols. \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
- FwVolBlock.h\r
-\r
-Abstract:\r
-\r
- Firmware Volume Block protocol.. Consumes FV hobs and creates\r
- appropriate block protocols.\r
-\r
- Also consumes NT_NON_MM_FV envinronment variable and produces appropriate\r
- block protocols fro them also... (this is TBD)\r
-\r
---*/\r
+**/\r
\r
#ifndef _FWVOL_BLOCK_H_\r
#define _FWVOL_BLOCK_H_\r
/**@file\r
+\r
Firmware File System protocol. Layers on top of Firmware\r
Block protocol to produce a file abstraction of FV based files.\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
+/** @file \r
+\r
+ The file contains the GCD related services in the EFI Boot Services Table.\r
+ The GCD services are used to manage the memory and I/O regions that \r
+ are accessible to the CPU that is executing the DXE core.\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
- gcd.c\r
-\r
-Abstract:\r
- The file contains the GCD related services in the EFI Boot Services Table.\r
- The GCD services are used to manage the memory and I/O regions that \r
- are accessible to the CPU that is executing the DXE core.\r
-\r
---*/\r
+**/\r
\r
#include <DxeMain.h>\r
\r
-/*++\r
+/** @file \r
+\r
+ Support functions to connect/disconnect UEFI Driver model 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
- DriverSupport.c\r
- \r
-Abstract:\r
-\r
- EFI Driver Support Protocol\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
\r
#include <DxeMain.h>\r
\r
-/*++\r
+/** @file \r
+\r
+ UEFI notify infrastructure\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
- notify.c\r
-\r
-Abstract:\r
-\r
- EFI notify infrastructure\r
-\r
-\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
\r
#include <DxeMain.h>\r
\r
-/*++\r
+/** @file \r
+\r
+ UEFI handle & protocol handling\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
- handle.c\r
-\r
-Abstract:\r
-\r
- EFI handle & protocol handling\r
-\r
-\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
\r
#include <DxeMain.h>\r
\r
-/*++\r
+/** @file \r
+\r
+ Locate handle functions \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
- locate.c\r
-\r
-Abstract:\r
-\r
- Locate handle functions \r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
\r
#include <DxeMain.h>\r
\r
-/*++\r
-\r
-Copyright (c) 2006, Intel Corporation\r
+/** @file \r
+ \r
+ Data structure and functions to load and unload PeImage.\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
- Image.h\r
-\r
-Abstract:\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
\r
\r
#ifndef _IMAGE_H_\r
-/*++\r
+/** @file \r
+\r
+ Core image handling services to load and unload PeImage.\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
- Image.c\r
-\r
-Abstract:\r
-\r
- Core image handling services\r
-\r
---*/\r
+**/\r
\r
#include <DxeMain.h>\r
//\r
-/*++\r
-\r
+/** @file\r
+ \r
+ Handle services to image file. \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
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
- ImageFile.c\r
-\r
-\r
-Abstract:\r
-\r
-\r
-\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
\r
#include <DxeMain.h>\r
\r
-/*++\r
+/** @file \r
+\r
+ Internal functions shared in DxeCore module.\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
- Library.h\r
-\r
-Abstract:\r
-\r
-Revision History\r
-\r
--*/\r
\r
#ifndef _DXE_LIBRARY_H_\r
-/*++\r
+/** @file\r
+\r
+ UEFI Memory page management functions.\r
\r
-Copyright (c) 2007, Intel Corporation \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
- page.c\r
-\r
-Abstract:\r
-\r
- EFI Memory page management\r
-\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
\r
#include <DxeMain.h>\r
\r
-/*++\r
+/** @file \r
\r
-Copyright (c) 2006, Intel Corporation \r
+ Global data used in memory service\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
- memdata.c\r
-\r
-Abstract:\r
-\r
- Global data used in memory service\r
-\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
\r
#include <DxeMain.h>\r
\r
-/*++\r
+/** @file \r
+\r
+ UEFI Memory pool management functions.\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
- pool.c\r
-\r
-Abstract:\r
-\r
- EFI Memory pool management\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
\r
#include <DxeMain.h>\r
\r
-/*++\r
+/** @file \r
+\r
+ Support functions for managing debug image info table when loading and unloading\r
+ images.\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
- DebugImageInfo.c\r
- \r
-Abstract:\r
-\r
- Support functions for managing debug image info table when loading and unloading\r
- images.\r
-\r
---*/\r
+**/\r
\r
#include <DxeMain.h>\r
\r
-/*++\r
+/** @file \r
+\r
+ UEFI Miscellaneous boot Services InstallConfigurationTable service\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
- InstallConfigurationTable.c\r
-\r
-\r
-Abstract:\r
-\r
- Tiano Miscellaneous Services InstallConfigurationTable service\r
-\r
---*/\r
+**/\r
\r
#include <DxeMain.h>\r
\r
-/*++\r
+/** @file \r
+\r
+ UEFI Miscellaneous boot Services SetWatchdogTimer service implementation\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
- SetWatchdogTimer.c\r
-\r
-Abstract:\r
-\r
- Tiano Miscellaneous Services SetWatchdogTimer service implementation\r
-\r
---*/\r
+**/\r
\r
#include <DxeMain.h>\r
\r
-/*++\r
+/** @file \r
+\r
+ UEFI Miscellaneous boot Services Stall service implementation\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
- Stall.c\r
-\r
-Abstract:\r
-\r
- Tiano Miscellaneous Services Stall service implementation\r
-\r
---*/\r
+**/\r
\r
//\r
// Include statements\r
-/*++\r
+/** @file \r
\r
-Copyright (c) 2006, Intel Corporation \r
+ GCD Operations and data structure used to \r
+ convert from GCD attributes to EFI Memory Map attributes.\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
- gcd.h\r
-\r
-Abstract:\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
\r
#ifndef _GCD_H\r
#define _GCD_H\r
-/*++\r
+/** @file \r
+\r
+ Support functions for managing 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
- hand.h\r
-\r
-Abstract:\r
-\r
- EFI internal protocol definitions\r
-\r
-\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
\r
#ifndef _HAND_H_\r
#define _HAND_H_\r
-/*++\r
+/** @file \r
+ \r
+ Data structure and functions to allocate and free memory space.\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
- imem.h\r
-\r
-Abstract:\r
-\r
- Head file to imem.h\r
-\r
-\r
-Revision History\r
-\r
--*/\r
\r
#ifndef _IMEM_H_\r
-/*++\r
+/** @file\r
\r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+ Tiano Guid used to define the Alternate Firmware Volume Block Guid.\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
- AlternateFvBlock.h\r
-\r
-Abstract:\r
-\r
- Tiano Guid used to define the Alternate Firmware Volume Block Guid.\r
-\r
---*/\r
+**/\r
\r
#ifndef __ALT_FVB_GUID_H__\r
#define __ALT_FVB_GUID_H__\r
-/*++\r
+/** @file\r
\r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+ Capsule update Guid definitions for capsule varialbe and capsule hob.\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
- CapsuleVendor.h\r
-\r
-Abstract:\r
-\r
- Capsule update Guid definitions\r
-\r
---*/\r
+**/\r
\r
#ifndef __EFI_CAPSULE_VENDOR_GUID_H__\r
#define __EFI_CAPSULE_VENDOR_GUID_H__\r
-/*++\r
+/** @file\r
+ \r
+ GUID for the PE/COFF Loader APIs shared between SEC, PEI and DXE\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
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
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
\r
-Module Name:\r
- PeiPeCoffLoader.h\r
- \r
-Abstract:\r
- GUID for the PE/COFF Loader APIs shared between PEI and DXE\r
-\r
---*/\r
+**/\r
\r
#ifndef __PEI_PE_COFF_LOADER_H__\r
#define __PEI_PE_COFF_LOADER_H__\r
\r
typedef struct _EFI_PEI_PE_COFF_LOADER_PROTOCOL EFI_PEI_PE_COFF_LOADER_PROTOCOL;\r
\r
+/**\r
+ Retrieves information about a PE/COFF image.\r
+\r
+ Computes the PeCoffHeaderOffset, ImageAddress, ImageSize, DestinationAddress, CodeView,\r
+ PdbPointer, RelocationsStripped, SectionAlignment, SizeOfHeaders, and DebugDirectoryEntryRva\r
+ fields of the ImageContext structure. If ImageContext is NULL, then return RETURN_INVALID_PARAMETER.\r
+ If the PE/COFF image accessed through the ImageRead service in the ImageContext structure is not\r
+ a supported PE/COFF image type, then return RETURN_UNSUPPORTED. If any errors occur while\r
+ computing the fields of ImageContext, then the error status is returned in the ImageError field of\r
+ ImageContext. \r
+\r
+ @param This Pointer to the EFI_PEI_PE_COFF_LOADER_PROTOCOL instance.\r
+ @param ImageContext Pointer to the image context structure that describes the PE/COFF\r
+ image that needs to be examined by this function.\r
+\r
+ @retval RETURN_SUCCESS The information on the PE/COFF image was collected.\r
+ @retval RETURN_INVALID_PARAMETER ImageContext is NULL.\r
+ @retval RETURN_UNSUPPORTED The PE/COFF image is not supported.\r
\r
+**/\r
typedef \r
-EFI_STATUS\r
+RETURN_STATUS\r
(EFIAPI *EFI_PEI_PE_COFF_LOADER_GET_IMAGE_INFO) (\r
IN EFI_PEI_PE_COFF_LOADER_PROTOCOL *This,\r
IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
);\r
\r
+/**\r
+ Loads a PE/COFF image into memory.\r
+\r
+ Loads the PE/COFF image accessed through the ImageRead service of ImageContext into the buffer\r
+ specified by the ImageAddress and ImageSize fields of ImageContext. The caller must allocate\r
+ the load buffer and fill in the ImageAddress and ImageSize fields prior to calling this function.\r
+ The EntryPoint, FixupDataSize, CodeView, and PdbPointer fields of ImageContext are computed.\r
+ If ImageContext is NULL, then ASSERT().\r
+\r
+ @param This Pointer to the EFI_PEI_PE_COFF_LOADER_PROTOCOL instance.\r
+ @param ImageContext Pointer to the image context structure that describes the PE/COFF\r
+ image that is being loaded.\r
+\r
+ @retval RETURN_SUCCESS The PE/COFF image was loaded into the buffer specified by\r
+ the ImageAddress and ImageSize fields of ImageContext.\r
+ Extended status information is in the ImageError field of ImageContext.\r
+ @retval RETURN_BUFFER_TOO_SMALL The caller did not provide a large enough buffer.\r
+ Extended status information is in the ImageError field of ImageContext.\r
+ @retval RETURN_LOAD_ERROR The PE/COFF image is an EFI Runtime image with no relocations.\r
+ Extended status information is in the ImageError field of ImageContext.\r
+ @retval RETURN_INVALID_PARAMETER The image address is invalid.\r
+ Extended status information is in the ImageError field of ImageContext.\r
+\r
+**/\r
typedef \r
-EFI_STATUS\r
+RETURN_STATUS\r
(EFIAPI *EFI_PEI_PE_COFF_LOADER_LOAD_IMAGE) (\r
IN EFI_PEI_PE_COFF_LOADER_PROTOCOL *This,\r
IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
);\r
\r
+/**\r
+ Applies relocation fixups to a PE/COFF image that was loaded with PeCoffLoaderLoadImage().\r
+\r
+ If the DestinationAddress field of ImageContext is 0, then use the ImageAddress field of\r
+ ImageContext as the relocation base address. Otherwise, use the DestinationAddress field\r
+ of ImageContext as the relocation base address. The caller must allocate the relocation\r
+ fixup log buffer and fill in the FixupData field of ImageContext prior to calling this function. \r
+ If ImageContext is NULL, then ASSERT().\r
+\r
+ @param This Pointer to the EFI_PEI_PE_COFF_LOADER_PROTOCOL instance.\r
+ @param ImageContext Pointer to the image context structure that describes the PE/COFF\r
+ image that is being relocated.\r
+\r
+ @retval RETURN_SUCCESS The PE/COFF image was relocated.\r
+ Extended status information is in the ImageError field of ImageContext.\r
+ @retval RETURN_LOAD_ERROR The image in not a valid PE/COFF image.\r
+ Extended status information is in the ImageError field of ImageContext.\r
+ @retval RETURN_UNSUPPORTED A relocation record type is not supported.\r
+ Extended status information is in the ImageError field of ImageContext.\r
+\r
+**/\r
typedef \r
-EFI_STATUS\r
+RETURN_STATUS\r
(EFIAPI *EFI_PEI_PE_COFF_LOADER_RELOCATE_IMAGE) (\r
IN EFI_PEI_PE_COFF_LOADER_PROTOCOL *This,\r
IN OUT PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
);\r
\r
+/**\r
+ Unloads a loaded PE/COFF image from memory and releases its taken resource.\r
+ \r
+ For NT32 emulator, the PE/COFF image loaded by system needs to release.\r
+ For real platform, the PE/COFF image loaded by Core doesn't needs to be unloaded, \r
+ this function can simply return RETURN_SUCCESS.\r
+\r
+ @param This Pointer to the EFI_PEI_PE_COFF_LOADER_PROTOCOL instance.\r
+ @param ImageContext Pointer to the image context structure that describes the PE/COFF\r
+ image to be unloaded.\r
+\r
+ @retval RETURN_SUCCESS The PE/COFF image was unloaded successfully.\r
+**/\r
typedef \r
-EFI_STATUS\r
+RETURN_STATUS\r
(EFIAPI *EFI_PEI_PE_COFF_LOADER_UNLOAD_IMAGE) (\r
IN EFI_PEI_PE_COFF_LOADER_PROTOCOL *This,\r
IN PE_COFF_LOADER_IMAGE_CONTEXT *ImageContext\r
-/*++\r
+/** @file\r
\r
-Copyright (c) 2006, Intel Corporation \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
+\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
- SystemNvDataGuid.h\r
- \r
-Abstract:\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
-\r
---*/\r
+**/\r
\r
#ifndef __SYSTEM_NV_DATA_GUID_H__\r
#define __SYSTEM_NV_DATA_GUID_H__\r
-/*++\r
+/** @file\r
\r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+ 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
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
---*/\r
+**/\r
\r
#ifndef __VARIABLE_INFO_GUID_H__\r
#define __VARIABLE_INFO_GUID_H__\r
/** @file\r
+\r
Capsule Library. This library class defines a set of interfaces on \r
how to process capusle image update.\r
\r
-/*++\r
+/** @file\r
\r
-Copyright (c) 2006, Intel Corporation \r
+ FlashMap PPI abstracts access to FlashMap information. \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
- FlashMap.h\r
-\r
-Abstract:\r
-\r
- FlashMap PPI defined in Tiano\r
-\r
- This code abstracts FlashMap access\r
-\r
---*/\r
+**/\r
\r
#ifndef _PEI_FLASH_MAP_PPI_H_\r
#define _PEI_FLASH_MAP_PPI_H_\r
{ 0xf34c2fa0, 0xde88, 0x4270, {0x84, 0x14, 0x96, 0x12, 0x22, 0xf4, 0x52, 0x1c } }\r
\r
typedef struct _PEI_FLASH_MAP_PPI PEI_FLASH_MAP_PPI;\r
+\r
//\r
// Functions\r
//\r
+/**\r
+ Get flash region information.\r
+ \r
+ @param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+ @param This Pointer to the FlashMap PPI instance\r
+ @param AreaType Flash Area Type\r
+ @param AreaTypeGuid Pointer to Guid for Flash Area Type \r
+ @param NumEntries Pointer to the number of entries for the total flash area.\r
+ @param Entries Pointer to the entry list. \r
+ \r
+ @retval EFI_SUCESS Get flash area information successfully.\r
+ @retval EFI_NOT_FOUND No flash area information is found.\r
+**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *PEI_GET_FLASH_AREA_INFO) (\r
-/*++\r
+/** @file\r
\r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+ Capsule Architectural Protocol is added to produce UEFI2.0 capsule runtime services.\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
- Capsule.h\r
-\r
-Abstract:\r
-\r
- Capsule Architectural Protocol is newly added to produce UEFI2.0 capsule runtime services.\r
-\r
---*/\r
+**/\r
\r
#ifndef __ARCH_PROTOCOL_CAPSULE_ARCH_H__\r
#define __ARCH_PROTOCOL_CAPSULE_ARCH_H__\r
-/*++\r
+/** @file\r
+ \r
+ The user Customized Decompress Protocol Interface\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
- CustomizedDecompress.h\r
- \r
-Abstract:\r
- The user Customized Decompress Protocol Interface\r
-\r
---*/\r
+**/\r
\r
#ifndef __CUSTOMIZED_DECOMPRESS_H__\r
#define __CUSTOMIZED_DECOMPRESS_H__\r
\r
typedef struct _EFI_CUSTOMIZED_DECOMPRESS_PROTOCOL EFI_CUSTOMIZED_DECOMPRESS_PROTOCOL;\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
-Routine Description:\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
output it as DestinationSize. And ScratchSize is specific to the decompression\r
implementation.\r
\r
-Arguments:\r
-\r
- This - The protocol instance pointer\r
- Source - The source buffer containing the compressed data.\r
- SourceSize - The size, in bytes, of source buffer.\r
- 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
- 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
-Returns:\r
- 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
- EFI_INVALID_PARAMETER - 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
+ @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
-\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
+(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
-Routine Description:\r
+/**\r
\r
The Decompress() function extracts decompressed data to its original form.\r
\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
-Arguments:\r
-\r
- This - The protocol instance pointer\r
- Source - The source buffer containing the compressed data.\r
- SourceSize - The size of source data.\r
- Destination - On output, the destination buffer that contains \r
- the uncompressed data.\r
- DestinationSize - The size of destination buffer. The size of destination\r
- buffer needed is obtained from GetInfo().\r
- Scratch - A temporary scratch buffer that is used to perform the \r
- decompression.\r
- ScratchSize - The size of scratch buffer. The size of scratch buffer needed\r
- is obtained from GetInfo().\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - Decompression completed successfully, and the uncompressed \r
- buffer is returned in Destination.\r
- EFI_INVALID_PARAMETER \r
- - The source buffer specified by Source and SourceSize is \r
- corrupted (not in a valid compressed format).\r
-\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
-/*++\r
+/** @file\r
\r
-Copyright (c) 2006, Intel Corporation \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
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
- EdkDecompress.h\r
- \r
-Abstract:\r
- The Tiano Decompress Protocol Interface\r
-\r
---*/\r
+**/\r
\r
#ifndef __EDK_DECOMPRESS_H__\r
#define __EDK_DECOMPRESS_H__\r
\r
typedef struct _EFI_TIANO_DECOMPRESS_PROTOCOL EFI_TIANO_DECOMPRESS_PROTOCOL;\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
-Routine Description:\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
output it as DestinationSize. And ScratchSize is specific to the decompression\r
implementation.\r
\r
-Arguments:\r
-\r
- This - The protocol instance pointer\r
- Source - The source buffer containing the compressed data.\r
- SourceSize - The size, in bytes, of source buffer.\r
- 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
- 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
-Returns:\r
- 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
- EFI_INVALID_PARAMETER - 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
+ @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
-\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
+(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
-Routine Description:\r
+/**\r
\r
The Decompress() function extracts decompressed data to its original form.\r
\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
-Arguments:\r
-\r
- This - The protocol instance pointer\r
- Source - The source buffer containing the compressed data.\r
- SourceSize - The size of source data.\r
- Destination - On output, the destination buffer that contains \r
- the uncompressed data.\r
- DestinationSize - The size of destination buffer. The size of destination\r
- buffer needed is obtained from GetInfo().\r
- Scratch - A temporary scratch buffer that is used to perform the \r
- decompression.\r
- ScratchSize - The size of scratch buffer. The size of scratch buffer needed\r
- is obtained from GetInfo().\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - Decompression completed successfully, and the uncompressed \r
- buffer is returned in Destination.\r
- EFI_INVALID_PARAMETER \r
- - The source buffer specified by Source and SourceSize is \r
- corrupted (not in a valid compressed format).\r
-\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
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: FirmwareVolumeDispatch.h\r
-\r
- @par Revision Reference:\r
- This protol will be defined in DXE CIS Spec.\r
- Version 0.91C.\r
-\r
**/\r
\r
#ifndef __FIRMWARE_VOLUME_DISPATCH_H__\r
-/*++\r
+/** @file\r
\r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+ FVB Extension protocol that extends the FVB Class in a component fashion.\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
- FvbExtension.h\r
-\r
-Abstract:\r
-\r
- FVB Extension protocol that extends the FVB Class in a component fashion.\r
-\r
---*/\r
+**/\r
\r
#ifndef __FVB_EXTENSION_H__\r
#define __FVB_EXTENSION_H__\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
+ @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
+
+**/\r
typedef\r
EFI_STATUS\r
(EFIAPI * EFI_FV_ERASE_CUSTOM_BLOCK) (\r
);\r
\r
//\r
-// IPMI TRANSPORT PROTOCOL\r
+// FVB Extension PROTOCOL\r
//\r
struct _EFI_FVB_EXTENSION_PROTOCOL {\r
EFI_FV_ERASE_CUSTOM_BLOCK EraseFvbCustomBlock;\r
-/*++\r
+/** @file\r
\r
-Copyright (c) 2006, 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
- LoadPe32Image.h\r
-\r
-Abstract:\r
Load File protocol.\r
\r
Load file protocol exists to supports the addition of new boot devices,\r
\r
UEFI 2.0 can boot from any device that produces a LoadFile protocol.\r
\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 __LOAD_PE32_IMAGE_H__\r
#define __LOAD_PE32_IMAGE_H__\r
\r
typedef struct _EFI_PE32_IMAGE_PROTOCOL EFI_PE32_IMAGE_PROTOCOL;\r
\r
+/**\r
+\r
+ Loads an EFI image into memory and returns a handle to the image with extended parameters.\r
+\r
+ @param This Calling context\r
+ @param ParentImageHandle The caller's image handle.\r
+ @param FilePath The specific file path from which the image is loaded.\r
+ @param SourceBuffer If not NULL, a pointer to the memory location containing a copy of\r
+ the image to be loaded.\r
+ @param SourceSize The size in bytes of SourceBuffer.\r
+ @param DstBuffer The buffer to store the image.\r
+ @param NumberOfPages For input, specifies the space size of the image by caller if not NULL.\r
+ For output, specifies the actual space size needed.\r
+ @param ImageHandle Image handle for output.\r
+ @param EntryPoint Image entry point for output.\r
+ @param Attribute The bit mask of attributes to set for the load PE image.\r
+\r
+ @retval EFI_SUCCESS The image was loaded into memory.\r
+ @retval EFI_NOT_FOUND The FilePath was not found.\r
+ @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
+ @retval EFI_UNSUPPORTED The image type is not supported, or the device path cannot be\r
+ parsed to locate the proper protocol for loading the file.\r
+ @retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient resources.\r
+**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *LOAD_PE_IMAGE) (\r
IN UINT32 Attribute\r
);\r
\r
+/**\r
+\r
+ Unload the specified image.\r
+\r
+ @param This Indicates the calling context.\r
+ @param ImageHandle The specified image handle.\r
+\r
+ @retval EFI_INVALID_PARAMETER Image handle is NULL.\r
+ @retval EFI_UNSUPPORTED Attempt to unload an unsupported image.\r
+ @retval EFI_SUCCESS Image successfully unloaded.\r
+\r
+--*/\r
typedef\r
EFI_STATUS\r
(EFIAPI *UNLOAD_PE_IMAGE) (\r
-/*++\r
+/** @file\r
\r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+ This file defines the Print protocol.\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
- Print.h\r
-\r
-Abstract:\r
-\r
- This file defines the Print protocol\r
-\r
---*/\r
+**/\r
\r
#ifndef __PPRINT_H__\r
#define __PPRINT_H__\r
//\r
typedef struct _EFI_PRINT_PROTOCOL EFI_PRINT_PROTOCOL;\r
\r
-\r
+/**
+ Produces a Null-terminated Unicode string in an output buffer based on
+ a Null-terminated Unicode format string and a VA_LIST argument list
+
+ Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer
+ and BufferSize.
+ The Unicode string is produced by parsing the format string specified by FormatString.
+ Arguments are pulled from the variable argument list specified by Marker based on the
+ contents of the format string.
+ The number of Unicode characters in the produced output buffer is returned not including
+ the Null-terminator.
+ If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.
+
+ If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().
+ If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().
+ If BufferSize > 1 and FormatString is NULL, then ASSERT().
+ If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, then ASSERT().
+ If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than
+ PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then
+ ASSERT().
+ If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string
+ contains more than PcdMaximumUnicodeStringLength Unicode characters not including the
+ Null-terminator, then ASSERT().
+
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
+ Unicode string.
+ @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
+ @param FormatString Null-terminated Unicode format string.
+ @param Marker VA_LIST marker for the variable argument list.
+
+ @return The number of Unicode characters in the produced output buffer not including the
+ Null-terminator.
+
+**/\r
typedef\r
UINTN\r
(EFIAPI *UNI_VSPRINT) (\r
IN VA_LIST Marker\r
);\r
\r
+/**
+ Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated
+ ASCII format string and a VA_LIST argument list
+
+ Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer
+ and BufferSize.
+ The Unicode string is produced by parsing the format string specified by FormatString.
+ Arguments are pulled from the variable argument list specified by Marker based on the
+ contents of the format string.
+ The number of Unicode characters in the produced output buffer is returned not including
+ the Null-terminator.
+ If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.
+
+ If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().
+ If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().
+ If BufferSize > 1 and FormatString is NULL, then ASSERT().
+ If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than
+ PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then
+ ASSERT().
+ If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string
+ contains more than PcdMaximumUnicodeStringLength Unicode characters not including the
+ Null-terminator, then ASSERT().
+
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
+ Unicode string.
+ @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
+ @param FormatString Null-terminated Unicode format string.
+ @param Marker VA_LIST marker for the variable argument list.
+
+ @return The number of Unicode characters in the produced output buffer not including the
+ Null-terminator.
+
+**/\r
typedef\r
UINTN
(EFIAPI *UNI_VSPRINT_ASCII) (
IN VA_LIST Marker
);\r
\r
+/**
+ Converts a decimal value to a Null-terminated Unicode string.
+
+ Converts the decimal number specified by Value to a Null-terminated Unicode
+ string specified by Buffer containing at most Width characters. No padding of spaces
+ is ever performed. If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.
+ The number of Unicode characters in Buffer is returned not including the Null-terminator.
+ If the conversion contains more than Width characters, then only the first
+ Width characters are returned, and the total number of characters
+ required to perform the conversion is returned.
+ Additional conversion parameters are specified in Flags.
+
+ The Flags bit LEFT_JUSTIFY is always ignored.
+ All conversions are left justified in Buffer.
+ If Width is 0, PREFIX_ZERO is ignored in Flags.
+ If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas
+ are inserted every 3rd digit starting from the right.
+ If HEX_RADIX is set in Flags, then the output buffer will be
+ formatted in hexadecimal format.
+ If Value is < 0 and HEX_RADIX is not set in Flags, then the fist character in Buffer is a '-'.
+ If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored,
+ then Buffer is padded with '0' characters so the combination of the optional '-'
+ sign character, '0' characters, digit characters for Value, and the Null-terminator
+ add up to Width characters.
+ If both COMMA_TYPE and HEX_RADIX are set in Flags, then ASSERT().
+ If Buffer is NULL, then ASSERT().
+ If Buffer is not aligned on a 16-bit boundary, then ASSERT().
+ If unsupported bits are set in Flags, then ASSERT().
+ If both COMMA_TYPE and HEX_RADIX are set in Flags, then ASSERT().
+ If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()
+
+ @param Buffer Pointer to the output buffer for the produced Null-terminated
+ Unicode string.
+ @param Flags The bitmask of flags that specify left justification, zero pad, and commas.
+ @param Value The 64-bit signed value to convert to a string.
+ @param Width The maximum number of Unicode characters to place in Buffer, not including
+ the Null-terminator.
+
+ @return The number of Unicode characters in Buffer not including the Null-terminator.
+
+**/\r
typedef\r
UINTN
(EFIAPI *VALUE_TO_UNISTRING) (
IN UINTN Width
);\r
\r
+/**
+ Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated
+ ASCII format string and a VA_LIST argument list.
+
+ Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer
+ and BufferSize.
+ The ASCII string is produced by parsing the format string specified by FormatString.
+ Arguments are pulled from the variable argument list specified by Marker based on
+ the contents of the format string.
+ The number of ASCII characters in the produced output buffer is returned not including
+ the Null-terminator.
+ If BufferSize is 0, then no output buffer is produced and 0 is returned.
+
+ If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().
+ If BufferSize > 0 and FormatString is NULL, then ASSERT().
+ If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than
+ PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then
+ ASSERT().
+ If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string
+ contains more than PcdMaximumAsciiStringLength ASCII characters not including the
+ Null-terminator, then ASSERT().
+
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
+ ASCII string.
+ @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
+ @param FormatString Null-terminated Unicode format string.
+ @param Marker VA_LIST marker for the variable argument list.
+
+ @return The number of ASCII characters in the produced output buffer not including the
+ Null-terminator.
+
+**/\r
typedef\r
UINTN
(EFIAPI *ASCII_VSPRINT) (
IN VA_LIST Marker
);\r
\r
+/**
+ Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated
+ ASCII format string and a VA_LIST argument list.
+
+ Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer
+ and BufferSize.
+ The ASCII string is produced by parsing the format string specified by FormatString.
+ Arguments are pulled from the variable argument list specified by Marker based on
+ the contents of the format string.
+ The number of ASCII characters in the produced output buffer is returned not including
+ the Null-terminator.
+ If BufferSize is 0, then no output buffer is produced and 0 is returned.
+
+ If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().
+ If BufferSize > 0 and FormatString is NULL, then ASSERT().
+ If BufferSize > 0 and FormatString is not aligned on a 16-bit boundary, then ASSERT().
+ If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than
+ PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then
+ ASSERT().
+ If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string
+ contains more than PcdMaximumAsciiStringLength ASCII characters not including the
+ Null-terminator, then ASSERT().
+
+ @param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
+ ASCII string.
+ @param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
+ @param FormatString Null-terminated Unicode format string.
+ @param Marker VA_LIST marker for the variable argument list.
+
+ @return The number of ASCII characters in the produced output buffer not including the
+ Null-terminator.
+
+**/\r
typedef\r
UINTN
(EFIAPI *ASCII_VSPRINT_UNI) (
IN VA_LIST Marker
);\r
\r
+/**
+ Converts a decimal value to a Null-terminated ASCII string.
+
+ Converts the decimal number specified by Value to a Null-terminated ASCII string
+ specified by Buffer containing at most Width characters. No padding of spaces
+ is ever performed.
+ If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.
+ The number of ASCII characters in Buffer is returned not including the Null-terminator.
+ If the conversion contains more than Width characters, then only the first Width
+ characters are returned, and the total number of characters required to perform
+ the conversion is returned.
+ Additional conversion parameters are specified in Flags.
+ The Flags bit LEFT_JUSTIFY is always ignored.
+ All conversions are left justified in Buffer.
+ If Width is 0, PREFIX_ZERO is ignored in Flags.
+ If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas
+ are inserted every 3rd digit starting from the right.
+ If HEX_RADIX is set in Flags, then the output buffer will be
+ formatted in hexadecimal format.
+ If Value is < 0 and HEX_RADIX is not set in Flags, then the fist character in Buffer is a '-'.
+ If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored,
+ then Buffer is padded with '0' characters so the combination of the optional '-'
+ sign character, '0' characters, digit characters for Value, and the Null-terminator
+ add up to Width characters.
+
+ If Buffer is NULL, then ASSERT().
+ If unsupported bits are set in Flags, then ASSERT().
+ If both COMMA_TYPE and HEX_RADIX are set in Flags, then ASSERT().
+ If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()
+
+ @param Buffer Pointer to the output buffer for the produced Null-terminated
+ ASCII string.
+ @param Flags The bitmask of flags that specify left justification, zero pad, and commas.
+ @param Value The 64-bit signed value to convert to a string.
+ @param Width The maximum number of ASCII characters to place in Buffer, not including
+ the Null-terminator.
+
+ @return The number of ASCII characters in Buffer not including the Null-terminator.
+
+**/\r
typedef\r
UINTN
(EFIAPI *VALUE_TO_ASCIISTRING) (
-/*++\r
+/** @file\r
\r
-Copyright (c) 2006, Intel Corporation \r
+ Tcg addtional services to measure PeImage and ActionString\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
- TcgPlatform.h\r
-\r
-Abstract:\r
- Tcg addtional services to measure PeImage and ActionString\r
-\r
---*/\r
+**/\r
\r
#ifndef _TCG_PLATFORM_PROTOCOL_H_\r
#define _TCG_PLATFORM_PROTOCOL_H_\r
\r
#pragma pack(1)\r
\r
+//\r
+// Variable Store region header\r
+//\r
typedef struct {\r
UINT32 Signature;\r
UINT32 Size;\r
UINT32 Reserved1;\r
} VARIABLE_STORE_HEADER;\r
\r
+//\r
+// Variable header structure\r
+//\r
typedef struct {\r
UINT16 StartId;\r
UINT8 State;\r
-/*++\r
+/** @file\r
\r
-Copyright (c) 2006, Intel Corporation\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
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
- EfiWorkingBlockHeader.h\r
-\r
-Abstract:\r
-\r
- Defines data structure that is the headers found at the runtime\r
- updatable firmware volumes, such as the FileSystemGuid of the\r
- working block, the header structure of the variable block, FTW\r
- working block, or event log block.\r
-\r
---*/\r
+**/\r
\r
#ifndef __EFI_WORKING_BLOCK_HEADER_H__\r
#define __EFI_WORKING_BLOCK_HEADER_H__\r
-/*++\r
+/** @file\r
+\r
+ Implements CRC32 guided section handler to parse CRC32 encapsulation section, \r
+ extract data and authenticate 32 bit CRC value.\r
\r
-Copyright (c) 2007, Intel Corporation \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
- DxeCrc32GuidedSectionExtractLib.c\r
-\r
-Abstract:\r
-\r
- Implements GUIDed section extraction protocol interface with \r
- a specific GUID: CRC32.\r
-\r
- Please refer to the Framewokr Firmware Volume Specification 0.9.\r
-\r
---*/\r
+**/\r
\r
#include <PiDxe.h>\r
#include <Protocol/Crc32GuidedSectionExtraction.h>\r
-/*++\r
+/** @file\r
\r
-Copyright (c) 2006, Intel Corporation\r
+ Implement the print library instance by wrap the interface \r
+ provided in the Print protocol. This protocol is defined as the internal\r
+ protocol related to this implementation, not in the public spec. So, this \r
+ library instance is only for this code base.\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
- PrintLib.c\r
-\r
-Abstract:\r
-\r
- Print Library\r
-\r
---*/\r
+**/\r
\r
#include <PiDxe.h>\r
\r
/**@file\r
\r
- Firmware Volume Block Protocol Runtime Abstraction\r
+ Firmware Volume Block Protocol Runtime Interface Abstraction\r
+ And FVB Extension protocol Runtime Interface Abstraction\r
\r
mFvbEntry is an array of Handle Fvb pairs. The Fvb Lib Instance matches the\r
index in the mFvbEntry array. This should be the same sequence as the FVB's\r
\r
If you are using any of these lib functions.you must first call FvbInitialize ().\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
- The internal header file for EdkFvbServiceLib.\r
+/** @file \r
+ The internal header file includes the common header files, defines\r
+ internal structure FVB_ENTRY.\r
\r
-Copyright (c) 2006, Intel Corporation. <BR>\r
+Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions\r
-/*++\r
+/** @file\r
+\r
+ Emulation Variable services operate on the runtime volatile memory.\r
+ The nonvolatile variable space doesn't exist.\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
- EmuVariable.c\r
-\r
-Abstract:\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
\r
#include "Variable.h"\r
\r
-/*++\r
+/** @file\r
\r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+ Implment all four UEFI runtime variable services and \r
+ install variable architeture protocol.\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
- InitVariable.c\r
-\r
-Abstract:\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
\r
#include "Variable.h"\r
\r
-/*++\r
+/** @file\r
\r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+ The internal header file includes the common header files, defines\r
+ internal structure and functions used by EmuVariable module.\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
- Variable.h\r
-\r
-Abstract:\r
-\r
---*/\r
+**/\r
\r
#ifndef _VARIABLE_H\r
#define _VARIABLE_H\r
/** @file\r
- Variable worker functions.\r
\r
- Copyright (c) 2006, Intel Corporation<BR>\r
+ Variable worker functions specific for IPF arch.\r
+\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
-/*++\r
+/** @file\r
+\r
+ Implement ReadOnly Variable Services required by PEIM and install\r
+ PI ReadOnly Varaiable2 PPI. These services operates the non volatile storage space.\r
\r
Copyright (c) 2006 - 2008 Intel Corporation. <BR>\r
All rights reserved. This program and the accompanying materials\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
Module Name:\r
\r
- Variable.c\r
-\r
-Abstract:\r
-\r
- PEIM to provide the Variable functionality\r
-\r
---*/\r
+**/\r
\r
\r
#include "Variable.h"\r
-/*++\r
+/** @file\r
+\r
+ The internal header file includes the common header files, defines\r
+ internal structure and functions used by PeiVariable module.\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
- Variable.h\r
-\r
-Abstract:\r
-\r
- Tiano PEIM to provide the variable functionality\r
-\r
---*/\r
+**/\r
\r
#ifndef _PEI_VARIABLE_H\r
#define _PEI_VARIABLE_H\r
-/*++\r
+/** @file\r
\r
-Copyright (c) 2007, Intel Corporation\r
+ Variable worker functions specific for IA32, X64 and EBC.\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
- VariableWorker.c\r
-\r
-Abstract:\r
-\r
- PEIM to provide the Variable functionality\r
-\r
---*/\r
+**/\r
\r
#include <Variable.h>\r
\r
/** @file\r
- EFI Runtime Variable services.\r
+\r
+ Implement all four UEFI Runtime Variable services for the nonvolatile\r
+ and volatile storage space and install variable architecture protocol.\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
+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
-/*++\r
+/** @file\r
\r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+ The internal header file includes the common header files, defines\r
+ internal structure and functions used by RuntimeVariable module.\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
- Variable.h\r
-\r
-Abstract:\r
-\r
---*/\r
+**/\r
\r
#ifndef _VARIABLE_H\r
#define _VARIABLE_H\r
-/*++\r
+/** @file\r
+ \r
+ Handles non-volatile variable store garbage collection, using FTW\r
+ (Fault Tolerant Write) protocol.\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
- reclaim.c\r
-\r
-Abstract:\r
-\r
- Handles non-volatile variable store garbage collection, using FTW\r
- (Fault Tolerant Write) protocol.\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
\r
\r
#include "Variable.h"\r
-/*++\r
-\r
-Copyright (c) 2006, Intel Corporation\r
+/** @file\r
+ \r
+ Generic watchdog timer services implemenetation using UEFI APIs and\r
+ install watchdog timer architecture protocol.\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
- WatchdogTimer.c\r
-\r
-Abstract:\r
-\r
- Generic watchdog timer implemenetation using EFI APIs\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
\r
#include "WatchdogTimer.h"\r
\r
-/*++\r
+/** @file\r
\r
-Copyright (c) 2006, Intel Corporation \r
+ The internal header file includes the common header files, defines\r
+ internal functions used by WatchDogTimer module. \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
- WatchdogTimer.h\r
-\r
-Abstract:\r
-\r
- Generic watchdog timer implemenetation using EFI APIs\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
\r
#ifndef _WATCHDOG_TIMER_H_\r
#define _WATCHDOG_TIMER_H_\r
projects / mirror_edk2.git / commitdiff