sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Grammatical and disclaimer changes (does not follow internal C coding stds.)

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10235 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
myronporter
2010-03-12 22:19:12 +00:00
parent 636f2be673
commit af2dc6a70b
85 changed files with 2610 additions and 2573 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
MdePkg/Include/Uefi/UefiBaseType.h
View File

@@ -1,15 +1,14 @@
/** @file
Defines data types and constants introduced in UEFI.
Copyright (c) 2006 - 2009, Intel Corporation<BR>
Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<BR>
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.
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that 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.
**/
@@ -27,7 +26,7 @@
///
typedef GUID EFI_GUID;
///
/// Function return status for EFI API
/// Function return status for EFI API.
///
typedef RETURN_STATUS EFI_STATUS;
///
@@ -91,7 +90,7 @@ typedef struct {
} EFI_IPv4_ADDRESS;
///
/// 16-byte buffer. An IPv6 internet protocol address
/// 16-byte buffer. An IPv6 internet protocol address.
///
typedef struct {
UINT8 Addr[16];
@@ -194,27 +193,27 @@ typedef union {
#define EFI_PAGES_TO_SIZE(a) ( (a) << EFI_PAGE_SHIFT)
///
/// PE32+ Machine type for IA32 UEFI images
/// PE32+ Machine type for IA32 UEFI images.
///
#define EFI_IMAGE_MACHINE_IA32 0x014C
///
/// PE32+ Machine type for IA64 UEFI images
/// PE32+ Machine type for IA64 UEFI images.
///
#define EFI_IMAGE_MACHINE_IA64 0x0200
///
/// PE32+ Machine type for EBC UEFI images
/// PE32+ Machine type for EBC UEFI images.
///
#define EFI_IMAGE_MACHINE_EBC 0x0EBC
///
/// PE32+ Machine type for X64 UEFI images
/// PE32+ Machine type for X64 UEFI images.
///
#define EFI_IMAGE_MACHINE_X64 0x8664
///
/// PE32+ Machine type for ARM mixed ARM and Thumb/Thumb2 images
/// PE32+ Machine type for ARM mixed ARM and Thumb/Thumb2 images.
///
#define EFI_IMAGE_MACHINE_ARMTHUMB_MIXED 0x01C2

26
MdePkg/Include/Uefi/UefiGpt.h
View File

@@ -1,14 +1,14 @@
/** @file
EFI Guid Partition Table Format Definition.
Copyright (c) 2006 - 2009, 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.
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that 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.
**/
@@ -21,19 +21,19 @@
///
#define PRIMARY_PART_HEADER_LBA 1
///
/// EFI Partition Table Signature: "EFI PART"
/// EFI Partition Table Signature: "EFI PART".
///
#define EFI_PTAB_HEADER_ID SIGNATURE_64 ('E','F','I',' ','P','A','R','T')
#pragma pack(1)
///
/// GPT Partition Table Header
/// GPT Partition Table Header.
///
typedef struct {
///
/// The table header for the GPT partition Table.
/// This header contains EFI_PTAB_HEADER_ID
/// This header contains EFI_PTAB_HEADER_ID.
///
EFI_TABLE_HEADER Header;
///
@@ -82,7 +82,7 @@ typedef struct {
} EFI_PARTITION_TABLE_HEADER;
///
/// GPT Partition Entry
/// GPT Partition Entry.
///
typedef struct {
///
@@ -110,7 +110,7 @@ typedef struct {
/// partition indicates that deletion or modification of the contents can result in loss of platform
/// features or failure for the platform to boot or operate. The system cannot function normally if
/// this partition is removed, and it should be considered part of the hardware of the system.
/// Actions such as running diagnostics, system recovery, or even OS install or boot could
/// Actions such as running diagnostics, system recovery, or even OS install or boot, could
/// potentially stop working if this partition is removed. Unless OS software or firmware
/// recognizes this partition, it should never be removed or modified as the UEFI firmware or
/// platform hardware may become non-functional.

46
MdePkg/Include/Uefi/UefiInternalFormRepresentation.h
View File

@@ -3,14 +3,14 @@
IFR is primarily consumed by the EFI presentation engine, and produced by EFI
internal application and drivers as well as all add-in card option-ROM drivers
Copyright (c) 2006 - 2010, 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.
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that 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.
@par Revision Reference:
These definitions are from UEFI 2.1 and 2.2.
@@ -86,7 +86,7 @@ typedef struct {
//
///
/// Contents of EFI_NARROW_GLYPH.Attributes
/// Contents of EFI_NARROW_GLYPH.Attributes.
///@{
#define EFI_GLYPH_NON_SPACING 0x01
#define EFI_GLYPH_WIDE 0x02
@@ -187,7 +187,7 @@ typedef struct _EFI_HII_GLYPH_INFO {
} EFI_HII_GLYPH_INFO;
///
/// The fixed header consists of a standard record header and
/// The fixed header consists of a standard record header,
/// then the character values in this section, the flags
/// (including the encoding method) and the offsets of the glyph
/// information, the glyph bitmaps and the character map.
@@ -1274,10 +1274,10 @@ typedef struct _EFI_IFR_TO_BOOLEAN {
///
/// For EFI_IFR_TO_STRING, when converting from
/// unsigned integers, these flags control the format:
/// 0 = unsigned decimal
/// 1 = signed decimal
/// 2 = hexadecimal (lower-case alpha)
/// 3 = hexadecimal (upper-case alpha)
/// 0 = unsigned decimal.
/// 1 = signed decimal.
/// 2 = hexadecimal (lower-case alpha).
/// 3 = hexadecimal (upper-case alpha).
///@{
#define EFI_IFR_STRING_UNSIGNED_DEC 0
#define EFI_IFR_STRING_SIGNED_DEC 1
@@ -1287,8 +1287,8 @@ typedef struct _EFI_IFR_TO_BOOLEAN {
///
/// When converting from a buffer, these flags control the format:
/// 0 = ASCII
/// 8 = Unicode
/// 0 = ASCII.
/// 8 = Unicode.
///@{
#define EFI_IFR_STRING_ASCII 0
#define EFI_IFR_STRING_UNICODE 8
@@ -1778,7 +1778,7 @@ typedef struct _EFI_IFR_ANIMATION {
} EFI_IFR_ANIMATION;
///
/// HII animation package header
/// HII animation package header.
///
typedef struct _EFI_HII_ANIMATION_PACKAGE_HDR {
///
@@ -1794,7 +1794,7 @@ typedef struct _EFI_HII_ANIMATION_PACKAGE_HDR {
///
/// Animation information is encoded as a series of blocks,
/// with each block prefixed by a single byte header EFI_HII_ANIMATION_BLOCK
/// with each block prefixed by a single byte header EFI_HII_ANIMATION_BLOCK.
///
typedef struct _EFI_HII_ANIMATION_BLOCK {
UINT8 BlockType;
@@ -1802,7 +1802,7 @@ typedef struct _EFI_HII_ANIMATION_BLOCK {
} EFI_HII_ANIMATION_BLOCK;
///
/// Animation block types
/// Animation block types.
///
#define EFI_HII_AIBT_END 0x00
#define EFI_HII_AIBT_OVERLAY_IMAGES 0x10
@@ -1825,11 +1825,11 @@ typedef struct _EFI_HII_ANIMATION_BLOCK {
typedef struct _EFI_HII_AIBT_EXT1_BLOCK {
///
/// Standard animation header, where Header.BlockType = EFI_HII_AIBT_EXT1
/// Standard animation header, where Header.BlockType = EFI_HII_AIBT_EXT1.
///
EFI_HII_ANIMATION_BLOCK Header;
///
/// The block type
/// The block type.
///
UINT8 BlockType2;
///
@@ -1840,7 +1840,7 @@ typedef struct _EFI_HII_AIBT_EXT1_BLOCK {
typedef struct _EFI_HII_AIBT_EXT2_BLOCK {
///
/// Standard animation header, where Header.BlockType = EFI_HII_AIBT_EXT2
/// Standard animation header, where Header.BlockType = EFI_HII_AIBT_EXT2.
///
EFI_HII_ANIMATION_BLOCK Header;
///
@@ -1855,7 +1855,7 @@ typedef struct _EFI_HII_AIBT_EXT2_BLOCK {
typedef struct _EFI_HII_AIBT_EXT4_BLOCK {
///
/// Standard animation header, where Header.BlockType = EFI_HII_AIBT_EXT4
/// Standard animation header, where Header.BlockType = EFI_HII_AIBT_EXT4.
///
EFI_HII_ANIMATION_BLOCK Header;
///

20
MdePkg/Include/Uefi/UefiMultiPhase.h
View File

@@ -1,14 +1,14 @@
/** @file
This includes some definitions introduced in UEFI that will be used in both PEI and DXE phases.
Copyright (c) 2006 - 2009, 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.
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that 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.
**/
@@ -35,7 +35,7 @@ typedef enum {
///
EfiLoaderData,
///
/// The code portions of a loaded Boot Services Driver
/// The code portions of a loaded Boot Services Driver.
///
EfiBootServicesCode,
///
@@ -144,7 +144,7 @@ typedef struct {
/// key associated w/ the public/private 2048-bit RSA key-pair. The
/// WIN_CERTIFICATE shall be used to describe the signature of the
/// Variable data *Data. In addition, the signature will also
/// include the MonotonicCount value to guard against replay attacks
/// include the MonotonicCount value to guard against replay attacks.
///
typedef struct {
///

196
MdePkg/Include/Uefi/UefiPxe.h
View File

@@ -3,18 +3,18 @@
structure prototypes, global variables and constants that
are needed for porting PXE to EFI.
Copyright (c) 2006 - 2010, 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.
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that 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.
@par Revision Reference:
32/64-bit PXE specification:
alpha-4, 99-Dec-17
alpha-4, 99-Dec-17.
**/
@@ -30,12 +30,12 @@
)
///
/// UNDI ROM ID and devive ID signature
/// UNDI ROM ID and devive ID signature.
///
#define PXE_BUSTYPE_PXE PXE_BUSTYPE ('!', 'P', 'X', 'E')
///
/// BUS ROM ID signatures
/// BUS ROM ID signatures.
///
#define PXE_BUSTYPE_PCI PXE_BUSTYPE ('P', 'C', 'I', 'R')
#define PXE_BUSTYPE_PC_CARD PXE_BUSTYPE ('P', 'C', 'C', 'R')
@@ -76,7 +76,7 @@ typedef UINT32 PXE_UINT32;
typedef UINTN PXE_UINTN;
///
/// typedef unsigned long PXE_UINT64;
/// Typedef unsigned long PXE_UINT64.
///
typedef UINT64 PXE_UINT64;
@@ -226,12 +226,12 @@ typedef PXE_UINT16 PXE_OPFLAGS;
#define PXE_OPFLAGS_RESET_DISABLE_FILTERS 0x0002
///
/// UNDI Shutdown
/// UNDI Shutdown.
///
/// No OpFlags
/// No OpFlags.
///
/// UNDI Interrupt Enables
/// UNDI Interrupt Enables.
///
///
/// Select whether to enable or disable external interrupt signals.
@@ -267,7 +267,7 @@ typedef PXE_UINT16 PXE_OPFLAGS;
#define PXE_OPFLAGS_INTERRUPT_SOFTWARE 0x0008
///
/// UNDI Receive Filters
/// UNDI Receive Filters.
///
///
/// Select whether to enable or disable receive filters.
@@ -315,20 +315,20 @@ typedef PXE_UINT16 PXE_OPFLAGS;
#define PXE_OPFLAGS_RECEIVE_FILTER_ALL_MULTICAST 0x0010
///
/// UNDI Station Address
/// UNDI Station Address.
///
#define PXE_OPFLAGS_STATION_ADDRESS_READ 0x0000
#define PXE_OPFLAGS_STATION_ADDRESS_WRITE 0x0000
#define PXE_OPFLAGS_STATION_ADDRESS_RESET 0x0001
///
/// UNDI Statistics
/// UNDI Statistics.
///
#define PXE_OPFLAGS_STATISTICS_READ 0x0000
#define PXE_OPFLAGS_STATISTICS_RESET 0x0001
///
/// UNDI MCast IP to MAC
/// UNDI MCast IP to MAC.
///
///
/// Identify the type of IP address in the CPB.
@@ -338,7 +338,7 @@ typedef PXE_UINT16 PXE_OPFLAGS;
#define PXE_OPFLAGS_MCAST_IPV6_TO_MAC 0x0001
///
/// UNDI NvData
/// UNDI NvData.
///
///
/// Select the type of non-volatile data operation.
@@ -348,7 +348,7 @@ typedef PXE_UINT16 PXE_OPFLAGS;
#define PXE_OPFLAGS_NVDATA_WRITE 0x0001
///
/// UNDI Get Status
/// UNDI Get Status.
///
///
/// Return current interrupt status. This will also clear any interrupts
@@ -374,14 +374,14 @@ typedef PXE_UINT16 PXE_OPFLAGS;
#define PXE_OPFLAGS_GET_MEDIA_STATUS 0x0004
///
/// UNDI Fill Header
/// UNDI Fill Header.
///
#define PXE_OPFLAGS_FILL_HEADER_OPMASK 0x0001
#define PXE_OPFLAGS_FILL_HEADER_FRAGMENTED 0x0001
#define PXE_OPFLAGS_FILL_HEADER_WHOLE 0x0000
///
/// UNDI Transmit
/// UNDI Transmit.
///
///
/// S/W UNDI only. Return after the packet has been transmitted. A
@@ -397,13 +397,13 @@ typedef PXE_UINT16 PXE_OPFLAGS;
#define PXE_OPFLAGS_TRANSMIT_WHOLE 0x0000
///
/// UNDI Receive
/// UNDI Receive.
///
/// No OpFlags
/// No OpFlags.
///
///
/// PXE STATFLAGS
/// PXE STATFLAGS.
///
typedef PXE_UINT16 PXE_STATFLAGS;
@@ -423,7 +423,7 @@ typedef PXE_UINT16 PXE_STATFLAGS;
#define PXE_STATFLAGS_COMMAND_QUEUED 0x4000
///
/// UNDI Get State
/// UNDI Get State.
///
#define PXE_STATFLAGS_GET_STATE_MASK 0x0003
#define PXE_STATFLAGS_GET_STATE_INITIALIZED 0x0002
@@ -431,13 +431,13 @@ typedef PXE_UINT16 PXE_STATFLAGS;
#define PXE_STATFLAGS_GET_STATE_STOPPED 0x0000
///
/// UNDI Start
/// UNDI Start.
///
/// No additional StatFlags
/// No additional StatFlags.
///
///
/// UNDI Get Init Info
/// UNDI Get Init Info.
///
#define PXE_STATFLAGS_CABLE_DETECT_MASK 0x0001
#define PXE_STATFLAGS_CABLE_DETECT_NOT_SUPPORTED 0x0000
@@ -448,22 +448,22 @@ typedef PXE_UINT16 PXE_STATFLAGS;
#define PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED 0x0002
///
/// UNDI Initialize
/// UNDI Initialize.
///
#define PXE_STATFLAGS_INITIALIZED_NO_MEDIA 0x0001
///
/// UNDI Reset
/// UNDI Reset.
///
#define PXE_STATFLAGS_RESET_NO_MEDIA 0x0001
///
/// UNDI Shutdown
/// UNDI Shutdown.
///
/// No additional StatFlags
/// No additional StatFlags.
///
/// UNDI Interrupt Enables
/// UNDI Interrupt Enables.
///
///
/// If set, receive interrupts are enabled.
@@ -481,7 +481,7 @@ typedef PXE_UINT16 PXE_STATFLAGS;
#define PXE_STATFLAGS_INTERRUPT_COMMAND 0x0004
///
/// UNDI Receive Filters
/// UNDI Receive Filters.
///
///
@@ -511,30 +511,30 @@ typedef PXE_UINT16 PXE_STATFLAGS;
#define PXE_STATFLAGS_RECEIVE_FILTER_ALL_MULTICAST 0x0010
///
/// UNDI Station Address
/// UNDI Station Address.
///
/// No additional StatFlags
/// No additional StatFlags.
///
///
/// UNDI Statistics
/// UNDI Statistics.
///
/// No additional StatFlags
/// No additional StatFlags.
///
///
//// UNDI MCast IP to MAC
//// UNDI MCast IP to MAC.
////
//// No additional StatFlags
//// No additional StatFlags.
///
/// UNDI NvData
/// UNDI NvData.
///
/// No additional StatFlags
/// No additional StatFlags.
///
///
/// UNDI Get Status
/// UNDI Get Status.
///
///
@@ -581,19 +581,19 @@ typedef PXE_UINT16 PXE_STATFLAGS;
#define PXE_STATFLAGS_GET_STATUS_NO_MEDIA 0x0040
///
/// UNDI Fill Header
/// UNDI Fill Header.
///
/// No additional StatFlags
/// No additional StatFlags.
///
///
/// UNDI Transmit
/// UNDI Transmit.
///
/// No additional StatFlags.
///
/// UNDI Receive
///
///.
///
/// No additional StatFlags.
@@ -715,28 +715,28 @@ typedef UINT16 PXE_MEDIA_PROTOCOL;
#define PXE_IFTYPE_FIBRE_CHANNEL 0x12
typedef struct s_pxe_hw_undi {
PXE_UINT32 Signature; ///< PXE_ROMID_SIGNATURE
PXE_UINT8 Len; ///< sizeof(PXE_HW_UNDI)
PXE_UINT8 Fudge; ///< makes 8-bit cksum equal zero
PXE_UINT8 Rev; ///< PXE_ROMID_REV
PXE_UINT8 IFcnt; ///< physical connector count
PXE_UINT8 MajorVer; ///< PXE_ROMID_MAJORVER
PXE_UINT8 MinorVer; ///< PXE_ROMID_MINORVER
PXE_UINT16 reserved; ///< zero, not used
PXE_UINT32 Implementation; ///< implementation flags
///< reserved ///< vendor use
///< UINT32 Status; ///< status port
///< UINT32 Command; ///< command port
///< UINT64 CDBaddr; ///< CDB address port
PXE_UINT32 Signature; ///< PXE_ROMID_SIGNATURE.
PXE_UINT8 Len; ///< sizeof(PXE_HW_UNDI).
PXE_UINT8 Fudge; ///< makes 8-bit cksum equal zero.
PXE_UINT8 Rev; ///< PXE_ROMID_REV.
PXE_UINT8 IFcnt; ///< physical connector count.
PXE_UINT8 MajorVer; ///< PXE_ROMID_MAJORVER.
PXE_UINT8 MinorVer; ///< PXE_ROMID_MINORVER.
PXE_UINT16 reserved; ///< zero, not used.
PXE_UINT32 Implementation; ///< implementation flags.
///< reserved ///< vendor use.
///< UINT32 Status; ///< status port.
///< UINT32 Command; ///< command port.
///< UINT64 CDBaddr; ///< CDB address port.
///<
} PXE_HW_UNDI;
///
/// Status port bit definitions
/// Status port bit definitions.
///
///
/// UNDI operation state
/// UNDI operation state.
///
#define PXE_HWSTAT_STATE_MASK 0xC0000000
#define PXE_HWSTAT_BUSY 0xC0000000
@@ -745,12 +745,12 @@ typedef struct s_pxe_hw_undi {
#define PXE_HWSTAT_STOPPED 0x00000000
///
/// If set, last command failed
/// If set, last command failed.
///
#define PXE_HWSTAT_COMMAND_FAILED 0x20000000
///
/// If set, identifies enabled receive filters
/// If set, identifies enabled receive filters.
///
#define PXE_HWSTAT_PROMISCUOUS_MULTICAST_RX_ENABLED 0x00001000
#define PXE_HWSTAT_PROMISCUOUS_RX_ENABLED 0x00000800
@@ -759,7 +759,7 @@ typedef struct s_pxe_hw_undi {
#define PXE_HWSTAT_UNICAST_RX_ENABLED 0x00000100
///
/// If set, identifies enabled external interrupts
/// If set, identifies enabled external interrupts.
///
#define PXE_HWSTAT_SOFTWARE_INT_ENABLED 0x00000080
#define PXE_HWSTAT_TX_COMPLETE_INT_ENABLED 0x00000040
@@ -767,7 +767,7 @@ typedef struct s_pxe_hw_undi {
#define PXE_HWSTAT_CMD_COMPLETE_INT_ENABLED 0x00000010
///
/// If set, identifies pending interrupts
/// If set, identifies pending interrupts.
///
#define PXE_HWSTAT_SOFTWARE_INT_PENDING 0x00000008
#define PXE_HWSTAT_TX_COMPLETE_INT_PENDING 0x00000004
@@ -775,7 +775,7 @@ typedef struct s_pxe_hw_undi {
#define PXE_HWSTAT_CMD_COMPLETE_INT_PENDING 0x00000001
///
/// Command port definitions
/// Command port definitions.
///
///
@@ -795,7 +795,7 @@ typedef struct s_pxe_hw_undi {
#define PXE_HWCMD_UNICAST_RX_ENABLE 0x00000100
///
/// Use these to enable/disable external interrupts
/// Use these to enable/disable external interrupts.
///
#define PXE_HWCMD_SOFTWARE_INT_ENABLE 0x00000080
#define PXE_HWCMD_TX_COMPLETE_INT_ENABLE 0x00000040
@@ -803,7 +803,7 @@ typedef struct s_pxe_hw_undi {
#define PXE_HWCMD_CMD_COMPLETE_INT_ENABLE 0x00000010
///
/// Use these to clear pending external interrupts
/// Use these to clear pending external interrupts.
///
#define PXE_HWCMD_CLEAR_SOFTWARE_INT 0x00000008
#define PXE_HWCMD_CLEAR_TX_COMPLETE_INT 0x00000004
@@ -811,19 +811,19 @@ typedef struct s_pxe_hw_undi {
#define PXE_HWCMD_CLEAR_CMD_COMPLETE_INT 0x00000001
typedef struct s_pxe_sw_undi {
PXE_UINT32 Signature; ///< PXE_ROMID_SIGNATURE
PXE_UINT8 Len; ///< sizeof(PXE_SW_UNDI)
PXE_UINT8 Fudge; ///< makes 8-bit cksum zero
PXE_UINT8 Rev; ///< PXE_ROMID_REV
PXE_UINT8 IFcnt; ///< physical connector count
PXE_UINT8 MajorVer; ///< PXE_ROMID_MAJORVER
PXE_UINT8 MinorVer; ///< PXE_ROMID_MINORVER
PXE_UINT16 reserved1; ///< zero, not used
PXE_UINT32 Implementation; ///< Implementation flags
PXE_UINT64 EntryPoint; ///< API entry point
PXE_UINT8 reserved2[3]; ///< zero, not used
PXE_UINT8 BusCnt; ///< number of bustypes supported
PXE_UINT32 BusType[1]; ///< list of supported bustypes
PXE_UINT32 Signature; ///< PXE_ROMID_SIGNATURE.
PXE_UINT8 Len; ///< sizeof(PXE_SW_UNDI).
PXE_UINT8 Fudge; ///< makes 8-bit cksum zero.
PXE_UINT8 Rev; ///< PXE_ROMID_REV.
PXE_UINT8 IFcnt; ///< physical connector count.
PXE_UINT8 MajorVer; ///< PXE_ROMID_MAJORVER.
PXE_UINT8 MinorVer; ///< PXE_ROMID_MINORVER.
PXE_UINT16 reserved1; ///< zero, not used.
PXE_UINT32 Implementation; ///< Implementation flags.
PXE_UINT64 EntryPoint; ///< API entry point.
PXE_UINT8 reserved2[3]; ///< zero, not used.
PXE_UINT8 BusCnt; ///< number of bustypes supported.
PXE_UINT32 BusType[1]; ///< list of supported bustypes.
} PXE_SW_UNDI;
typedef union u_pxe_undi {
@@ -832,13 +832,13 @@ typedef union u_pxe_undi {
} PXE_UNDI;
///
/// Signature of !PXE structure
/// Signature of !PXE structure.
///
#define PXE_ROMID_SIGNATURE PXE_BUSTYPE ('!', 'P', 'X', 'E')
///
/// !PXE structure format revision
///
///.
#define PXE_ROMID_REV 0x02
///
@@ -850,7 +850,7 @@ typedef union u_pxe_undi {
#define PXE_ROMID_MINORVER 0x01
///
/// Implementation flags
/// Implementation flags.
///
#define PXE_ROMID_IMP_HW_UNDI 0x80000000
#define PXE_ROMID_IMP_SW_VIRT_ADDR 0x40000000
@@ -921,9 +921,9 @@ typedef union pxe_device {
///
/// cpb and db definitions
///
#define MAX_PCI_CONFIG_LEN 64 ///< # of dwords
#define MAX_EEPROM_LEN 128 ///< # of dwords
#define MAX_XMIT_BUFFERS 32 ///< recycling Q length for xmit_done
#define MAX_PCI_CONFIG_LEN 64 ///< # of dwords.
#define MAX_EEPROM_LEN 128 ///< # of dwords.
#define MAX_XMIT_BUFFERS 32 ///< recycling Q length for xmit_done.
#define MAX_MCAST_ADDRESS_CNT 8
typedef struct s_pxe_cpb_start_30 {
@@ -1048,7 +1048,7 @@ typedef struct s_pxe_cpb_start_31 {
/// used with the DMA, it converts the given virtual address to it's
/// physical address and write that in the mapped address pointer.
///
/// This field can be set to zero if there is no mapping service available
/// This field can be set to zero if there is no mapping service available.
///
UINT64 Map_Mem;
@@ -1056,10 +1056,10 @@ typedef struct s_pxe_cpb_start_31 {
/// PXE_VOID UnMap_Mem(UINT64 unq_id, UINT64 virtual_addr, UINT32 size,
/// UINT32 Direction, UINT64 mapped_addr);
///
/// UNDI will pass the virtual and mapped addresses of a buffer
/// This call will un map the given address
/// UNDI will pass the virtual and mapped addresses of a buffer.
/// This call will un map the given address.
///
/// This field can be set to zero if there is no unmapping service available
/// This field can be set to zero if there is no unmapping service available.
///
UINT64 UnMap_Mem;
@@ -1067,11 +1067,11 @@ typedef struct s_pxe_cpb_start_31 {
/// PXE_VOID Sync_Mem(UINT64 unq_id, UINT64 virtual,
/// UINT32 size, UINT32 Direction, UINT64 mapped_addr);
///
/// UNDI will pass the virtual and mapped addresses of a buffer
/// This call will synchronize the contents of both the virtual and mapped
/// UNDI will pass the virtual and mapped addresses of a buffer.
/// This call will synchronize the contents of both the virtual and mapped.
/// buffers for the given Direction.
///
/// This field can be set to zero if there is no service available
/// This field can be set to zero if there is no service available.
///
UINT64 Sync_Mem;
@@ -1195,7 +1195,7 @@ typedef struct s_pxe_pci_config_info {
UINT32 BusType;
///
/// This identifies the PCI network device that this UNDI interface
/// This identifies the PCI network device that this UNDI interface.
/// is bound to.
///
UINT16 Bus;

89
MdePkg/Include/Uefi/UefiSpec.h
View File

@@ -5,15 +5,14 @@
If a code construct is defined in the UEFI 2.1 specification it must be included
by this include file.
Copyright (c) 2006 - 2010, Intel Corporation<BR>
Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<BR>
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.
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that 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.
**/
@@ -31,20 +30,20 @@
///
typedef enum {
///
/// Allocate any available range of pages that satisfies the request
/// Allocate any available range of pages that satisfies the request.
///
AllocateAnyPages,
///
/// Allocate any available range of pages whose uppermost address is less than
/// or equal to a specified maximum address
/// or equal to a specified maximum address.
///
AllocateMaxAddress,
///
/// Allocate pages at a specified address
/// Allocate pages at a specified address.
///
AllocateAddress,
///
/// Maximum enumeration value that may be used for bounds checking
/// Maximum enumeration value that may be used for bounds checking.
///
MaxAllocateType
} EFI_ALLOCATE_TYPE;
@@ -56,7 +55,7 @@ typedef enum {
#define EFI_TIME_IN_DAYLIGHT 0x02
///
/// Value definition for EFI_TIME.TimeZone
/// Value definition for EFI_TIME.TimeZone.
///
#define EFI_UNSPECIFIED_TIMEZONE 0x07FF
@@ -80,16 +79,16 @@ typedef enum {
#define EFI_MEMORY_RUNTIME 0x8000000000000000ULL
///
/// Memory descriptor version number
/// Memory descriptor version number.
///
#define EFI_MEMORY_DESCRIPTOR_VERSION 1
///
/// Definition of an EFI memory descriptor
/// Definition of an EFI memory descriptor.
///
typedef struct {
///
/// Type of the memory region. See EFI_MEMORY_TYPE
/// Type of the memory region. See EFI_MEMORY_TYPE.
///
UINT32 Type;
///
@@ -120,7 +119,7 @@ typedef struct {
@param Type The type of allocation to perform.
@param MemoryType The type of memory to allocate.
@param Pages The number of contiguous 4 KB pages to allocate.
@param Memory Pointer to a physical address. On input, the way in which the address is
@param Memory The pointer to a physical address. On input, the way in which the address is
used depends on the value of Type.
@retval EFI_SUCCESS The requested pages were allocated.
@@ -219,7 +218,7 @@ EFI_STATUS
/**
Returns pool memory to the system.
@param Buffer Pointer to the buffer to free.
@param Buffer The pointer to the buffer to free.
@retval EFI_SUCCESS The memory was returned to the system.
@retval EFI_INVALID_PARAMETER Buffer was invalid.
@@ -378,7 +377,7 @@ EFI_STATUS
Invoke a notification event
@param Event Event whose notification function is being invoked.
@param Context Pointer to the notification function's context,
@param Context The pointer to the notification function's context,
which is implementation-dependent.
**/
@@ -394,10 +393,10 @@ VOID
@param Type The type of event to create and its mode and attributes.
@param NotifyTpl The task priority level of event notifications, if needed.
@param NotifyFunction Pointer to the event's notification function, if any.
@param NotifyContext Pointer to the notification function's context; corresponds to parameter
@param NotifyFunction The pointer to the event's notification function, if any.
@param NotifyContext The pointer to the notification function's context; corresponds to parameter
Context in the notification function.
@param Event Pointer to the newly created event if the call succeeds; undefined
@param Event The pointer to the newly created event if the call succeeds; undefined
otherwise.
@retval EFI_SUCCESS The event structure was created.
@@ -420,13 +419,13 @@ EFI_STATUS
@param Type The type of event to create and its mode and attributes.
@param NotifyTpl The task priority level of event notifications,if needed.
@param NotifyFunction Pointer to the event's notification function, if any.
@param NotifyContext Pointer to the notification function's context; corresponds to parameter
@param NotifyFunction The pointer to the event's notification function, if any.
@param NotifyContext The pointer to the notification function's context; corresponds to parameter
Context in the notification function.
@param EventGroup Pointer to the unique identifier of the group to which this event belongs.
@param EventGroup The pointer to the unique identifier of the group to which this event belongs.
If this is NULL, then the function behaves as if the parameters were passed
to CreateEvent.
@param Event Pointer to the newly created event if the call succeeds; undefined
@param Event The pointer to the newly created event if the call succeeds; undefined
otherwise.
@retval EFI_SUCCESS The event structure was created.
@@ -450,7 +449,7 @@ EFI_STATUS
///
typedef enum {
///
/// An event's timer settings is to be cancelled and not trigger time is to be set
/// An event's timer settings is to be cancelled and not trigger time is to be set/
///
TimerCancel,
///
@@ -506,7 +505,7 @@ EFI_STATUS
@param NumberOfEvents The number of events in the Event array.
@param Event An array of EFI_EVENT.
@param Index Pointer to the index of the event which satisfied the wait condition.
@param Index The pointer to the index of the event which satisfied the wait condition.
@retval EFI_SUCCESS The event indicated by Index was signaled.
@retval EFI_INVALID_PARAMETER 1) NumberOfEvents is 0.
@@ -811,7 +810,7 @@ EFI_STATUS
@param SourceBuffer If not NULL, a pointer to the memory location containing a copy
of the image to be loaded.
@param SourceSize The size in bytes of SourceBuffer. Ignored if SourceBuffer is NULL.
@param ImageHandle Pointer to the returned image handle that is created when the
@param ImageHandle The pointer to the returned image handle that is created when the
image is successfully loaded.
@retval EFI_SUCCESS Image was loaded into memory correctly.
@@ -839,12 +838,12 @@ EFI_STATUS
Transfers control to a loaded image's entry point.
@param ImageHandle Handle of image to be started.
@param ExitDataSize Pointer to the size, in bytes, of ExitData.
@param ExitData Pointer to a pointer to a data buffer that includes a Null-terminated
@param ExitDataSize The pointer to the size, in bytes, of ExitData.
@param ExitData The pointer to a pointer to a data buffer that includes a Null-terminated
string, optionally followed by additional binary data.
@retval EFI_INVALID_PARAMETER ImageHandle is either an invalid image handle or the image
has already been initialized with StartImage
has already been initialized with StartImage.
@return Exit code from image
**/
@@ -863,7 +862,7 @@ EFI_STATUS
image on entry.
@param ExitStatus The image's exit code.
@param ExitDataSize The size, in bytes, of ExitData. Ignored if ExitStatus is EFI_SUCCESS.
@param ExitData Pointer to a data buffer that includes a Null-terminated string,
@param ExitData The pointer to a data buffer that includes a Null-terminated string,
optionally followed by additional binary data. The string is a
description that the caller may use to further indicate the reason
for the image's exit. ExitData is only valid if ExitStatus
@@ -944,7 +943,7 @@ EFI_STATUS
@retval EFI_SUCCESS The timeout has been set.
@retval EFI_INVALID_PARAMETER The supplied WatchdogCode is invalid.
@retval EFI_UNSUPPORTED The system does not have a watchdog timer.
@retval EFI_DEVICE_ERROR The watch dog timer could not be programmed due to a hardware
@retval EFI_DEVICE_ERROR The watchdog timer could not be programmed due to a hardware
error.
**/
@@ -1005,7 +1004,7 @@ VOID
/**
Returns a monotonically increasing count for the platform.
@param Count Pointer to returned value.
@param Count The pointer to returned value.
@retval EFI_SUCCESS The next monotonic count was returned.
@retval EFI_INVALID_PARAMETER Count is NULL.
@@ -1021,7 +1020,7 @@ EFI_STATUS
/**
Returns the next high 32 bits of the platform's monotonic counter.
@param HighCount Pointer to returned value.
@param HighCount The pointer to returned value.
@retval EFI_SUCCESS The next high monotonic count was returned.
@retval EFI_INVALID_PARAMETER HighCount is NULL.
@@ -1060,8 +1059,8 @@ EFI_STATUS
/**
Copies the contents of one buffer to another buffer.
@param Destination Pointer to the destination buffer of the memory copy.
@param Source Pointer to the source buffer of the memory copy.
@param Destination The pointer to the destination buffer of the memory copy.
@param Source The pointer to the source buffer of the memory copy.
@param Length Number of bytes to copy from Source to Destination.
**/
@@ -1076,7 +1075,7 @@ VOID
/**
The SetMem() function fills a buffer with a specified value.
@param Buffer Pointer to the buffer to fill.
@param Buffer The pointer to the buffer to fill.
@param Size Number of bytes in Buffer to fill.
@param Value Value to fill Buffer with.
@@ -1577,7 +1576,7 @@ typedef struct {
} EFI_CAPSULE_BLOCK_DESCRIPTOR;
///
/// EFI Capsule Header
/// EFI Capsule Header.
///
typedef struct {
///
@@ -1732,7 +1731,7 @@ EFI_STATUS
#define EFI_RUNTIME_SERVICES_REVISION EFI_2_30_SYSTEM_TABLE_REVISION
///
/// EFI Runtime Services Table
/// EFI Runtime Services Table.
///
typedef struct {
///
@@ -1784,7 +1783,7 @@ typedef struct {
#define EFI_BOOT_SERVICES_REVISION EFI_2_30_SYSTEM_TABLE_REVISION
///
/// EFI Boot Services Table
/// EFI Boot Services Table.
///
typedef struct {
///
@@ -1971,7 +1970,7 @@ typedef struct {
@param SystemTable A pointer to the EFI System Table.
@retval EFI_SUCCESS The operation completed successfully.
@retval Others Some unexpected error happened.
@retval Others An unexpected error occurred.
**/
typedef
EFI_STATUS
@@ -2040,7 +2039,7 @@ typedef union {
} EFI_BOOT_KEY_DATA;
///
/// EFI Key Option
/// EFI Key Option.
///
typedef struct {
///