added additional comments and fixed some typo.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5810 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
vanjeff 2008-09-04 06:16:14 +00:00
parent 6fc2b00b1a
commit 7b1bf9f61b
5 changed files with 39 additions and 28 deletions

View File

@ -1,7 +1,7 @@
/** @file /** @file
Present the dependency expression values in PI. Present the dependency expression values in PI.
Copyright (c) 2006 - 2007, Intel Corporation Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at
@ -18,12 +18,14 @@
#define __PI_DEPENDENCY_H__ #define __PI_DEPENDENCY_H__
/// ///
/// If present, this must be the first and only opcode /// If present, this must be the first and only opcode,
/// EFI_DEP_BEFORE is only used by DXE driver.
/// ///
#define EFI_DEP_BEFORE 0x00 #define EFI_DEP_BEFORE 0x00
/// ///
/// If present, this must be the first and only opcode /// If present, this must be the first and only opcode,
/// EFI_DEP_AFTER is only used by DXE driver.
/// ///
#define EFI_DEP_AFTER 0x01 #define EFI_DEP_AFTER 0x01
@ -37,7 +39,8 @@
/// ///
/// If present, this must be the first opcode. /// If present, this must be the first opcode,
/// EFI_DEP_SOR is only used by DXE driver.
/// ///
#define EFI_DEP_SOR 0x09 #define EFI_DEP_SOR 0x09

View File

@ -1,7 +1,7 @@
/** @file /** @file
Include file matches things in PI. Include file matches things in PI.
Copyright (c) 2006 - 2007, Intel Corporation Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at

View File

@ -1,7 +1,7 @@
/** @file /** @file
The firmware file related definitions in PI. The firmware file related definitions in PI.
Copyright (c) 2006 - 2007, Intel Corporation Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at
@ -225,6 +225,10 @@ typedef struct {
typedef struct { typedef struct {
EFI_COMMON_SECTION_HEADER CommonHeader; EFI_COMMON_SECTION_HEADER CommonHeader;
UINT16 BuildNumber; UINT16 BuildNumber;
///
/// Array of unicode string.
///
CHAR16 VersionString[1]; CHAR16 VersionString[1];
} EFI_VERSION_SECTION; } EFI_VERSION_SECTION;

View File

@ -1,7 +1,7 @@
/** @file /** @file
HOB related definitions in PI. HOB related definitions in PI.
Copyright (c) 2006 - 2007, Intel Corporation Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at
@ -69,9 +69,11 @@ typedef struct {
EFI_PHYSICAL_ADDRESS EfiEndOfHobList; EFI_PHYSICAL_ADDRESS EfiEndOfHobList;
} EFI_HOB_HANDOFF_INFO_TABLE; } EFI_HOB_HANDOFF_INFO_TABLE;
///
/// EFI_HOB_MEMORY_ALLOCATION_HEADER describes the /// EFI_HOB_MEMORY_ALLOCATION_HEADER describes the
/// various attributes of the logical memory allocation. The type field will be used for /// various attributes of the logical memory allocation. The type field will be used for
/// subsequent inclusion in the UEFI memory map. /// subsequent inclusion in the UEFI memory map.
///
typedef struct { typedef struct {
/// ///
/// A GUID that defines the memory allocation region¡¯s type and purpose, as well as /// A GUID that defines the memory allocation region¡¯s type and purpose, as well as
@ -87,7 +89,9 @@ typedef struct {
/// specification. /// specification.
EFI_PHYSICAL_ADDRESS MemoryBaseAddress; EFI_PHYSICAL_ADDRESS MemoryBaseAddress;
///
/// The length in bytes of memory allocated by this HOB. /// The length in bytes of memory allocated by this HOB.
///
UINT64 MemoryLength; UINT64 MemoryLength;
/// ///

View File

@ -1,7 +1,7 @@
/** @file /** @file
PI PEI master include file. This file should match the PI spec. PI PEI master include file. This file should match the PI spec.
Copyright (c) 2006 - 2007, Intel Corporation Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at
@ -282,7 +282,7 @@ EFI_STATUS
IN CONST EFI_PEI_SERVICES **PeiServices, IN CONST EFI_PEI_SERVICES **PeiServices,
IN UINT16 Type, IN UINT16 Type,
IN UINT16 Length, IN UINT16 Length,
OUT VOID **Hob IN OUT VOID **Hob
); );
/** /**
@ -297,7 +297,7 @@ EFI_STATUS
@retval EFI_SUCCESS The volume was found. @retval EFI_SUCCESS The volume was found.
@retval EFI_NOT_FOUND The volume was not found. @retval EFI_NOT_FOUND The volume was not found.
@retval EFI_INVALID_PARAMETER VolHandle is NULL @retval EFI_INVALID_PARAMETER VolumeHandle is NULL.
**/ **/
typedef typedef