environment. There are a set of base libraries in the Mde Package that can\r
be used to implement base modules.\r
\r
-Copyright (c) 2006 - 2009, Intel Corporation<BR>\r
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<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
-http://opensource.org/licenses/bsd-license.php\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
#define GLOBAL_REMOVE_IF_UNREFERENCED __declspec(selectany)\r
#else\r
///\r
- /// Remove global variable from the linked image if there are no references to \r
- /// it after all compiler and linker optimizations have been performed.\r
+ /// Remove the global variable from the linked image if there are no references \r
+ /// to it after all compiler and linker optimizations have been performed.\r
///\r
///\r
#define GLOBAL_REMOVE_IF_UNREFERENCED\r
//\r
\r
///\r
-/// Datum is read-only\r
+/// Datum is read-only.\r
///\r
#define CONST const\r
\r
///\r
-/// Datum is scoped to the current file or function\r
+/// Datum is scoped to the current file or function.\r
///\r
#define STATIC static\r
\r
///\r
-/// Undeclared type\r
+/// Undeclared type.\r
///\r
#define VOID void\r
\r
//\r
\r
///\r
-/// Datum is passed to the function\r
+/// Datum is passed to the function.\r
///\r
#define IN\r
\r
///\r
-/// Datum is returned from the function\r
+/// Datum is returned from the function.\r
///\r
#define OUT\r
\r
///\r
/// Passing the datum to the function is optional, and a NULL\r
-/// be passed if the value is not supplied.\r
+/// is passed if the value is not supplied.\r
///\r
#define OPTIONAL\r
\r
/**\r
Return the size of argument that has been aligned to sizeof (UINTN).\r
\r
- @param n The parameter size is to be aligned.\r
+ @param n The parameter size to be aligned.\r
\r
- @return The aligned size\r
+ @return The aligned size.\r
**/\r
#define _INT_SIZE_OF(n) ((sizeof (n) + sizeof (UINTN) - 1) &~(sizeof (UINTN) - 1))\r
\r
typedef CHAR8 *VA_LIST;\r
\r
/**\r
- Retrieves a pointer to the beginning of a variable argument list based on \r
+ Retrieves a pointer to the beginning of a variable argument list, based on \r
the name of the parameter that immediately precedes the variable argument list. \r
\r
- This function initializes Marker to point to the beginning of the variable argument \r
- list that immediately follows Parameter. The method for computing the pointer to the \r
- next argument in the argument list is CPU specific following the EFIAPI ABI.\r
+ This function initializes Marker to point to the beginning of the variable \r
+ argument list that immediately follows Parameter. The method for computing the \r
+ pointer to the next argument in the argument list is CPU-specific following the \r
+ EFIAPI ABI.\r
\r
- @param Marker VA_LIST used to traverse the list of arguments.\r
+ @param Marker The VA_LIST used to traverse the list of arguments.\r
@param Parameter The name of the parameter that immediately precedes \r
the variable argument list.\r
\r
This function returns an argument of the type specified by TYPE from the beginning \r
of the variable argument list specified by Marker. Marker is then updated to point \r
to the next argument in the variable argument list. The method for computing the \r
- pointer to the next argument in the argument list is CPU specific following the EFIAPI ABI.\r
+ pointer to the next argument in the argument list is CPU-specific following the EFIAPI ABI.\r
\r
@param Marker VA_LIST used to traverse the list of arguments.\r
@param TYPE The type of argument to retrieve from the beginning \r
Terminates the use of a variable argument list.\r
\r
This function initializes Marker so it can no longer be used with VA_ARG(). \r
- After this macro is used, the only way to access the variable argument list again is \r
+ After this macro is used, the only way to access the variable argument list is \r
by using VA_START() again.\r
\r
@param Marker VA_LIST used to traverse the list of arguments.\r
to the next argument in the variable argument list. The method for computing the \r
pointer to the next argument in the argument list is CPU specific following the EFIAPI ABI.\r
\r
- @param Marker Pointer to the beginning of a variable argument list.\r
+ @param Marker The pointer to the beginning of a variable argument list.\r
@param TYPE The type of argument to retrieve from the beginning \r
of the variable argument list.\r
\r
#define BASE_ARG(Marker, TYPE) (*(TYPE *) ((Marker += _BASE_INT_SIZE_OF (TYPE)) - _BASE_INT_SIZE_OF (TYPE)))\r
\r
/**\r
- Macro that returns the byte offset of a field in a data structure. \r
+ The macro that returns the byte offset of a field in a data structure. \r
\r
This function returns the offset, in bytes, of field specified by Field from the \r
beginning of the data structure specified by TYPE. If TYPE does not contain Field, \r
/**\r
Returns TRUE if a specified RETURN_STATUS code is an error code. \r
\r
- This function returns TRUE if StatusCode has the high bit set. Otherwise FALSE is returned. \r
+ This function returns TRUE if StatusCode has the high bit set. Otherwise, FALSE is returned. \r
\r
@param StatusCode The status code value to evaluate.\r
\r
#define RETURN_CRC_ERROR ENCODE_ERROR (27)\r
\r
///\r
-/// Beginning or end of media was reached.\r
+/// The beginning or end of media was reached.\r
///\r
#define RETURN_END_OF_MEDIA ENCODE_ERROR (28)\r
\r
We currently only have one EBC compiler so there may be some Intel compiler\r
specific functions in this file.\r
\r
- Copyright (c) 2006 - 2009, 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
- 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
typedef unsigned char BOOLEAN;\r
///\r
-/// 1-byte unsigned value\r
+/// 1-byte unsigned value.\r
///\r
typedef unsigned char UINT8;\r
///\r
-/// 1-byte Character\r
+/// 1-byte Character.\r
///\r
typedef char CHAR8;\r
///\r
-/// 2-byte signed value\r
+/// 2-byte signed value.\r
///\r
typedef short INT16;\r
///\r
-/// 2-byte unsigned value\r
+/// 2-byte unsigned value.\r
///\r
typedef unsigned short UINT16;\r
///\r
///\r
typedef unsigned short CHAR16;\r
///\r
-/// 4-byte signed value\r
+/// 4-byte signed value.\r
///\r
typedef int INT32;\r
///\r
-/// 4-byte unsigned value\r
+/// 4-byte unsigned value.\r
///\r
typedef unsigned int UINT32;\r
///\r
-/// 8-byte signed value\r
+/// 8-byte signed value.\r
///\r
typedef __int64 INT64;\r
///\r
-/// 8-byte unsigned value\r
+/// 8-byte unsigned value.\r
///\r
typedef unsigned __int64 UINT64;\r
\r
///\r
typedef long INTN;\r
///\r
-/// Unsigned value of native width. (4 bytes on supported 32-bit processor instructions,\r
+/// The unsigned value of native width. (4 bytes on supported 32-bit processor instructions;\r
/// 8 bytes on supported 64-bit processor instructions)\r
-/// "long" type scales to the processor native size with EBC compiler\r
+/// "long" type scales to the processor native size with the EBC compiler.\r
///\r
typedef unsigned long UINTN;\r
\r
///\r
/// A value of native width with the highest bit set.\r
-/// Scalable macro to set the most significant bit in a natural number\r
+/// Scalable macro to set the most significant bit in a natural number.\r
///\r
#define MAX_BIT (1ULL << (sizeof (INTN) * 8 - 1)) \r
///\r
/// A value of native width with the two highest bits set.\r
-/// Scalable macro to set the most 2 significant bits in a natural number\r
+/// Scalable macro to set the most 2 significant bits in a natural number.\r
///\r
#define MAX_2_BITS (3ULL << (sizeof (INTN) * 8 - 2))\r
\r
/** @file\r
GUIDs for gBS->CreateEventEx Event Groups. Defined in UEFI spec 2.0 and PI 1.2.\r
\r
- Copyright (c) 2006 - 2009, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
and EFI_FILE_PROTOCOL.GetInfo() to set or get generic file information.\r
This GUID is defined in UEFI specification.\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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
typedef struct {\r
///\r
- /// Size of the EFI_FILE_INFO structure, including the Null-terminated FileName string.\r
+ /// The size of the EFI_FILE_INFO structure, including the Null-terminated FileName string.\r
///\r
UINT64 Size;\r
///\r
or EFI_FILE_PROTOCOL.SetInfo() to get or set information about the system's volume.\r
This GUID is defined in UEFI specification.\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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
typedef struct {\r
///\r
- /// Size of the EFI_FILE_SYSTEM_INFO structure, including the Null-terminated VolumeLabel string.\r
+ /// The size of the EFI_FILE_SYSTEM_INFO structure, including the Null-terminated VolumeLabel string.\r
///\r
UINT64 Size;\r
///\r
GUID indicates that the form set contains forms designed to be used \r
for platform configuration and this form set will be displayed.\r
\r
- Copyright (c) 2009, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@par Revision Reference:\r
GUID defined in UEFI 2.1.\r
/** @file \r
ACPI 1.0b definitions from the ACPI Specification, revision 1.0b\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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
#ifndef _ACPI_1_0_H_\r
\r
///\r
/// Common table header, this prefaces all ACPI tables, including FACS, but\r
-/// excluding the RSD PTR structure\r
+/// excluding the RSD PTR structure.\r
///\r
typedef struct {\r
UINT32 Signature;\r
\r
#pragma pack(1)\r
///\r
-/// Common ACPI description table header. This structure prefaces most ACPI tables.\r
+/// The common ACPI description table header. This structure prefaces most ACPI tables.\r
///\r
typedef struct {\r
UINT32 Signature;\r
#define ACPI_ADDRESS_SPACE_TYPE_BUS 0x02\r
\r
///\r
-/// Power Management Timer frequency is fixed at 3.579545MHz\r
+/// Power Management Timer frequency is fixed at 3.579545MHz.\r
///\r
#define ACPI_TIMER_FREQUENCY 3579545\r
\r
\r
///\r
/// The commond definition of QWORD, DWORD, and WORD\r
-/// Address Space Descriptors\r
+/// Address Space Descriptors.\r
///\r
typedef PACKED struct {\r
UINT8 Desc;\r
#pragma pack()\r
\r
///\r
-/// the End tag identifies an end of resource data.\r
+/// The End tag identifies an end of resource data.\r
///\r
typedef struct {\r
UINT8 Desc;\r
//\r
\r
///\r
-/// Root System Description Pointer Structure\r
+/// Root System Description Pointer Structure.\r
///\r
typedef struct {\r
UINT64 Signature;\r
//\r
\r
///\r
-/// RSDT Revision (as defined in ACPI 1.0b spec.)\r
+/// RSDT Revision (as defined in ACPI 1.0b specification).\r
///\r
#define EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_REVISION 0x01\r
\r
///\r
-/// Fixed ACPI Description Table Structure (FADT)\r
+/// Fixed ACPI Description Table Structure (FADT).\r
///\r
typedef struct {\r
EFI_ACPI_DESCRIPTION_HEADER Header;\r
} EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE;\r
\r
///\r
-/// FADT Version (as defined in ACPI 1.0b spec.)\r
+/// FADT Version (as defined in ACPI 1.0b specification).\r
///\r
#define EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE_REVISION 0x01\r
\r
#define EFI_ACPI_1_0_DCK_CAP BIT9\r
\r
///\r
-/// Firmware ACPI Control Structure\r
+/// Firmware ACPI Control Structure.\r
///\r
typedef struct {\r
UINT32 Signature;\r
} EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE;\r
\r
///\r
-/// Firmware Control Structure Feature Flags\r
+/// Firmware Control Structure Feature Flags.\r
/// All other bits are reserved and must be set to 0.\r
///\r
#define EFI_ACPI_1_0_S4BIOS_F BIT0\r
\r
///\r
/// Multiple APIC Description Table header definition. The rest of the table\r
-/// must be defined in a platform specific manner.\r
+/// must be defined in a platform-specific manner.\r
///\r
typedef struct {\r
EFI_ACPI_DESCRIPTION_HEADER Header;\r
} EFI_ACPI_1_0_MULTIPLE_APIC_DESCRIPTION_TABLE_HEADER;\r
\r
///\r
-/// MADT Revision (as defined in ACPI 1.0b spec.)\r
+/// MADT Revision (as defined in ACPI 1.0b specification).\r
///\r
#define EFI_ACPI_1_0_MULTIPLE_APIC_DESCRIPTION_TABLE_REVISION 0x01\r
\r
//\r
\r
///\r
-/// Processor Local APIC Structure Definition\r
+/// Processor Local APIC Structure Definition.\r
///\r
typedef struct {\r
UINT8 Type;\r
#define EFI_ACPI_1_0_LOCAL_APIC_ENABLED BIT0\r
\r
///\r
-/// IO APIC Structure\r
+/// IO APIC Structure.\r
///\r
typedef struct {\r
UINT8 Type;\r
} EFI_ACPI_1_0_IO_APIC_STRUCTURE;\r
\r
///\r
-/// Interrupt Source Override Structure\r
+/// Interrupt Source Override Structure.\r
///\r
typedef struct {\r
UINT8 Type;\r
} EFI_ACPI_1_0_INTERRUPT_SOURCE_OVERRIDE_STRUCTURE;\r
\r
///\r
-/// Non-Maskable Interrupt Source Structure\r
+/// Non-Maskable Interrupt Source Structure.\r
///\r
typedef struct {\r
UINT8 Type;\r
} EFI_ACPI_1_0_NON_MASKABLE_INTERRUPT_SOURCE_STRUCTURE;\r
\r
///\r
-/// Local APIC NMI Structure\r
+/// Local APIC NMI Structure.\r
///\r
typedef struct {\r
UINT8 Type;\r
//\r
\r
///\r
-/// "RSD PTR " Root System Description Pointer\r
+/// "RSD PTR " Root System Description Pointer.\r
///\r
#define EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_POINTER_SIGNATURE SIGNATURE_64('R', 'S', 'D', ' ', 'P', 'T', 'R', ' ')\r
\r
///\r
-/// "APIC" Multiple APIC Description Table\r
+/// "APIC" Multiple APIC Description Table.\r
///\r
#define EFI_ACPI_1_0_APIC_SIGNATURE SIGNATURE_32('A', 'P', 'I', 'C')\r
\r
///\r
-/// "DSDT" Differentiated System Description Table\r
+/// "DSDT" Differentiated System Description Table.\r
///\r
#define EFI_ACPI_1_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('D', 'S', 'D', 'T')\r
\r
///\r
-/// "FACS" Firmware ACPI Control Structure\r
+/// "FACS" Firmware ACPI Control Structure.\r
///\r
#define EFI_ACPI_1_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE SIGNATURE_32('F', 'A', 'C', 'S')\r
\r
///\r
-/// "FACP" Fixed ACPI Description Table\r
+/// "FACP" Fixed ACPI Description Table.\r
///\r
#define EFI_ACPI_1_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('F', 'A', 'C', 'P')\r
\r
///\r
-/// "PSDT" Persistent System Description Table\r
+/// "PSDT" Persistent System Description Table.\r
///\r
#define EFI_ACPI_1_0_PERSISTENT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('P', 'S', 'D', 'T')\r
\r
///\r
-/// "RSDT" Root System Description Table\r
+/// "RSDT" Root System Description Table.\r
///\r
#define EFI_ACPI_1_0_ROOT_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('R', 'S', 'D', 'T')\r
\r
///\r
-/// "SBST" Smart Battery Specification Table\r
+/// "SBST" Smart Battery Specification Table.\r
///\r
#define EFI_ACPI_1_0_SMART_BATTERY_SPECIFICATION_TABLE_SIGNATURE SIGNATURE_32('S', 'B', 'S', 'T')\r
\r
///\r
-/// "SSDT" Secondary System Description Table\r
+/// "SSDT" Secondary System Description Table.\r
///\r
#define EFI_ACPI_1_0_SECONDARY_SYSTEM_DESCRIPTION_TABLE_SIGNATURE SIGNATURE_32('S', 'S', 'D', 'T')\r
\r
This file contains just some basic definitions that are needed by drivers\r
that dealing with ATA/ATAPI interface.\r
\r
-Copyright (c) 2007 - 2010, 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
+Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
#pragma pack(1)\r
\r
///\r
-/// ATA5_IDENTIFY_DATA is defined in ATA-5\r
-/// (This structure is provided here mainly for backward-compatibility support.\r
-/// Old drivers may reference some field that is marked "obsolete" in \r
-/// ATA_IDENTIFY_DATA, which current conforms to ATA-8) \r
+/// ATA5_IDENTIFY_DATA is defined in ATA-5.\r
+/// (This structure is provided mainly for backward-compatibility support.\r
+/// Old drivers may reference fields that are marked "obsolete" in \r
+/// ATA_IDENTIFY_DATA, which currently conforms to ATA-8.) \r
///\r
typedef struct { \r
- UINT16 config; ///< General Configuration \r
- UINT16 cylinders; ///< Number of Cylinders \r
+ UINT16 config; ///< General Configuration.\r
+ UINT16 cylinders; ///< Number of Cylinders.\r
UINT16 reserved_2; \r
- UINT16 heads; ///< Number of logical heads \r
+ UINT16 heads; ///< Number of logical heads. \r
UINT16 vendor_data1; \r
UINT16 vendor_data2; \r
UINT16 sectors_per_track; \r
} ATA5_IDENTIFY_DATA;\r
\r
///\r
-/// ATA_IDENTIFY_DATA is strictly complied with ATA/ATAPI-8 Spec\r
+/// ATA_IDENTIFY_DATA strictly complies with ATA/ATAPI-8 Spec\r
/// to define the data returned by an ATA device upon successful\r
-/// completion of the ATA IDENTIFY_DEVICE command\r
+/// completion of the ATA IDENTIFY_DEVICE command.\r
///\r
typedef struct {\r
- UINT16 config; ///< General Configuration\r
+ UINT16 config; ///< General Configuration.\r
UINT16 obsolete_1;\r
- UINT16 specific_config; ///< Specific Configuration\r
+ UINT16 specific_config; ///< Specific Configuration.\r
UINT16 obsolete_3;\r
UINT16 retired_4_5[2]; \r
UINT16 obsolete_6;\r
UINT16 min_pio_cycle_time_with_flow_control; \r
UINT16 reserved_69_74[6]; \r
UINT16 queue_depth; \r
- UINT16 reserved_76_79[4]; ///< reserved for Serial ATA\r
+ UINT16 reserved_76_79[4]; ///< Reserved for Serial ATA.\r
UINT16 major_version_no; \r
UINT16 minor_version_no; \r
UINT16 command_set_supported_82; ///< word 82\r
} ATA_IDENTIFY_DATA;\r
\r
///\r
-/// ATAPI_IDENTIFY_DATA is strictly complied with ATA/ATAPI-8 Spec\r
+/// ATAPI_IDENTIFY_DATA strictly complies with ATA/ATAPI-8 Spec\r
/// to define the data returned by an ATAPI device upon successful\r
-/// completion of the ATA IDENTIFY_PACKET_DEVICE command\r
+/// completion of the ATA IDENTIFY_PACKET_DEVICE command.\r
///\r
typedef struct {\r
- UINT16 config; ///< General Configuration\r
+ UINT16 config; ///< General Configuration.\r
UINT16 reserved_1;\r
- UINT16 specific_config; ///< Specific Configuration\r
+ UINT16 specific_config; ///< Specific Configuration.\r
UINT16 reserved_3_9[7];\r
CHAR8 SerialNo[20]; ///< word 10~19\r
UINT16 reserved_20_22[3];\r
\r
\r
///\r
-/// Standard Quiry Data format, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// Standard Quiry Data format, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
///\r
typedef struct {\r
UINT8 peripheral_type;\r
UINT8 RMB;\r
UINT8 version;\r
UINT8 response_data_format;\r
- UINT8 addnl_length; ///< n - 4, Numbers of bytes following this one\r
+ UINT8 addnl_length; ///< n - 4, Numbers of bytes following this one.\r
UINT8 reserved_5;\r
UINT8 reserved_6;\r
UINT8 reserved_7;\r
UINT8 vendor_specific_36_55[55 - 36 + 1];\r
UINT8 reserved_56_95[95 - 56 + 1];\r
///\r
- /// Vendor specific parameters fields, the sizeof (ATAPI_INQUIRY_DATA) is 254\r
+ /// Vendor-specific parameters fields. The sizeof (ATAPI_INQUIRY_DATA) is 254\r
/// since allocation_length is one byte in ATAPI_INQUIRY_CMD.\r
///\r
UINT8 vendor_specific_96_253[253 - 96 + 1];\r
} ATAPI_INQUIRY_DATA;\r
\r
///\r
-/// Request Sense Standard Data, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// Request Sense Standard Data, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
///\r
typedef struct {\r
UINT8 error_code : 7;\r
} ATAPI_REQUEST_SENSE_DATA;\r
\r
///\r
-/// READ CAPACITY Data, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// READ CAPACITY Data, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
///\r
typedef struct {\r
UINT8 LastLba3;\r
\r
///\r
/// Capacity List Header + Current/Maximum Capacity Descriptor,\r
-/// defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
///\r
typedef struct {\r
UINT8 reserved_0;\r
} ATAPI_READ_FORMAT_CAPACITY_DATA;\r
\r
///\r
-/// Test Unit Ready Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// Test Unit Ready Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
///\r
typedef struct {\r
UINT8 opcode;\r
} ATAPI_TEST_UNIT_READY_CMD;\r
\r
///\r
-/// INQUIRY Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// INQUIRY Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
///\r
typedef struct {\r
UINT8 opcode;\r
} ATAPI_INQUIRY_CMD;\r
\r
///\r
-/// REQUEST SENSE Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// REQUEST SENSE Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
///\r
typedef struct {\r
UINT8 opcode;\r
} ATAPI_REQUEST_SENSE_CMD;\r
\r
///\r
-/// READ (10) Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// READ (10) Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
///\r
typedef struct {\r
UINT8 opcode;\r
} ATAPI_READ10_CMD;\r
\r
///\r
-/// READ Format Capacity Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// READ Format Capacity Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
///\r
typedef struct {\r
UINT8 opcode;\r
} ATAPI_READ_FORMAT_CAP_CMD;\r
\r
///\r
-/// MODE SENSE Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification)\r
+/// MODE SENSE Command, defined in SFF-8070i(ATAPI Removable Rewritable Specification).\r
///\r
typedef struct {\r
UINT8 opcode;\r
} ATAPI_MODE_SENSE_CMD;\r
\r
///\r
-/// ATAPI_PACKET_COMMAND is not defined in ATA specification.\r
-/// We add it here for the convenience for ATA/ATAPI module writer. \r
+/// ATAPI_PACKET_COMMAND is not defined in the ATA specification.\r
+/// We add it here for the convenience of ATA/ATAPI module writers. \r
///\r
typedef union {\r
UINT16 Data16[6];\r
#define ATA_CMD_WRITE_DMA_EXT 0x35 ///< defined from ATA-6\r
\r
///\r
-/// default content of device control register, disable INT,\r
+/// Default content of device control register, disable INT,\r
/// Bit3 is set to 1 according ATA-1\r
///\r
#define ATA_DEFAULT_CTL (0x0a) \r
///\r
-/// default context of Device/Head Register,\r
-/// Bit7 and Bit5 are set to 1 for back-compatibilities\r
+/// Default context of Device/Head Register,\r
+/// Bit7 and Bit5 are set to 1 for back-compatibilities.\r
///\r
#define ATA_DEFAULT_CMD (0xa0)\r
\r
#define ATA_ASC_INVALID_FIELD (0x24)\r
#define ATA_ASC_WRITE_PROTECTED (0x27)\r
#define ATA_ASC_MEDIA_CHANGE (0x28)\r
-#define ATA_ASC_RESET (0x29) ///< Power On Reset or Bus Reset occurred\r
+#define ATA_ASC_RESET (0x29) ///< Power On Reset or Bus Reset occurred.\r
#define ATA_ASC_ILLEGAL_FIELD (0x26)\r
#define ATA_ASC_NO_MEDIA (0x3A)\r
#define ATA_ASC_ILLEGAL_MODE_FOR_THIS_TRACK (0x64)\r
//\r
// Device Control Register\r
//\r
-#define ATA_CTLREG_SRST BIT2 ///< Software Reset\r
-#define ATA_CTLREG_IEN_L BIT1 ///< Interrupt Enable #\r
+#define ATA_CTLREG_SRST BIT2 ///< Software Reset.\r
+#define ATA_CTLREG_IEN_L BIT1 ///< Interrupt Enable #.\r
\r
#endif\r
\r
/** @file\r
Support for the latest PCI standard.\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
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
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
/** @file\r
Support for PCI 2.3 standard.\r
\r
- Copyright (c) 2006 - 2009, Intel Corporation \r
+ Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<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
- http://opensource.org/licenses/bsd-license.php \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
#include <IndustryStandard/Pci22.h>\r
\r
///\r
-/// PCI_CLASS_MASS_STORAGE, Base Class 01h\r
+/// PCI_CLASS_MASS_STORAGE, Base Class 01h.\r
///\r
///@{\r
#define PCI_CLASS_MASS_STORAGE_ATA 0x05\r
///@}\r
\r
///\r
-/// PCI_CLASS_SERIAL, Base Class 0Ch\r
+/// PCI_CLASS_SERIAL, Base Class 0Ch.\r
///\r
///@{\r
#define PCI_IF_EHCI 0x20\r
#define PCI_EXP_MAX_CONFIG_OFFSET 0x1000\r
\r
///\r
-/// PCI Capability List IDs and records\r
+/// PCI Capability List IDs and records.\r
///\r
#define EFI_PCI_CAPABILITY_ID_PCIX 0x07\r
\r
#pragma pack(1)\r
///\r
/// PCI-X Capabilities List, \r
-/// Section 7.2, PCI-X Addendum to the PCI Local Bus Specification, Revision 1.0b\r
+/// Section 7.2, PCI-X Addendum to the PCI Local Bus Specification, Revision 1.0b.\r
///\r
typedef struct {\r
EFI_PCI_CAPABILITY_HDR Hdr;\r
\r
///\r
/// PCI-X Bridge Capabilities List, \r
-/// Section 8.6.2, PCI-X Addendum to the PCI Local Bus Specification, Revision 1.0b\r
+/// Section 8.6.2, PCI-X Addendum to the PCI Local Bus Specification, Revision 1.0b.\r
///\r
typedef struct {\r
EFI_PCI_CAPABILITY_HDR Hdr;\r
Common Object File Format Specification, Revision 8.0 - May 16, 2006. \r
This file also includes some definitions in PI Specification, Revision 1.0.\r
\r
- Copyright (c) 2006 - 2009, Intel Corporation<BR>\r
- Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<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
- http://opensource.org/licenses/bsd-license.php \r
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
+Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<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
+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
+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
/// under DOS it can print an error message.\r
///\r
typedef struct {\r
- UINT16 e_magic; ///< Magic number\r
- UINT16 e_cblp; ///< Bytes on last page of file\r
- UINT16 e_cp; ///< Pages in file\r
- UINT16 e_crlc; ///< Relocations\r
- UINT16 e_cparhdr; ///< Size of header in paragraphs\r
- UINT16 e_minalloc; ///< Minimum extra paragraphs needed\r
- UINT16 e_maxalloc; ///< Maximum extra paragraphs needed\r
- UINT16 e_ss; ///< Initial (relative) SS value\r
- UINT16 e_sp; ///< Initial SP value\r
- UINT16 e_csum; ///< Checksum\r
- UINT16 e_ip; ///< Initial IP value\r
- UINT16 e_cs; ///< Initial (relative) CS value\r
- UINT16 e_lfarlc; ///< File address of relocation table\r
- UINT16 e_ovno; ///< Overlay number\r
- UINT16 e_res[4]; ///< Reserved words\r
- UINT16 e_oemid; ///< OEM identifier (for e_oeminfo)\r
- UINT16 e_oeminfo; ///< OEM information; e_oemid specific\r
- UINT16 e_res2[10]; ///< Reserved words\r
- UINT32 e_lfanew; ///< File address of new exe header\r
+ UINT16 e_magic; ///< Magic number.\r
+ UINT16 e_cblp; ///< Bytes on last page of file.\r
+ UINT16 e_cp; ///< Pages in file.\r
+ UINT16 e_crlc; ///< Relocations.\r
+ UINT16 e_cparhdr; ///< Size of header in paragraphs.\r
+ UINT16 e_minalloc; ///< Minimum extra paragraphs needed.\r
+ UINT16 e_maxalloc; ///< Maximum extra paragraphs needed.\r
+ UINT16 e_ss; ///< Initial (relative) SS value.\r
+ UINT16 e_sp; ///< Initial SP value.\r
+ UINT16 e_csum; ///< Checksum.\r
+ UINT16 e_ip; ///< Initial IP value.\r
+ UINT16 e_cs; ///< Initial (relative) CS value.\r
+ UINT16 e_lfarlc; ///< File address of relocation table.\r
+ UINT16 e_ovno; ///< Overlay number.\r
+ UINT16 e_res[4]; ///< Reserved words.\r
+ UINT16 e_oemid; ///< OEM identifier (for e_oeminfo).\r
+ UINT16 e_oeminfo; ///< OEM information; e_oemid specific.\r
+ UINT16 e_res2[10]; ///< Reserved words.\r
+ UINT32 e_lfanew; ///< File address of new exe header.\r
} EFI_IMAGE_DOS_HEADER;\r
\r
///\r
-/// COFF File Header (Object and Image)\r
+/// COFF File Header (Object and Image).\r
///\r
typedef struct {\r
UINT16 Machine;\r
} EFI_IMAGE_FILE_HEADER;\r
\r
///\r
-/// Size of EFI_IMAGE_FILE_HEADER\r
+/// Size of EFI_IMAGE_FILE_HEADER.\r
///\r
#define EFI_IMAGE_SIZEOF_FILE_HEADER 20\r
\r
#define EFI_IMAGE_FILE_LOCAL_SYMS_STRIPPED BIT3 ///< 0x0008 Local symbols stripped from file.\r
#define EFI_IMAGE_FILE_BYTES_REVERSED_LO BIT7 ///< 0x0080 Bytes of machine word are reversed.\r
#define EFI_IMAGE_FILE_32BIT_MACHINE BIT8 ///< 0x0100 32 bit word machine.\r
-#define EFI_IMAGE_FILE_DEBUG_STRIPPED BIT9 ///< 0x0200 Debugging info stripped from file in .DBG file\r
+#define EFI_IMAGE_FILE_DEBUG_STRIPPED BIT9 ///< 0x0200 Debugging info stripped from file in .DBG file.\r
#define EFI_IMAGE_FILE_SYSTEM BIT12 ///< 0x1000 System File.\r
#define EFI_IMAGE_FILE_DLL BIT13 ///< 0x2000 File is a DLL.\r
#define EFI_IMAGE_FILE_BYTES_REVERSED_HI BIT15 ///< 0x8000 Bytes of machine word are reversed.\r
\r
///\r
-/// Header Data Directories\r
+/// Header Data Directories.\r
///\r
typedef struct {\r
UINT32 VirtualAddress;\r
#define EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC 0x10b\r
\r
///\r
-/// Optional Header Standard Fields for PE32\r
+/// Optional Header Standard Fields for PE32.\r
///\r
typedef struct {\r
///\r
UINT32 SizeOfUninitializedData;\r
UINT32 AddressOfEntryPoint;\r
UINT32 BaseOfCode;\r
- UINT32 BaseOfData; ///< PE32 contains this additional field, which is absent in PE32+\r
+ UINT32 BaseOfData; ///< PE32 contains this additional field, which is absent in PE32+.\r
///\r
/// Optional Header Windows-Specific Fields.\r
///\r
#define EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC 0x20b\r
\r
///\r
-/// Optional Header Standard Fields for PE32+\r
+/// Optional Header Standard Fields for PE32+.\r
///\r
typedef struct {\r
///\r
#define EFI_IMAGE_SIZEOF_SHORT_NAME 8\r
\r
///\r
-/// Section Table, this table immediately follows the optional header\r
+/// Section Table. This table immediately follows the optional header.\r
///\r
typedef struct {\r
UINT8 Name[EFI_IMAGE_SIZEOF_SHORT_NAME];\r
} EFI_IMAGE_SECTION_HEADER;\r
\r
///\r
-/// Size of EFI_IMAGE_SECTION_HEADER\r
+/// Size of EFI_IMAGE_SECTION_HEADER.\r
///\r
#define EFI_IMAGE_SIZEOF_SECTION_HEADER 40\r
\r
#define EFI_IMAGE_SCN_MEM_WRITE BIT31 ///< 0x80000000\r
\r
///\r
-/// Size of a Symbol Table Record\r
+/// Size of a Symbol Table Record.\r
///\r
#define EFI_IMAGE_SIZEOF_SYMBOL 18\r
\r
//\r
// I386 relocation types.\r
//\r
-#define EFI_IMAGE_REL_I386_ABSOLUTE 0x0000 ///< Reference is absolute, no relocation is necessary\r
-#define EFI_IMAGE_REL_I386_DIR16 0x0001 ///< Direct 16-bit reference to the symbols virtual address\r
-#define EFI_IMAGE_REL_I386_REL16 0x0002 ///< PC-relative 16-bit reference to the symbols virtual address\r
-#define EFI_IMAGE_REL_I386_DIR32 0x0006 ///< Direct 32-bit reference to the symbols virtual address\r
-#define EFI_IMAGE_REL_I386_DIR32NB 0x0007 ///< Direct 32-bit reference to the symbols virtual address, base not included\r
-#define EFI_IMAGE_REL_I386_SEG12 0x0009 ///< Direct 16-bit reference to the segment-selector bits of a 32-bit virtual address\r
+#define EFI_IMAGE_REL_I386_ABSOLUTE 0x0000 ///< Reference is absolute, no relocation is necessary.\r
+#define EFI_IMAGE_REL_I386_DIR16 0x0001 ///< Direct 16-bit reference to the symbols virtual address.\r
+#define EFI_IMAGE_REL_I386_REL16 0x0002 ///< PC-relative 16-bit reference to the symbols virtual address.\r
+#define EFI_IMAGE_REL_I386_DIR32 0x0006 ///< Direct 32-bit reference to the symbols virtual address.\r
+#define EFI_IMAGE_REL_I386_DIR32NB 0x0007 ///< Direct 32-bit reference to the symbols virtual address, base not included.\r
+#define EFI_IMAGE_REL_I386_SEG12 0x0009 ///< Direct 16-bit reference to the segment-selector bits of a 32-bit virtual address.\r
#define EFI_IMAGE_REL_I386_SECTION 0x000A\r
#define EFI_IMAGE_REL_I386_SECREL 0x000B\r
-#define EFI_IMAGE_REL_I386_REL32 0x0014 ///< PC-relative 32-bit reference to the symbols virtual address\r
+#define EFI_IMAGE_REL_I386_REL32 0x0014 ///< PC-relative 32-bit reference to the symbols virtual address.\r
\r
// \r
// x64 processor relocation types.\r
} EFI_IMAGE_BASE_RELOCATION;\r
\r
///\r
-/// Size of EFI_IMAGE_BASE_RELOCATION\r
+/// Size of EFI_IMAGE_BASE_RELOCATION.\r
///\r
#define EFI_IMAGE_SIZEOF_BASE_RELOCATION 8\r
\r
} EFI_IMAGE_LINENUMBER;\r
\r
///\r
-/// Size of EFI_IMAGE_LINENUMBER\r
+/// Size of EFI_IMAGE_LINENUMBER.\r
///\r
#define EFI_IMAGE_SIZEOF_LINENUMBER 6\r
\r
UINT8 GroupID[6]; ///< File member group id - decimal.\r
UINT8 Mode[8]; ///< File member mode - octal.\r
UINT8 Size[10]; ///< File member size - decimal.\r
- UINT8 EndHeader[2]; ///< String to end header. (0x60 0x0A)\r
+ UINT8 EndHeader[2]; ///< String to end header. (0x60 0x0A).\r
} EFI_IMAGE_ARCHIVE_MEMBER_HEADER;\r
\r
///\r
-/// Size of EFI_IMAGE_ARCHIVE_MEMBER_HEADER\r
+/// Size of EFI_IMAGE_ARCHIVE_MEMBER_HEADER.\r
///\r
#define EFI_IMAGE_SIZEOF_ARCHIVE_MEMBER_HDR 60\r
\r
//\r
\r
///\r
-/// Export Directory Table\r
+/// Export Directory Table.\r
///\r
typedef struct {\r
UINT32 Characteristics;\r
} EFI_IMAGE_EXPORT_DIRECTORY;\r
\r
///\r
-/// Hint/Name Table\r
+/// Hint/Name Table.\r
///\r
typedef struct {\r
UINT16 Hint;\r
} EFI_IMAGE_IMPORT_BY_NAME;\r
\r
///\r
-/// Import Address Table RVA (Thunk Table)\r
+/// Import Address Table RVA (Thunk Table).\r
///\r
typedef struct {\r
union {\r
} u1;\r
} EFI_IMAGE_THUNK_DATA;\r
\r
-#define EFI_IMAGE_ORDINAL_FLAG BIT31 ///< Flag for PE32\r
+#define EFI_IMAGE_ORDINAL_FLAG BIT31 ///< Flag for PE32.\r
#define EFI_IMAGE_SNAP_BY_ORDINAL(Ordinal) ((Ordinal & EFI_IMAGE_ORDINAL_FLAG) != 0)\r
#define EFI_IMAGE_ORDINAL(Ordinal) (Ordinal & 0xffff)\r
\r
\r
\r
///\r
-/// Debug Directory Format\r
+/// Debug Directory Format.\r
///\r
typedef struct {\r
UINT32 Characteristics;\r
UINT16 MinorVersion;\r
UINT32 Type;\r
UINT32 SizeOfData;\r
- UINT32 RVA; ///< The address of the debug data when loaded, relative to the image base\r
- UINT32 FileOffset; ///< The file pointer to the debug data\r
+ UINT32 RVA; ///< The address of the debug data when loaded, relative to the image base.\r
+ UINT32 FileOffset; ///< The file pointer to the debug data.\r
} EFI_IMAGE_DEBUG_DIRECTORY_ENTRY;\r
\r
-#define EFI_IMAGE_DEBUG_TYPE_CODEVIEW 2 ///< The Visual C++ debug information\r
+#define EFI_IMAGE_DEBUG_TYPE_CODEVIEW 2 ///< The Visual C++ debug information.\r
\r
///\r
-/// Debug Data Structure defined in Microsoft C++\r
+/// Debug Data Structure defined in Microsoft C++.\r
///\r
#define CODEVIEW_SIGNATURE_NB10 SIGNATURE_32('N', 'B', '1', '0')\r
typedef struct {\r
} EFI_IMAGE_DEBUG_CODEVIEW_NB10_ENTRY;\r
\r
///\r
-/// Debug Data Structure defined in Microsoft C++\r
+/// Debug Data Structure defined in Microsoft C++.\r
///\r
#define CODEVIEW_SIGNATURE_RSDS SIGNATURE_32('R', 'S', 'D', 'S')\r
typedef struct {\r
- UINT32 Signature; ///< "RSDS"\r
+ UINT32 Signature; ///< "RSDS".\r
UINT32 Unknown;\r
UINT32 Unknown2;\r
UINT32 Unknown3;\r
\r
\r
///\r
-/// Debug Data Structure defined by Apple Mach-O to Coff utility\r
+/// Debug Data Structure defined by Apple Mach-O to Coff utility.\r
///\r
#define CODEVIEW_SIGNATURE_MTOC SIGNATURE_32('M', 'T', 'O', 'C')\r
typedef struct {\r
- UINT32 Signature; ///< "MTOC"\r
+ UINT32 Signature; ///< "MTOC".\r
GUID MachOUuid;\r
//\r
// Filename of .DLL (Mach-O with debug info) goes here\r
} EFI_IMAGE_RESOURCE_DATA_ENTRY;\r
\r
///\r
-/// Header format for TE images, defined in PI Specification, 1.0\r
+/// Header format for TE images, defined in the PI Specification, 1.0.\r
///\r
typedef struct {\r
- UINT16 Signature; ///< signature for TE format = "VZ"\r
- UINT16 Machine; ///< from the original file header\r
- UINT8 NumberOfSections; ///< from the original file header\r
- UINT8 Subsystem; ///< from original optional header\r
- UINT16 StrippedSize; ///< how many bytes we removed from the header\r
- UINT32 AddressOfEntryPoint; ///< offset to entry point -- from original optional header\r
- UINT32 BaseOfCode; ///< from original image -- required for ITP debug\r
- UINT64 ImageBase; ///< from original file header\r
- EFI_IMAGE_DATA_DIRECTORY DataDirectory[2]; ///< only base relocation and debug directory\r
+ UINT16 Signature; ///< The signature for TE format = "VZ".\r
+ UINT16 Machine; ///< From the original file header.\r
+ UINT8 NumberOfSections; ///< From the original file header.\r
+ UINT8 Subsystem; ///< From original optional header.\r
+ UINT16 StrippedSize; ///< Number of bytes we removed from the header.\r
+ UINT32 AddressOfEntryPoint; ///< Offset to entry point -- from original optional header.\r
+ UINT32 BaseOfCode; ///< From original image -- required for ITP debug.\r
+ UINT64 ImageBase; ///< From original file header.\r
+ EFI_IMAGE_DATA_DIRECTORY DataDirectory[2]; ///< Only base relocation and debug directory.\r
} EFI_TE_IMAGE_HEADER;\r
\r
\r
\r
\r
///\r
-/// Union of PE32, PE32+, and TE headers\r
+/// Union of PE32, PE32+, and TE headers.\r
///\r
typedef union {\r
EFI_IMAGE_NT_HEADERS32 Pe32;\r
Main SAL API's defined in Intel Itanium Processor Family System Abstraction\r
Layer Specification Revision 3.2 (December 2003)\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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
#define EFI_SAL_SUCCESS ((EFI_SAL_STATUS) 0)\r
///\r
-/// Call completed without error but some information was lost due to overflow. \r
+/// Call completed without error, but some information was lost due to overflow. \r
///\r
#define EFI_SAL_OVERFLOW ((EFI_SAL_STATUS) 1)\r
///\r
#define EFI_SAL_NOT_ENOUGH_SCRATCH ((EFI_SAL_STATUS) - 9)\r
\r
///\r
-/// Return registers from SAL\r
+/// Return registers from SAL.\r
///\r
typedef struct {\r
///\r
- /// SAL return status value in r8\r
+ /// SAL return status value in r8.\r
///\r
EFI_SAL_STATUS Status;\r
///\r
- /// SAL returned value in r9\r
+ /// SAL returned value in r9.\r
///\r
UINTN r9;\r
///\r
- /// SAL returned value in r10\r
+ /// SAL returned value in r10.\r
///\r
UINTN r10;\r
///\r
- /// SAL returned value in r11\r
+ /// SAL returned value in r11.\r
///\r
UINTN r11;\r
} SAL_RETURN_REGS;\r
0x04XXXXXX to 0xFFFFFFFF - Reserved.\r
@param Arg1 The first parameter of the architected/OEM specific SAL functions.\r
@param Arg2 The second parameter of the architected/OEM specific SAL functions.\r
- @param Arg3 The third parameter passed to the ESAL function based\r
- @param Arg4 The fourth parameter passed to the ESAL function based\r
- @param Arg5 The fifth parameter passed to the ESAL function based\r
- @param Arg6 The sixth parameter passed to the ESAL function\r
- @param Arg7 The seventh parameter passed to the ESAL function based\r
+ @param Arg3 The third parameter passed to the ESAL function based.\r
+ @param Arg4 The fourth parameter passed to the ESAL function based.\r
+ @param Arg5 The fifth parameter passed to the ESAL function based.\r
+ @param Arg6 The sixth parameter passed to the ESAL function.\r
+ @param Arg7 The seventh parameter passed to the ESAL function based.\r
\r
@return r8 Return status: positive number indicates successful,\r
negative number indicates failure.\r
#define EFI_SAL_SET_INIT_VECTOR 0x1\r
#define EFI_SAL_SET_BOOT_RENDEZ_VECTOR 0x2\r
///\r
-/// Format of length_cs_n argument.\r
+/// The format of a length_cs_n argument.\r
///\r
typedef struct {\r
UINT64 Length : 32;\r
#define EFI_SAL_PCI_COMPATIBLE_ADDRESS 0x0\r
#define EFI_SAL_PCI_EXTENDED_REGISTER_ADDRESS 0x1\r
///\r
-/// Format of PCI Compatible Address\r
+/// The format of PCI Compatible Address.\r
///\r
typedef struct {\r
UINT64 Register : 8;\r
UINT64 Reserved : 32;\r
} SAL_PCI_ADDRESS;\r
///\r
-/// Format of Extended Register Address\r
+/// The format of Extended Register Address.\r
///\r
typedef struct {\r
UINT64 Register : 8;\r
UINT8 Reserved2[40];\r
} SAL_UPDATE_PAL_DATA_BLOCK;\r
///\r
-/// Data structure pointed by parameter param_buf.\r
+/// Data structure pointed by the parameter param_buf.\r
/// It is a 16-byte aligned data structure in memory with a length of 32 bytes\r
/// that describes the new firmware. This information is organized in the form\r
/// of a linked list with each element describing one firmware component.\r
} SAL_UPDATE_PAL_INFO_BLOCK;\r
\r
///\r
-/// SAL System Table Definitions\r
+/// SAL System Table Definitions.\r
///\r
#pragma pack(1)\r
typedef struct {\r
///\r
- /// The ASCII string representation of "SST_" which confirms the presence of the table. \r
+ /// The ASCII string representation of "SST_" that confirms the presence of the table. \r
/// \r
UINT32 Signature;\r
///\r
UINT32 Length;\r
///\r
/// The revision number of the Itanium Processor Family System Abstraction Layer\r
- /// Specification supported by the SAL implementation in binary coded decimal (BCD) format.\r
+ /// Specification supported by the SAL implementation, in binary coded decimal (BCD) format.\r
///\r
UINT16 SalRevision;\r
///\r
#define EFI_SAL_ST_AP_WAKEUP_SIZE 16\r
\r
///\r
-/// Format of Entrypoint Descriptor Entry\r
+/// Format of Entrypoint Descriptor Entry.\r
///\r
typedef struct {\r
- UINT8 Type; ///< Type here should be 0\r
+ UINT8 Type; ///< Type here should be 0.\r
UINT8 Reserved[7];\r
UINT64 PalProcEntry;\r
UINT64 SalProcEntry;\r
} SAL_ST_ENTRY_POINT_DESCRIPTOR;\r
\r
///\r
-/// Format of Platform Features Descriptor Entry\r
+/// Format of Platform Features Descriptor Entry.\r
///\r
typedef struct {\r
- UINT8 Type; ///< Type here should be 2\r
+ UINT8 Type; ///< Type here should be 2.\r
UINT8 PlatformFeatures;\r
UINT8 Reserved[14];\r
} SAL_ST_PLATFORM_FEATURES;\r
#define SAL_PLAT_FEAT_PROC_IPI_HINT 0x04\r
\r
///\r
-/// Format of Translation Register Descriptor Entry\r
+/// Format of Translation Register Descriptor Entry.\r
///\r
typedef struct {\r
- UINT8 Type; ///< Type here should be 3\r
+ UINT8 Type; ///< Type here should be 3.\r
UINT8 TRType;\r
UINT8 TRNumber;\r
UINT8 Reserved[5];\r
#define EFI_SAL_ST_TR_USAGE_DATA 01\r
\r
///\r
-/// Definition of Coherence Domain Information\r
+/// Definition of Coherence Domain Information.\r
///\r
typedef struct {\r
UINT64 NumberOfProcessors;\r
} SAL_COHERENCE_DOMAIN_INFO;\r
\r
///\r
-/// Format of Purge Translation Cache Coherence Domain Entry\r
+/// Format of Purge Translation Cache Coherence Domain Entry.\r
///\r
typedef struct {\r
- UINT8 Type; ///< Type here should be 4\r
+ UINT8 Type; ///< Type here should be 4.\r
UINT8 Reserved[3];\r
UINT32 NumberOfDomains;\r
SAL_COHERENCE_DOMAIN_INFO *DomainInformation;\r
} SAL_ST_CACHE_COHERENCE_DECRIPTOR;\r
\r
///\r
-/// Format of Application Processor Wake-Up Descriptor Entry\r
+/// Format of Application Processor Wake-Up Descriptor Entry.\r
///\r
typedef struct {\r
- UINT8 Type; ///< Type here should be 5\r
+ UINT8 Type; ///< Type here should be 5.\r
UINT8 WakeUpType;\r
UINT8 Reserved[6];\r
UINT64 ExternalInterruptVector;\r
} SAL_ST_AP_WAKEUP_DECRIPTOR;\r
\r
///\r
-/// Format of Firmware Interface Table (FIT) Entry\r
+/// Format of Firmware Interface Table (FIT) Entry.\r
///\r
typedef struct {\r
UINT64 Address;\r
//\r
\r
///\r
-/// Format of TimeStamp field in Record Header\r
+/// Format of TimeStamp field in Record Header.\r
///\r
typedef struct {\r
UINT8 Seconds;\r
UINT8 Century;\r
} SAL_TIME_STAMP;\r
///\r
-/// Definition of Record Header\r
+/// Definition of Record Header.\r
///\r
typedef struct {\r
UINT64 RecordId;\r
UINT8 OemPlatformId[16];\r
} SAL_RECORD_HEADER;\r
///\r
-/// Definition of Section Header\r
+/// Definition of Section Header.\r
///\r
typedef struct {\r
GUID Guid;\r
} SAL_SEC_HEADER;\r
\r
///\r
-/// GUID of Processor Machine Check Errors\r
+/// GUID of Processor Machine Check Errors.\r
///\r
#define SAL_PROCESSOR_ERROR_RECORD_INFO \\r
{ \\r
#define TARGER_ID_VALID_BIT_MASK 0x8\r
#define PRECISE_IP_VALID_BIT_MASK 0x10\r
///\r
-/// Definition of MOD_ERROR_INFO_STRUCT\r
+/// Definition of MOD_ERROR_INFO_STRUCT.\r
///\r
typedef struct {\r
UINT64 InfoValid : 1;\r
UINT64 Ip;\r
} MOD_ERROR_INFO;\r
///\r
-/// Definition of CPUID_INFO_STRUCT\r
+/// Definition of CPUID_INFO_STRUCT.\r
///\r
typedef struct {\r
UINT8 CpuidInfo[40];\r
#define RR_VALID_BIT_MASK 0x10\r
#define FR_VALID_BIT_MASK 0x20\r
///\r
-/// Definition of PSI_STATIC_STRUCT\r
+/// Definition of PSI_STATIC_STRUCT.\r
///\r
typedef struct {\r
UINT64 ValidFieldBits;\r
#define PROC_STATIC_STRUCT_VALID_BIT_MASK 0x8\r
#define CPU_INFO_VALID_BIT_MASK 0x1000000\r
///\r
-/// Definition of Processor Machine Check Error Record\r
+/// Definition of Processor Machine Check Error Record.\r
///\r
typedef struct {\r
SAL_SEC_HEADER SectionHeader;\r
} SAL_PROCESSOR_ERROR_RECORD;\r
\r
///\r
-/// GUID of Platform Memory Device Error Info\r
+/// GUID of Platform Memory Device Error Info.\r
///\r
#define SAL_MEMORY_ERROR_RECORD_INFO \\r
{ \\r
#define MEMORY_PLATFORM_OEM_ID_VALID_BIT_MASK 0x8000\r
#define MEMORY_PLATFORM_OEM_DATA_STRUCT_VALID_BIT_MASK 0x10000\r
///\r
-/// Definition of Platform Memory Device Error Info Record\r
+/// Definition of Platform Memory Device Error Info Record.\r
///\r
typedef struct {\r
SAL_SEC_HEADER SectionHeader;\r
} SAL_MEMORY_ERROR_RECORD;\r
\r
///\r
-/// GUID of Platform PCI Bus Error Info\r
+/// GUID of Platform PCI Bus Error Info.\r
///\r
#define SAL_PCI_BUS_ERROR_RECORD_INFO \\r
{ \\r
#define PCI_BUS_OEM_DATA_STRUCT_VALID_BIT_MASK 0x400\r
\r
///\r
-/// Designated PCI Bus identifier\r
+/// Designated PCI Bus identifier.\r
///\r
typedef struct {\r
UINT8 BusNumber;\r
} PCI_BUS_ID;\r
\r
///\r
-/// Definition of Platform PCI Bus Error Info Record\r
+/// Definition of Platform PCI Bus Error Info Record.\r
///\r
typedef struct {\r
SAL_SEC_HEADER SectionHeader;\r
} SAL_PCI_BUS_ERROR_RECORD;\r
\r
///\r
-/// GUID of Platform PCI Component Error Info\r
+/// GUID of Platform PCI Component Error Info.\r
///\r
#define SAL_PCI_COMP_ERROR_RECORD_INFO \\r
{ \\r
#define PCI_COMP_REG_DATA_PAIR_VALID_BIT_MASK 0x10\r
#define PCI_COMP_OEM_DATA_STRUCT_VALID_BIT_MASK 0x20\r
///\r
-/// Format of PCI Component Information to identify the device\r
+/// Format of PCI Component Information to identify the device.\r
///\r
typedef struct {\r
UINT16 VendorId;\r
UINT8 Reserved[5];\r
} PCI_COMP_INFO;\r
///\r
-/// Definition of Platform PCI Component Error Info\r
+/// Definition of Platform PCI Component Error Info.\r
///\r
typedef struct {\r
SAL_SEC_HEADER SectionHeader;\r
} SAL_PCI_COMPONENT_ERROR_RECORD;\r
\r
///\r
-/// Platform SEL Device Error Info\r
+/// Platform SEL Device Error Info.\r
///\r
#define SAL_SEL_DEVICE_ERROR_RECORD_INFO \\r
{ \\r
#define SEL_EVENT_DATA2_VALID_BIT_MASK 0x100;\r
#define SEL_EVENT_DATA3_VALID_BIT_MASK 0x200;\r
///\r
-/// Definition of Platform SEL Device Error Info Record\r
+/// Definition of Platform SEL Device Error Info Record.\r
///\r
typedef struct {\r
SAL_SEC_HEADER SectionHeader;\r
} SAL_SEL_DEVICE_ERROR_RECORD;\r
\r
///\r
-/// GUID of Platform SMBIOS Device Error Info\r
+/// GUID of Platform SMBIOS Device Error Info.\r
///\r
#define SAL_SMBIOS_ERROR_RECORD_INFO \\r
{ \\r
#define SMBIOS_TIME_STAMP_VALID_BIT_MASK 0x4\r
#define SMBIOS_DATA_VALID_BIT_MASK 0x8\r
///\r
-/// Definition of Platform SMBIOS Device Error Info Record\r
+/// Definition of Platform SMBIOS Device Error Info Record.\r
///\r
typedef struct {\r
SAL_SEC_HEADER SectionHeader;\r
} SAL_SMBIOS_DEVICE_ERROR_RECORD;\r
\r
///\r
-/// GUID of Platform Specific Error Info\r
+/// GUID of Platform Specific Error Info.\r
///\r
#define SAL_PLATFORM_ERROR_RECORD_INFO \\r
{ \\r
#define PLATFORM_OEM_DATA_STRUCT_VALID_BIT_MASK 0x40\r
#define PLATFORM_OEM_DEVICE_PATH_VALID_BIT_MASK 0x80\r
///\r
-/// Definition of Platform Specific Error Info Record\r
+/// Definition of Platform Specific Error Info Record.\r
///\r
typedef struct {\r
SAL_SEC_HEADER SectionHeader;\r
} SAL_PLATFORM_SPECIFIC_ERROR_RECORD;\r
\r
///\r
-/// Union of all the possible SAL Error Record Types\r
+/// Union of all the possible SAL Error Record Types.\r
///\r
typedef union {\r
SAL_RECORD_HEADER *RecordHeader;\r
/** @file\r
Industry Standard Definitions of SMBIOS Table Specification v2.6.1\r
\r
- Copyright (c) 2006 - 2010, Intel Corporation All rights\r
- reserved. This program and the accompanying materials are\r
- 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
#define SMBIOS_HANDLE_RESERVED_BEGIN 0xFF00\r
\r
///\r
-/// Reference SMBIOS 2.6, chapter 3.1.3\r
-/// Each text string is limited to 64 significant characters due to system MIF limitations\r
+/// Reference SMBIOS 2.6, chapter 3.1.3.\r
+/// Each text string is limited to 64 significant characters due to system MIF limitations.\r
///\r
#define SMBIOS_STRING_MAX_LENGTH 64\r
\r
#define SMBIOS_TYPE_END_OF_TABLE 0x007F\r
\r
///\r
-/// Smbios Table Entry Point Structure\r
+/// Smbios Table Entry Point Structure.\r
///\r
#pragma pack(1)\r
typedef struct {\r
} SMBIOS_TABLE_ENTRY_POINT;\r
\r
///\r
-/// The Smbios structure header\r
+/// The Smbios structure header.\r
///\r
typedef struct {\r
UINT8 Type;\r
/// Defines which functions the BIOS supports. PCI, PCMCIA, Flash, etc. \r
///\r
typedef struct {\r
- UINT32 Reserved :2; ///< Bits 0-1\r
+ UINT32 Reserved :2; ///< Bits 0-1.\r
UINT32 Unknown :1; \r
UINT32 BiosCharacteristicsNotSupported :1; \r
UINT32 IsaIsSupported :1; \r
} MISC_BIOS_CHARACTERISTICS;\r
\r
///\r
-/// BIOS Characteristics Extension Byte 1 \r
+/// BIOS Characteristics Extension Byte 1 .\r
/// This information, available for SMBIOS version 2.1 and later, appears at offset 12h \r
/// within the BIOS Information structure.\r
///\r
} MBCE_BIOS_RESERVED;\r
\r
///\r
-/// BIOS Characteristics Extension Byte 2\r
+/// BIOS Characteristics Extension Byte 2.\r
/// This information, available for SMBIOS version 2.3 and later, appears at offset 13h \r
/// within the BIOS Information structure.\r
///\r
} MBCE_SYSTEM_RESERVED;\r
\r
///\r
-/// BIOS Characteristics Extension Bytes\r
+/// BIOS Characteristics Extension Bytes.\r
///\r
typedef struct {\r
MBCE_BIOS_RESERVED BiosReserved;\r
} MISC_BIOS_CHARACTERISTICS_EXTENSION;\r
\r
///\r
-/// BIOS Information (Type 0)\r
+/// BIOS Information (Type 0).\r
///\r
typedef struct {\r
SMBIOS_STRUCTURE Hdr;\r
} SMBIOS_TABLE_TYPE0;\r
\r
///\r
-/// System Wake-up Type \r
+/// System Wake-up Type.\r
///\r
typedef enum { \r
SystemWakeupTypeReserved = 0x00,\r
} MISC_SYSTEM_WAKEUP_TYPE;\r
\r
///\r
-/// System Information (Type 1)\r
+/// System Information (Type 1).\r
/// \r
/// The information in this structure defines attributes of the overall system and is \r
/// intended to be associated with the Component ID group of the system's MIF.\r
SMBIOS_TABLE_STRING Version;\r
SMBIOS_TABLE_STRING SerialNumber;\r
GUID Uuid;\r
- UINT8 WakeUpType; ///< enumeration value from MISC_SYSTEM_WAKEUP_TYPE\r
+ UINT8 WakeUpType; ///< The enumeration value from MISC_SYSTEM_WAKEUP_TYPE.\r
SMBIOS_TABLE_STRING SKUNumber;\r
SMBIOS_TABLE_STRING Family;\r
} SMBIOS_TABLE_TYPE1;\r
\r
///\r
-/// Base Board - Feature Flags \r
+/// Base Board - Feature Flags. \r
///\r
typedef struct {\r
UINT8 Motherboard :1;\r
} BASE_BOARD_FEATURE_FLAGS;\r
\r
///\r
-/// Base Board - Board Type\r
+/// Base Board - Board Type.\r
///\r
typedef enum { \r
BaseBoardTypeUnknown = 0x1,\r
} BASE_BOARD_TYPE;\r
\r
///\r
-/// Base Board (or Module) Information (Type 2)\r
+/// Base Board (or Module) Information (Type 2).\r
///\r
/// The information in this structure defines attributes of a system baseboard - \r
/// for example a motherboard, planar, or server blade or other standard system module.\r
BASE_BOARD_FEATURE_FLAGS FeatureFlag;\r
SMBIOS_TABLE_STRING LocationInChassis;\r
UINT16 ChassisHandle;\r
- UINT8 BoardType; ///< enumeration value from BASE_BOARD_TYPE\r
+ UINT8 BoardType; ///< The enumeration value from BASE_BOARD_TYPE.\r
UINT8 NumberOfContainedObjectHandles;\r
UINT16 ContainedObjectHandles[1];\r
} SMBIOS_TABLE_TYPE2;\r
} MISC_CHASSIS_TYPE;\r
\r
///\r
-/// System Enclosure or Chassis States \r
+/// System Enclosure or Chassis States .\r
///\r
typedef enum { \r
ChassisStateOther = 0x01,\r
} MISC_CHASSIS_STATE;\r
\r
///\r
-/// System Enclosure or Chassis Security Status \r
+/// System Enclosure or Chassis Security Status.\r
///\r
typedef enum { \r
ChassisSecurityStatusOther = 0x01,\r
\r
\r
///\r
-/// System Enclosure or Chassis (Type 3)\r
+/// System Enclosure or Chassis (Type 3).\r
///\r
/// The information in this structure defines attributes of the system's mechanical enclosure(s). \r
/// For example, if a system included a separate enclosure for its peripheral devices, \r
SMBIOS_TABLE_STRING Version;\r
SMBIOS_TABLE_STRING SerialNumber;\r
SMBIOS_TABLE_STRING AssetTag;\r
- UINT8 BootupState; ///< enumeration value from MISC_CHASSIS_STATE\r
- UINT8 PowerSupplyState; ///< enumeration value from MISC_CHASSIS_STATE\r
- UINT8 ThermalState; ///< enumeration value from MISC_CHASSIS_STATE\r
- UINT8 SecurityStatus; ///< enumeration value from MISC_CHASSIS_SECURITY_STATE\r
+ UINT8 BootupState; ///< The enumeration value from MISC_CHASSIS_STATE.\r
+ UINT8 PowerSupplyState; ///< The enumeration value from MISC_CHASSIS_STATE.\r
+ UINT8 ThermalState; ///< The enumeration value from MISC_CHASSIS_STATE.\r
+ UINT8 SecurityStatus; ///< The enumeration value from MISC_CHASSIS_SECURITY_STATE.\r
UINT8 OemDefined[4];\r
UINT8 Height;\r
UINT8 NumberofPowerCords;\r
} SMBIOS_TABLE_TYPE3;\r
\r
///\r
-/// Processor Information - Processor Type\r
+/// Processor Information - Processor Type.\r
///\r
typedef enum {\r
ProcessorOther = 0x01,\r
} PROCESSOR_TYPE_DATA;\r
\r
///\r
-/// Processor Information - Processor Family\r
+/// Processor Information - Processor Family.\r
///\r
typedef enum {\r
ProcessorFamilyOther = 0x01, \r
} PROCESSOR_FAMILY_DATA;\r
\r
///\r
-/// Processor Information - Voltage \r
+/// Processor Information - Voltage. \r
///\r
typedef struct {\r
UINT8 ProcessorVoltageCapability5V :1; \r
} PROCESSOR_VOLTAGE;\r
\r
///\r
-/// Processor Information - Processor Upgrade \r
+/// Processor Information - Processor Upgrade.\r
///\r
typedef enum {\r
ProcessorUpgradeOther = 0x01,\r
ProcessorUpgradeUnknown = 0x02,\r
ProcessorUpgradeDaughterBoard = 0x03,\r
ProcessorUpgradeZIFSocket = 0x04,\r
- ProcessorUpgradePiggyBack = 0x05, ///< Replaceable\r
+ ProcessorUpgradePiggyBack = 0x05, ///< Replaceable.\r
ProcessorUpgradeNone = 0x06,\r
ProcessorUpgradeLIFSocket = 0x07,\r
ProcessorUpgradeSlot1 = 0x08,\r
ProcessorUpgradeSlotA = 0x0B,\r
ProcessorUpgradeSlotM = 0x0C,\r
ProcessorUpgradeSocket423 = 0x0D,\r
- ProcessorUpgradeSocketA = 0x0E, ///< Socket 462\r
+ ProcessorUpgradeSocketA = 0x0E, ///< Socket 462.\r
ProcessorUpgradeSocket478 = 0x0F,\r
ProcessorUpgradeSocket754 = 0x10,\r
ProcessorUpgradeSocket940 = 0x11,\r
} PROCESSOR_ID_DATA;\r
\r
///\r
-/// Processor Information (Type 4)\r
+/// Processor Information (Type 4).\r
///\r
/// The information in this structure defines the attributes of a single processor; \r
/// a separate structure instance is provided for each system processor socket/slot. \r
/// For example, a system with an IntelDX2 processor would have a single \r
-/// structure instance while a system with an IntelSX2 processor would have a structure\r
-/// to describe the main CPU and a second structure to describe the 80487 co-processor. \r
+/// structure instance, while a system with an IntelSX2 processor would have a structure\r
+/// to describe the main CPU, and a second structure to describe the 80487 co-processor. \r
///\r
typedef struct { \r
SMBIOS_STRUCTURE Hdr;\r
SMBIOS_TABLE_STRING Socket;\r
- UINT8 ProcessorType; ///< enumeration value from PROCESSOR_TYPE_DATA\r
- UINT8 ProcessorFamily; ///< enumeration value from PROCESSOR_FAMILY_DATA\r
+ UINT8 ProcessorType; ///< The enumeration value from PROCESSOR_TYPE_DATA.\r
+ UINT8 ProcessorFamily; ///< The enumeration value from PROCESSOR_FAMILY_DATA.\r
SMBIOS_TABLE_STRING ProcessorManufacture;\r
PROCESSOR_ID_DATA ProcessorId;\r
SMBIOS_TABLE_STRING ProcessorVersion;\r
UINT16 MaxSpeed;\r
UINT16 CurrentSpeed;\r
UINT8 Status;\r
- UINT8 ProcessorUpgrade; ///< enumeration value from PROCESSOR_UPGRADE\r
+ UINT8 ProcessorUpgrade; ///< The enumeration value from PROCESSOR_UPGRADE.\r
UINT16 L1CacheHandle;\r
UINT16 L2CacheHandle;\r
UINT16 L3CacheHandle;\r
} SMBIOS_TABLE_TYPE4;\r
\r
///\r
-/// Memory Controller Error Detecting Method \r
+/// Memory Controller Error Detecting Method.\r
///\r
typedef enum { \r
ErrorDetectingMethodOther = 0x01,\r
} MEMORY_ERROR_DETECT_METHOD;\r
\r
///\r
-/// Memory Controller Error Correcting Capability\r
+/// Memory Controller Error Correcting Capability.\r
///\r
typedef struct {\r
UINT8 Other :1;\r
} MEMORY_ERROR_CORRECT_CAPABILITY;\r
\r
///\r
-/// Memory Controller Information - Interleave Support\r
+/// Memory Controller Information - Interleave Support.\r
///\r
typedef enum { \r
MemoryInterleaveOther = 0x01,\r
} MEMORY_SUPPORT_INTERLEAVE_TYPE;\r
\r
///\r
-/// Memory Controller Information - Memory Speeds\r
+/// Memory Controller Information - Memory Speeds.\r
///\r
typedef struct {\r
UINT16 Other :1;\r
} MEMORY_SPEED_TYPE;\r
\r
///\r
-/// Memory Controller Information (Type 5, Obsolete)\r
+/// Memory Controller Information (Type 5, Obsolete).\r
///\r
/// The information in this structure defines the attributes of the system's memory controller(s) \r
/// and the supported attributes of any memory-modules present in the sockets controlled by \r
/// this controller. \r
/// Note: This structure, and its companion Memory Module Information (Type 6, Obsolete), \r
-/// are obsolete starting with version 2.1 of this specification; the Physical Memory Array (Type 16)\r
+/// are obsolete starting with version 2.1 of this specification. The Physical Memory Array (Type 16)\r
/// and Memory Device (Type 17) structures should be used instead. BIOS providers might\r
/// choose to implement both memory description types to allow existing DMI browsers\r
/// to properly display the system's memory attributes.\r
///\r
typedef struct {\r
SMBIOS_STRUCTURE Hdr;\r
- UINT8 ErrDetectMethod; ///< enumeration value from MEMORY_ERROR_DETECT_METHOD\r
+ UINT8 ErrDetectMethod; ///< The enumeration value from MEMORY_ERROR_DETECT_METHOD.\r
MEMORY_ERROR_CORRECT_CAPABILITY ErrCorrectCapability;\r
- UINT8 SupportInterleave; ///< enumeration value from MEMORY_SUPPORT_INTERLEAVE_TYPE\r
- UINT8 CurrentInterleave; ///< enumeration value from MEMORY_SUPPORT_INTERLEAVE_TYPE \r
+ UINT8 SupportInterleave; ///< The enumeration value from MEMORY_SUPPORT_INTERLEAVE_TYPE.\r
+ UINT8 CurrentInterleave; ///< The enumeration value from MEMORY_SUPPORT_INTERLEAVE_TYPE . \r
UINT8 MaxMemoryModuleSize;\r
MEMORY_SPEED_TYPE SupportSpeed;\r
UINT16 SupportMemoryType;\r
} MEMORY_CURRENT_TYPE;\r
\r
///\r
-/// Memory Module Information - Memory Size\r
+/// Memory Module Information - Memory Size.\r
///\r
typedef struct {\r
UINT8 InstalledOrEnabledSize :7; ///< Size (n), where 2**n is the size in MB.\r
/// of each system memory module. The supported attributes of each module are described \r
/// by the "owning" Memory Controller Information structure. \r
/// Note: This structure, and its companion Memory Controller Information (Type 5, Obsolete), \r
-/// are obsolete starting with version 2.1 of this specification; the Physical Memory Array (Type 16)\r
+/// are obsolete starting with version 2.1 of this specification. The Physical Memory Array (Type 16)\r
/// and Memory Device (Type 17) structures should be used instead.\r
///\r
typedef struct {\r
} SMBIOS_TABLE_TYPE6;\r
\r
///\r
-/// Cache Information - SRAM Type\r
+/// Cache Information - SRAM Type.\r
///\r
typedef struct {\r
UINT16 Other :1;\r
} CACHE_SRAM_TYPE_DATA;\r
\r
///\r
-/// Cache Information - Error Correction Type \r
+/// Cache Information - Error Correction Type.\r
///\r
typedef enum {\r
CacheErrorOther = 0x01,\r
} CACHE_ERROR_TYPE_DATA;\r
\r
///\r
-/// Cache Information - System Cache Type \r
+/// Cache Information - System Cache Type. \r
///\r
typedef enum {\r
CacheTypeOther = 0x01,\r
} CACHE_TYPE_DATA;\r
\r
///\r
-/// Cache Information - Associativity \r
+/// Cache Information - Associativity. \r
///\r
typedef enum {\r
CacheAssociativityOther = 0x01,\r
} CACHE_ASSOCIATIVITY_DATA;\r
\r
///\r
-/// Cache Information (Type 7)\r
+/// Cache Information (Type 7).\r
///\r
-/// he information in this structure defines the attributes of CPU cache device in the system. \r
+/// The information in this structure defines the attributes of CPU cache device in the system. \r
/// One structure is specified for each such device, whether the device is internal to\r
/// or external to the CPU module. Cache modules can be associated with a processor structure\r
-/// in one or two ways depending on the SMBIOS version.\r
+/// in one or two ways, depending on the SMBIOS version.\r
///\r
typedef struct {\r
SMBIOS_STRUCTURE Hdr;\r
CACHE_SRAM_TYPE_DATA SupportedSRAMType;\r
CACHE_SRAM_TYPE_DATA CurrentSRAMType;\r
UINT8 CacheSpeed;\r
- UINT8 ErrorCorrectionType; ///< enumeration value from CACHE_ERROR_TYPE_DATA\r
- UINT8 SystemCacheType; ///< enumeration value from CACHE_TYPE_DATA\r
- UINT8 Associativity; ///< enumeration value from CACHE_ASSOCIATIVITY_DATA\r
+ UINT8 ErrorCorrectionType; ///< The enumeration value from CACHE_ERROR_TYPE_DATA.\r
+ UINT8 SystemCacheType; ///< The enumeration value from CACHE_TYPE_DATA.\r
+ UINT8 Associativity; ///< The enumeration value from CACHE_ASSOCIATIVITY_DATA.\r
} SMBIOS_TABLE_TYPE7;\r
\r
///\r
-/// Port Connector Information - Connector Types \r
+/// Port Connector Information - Connector Types. \r
///\r
typedef enum {\r
PortConnectorTypeNone = 0x00,\r
} MISC_PORT_TYPE;\r
\r
///\r
-/// Port Connector Information (Type 8)\r
+/// Port Connector Information (Type 8).\r
///\r
/// The information in this structure defines the attributes of a system port connector, \r
/// e.g. parallel, serial, keyboard, or mouse ports. The port's type and connector information \r
typedef struct {\r
SMBIOS_STRUCTURE Hdr;\r
SMBIOS_TABLE_STRING InternalReferenceDesignator;\r
- UINT8 InternalConnectorType; ///< enumeration value from MISC_PORT_CONNECTOR_TYPE\r
+ UINT8 InternalConnectorType; ///< The enumeration value from MISC_PORT_CONNECTOR_TYPE.\r
SMBIOS_TABLE_STRING ExternalReferenceDesignator;\r
- UINT8 ExternalConnectorType; ///< enumeration value from MISC_PORT_CONNECTOR_TYPE\r
- UINT8 PortType; ///< enumeration value from MISC_PORT_TYPE\r
+ UINT8 ExternalConnectorType; ///< The enumeration value from MISC_PORT_CONNECTOR_TYPE.\r
+ UINT8 PortType; ///< The enumeration value from MISC_PORT_TYPE.\r
} SMBIOS_TABLE_TYPE8;\r
\r
///\r
} MISC_SLOT_TYPE;\r
\r
///\r
-/// System Slots - Slot Data Bus Width\r
+/// System Slots - Slot Data Bus Width.\r
///\r
typedef enum {\r
SlotDataBusWidthOther = 0x01,\r
} MISC_SLOT_DATA_BUS_WIDTH;\r
\r
///\r
-/// System Slots - Current Usage\r
+/// System Slots - Current Usage.\r
///\r
typedef enum {\r
SlotUsageOther = 0x01,\r
} MISC_SLOT_USAGE;\r
\r
///\r
-/// System Slots - Slot Length \r
+/// System Slots - Slot Length. \r
///\r
typedef enum {\r
SlotLengthOther = 0x01,\r
} MISC_SLOT_LENGTH;\r
\r
///\r
-/// System Slots - Slot Characteristics 1 \r
+/// System Slots - Slot Characteristics 1. \r
///\r
typedef struct {\r
UINT8 CharacteristicsUnknown :1;\r
UINT8 ModemRingResumeSupported:1;\r
} MISC_SLOT_CHARACTERISTICS1;\r
///\r
-/// System Slots - Slot Characteristics 2 \r
+/// System Slots - Slot Characteristics 2. \r
///\r
typedef struct {\r
UINT8 PmeSignalSupported :1;\r
typedef struct {\r
SMBIOS_STRUCTURE Hdr;\r
SMBIOS_TABLE_STRING SlotDesignation;\r
- UINT8 SlotType; ///< enumeration value from MISC_SLOT_TYPE\r
- UINT8 SlotDataBusWidth; ///< enumeration value from MISC_SLOT_DATA_BUS_WIDTH\r
- UINT8 CurrentUsage; ///< enumeration value from MISC_SLOT_USAGE\r
- UINT8 SlotLength; ///< enumeration value from MISC_SLOT_LENGTH\r
+ UINT8 SlotType; ///< The enumeration value from MISC_SLOT_TYPE.\r
+ UINT8 SlotDataBusWidth; ///< The enumeration value from MISC_SLOT_DATA_BUS_WIDTH.\r
+ UINT8 CurrentUsage; ///< The enumeration value from MISC_SLOT_USAGE.\r
+ UINT8 SlotLength; ///< The enumeration value from MISC_SLOT_LENGTH.\r
UINT16 SlotID;\r
MISC_SLOT_CHARACTERISTICS1 SlotCharacteristics1;\r
MISC_SLOT_CHARACTERISTICS2 SlotCharacteristics2;\r
} SMBIOS_TABLE_TYPE9;\r
\r
///\r
-/// On Board Devices Information - Device Types \r
+/// On Board Devices Information - Device Types. \r
///\r
typedef enum {\r
OnBoardDeviceTypeOther = 0x01,\r
/// Device Item Entry\r
///\r
typedef struct {\r
- UINT8 DeviceType; ///< Bit [6:0] - enumeration type of device from MISC_ONBOARD_DEVICE_TYPE\r
- ///< Bit 7 - 1 : device enabled, 0 : device disabled\r
+ UINT8 DeviceType; ///< Bit [6:0] - enumeration type of device from MISC_ONBOARD_DEVICE_TYPE.\r
+ ///< Bit 7 - 1 : device enabled, 0 : device disabled.\r
SMBIOS_TABLE_STRING DescriptionString;\r
} DEVICE_STRUCT;\r
\r
///\r
-/// On Board Devices Information (Type 10, obsolete)\r
+/// On Board Devices Information (Type 10, obsolete).\r
///\r
/// Note: This structure is obsolete starting with version 2.6 specification; the Onboard Devices Extended \r
/// Information (Type 41) structure should be used instead . BIOS providers can choose to implement both \r
} SMBIOS_TABLE_TYPE10;\r
\r
///\r
-/// OEM Strings (Type 11)\r
+/// OEM Strings (Type 11).\r
/// This structure contains free form strings defined by the OEM. Examples of this are: \r
/// Part Numbers for Reference Documents for the system, contact information for the manufacturer, etc. \r
///\r
} SMBIOS_TABLE_TYPE11;\r
\r
///\r
-/// System Configuration Options (Type 12)\r
+/// System Configuration Options (Type 12).\r
///\r
/// This structure contains information required to configure the base board's Jumpers and Switches. \r
///\r
\r
\r
///\r
-/// BIOS Language Information (Type 13)\r
+/// BIOS Language Information (Type 13).\r
///\r
/// The information in this structure defines the installable language attributes of the BIOS. \r
/// \r
} SMBIOS_TABLE_TYPE13;\r
\r
///\r
-/// System Event Log - Event Log Types \r
+/// System Event Log - Event Log Types.\r
/// \r
typedef enum {\r
EventLogTypeReserved = 0x00,\r
} EVENT_LOG_TYPE_DATA;\r
\r
///\r
-/// System Event Log - Variable Data Format Types \r
+/// System Event Log - Variable Data Format Types. \r
/// \r
typedef enum {\r
EventLogVariableNone = 0x00,\r
/// Event Log Type Descriptors\r
///\r
typedef struct {\r
- UINT8 LogType; ///< enumeration value from EVENT_LOG_TYPE_DATA\r
+ UINT8 LogType; ///< The enumeration value from EVENT_LOG_TYPE_DATA.\r
UINT8 DataFormatType;\r
} EVENT_LOG_TYPE;\r
\r
///\r
-/// Group Associations (Type 14)\r
+/// Group Associations (Type 14).\r
///\r
/// The Group Associations structure is provided for OEMs who want to specify \r
/// the arrangement or hierarchy of certain components (including other Group Associations) \r
} SMBIOS_TABLE_TYPE14;\r
\r
///\r
-/// System Event Log (Type 15)\r
+/// System Event Log (Type 15).\r
///\r
/// The presence of this structure within the SMBIOS data returned for a system indicates \r
/// that the system supports an event log. An event log is a fixed-length area within a \r
} SMBIOS_TABLE_TYPE15;\r
\r
///\r
-/// Physical Memory Array - Location\r
+/// Physical Memory Array - Location.\r
///\r
typedef enum {\r
MemoryArrayLocationOther = 0x01,\r
} MEMORY_ARRAY_LOCATION;\r
\r
///\r
-/// Physical Memory Array - Use\r
+/// Physical Memory Array - Use.\r
///\r
typedef enum {\r
MemoryArrayUseOther = 0x01,\r
} MEMORY_ARRAY_USE;\r
\r
///\r
-/// Physical Memory Array - Error Correction Types \r
+/// Physical Memory Array - Error Correction Types. \r
///\r
typedef enum {\r
MemoryErrorCorrectionOther = 0x01,\r
} MEMORY_ERROR_CORRECTION;\r
\r
///\r
-/// Physical Memory Array (Type 16)\r
+/// Physical Memory Array (Type 16).\r
///\r
/// This structure describes a collection of memory devices that operate \r
/// together to form a memory address space. \r
///\r
typedef struct {\r
SMBIOS_STRUCTURE Hdr;\r
- UINT8 Location; ///< enumeration value from MEMORY_ARRAY_LOCATION\r
- UINT8 Use; ///< enumeration value from MEMORY_ARRAY_USE\r
- UINT8 MemoryErrorCorrection; ///< enumeration value from MEMORY_ERROR_CORRECTION\r
+ UINT8 Location; ///< The enumeration value from MEMORY_ARRAY_LOCATION.\r
+ UINT8 Use; ///< The enumeration value from MEMORY_ARRAY_USE.\r
+ UINT8 MemoryErrorCorrection; ///< The enumeration value from MEMORY_ERROR_CORRECTION.\r
UINT32 MaximumCapacity;\r
UINT16 MemoryErrorInformationHandle;\r
UINT16 NumberOfMemoryDevices;\r
} SMBIOS_TABLE_TYPE16;\r
\r
///\r
-/// Memory Device - Form Factor\r
+/// Memory Device - Form Factor.\r
///\r
typedef enum {\r
MemoryFormFactorOther = 0x01,\r
} MEMORY_DEVICE_TYPE_DETAIL;\r
\r
///\r
-/// Memory Device (Type 17)\r
+/// Memory Device (Type 17).\r
///\r
/// This structure describes a single memory device that is part of \r
/// a larger Physical Memory Array (Type 16).\r
/// Note: If a system includes memory-device sockets, the SMBIOS implementation \r
-/// includes a Memory Device structure instance for each slot whether or not the \r
+/// includes a Memory Device structure instance for each slot, whether or not the \r
/// socket is currently populated.\r
///\r
typedef struct {\r
UINT16 TotalWidth;\r
UINT16 DataWidth;\r
UINT16 Size;\r
- UINT8 FormFactor; ///< enumeration value from MEMORY_FORM_FACTOR\r
+ UINT8 FormFactor; ///< The enumeration value from MEMORY_FORM_FACTOR.\r
UINT8 DeviceSet;\r
SMBIOS_TABLE_STRING DeviceLocator;\r
SMBIOS_TABLE_STRING BankLocator;\r
- UINT8 MemoryType; ///< enumeration value from MEMORY_DEVICE_TYPE\r
+ UINT8 MemoryType; ///< The enumeration value from MEMORY_DEVICE_TYPE.\r
MEMORY_DEVICE_TYPE_DETAIL TypeDetail;\r
UINT16 Speed;\r
SMBIOS_TABLE_STRING Manufacturer;\r
} SMBIOS_TABLE_TYPE17;\r
\r
///\r
-/// 32-bit Memory Error Information - Error Type \r
+/// 32-bit Memory Error Information - Error Type. \r
///\r
typedef enum { \r
MemoryErrorOther = 0x01,\r
} MEMORY_ERROR_TYPE;\r
\r
///\r
-/// 32-bit Memory Error Information - Error Granularity \r
+/// 32-bit Memory Error Information - Error Granularity. \r
///\r
typedef enum { \r
MemoryGranularityOther = 0x01,\r
} MEMORY_ERROR_GRANULARITY;\r
\r
///\r
-/// 32-bit Memory Error Information - Error Operation \r
+/// 32-bit Memory Error Information - Error Operation. \r
///\r
typedef enum { \r
MemoryErrorOperationOther = 0x01,\r
} MEMORY_ERROR_OPERATION;\r
\r
///\r
-/// 32-bit Memory Error Information (Type 18)\r
+/// 32-bit Memory Error Information (Type 18).\r
/// \r
/// This structure identifies the specifics of an error that might be detected \r
/// within a Physical Memory Array.\r
///\r
typedef struct {\r
SMBIOS_STRUCTURE Hdr;\r
- UINT8 ErrorType; ///< enumeration value from MEMORY_ERROR_TYPE\r
- UINT8 ErrorGranularity; ///< enumeration value from MEMORY_ERROR_GRANULARITY\r
- UINT8 ErrorOperation; ///< enumeration value from MEMORY_ERROR_OPERATION\r
+ UINT8 ErrorType; ///< The enumeration value from MEMORY_ERROR_TYPE.\r
+ UINT8 ErrorGranularity; ///< The enumeration value from MEMORY_ERROR_GRANULARITY.\r
+ UINT8 ErrorOperation; ///< The enumeration value from MEMORY_ERROR_OPERATION.\r
UINT32 VendorSyndrome;\r
UINT32 MemoryArrayErrorAddress;\r
UINT32 DeviceErrorAddress;\r
} SMBIOS_TABLE_TYPE18;\r
\r
///\r
-/// Memory Array Mapped Address (Type 19)\r
+/// Memory Array Mapped Address (Type 19).\r
///\r
/// This structure provides the address mapping for a Physical Memory Array. \r
/// One structure is present for each contiguous address range described.\r
} SMBIOS_TABLE_TYPE19;\r
\r
///\r
-/// Memory Device Mapped Address (Type 20)\r
+/// Memory Device Mapped Address (Type 20).\r
///\r
/// This structure maps memory address space usually to a device-level granularity. \r
/// One structure is present for each contiguous address range described. \r
} BUILTIN_POINTING_DEVICE_TYPE;\r
\r
///\r
-/// Built-in Pointing Device - Interface\r
+/// Built-in Pointing Device - Interface.\r
///\r
typedef enum {\r
PointingDeviceInterfaceOther = 0x01,\r
} BUILTIN_POINTING_DEVICE_INTERFACE;\r
\r
///\r
-/// Built-in Pointing Device (Type 21)\r
+/// Built-in Pointing Device (Type 21).\r
///\r
/// This structure describes the attributes of the built-in pointing device for the \r
-/// system - the presence of this structure does not imply that the built-in\r
+/// system. The presence of this structure does not imply that the built-in\r
/// pointing device is active for the system's use! \r
///\r
typedef struct {\r
SMBIOS_STRUCTURE Hdr;\r
- UINT8 Type; ///< enumeration value from BUILTIN_POINTING_DEVICE_TYPE\r
- UINT8 Interface; ///< enumeration value from BUILTIN_POINTING_DEVICE_INTERFACE\r
+ UINT8 Type; ///< The enumeration value from BUILTIN_POINTING_DEVICE_TYPE.\r
+ UINT8 Interface; ///< The enumeration value from BUILTIN_POINTING_DEVICE_INTERFACE.\r
UINT8 NumberOfButtons;\r
} SMBIOS_TABLE_TYPE21;\r
\r
} PORTABLE_BATTERY_DEVICE_CHEMISTRY;\r
\r
///\r
-/// Portable Battery (Type 22)\r
+/// Portable Battery (Type 22).\r
///\r
/// This structure describes the attributes of the portable battery(s) for the system. \r
/// The structure contains the static attributes for the group. Each structure describes \r
SMBIOS_TABLE_STRING ManufactureDate;\r
SMBIOS_TABLE_STRING SerialNumber;\r
SMBIOS_TABLE_STRING DeviceName;\r
- UINT8 DeviceChemistry; ///< enumeration value from PORTABLE_BATTERY_DEVICE_CHEMISTRY\r
+ UINT8 DeviceChemistry; ///< The enumeration value from PORTABLE_BATTERY_DEVICE_CHEMISTRY.\r
UINT16 DeviceCapacity;\r
UINT16 DesignVoltage;\r
SMBIOS_TABLE_STRING SBDSVersionNumber;\r
} SMBIOS_TABLE_TYPE23;\r
\r
///\r
-/// Hardware Security (Type 24)\r
+/// Hardware Security (Type 24).\r
///\r
/// This structure describes the system-wide hardware security settings. \r
///\r
} SMBIOS_TABLE_TYPE24;\r
\r
///\r
-/// System Power Controls (Type 25)\r
+/// System Power Controls (Type 25).\r
///\r
/// This structure describes the attributes for controlling the main power supply to the system. \r
/// Software that interprets this structure uses the month, day, hour, minute, and second values \r
} SMBIOS_TABLE_TYPE25;\r
\r
///\r
-/// Voltage Probe - Location and Status\r
+/// Voltage Probe - Location and Status.\r
///\r
typedef struct {\r
UINT8 VoltageProbeSite :5;\r
} SMBIOS_TABLE_TYPE26;\r
\r
///\r
-/// Cooling Device - Device Type and Status\r
+/// Cooling Device - Device Type and Status.\r
///\r
typedef struct {\r
UINT8 CoolingDevice :5;\r
} SMBIOS_TABLE_TYPE27;\r
\r
///\r
-/// Temperature Probe - Location and Status\r
+/// Temperature Probe - Location and Status.\r
///\r
typedef struct {\r
UINT8 TemperatureProbeSite :5;\r
} MISC_TEMPERATURE_PROBE_LOCATION;\r
\r
///\r
-/// Temperature Probe (Type 28)\r
+/// Temperature Probe (Type 28).\r
///\r
/// This structure describes the attributes for a temperature probe in the system. \r
/// Each structure describes a single temperature probe. \r
} SMBIOS_TABLE_TYPE28;\r
\r
///\r
-/// Electrical Current Probe - Location and Status\r
+/// Electrical Current Probe - Location and Status.\r
///\r
typedef struct {\r
UINT8 ElectricalCurrentProbeSite :5;\r
} MISC_ELECTRICAL_CURRENT_PROBE_LOCATION;\r
\r
///\r
-/// Electrical Current Probe (Type 29)\r
+/// Electrical Current Probe (Type 29).\r
///\r
/// This structure describes the attributes for an electrical current probe in the system.\r
/// Each structure describes a single electrical current probe. \r
} SMBIOS_TABLE_TYPE29;\r
\r
///\r
-/// Out-of-Band Remote Access (Type 30)\r
+/// Out-of-Band Remote Access (Type 30).\r
///\r
/// This structure describes the attributes and policy settings of a hardware facility \r
/// that may be used to gain remote access to a hardware system when the operating system \r
} SMBIOS_TABLE_TYPE30;\r
\r
///\r
-/// Boot Integrity Services (BIS) Entry Point (Type 31)\r
+/// Boot Integrity Services (BIS) Entry Point (Type 31).\r
///\r
/// Structure type 31 (decimal) is reserved for use by the Boot Integrity Services (BIS). \r
/// \r
} SMBIOS_TABLE_TYPE31;\r
\r
///\r
-/// System Boot Information - System Boot Status\r
+/// System Boot Information - System Boot Status.\r
///\r
typedef enum {\r
BootInformationStatusNoError = 0x00,\r
} MISC_BOOT_INFORMATION_STATUS_DATA_TYPE;\r
\r
///\r
-/// System Boot Information (Type 32)\r
+/// System Boot Information (Type 32).\r
///\r
/// The client system firmware, e.g. BIOS, communicates the System Boot Status to the \r
/// client's Pre-boot Execution Environment (PXE) boot image or OS-present management \r
typedef struct {\r
SMBIOS_STRUCTURE Hdr;\r
UINT8 Reserved[6];\r
- UINT8 BootStatus; ///< enumeration value from MISC_BOOT_INFORMATION_STATUS_DATA_TYPE\r
+ UINT8 BootStatus; ///< The enumeration value from MISC_BOOT_INFORMATION_STATUS_DATA_TYPE.\r
} SMBIOS_TABLE_TYPE32;\r
\r
///\r
-/// 64-bit Memory Error Information (Type 33)\r
+/// 64-bit Memory Error Information (Type 33).\r
///\r
/// This structure describes an error within a Physical Memory Array, \r
/// when the error address is above 4G (0xFFFFFFFF).\r
/// \r
typedef struct {\r
SMBIOS_STRUCTURE Hdr;\r
- UINT8 ErrorType; ///< enumeration value from MEMORY_ERROR_TYPE\r
- UINT8 ErrorGranularity; ///< enumeration value from MEMORY_ERROR_GRANULARITY\r
- UINT8 ErrorOperation; ///< enumeration value from MEMORY_ERROR_OPERATION\r
+ UINT8 ErrorType; ///< The enumeration value from MEMORY_ERROR_TYPE.\r
+ UINT8 ErrorGranularity; ///< The enumeration value from MEMORY_ERROR_GRANULARITY.\r
+ UINT8 ErrorOperation; ///< The enumeration value from MEMORY_ERROR_OPERATION.\r
UINT32 VendorSyndrome;\r
UINT64 MemoryArrayErrorAddress;\r
UINT64 DeviceErrorAddress;\r
} SMBIOS_TABLE_TYPE33;\r
\r
///\r
-/// Management Device - Type \r
+/// Management Device - Type. \r
///\r
typedef enum {\r
ManagementDeviceTypeOther = 0x01,\r
} MISC_MANAGEMENT_DEVICE_TYPE;\r
\r
///\r
-/// Management Device - Address Type \r
+/// Management Device - Address Type. \r
///\r
typedef enum {\r
ManagementDeviceAddressTypeOther = 0x01,\r
} MISC_MANAGEMENT_DEVICE_ADDRESS_TYPE;\r
\r
///\r
-/// Management Device (Type 34)\r
+/// Management Device (Type 34).\r
///\r
/// The information in this structure defines the attributes of a Management Device. \r
/// A Management Device might control one or more fans or voltage, current, or temperature\r
typedef struct {\r
SMBIOS_STRUCTURE Hdr;\r
SMBIOS_TABLE_STRING Description;\r
- UINT8 Type; ///< enumeration value from MISC_MANAGEMENT_DEVICE_TYPE\r
+ UINT8 Type; ///< The enumeration value from MISC_MANAGEMENT_DEVICE_TYPE.\r
UINT32 Address;\r
- UINT8 AddressType; ///< enumeration value from MISC_MANAGEMENT_DEVICE_ADDRESS_TYPE\r
+ UINT8 AddressType; ///< The enumeration value from MISC_MANAGEMENT_DEVICE_ADDRESS_TYPE.\r
} SMBIOS_TABLE_TYPE34;\r
\r
///\r
} SMBIOS_TABLE_TYPE35;\r
\r
///\r
-/// Management Device Threshold Data (Type 36)\r
+/// Management Device Threshold Data (Type 36).\r
///\r
/// The information in this structure defines threshold information for \r
/// a component (probe or cooling-unit) contained within a Management Device. \r
} SMBIOS_TABLE_TYPE36;\r
\r
///\r
-/// Memory Channel Entry\r
+/// Memory Channel Entry.\r
///\r
typedef struct {\r
UINT8 DeviceLoad;\r
} MEMORY_DEVICE;\r
\r
///\r
-/// Memory Channel - Channel Type\r
+/// Memory Channel - Channel Type.\r
///\r
typedef enum {\r
MemoryChannelTypeOther = 0x01,\r
/// Memory Channel (Type 37)\r
///\r
/// The information in this structure provides the correlation between a Memory Channel\r
-/// and its associated Memory Devices. Each device presents one or more loads to the channel; \r
-/// the sum of all device loads cannot exceed the channel's defined maximum.\r
+/// and its associated Memory Devices. Each device presents one or more loads to the channel. \r
+/// The sum of all device loads cannot exceed the channel's defined maximum.\r
///\r
typedef struct {\r
SMBIOS_STRUCTURE Hdr;\r
///\r
typedef enum {\r
IPMIDeviceInfoInterfaceTypeUnknown = 0x00,\r
- IPMIDeviceInfoInterfaceTypeKCS = 0x01, ///< Keyboard Controller Style\r
- IPMIDeviceInfoInterfaceTypeSMIC = 0x02, ///< Server Management Interface Chip\r
- IPMIDeviceInfoInterfaceTypeBT = 0x03, ///< Block Transfer\r
+ IPMIDeviceInfoInterfaceTypeKCS = 0x01, ///< The Keyboard Controller Style.\r
+ IPMIDeviceInfoInterfaceTypeSMIC = 0x02, ///< The Server Management Interface Chip.\r
+ IPMIDeviceInfoInterfaceTypeBT = 0x03, ///< The Block Transfer\r
IPMIDeviceInfoInterfaceTypeReserved = 0x04\r
} BMC_INTERFACE_TYPE;\r
\r
///\r
-/// IPMI Device Information (Type 38)\r
+/// IPMI Device Information (Type 38).\r
///\r
/// The information in this structure defines the attributes of an \r
/// Intelligent Platform Management Interface (IPMI) Baseboard Management Controller (BMC).\r
/// \r
typedef struct {\r
SMBIOS_STRUCTURE Hdr;\r
- UINT8 InterfaceType; ///< enumeration value from BMC_INTERFACE_TYPE\r
+ UINT8 InterfaceType; ///< The enumeration value from BMC_INTERFACE_TYPE.\r
UINT8 IPMISpecificationRevision;\r
UINT8 I2CSlaveAddress;\r
UINT8 NVStorageDeviceAddress;\r
} SMBIOS_TABLE_TYPE38;\r
\r
///\r
-/// System Power Supply - Power Supply Characteristics\r
+/// System Power Supply - Power Supply Characteristics.\r
///\r
typedef struct {\r
UINT16 PowerSupplyHotReplaceable:1;\r
} SYS_POWER_SUPPLY_CHARACTERISTICS;\r
\r
///\r
-/// System Power Supply (Type 39)\r
+/// System Power Supply (Type 39).\r
///\r
/// This structure identifies attributes of a system power supply. One instance\r
/// of this record is present for each possible power supply in a system. \r
} SMBIOS_TABLE_TYPE39;\r
\r
///\r
-/// Additional Information Entry Format \r
+/// Additional Information Entry Format. \r
///\r
typedef struct { \r
UINT8 EntryLength; \r
}ADDITIONAL_INFORMATION_ENTRY;\r
\r
///\r
-/// Additional Information (Type 40)\r
+/// Additional Information (Type 40).\r
///\r
/// This structure is intended to provide additional information for handling unspecified \r
/// enumerated values and interim field updates in another structure. \r
} SMBIOS_TABLE_TYPE40;\r
\r
///\r
-/// Onboard Devices Extended Information - Onboard Device Types\r
+/// Onboard Devices Extended Information - Onboard Device Types.\r
///\r
typedef enum{\r
OnBoardDeviceExtendedTypeOther = 0x01,\r
} ONBOARD_DEVICE_EXTENDED_INFO_TYPE;\r
\r
///\r
-/// Onboard Devices Extended Information (Type 41)\r
+/// Onboard Devices Extended Information (Type 41).\r
///\r
/// The information in this structure defines the attributes of devices that \r
/// are onboard (soldered onto) a system element, usually the baseboard. \r
typedef struct {\r
SMBIOS_STRUCTURE Hdr;\r
SMBIOS_TABLE_STRING ReferenceDesignation;\r
- UINT8 DeviceType; ///< enumeration value from ONBOARD_DEVICE_EXTENDED_INFO_TYPE\r
+ UINT8 DeviceType; ///< The enumeration value from ONBOARD_DEVICE_EXTENDED_INFO_TYPE\r
UINT8 DeviceTypeInstance;\r
UINT16 SegmentGroupNum;\r
UINT8 BusNum;\r
} SMBIOS_TABLE_TYPE127;\r
\r
///\r
-/// Union of all the possible SMBIOS record types\r
+/// Union of all the possible SMBIOS record types.\r
///\r
typedef union {\r
SMBIOS_STRUCTURE *Hdr;\r
Provides string functions, linked list functions, math functions, synchronization\r
functions, and CPU architecture-specific functions.\r
\r
-Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<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
-http://opensource.org/licenses/bsd-license.php\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
#if defined (MDE_CPU_IA32)\r
///\r
-/// IA-32 architecture context buffer used by SetJump() and LongJump()\r
+/// The IA-32 architecture context buffer used by SetJump() and LongJump().\r
///\r
typedef struct {\r
UINT32 Ebx;\r
#if defined (MDE_CPU_IPF)\r
\r
///\r
-/// Itanium architecture context buffer used by SetJump() and LongJump()\r
+/// The Itanium architecture context buffer used by SetJump() and LongJump().\r
///\r
typedef struct {\r
UINT64 F2[2];\r
\r
#if defined (MDE_CPU_X64)\r
///\r
-/// x64 architecture context buffer used by SetJump() and LongJump()\r
+/// The x64 architecture context buffer used by SetJump() and LongJump().\r
///\r
typedef struct {\r
UINT64 Rbx;\r
UINT64 R15;\r
UINT64 Rip;\r
UINT64 MxCsr;\r
- UINT8 XmmBuffer[160]; ///< XMM6-XMM15\r
+ UINT8 XmmBuffer[160]; ///< XMM6-XMM15.\r
} BASE_LIBRARY_JUMP_BUFFER;\r
\r
#define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8\r
\r
#if defined (MDE_CPU_EBC)\r
///\r
-/// EBC context buffer used by SetJump() and LongJump()\r
+/// The EBC context buffer used by SetJump() and LongJump().\r
///\r
typedef struct {\r
UINT64 R0;\r
#if defined (MDE_CPU_ARM)\r
\r
typedef struct {\r
- UINT32 R3; ///< Copy of R13\r
+ UINT32 R3; ///< A copy of R13.\r
UINT32 R4;\r
UINT32 R5;\r
UINT32 R6;\r
PcdMaximumUnicodeStringLength Unicode characters not including the\r
Null-terminator, then ASSERT().\r
\r
- @param Destination Pointer to a Null-terminated Unicode string.\r
- @param Source Pointer to a Null-terminated Unicode string.\r
+ @param Destination The pointer to a Null-terminated Unicode string.\r
+ @param Source The pointer to a Null-terminated Unicode string.\r
\r
@return Destination.\r
\r
\r
\r
/**\r
- Copies up to a specified length from one Null-terminated Unicode string to \r
+ Copies up to a specified length from one Null-terminated Unicode string to \r
another Null-terminated Unicode string and returns the new Unicode string.\r
\r
This function copies the contents of the Unicode string Source to the Unicode\r
PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator,\r
then ASSERT().\r
\r
- @param Destination Pointer to a Null-terminated Unicode string.\r
- @param Source Pointer to a Null-terminated Unicode string.\r
- @param Length Maximum number of Unicode characters to copy.\r
+ @param Destination The pointer to a Null-terminated Unicode string.\r
+ @param Source The pointer to a Null-terminated Unicode string.\r
+ @param Length The maximum number of Unicode characters to copy.\r
\r
@return Destination.\r
\r
PcdMaximumUnicodeStringLength Unicode characters not including the\r
Null-terminator, then ASSERT().\r
\r
- @param String Pointer to a Null-terminated Unicode string.\r
+ @param String The pointer to a Null-terminated Unicode string.\r
\r
@return The size of String.\r
\r
than PcdMaximumUnicodeStringLength Unicode characters not including the\r
Null-terminator, then ASSERT().\r
If PcdMaximumUnicodeStringLength is not zero, and SecondString contains more\r
- than PcdMaximumUnicodeStringLength Unicode characters not including the\r
+ than PcdMaximumUnicodeStringLength Unicode characters, not including the\r
Null-terminator, then ASSERT().\r
\r
- @param FirstString Pointer to a Null-terminated Unicode string.\r
- @param SecondString Pointer to a Null-terminated Unicode string.\r
+ @param FirstString The pointer to a Null-terminated Unicode string.\r
+ @param SecondString The pointer to a Null-terminated Unicode string.\r
\r
@retval 0 FirstString is identical to SecondString.\r
@return others FirstString is not identical to SecondString.\r
PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator,\r
then ASSERT().\r
\r
- @param FirstString Pointer to a Null-terminated Unicode string.\r
- @param SecondString Pointer to a Null-terminated Unicode string.\r
- @param Length Maximum number of Unicode characters to compare.\r
+ @param FirstString The pointer to a Null-terminated Unicode string.\r
+ @param SecondString The pointer to a Null-terminated Unicode string.\r
+ @param Length The maximum number of Unicode characters to compare.\r
\r
@retval 0 FirstString is identical to SecondString.\r
@return others FirstString is not identical to SecondString.\r
If Source is not aligned on a 16-bit boundary, then ASSERT().\r
If Source and Destination overlap, then ASSERT().\r
If PcdMaximumUnicodeStringLength is not zero, and Destination contains more\r
- than PcdMaximumUnicodeStringLength Unicode characters not including the\r
+ than PcdMaximumUnicodeStringLength Unicode characters, not including the\r
Null-terminator, then ASSERT().\r
If PcdMaximumUnicodeStringLength is not zero, and Source contains more than\r
- PcdMaximumUnicodeStringLength Unicode characters not including the\r
+ PcdMaximumUnicodeStringLength Unicode characters, not including the\r
Null-terminator, then ASSERT().\r
If PcdMaximumUnicodeStringLength is not zero, and concatenating Destination\r
and Source results in a Unicode string with more than\r
- PcdMaximumUnicodeStringLength Unicode characters not including the\r
+ PcdMaximumUnicodeStringLength Unicode characters, not including the\r
Null-terminator, then ASSERT().\r
\r
- @param Destination Pointer to a Null-terminated Unicode string.\r
- @param Source Pointer to a Null-terminated Unicode string.\r
+ @param Destination The pointer to a Null-terminated Unicode string.\r
+ @param Source The pointer to a Null-terminated Unicode string.\r
\r
@return Destination.\r
\r
and Source results in a Unicode string with more than PcdMaximumUnicodeStringLength\r
Unicode characters, not including the Null-terminator, then ASSERT().\r
\r
- @param Destination Pointer to a Null-terminated Unicode string.\r
- @param Source Pointer to a Null-terminated Unicode string.\r
- @param Length Maximum number of Unicode characters to concatenate from\r
+ @param Destination The pointer to a Null-terminated Unicode string.\r
+ @param Source The pointer to a Null-terminated Unicode string.\r
+ @param Length The maximum number of Unicode characters to concatenate from\r
Source.\r
\r
@return Destination.\r
This function scans the contents of the Null-terminated Unicode string\r
specified by String and returns the first occurrence of SearchString.\r
If SearchString is not found in String, then NULL is returned. If\r
- the length of SearchString is zero, then String is\r
- returned.\r
+ the length of SearchString is zero, then String is returned.\r
\r
If String is NULL, then ASSERT().\r
If String is not aligned on a 16-bit boundary, then ASSERT().\r
\r
If PcdMaximumUnicodeStringLength is not zero, and SearchString\r
or String contains more than PcdMaximumUnicodeStringLength Unicode\r
- characters not including the Null-terminator, then ASSERT().\r
+ characters, not including the Null-terminator, then ASSERT().\r
\r
- @param String Pointer to a Null-terminated Unicode string.\r
- @param SearchString Pointer to a Null-terminated Unicode string to search for.\r
+ @param String The pointer to a Null-terminated Unicode string.\r
+ @param SearchString The pointer to a Null-terminated Unicode string to search for.\r
\r
@retval NULL If the SearchString does not appear in String.\r
@return others If there is a match.\r
more than PcdMaximumUnicodeStringLength Unicode characters not including\r
the Null-terminator, then ASSERT().\r
\r
- @param String Pointer to a Null-terminated Unicode string.\r
+ @param String The pointer to a Null-terminated Unicode string.\r
\r
@retval Value translated from String.\r
\r
more than PcdMaximumUnicodeStringLength Unicode characters not including\r
the Null-terminator, then ASSERT().\r
\r
- @param String Pointer to a Null-terminated Unicode string.\r
+ @param String The pointer to a Null-terminated Unicode string.\r
\r
@retval Value translated from String.\r
\r
The function will ignore the pad space, which includes spaces or tab characters,\r
before [zeros], [x] or [hexadecimal digit]. The running zero before [x] or\r
[hexadecimal digit] will be ignored. Then, the decoding starts after [x] or the\r
- first valid hexadecimal digit. Then, the function stops at the first character that is\r
- a not a valid hexadecimal character or NULL, whichever one comes first.\r
+ first valid hexadecimal digit. Then, the function stops at the first character \r
+ that is a not a valid hexadecimal character or NULL, whichever one comes first.\r
\r
If String is NULL, then ASSERT().\r
If String is not aligned in a 16-bit boundary, then ASSERT().\r
PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator,\r
then ASSERT().\r
\r
- @param String Pointer to a Null-terminated Unicode string.\r
+ @param String The pointer to a Null-terminated Unicode string.\r
\r
@retval Value translated from String.\r
\r
PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator,\r
then ASSERT().\r
\r
- @param String Pointer to a Null-terminated Unicode string.\r
+ @param String The pointer to a Null-terminated Unicode string.\r
\r
@retval Value translated from String.\r
\r
than PcdMaximumAsciiStringLength Unicode characters not including the\r
Null-terminator, then ASSERT().\r
\r
- @param Source Pointer to a Null-terminated Unicode string.\r
- @param Destination Pointer to a Null-terminated ASCII string.\r
+ @param Source The pointer to a Null-terminated Unicode string.\r
+ @param Destination The pointer to a Null-terminated ASCII string.\r
\r
@return Destination.\r
\r
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,\r
then ASSERT().\r
\r
- @param Destination Pointer to a Null-terminated ASCII string.\r
- @param Source Pointer to a Null-terminated ASCII string.\r
+ @param Destination The pointer to a Null-terminated ASCII string.\r
+ @param Source The pointer to a Null-terminated ASCII string.\r
\r
@return Destination\r
\r
PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,\r
then ASSERT().\r
\r
- @param Destination Pointer to a Null-terminated ASCII string.\r
- @param Source Pointer to a Null-terminated ASCII string.\r
- @param Length Maximum number of ASCII characters to copy.\r
+ @param Destination The pointer to a Null-terminated ASCII string.\r
+ @param Source The pointer to a Null-terminated ASCII string.\r
+ @param Length The maximum number of ASCII characters to copy.\r
\r
@return Destination\r
\r
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,\r
then ASSERT().\r
\r
- @param String Pointer to a Null-terminated ASCII string.\r
+ @param String The pointer to a Null-terminated ASCII string.\r
\r
@return The length of String.\r
\r
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,\r
then ASSERT().\r
\r
- @param String Pointer to a Null-terminated ASCII string.\r
+ @param String The pointer to a Null-terminated ASCII string.\r
\r
@return The size of String.\r
\r
than PcdMaximumAsciiStringLength ASCII characters not including the\r
Null-terminator, then ASSERT().\r
\r
- @param FirstString Pointer to a Null-terminated ASCII string.\r
- @param SecondString Pointer to a Null-terminated ASCII string.\r
+ @param FirstString The pointer to a Null-terminated ASCII string.\r
+ @param SecondString The pointer to a Null-terminated ASCII string.\r
\r
@retval ==0 FirstString is identical to SecondString.\r
@retval !=0 FirstString is not identical to SecondString.\r
than PcdMaximumAsciiStringLength ASCII characters not including the\r
Null-terminator, then ASSERT().\r
\r
- @param FirstString Pointer to a Null-terminated ASCII string.\r
- @param SecondString Pointer to a Null-terminated ASCII string.\r
+ @param FirstString The pointer to a Null-terminated ASCII string.\r
+ @param SecondString The pointer to a Null-terminated ASCII string.\r
\r
@retval ==0 FirstString is identical to SecondString using case insensitive\r
comparisons.\r
PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,\r
then ASSERT().\r
\r
- @param FirstString Pointer to a Null-terminated ASCII string.\r
- @param SecondString Pointer to a Null-terminated ASCII string.\r
- @param Length Maximum number of ASCII characters for compare.\r
+ @param FirstString The pointer to a Null-terminated ASCII string.\r
+ @param SecondString The pointer to a Null-terminated ASCII string.\r
+ @param Length The maximum number of ASCII characters for compare.\r
\r
@retval ==0 FirstString is identical to SecondString.\r
@retval !=0 FirstString is not identical to SecondString.\r
Source results in a ASCII string with more than PcdMaximumAsciiStringLength\r
ASCII characters, then ASSERT().\r
\r
- @param Destination Pointer to a Null-terminated ASCII string.\r
- @param Source Pointer to a Null-terminated ASCII string.\r
+ @param Destination The pointer to a Null-terminated ASCII string.\r
+ @param Source The pointer to a Null-terminated ASCII string.\r
\r
@return Destination\r
\r
Source results in a ASCII string with more than PcdMaximumAsciiStringLength\r
ASCII characters, not including the Null-terminator, then ASSERT().\r
\r
- @param Destination Pointer to a Null-terminated ASCII string.\r
- @param Source Pointer to a Null-terminated ASCII string.\r
- @param Length Maximum number of ASCII characters to concatenate from\r
+ @param Destination The pointer to a Null-terminated ASCII string.\r
+ @param Source The pointer to a Null-terminated ASCII string.\r
+ @param Length The maximum number of ASCII characters to concatenate from\r
Source.\r
\r
@return Destination\r
String contains more than PcdMaximumAsciiStringLength Unicode characters\r
not including the Null-terminator, then ASSERT().\r
\r
- @param String Pointer to a Null-terminated ASCII string.\r
- @param SearchString Pointer to a Null-terminated ASCII string to search for.\r
+ @param String The pointer to a Null-terminated ASCII string.\r
+ @param SearchString The pointer to a Null-terminated ASCII string to search for.\r
\r
@retval NULL If the SearchString does not appear in String.\r
@retval others If there is a match return the first occurrence of SearchingString.\r
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,\r
then ASSERT().\r
\r
- @param String Pointer to a Null-terminated ASCII string.\r
+ @param String The pointer to a Null-terminated ASCII string.\r
\r
- @retval Value translated from String.\r
+ @retval The value translated from String.\r
\r
**/\r
UINTN\r
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,\r
then ASSERT().\r
\r
- @param String Pointer to a Null-terminated ASCII string.\r
+ @param String The pointer to a Null-terminated ASCII string.\r
\r
@retval Value translated from String.\r
\r
and String contains more than PcdMaximumAsciiStringLength ASCII characters not including\r
the Null-terminator, then ASSERT().\r
\r
- @param String Pointer to a Null-terminated ASCII string.\r
+ @param String The pointer to a Null-terminated ASCII string.\r
\r
@retval Value translated from String.\r
\r
and String contains more than PcdMaximumAsciiStringLength ASCII characters not including\r
the Null-terminator, then ASSERT().\r
\r
- @param String Pointer to a Null-terminated ASCII string.\r
+ @param String The pointer to a Null-terminated ASCII string.\r
\r
@retval Value translated from String.\r
\r
PcdMaximumUnicodeStringLength ASCII characters not including the\r
Null-terminator, then ASSERT().\r
\r
- @param Source Pointer to a Null-terminated ASCII string.\r
- @param Destination Pointer to a Null-terminated Unicode string.\r
+ @param Source The pointer to a Null-terminated ASCII string.\r
+ @param Destination The pointer to a Null-terminated Unicode string.\r
\r
@return Destination.\r
\r
@param List A pointer to the head node of a doubly linked list.\r
@param Node A pointer to a node in the doubly linked list.\r
\r
- @return Pointer to the next node if one exists. Otherwise List is returned.\r
+ @return The pointer to the next node if one exists. Otherwise List is returned.\r
\r
**/\r
LIST_ENTRY *\r
@param List A pointer to the head node of a doubly linked list.\r
@param Node A pointer to a node in the doubly linked list.\r
\r
- @return Pointer to the previous node if one exists. Otherwise List is returned.\r
+ @return The pointer to the previous node if one exists. Otherwise List is returned.\r
\r
**/\r
LIST_ENTRY *\r
\r
\r
/**\r
- Switches the endianess of a 16-bit integer.\r
+ Switches the endianness of a 16-bit integer.\r
\r
This function swaps the bytes in a 16-bit unsigned value to switch the value\r
from little endian to big endian or vice versa. The byte swapped value is\r
\r
\r
/**\r
- Switches the endianess of a 32-bit integer.\r
+ Switches the endianness of a 32-bit integer.\r
\r
This function swaps the bytes in a 32-bit unsigned value to switch the value\r
from little endian to big endian or vice versa. The byte swapped value is\r
\r
\r
/**\r
- Switches the endianess of a 64-bit integer.\r
+ Switches the endianness of a 64-bit integer.\r
\r
This function swaps the bytes in a 64-bit unsigned value to switch the value\r
from little endian to big endian or vice versa. The byte swapped value is\r
@param Multiplicand A 64-bit unsigned value.\r
@param Multiplier A 64-bit unsigned value.\r
\r
- @return Multiplicand * Multiplier\r
+ @return Multiplicand * Multiplier.\r
\r
**/\r
UINT64\r
@param Dividend A 64-bit unsigned value.\r
@param Divisor A 32-bit unsigned value.\r
\r
- @return Dividend / Divisor\r
+ @return Dividend / Divisor.\r
\r
**/\r
UINT64\r
@param Dividend A 64-bit unsigned value.\r
@param Divisor A 32-bit unsigned value.\r
\r
- @return Dividend % Divisor\r
+ @return Dividend % Divisor.\r
\r
**/\r
UINT32\r
@param Remainder A pointer to a 32-bit unsigned value. This parameter is\r
optional and may be NULL.\r
\r
- @return Dividend / Divisor\r
+ @return Dividend / Divisor.\r
\r
**/\r
UINT64\r
@param Remainder A pointer to a 64-bit unsigned value. This parameter is\r
optional and may be NULL.\r
\r
- @return Dividend / Divisor\r
+ @return Dividend / Divisor.\r
\r
**/\r
UINT64\r
@param Remainder A pointer to a 64-bit signed value. This parameter is\r
optional and may be NULL.\r
\r
- @return Dividend / Divisor\r
+ @return Dividend / Divisor.\r
\r
**/\r
INT64\r
\r
If the Buffer is NULL, then ASSERT().\r
\r
- @param Buffer Pointer to a 16-bit value that may be unaligned.\r
+ @param Buffer The pointer to a 16-bit value that may be unaligned.\r
\r
@return The 16-bit value read from Buffer.\r
\r
\r
If the Buffer is NULL, then ASSERT().\r
\r
- @param Buffer Pointer to a 16-bit value that may be unaligned.\r
+ @param Buffer The pointer to a 16-bit value that may be unaligned.\r
@param Value 16-bit value to write to Buffer.\r
\r
@return The 16-bit value to write to Buffer.\r
\r
If the Buffer is NULL, then ASSERT().\r
\r
- @param Buffer Pointer to a 24-bit value that may be unaligned.\r
+ @param Buffer The pointer to a 24-bit value that may be unaligned.\r
\r
@return The 24-bit value read from Buffer.\r
\r
\r
If the Buffer is NULL, then ASSERT().\r
\r
- @param Buffer Pointer to a 24-bit value that may be unaligned.\r
+ @param Buffer The pointer to a 24-bit value that may be unaligned.\r
@param Value 24-bit value to write to Buffer.\r
\r
@return The 24-bit value to write to Buffer.\r
\r
If the Buffer is NULL, then ASSERT().\r
\r
- @param Buffer Pointer to a 32-bit value that may be unaligned.\r
+ @param Buffer The pointer to a 32-bit value that may be unaligned.\r
\r
@return The 32-bit value read from Buffer.\r
\r
\r
If the Buffer is NULL, then ASSERT().\r
\r
- @param Buffer Pointer to a 32-bit value that may be unaligned.\r
+ @param Buffer The pointer to a 32-bit value that may be unaligned.\r
@param Value 32-bit value to write to Buffer.\r
\r
@return The 32-bit value to write to Buffer.\r
\r
If the Buffer is NULL, then ASSERT().\r
\r
- @param Buffer Pointer to a 64-bit value that may be unaligned.\r
+ @param Buffer The pointer to a 64-bit value that may be unaligned.\r
\r
@return The 64-bit value read from Buffer.\r
\r
\r
If the Buffer is NULL, then ASSERT().\r
\r
- @param Buffer Pointer to a 64-bit value that may be unaligned.\r
+ @param Buffer The pointer to a 64-bit value that may be unaligned.\r
@param Value 64-bit value to write to Buffer.\r
\r
@return The 64-bit value to write to Buffer.\r
Range 0..31.\r
@param EndBit The ordinal of the most significant bit in the bit field.\r
Range 0..31.\r
- @param OrData The value to OR with the read value from the value\r
+ @param OrData The value to OR with the read value from the value.\r
\r
@return The new 32-bit value.\r
\r
If Buffer is NULL, then ASSERT().\r
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
- @param Buffer Pointer to the buffer to carry out the sum operation.\r
+ @param Buffer The pointer to the buffer to carry out the sum operation.\r
@param Length The size, in bytes, of Buffer.\r
\r
@return Sum The sum of Buffer with carry bits dropped during additions.\r
If Buffer is NULL, then ASSERT().\r
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
- @param Buffer Pointer to the buffer to carry out the checksum operation.\r
+ @param Buffer The pointer to the buffer to carry out the checksum operation.\r
@param Length The size, in bytes, of Buffer.\r
\r
- @return Checksum The 2's complement checksum of Buffer.\r
+ @return Checksum The two's complement checksum of Buffer.\r
\r
**/\r
UINT8\r
If Length is not aligned on a 16-bit boundary, then ASSERT().\r
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
- @param Buffer Pointer to the buffer to carry out the sum operation.\r
+ @param Buffer The pointer to the buffer to carry out the sum operation.\r
@param Length The size, in bytes, of Buffer.\r
\r
@return Sum The sum of Buffer with carry bits dropped during additions.\r
If Length is not aligned on a 16-bit boundary, then ASSERT().\r
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
- @param Buffer Pointer to the buffer to carry out the checksum operation.\r
+ @param Buffer The pointer to the buffer to carry out the checksum operation.\r
@param Length The size, in bytes, of Buffer.\r
\r
- @return Checksum The 2's complement checksum of Buffer.\r
+ @return Checksum The two's complement checksum of Buffer.\r
\r
**/\r
UINT16\r
If Length is not aligned on a 32-bit boundary, then ASSERT().\r
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
- @param Buffer Pointer to the buffer to carry out the sum operation.\r
+ @param Buffer The pointer to the buffer to carry out the sum operation.\r
@param Length The size, in bytes, of Buffer.\r
\r
@return Sum The sum of Buffer with carry bits dropped during additions.\r
If Length is not aligned on a 32-bit boundary, then ASSERT().\r
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
- @param Buffer Pointer to the buffer to carry out the checksum operation.\r
+ @param Buffer The pointer to the buffer to carry out the checksum operation.\r
@param Length The size, in bytes, of Buffer.\r
\r
- @return Checksum The 2's complement checksum of Buffer.\r
+ @return Checksum The two's complement checksum of Buffer.\r
\r
**/\r
UINT32\r
If Length is not aligned on a 64-bit boundary, then ASSERT().\r
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
- @param Buffer Pointer to the buffer to carry out the sum operation.\r
+ @param Buffer The pointer to the buffer to carry out the sum operation.\r
@param Length The size, in bytes, of Buffer.\r
\r
@return Sum The sum of Buffer with carry bits dropped during additions.\r
If Length is not aligned on a 64-bit boundary, then ASSERT().\r
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
- @param Buffer Pointer to the buffer to carry out the checksum operation.\r
+ @param Buffer The pointer to the buffer to carry out the checksum operation.\r
@param Length The size, in bytes, of Buffer.\r
\r
- @return Checksum The 2's complement checksum of Buffer.\r
+ @return Checksum The two's complement checksum of Buffer.\r
\r
**/\r
UINT64\r
/**\r
Retrieves the current CPU interrupt state.\r
\r
- Returns TRUE is interrupts are currently enabled. Otherwise\r
+ Returns TRUE if interrupts are currently enabled. Otherwise\r
returns FALSE.\r
\r
@retval TRUE CPU interrupts are enabled.\r
function.\r
@param NewStack A pointer to the new stack to use for the EntryPoint\r
function.\r
- @param ... This variable argument list is ignored for IA-32, x64, and EBC architectures. \r
- For Itanium processors, this variable argument list is expected to contain \r
- a single parameter of type VOID * that specifies the new backing \r
- store pointer.\r
+ @param ... This variable argument list is ignored for IA-32, x64, and \r
+ EBC architectures. For Itanium processors, this variable \r
+ argument list is expected to contain a single parameter of \r
+ type VOID * that specifies the new backing store pointer.\r
\r
\r
**/\r
\r
\r
/**\r
- Executes a FC instruction\r
- Executes a FC instruction on the cache line specified by Address.\r
+ Executes an FC instruction.\r
+ Executes an FC instruction on the cache line specified by Address.\r
The cache line size affected is at least 32-bytes (aligned on a 32-byte boundary).\r
An implementation may flush a larger region. This function is only available on Itanium processors.\r
\r
\r
\r
/**\r
- Executes a FC.I instruction.\r
- Executes a FC.I instruction on the cache line specified by Address.\r
+ Executes an FC.I instruction.\r
+ Executes an FC.I instruction on the cache line specified by Address.\r
The cache line size affected is at least 32-bytes (aligned on a 32-byte boundary).\r
An implementation may flush a larger region. This function is only available on Itanium processors.\r
\r
@param Address The Address of cache line to be flushed.\r
\r
- @return The address of FC.I instruction executed.\r
+ @return The address of the FC.I instruction executed.\r
\r
**/\r
UINT64\r
\r
The Instruction Breakpoint Registers are used in pairs. The even numbered\r
registers contain breakpoint addresses, and the odd numbered registers contain\r
- breakpoint mask conditions. At least 4 instruction registers pairs are implemented\r
+ breakpoint mask conditions. At least four instruction registers pairs are implemented\r
on all processor models. Implemented registers are contiguous starting with\r
register 0. No parameter checking is performed on Index, and if the Index value\r
is beyond the implemented IBR register range, a Reserved Register/Field fault may\r
\r
The Data Breakpoint Registers are used in pairs. The even numbered registers\r
contain breakpoint addresses, and odd numbered registers contain breakpoint\r
- mask conditions. At least 4 data registers pairs are implemented on all processor\r
+ mask conditions. At least four data registers pairs are implemented on all processor\r
models. Implemented registers are contiguous starting with register 0.\r
No parameter checking is performed on Index. If the Index value is beyond\r
the implemented DBR register range, a Reserved Register/Field fault may occur.\r
/**\r
Reads the current value of Performance Monitor Configuration Register (PMC).\r
\r
- All processor implementations provide at least 4 performance counters\r
- (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow\r
+ All processor implementations provide at least four performance counters\r
+ (PMC/PMD [4]...PMC/PMD [7] pairs), and four performance monitor counter overflow\r
status registers (PMC [0]... PMC [3]). Processor implementations may provide\r
additional implementation-dependent PMC and PMD to increase the number of\r
'generic' performance counters (PMC/PMD pairs). The remainder of PMC and PMD\r
Writes current value of Instruction Breakpoint Register specified by Index.\r
The Instruction Breakpoint Registers are used in pairs. The even numbered\r
registers contain breakpoint addresses, and odd numbered registers contain\r
- breakpoint mask conditions. At least 4 instruction registers pairs are implemented\r
+ breakpoint mask conditions. At least four instruction registers pairs are implemented\r
on all processor models. Implemented registers are contiguous starting with\r
register 0. No parameter checking is performed on Index. If the Index value\r
is beyond the implemented IBR register range, a Reserved Register/Field fault may\r
Writes current value of Data Breakpoint Register specified by Index.\r
The Data Breakpoint Registers are used in pairs. The even numbered registers\r
contain breakpoint addresses, and odd numbered registers contain breakpoint\r
- mask conditions. At least 4 data registers pairs are implemented on all processor\r
+ mask conditions. At least four data registers pairs are implemented on all processor\r
models. Implemented registers are contiguous starting with register 0. No parameter\r
checking is performed on Index. If the Index value is beyond the implemented\r
DBR register range, a Reserved Register/Field fault may occur. The caller must\r
Writes the current value of 64-bit Performance Monitor Configuration Register (PMC).\r
\r
Writes current value of Performance Monitor Configuration Register specified by Index.\r
- All processor implementations provide at least 4 performance counters\r
- (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow status\r
+ All processor implementations provide at least four performance counters\r
+ (PMC/PMD [4]...PMC/PMD [7] pairs), and four performance monitor counter overflow status\r
registers (PMC [0]... PMC [3]). Processor implementations may provide additional\r
implementation-dependent PMC and PMD to increase the number of 'generic' performance\r
counters (PMC/PMD pairs). The remainder of PMC and PMD register set is implementation\r
Writes the current value of 64-bit Performance Monitor Data Register (PMD).\r
\r
Writes current value of Performance Monitor Data Register specified by Index.\r
- All processor implementations provide at least 4 performance counters\r
- (PMC/PMD [4]...PMC/PMD [7] pairs), and 4 performance monitor counter overflow\r
+ All processor implementations provide at least four performance counters\r
+ (PMC/PMD [4]...PMC/PMD [7] pairs), and four performance monitor counter overflow\r
status registers (PMC [0]... PMC [3]). Processor implementations may provide\r
additional implementation-dependent PMC and PMD to increase the number of 'generic'\r
performance counters (PMC/PMD pairs). The remainder of PMC and PMD register set\r
\r
\r
///\r
-/// Valid Index value for AsmReadControlRegister()\r
+/// Valid Index value for AsmReadControlRegister().\r
///\r
#define IPF_CONTROL_REGISTER_DCR 0\r
#define IPF_CONTROL_REGISTER_ITM 1\r
/**\r
Reads a 64-bit control register.\r
\r
- Reads and returns the control register specified by Index. The valid Index valued are defined\r
- above in "Related Definitions".\r
- If Index is invalid then 0xFFFFFFFFFFFFFFFF is returned. This function is only available on Itanium processors.\r
+ Reads and returns the control register specified by Index. The valid Index valued \r
+ are defined above in "Related Definitions".\r
+ If Index is invalid then 0xFFFFFFFFFFFFFFFF is returned. This function is only \r
+ available on Itanium processors.\r
\r
@param Index The index of the control register to read.\r
\r
\r
\r
///\r
-/// Valid Index value for AsmReadApplicationRegister()\r
+/// Valid Index value for AsmReadApplicationRegister().\r
///\r
#define IPF_APPLICATION_REGISTER_K0 0\r
#define IPF_APPLICATION_REGISTER_K1 1\r
/**\r
Reads a 64-bit application register.\r
\r
- Reads and returns the application register specified by Index. The valid Index valued are defined\r
- above in "Related Definitions".\r
- If Index is invalid then 0xFFFFFFFFFFFFFFFF is returned. This function is only available on Itanium processors.\r
+ Reads and returns the application register specified by Index. The valid Index \r
+ valued are defined above in "Related Definitions".\r
+ If Index is invalid then 0xFFFFFFFFFFFFFFFF is returned. This function is only \r
+ available on Itanium processors.\r
\r
@param Index The index of the application register to read.\r
\r
\r
#if defined (MDE_CPU_IA32) || defined (MDE_CPU_X64)\r
///\r
-/// IA32 and x64 Specific Functions\r
-/// Byte packed structure for 16-bit Real Mode EFLAGS\r
+/// IA32 and x64 Specific Functions.\r
+/// Byte packed structure for 16-bit Real Mode EFLAGS.\r
///\r
typedef union {\r
struct {\r
- UINT32 CF:1; ///< Carry Flag\r
- UINT32 Reserved_0:1; ///< Reserved\r
- UINT32 PF:1; ///< Parity Flag\r
- UINT32 Reserved_1:1; ///< Reserved\r
- UINT32 AF:1; ///< Auxiliary Carry Flag\r
- UINT32 Reserved_2:1; ///< Reserved\r
- UINT32 ZF:1; ///< Zero Flag\r
- UINT32 SF:1; ///< Sign Flag\r
- UINT32 TF:1; ///< Trap Flag\r
- UINT32 IF:1; ///< Interrupt Enable Flag\r
- UINT32 DF:1; ///< Direction Flag\r
- UINT32 OF:1; ///< Overflow Flag\r
- UINT32 IOPL:2; ///< I/O Privilege Level\r
- UINT32 NT:1; ///< Nested Task\r
- UINT32 Reserved_3:1; ///< Reserved\r
+ UINT32 CF:1; ///< Carry Flag.\r
+ UINT32 Reserved_0:1; ///< Reserved.\r
+ UINT32 PF:1; ///< Parity Flag.\r
+ UINT32 Reserved_1:1; ///< Reserved.\r
+ UINT32 AF:1; ///< Auxiliary Carry Flag.\r
+ UINT32 Reserved_2:1; ///< Reserved.\r
+ UINT32 ZF:1; ///< Zero Flag.\r
+ UINT32 SF:1; ///< Sign Flag.\r
+ UINT32 TF:1; ///< Trap Flag.\r
+ UINT32 IF:1; ///< Interrupt Enable Flag.\r
+ UINT32 DF:1; ///< Direction Flag.\r
+ UINT32 OF:1; ///< Overflow Flag.\r
+ UINT32 IOPL:2; ///< I/O Privilege Level.\r
+ UINT32 NT:1; ///< Nested Task.\r
+ UINT32 Reserved_3:1; ///< Reserved.\r
} Bits;\r
UINT16 Uint16;\r
} IA32_FLAGS16;\r
\r
///\r
-/// Byte packed structure for EFLAGS/RFLAGS\r
-/// 32-bits on IA-32\r
-/// 64-bits on x64. The upper 32-bits on x64 are reserved\r
+/// Byte packed structure for EFLAGS/RFLAGS.\r
+/// 32-bits on IA-32.\r
+/// 64-bits on x64. The upper 32-bits on x64 are reserved.\r
///\r
typedef union {\r
struct {\r
- UINT32 CF:1; ///< Carry Flag\r
- UINT32 Reserved_0:1; ///< Reserved\r
- UINT32 PF:1; ///< Parity Flag\r
- UINT32 Reserved_1:1; ///< Reserved\r
- UINT32 AF:1; ///< Auxiliary Carry Flag\r
- UINT32 Reserved_2:1; ///< Reserved\r
- UINT32 ZF:1; ///< Zero Flag\r
- UINT32 SF:1; ///< Sign Flag\r
- UINT32 TF:1; ///< Trap Flag\r
- UINT32 IF:1; ///< Interrupt Enable Flag\r
- UINT32 DF:1; ///< Direction Flag\r
- UINT32 OF:1; ///< Overflow Flag\r
- UINT32 IOPL:2; ///< I/O Privilege Level\r
- UINT32 NT:1; ///< Nested Task\r
- UINT32 Reserved_3:1; ///< Reserved\r
- UINT32 RF:1; ///< Resume Flag\r
- UINT32 VM:1; ///< Virtual 8086 Mode\r
- UINT32 AC:1; ///< Alignment Check\r
- UINT32 VIF:1; ///< Virtual Interrupt Flag\r
- UINT32 VIP:1; ///< Virtual Interrupt Pending\r
- UINT32 ID:1; ///< ID Flag\r
- UINT32 Reserved_4:10; ///< Reserved\r
+ UINT32 CF:1; ///< Carry Flag.\r
+ UINT32 Reserved_0:1; ///< Reserved.\r
+ UINT32 PF:1; ///< Parity Flag.\r
+ UINT32 Reserved_1:1; ///< Reserved.\r
+ UINT32 AF:1; ///< Auxiliary Carry Flag.\r
+ UINT32 Reserved_2:1; ///< Reserved.\r
+ UINT32 ZF:1; ///< Zero Flag.\r
+ UINT32 SF:1; ///< Sign Flag.\r
+ UINT32 TF:1; ///< Trap Flag.\r
+ UINT32 IF:1; ///< Interrupt Enable Flag.\r
+ UINT32 DF:1; ///< Direction Flag.\r
+ UINT32 OF:1; ///< Overflow Flag.\r
+ UINT32 IOPL:2; ///< I/O Privilege Level.\r
+ UINT32 NT:1; ///< Nested Task.\r
+ UINT32 Reserved_3:1; ///< Reserved.\r
+ UINT32 RF:1; ///< Resume Flag.\r
+ UINT32 VM:1; ///< Virtual 8086 Mode.\r
+ UINT32 AC:1; ///< Alignment Check.\r
+ UINT32 VIF:1; ///< Virtual Interrupt Flag.\r
+ UINT32 VIP:1; ///< Virtual Interrupt Pending.\r
+ UINT32 ID:1; ///< ID Flag.\r
+ UINT32 Reserved_4:10; ///< Reserved.\r
} Bits;\r
UINTN UintN;\r
} IA32_EFLAGS32;\r
\r
///\r
-/// Byte packed structure for Control Register 0 (CR0)\r
-/// 32-bits on IA-32\r
-/// 64-bits on x64. The upper 32-bits on x64 are reserved\r
+/// Byte packed structure for Control Register 0 (CR0).\r
+/// 32-bits on IA-32.\r
+/// 64-bits on x64. The upper 32-bits on x64 are reserved.\r
///\r
typedef union {\r
struct {\r
- UINT32 PE:1; ///< Protection Enable\r
- UINT32 MP:1; ///< Monitor Coprocessor\r
- UINT32 EM:1; ///< Emulation\r
- UINT32 TS:1; ///< Task Switched\r
- UINT32 ET:1; ///< Extension Type\r
- UINT32 NE:1; ///< Numeric Error\r
- UINT32 Reserved_0:10; ///< Reserved\r
- UINT32 WP:1; ///< Write Protect\r
- UINT32 Reserved_1:1; ///< Reserved\r
- UINT32 AM:1; ///< Alignment Mask\r
- UINT32 Reserved_2:10; ///< Reserved\r
- UINT32 NW:1; ///< Mot Write-through\r
- UINT32 CD:1; ///< Cache Disable\r
- UINT32 PG:1; ///< Paging\r
+ UINT32 PE:1; ///< Protection Enable.\r
+ UINT32 MP:1; ///< Monitor Coprocessor.\r
+ UINT32 EM:1; ///< Emulation.\r
+ UINT32 TS:1; ///< Task Switched.\r
+ UINT32 ET:1; ///< Extension Type.\r
+ UINT32 NE:1; ///< Numeric Error.\r
+ UINT32 Reserved_0:10; ///< Reserved.\r
+ UINT32 WP:1; ///< Write Protect.\r
+ UINT32 Reserved_1:1; ///< Reserved.\r
+ UINT32 AM:1; ///< Alignment Mask.\r
+ UINT32 Reserved_2:10; ///< Reserved.\r
+ UINT32 NW:1; ///< Mot Write-through.\r
+ UINT32 CD:1; ///< Cache Disable.\r
+ UINT32 PG:1; ///< Paging.\r
} Bits;\r
UINTN UintN;\r
} IA32_CR0;\r
\r
///\r
-/// Byte packed structure for Control Register 4 (CR4)\r
-/// 32-bits on IA-32\r
-/// 64-bits on x64. The upper 32-bits on x64 are reserved\r
+/// Byte packed structure for Control Register 4 (CR4).\r
+/// 32-bits on IA-32.\r
+/// 64-bits on x64. The upper 32-bits on x64 are reserved.\r
///\r
typedef union {\r
struct {\r
- UINT32 VME:1; ///< Virtual-8086 Mode Extensions\r
- UINT32 PVI:1; ///< Protected-Mode Virtual Interrupts\r
- UINT32 TSD:1; ///< Time Stamp Disable\r
- UINT32 DE:1; ///< Debugging Extensions\r
- UINT32 PSE:1; ///< Page Size Extensions\r
- UINT32 PAE:1; ///< Physical Address Extension\r
- UINT32 MCE:1; ///< Machine Check Enable\r
- UINT32 PGE:1; ///< Page Global Enable\r
+ UINT32 VME:1; ///< Virtual-8086 Mode Extensions.\r
+ UINT32 PVI:1; ///< Protected-Mode Virtual Interrupts.\r
+ UINT32 TSD:1; ///< Time Stamp Disable.\r
+ UINT32 DE:1; ///< Debugging Extensions.\r
+ UINT32 PSE:1; ///< Page Size Extensions.\r
+ UINT32 PAE:1; ///< Physical Address Extension.\r
+ UINT32 MCE:1; ///< Machine Check Enable.\r
+ UINT32 PGE:1; ///< Page Global Enable.\r
UINT32 PCE:1; ///< Performance Monitoring Counter\r
- ///< Enable\r
+ ///< Enable.\r
UINT32 OSFXSR:1; ///< Operating System Support for\r
///< FXSAVE and FXRSTOR instructions\r
UINT32 OSXMMEXCPT:1; ///< Operating System Support for\r
///< Unmasked SIMD Floating Point\r
- ///< Exceptions\r
- UINT32 Reserved_0:2; ///< Reserved\r
+ ///< Exceptions.\r
+ UINT32 Reserved_0:2; ///< Reserved.\r
UINT32 VMXE:1; ///< VMX Enable\r
- UINT32 Reserved_1:18; ///< Reserved\r
+ UINT32 Reserved_1:18; ///< Reserved.\r
} Bits;\r
UINTN UintN;\r
} IA32_CR4;\r
\r
///\r
-/// Byte packed structure for an IDTR, GDTR, LDTR descriptor\r
+/// Byte packed structure for an IDTR, GDTR, LDTR descriptor.\r
///\r
#pragma pack (1)\r
typedef struct {\r
\r
#if defined (MDE_CPU_IA32)\r
///\r
-/// Byte packed structure for an IA-32 Interrupt Gate Descriptor\r
+/// Byte packed structure for an IA-32 Interrupt Gate Descriptor.\r
///\r
typedef union {\r
struct {\r
- UINT32 OffsetLow:16; ///< Offset bits 15..0\r
- UINT32 Selector:16; ///< Selector\r
- UINT32 Reserved_0:8; ///< Reserved\r
- UINT32 GateType:8; ///< Gate Type. See #defines above\r
- UINT32 OffsetHigh:16; ///< Offset bits 31..16\r
+ UINT32 OffsetLow:16; ///< Offset bits 15..0.\r
+ UINT32 Selector:16; ///< Selector.\r
+ UINT32 Reserved_0:8; ///< Reserved.\r
+ UINT32 GateType:8; ///< Gate Type. See #defines above.\r
+ UINT32 OffsetHigh:16; ///< Offset bits 31..16.\r
} Bits;\r
UINT64 Uint64;\r
} IA32_IDT_GATE_DESCRIPTOR;\r
\r
#if defined (MDE_CPU_X64)\r
///\r
-/// Byte packed structure for an x64 Interrupt Gate Descriptor\r
+/// Byte packed structure for an x64 Interrupt Gate Descriptor.\r
///\r
typedef union {\r
struct {\r
- UINT32 OffsetLow:16; ///< Offset bits 15..0\r
- UINT32 Selector:16; ///< Selector\r
- UINT32 Reserved_0:8; ///< Reserved\r
- UINT32 GateType:8; ///< Gate Type. See #defines above\r
- UINT32 OffsetHigh:16; ///< Offset bits 31..16\r
- UINT32 OffsetUpper:32; ///< Offset bits 63..32\r
- UINT32 Reserved_1:32; ///< Reserved\r
+ UINT32 OffsetLow:16; ///< Offset bits 15..0.\r
+ UINT32 Selector:16; ///< Selector.\r
+ UINT32 Reserved_0:8; ///< Reserved.\r
+ UINT32 GateType:8; ///< Gate Type. See #defines above.\r
+ UINT32 OffsetHigh:16; ///< Offset bits 31..16.\r
+ UINT32 OffsetUpper:32; ///< Offset bits 63..32.\r
+ UINT32 Reserved_1:32; ///< Reserved.\r
} Bits;\r
struct {\r
UINT64 Uint64;\r
#endif\r
\r
///\r
-/// Byte packed structure for an FP/SSE/SSE2 context\r
+/// Byte packed structure for an FP/SSE/SSE2 context.\r
///\r
typedef struct {\r
UINT8 Buffer[512];\r
} IA32_FX_BUFFER;\r
\r
///\r
-/// Structures for the 16-bit real mode thunks\r
+/// Structures for the 16-bit real mode thunks.\r
///\r
typedef struct {\r
UINT32 Reserved1;\r
} IA32_REGISTER_SET;\r
\r
///\r
-/// Byte packed structure for an 16-bit real mode thunks\r
+/// Byte packed structure for an 16-bit real mode thunks.\r
///\r
typedef struct {\r
IA32_REGISTER_SET *RealModeState;\r
\r
@param Index The 32-bit value to load into EAX prior to invoking the CPUID\r
instruction.\r
- @param Eax Pointer to the 32-bit EAX value returned by the CPUID\r
+ @param Eax The pointer to the 32-bit EAX value returned by the CPUID\r
instruction. This is an optional parameter that may be NULL.\r
- @param Ebx Pointer to the 32-bit EBX value returned by the CPUID\r
+ @param Ebx The pointer to the 32-bit EBX value returned by the CPUID\r
instruction. This is an optional parameter that may be NULL.\r
- @param Ecx Pointer to the 32-bit ECX value returned by the CPUID\r
+ @param Ecx The pointer to the 32-bit ECX value returned by the CPUID\r
instruction. This is an optional parameter that may be NULL.\r
- @param Edx Pointer to the 32-bit EDX value returned by the CPUID\r
+ @param Edx The pointer to the 32-bit EDX value returned by the CPUID\r
instruction. This is an optional parameter that may be NULL.\r
\r
@return Index.\r
CPUID instruction.\r
@param SubIndex The 32-bit value to load into ECX prior to invoking the\r
CPUID instruction.\r
- @param Eax Pointer to the 32-bit EAX value returned by the CPUID\r
+ @param Eax The pointer to the 32-bit EAX value returned by the CPUID\r
instruction. This is an optional parameter that may be\r
NULL.\r
- @param Ebx Pointer to the 32-bit EBX value returned by the CPUID\r
+ @param Ebx The pointer to the 32-bit EBX value returned by the CPUID\r
instruction. This is an optional parameter that may be\r
NULL.\r
- @param Ecx Pointer to the 32-bit ECX value returned by the CPUID\r
+ @param Ecx The pointer to the 32-bit ECX value returned by the CPUID\r
instruction. This is an optional parameter that may be\r
NULL.\r
- @param Edx Pointer to the 32-bit EDX value returned by the CPUID\r
+ @param Edx The pointer to the 32-bit EDX value returned by the CPUID\r
instruction. This is an optional parameter that may be\r
NULL.\r
\r
\r
If Gdtr is NULL, then ASSERT().\r
\r
- @param Gdtr Pointer to a GDTR descriptor.\r
+ @param Gdtr The pointer to a GDTR descriptor.\r
\r
**/\r
VOID\r
\r
If Gdtr is NULL, then ASSERT().\r
\r
- @param Gdtr Pointer to a GDTR descriptor.\r
+ @param Gdtr The pointer to a GDTR descriptor.\r
\r
**/\r
VOID\r
\r
If Idtr is NULL, then ASSERT().\r
\r
- @param Idtr Pointer to a IDTR descriptor.\r
+ @param Idtr The pointer to a IDTR descriptor.\r
\r
**/\r
VOID\r
\r
If Idtr is NULL, then ASSERT().\r
\r
- @param Idtr Pointer to a IDTR descriptor.\r
+ @param Idtr The pointer to a IDTR descriptor.\r
\r
**/\r
VOID\r
If Buffer is NULL, then ASSERT().\r
If Buffer is not aligned on a 16-byte boundary, then ASSERT().\r
\r
- @param Buffer Pointer to a buffer to save the floating point/SSE/SSE2 context.\r
+ @param Buffer The pointer to a buffer to save the floating point/SSE/SSE2 context.\r
\r
**/\r
VOID\r
If Buffer is not aligned on a 16-byte boundary, then ASSERT().\r
If Buffer was not saved with AsmFxSave(), then ASSERT().\r
\r
- @param Buffer Pointer to a buffer to save the floating point/SSE/SSE2 context.\r
+ @param Buffer The pointer to a buffer to save the floating point/SSE/SSE2 context.\r
\r
**/\r
VOID\r
addressing mode, then LinearAddress is a virtual\r
address.\r
\r
- @return LinearAddress\r
+ @return LinearAddress.\r
**/\r
VOID *\r
EFIAPI\r
ThunkAttributes, then ASSERT().\r
\r
This interface is limited to be used in either physical mode or virtual modes with paging enabled where the\r
- virtual to physical mappings for ThunkContext.RealModeBuffer is mapped 1:1.\r
+ virtual to physical mappings for ThunkContext.RealModeBuffer are mapped 1:1.\r
\r
@param ThunkContext A pointer to the context structure that describes the\r
16-bit real mode code to call.\r
These functions should be used in place of coding your own loops to do equivalent common functions. \r
This allows optimized library implementations to help increase performance. \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
-http://opensource.org/licenses/bsd-license.php\r
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
If Length is greater than (MAX_ADDRESS - DestinationBuffer + 1), then ASSERT().\r
If Length is greater than (MAX_ADDRESS - SourceBuffer + 1), then ASSERT().\r
\r
- @param DestinationBuffer Pointer to the destination buffer of the memory copy.\r
- @param SourceBuffer Pointer to the source buffer of the memory copy.\r
- @param Length Number of bytes to copy from SourceBuffer to DestinationBuffer.\r
+ @param DestinationBuffer The pointer to the destination buffer of the memory copy.\r
+ @param SourceBuffer The pointer to the source buffer of the memory copy.\r
+ @param Length The number of bytes to copy from SourceBuffer to DestinationBuffer.\r
\r
@return DestinationBuffer.\r
\r
\r
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
- @param Buffer Memory to set.\r
- @param Length Number of bytes to set.\r
- @param Value Value with which to fill Length bytes of Buffer.\r
+ @param Buffer The memory to set.\r
+ @param Length The number of bytes to set.\r
+ @param Value The value with which to fill Length bytes of Buffer.\r
\r
@return Buffer.\r
\r
If Buffer is not aligned on a 16-bit boundary, then ASSERT().\r
If Length is not aligned on a 16-bit boundary, then ASSERT().\r
\r
- @param Buffer Pointer to the target buffer to fill.\r
- @param Length Number of bytes in Buffer to fill.\r
- @param Value Value with which to fill Length bytes of Buffer.\r
+ @param Buffer The pointer to the target buffer to fill.\r
+ @param Length The number of bytes in Buffer to fill.\r
+ @param Value The value with which to fill Length bytes of Buffer.\r
\r
@return Buffer.\r
\r
If Buffer is not aligned on a 32-bit boundary, then ASSERT().\r
If Length is not aligned on a 32-bit boundary, then ASSERT().\r
\r
- @param Buffer Pointer to the target buffer to fill.\r
- @param Length Number of bytes in Buffer to fill.\r
- @param Value Value with which to fill Length bytes of Buffer.\r
+ @param Buffer The pointer to the target buffer to fill.\r
+ @param Length The number of bytes in Buffer to fill.\r
+ @param Value The value with which to fill Length bytes of Buffer.\r
\r
@return Buffer.\r
\r
If Buffer is not aligned on a 64-bit boundary, then ASSERT().\r
If Length is not aligned on a 64-bit boundary, then ASSERT().\r
\r
- @param Buffer Pointer to the target buffer to fill.\r
- @param Length Number of bytes in Buffer to fill.\r
- @param Value Value with which to fill Length bytes of Buffer.\r
+ @param Buffer The pointer to the target buffer to fill.\r
+ @param Length The number of bytes in Buffer to fill.\r
+ @param Value The value with which to fill Length bytes of Buffer.\r
\r
@return Buffer.\r
\r
If Buffer is not aligned on a UINTN boundary, then ASSERT().\r
If Length is not aligned on a UINTN boundary, then ASSERT().\r
\r
- @param Buffer Pointer to the target buffer to fill.\r
- @param Length Number of bytes in Buffer to fill.\r
- @param Value Value with which to fill Length bytes of Buffer.\r
+ @param Buffer The pointer to the target buffer to fill.\r
+ @param Length The number of bytes in Buffer to fill.\r
+ @param Value The value with which to fill Length bytes of Buffer.\r
\r
@return Buffer.\r
\r
If Length > 0 and Buffer is NULL, then ASSERT().\r
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
- @param Buffer Pointer to the target buffer to fill with zeros.\r
- @param Length Number of bytes in Buffer to fill with zeros.\r
+ @param Buffer The pointer to the target buffer to fill with zeros.\r
+ @param Length The number of bytes in Buffer to fill with zeros.\r
\r
@return Buffer.\r
\r
If Length is greater than (MAX_ADDRESS - DestinationBuffer + 1), then ASSERT().\r
If Length is greater than (MAX_ADDRESS - SourceBuffer + 1), then ASSERT().\r
\r
- @param DestinationBuffer Pointer to the destination buffer to compare.\r
- @param SourceBuffer Pointer to the source buffer to compare.\r
- @param Length Number of bytes to compare.\r
+ @param DestinationBuffer The pointer to the destination buffer to compare.\r
+ @param SourceBuffer The pointer to the source buffer to compare.\r
+ @param Length The number of bytes to compare.\r
\r
@return 0 All Length bytes of the two buffers are identical.\r
@retval Non-zero The first mismatched byte in SourceBuffer subtracted from the first\r
If Length > 0 and Buffer is NULL, then ASSERT().\r
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
- @param Buffer Pointer to the target buffer to scan.\r
- @param Length Number of bytes in Buffer to scan.\r
- @param Value Value to search for in the target buffer.\r
+ @param Buffer The pointer to the target buffer to scan.\r
+ @param Length The number of bytes in Buffer to scan.\r
+ @param Value The value to search for in the target buffer.\r
\r
- @return A pointer to the matching byte in the target buffer or NULL otherwise.\r
+ @return A pointer to the matching byte in the target buffer, otherwise NULL.\r
\r
**/\r
VOID *\r
If Length is not aligned on a 16-bit boundary, then ASSERT().\r
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
- @param Buffer Pointer to the target buffer to scan.\r
- @param Length Number of bytes in Buffer to scan.\r
- @param Value Value to search for in the target buffer.\r
+ @param Buffer The pointer to the target buffer to scan.\r
+ @param Length The number of bytes in Buffer to scan.\r
+ @param Value The value to search for in the target buffer.\r
\r
- @return A pointer to the matching byte in the target buffer or NULL otherwise.\r
+ @return A pointer to the matching byte in the target buffer, otherwise NULL.\r
\r
**/\r
VOID *\r
If Length is not aligned on a 32-bit boundary, then ASSERT().\r
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
- @param Buffer Pointer to the target buffer to scan.\r
- @param Length Number of bytes in Buffer to scan.\r
- @param Value Value to search for in the target buffer.\r
+ @param Buffer The pointer to the target buffer to scan.\r
+ @param Length The number of bytes in Buffer to scan.\r
+ @param Value The value to search for in the target buffer.\r
\r
- @return A pointer to the matching byte in the target buffer or NULL otherwise.\r
+ @return A pointer to the matching byte in the target buffer, otherwise NULL.\r
\r
**/\r
VOID *\r
If Length is not aligned on a 64-bit boundary, then ASSERT().\r
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
- @param Buffer Pointer to the target buffer to scan.\r
- @param Length Number of bytes in Buffer to scan.\r
- @param Value Value to search for in the target buffer.\r
+ @param Buffer The pointer to the target buffer to scan.\r
+ @param Length The number of bytes in Buffer to scan.\r
+ @param Value The value to search for in the target buffer.\r
\r
- @return A pointer to the matching byte in the target buffer or NULL otherwise.\r
+ @return A pointer to the matching byte in the target buffer, otherwise NULL.\r
\r
**/\r
VOID *\r
If Length is not aligned on a UINTN boundary, then ASSERT().\r
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
- @param Buffer Pointer to the target buffer to scan.\r
- @param Length Number of bytes in Buffer to scan.\r
- @param Value Value to search for in the target buffer.\r
+ @param Buffer The pointer to the target buffer to scan.\r
+ @param Length The number of bytes in Buffer to scan.\r
+ @param Value The value to search for in the target buffer.\r
\r
- @return A pointer to the matching byte in the target buffer or NULL otherwise.\r
+ @return A pointer to the matching byte in the target buffer, otherwise NULL.\r
\r
**/\r
VOID *\r
If DestinationGuid is NULL, then ASSERT().\r
If SourceGuid is NULL, then ASSERT().\r
\r
- @param DestinationGuid Pointer to the destination GUID.\r
- @param SourceGuid Pointer to the source GUID.\r
+ @param DestinationGuid The pointer to the destination GUID.\r
+ @param SourceGuid The pointer to the source GUID.\r
\r
@return DestinationGuid.\r
\r
If Length is not aligned on a 128-bit boundary, then ASSERT().\r
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
- @param Buffer Pointer to the target buffer to scan.\r
- @param Length Number of bytes in Buffer to scan.\r
- @param Guid Value to search for in the target buffer.\r
+ @param Buffer The pointer to the target buffer to scan.\r
+ @param Length The number of bytes in Buffer to scan.\r
+ @param Guid The value to search for in the target buffer.\r
\r
- @return A pointer to the matching Guid in the target buffer or NULL otherwise.\r
+ @return A pointer to the matching Guid in the target buffer, otherwise NULL.\r
\r
**/\r
VOID *\r
of size reduction when compiler optimization is disabled. If MDEPKG_NDEBUG is\r
defined, then debug and assert related macros wrapped by it are the NULL implementations.\r
\r
-Copyright (c) 2006 - 2010, 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
-http://opensource.org/licenses/bsd-license.php\r
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
If Format is NULL, then ASSERT().\r
\r
@param ErrorLevel The error level of the debug message.\r
- @param Format Format string for the debug message to print.\r
- @param ... Variable argument list whose contents are accessed \r
+ @param Format The format string for the debug message to print.\r
+ @param ... The variable argument list whose contents are accessed \r
based on the format string specified by Format.\r
\r
**/\r
If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.\r
If Description is NULL, then a <Description> string of "(NULL) Description" is printed.\r
\r
- @param FileName Pointer to the name of the source file that generated the assert condition.\r
+ @param FileName The pointer to the name of the source file that generated the assert condition.\r
@param LineNumber The line number in the source file that generated the assert condition\r
- @param Description Pointer to the description of the assert condition.\r
+ @param Description The pointer to the description of the assert condition.\r
\r
**/\r
VOID\r
If Buffer is NULL, then ASSERT().\r
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
\r
- @param Buffer Pointer to the target buffer to be filled with PcdDebugClearMemoryValue.\r
- @param Length Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. \r
+ @param Buffer The pointer to the target buffer to be filled with PcdDebugClearMemoryValue.\r
+ @param Length The number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. \r
\r
- @return Buffer Pointer to the target buffer filled with PcdDebugClearMemoryValue.\r
+ @return Buffer The pointer to the target buffer filled with PcdDebugClearMemoryValue.\r
\r
**/\r
VOID *\r
Returns TRUE if ASSERT() macros are enabled.\r
\r
This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of \r
- PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
+ PcdDebugProperyMask is set. Otherwise, FALSE is returned.\r
\r
@retval TRUE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.\r
@retval FALSE The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.\r
Returns TRUE if DEBUG() macros are enabled.\r
\r
This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of \r
- PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
+ PcdDebugProperyMask is set. Otherwise, FALSE is returned.\r
\r
@retval TRUE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.\r
@retval FALSE The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.\r
Returns TRUE if DEBUG_CODE() macros are enabled.\r
\r
This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of \r
- PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
+ PcdDebugProperyMask is set. Otherwise, FALSE is returned.\r
\r
@retval TRUE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.\r
@retval FALSE The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.\r
Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.\r
\r
This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of \r
- PcdDebugProperyMask is set. Otherwise FALSE is returned.\r
+ PcdDebugProperyMask is set. Otherwise, FALSE is returned.\r
\r
@retval TRUE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
@retval FALSE The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\r
DebugAssert() is called passing in the source filename, source line number, \r
and Expression.\r
\r
- @param Expression Boolean expression\r
+ @param Expression Boolean expression.\r
\r
**/\r
#if !defined(MDEPKG_NDEBUG) \r
parameter that may be NULL. If it is NULL, then the entire \r
handle database is searched.\r
\r
- @param Guid Pointer to a protocol GUID.\r
+ @param Guid The pointer to a protocol GUID.\r
\r
**/\r
#if !defined(MDEPKG_NDEBUG)\r
\r
\r
/** \r
- Macro that marks the end of debug source code.\r
+ The macro that marks the end of debug source code.\r
\r
If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set, \r
then this macro marks the end of source code that is included in a module. \r
\r
\r
/** \r
- Macro that declares a section of debug source code.\r
+ The macro that declares a section of debug source code.\r
\r
If the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set, \r
then the source code specified by Expression is included in a module. \r
\r
\r
/** \r
- Macro that calls DebugClearMemory() to clear a buffer to a default value.\r
+ The macro that calls DebugClearMemory() to clear a buffer to a default value.\r
\r
If the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set, \r
then this macro calls DebugClearMemory() passing in Address and Length.\r
\r
- @param Address Pointer to a buffer.\r
+ @param Address The pointer to a buffer.\r
@param Length The number of bytes in the buffer to set.\r
\r
**/\r
Macro that calls DebugAssert() if the containing record does not have a \r
matching signature. If the signatures matches, then a pointer to the data \r
structure that contains a specified field of that data structure is returned. \r
- This is a light weight method hide information by placing a public data \r
+ This is a lightweight method hide information by placing a public data \r
structure inside a larger private data structure and using a pointer to the \r
public data structure to retrieve a pointer to the private data structure.\r
\r
If MDEPKG_NDEBUG is defined or the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit \r
of PcdDebugProperyMask is clear, then this macro computes the offset, in bytes,\r
- of field specified by Field from the beginning of the data structure specified \r
+ of the field specified by Field from the beginning of the data structure specified \r
by TYPE. This offset is subtracted from Record, and is used to return a pointer \r
to a data structure of the type specified by TYPE.\r
\r
If TYPE does not contain a field called Signature, then the module will not \r
compile.\r
\r
- @param Record Pointer to the field specified by Field within a data \r
+ @param Record The pointer to the field specified by Field within a data \r
structure of type TYPE.\r
\r
@param TYPE The name of the data structure type to return This \r
This library provides defines, macros, and functions to help create and parse \r
EFI_DEVICE_PATH_PROTOCOL structures.\r
\r
-Copyright (c) 2006 - 2009, 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
-http://opensource.org/licenses/bsd-license.php\r
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
Determines if a device path node is an end node of a device path.\r
- This includes nodes that are the end of a device path instance and nodes that are the end of an entire device path.\r
+ This includes nodes that are the end of a device path instance and nodes that \r
+ are the end of an entire device path.\r
\r
Determines if the device path node specified by Node is an end node of a device path. \r
This includes nodes that are the end of a device path instance and nodes that are the \r
\r
@param DevicePath A pointer to a device path data structure.\r
\r
- @retval 0 If DevicePath is NULL.\r
+ @retval 0 DevicePath is NULL.\r
@retval Others The size of a device path in bytes.\r
\r
**/\r
\r
@param DevicePath A pointer to a device path data structure.\r
\r
- @retval NULL If DevicePath is NULL.\r
+ @retval NULL DevicePath is NULL.\r
@retval Others A pointer to the duplicated device path.\r
\r
**/\r
@param DevicePath A pointer to a device path data structure.\r
@param DevicePathNode A pointer to a single device path node.\r
\r
- @retval NULL If there is not enough memory for the new device path.\r
+ @retval NULL There is not enough memory for the new device path.\r
@retval Others A pointer to the new device path if success.\r
A copy of DevicePathNode followed by an end-of-device-path node \r
if both FirstDevicePath and SecondDevicePath are NULL.\r
@param DevicePath A pointer to a device path data structure.\r
\r
@retval TRUE DevicePath is multi-instance.\r
- @retval FALSE DevicePath is not multi-instance or DevicePath is NULL.\r
+ @retval FALSE DevicePath is not multi-instance, or DevicePath is NULL.\r
\r
**/\r
BOOLEAN\r
MDE DXE Services Library provides functions that simplify the development of DXE Drivers. \r
These functions help access data from sections of FFS files or from file path.\r
\r
- Copyright (c) 2008 - 2010, 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
- http://opensource.org/licenses/bsd-license.php \r
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
+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
If Size is NULL, then ASSERT().\r
\r
\r
- @param NameGuid A pointer to to the FFS filename GUID to search for within \r
- any of the firmware volumes in the platform. \r
- @param SectionType Indicates the FFS section type to search for within the FFS file specified by NameGuid.\r
- @param SectionInstance Indicates which section instance within the FFS file specified by NameGuid to retrieve.\r
- @param Buffer On output, a pointer to a callee allocated buffer containing the FFS file section that was found. \r
- It is the caller's responsibility to free this buffer using FreePool().\r
+ @param NameGuid A pointer to to the FFS filename GUID to search for \r
+ within any of the firmware volumes in the platform. \r
+ @param SectionType Indicates the FFS section type to search for within \r
+ the FFS file specified by NameGuid.\r
+ @param SectionInstance Indicates which section instance within the FFS file \r
+ specified by NameGuid to retrieve.\r
+ @param Buffer On output, a pointer to a callee-allocated buffer \r
+ containing the FFS file section that was found. \r
+ It is the caller's responsibility to free this \r
+ buffer using FreePool().\r
@param Size On output, a pointer to the size, in bytes, of Buffer.\r
\r
@retval EFI_SUCCESS The specified FFS section was returned.\r
@retval EFI_NOT_FOUND The specified FFS section could not be found.\r
- @retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve the matching FFS section.\r
- @retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a device error.\r
- @retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the firmware volume that \r
- contains the matching FFS section does not allow reads.\r
+ @retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve \r
+ the matching FFS section.\r
+ @retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a \r
+ device error.\r
+ @retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the \r
+ firmware volume that contains the matching FFS \r
+ section does not allow reads.\r
**/\r
EFI_STATUS\r
EFIAPI\r
If Buffer is NULL, then ASSERT().\r
If Size is NULL, then ASSERT().\r
\r
- @param NameGuid A pointer to to the FFS filename GUID to search for within \r
- the firmware volumes that the currently executing module was loaded from.\r
- @param SectionType Indicates the FFS section type to search for within the FFS file specified by NameGuid.\r
- @param SectionInstance Indicates which section instance within the FFS file specified by NameGuid to retrieve.\r
- @param Buffer On output, a pointer to a callee allocated buffer containing the FFS file section that was found. \r
- It is the caller's responsibility to free this buffer using FreePool().\r
+ @param NameGuid A pointer to to the FFS filename GUID to search for \r
+ within the firmware volumes that the currently \r
+ executing module was loaded from.\r
+ @param SectionType Indicates the FFS section type to search for within \r
+ the FFS file specified by NameGuid.\r
+ @param SectionInstance Indicates which section instance within the FFS \r
+ file specified by NameGuid to retrieve.\r
+ @param Buffer On output, a pointer to a callee allocated buffer \r
+ containing the FFS file section that was found. \r
+ It is the caller's responsibility to free this buffer \r
+ using FreePool().\r
@param Size On output, a pointer to the size, in bytes, of Buffer.\r
\r
\r
@retval EFI_SUCCESS The specified FFS section was returned.\r
@retval EFI_NOT_FOUND The specified FFS section could not be found.\r
- @retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve the matching FFS section.\r
- @retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a device error.\r
- @retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the firmware volume that \r
- contains the matching FFS section does not allow reads. \r
+ @retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve \r
+ the matching FFS section.\r
+ @retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a \r
+ device error.\r
+ @retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the \r
+ firmware volume that contains the matching FFS \r
+ section does not allow reads. \r
**/\r
EFI_STATUS\r
EFIAPI\r
If Size is NULL, then ASSERT().\r
\r
\r
- @param SectionType Indicates the FFS section type to search for within the FFS file \r
- that the currently executing module was loaded from.\r
- @param SectionInstance Indicates which section instance to retrieve within the FFS file \r
- that the currently executing module was loaded from.\r
- @param Buffer On output, a pointer to a callee allocated buffer containing the FFS file section that was found. \r
- It is the caller's responsibility to free this buffer using FreePool().\r
+ @param SectionType Indicates the FFS section type to search for within \r
+ the FFS file that the currently executing module \r
+ was loaded from.\r
+ @param SectionInstance Indicates which section instance to retrieve within \r
+ the FFS file that the currently executing module \r
+ was loaded from.\r
+ @param Buffer On output, a pointer to a callee allocated buffer \r
+ containing the FFS file section that was found. \r
+ It is the caller's responsibility to free this buffer \r
+ using FreePool().\r
@param Size On output, a pointer to the size, in bytes, of Buffer.\r
\r
@retval EFI_SUCCESS The specified FFS section was returned.\r
@retval EFI_NOT_FOUND The specified FFS section could not be found.\r
- @retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve the matching FFS section.\r
- @retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a device error.\r
- @retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the firmware volume that \r
- contains the matching FFS section does not allow reads. \r
+ @retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve \r
+ the matching FFS section.\r
+ @retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a \r
+ device error.\r
+ @retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the \r
+ firmware volume that contains the matching FFS \r
+ section does not allow reads. \r
\r
**/\r
EFI_STATUS\r
If FileSize is NULL, then NULL is returned.\r
If AuthenticationStatus is NULL, then NULL is returned.\r
\r
- @param[in] BootPolicy Policy for Open Image File.If TRUE, indicates that the request \r
- originates from the boot manager, and that the boot manager is\r
- attempting to load FilePath as a boot selection. If FALSE, \r
- then FilePath must match an exact file to be loaded.\r
- @param[in] FilePath Pointer to the device path of the file that is absracted to\r
+ @param[in] BootPolicy The policy for Open Image File.If TRUE, \r
+ indicates that the request originates from \r
+ the boot manager, and that the boot manager is\r
+ attempting to load FilePath as a boot selection. \r
+ If FALSE, then FilePath must match an exact \r
+ file to be loaded.\r
+ @param[in] FilePath Pointer to the device path of the file that is abstracted to\r
the file buffer.\r
@param[out] FileSize Pointer to the size of the abstracted file buffer.\r
@param[out] AuthenticationStatus Pointer to a caller-allocated UINT32 in which the authentication\r
status is returned.\r
\r
- @retval NULL File is NULL, or FileSize is NULL. Or the file can't be found.\r
+ @retval NULL File is NULL, or FileSize is NULL, or the file can't be found.\r
@retval other The abstracted file buffer. The caller is responsible to free memory.\r
**/\r
VOID *\r
/** @file\r
Provides a service to retrieve the PE/COFF entry point from a PE/COFF image.\r
\r
-Copyright (c) 2006 - 2010, 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
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
If Pe32Data is NULL, then ASSERT().\r
If EntryPoint is NULL, then ASSERT().\r
\r
- @param Pe32Data Pointer to the PE/COFF image that is loaded in system memory.\r
- @param EntryPoint Pointer to entry point to the PE/COFF image to return.\r
+ @param Pe32Data The pointer to the PE/COFF image that is loaded in system memory.\r
+ @param EntryPoint The pointer to entry point to the PE/COFF image to return.\r
\r
@retval RETURN_SUCCESS EntryPoint was returned.\r
@retval RETURN_INVALID_PARAMETER The entry point could not be found in the PE/COFF image.\r
Returns the machine type from the PE/COFF image specified by Pe32Data.\r
If Pe32Data is NULL, then ASSERT().\r
\r
- @param Pe32Data Pointer to the PE/COFF image that is loaded in system\r
+ @param Pe32Data The pointer to the PE/COFF image that is loaded in system\r
memory.\r
\r
@return Machine type or zero if not a valid image.\r
then NULL is returned.\r
If Pe32Data is NULL, then ASSERT().\r
\r
- @param Pe32Data Pointer to the PE/COFF image that is loaded in system\r
+ @param Pe32Data The pointer to the PE/COFF image that is loaded in system\r
memory.\r
\r
- @return The PDB file name for the PE/COFF image specified by Pe32Data or NULL\r
+ @return The PDB file name for the PE/COFF image specified by Pe32Data, or NULL\r
if it cannot be retrieved.\r
\r
**/\r
Returns the size of the PE/COFF header specified by Pe32Data.\r
If Pe32Data is NULL, then ASSERT().\r
\r
- @param Pe32Data Pointer to the PE/COFF image that is loaded in system\r
+ @param Pe32Data The pointer to the PE/COFF image that is loaded in system\r
memory.\r
\r
- @return Size of PE/COFF header in bytes or zero if not a valid image.\r
+ @return Size of PE/COFF header in bytes, or zero if not a valid image.\r
\r
**/\r
UINT32\r
IA-32, x86, IPF, and EBC processor types. The library functions are memory-based \r
and can be ported easily to any environment.\r
\r
-Copyright (c) 2006 - 2008, Intel Corporation<BR> \r
-Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<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
-http://opensource.org/licenses/bsd-license.php \r
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
On output, the number of bytes actually read.\r
@param Buffer Output buffer that contains the data read from the PE/COFF image.\r
\r
- @retval RETURN_SUCCESS The specified portion of the PE/COFF image was read and the size \r
- @retval RETURN_DEVICE_ERROR The specified portion of the PE/COFF image could not be read due \r
- to a device error.\r
+ @retval RETURN_SUCCESS The specified portion of the PE/COFF image was \r
+ read and the size \r
+ @retval RETURN_DEVICE_ERROR The specified portion of the PE/COFF image \r
+ could not be read due to a device error.\r
\r
**/\r
typedef\r
);\r
\r
///\r
-/// Context structure used while PE/COFF image is being loaded and relocated\r
+/// The context structure used while PE/COFF image is being loaded and relocated.\r
///\r
typedef struct {\r
///\r
- /// Is set by PeCoffLoaderGetImageInfo() to the ImageBase in the PE/COFF header\r
+ /// Set by PeCoffLoaderGetImageInfo() to the ImageBase in the PE/COFF header.\r
///\r
PHYSICAL_ADDRESS ImageAddress;\r
///\r
- /// Is set by PeCoffLoaderGetImageInfo() to the SizeOfImage in the PE/COFF header.\r
+ /// Set by PeCoffLoaderGetImageInfo() to the SizeOfImage in the PE/COFF header.\r
/// Image size includes the size of Debug Entry if it is present.\r
///\r
UINT64 ImageSize;\r
///\r
- /// Is set to zero by PeCoffLoaderGetImageInfo(). If DestinationAddress is non zero,\r
+ /// Is set to zero by PeCoffLoaderGetImageInfo(). If DestinationAddress is non-zero,\r
/// PeCoffLoaderRelocateImage() will relocate the image using this base address.\r
/// If the DestinationAddress is zero, the ImageAddress will be used as the base\r
/// address of relocation.\r
///\r
VOID *FixupData;\r
///\r
- /// Is set by PeCoffLoaderGetImageInfo() to the Section Alignment in the PE/COFF header\r
+ /// Set by PeCoffLoaderGetImageInfo() to the Section Alignment in the PE/COFF header.\r
/// If the image is a TE image, then this field is set to 0.\r
///\r
UINT32 SectionAlignment;\r
///\r
/// Set by PeCoffLoaderGetImageInfo() to offset to the PE/COFF header.\r
- /// If the PE/COFF image does not start with a DOS header, this value is zero; \r
- /// otherwise, it's the offset to the PE/COFF header.\r
+ /// If the PE/COFF image does not start with a DOS header, this value is zero. \r
+ /// Otherwise, it's the offset to the PE/COFF header.\r
///\r
UINT32 PeCoffHeaderOffset;\r
///\r
- /// Set by PeCoffLoaderGetImageInfo() to the Relative Virtual Address of the debug directory\r
+ /// Set by PeCoffLoaderGetImageInfo() to the Relative Virtual Address of the debug directory,\r
/// if it exists in the image\r
///\r
UINT32 DebugDirectoryEntryRva;\r
/// Not used by this library class. Other library classes that layer on top of this library \r
/// class fill in this value as part of their GetImageInfo call.\r
/// This allows the caller of the library to know what type of memory needs to be allocated\r
- /// to load and relocate the image\r
+ /// to load and relocate the image.\r
///\r
UINT32 ImageDataMemoryType;\r
///\r
UINT32 ImageError;\r
///\r
/// Set by PeCoffLoaderLoadImage() to indicate the size of FixupData that the caller must\r
- /// allocate before calling PeCoffLoaderRelocateImage()\r
+ /// allocate before calling PeCoffLoaderRelocateImage().\r
///\r
UINTN FixupDataSize;\r
///\r
- /// Set by PeCoffLoaderGetImageInfo() to the machine type stored in the PE/COFF header\r
+ /// Set by PeCoffLoaderGetImageInfo() to the machine type stored in the PE/COFF header.\r
///\r
UINT16 Machine;\r
///\r
BOOLEAN IsTeImage;\r
///\r
/// Set by PeCoffLoaderLoadImage() to the HII resource offset\r
- /// if the image contains a custom PE/COFF resource with the type 'HII';\r
- /// otherwise, the entry remains to be 0.\r
+ /// if the image contains a custom PE/COFF resource with the type 'HII'.\r
+ /// Otherwise, the entry remains to be 0.\r
///\r
PHYSICAL_ADDRESS HiiResourceData;\r
///\r
The ImageRead and Handle fields of ImageContext structure must be valid prior \r
to invoking this service.\r
\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
+ @param ImageContext The pointer to the image context structure that \r
+ describes the PE/COFF image that needs to be \r
+ 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
cache(s) in hardware, then the caller is responsible for performing cache maintenance operations\r
prior to transferring control to a PE/COFF image that is loaded using this library.\r
\r
- @param ImageContext Pointer to the image context structure that describes the PE/COFF\r
+ @param ImageContext The 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
cache(s) in hardware, then the caller is responsible for performing cache maintenance operations\r
prior to transferring control to a PE/COFF image that is loaded using this library.\r
\r
- @param ImageContext Pointer to the image context structure that describes the PE/COFF\r
+ @param ImageContext The 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
If ReadSize is NULL, then ASSERT().\r
If Buffer is NULL, then ASSERT().\r
\r
- @param FileHandle Pointer to base of the input stream\r
+ @param FileHandle The pointer to base of the input stream\r
@param FileOffset Offset into the PE/COFF image to begin the read operation.\r
@param ReadSize On input, the size in bytes of the requested read operation. \r
On output, the number of bytes actually read.\r
@param Buffer Output buffer that contains the data read from the PE/COFF image.\r
\r
- @retval RETURN_SUCCESS Data is read from FileOffset from the Handle into \r
+ @retval RETURN_SUCCESS The data is read from FileOffset from the Handle into \r
the buffer.\r
**/\r
RETURN_STATUS\r
cache(s) in hardware, then the caller is responsible for performing cache maintenance operations\r
prior to transferring control to a PE/COFF image that is loaded using this library.\r
\r
- @param ImageBase Base address of a PE/COFF image that has been loaded \r
+ @param ImageBase The base address of a PE/COFF image that has been loaded \r
and relocated into system memory.\r
@param VirtImageBase The request virtual address that the PE/COFF image is to\r
be fixed up for.\r
Provides services to print a formatted string to a buffer. All combinations of\r
Unicode and ASCII strings are supported.\r
\r
-Copyright (c) 2006 - 2009, 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
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
/// Define the maximum number of characters that are required to\r
-/// encode a decimal, hexadecimal, GUID, or TIME value with a NULL \r
-/// terminator.\r
+/// encode with a NULL terminator a decimal, hexadecimal, GUID, \r
+/// or TIME value.\r
/// \r
/// Maximum Length Decimal String = 28\r
/// "-9,223,372,036,854,775,808"\r
\r
/**\r
Produces a Null-terminated Unicode string in an output buffer based on \r
- a Null-terminated Unicode format string and a VA_LIST argument list\r
+ a Null-terminated Unicode format string and a VA_LIST argument list.\r
\r
Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
and BufferSize. \r
The Unicode string is produced by parsing the format string specified by FormatString. \r
Arguments are pulled from the variable argument list specified by Marker based on the \r
contents of the format string. \r
- The number of Unicode characters in the produced output buffer is returned not including\r
+ The number of Unicode characters in the produced output buffer is returned, not including\r
the Null-terminator.\r
If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
\r
If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than \r
- PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+ PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator, then\r
ASSERT().\r
If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
- contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
+ contains more than PcdMaximumUnicodeStringLength Unicode characters, not including the\r
Null-terminator, then ASSERT().\r
\r
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
@param FormatString Null-terminated Unicode format string.\r
@param Marker VA_LIST marker for the variable argument list.\r
\r
- @return The number of Unicode characters in the produced output buffer not including the\r
+ @return The number of Unicode characters in the produced output buffer, not including the\r
Null-terminator.\r
\r
**/\r
\r
/**\r
Produces a Null-terminated Unicode string in an output buffer based on \r
- a Null-terminated Unicode format string and a BASE_LIST argument list\r
+ a Null-terminated Unicode format string and a BASE_LIST argument list.\r
\r
Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
and BufferSize. \r
The Unicode string is produced by parsing the format string specified by FormatString. \r
Arguments are pulled from the variable argument list specified by Marker based on the \r
contents of the format string. \r
- The number of Unicode characters in the produced output buffer is returned not including\r
+ The number of Unicode characters in the produced output buffer is returned, not including\r
the Null-terminator.\r
If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
\r
If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than \r
- PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+ PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator, then\r
ASSERT().\r
If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
- contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
+ contains more than PcdMaximumUnicodeStringLength Unicode characters, not including the\r
Null-terminator, then ASSERT().\r
\r
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
@param FormatString Null-terminated Unicode format string.\r
@param Marker BASE_LIST marker for the variable argument list.\r
\r
- @return The number of Unicode characters in the produced output buffer not including the\r
+ @return The number of Unicode characters in the produced output buffer, not including the\r
Null-terminator.\r
\r
**/\r
and BufferSize.\r
The Unicode string is produced by parsing the format string specified by FormatString.\r
Arguments are pulled from the variable argument list based on the contents of the format string.\r
- The number of Unicode characters in the produced output buffer is returned not including\r
+ The number of Unicode characters in the produced output buffer is returned, not including\r
the Null-terminator.\r
If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
\r
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
Unicode string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
- @param ... Variable argument list whose contents are accessed based on the \r
+ @param FormatString A null-terminated Unicode format string.\r
+ @param ... The variable argument list whose contents are accessed based on the \r
format string specified by FormatString.\r
\r
- @return The number of Unicode characters in the produced output buffer not including the\r
+ @return The number of Unicode characters in the produced output buffer, not including the\r
Null-terminator.\r
\r
**/\r
The Unicode string is produced by parsing the format string specified by FormatString.\r
Arguments are pulled from the variable argument list specified by Marker based on the \r
contents of the format string.\r
- The number of Unicode characters in the produced output buffer is returned not including\r
+ The number of Unicode characters in the produced output buffer is returned, not including\r
the Null-terminator.\r
If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
\r
If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
- PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
+ PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator, then\r
ASSERT().\r
If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
- contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
+ contains more than PcdMaximumUnicodeStringLength Unicode characters, not including the\r
Null-terminator, then ASSERT().\r
\r
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
Unicode string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated ASCII format string.\r
+ @param FormatString A null-terminated ASCII format string.\r
@param Marker VA_LIST marker for the variable argument list.\r
\r
@return The number of Unicode characters in the produced output buffer not including the\r
The Unicode string is produced by parsing the format string specified by FormatString.\r
Arguments are pulled from the variable argument list specified by Marker based on the \r
contents of the format string.\r
- The number of Unicode characters in the produced output buffer is returned not including\r
+ The number of Unicode characters in the produced output buffer is returned, not including\r
the Null-terminator.\r
If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
\r
If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
- PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
+ PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator, then\r
ASSERT().\r
If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
- contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
+ contains more than PcdMaximumUnicodeStringLength Unicode characters, not including the\r
Null-terminator, then ASSERT().\r
\r
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
Unicode string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated ASCII format string.\r
- @param Marker BASE_LIST marker for the variable argument list.\r
+ @param FormatString A null-terminated ASCII format string.\r
+ @param Marker A BASE_LIST marker for the variable argument list.\r
\r
- @return The number of Unicode characters in the produced output buffer not including the\r
+ @return The number of Unicode characters in the produced output buffer, not including the\r
Null-terminator.\r
\r
**/\r
The Unicode string is produced by parsing the format string specified by FormatString.\r
Arguments are pulled from the variable argument list based on the contents of the \r
format string.\r
- The number of Unicode characters in the produced output buffer is returned not including\r
+ The number of Unicode characters in the produced output buffer is returned, not including\r
the Null-terminator.\r
If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
\r
If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
- PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
+ PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator, then\r
ASSERT().\r
If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
- contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
+ contains more than PcdMaximumUnicodeStringLength Unicode characters, the\r
Null-terminator, then ASSERT().\r
\r
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
Unicode string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated ASCII format string.\r
+ @param FormatString A null-terminated ASCII format string.\r
@param ... Variable argument list whose contents are accessed based on the \r
format string specified by FormatString.\r
\r
- @return The number of Unicode characters in the produced output buffer not including the\r
+ @return The number of Unicode characters in the produced output buffer, not including the\r
Null-terminator.\r
\r
**/\r
Converts the decimal number specified by Value to a Null-terminated Unicode \r
string specified by Buffer containing at most Width characters. No padding of spaces \r
is ever performed. If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.\r
- The number of Unicode characters in Buffer is returned not including the Null-terminator.\r
+ The number of Unicode characters in Buffer is returned, not including the Null-terminator.\r
If the conversion contains more than Width characters, then only the first\r
Width characters are returned, and the total number of characters \r
required to perform the conversion is returned.\r
If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT().\r
If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()\r
\r
- @param Buffer Pointer to the output buffer for the produced Null-terminated\r
+ @param Buffer The pointer to the output buffer for the produced Null-terminated\r
Unicode string.\r
@param Flags The bitmask of flags that specify left justification, zero pad, and commas.\r
@param Value The 64-bit signed value to convert to a string.\r
@param Width The maximum number of Unicode characters to place in Buffer, not including\r
the Null-terminator.\r
\r
- @return The number of Unicode characters in Buffer not including the Null-terminator.\r
+ @return The number of Unicode characters in Buffer, not including the Null-terminator.\r
\r
**/\r
UINTN\r
The ASCII string is produced by parsing the format string specified by FormatString.\r
Arguments are pulled from the variable argument list specified by Marker based on \r
the contents of the format string.\r
- The number of ASCII characters in the produced output buffer is returned not including\r
+ The number of ASCII characters in the produced output buffer is returned, not including\r
the Null-terminator.\r
If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
- PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
+ PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator, then\r
ASSERT().\r
If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
- contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
+ contains more than PcdMaximumAsciiStringLength ASCII characters, not including the\r
Null-terminator, then ASSERT().\r
\r
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
ASCII string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated ASCII format string.\r
+ @param FormatString A null-terminated ASCII format string.\r
@param Marker VA_LIST marker for the variable argument list.\r
\r
- @return The number of ASCII characters in the produced output buffer not including the\r
+ @return The number of ASCII characters in the produced output buffer, not including the\r
Null-terminator.\r
\r
**/\r
The ASCII string is produced by parsing the format string specified by FormatString.\r
Arguments are pulled from the variable argument list specified by Marker based on \r
the contents of the format string.\r
- The number of ASCII characters in the produced output buffer is returned not including\r
+ The number of ASCII characters in the produced output buffer is returned, not including\r
the Null-terminator.\r
If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
- PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
+ PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator, then\r
ASSERT().\r
If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
- contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
+ contains more than PcdMaximumAsciiStringLength ASCII characters, not including the\r
Null-terminator, then ASSERT().\r
\r
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
ASCII string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated ASCII format string.\r
+ @param FormatString A null-terminated ASCII format string.\r
@param Marker BASE_LIST marker for the variable argument list.\r
\r
- @return The number of ASCII characters in the produced output buffer not including the\r
+ @return The number of ASCII characters in the produced output buffer, not including the\r
Null-terminator.\r
\r
**/\r
The ASCII string is produced by parsing the format string specified by FormatString.\r
Arguments are pulled from the variable argument list based on the contents of the \r
format string.\r
- The number of ASCII characters in the produced output buffer is returned not including\r
+ The number of ASCII characters in the produced output buffer is returned, not including\r
the Null-terminator.\r
If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
- PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
+ PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator, then\r
ASSERT().\r
If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
- contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
+ contains more than PcdMaximumAsciiStringLength ASCII characters, not including the\r
Null-terminator, then ASSERT().\r
\r
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
ASCII string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated ASCII format string.\r
- @param ... Variable argument list whose contents are accessed based on the \r
+ @param FormatString A null-terminated ASCII format string.\r
+ @param ... The variable argument list whose contents are accessed based on the \r
format string specified by FormatString.\r
\r
- @return The number of ASCII characters in the produced output buffer not including the\r
+ @return The number of ASCII characters in the produced output buffer, not including the\r
Null-terminator.\r
\r
**/\r
The ASCII string is produced by parsing the format string specified by FormatString.\r
Arguments are pulled from the variable argument list specified by Marker based on \r
the contents of the format string.\r
- The number of ASCII characters in the produced output buffer is returned not including\r
+ The number of ASCII characters in the produced output buffer is returned, not including\r
the Null-terminator.\r
If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
If BufferSize > 0 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
- PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+ PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator, then\r
ASSERT().\r
If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
- contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
+ contains more than PcdMaximumAsciiStringLength ASCII characters, not including the\r
Null-terminator, then ASSERT().\r
\r
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
ASCII string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
+ @param FormatString A null-terminated Unicode format string.\r
@param Marker VA_LIST marker for the variable argument list.\r
\r
- @return The number of ASCII characters in the produced output buffer not including the\r
+ @return The number of ASCII characters in the produced output buffer, not including the\r
Null-terminator.\r
\r
**/\r
The ASCII string is produced by parsing the format string specified by FormatString.\r
Arguments are pulled from the variable argument list specified by Marker based on \r
the contents of the format string.\r
- The number of ASCII characters in the produced output buffer is returned not including\r
+ The number of ASCII characters in the produced output buffer is returned, not including\r
the Null-terminator.\r
If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
If BufferSize > 0 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
- PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+ PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator, then\r
ASSERT().\r
If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
- contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
+ contains more than PcdMaximumAsciiStringLength ASCII characters, not including the\r
Null-terminator, then ASSERT().\r
\r
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
ASCII string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
+ @param FormatString A null-terminated Unicode format string.\r
@param Marker BASE_LIST marker for the variable argument list.\r
\r
- @return The number of ASCII characters in the produced output buffer not including the\r
+ @return The number of ASCII characters in the produced output buffer, not including the\r
Null-terminator.\r
\r
**/\r
The ASCII string is produced by parsing the format string specified by FormatString.\r
Arguments are pulled from the variable argument list based on the contents of the \r
format string.\r
- The number of ASCII characters in the produced output buffer is returned not including\r
+ The number of ASCII characters in the produced output buffer is returned, not including\r
the Null-terminator.\r
If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
\r
If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
If BufferSize > 0 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
- PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
+ PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator, then\r
ASSERT().\r
If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
- contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
+ contains more than PcdMaximumAsciiStringLength ASCII characters, not including the\r
Null-terminator, then ASSERT().\r
\r
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated \r
ASCII string.\r
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.\r
- @param FormatString Null-terminated Unicode format string.\r
+ @param FormatString A null-terminated Unicode format string.\r
@param ... Variable argument list whose contents are accessed based on the \r
format string specified by FormatString.\r
\r
- @return The number of ASCII characters in the produced output buffer not including the\r
+ @return The number of ASCII characters in the produced output buffer, not including the\r
Null-terminator.\r
\r
**/\r
specified by Buffer containing at most Width characters. No padding of spaces \r
is ever performed.\r
If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.\r
- The number of ASCII characters in Buffer is returned not including the Null-terminator.\r
+ The number of ASCII characters in Buffer is returned, not including the Null-terminator.\r
If the conversion contains more than Width characters, then only the first Width\r
characters are returned, and the total number of characters required to perform\r
the conversion is returned.\r
If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT().\r
If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()\r
\r
- @param Buffer Pointer to the output buffer for the produced Null-terminated\r
+ @param Buffer A pointer to the output buffer for the produced Null-terminated\r
ASCII string.\r
@param Flags The bitmask of flags that specify left justification, zero pad, and commas.\r
@param Value The 64-bit signed value to convert to a string.\r
@param Width The maximum number of ASCII characters to place in Buffer, not including\r
the Null-terminator.\r
\r
- @return The number of ASCII characters in Buffer not including the Null-terminator.\r
+ @return The number of ASCII characters in Buffer, not including the Null-terminator.\r
\r
**/\r
UINTN\r
/** @file\r
Provides services to log status code records.\r
\r
-Copyright (c) 2006 - 2009, 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
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@param PostCode A pointer to the 8-bit POST code value to return. \r
\r
@retval TRUE The status code specified by CodeType and Value was converted \r
- to an 8-bit POST code and returned in PostCode.\r
+ to an 8-bit POST code and returned in PostCode.\r
@retval FALSE The status code specified by CodeType and Value could not be \r
converted to an 8-bit POST code value.\r
\r
\r
@param CodeType The type of status code being converted.\r
@param Value The status code value being converted.\r
- @param Data Pointer to status code data buffer. \r
- @param Filename Pointer to the source file name that generated the ASSERT().\r
- @param Description Pointer to the description of the ASSERT().\r
- @param LineNumber Pointer to source line number that generated the ASSERT().\r
+ @param Data The pointer to status code data buffer. \r
+ @param Filename The pointer to the source file name that generated the ASSERT().\r
+ @param Description The pointer to the description of the ASSERT().\r
+ @param LineNumber The pointer to source line number that generated the ASSERT().\r
\r
@retval TRUE The status code specified by CodeType, Value, and Data was \r
converted ASSERT() arguments specified by Filename, Description, \r
If Marker is NULL, then ASSERT().\r
If Format is NULL, then ASSERT().\r
\r
- @param Data Pointer to status code data buffer. \r
- @param ErrorLevel Pointer to error level mask for a debug message.\r
- @param Marker Pointer to the variable argument list associated with Format.\r
- @param Format Pointer to a Null-terminated ASCII format string of a \r
+ @param Data The pointer to status code data buffer. \r
+ @param ErrorLevel The pointer to error level mask for a debug message.\r
+ @param Marker The pointer to the variable argument list associated with Format.\r
+ @param Format The pointer to a Null-terminated ASCII format string of a \r
debug message.\r
\r
@retval TRUE The status code specified by Data was converted DEBUG() arguments \r
@retval EFI_SUCCESS The status code was reported.\r
@retval EFI_DEVICE_ERROR There status code could not be reported due to a \r
device error.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
+ @retval EFI_UNSUPPORTED The report status code is not supported.\r
\r
**/\r
EFI_STATUS\r
\r
If DevicePath is NULL, then ASSERT().\r
\r
- @param Type Status code type. \r
- @param Value Status code value.\r
- @param DevicePath Pointer to the Device Path Protocol to be reported.\r
+ @param Type The status code type. \r
+ @param Value The status code value.\r
+ @param DevicePath The pointer to the Device Path Protocol to be reported.\r
\r
@retval EFI_SUCCESS The status code was reported with the extended \r
data specified by DevicePath.\r
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the \r
extended data section.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
+ @retval EFI_UNSUPPORTED The report status code is not supported.\r
@retval EFI_DEVICE_ERROR A call to a Report Status Code Library function\r
is already in progress.\r
\r
If ExtendedData is NULL, then ASSERT().\r
If ExtendedDataSize is 0, then ASSERT().\r
\r
- @param Type Status code type. \r
- @param Value Status code value.\r
- @param ExtendedData Pointer to the extended data buffer to be reported.\r
+ @param Type The status code type. \r
+ @param Value The status code value.\r
+ @param ExtendedData The pointer to the extended data buffer to be reported.\r
@param ExtendedDataSize The size, in bytes, of the extended data buffer to \r
be reported.\r
\r
data specified by ExtendedData and ExtendedDataSize.\r
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the \r
extended data section.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
+ @retval EFI_UNSUPPORTED The report status code is not supported.\r
@retval EFI_DEVICE_ERROR A call to a Report Status Code Library function\r
is already in progress.\r
\r
If ExtendedData is NULL and ExtendedDataSize is not zero, then ASSERT().\r
If ExtendedData is not NULL and ExtendedDataSize is zero, then ASSERT().\r
\r
- @param Type Status code type. \r
- @param Value Status code value.\r
- @param Instance Status code instance number.\r
- @param CallerId Pointer to a GUID that identifies the caller of this \r
+ @param Type The status code type. \r
+ @param Value The status code value.\r
+ @param Instance The status code instance number.\r
+ @param CallerId The pointer to a GUID that identifies the caller of this \r
function. If this parameter is NULL, then a caller \r
ID of gEfiCallerIdGuid is used.\r
- @param ExtendedDataGuid Pointer to the GUID for the extended data buffer. \r
+ @param ExtendedDataGuid The pointer to the GUID for the extended data buffer. \r
If this parameter is NULL, then a the status code \r
standard header is filled in with an implementation dependent GUID.\r
- @param ExtendedData Pointer to the extended data buffer. This is an \r
+ @param ExtendedData The pointer to the extended data buffer. This is an \r
optional parameter that may be NULL.\r
@param ExtendedDataSize The size, in bytes, of the extended data buffer.\r
\r
@retval EFI_SUCCESS The status code was reported.\r
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate \r
the extended data section if it was specified.\r
- @retval EFI_UNSUPPORTED Report status code is not supported.\r
+ @retval EFI_UNSUPPORTED The report status code is not supported.\r
@retval EFI_DEVICE_ERROR A call to a Report Status Code Library function\r
is already in progress.\r
\r
Returns TRUE if status codes of type EFI_ERROR_CODE are enabled\r
\r
This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED \r
- bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.\r
+ bit of PcdReportStatusCodeProperyMask is set. Otherwise, FALSE is returned.\r
\r
@retval TRUE The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of \r
PcdReportStatusCodeProperyMask is set.\r
PcdReportStatusCodeProperyMask, then call ReportStatusCode() passing in Type \r
and Value.\r
\r
- @param Type Status code type. \r
- @param Value Status code value.\r
+ @param Type The status code type. \r
+ @param Value The status code value.\r
\r
@retval EFI_SUCCESS The status code was reported.\r
@retval EFI_DEVICE_ERROR There status code could not be reported due to a device error.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
+ @retval EFI_UNSUPPORTED Report status code is not supported.\r
\r
**/\r
#define REPORT_STATUS_CODE(Type,Value) \\r
PcdReportStatusCodeProperyMask, then call ReportStatusCodeWithDevicePath() \r
passing in Type, Value, and DevicePath.\r
\r
- @param Type Status code type. \r
- @param Value Status code value.\r
+ @param Type The status code type. \r
+ @param Value The status code value.\r
@param DevicePath Pointer to the Device Path Protocol to be reported.\r
\r
@retval EFI_SUCCESS The status code was reported with the extended \r
data specified by DevicePath.\r
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the \r
extended data section.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
+ @retval EFI_UNSUPPORTED The report status code is not supported.\r
@retval EFI_DEVICE_ERROR A call to a Report Status Code Library function\r
is already in progress.\r
\r
PcdReportStatusCodeProperyMask, then call ReportStatusCodeWithExtendedData() \r
passing in Type, Value, ExtendedData, and ExtendedDataSize.\r
\r
- @param Type Status code type. \r
- @param Value Status code value.\r
- @param ExtendedData Pointer to the extended data buffer to be reported.\r
+ @param Type The status code type. \r
+ @param Value The status code value.\r
+ @param ExtendedData The pointer to the extended data buffer to be reported.\r
@param ExtendedDataSize The size, in bytes, of the extended data buffer to\r
be reported.\r
\r
data specified by ExtendedData and ExtendedDataSize.\r
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the \r
extended data section.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
+ @retval EFI_UNSUPPORTED The report status code is not supported.\r
@retval EFI_DEVICE_ERROR A call to a Report Status Code Library function\r
is already in progress.\r
\r
PcdReportStatusCodeProperyMask, then call ReportStatusCodeEx() passing in Type, \r
Value, Instance, CallerId, ExtendedDataGuid, ExtendedData, and ExtendedDataSize.\r
\r
- @param Type Status code type. \r
- @param Value Status code value.\r
- @param Instance Status code instance number.\r
- @param CallerId Pointer to a GUID that identifies the caller of this \r
+ @param Type The status code type. \r
+ @param Value The status code value.\r
+ @param Instance The status code instance number.\r
+ @param CallerId The pointer to a GUID that identifies the caller of this \r
function. If this parameter is NULL, then a caller \r
ID of gEfiCallerIdGuid is used.\r
@param ExtendedDataGuid Pointer to the GUID for the extended data buffer. \r
@retval EFI_SUCCESS The status code was reported.\r
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the \r
extended data section if it was specified.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
+ @retval EFI_UNSUPPORTED The report status code is not supported.\r
@retval EFI_DEVICE_ERROR A call to a Report Status Code Library function\r
is already in progress.\r
\r
of size reduction when compiler optimization is disabled. If MDEPKG_NDEBUG is\r
defined, then debug and assert related macros wrapped by it are the NULL implementations.\r
\r
-Copyright (c) 2006 - 2010, 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
-http://opensource.org/licenses/bsd-license.php\r
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
Macro that returns the number of 100 ns units for a specified number of microseconds.\r
- Useful for managing EFI timer events.\r
+ This is useful for managing EFI timer events.\r
\r
- @param Microseconds Number of microseconds.\r
+ @param Microseconds The number of microseconds.\r
\r
@return The number of 100 ns units equivalent to the number of microseconds specified\r
by Microseconds.\r
\r
/**\r
Macro that returns the number of 100 ns units for a specified number of milliseconds.\r
- Useful for managing EFI timer events.\r
+ This is useful for managing EFI timer events.\r
\r
- @param Milliseconds Number of milliseconds.\r
+ @param Milliseconds The number of milliseconds.\r
\r
@return The number of 100 ns units equivalent to the number of milliseconds specified\r
by Milliseconds.\r
\r
/**\r
Macro that returns the number of 100 ns units for a specified number of seconds.\r
- Useful for managing EFI timer events.\r
+ This is useful for managing EFI timer events.\r
\r
- @param Seconds Number of seconds.\r
+ @param Seconds The number of seconds.\r
\r
@return The number of 100 ns units equivalent to the number of seconds specified\r
by Seconds.\r
If TableGuid is NULL, then ASSERT().\r
If Table is NULL, then ASSERT().\r
\r
- @param TableGuid Pointer to table's GUID type..\r
- @param Table Pointer to the table associated with TableGuid in the EFI System Table.\r
+ @param TableGuid The pointer to table's GUID type..\r
+ @param Table The pointer to the table associated with TableGuid in the EFI System Table.\r
\r
@retval EFI_SUCCESS A configuration table matching TableGuid was found.\r
@retval EFI_NOT_FOUND A configuration table matching TableGuid could not be found.\r
@param Registration A pointer to a memory location to receive the registration value.\r
\r
@retval EFI_SUCCESS A named event was created.\r
- @retval EFI_OUT_OF_RESOURCES There are not enough resource to create the named event.\r
+ @retval EFI_OUT_OF_RESOURCES There are not enough resources to create the named event.\r
\r
**/\r
EFI_STATUS\r
created with EfiNamedEventListen().\r
If Name is NULL, then ASSERT().\r
\r
- @param Name Supplies GUID name of the event.\r
+ @param Name Supplies the GUID name of the event.\r
\r
@retval EFI_SUCCESS A named event was signaled.\r
- @retval EFI_OUT_OF_RESOURCES There are not enough resource to signal the named event.\r
+ @retval EFI_OUT_OF_RESOURCES There are not enough resources to signal the named event.\r
\r
**/\r
EFI_STATUS\r
If Priority is not a valid TPL value, then ASSERT().\r
\r
@param Lock A pointer to the lock data structure to initialize.\r
- @param Priority EFI TPL associated with the lock.\r
+ @param Priority The EFI TPL associated with the lock.\r
\r
@return The lock.\r
\r
that matches the language specified by Language.\r
@param Iso639Language Specifies the supported language code format. If it is TRUE, then\r
Language and SupportedLanguages follow ISO 639-2 language code format.\r
- Otherwise, they follow RFC 4646 language code format.\r
+ Otherwise, they follow the RFC 4646 language code format.\r
\r
\r
@retval EFI_SUCCESS The Unicode string that matches the language specified by Language\r
If Name is NULL, then ASSERT().\r
If Guid is NULL, then ASSERT().\r
\r
- @param[in] Name Pointer to a Null-terminated Unicode string.\r
- @param[in] Guid Pointer to an EFI_GUID structure\r
+ @param[in] Name The pointer to a Null-terminated Unicode string.\r
+ @param[in] Guid The pointer to an EFI_GUID structure.\r
\r
@retval NULL The variable could not be retrieved.\r
@retval NULL There are not enough resources available for the variable contents.\r
\r
If Name is NULL, then ASSERT().\r
\r
- @param[in] Name Pointer to a Null-terminated Unicode string.\r
+ @param[in] Name The pointer to a Null-terminated Unicode string.\r
\r
@retval NULL The variable could not be retrieved.\r
@retval NULL There are not enough resources available for the variable contents.\r
\r
@param LegacyBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).\r
\r
- @retval EFI_SUCCESS Event was created.\r
- @retval Other Event was not created.\r
+ @retval EFI_SUCCESS The event was created.\r
+ @retval Other The event was not created.\r
\r
**/\r
EFI_STATUS\r
@param NotifyContext The content to pass to NotifyFunction when the event is signaled.\r
@param LegacyBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).\r
\r
- @retval EFI_SUCCESS Event was created.\r
- @retval Other Event was not created.\r
+ @retval EFI_SUCCESS The event was created.\r
+ @retval Other The event was not created.\r
\r
**/\r
EFI_STATUS\r
\r
@param ReadyToBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).\r
\r
- @retval EFI_SUCCESS Event was created.\r
- @retval Other Event was not created.\r
+ @retval EFI_SUCCESS The event was created.\r
+ @retval Other The event was not created.\r
\r
**/\r
EFI_STATUS\r
@param NotifyContext The content to pass to NotifyFunction when the event is signaled.\r
@param ReadyToBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).\r
\r
- @retval EFI_SUCCESS Event was created.\r
- @retval Other Event was not created.\r
+ @retval EFI_SUCCESS The event was created.\r
+ @retval Other The event was not created.\r
\r
**/\r
EFI_STATUS\r
If FvDevicePathNode is NULL, then ASSERT().\r
If NameGuid is NULL, then ASSERT().\r
\r
- @param FvDevicePathNode Pointer to a FV device path node to initialize\r
+ @param FvDevicePathNode The pointer to a FV device path node to initialize\r
@param NameGuid FV file name to use in FvDevicePathNode\r
\r
**/\r
the differences from the caller.\r
If FvDevicePathNode is NULL, then ASSERT().\r
\r
- @param FvDevicePathNode Pointer to FV device path to check.\r
+ @param FvDevicePathNode The pointer to FV device path to check.\r
\r
@retval NULL FvDevicePathNode is not valid.\r
@retval Other FvDevicePathNode is valid and pointer to NameGuid was returned.\r
If Format is NULL, then ASSERT().\r
If Format is not aligned on a 16-bit boundary, then ASSERT().\r
\r
- @param Format Null-terminated Unicode format string.\r
- @param ... Variable argument list whose contents are accessed based \r
+ @param Format A null-terminated Unicode format string.\r
+ @param ... The variable argument list whose contents are accessed based \r
on the format string specified by Format.\r
\r
@return Number of Unicode characters printed to ConOut.\r
If Format is NULL, then ASSERT().\r
If Format is not aligned on a 16-bit boundary, then ASSERT().\r
\r
- @param Format Null-terminated Unicode format string.\r
- @param ... Variable argument list whose contents are accessed based \r
+ @param Format A null-terminated Unicode format string.\r
+ @param ... The variable argument list whose contents are accessed based \r
on the format string specified by Format.\r
\r
@return Number of Unicode characters printed to StdErr.\r
PcdUefiLibMaxPrintBufferSize characters are sent to ConOut.\r
If Format is NULL, then ASSERT().\r
\r
- @param Format Null-terminated ASCII format string.\r
- @param ... Variable argument list whose contents are accessed based \r
+ @param Format A null-terminated ASCII format string.\r
+ @param ... The variable argument list whose contents are accessed based \r
on the format string specified by Format.\r
\r
@return Number of ASCII characters printed to ConOut.\r
PcdUefiLibMaxPrintBufferSize characters are sent to StdErr.\r
If Format is NULL, then ASSERT().\r
\r
- @param Format Null-terminated ASCII format string.\r
- @param ... Variable argument list whose contents are accessed based \r
+ @param Format A null-terminated ASCII format string.\r
+ @param ... The variable argument list whose contents are accessed based \r
on the format string specified by Format.\r
\r
@return Number of ASCII characters printed to ConErr.\r
an optional parameter that may be NULL. If it is NULL, \r
then the background color of the current ConOut device\r
in the EFI_SYSTEM_TABLE is used.\r
- @param Format Null-terminated Unicode format string. See Print Library \r
+ @param Format A null-terminated Unicode format string. See Print Library \r
for the supported format string syntax.\r
@param ... Variable argument list whose contents are accessed based on \r
the format string specified by Format. \r
an optional parameter that may be NULL. If it is NULL, \r
then the background color of the current ConOut device\r
in the EFI_SYSTEM_TABLE is used.\r
- @param Format Null-terminated ASCII format string. See Print Library \r
+ @param Format A null-terminated ASCII format string. See Print Library \r
for the supported format string syntax.\r
- @param ... Variable argument list whose contents are accessed based on \r
+ @param ... The variable argument list whose contents are accessed based on \r
the format string specified by Format. \r
\r
@return The number of ASCII characters printed.\r
@param DriverBindingHandle The handle that DriverBinding is to be installed onto. If this\r
parameter is NULL, then a new handle is created.\r
\r
- @retval EFI_SUCCESS The protocol installation is completed successfully.\r
+ @retval EFI_SUCCESS The protocol installation completed successfully.\r
@retval EFI_OUT_OF_RESOURCES There was not enough system resources to install the protocol.\r
@retval Others Status from gBS->InstallMultipleProtocolInterfaces().\r
\r
@param DriverConfiguration A Driver Configuration Protocol instance that this driver is producing.\r
@param DriverDiagnostics A Driver Diagnostics Protocol instance that this driver is producing.\r
\r
- @retval EFI_SUCCESS The protocol installation is completed successfully.\r
- @retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.\r
+ @retval EFI_SUCCESS The protocol installation completed successfully.\r
+ @retval EFI_OUT_OF_RESOURCES There was not enough memory in the pool to install all the protocols.\r
\r
**/\r
EFI_STATUS\r
@param ComponentName A Component Name Protocol instance that this driver is producing.\r
@param ComponentName2 A Component Name 2 Protocol instance that this driver is producing.\r
\r
- @retval EFI_SUCCESS The protocol installation is completed successfully.\r
+ @retval EFI_SUCCESS The protocol installation completed successfully.\r
@retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.\r
\r
**/\r
@param DriverDiagnostics A Driver Diagnostics Protocol instance that this driver is producing.\r
@param DriverDiagnostics2 A Driver Diagnostics Protocol 2 instance that this driver is producing.\r
\r
- @retval EFI_SUCCESS The protocol installation is completed successfully.\r
+ @retval EFI_SUCCESS The protocol installation completed successfully.\r
@retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.\r
\r
**/\r
Provides library functions for each of the UEFI Runtime Services.\r
Only available to DXE and UEFI module types.\r
\r
-Copyright (c) 2006 - 2009, 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
-http://opensource.org/licenses/bsd-license.php\r
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@param Time The current alarm setting. Type EFI_TIME is defined in the GetTime()\r
function description.\r
\r
- @retval EFI_SUCCESS The alarm settings were returned.\r
+ @retval EFI_SUCCESS The alarm settings were returned.\r
@retval EFI_INVALID_PARAMETER Enabled is NULL.\r
@retval EFI_INVALID_PARAMETER Pending is NULL.\r
@retval EFI_INVALID_PARAMETER Time is NULL.\r
@param DebugDisposition Supplies type information for the pointer being converted.\r
@param ListHead Head of linked list to convert.\r
\r
- @retval EFI_SUCCESS Success to execute the function.\r
+ @retval EFI_SUCCESS Successfully executed the function.\r
@retval !EFI_SUCCESS Failed to execute the function.\r
\r
**/\r
CapsuleHeaderArray. This parameter is only referenced if\r
the capsules are defined to persist across system reset.\r
\r
- @retval EFI_SUCCESS Valid capsule was passed. If CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set,\r
+ @retval EFI_SUCCESS A valid capsule was passed. If CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set,\r
the capsule has been successfully processed by the firmware.\r
@retval EFI_INVALID_PARAMETER CapsuleSize is NULL, or an incompatible set of flags were\r
set in the capsule header.\r
Undefined on input.\r
@param ResetType Returns the type of reset required for the capsule update.\r
\r
- @retval EFI_SUCCESS Valid answer returned.\r
+ @retval EFI_SUCCESS A valid answer was returned.\r
@retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.\r
@retval EFI_UNSUPPORTED The capsule type is not supported on this platform, and\r
MaximumCapsuleSize and ResetType are undefined.\r
@param RemainingVariableStorageSize\r
Returns the remaining size of the storage space\r
available for the EFI variables associated with the\r
- attributes specified..\r
+ attributes specified.\r
@param MaximumVariableSize Returns the maximum size of the individual EFI\r
variables associated with the attributes specified.\r
\r
- @retval EFI_SUCCESS Valid answer returned.\r
+ @retval EFI_SUCCESS A valid answer was returned.\r
@retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied.\r
@retval EFI_UNSUPPORTED EFI_UNSUPPORTED The attribute is not supported on this platform, and the\r
MaximumVariableStorageSize,\r
/** @file\r
Include file matches things in PI.\r
\r
- Copyright (c) 2006 - 2010, 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
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
+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
@par Revision Reference:\r
PI Version 1.0\r
#include <Pi/PiMultiPhase.h>\r
\r
///\r
-/// Global Coherencey Domain types - Memory type\r
+/// Global Coherencey Domain types - Memory type.\r
///\r
typedef enum {\r
///\r
} EFI_GCD_MEMORY_TYPE;\r
\r
///\r
-/// Global Coherencey Domain types - IO type\r
+/// Global Coherencey Domain types - IO type.\r
///\r
typedef enum {\r
///\r
} EFI_GCD_ALLOCATE_TYPE;\r
\r
///\r
-/// EFI_GCD_MEMORY_SPACE_DESCRIPTOR\r
+/// EFI_GCD_MEMORY_SPACE_DESCRIPTOR.\r
/// \r
typedef struct {\r
///\r
/// The physical address of the first byte in the memory region. Type\r
/// EFI_PHYSICAL_ADDRESS is defined in the AllocatePages() function\r
- /// description in the UEFI 2.0 specification\r
+ /// description in the UEFI 2.0 specification.\r
/// \r
EFI_PHYSICAL_ADDRESS BaseAddress;\r
\r
UINT64 Attributes;\r
///\r
/// Type of the memory region. Type EFI_GCD_MEMORY_TYPE is defined in the\r
- /// AddMemorySpace() function description\r
+ /// AddMemorySpace() function description.\r
/// \r
EFI_GCD_MEMORY_TYPE GcdMemoryType;\r
\r
} EFI_GCD_MEMORY_SPACE_DESCRIPTOR;\r
\r
///\r
-/// EFI_GCD_IO_SPACE_DESCRIPTOR\r
+/// EFI_GCD_IO_SPACE_DESCRIPTOR.\r
/// \r
typedef struct {\r
///\r
added to the global coherency domain of the processor.\r
@retval EFI_ACCESS_DENIED One or more bytes of the memory resource range\r
specified by BaseAddress and Length was allocated\r
- in a prior call to AllocateMemorySpace()..\r
+ in a prior call to AllocateMemorySpace().\r
\r
**/\r
typedef\r
@retval EFI_SUCCESS One or more DXE driver were dispatched.\r
@retval EFI_NOT_FOUND No DXE drivers were dispatched.\r
@retval EFI_ALREADY_STARTED An attempt is being made to start the DXE Dispatcher recursively.\r
- Thus no action was taken.\r
+ Thus, no action was taken.\r
\r
**/\r
typedef\r
\r
\r
/**\r
- Function prototype for invoking a function on an Application Processor.\r
+ The function prototype for invoking a function on an Application Processor.\r
\r
This definition is used by the UEFI MP Serices Protocol, and the\r
PI SMM System Table.\r
\r
- @param[in,out] Buffer Pointer to private data buffer.\r
+ @param[in,out] Buffer The pointer to private data buffer.\r
**/\r
typedef\r
VOID\r
/** @file\r
The firmware file related definitions in PI.\r
\r
- Copyright (c) 2006 - 2010, 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
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
+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
@par Revision Reference:\r
- PI Version 1.2\r
+ PI Version 1.2.\r
\r
**/\r
\r
\r
///\r
/// FFS_FIXED_CHECKSUM is the checksum value used when the\r
-/// FFS_ATTRIB_CHECKSUM attribute bit is clear\r
+/// FFS_ATTRIB_CHECKSUM attribute bit is clear.\r
///\r
#define FFS_FIXED_CHECKSUM 0xAA\r
\r
EFI_FFS_FILE_STATE State;\r
\r
///\r
- /// If FFS_ATTRIB_LARGE_FILE is set in Attributes then ExtendedSize exists and Size must be set to zero.\r
+ /// If FFS_ATTRIB_LARGE_FILE is set in Attributes, then ExtendedSize exists and Size must be set to zero.\r
/// If FFS_ATTRIB_LARGE_FILE is not set then EFI_FFS_FILE_HEADER is used.\r
///\r
EFI_FFS_FILE_STATE ExtendedSize;\r
typedef UINT8 EFI_SECTION_TYPE;\r
\r
///\r
-/// Pseudo type. It is\r
-/// used as a wild card when retrieving sections. The section\r
-/// type EFI_SECTION_ALL matches all section types.\r
+/// Pseudo type. It is used as a wild card when retrieving sections.\r
+/// The section type EFI_SECTION_ALL matches all section types.\r
///\r
#define EFI_SECTION_ALL 0x00\r
\r
///\r
-/// Encapsulation section Type values\r
+/// Encapsulation section Type values.\r
///\r
#define EFI_SECTION_COMPRESSION 0x01\r
\r
#define EFI_SECTION_DISPOSABLE 0x03\r
\r
///\r
-/// Leaf section Type values\r
+/// Leaf section Type values.\r
///\r
#define EFI_SECTION_PE32 0x10\r
#define EFI_SECTION_PIC 0x11\r
#define EFI_SECTION_SMM_DEPEX 0x1C\r
\r
///\r
-/// Common section header\r
+/// Common section header.\r
/// \r
typedef struct {\r
///\r
EFI_SECTION_TYPE Type;\r
\r
///\r
- /// If Size is 0xFFFFFF then ExtendedSize contains the size of the section. If\r
- /// Size is not equal to 0xFFFFFF then this field does not exist. \r
+ /// If Size is 0xFFFFFF, then ExtendedSize contains the size of the section. If\r
+ /// Size is not equal to 0xFFFFFF, then this field does not exist. \r
///\r
UINT32 ExtendedSize;\r
} EFI_COMMON_SECTION_HEADER2;\r
///\r
EFI_COMMON_SECTION_HEADER CommonHeader;\r
///\r
- /// UINT32 that indicates the size of the section data after decompression.\r
+ /// The UINT32 that indicates the size of the section data after decompression.\r
///\r
UINT32 UncompressedLength;\r
///\r
typedef EFI_COMMON_SECTION_HEADER2 EFI_DISPOSABLE_SECTION2;\r
\r
///\r
-/// Leaf section which could be used to determine the dispatch order of DXEs.\r
+/// The leaf section which could be used to determine the dispatch order of DXEs.\r
/// \r
typedef EFI_COMMON_SECTION_HEADER EFI_DXE_DEPEX_SECTION;\r
typedef EFI_COMMON_SECTION_HEADER2 EFI_DXE_DEPEX_SECTION2;\r
\r
///\r
-/// Leaf section which contains a PI FV.\r
+/// The leaf section which contains a PI FV.\r
/// \r
typedef EFI_COMMON_SECTION_HEADER EFI_FIRMWARE_VOLUME_IMAGE_SECTION;\r
typedef EFI_COMMON_SECTION_HEADER2 EFI_FIRMWARE_VOLUME_IMAGE_SECTION2;\r
\r
///\r
-/// Leaf section which contains a single GUID.\r
+/// The leaf section which contains a single GUID.\r
/// \r
typedef struct {\r
///\r
\r
typedef struct {\r
///\r
- /// Common section header. CommonHeader.Type = EFI_SECTION_FREEFORM_SUBTYPE_GUID.\r
+ /// The common section header. CommonHeader.Type = EFI_SECTION_FREEFORM_SUBTYPE_GUID.\r
///\r
EFI_COMMON_SECTION_HEADER2 CommonHeader;\r
///\r
} EFI_FREEFORM_SUBTYPE_GUID_SECTION2;\r
\r
///\r
-/// Attributes of EFI_GUID_DEFINED_SECTION\r
+/// Attributes of EFI_GUID_DEFINED_SECTION.\r
/// \r
#define EFI_GUIDED_SECTION_PROCESSING_REQUIRED 0x01\r
#define EFI_GUIDED_SECTION_AUTH_STATUS_VALID 0x02\r
///\r
-/// Leaf section which is encapsulation defined by specific GUID\r
+/// The leaf section which is encapsulation defined by specific GUID.\r
/// \r
typedef struct {\r
///\r
- /// Common section header. CommonHeader.Type = EFI_SECTION_GUID_DEFINED.\r
+ /// The common section header. CommonHeader.Type = EFI_SECTION_GUID_DEFINED.\r
///\r
EFI_COMMON_SECTION_HEADER CommonHeader;\r
///\r
- /// GUID that defines the format of the data that follows. It is a vendor-defined section type.\r
+ /// The GUID that defines the format of the data that follows. It is a vendor-defined section type.\r
///\r
EFI_GUID SectionDefinitionGuid;\r
///\r
///\r
UINT16 DataOffset;\r
///\r
- /// Bit field that declares some specific characteristics of the section contents.\r
+ /// The bit field that declares some specific characteristics of the section contents.\r
///\r
UINT16 Attributes;\r
} EFI_GUID_DEFINED_SECTION;\r
\r
typedef struct {\r
///\r
- /// Common section header. CommonHeader.Type = EFI_SECTION_GUID_DEFINED.\r
+ /// The common section header. CommonHeader.Type = EFI_SECTION_GUID_DEFINED.\r
///\r
EFI_COMMON_SECTION_HEADER2 CommonHeader;\r
///\r
- /// GUID that defines the format of the data that follows. It is a vendor-defined section type.\r
+ /// The GUID that defines the format of the data that follows. It is a vendor-defined section type.\r
/// \r
EFI_GUID SectionDefinitionGuid;\r
///\r
/// \r
UINT16 DataOffset;\r
///\r
- /// Bit field that declares some specific characteristics of the section contents.\r
+ /// The bit field that declares some specific characteristics of the section contents.\r
/// \r
UINT16 Attributes;\r
} EFI_GUID_DEFINED_SECTION2;\r
\r
///\r
-/// Leaf section which contains PE32+ image.\r
+/// The leaf section which contains PE32+ image.\r
/// \r
typedef EFI_COMMON_SECTION_HEADER EFI_PE32_SECTION;\r
typedef EFI_COMMON_SECTION_HEADER2 EFI_PE32_SECTION2;\r
\r
///\r
-/// Leaf section which used to determine the dispatch order of PEIMs.\r
+/// The leaf section used to determine the dispatch order of PEIMs.\r
/// \r
typedef EFI_COMMON_SECTION_HEADER EFI_PEI_DEPEX_SECTION;\r
typedef EFI_COMMON_SECTION_HEADER2 EFI_PEI_DEPEX_SECTION2;\r
typedef EFI_COMMON_SECTION_HEADER2 EFI_PIC_SECTION2;\r
\r
///\r
-/// Leaf section which constains the position-independent-code image.\r
+/// The leaf section which constains the position-independent-code image.\r
/// \r
typedef EFI_COMMON_SECTION_HEADER EFI_TE_SECTION;\r
typedef EFI_COMMON_SECTION_HEADER2 EFI_TE_SECTION2;\r
\r
///\r
-/// Leaf section which contains an array of zero or more bytes.\r
+/// The leaf section which contains an array of zero or more bytes.\r
/// \r
typedef EFI_COMMON_SECTION_HEADER EFI_RAW_SECTION;\r
typedef EFI_COMMON_SECTION_HEADER2 EFI_RAW_SECTION2;\r
/// The SMM dependency expression section is a leaf section that contains a dependency expression that\r
/// is used to determine the dispatch order for SMM drivers. Before the SMRAM invocation of the\r
/// SMM driver's entry point, this dependency expression must evaluate to TRUE. See the Platform\r
-/// Initialization Specification, Volume 2for details regarding the format of the dependency expression.\r
+/// Initialization Specification, Volume 2, for details regarding the format of the dependency expression.\r
/// The dependency expression may refer to protocols installed in either the UEFI or the SMM protocol\r
/// database. EFI_SMM_DEPEX_SECTION2 must be used if the section is 16MB or larger.\r
/// \r
typedef EFI_COMMON_SECTION_HEADER2 EFI_SMM_DEPEX_SECTION2;\r
\r
///\r
-/// Leaf section which contains a unicode string that \r
+/// The leaf section which contains a unicode string that \r
/// is human readable file name.\r
/// \r
typedef struct {\r
} EFI_USER_INTERFACE_SECTION2;\r
\r
///\r
-/// Leaf section which contains a numeric build number and\r
+/// The leaf section which contains a numeric build number and\r
/// an optional unicode string that represents the file revision. \r
/// \r
typedef struct {\r
/** @file\r
HOB related definitions in PI.\r
\r
- Copyright (c) 2006 - 2009, 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
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
+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
@par Revision Reference:\r
PI Version 1.0\r
\r
\r
///\r
-/// Value of version ofinEFI_HOB_HANDOFF_INFO_TABLE.\r
+/// Value of version in EFI_HOB_HANDOFF_INFO_TABLE.\r
/// \r
#define EFI_HOB_HANDOFF_TABLE_VERSION 0x0009\r
\r
EFI_HOB_GENERIC_HEADER Header;\r
///\r
/// The version number pertaining to the PHIT HOB definition.\r
- /// This value is 4 bytes in length to provide an 8-byte aligned entry \r
+ /// This value is four bytes in length to provide an 8-byte aligned entry \r
/// when it is combined with the 4-byte BootMode.\r
///\r
UINT32 Version;\r
\r
///\r
/// Describes the memory stack that is produced by the HOB producer \r
-/// phase and upon which all postmemory-installed executable\r
+/// phase and upon which all post-memory-installed executable\r
/// content in the HOB producer phase is executing.\r
/// \r
typedef struct {\r
} EFI_HOB_MEMORY_ALLOCATION_MODULE;\r
\r
///\r
-/// Resource type \r
+/// The resource type.\r
/// \r
typedef UINT32 EFI_RESOURCE_TYPE;\r
\r
#define EFI_RESOURCE_MAX_MEMORY_TYPE 0x00000007\r
\r
///\r
-/// type of recount attribute type\r
+/// A type of recount attribute type.\r
/// \r
typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE;\r
\r
///\r
EFI_GUID Owner;\r
///\r
- /// Resource type enumeration as defined by EFI_RESOURCE_TYPE.\r
+ /// The resource type enumeration as defined by EFI_RESOURCE_TYPE.\r
///\r
EFI_RESOURCE_TYPE ResourceType;\r
///\r
///\r
EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute;\r
///\r
- /// Physical start address of the resource region. \r
+ /// The physical start address of the resource region. \r
///\r
EFI_PHYSICAL_ADDRESS PhysicalStart;\r
///\r
- /// Number of bytes of the resource region.\r
+ /// The number of bytes of the resource region.\r
///\r
UINT64 ResourceLength;\r
} EFI_HOB_RESOURCE_DESCRIPTOR;\r
} EFI_HOB_FIRMWARE_VOLUME;\r
\r
///\r
-/// Details the location of a firmware volume which was extracted \r
+/// Details the location of a firmware volume that was extracted \r
/// from a file within another firmware volume.\r
/// \r
typedef struct {\r
///\r
EFI_GUID FvName;\r
///\r
- /// The name of the firmware file which contained this firmware volume.\r
+ /// The name of the firmware file that contained this firmware volume.\r
///\r
EFI_GUID FileName;\r
} EFI_HOB_FIRMWARE_VOLUME2;\r
///\r
/// The physical memory-mapped base address of an UEFI capsule. This value is set to\r
/// point to the base of the contiguous memory of the UEFI capsule.\r
- /// The length of the contiguous memory in bytes\r
+ /// The length of the contiguous memory in bytes.\r
///\r
EFI_PHYSICAL_ADDRESS BaseAddress;\r
UINT64 Length;\r
} EFI_HOB_UEFI_CAPSULE;\r
\r
///\r
-/// Union of all the possible HOB Types\r
+/// Union of all the possible HOB Types.\r
///\r
typedef union {\r
EFI_HOB_GENERIC_HEADER *Header;\r
/** @file\r
Include file matches things in PI for multiple module types.\r
\r
- Copyright (c) 2006 - 2010, 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
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
+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
@par Revision Reference:\r
- These elements are defined in UEFI Platform Initialization Specification 1.2 \r
+ These elements are defined in UEFI Platform Initialization Specification 1.2.\r
\r
**/\r
\r
#define EFI_NOT_AVAILABLE_YET DXE_ERROR (2)\r
\r
///\r
-/// Success and warning codes reserved for use by PI\r
-/// Supported 32-bit range is 0x20000000-0x3fffffff\r
-/// Supported 64-bit range is 0x2000000000000000-0x3fffffffffffffff\r
+/// Success and warning codes reserved for use by PI.\r
+/// Supported 32-bit range is 0x20000000-0x3fffffff.\r
+/// Supported 64-bit range is 0x2000000000000000-0x3fffffffffffffff.\r
///\r
#define PI_ENCODE_WARNING(a) ((MAX_BIT >> 2) | (a))\r
\r
///\r
-/// Error codes reserved for use by PI\r
-/// Supported 32-bit range is 0xa0000000-0xbfffffff\r
-/// Supported 64-bit range is 0xa000000000000000-0xbfffffffffffffff\r
+/// Error codes reserved for use by PI.\r
+/// Supported 32-bit range is 0xa0000000-0xbfffffff.\r
+/// Supported 64-bit range is 0xa000000000000000-0xbfffffffffffffff.\r
///\r
#define PI_ENCODE_ERROR(a) (MAX_BIT | (MAX_BIT >> 2) | (a))\r
\r
/// \r
-/// Return status codes defined in SMM CIS\r
+/// Return status codes defined in SMM CIS.\r
/// \r
#define EFI_INTERRUPT_PENDING PI_ENCODE_ERROR (0)\r
\r
/// and the EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI\r
///\r
/// xx00 Image was not signed.\r
-/// xxx1 Platform security policy override. Assumes same meaning as 0010 (the image was signed, the\r
+/// xxx1 Platform security policy override. Assumes the same meaning as 0010 (the image was signed, the\r
/// signature was tested, and the signature passed authentication test).\r
/// 0010 Image was signed, the signature was tested, and the signature passed authentication test.\r
/// 0110 Image was signed and the signature was not tested.\r
#define EFI_NEEDS_ECC_INITIALIZATION 0x00000040\r
\r
///\r
-/// Structure describing a SMRAM region and its accessibility attributes\r
+/// Structure describing a SMRAM region and its accessibility attributes.\r
///\r
typedef struct {\r
///\r
/** @file\r
PI PEI master include file. This file should match the PI spec.\r
\r
- Copyright (c) 2006 - 2010, 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
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php. \r
+ \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
+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
@par Revision Reference:\r
- PI Version 1.0\r
+ PI Version 1.0.\r
\r
**/\r
\r
#include <Pi/PiMultiPhase.h>\r
\r
///\r
-/// Handles of EFI FV.\r
+/// The handles of EFI FV.\r
/// \r
typedef VOID *EFI_PEI_FV_HANDLE;\r
\r
///\r
-/// Handles of EFI FFS\r
+/// The handles of EFI FFS.\r
/// \r
typedef VOID *EFI_PEI_FILE_HANDLE;\r
\r
///\r
-/// Declare forward reference data structure for EFI_PEI_SERVICE\r
+/// Declare the forward reference data structure for EFI_PEI_SERVICE.\r
/// \r
typedef struct _EFI_PEI_SERVICES EFI_PEI_SERVICES;\r
\r
///\r
-/// Declare forward reference data structure for EFI_PEI_NOTIFY_DESCRIPTOR\r
+/// Declare the forward reference data structure for EFI_PEI_NOTIFY_DESCRIPTOR.\r
/// \r
typedef struct _EFI_PEI_NOTIFY_DESCRIPTOR EFI_PEI_NOTIFY_DESCRIPTOR;\r
\r
/// \r
struct _EFI_PEI_NOTIFY_DESCRIPTOR {\r
///\r
- /// Details if the type of notification is callback or dispatch.\r
+ /// Details if the type of notification are callback or dispatch.\r
///\r
UINTN Flags;\r
///\r
@param PpiList A pointer to the list of interfaces that the caller shall install.\r
\r
@retval EFI_SUCCESS The interface was successfully installed.\r
- @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.\r
+ @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI \r
+ descriptors in the list do not have the \r
+ EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.\r
@retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r
\r
**/\r
@param NotifyList A pointer to the list of notification interfaces that the caller shall install.\r
\r
@retval EFI_SUCCESS The interface was successfully installed.\r
- @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the \r
+ @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL, or any of the PEI PPI descriptors in the \r
list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.\r
@retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
@param BootMode A pointer to contain the value of the boot mode.\r
\r
- @retval EFI_SUCCESS The boot mode was returned successfully.\r
+ @retval EFI_SUCCESS The boot mode returned successfully.\r
\r
**/\r
typedef\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r
@param BootMode The value of the boot mode to set.\r
\r
- @retval EFI_SUCCESS The boot mode was returned successfully.\r
+ @retval EFI_SUCCESS The boot mode returned successfully.\r
\r
**/\r
typedef\r
);\r
\r
/**\r
- This service published by the PEI Foundation abstracts the creation of a Hand-Off Block's (HOB's) headers.\r
+ This service, published by the PEI Foundation, abstracts the creation of a Hand-Off Block's (HOB's) headers.\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
@param Type The type of HOB to be installed.\r
This service will search within encapsulation sections (compression and GUIDed) as well. It will\r
search inside of a GUIDed section or a compressed section, but may not, for example, search a\r
GUIDed section inside a GUIDes section.\r
- This service will not search within compression sections or GUIDed sections which require\r
+ This service will not search within compression sections or GUIDed sections that require\r
extraction if memory is not present.\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
This function registers the found memory configuration with the PEI Foundation.\r
\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
- @param MemoryBegin The value of a region of installed memory\r
+ @param MemoryBegin The value of a region of installed memory.\r
@param MemoryLength The corresponding length of a region of installed memory.\r
\r
@retval EFI_SUCCESS The region was successfully installed in a HOB.\r
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
@param MemoryType The type of memory to allocate.\r
@param Pages The number of contiguous 4 KB pages to allocate.\r
- @param Memory Pointer to a physical address. On output, the address is set to the base \r
+ @param Memory A pointer to a physical address. On output, the address is set to the base \r
of the page range that was allocated.\r
\r
@retval EFI_SUCCESS The memory range was successfully allocated.\r
@retval EFI_OUT_OF_RESOURCES The pages could not be allocated.\r
- @retval EFI_INVALID_PARAMETER Type is not equal to EfiLoaderCode, EfiLoaderData, EfiRuntimeServicesCode, \r
+ @retval EFI_INVALID_PARAMETER The type is not equal to EfiLoaderCode, EfiLoaderData, EfiRuntimeServicesCode, \r
EfiRuntimeServicesData, EfiBootServicesCode, EfiBootServicesData,\r
EfiACPIReclaimMemory, or EfiACPIMemoryNVS.\r
\r
/**\r
This service copies the contents of one buffer to another buffer.\r
\r
- @param Destination Pointer to the destination buffer of the memory copy.\r
- @param Source Pointer to the source buffer of the memory copy\r
- @param Length Number of bytes to copy from Source to Destination.\r
+ @param Destination The pointer to the destination buffer of the memory copy.\r
+ @param Source The pointer to the source buffer of the memory copy.\r
+ @param Length The number of bytes to copy from Source to Destination.\r
\r
**/\r
typedef\r
/**\r
The service fills a buffer with a specified value.\r
\r
- @param Buffer Pointer to the buffer to fill.\r
- @param Size Number of bytes in Buffer to fill.\r
- @param Value Value to fill Buffer with\r
+ @param Buffer The pointer to the buffer to fill.\r
+ @param Size The number of bytes in Buffer to fill.\r
+ @param Value The value to fill Buffer with.\r
\r
**/\r
typedef\r
@param FileHandle Upon exit, points to the found file's\r
handle or NULL if it could not be found.\r
\r
- @retval EFI_SUCCESS File was found.\r
- @retval EFI_NOT_FOUND File was not found.\r
+ @retval EFI_SUCCESS The file was found.\r
+ @retval EFI_NOT_FOUND The file was not found.\r
@retval EFI_INVALID_PARAMETER VolumeHandle or FileHandle or\r
FileName was NULL.\r
\r
);\r
\r
///\r
-/// Information of FV file.\r
+/// The information of the FV file.\r
///\r
typedef struct {\r
///\r
\r
This function returns information about a specific file,\r
including its file name, type, attributes, starting address and\r
- size. If the firmware volume is not memory mapped then the\r
+ size. If the firmware volume is not memory mapped, then the\r
Buffer member will be NULL.\r
\r
- @param FileHandle Handle of the file.\r
+ @param FileHandle The handle of the file.\r
@param FileInfo Upon exit, points to the file's\r
information.\r
\r
- @retval EFI_SUCCESS File information returned.\r
- @retval EFI_INVALID_PARAMETER If FileHandle does not\r
+ @retval EFI_SUCCESS File information was returned.\r
+ @retval EFI_INVALID_PARAMETER FileHandle does not\r
represent a valid file.\r
- @retval EFI_INVALID_PARAMETER If FileInfo is NULL.\r
+ @retval EFI_INVALID_PARAMETER FileInfo is NULL.\r
\r
**/\r
typedef\r
);\r
\r
///\r
-/// Information of FV volume.\r
+/// The information of the FV volume.\r
///\r
typedef struct {\r
///\r
@param VolumeHandle Handle of the volume.\r
@param VolumeInfo Upon exit, points to the volume's information.\r
\r
- @retval EFI_SUCCESS Volume information returned.\r
+ @retval EFI_SUCCESS The volume information returned.\r
@retval EFI_INVALID_PARAMETER If VolumeHandle does not represent a valid volume.\r
@retval EFI_INVALID_PARAMETER If VolumeHandle is NULL.\r
- @retval EFI_SUCCESS Information successfully returned.\r
+ @retval EFI_SUCCESS Information was successfully returned.\r
@retval EFI_INVALID_PARAMETER The volume designated by the VolumeHandle is not available.\r
\r
**/\r
#define PEI_SPECIFICATION_MAJOR_REVISION 1\r
#define PEI_SPECIFICATION_MINOR_REVISION 10\r
///\r
-/// Inconsistent with specification here: \r
-/// In PI1.0 spec, PEI_SERVICES_SIGNATURE is defined as 0x5652455320494550. But \r
-/// to pass multiple tool chain, it is append a ULL.\r
+/// Specification inconsistency here: \r
+/// In the PI1.0 spec, PEI_SERVICES_SIGNATURE is defined as 0x5652455320494550. But \r
+/// to pass a multiple tool chain, it appends an ULL.\r
///\r
//\r
// PEI Services Table\r
//\r
#define PEI_SERVICES_SIGNATURE 0x5652455320494550ULL\r
///\r
-/// Inconsistent with specification here: \r
-/// In PI1.0 spec, There is a typo error in PEI_SERVICES_REVISION. In the spec. the defintion is \r
+/// Specification inconsistency here: \r
+/// In the PI1.0 specification, there is a typo error in PEI_SERVICES_REVISION. In the specification the defintion is \r
/// #define ((PEI_SPECIFICATION_MAJOR_REVISION<<16) |(PEI_SPECIFICATION_MINOR_REVISION))\r
-/// and it should be as follow:\r
+/// and it should be as follows:\r
///\r
#define PEI_SERVICES_REVISION ((PEI_SPECIFICATION_MAJOR_REVISION<<16) | (PEI_SPECIFICATION_MINOR_REVISION))\r
\r
/// - Allocating both early and permanent memory\r
/// - Supporting the Firmware File System (FFS)\r
/// - Abstracting the PPI database abstraction\r
-/// - Creating Hand-Off Blocks (HOBs)\r
+/// - Creating Hand-Off Blocks (HOBs).\r
///\r
struct _EFI_PEI_SERVICES {\r
///\r
\r
\r
///\r
-/// EFI_SEC_PEI_HAND_OFF structure hold information about\r
+/// EFI_SEC_PEI_HAND_OFF structure holds information about\r
/// PEI core's operating environment, such as the size of location of\r
/// temporary RAM, the stack location and BFV location.\r
/// \r
VOID *PeiTemporaryRamBase;\r
\r
///\r
- /// Size of the available temporary RAM available for \r
+ /// The size of the available temporary RAM available for \r
/// use by the PEI Foundation, in bytes.\r
/// \r
UINTN PeiTemporaryRamSize;\r
\r
\r
/**\r
- Entry point of PEI Foundation.\r
+ The entry point of PEI Foundation.\r
\r
This function is the entry point for the PEI Foundation, which\r
allows the SEC phase to pass information about the stack,\r
/** @file\r
StatusCode related definitions in PI.\r
\r
- Copyright (c) 2009, 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
+Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
+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
@par Revision Reference:\r
- These status codes are defined in UEFI Platform Initialization Specification 1.2 \r
- Volume 3: Shared Architectural Elements\r
+ These status codes are defined in UEFI Platform Initialization Specification 1.2, \r
+ Volume 3: Shared Architectural Elements.\r
\r
**/\r
\r
#include <Protocol/DebugSupport.h>\r
\r
///\r
-/// Status Code Type Definition\r
+/// Status Code Type Definition.\r
///\r
typedef UINT32 EFI_STATUS_CODE_TYPE;\r
\r
///\r
-/// A Status Code Type is made up of the code type and severity\r
+/// A Status Code Type is made up of the code type and severity.\r
/// All values masked by EFI_STATUS_CODE_RESERVED_MASK are\r
/// reserved for use by this specification.\r
///\r
///@}\r
\r
///\r
-/// Definition of code types, all other values masked by\r
+/// Definition of code types. All other values masked by\r
/// EFI_STATUS_CODE_TYPE_MASK are reserved for use by\r
/// this specification.\r
///\r
/// EFI_STATUS_CODE_SEVERITY_MASK are reserved for use by\r
/// this specification.\r
/// Uncontained errors are major errors that could not contained\r
-/// to the specific component that is reporting the error\r
+/// to the specific component that is reporting the error.\r
/// For example, if a memory error was not detected early enough,\r
/// the bad data could be consumed by other drivers.\r
///\r
///@}\r
\r
///\r
-/// Status Code Value Definition\r
+/// Status Code Value Definition.\r
///\r
typedef UINT32 EFI_STATUS_CODE_VALUE;\r
\r
} EFI_STATUS_CODE_DATA;\r
\r
///\r
-/// General partitioning scheme for Progress and Error Codes are\r
-/// - 0x0000-0x0FFF Shared by all sub-classes in a given class\r
-/// - 0x1000-0x7FFF Subclass Specific\r
-/// - 0x8000-0xFFFF OEM specific\r
+/// General partitioning scheme for Progress and Error Codes are:\r
+/// - 0x0000-0x0FFF Shared by all sub-classes in a given class.\r
+/// - 0x1000-0x7FFF Subclass Specific.\r
+/// - 0x8000-0xFFFF OEM specific.\r
///@{\r
#define EFI_SUBCLASS_SPECIFIC 0x1000\r
#define EFI_OEM_SPECIFIC 0x8000\r
///@}\r
\r
///\r
-/// Debug Code definitions for all classes and subclass\r
+/// Debug Code definitions for all classes and subclass.\r
/// Only one debug code is defined at this point and should\r
-/// be used for anything that gets sent to debug stream.\r
+/// be used for anything that is sent to the debug stream.\r
///\r
///@{\r
#define EFI_DC_UNSPECIFIED 0x0\r
///@}\r
\r
///\r
-/// Class definitions\r
+/// Class definitions.\r
/// Values of 4-127 are reserved for future use by this specification.\r
/// Values in the range 127-255 are reserved for OEM use.\r
///\r
//\r
\r
///\r
-/// South Bridge initialization prior to memory detection\r
+/// South Bridge initialization prior to memory detection.\r
///\r
#define EFI_CHIPSET_PC_PEI_CAR_SB_INIT (EFI_SUBCLASS_SPECIFIC|0x00000000)\r
\r
///\r
-/// North Bridge initialization prior to memory detection\r
+/// North Bridge initialization prior to memory detection.\r
///\r
#define EFI_CHIPSET_PC_PEI_CAR_NB_INIT (EFI_SUBCLASS_SPECIFIC|0x00000001)\r
\r
///\r
-/// South Bridge initialization after memory detection\r
+/// South Bridge initialization after memory detection.\r
///\r
#define EFI_CHIPSET_PC_PEI_MEM_SB_INIT (EFI_SUBCLASS_SPECIFIC|0x00000002)\r
\r
///\r
-/// North Bridge initialization after memory detection\r
+/// North Bridge initialization after memory detection.\r
///\r
#define EFI_CHIPSET_PC_PEI_MEM_NB_INIT (EFI_SUBCLASS_SPECIFIC|0x00000003)\r
\r
///\r
-/// PCI Host Bridge DXE initialization\r
+/// PCI Host Bridge DXE initialization.\r
///\r
#define EFI_CHIPSET_PC_DXE_HB_INIT (EFI_SUBCLASS_SPECIFIC|0x00000004)\r
\r
///\r
-/// North Bridge DXE initialization\r
+/// North Bridge DXE initialization.\r
///\r
#define EFI_CHIPSET_PC_DXE_NB_INIT (EFI_SUBCLASS_SPECIFIC|0x00000005)\r
\r
///\r
-/// North Bridge specific SMM initialization in DXE\r
+/// North Bridge specific SMM initialization in DXE.\r
///\r
#define EFI_CHIPSET_PC_DXE_NB_SMM_INIT (EFI_SUBCLASS_SPECIFIC|0x00000006)\r
\r
///\r
-/// Initialization of the South Bridge specific UEFI Runtime Services\r
+/// Initialization of the South Bridge specific UEFI Runtime Services.\r
///\r
#define EFI_CHIPSET_PC_DXE_SB_RT_INIT (EFI_SUBCLASS_SPECIFIC|0x00000007)\r
\r
#define EFI_CHIPSET_PC_DXE_SB_INIT (EFI_SUBCLASS_SPECIFIC|0x00000008)\r
\r
///\r
-/// South Bridge specific SMM initialization in DXE\r
+/// South Bridge specific SMM initialization in DXE.\r
///\r
#define EFI_CHIPSET_PC_DXE_SB_SMM_INIT (EFI_SUBCLASS_SPECIFIC|0x00000009)\r
\r
///\r
-/// Initialization of the South Bridge devices\r
+/// Initialization of the South Bridge devices.\r
///\r
#define EFI_CHIPSET_PC_DXE_SB_DEVICES_INIT (EFI_SUBCLASS_SPECIFIC|0x0000000a)\r
\r
\r
Root include file for Mde Package DXE_CORE, DXE, RUNTIME, SMM, SAL type modules.\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
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
modules only use types defined via this include file and can\r
be ported easily to any environment. \r
\r
-Copyright (c) 2006 - 2009, 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
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
Root include file for Mde Package SMM modules.\r
\r
-Copyright (c) 2009, 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
+Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
Block I/O PPIs that are provided by the PEI ATAPI driver and PEI legacy floppy \r
driver are the same, here we define a set of general PPIs for both drivers to use.\r
\r
- Copyright (c) 2007 - 2009, 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
+Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
+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
@par Revision Reference:\r
This PPI is defined in UEFI Platform Initialization Specification 1.2 Volume 1: \r
- Pre-EFI Initalization Core Interface\r
+ Pre-EFI Initalization Core Interface.\r
\r
**/\r
\r
}\r
\r
///\r
-/// Forward declaration for EFI_PEI_RECOVERY_BLOCK_IO_PPI\r
+/// The forward declaration for EFI_PEI_RECOVERY_BLOCK_IO_PPI.\r
///\r
typedef struct _EFI_PEI_RECOVERY_BLOCK_IO_PPI EFI_PEI_RECOVERY_BLOCK_IO_PPI;\r
\r
///\r
-/// All blocks on the recovery device are addressed with a 64-bit Logical Block Address (LBA)\r
+/// All blocks on the recovery device are addressed with a 64-bit Logical Block Address (LBA).\r
///\r
typedef UINT64 EFI_PEI_LBA;\r
\r
} EFI_PEI_BLOCK_DEVICE_TYPE;\r
\r
///\r
-/// Inconsistent with specification here: \r
+/// Specification inconsistency here: \r
/// PEI_BLOCK_IO_MEDIA has been changed to EFI_PEI_BLOCK_IO_MEDIA.\r
/// Inconsistency exists in UEFI Platform Initialization Specification 1.2 \r
/// Volume 1: Pre-EFI Initalization Core Interface, where all referrences to \r
/// this structure name are with the "EFI_" prefix, except for the definition \r
/// which is without "EFI_". So the name of PEI_BLOCK_IO_MEDIA is taken as the \r
-/// exception, and EFI_PEI_BLOCK_IO_MEDIA is used to comply with most part of \r
+/// exception, and EFI_PEI_BLOCK_IO_MEDIA is used to comply with most of \r
/// the specification.\r
///\r
typedef struct {\r
instance.\r
@param[out] NumberBlockDevices The number of block I/O devices discovered.\r
\r
- @retval EFI_SUCCESS Operation performed successfully.\r
+ @retval EFI_SUCCESS The operation performed successfully.\r
\r
**/\r
typedef\r
order also applies to nested partitions, such as legacy MBR, where the \r
outermost partitions would have precedence in the reporting order. The \r
same logic applies to systems such as IDE that have precedence relationships \r
- like "Master/Slave" or "Primary/Secondary"; the master device should be \r
+ like "Master/Slave" or "Primary/Secondary". The master device should be \r
reported first, the slave second.\r
\r
@retval EFI_SUCCESS Media information about the specified block device \r
@param[in] This Indicates the EFI_PEI_RECOVERY_BLOCK_IO_PPI instance.\r
@param[in] DeviceIndex Specifies the block device to which the function wants \r
to talk. Because the driver that implements Block I/O \r
- PPIs will manage multiple block devices, the PPIs that \r
+ PPIs will manage multiple block devices, PPIs that \r
want to talk to a single device must specify the device \r
index that was assigned during the enumeration process. \r
This index is a number from one to NumberBlockDevices.\r
This PPI provides a set of memory and I/O-based services. \r
The perspective of the services is that of the processor, not the bus or system.\r
\r
- Copyright (c) 2006 - 2010, 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
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
+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
@par Revision Reference:\r
This PPI is introduced in PI Version 1.0.\r
typedef struct _EFI_PEI_CPU_IO_PPI EFI_PEI_CPU_IO_PPI;\r
\r
///\r
-/// EFI_PEI_CPU_IO_PPI_WIDTH\r
+/// EFI_PEI_CPU_IO_PPI_WIDTH.\r
///\r
typedef enum {\r
EfiPeiCpuIoWidthUint8,\r
\r
@param[in] PeiServices An indirect pointer to the PEI Services Table\r
published by the PEI Foundation.\r
- @param[in] This Pointer to local data for the interface.\r
+ @param[in] This The pointer to local data for the interface.\r
@param[in] Width The width of the access. Enumerated in bytes.\r
@param[in] Address The physical address of the access.\r
@param[in] Count The number of accesses to perform.\r
\r
@param[in] PeiServices An indirect pointer to the PEI Services Table published \r
by the PEI Foundation.\r
- @param[in] This Pointer to local data for the interface.\r
+ @param[in] This The pointer to local data for the interface.\r
@param[in] Address The physical address of the access.\r
\r
@return An 8-bit value returned from the I/O space.\r
\r
@param[in] PeiServices An indirect pointer to the PEI Services Table published \r
by the PEI Foundation.\r
- @param[in] This Pointer to local data for the interface.\r
+ @param[in] This The pointer to local data for the interface.\r
@param[in] Address The physical address of the access.\r
\r
@return A 16-bit value returned from the I/O space.\r
\r
@param[in] PeiServices An indirect pointer to the PEI Services Table published \r
by the PEI Foundation.\r
- @param[in] This Pointer to local data for the interface.\r
+ @param[in] This The pointer to local data for the interface.\r
@param[in] Address The physical address of the access.\r
\r
@return A 32-bit value returned from the I/O space.\r
\r
@param[in] PeiServices An indirect pointer to the PEI Services Table published \r
by the PEI Foundation.\r
- @param[in] This Pointer to local data for the interface.\r
+ @param[in] This The pointer to local data for the interface.\r
@param[in] Address The physical address of the access.\r
\r
@return A 64-bit value returned from the I/O space.\r
\r
@param[in] PeiServices An indirect pointer to the PEI Services Table published \r
by the PEI Foundation.\r
- @param[in] This Pointer to local data for the interface.\r
+ @param[in] This The pointer to local data for the interface.\r
@param[in] Address The physical address of the access.\r
@param[in] Data The data to write.\r
\r
\r
@param[in] PeiServices An indirect pointer to the PEI Services Table published \r
by the PEI Foundation.\r
- @param[in] This Pointer to local data for the interface.\r
+ @param[in] This The pointer to local data for the interface.\r
@param[in] Address The physical address of the access.\r
@param[in] Data The data to write.\r
\r
\r
@param[in] PeiServices An indirect pointer to the PEI Services Table published \r
by the PEI Foundation.\r
- @param[in] This Pointer to local data for the interface.\r
+ @param[in] This The pointer to local data for the interface.\r
@param[in] Address The physical address of the access.\r
@param[in] Data The data to write.\r
\r
\r
@param[in] PeiServices An indirect pointer to the PEI Services Table published \r
by the PEI Foundation.\r
- @param[in] This Pointer to local data for the interface.\r
+ @param[in] This The pointer to local data for the interface.\r
@param[in] Address The physical address of the access.\r
@param[in] Data The data to write.\r
\r
\r
@param[in] PeiServices An indirect pointer to the PEI Services Table published \r
by the PEI Foundation.\r
- @param[in] This Pointer to local data for the interface.\r
+ @param[in] This The pointer to local data for the interface.\r
@param[in] Address The physical address of the access.\r
\r
@return An 8-bit value returned from the memory space.\r
\r
@param[in] PeiServices An indirect pointer to the PEI Services Table published \r
by the PEI Foundation.\r
- @param[in] This Pointer to local data for the interface.\r
+ @param[in] This The pointer to local data for the interface.\r
@param[in] Address The physical address of the access.\r
\r
@return A 16-bit value returned from the memory space.\r
\r
@param[in] PeiServices An indirect pointer to the PEI Services Table published \r
by the PEI Foundation.\r
- @param[in] This Pointer to local data for the interface.\r
+ @param[in] This The pointer to local data for the interface.\r
@param[in] Address The physical address of the access.\r
\r
@return A 32-bit value returned from the memory space.\r
\r
@param[in] PeiServices An indirect pointer to the PEI Services Table published \r
by the PEI Foundation.\r
- @param[in] This Pointer to local data for the interface.\r
+ @param[in] This The pointer to local data for the interface.\r
@param[in] Address The physical address of the access.\r
\r
@return A 64-bit value returned from the memory space.\r
\r
@param[in] PeiServices An indirect pointer to the PEI Services Table published \r
by the PEI Foundation.\r
- @param[in] This Pointer to local data for the interface.\r
+ @param[in] This The pointer to local data for the interface.\r
@param[in] Address The physical address of the access.\r
@param[in] Data The data to write.\r
\r
\r
@param[in] PeiServices An indirect pointer to the PEI Services Table published \r
by the PEI Foundation.\r
- @param[in] This Pointer to local data for the interface.\r
+ @param[in] This The pointer to local data for the interface.\r
@param[in] Address The physical address of the access.\r
@param[in] Data The data to write.\r
\r
\r
@param[in] PeiServices An indirect pointer to the PEI Services Table published \r
by the PEI Foundation.\r
- @param[in] This Pointer to local data for the interface.\r
+ @param[in] This The pointer to local data for the interface.\r
@param[in] Address The physical address of the access.\r
@param[in] Data The data to write.\r
\r
\r
@param[in] PeiServices An indirect pointer to the PEI Services Table published \r
by the PEI Foundation.\r
- @param[in] This Pointer to local data for the interface.\r
+ @param[in] This The pointer to local data for the interface.\r
@param[in] Address The physical address of the access.\r
@param[in] Data The data to write.\r
\r
\r
///\r
/// EFI_PEI_CPU_IO_PPI provides a set of memory and I/O-based services.\r
-/// The perspective of the services is that of the processor, not the bus or system.\r
+/// The perspective of the services is that of the processor, not that of the \r
+/// bus or system.\r
///\r
struct _EFI_PEI_CPU_IO_PPI {\r
///\r
The interfaces for dynamic type PCD do not require the token space guid as parameter,\r
but interfaces for dynamic-ex type PCD require token space guid as parameter.\r
\r
- Copyright (c) 2006 - 2010, 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
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
+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
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
the maximum size supported for this TokenNumber.\r
@param[in] Buffer The buffer to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
the maximum size supported for this TokenNumber.\r
@param[in] Buffer The buffer to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
@param[in, out] Guid An indirect pointer to EFI_GUID. On input it designates a known \r
token namespace from which the search will start. On output, it designates \r
the next valid token namespace on the platform. If the input token namespace \r
- does not exist on the platform, an error is returned and the value of *Guid is \r
+ does not exist on the platform, an error is returned, and the value of *Guid is \r
undefined.\r
\r
@retval EFI_SUCCESS The PCD service has retrieved the next valid token namespace. \r
This file declares Read-only Variable Service2 PPI.\r
This ppi permits read-only access to the UEFI variable store during the PEI phase.\r
\r
- Copyright (c) 2006 - 2010, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@par Revision Reference:\r
This PPI is introduced in PI Version 1.0.\r
environment and also encapsulates knowledge of at least the \r
location of the Boot Firmware Volume (BFV).\r
\r
- Copyright (c) 2006 - 2010, 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
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
+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
@par Revision Reference:\r
This PPI is introduced in PI Version 1.0.\r
///\r
UINT32 Reserved1 :13;\r
///\r
- /// A 1-bit field. If set to 1, indicates that virtual\r
+ /// A 1-bit field. If set to 1, this indicates that virtual\r
/// memory features are not available.\r
///\r
UINT32 VirtualMemoryUnavailable : 1;\r
///\r
- /// A 1-bit field. If set to 1, indicates that IA-32 execution\r
+ /// A 1-bit field. If set to 1, this indicates that IA-32 execution\r
/// is not available.\r
///\r
UINT32 Ia32ExecutionUnavailable : 1;\r
///\r
- /// A 1-bit field. If set to 1, indicates that the floating\r
+ /// A 1-bit field. If set to 1, this indicates that the floating\r
/// point unit is not available.\r
///\r
UINT32 FloatingPointUnavailable : 1;\r
///\r
- /// A 1-bit field. If set to 1, indicates miscellaneous\r
+ /// A 1-bit field. If set to 1, this indicates miscellaneous\r
/// functional failure other than vm, ia, or fp.\r
/// The test status field provides additional information on\r
/// test failures when the State field returns a value of\r
UINT8 EidMask;\r
UINT16 Reserved4;\r
///\r
- /// Address to make PAL calls\r
+ /// Address to make PAL calls.\r
///\r
UINT64 PalCallAddress;\r
///\r
///\r
UINT64 PalSpecialAddress;\r
///\r
- /// GR35 from PALE_EXIT state\r
+ /// GR35 from PALE_EXIT state.\r
///\r
UINT64 SelfTestStatus;\r
///\r
} ITANIUM_HANDOFF_STATUS;\r
\r
///\r
-/// EFI_SEC_PLATFORM_INFORMATION_RECORD\r
+/// EFI_SEC_PLATFORM_INFORMATION_RECORD.\r
///\r
typedef union {\r
IA32_HANDOFF_STATUS IA32HealthFlags;\r
PEI Foundation. As such, if the platform supports the built-in self test (BIST) on IA-32 Intel\r
architecture or the PAL-A handoff state for Itanium architecture, this information is encapsulated\r
into the data structure abstracted by this service. This information is collected for the boot-strap\r
- processor (BSP) on IA-32, and for Itanium architecture, it is available on all processors that execute\r
+ processor (BSP) on IA-32. For Itanium architecture, it is available on all processors that execute\r
the PEI Foundation.\r
\r
- @param PeiServices Pointer to the PEI Services Table.\r
- @param StructureSize Pointer to the variable describing size of the input buffer.\r
- @param PlatformInformationRecord Pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD.\r
+ @param PeiServices The pointer to the PEI Services Table.\r
+ @param StructureSize The pointer to the variable describing size of the input buffer.\r
+ @param PlatformInformationRecord The pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD.\r
\r
@retval EFI_SUCCESS The data was successfully returned.\r
@retval EFI_BUFFER_TOO_SMALL The buffer was too small. The current buffer size needed to\r
The EFI ARP Protocol provides services to map IP network\r
address to hardware address used by a data link protocol.\r
\r
- Copyright (c) 2006 - 2009, 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<BR> \r
- http://opensource.org/licenses/bsd-license.php \r
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
+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
@par Revision Reference: \r
- This Protocol is introduced in UEFI Specification 2.0\r
+ This Protocol was introduced in UEFI Specification 2.0.\r
\r
**/\r
\r
UINT16 SwAddressType;\r
\r
///\r
- /// Length of the hardware address.\r
+ /// The length of the hardware address.\r
///\r
UINT8 HwAddressLength;\r
\r
///\r
- /// Length of the protocol address.\r
+ /// The length of the protocol address.\r
///\r
UINT8 SwAddressLength;\r
} EFI_ARP_FIND_DATA;\r
UINT16 SwAddressType;\r
\r
///\r
- /// Length in bytes of the station's protocol address to register.\r
+ /// The length in bytes of the station's protocol address to register.\r
///\r
UINT8 SwAddressLength;\r
\r
///\r
- /// Pointer to the first byte of the protocol address to register. For\r
+ /// The pointer to the first byte of the protocol address to register. For\r
/// example, if SwAddressType is 0x0800 (IP), then\r
/// StationAddress points to the first byte of this station's IP\r
/// address stored in network byte order.\r
all the following ARP functions will use this information. Attempting to change \r
the protocol type or station address to a configured ARP instance will result in errors.\r
\r
- @param This Pointer to the EFI_ARP_PROTOCOL instance.\r
- @param ConfigData Pointer to the EFI_ARP_CONFIG_DATA structure.\r
+ @param This The pointer to the EFI_ARP_PROTOCOL instance.\r
+ @param ConfigData The pointer to the EFI_ARP_CONFIG_DATA structure.\r
\r
@retval EFI_SUCCESS The new station address was successfully\r
registered.\r
by the Add() function may be static (will not time out) or dynamic (will time out).\r
Default ARP cache timeout values are not covered in most network protocol \r
specifications (although RFC 1122 comes pretty close) and will only be \r
- discussed in general in this specification. The timeout values that are \r
+ discussed in general terms in this specification. The timeout values that are \r
used in the EFI Sample Implementation should be used only as a guideline. \r
Final product implementations of the EFI network stack should be tuned for \r
their expected network environments.\r
set to TRUE. If the found ARP cache entry is a permanent entry, it is not \r
affected by Refresh.\r
\r
- @param This Pointer to the EFI_ARP_PROTOCOL instance.\r
+ @param This The pointer to the EFI_ARP_PROTOCOL instance.\r
@param BySwAddress Set to TRUE to look for matching software protocol\r
addresses. Set to FALSE to look for matching\r
hardware protocol addresses.\r
- @param AddressBuffer Pointer to address buffer. Set to NULL to match\r
- all addresses.\r
+ @param AddressBuffer The pointer to the address buffer. Set to NULL \r
+ to match all addresses.\r
@param EntryLength The size of an entry in the entries buffer.\r
@param EntryCount The number of ARP cache entries that are found by\r
the specified criteria.\r
- @param Entries Pointer to the buffer that will receive the ARP\r
+ @param Entries The pointer to the buffer that will receive the ARP\r
cache entries.\r
@param Refresh Set to TRUE to refresh the timeout value of the\r
matching ARP cache entry.\r
/**\r
This function removes specified ARP cache entries.\r
\r
- @param This Pointer to the EFI_ARP_PROTOCOL instance.\r
+ @param This The pointer to the EFI_ARP_PROTOCOL instance.\r
@param BySwAddress Set to TRUE to delete matching protocol addresses.\r
Set to FALSE to delete matching hardware\r
addresses.\r
- @param AddressBuffer Pointer to the address buffer that is used as a\r
+ @param AddressBuffer The pointer to the address buffer that is used as a\r
key to look for the cache entry. Set to NULL to\r
delete all entries.\r
\r
This function delete all dynamic entries from the ARP cache that match the specified\r
software protocol type.\r
\r
- @param This Pointer to the EFI_ARP_PROTOCOL instance.\r
+ @param This The pointer to the EFI_ARP_PROTOCOL instance.\r
\r
@retval EFI_SUCCESS The cache has been flushed.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
This function tries to resolve the TargetSwAddress and optionally returns a\r
TargetHwAddress if it already exists in the ARP cache.\r
\r
- @param This Pointer to the EFI_ARP_PROTOCOL instance.\r
- @param TargetSwAddress Pointer to the protocol address to resolve.\r
- @param ResolvedEvent Pointer to the event that will be signaled when\r
+ @param This The pointer to the EFI_ARP_PROTOCOL instance.\r
+ @param TargetSwAddress The pointer to the protocol address to resolve.\r
+ @param ResolvedEvent The pointer to the event that will be signaled when\r
the address is resolved or some error occurs.\r
- @param TargetHwAddress Pointer to the buffer for the resolved hardware\r
+ @param TargetHwAddress The pointer to the buffer for the resolved hardware\r
address in network byte order.\r
\r
@retval EFI_SUCCESS The data is copied from the ARP cache into the\r
NULL, all the pending asynchronous requests that have been issued by This \r
instance will be cancelled and their corresponding events will be signaled.\r
\r
- @param This Pointer to the EFI_ARP_PROTOCOL instance.\r
- @param TargetSwAddress Pointer to the protocol address in previous\r
+ @param This The pointer to the EFI_ARP_PROTOCOL instance.\r
+ @param TargetSwAddress The pointer to the protocol address in previous\r
request session.\r
@param ResolvedEvent Pointer to the event that is used as the\r
notification event in previous request session.\r
This protocol is used on any device handle to obtain authentication information \r
associated with the physical or logical device.\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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
AUTH_NODE_HEADER Header;\r
\r
///\r
- /// RADIUS Server IPv4 or IPv6 Address\r
+ /// RADIUS Server IPv4 or IPv6 Address.\r
///\r
- UINT8 RadiusIpAddr[16]; ///< IPv4 or IPv6 address\r
+ UINT8 RadiusIpAddr[16]; ///< IPv4 or IPv6 address.\r
\r
///\r
- /// Reserved for future use\r
+ /// Reserved for future use.\r
///\r
UINT16 Reserved;\r
\r
///\r
- /// Network Access Server IPv4 or IPv6 Address (OPTIONAL)\r
+ /// Network Access Server IPv4 or IPv6 Address (OPTIONAL).\r
///\r
- UINT8 NasIpAddr[16]; ///< IPv4 or IPv6 address\r
+ UINT8 NasIpAddr[16]; ///< IPv4 or IPv6 address.\r
\r
///\r
/// Network Access Server Secret Length in bytes (OPTIONAL)\r
UINT16 NasSecretLength; \r
\r
///\r
- /// Network Access Server Secret (OPTIONAL)\r
+ /// Network Access Server Secret (OPTIONAL).\r
///\r
UINT8 NasSecret[1];\r
\r
///\r
/// UINT8 ChapSecret[];\r
///\r
- /// CHAP Initiator Name Length in bytes on offset ChapSecret + ChapSecretLength\r
+ /// CHAP Initiator Name Length in bytes on offset ChapSecret + ChapSecretLength.\r
///\r
/// UINT16 ChapNameLength;\r
///\r
AUTH_NODE_HEADER Header;\r
\r
///\r
- /// Reserved for future use\r
+ /// Reserved for future use.\r
///\r
UINT16 Reserved;\r
\r
///\r
- /// User Secret Length in bytes\r
+ /// User Secret Length in bytes.\r
///\r
UINT16 UserSecretLength;\r
\r
///\r
- /// User Secret\r
+ /// User Secret.\r
///\r
UINT8 UserSecret[1];\r
\r
///\r
- /// User Name Length in bytes on offset UserSecret + UserSecretLength\r
+ /// User Name Length in bytes on offset UserSecret + UserSecretLength.\r
///\r
/// UINT16 UserNameLength;\r
///\r
/**\r
Retrieves the authentication information associated with a particular controller handle.\r
\r
- @param[in] This Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL\r
- @param[in] ControllerHandle Handle to the Controller\r
- @param[out] Buffer Pointer to the authentication information.\r
+ @param[in] This The pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL.\r
+ @param[in] ControllerHandle The handle to the Controller.\r
+ @param[out] Buffer The pointer to the authentication information.\r
\r
- @retval EFI_SUCCESS Successfully retrieved authentication information for the given ControllerHandle\r
- @retval EFI_INVALID_PARAMETER No matching authentication information found for the given ControllerHandle\r
- @retval EFI_DEVICE_ERROR The authentication information could not be retrieved due to a\r
- hardware error.\r
+ @retval EFI_SUCCESS Successfully retrieved authentication information \r
+ for the given ControllerHandle.\r
+ @retval EFI_INVALID_PARAMETER No matching authentication information found for \r
+ the given ControllerHandle.\r
+ @retval EFI_DEVICE_ERROR The authentication information could not be retrieved \r
+ due to a hardware error.\r
\r
**/\r
typedef\r
/**\r
Set the authentication information for a given controller handle.\r
\r
- @param[in] This Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL\r
- @param[in] ControllerHandle Handle to the Controller\r
- @param[in] Buffer Pointer to the authentication information.\r
+ @param[in] This The pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL.\r
+ @param[in] ControllerHandle The handle to the Controller.\r
+ @param[in] Buffer The pointer to the authentication information.\r
\r
- @retval EFI_SUCCESS Successfully set authentication information for the given ControllerHandle\r
- @retval EFI_UNSUPPORTED If the platform policies do not allow setting of the authentication\r
- information.\r
- @retval EFI_DEVICE_ERROR The authentication information could not be configured due to a\r
- hardware error.\r
+ @retval EFI_SUCCESS Successfully set authentication information for the \r
+ given ControllerHandle.\r
+ @retval EFI_UNSUPPORTED If the platform policies do not allow setting of \r
+ the authentication information.\r
+ @retval EFI_DEVICE_ERROR The authentication information could not be configured \r
+ due to a hardware error.\r
@retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the data.\r
\r
**/\r
The EFI_BIS_PROTOCOL is used to check a digital signature of a data block \r
against a digital certificate for the purpose of an integrity and authorization check.\r
\r
- Copyright (c) 2006 - 2009, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@par Revision Reference: \r
- This Protocol is introduced in EFI Specification 1.10 \r
+ This Protocol is introduced in EFI Specification 1.10. \r
\r
**/\r
\r
/// EFI_BIS_DATA instances obtained from BIS must be freed by calling Free( ).\r
///\r
typedef struct {\r
- UINT32 Length; ///< Length of Data in 8 bit bytes.\r
+ UINT32 Length; ///< The length of Data in 8 bit bytes.\r
UINT8 *Data; ///< 32 Bit Flat Address of data.\r
} EFI_BIS_DATA;\r
\r
/// EFI_BIS_VERSION type.\r
///\r
typedef struct {\r
- UINT32 Major; ///< the major BIS version number.\r
- UINT32 Minor; ///< a minor BIS version number.\r
+ UINT32 Major; ///< The major BIS version number.\r
+ UINT32 Minor; ///< A minor BIS version number.\r
} EFI_BIS_VERSION;\r
\r
//\r
typedef struct {\r
BIS_CERT_ID CertificateID; ///< Truncated hash of platform Boot Object\r
BIS_ALG_ID AlgorithmID; ///< A signature algorithm number.\r
- UINT16 KeyLength; ///< Length of alg. keys in bits.\r
+ UINT16 KeyLength; ///< The length of alg. keys in bits.\r
} EFI_BIS_SIGNATURE_INFO;\r
\r
///\r
/// values for EFI_BIS_SIGNATURE_INFO.AlgorithmID.\r
-/// The exact numeric values come from\r
+/// The exact numeric values come from the\r
/// "Common Data Security Architecture (CDSA) Specification".\r
///\r
#define BIS_ALG_DSA (41) // CSSM_ALGID_DSA\r
#define BIS_CERT_ID_DSA BIS_ALG_DSA // CSSM_ALGID_DSA\r
#define BIS_CERT_ID_RSA_MD5 BIS_ALG_RSA_MD5 // CSSM_ALGID_MD5_WITH_RSA\r
///\r
-/// the mask value that gets applied to the truncated hash of a\r
+/// The mask value that gets applied to the truncated hash of a\r
/// platform Boot Object Authorization Certificate to create the certificateID.\r
/// A certificateID must not have any bits set to the value 1 other than bits in\r
/// this mask.\r
\r
///\r
/// Macros for dealing with the EFI_BIS_DATA object obtained\r
-/// from BIS_GetSignatureInfo()\r
+/// from BIS_GetSignatureInfo().\r
/// BIS_GET_SIGINFO_COUNT - tells how many EFI_BIS_SIGNATURE_INFO\r
/// elements are contained in a EFI_BIS_DATA struct pointed to\r
/// by the provided EFI_BIS_DATA*.\r
#define BIS_GET_SIGINFO_ARRAY(BisDataPtr) ((EFI_BIS_SIGNATURE_INFO *) (BisDataPtr)->Data)\r
\r
///\r
-/// Support old name for backward compatibility\r
+/// Support an old name for backward compatibility.\r
///\r
#define BOOT_OBJECT_AUTHORIZATION_PARMSET_GUIDVALUE \\r
BOOT_OBJECT_AUTHORIZATION_PARMSET_GUID\r
found\r
* A resource limitation was encountered while using a cryptographic software module.\r
@retval EFI_INVALID_PARAMETER The This parameter supplied by the caller is NULL or does not\r
- reference a valid EFI_BIS_PROTOCOL object, or\r
- The AppHandle parameter supplied by the caller is NULL or\r
- an invalid memory reference, or\r
- The InterfaceVersion parameter supplied by the caller\r
- is NULL or an invalid memory reference, or\r
- The TargetAddress parameter supplied by the caller is\r
+ reference a valid EFI_BIS_PROTOCOL object. Or,\r
+ the AppHandle parameter supplied by the caller is NULL or\r
+ an invalid memory reference. Or,\r
+ the InterfaceVersion parameter supplied by the caller\r
+ is NULL or an invalid memory reference. Or,\r
+ the TargetAddress parameter supplied by the caller is\r
NULL or an invalid memory reference.\r
\r
**/ \r
of the BIS service. \r
\r
@retval EFI_SUCCESS The function completed successfully.\r
- @retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid\r
+ @retval EFI_NO_MAPPING The AppHandle parameter is not, or is no longer, a valid\r
application instance handle associated with the EFI_BIS protocol. \r
@retval EFI_OUT_OF_RESOURCES The function failed due to lack of memory or other resources. \r
@retval EFI_DEVICE_ERROR The function encountered an unexpected internal failure while\r
Retrieves a unique token value to be included in the request credential for the next update of any\r
parameter in the Boot Object Authorization set \r
\r
- @param AppHandle An opaque handle that identifies the caller's instance of initialization\r
- of the BIS service. \r
- @param UpdateToken The function writes an allocated EFI_BIS_DATA* containing the new\r
- unique update token value. The caller must\r
- eventually free the memory allocated by this function using the function Free().\r
+ @param AppHandle An opaque handle that identifies the caller's \r
+ instance of initialization of the BIS service. \r
+ @param UpdateToken The function writes an allocated EFI_BIS_DATA* \r
+ containing the newunique update token value. \r
+ The caller musteventually free the memory allocated \r
+ by this function using the function Free().\r
\r
@retval EFI_SUCCESS The function completed successfully.\r
@retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid\r
/** \r
Updates one of the configurable parameters of the Boot Object Authorization set.\r
\r
- @param AppHandle An opaque handle that identifies the caller's instance of initialization\r
- of the BIS service. \r
- @param RequestCredential This is a Signed Manifest with embedded attributes that carry the details\r
- of the requested update. \r
- @param NewUpdateToken The function writes an allocated EFI_BIS_DATA* containing the new \r
- unique update token value. The caller must\r
- eventually free the memory allocated by this function using the function Free().\r
+ @param AppHandle An opaque handle that identifies the caller's \r
+ instance of initialization of the BIS service. \r
+ @param RequestCredential This is a Signed Manifest with embedded attributes \r
+ that carry the details of the requested update. \r
+ @param NewUpdateToken The function writes an allocated EFI_BIS_DATA* \r
+ containing the new unique update token value. \r
+ The caller must eventually free the memory allocated \r
+ by this function using the function Free().\r
\r
@retval EFI_SUCCESS The function completed successfully. \r
@retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid \r
This protocol is used to retrieve user readable names of EFI Drivers \r
and controllers managed by EFI Drivers.\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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
#define __EFI_COMPONENT_NAME_H__\r
\r
///\r
-/// Global ID for the Component Name Protocol\r
+/// The global ID for the Component Name Protocol.\r
///\r
#define EFI_COMPONENT_NAME_PROTOCOL_GUID \\r
{ \\r
\r
\r
/**\r
- Retrieves a Unicode string that is the user readable name of the EFI Driver.\r
+ Retrieves a Unicode string that is the user-readable name of the EFI Driver.\r
\r
@param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r
- @param Language A pointer to a three character ISO 639-2 language identifier.\r
+ @param Language A pointer to a three-character ISO 639-2 language identifier.\r
This is the language of the driver name that that the caller\r
is requesting, and it must match one of the languages specified\r
in SupportedLanguages. The number of languages supported by a\r
that wishes to retrieve the name of a child controller.\r
@param Language A pointer to a three character ISO 639-2 language\r
identifier. This is the language of the controller name\r
- that that the caller is requesting, and it must match one\r
+ that the caller is requesting, and it must match one\r
of the languages specified in SupportedLanguages. The\r
number of languages supported by a driver is up to the\r
driver writer.\r
@param ControllerName A pointer to the Unicode string to return. This Unicode\r
string is the name of the controller specified by\r
ControllerHandle and ChildHandle in the language specified\r
- by Language from the point of view of the driver specified\r
+ by Language, from the point of view of the driver specified\r
by This.\r
\r
- @retval EFI_SUCCESS The Unicode string for the user readable name in the\r
+ @retval EFI_SUCCESS The Unicode string for the user-readable name in the\r
language specified by Language for the driver\r
specified by This was returned in DriverName.\r
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
The DebugSupport protocol is used by source level debuggers to abstract the\r
processor and handle context save and restore operations.\r
\r
- Copyright (c) 2006 - 2009, Intel Corporation<BR> \r
- Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<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
- 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
typedef struct _EFI_DEBUG_SUPPORT_PROTOCOL EFI_DEBUG_SUPPORT_PROTOCOL;\r
\r
///\r
-/// Debug Support protocol {2755590C-6F3C-42FA-9EA4-A3BA543CDA25}\r
+/// Debug Support protocol {2755590C-6F3C-42FA-9EA4-A3BA543CDA25}.\r
///\r
#define EFI_DEBUG_SUPPORT_PROTOCOL_GUID \\r
{ \\r
typedef INTN EFI_EXCEPTION_TYPE;\r
\r
///\r
-/// IA-32 processor exception types\r
+/// IA-32 processor exception types.\r
///\r
#define EXCEPT_IA32_DIVIDE_ERROR 0\r
#define EXCEPT_IA32_DEBUG 1\r
#define EXCEPT_IA32_SIMD 19\r
\r
///\r
-/// FXSAVE_STATE\r
-/// FP / MMX / XMM registers (see fxrstor instruction definition)\r
+/// FXSAVE_STATE.\r
+/// FP / MMX / XMM registers (see fxrstor instruction definition).\r
///\r
typedef struct {\r
UINT16 Fcw;\r
} EFI_FX_SAVE_STATE_IA32;\r
\r
///\r
-/// IA-32 processor context definition\r
+/// IA-32 processor context definition.\r
///\r
typedef struct {\r
UINT32 ExceptionData;\r
} EFI_SYSTEM_CONTEXT_IA32;\r
\r
///\r
-/// x64 processor exception types\r
+/// x64 processor exception types.\r
///\r
#define EXCEPT_X64_DIVIDE_ERROR 0\r
#define EXCEPT_X64_DEBUG 1\r
#define EXCEPT_X64_SIMD 19\r
\r
///\r
-/// FXSAVE_STATE\r
-/// FP / MMX / XMM registers (see fxrstor instruction definition)\r
+/// FXSAVE_STATE.\r
+/// FP / MMX / XMM registers (see fxrstor instruction definition).\r
///\r
typedef struct {\r
UINT16 Fcw;\r
} EFI_FX_SAVE_STATE_X64;\r
\r
///\r
-/// x64 processor context definition\r
+/// x64 processor context definition.\r
///\r
typedef struct {\r
UINT64 ExceptionData;\r
} EFI_SYSTEM_CONTEXT_X64;\r
\r
///\r
-/// Itanium Processor Family Exception types\r
+/// Itanium Processor Family Exception types.\r
///\r
#define EXCEPT_IPF_VHTP_TRANSLATION 0\r
#define EXCEPT_IPF_INSTRUCTION_TLB 1\r
#define EXCEPT_IPF_IA32_INTERRUPT 47\r
\r
///\r
-/// IPF processor context definition\r
+/// IPF processor context definition.\r
///\r
typedef struct {\r
//\r
} EFI_SYSTEM_CONTEXT_IPF;\r
\r
///\r
-/// EBC processor exception types\r
+/// EBC processor exception types.\r
///\r
#define EXCEPT_EBC_UNDEFINED 0\r
#define EXCEPT_EBC_DIVIDE_ERROR 1\r
#define EXCEPT_EBC_DEBUG 2\r
#define EXCEPT_EBC_BREAKPOINT 3\r
#define EXCEPT_EBC_OVERFLOW 4\r
-#define EXCEPT_EBC_INVALID_OPCODE 5 ///< opcode out of range\r
+#define EXCEPT_EBC_INVALID_OPCODE 5 ///< Opcode out of range.\r
#define EXCEPT_EBC_STACK_FAULT 6\r
#define EXCEPT_EBC_ALIGNMENT_CHECK 7\r
-#define EXCEPT_EBC_INSTRUCTION_ENCODING 8 ///< malformed instruction\r
-#define EXCEPT_EBC_BAD_BREAK 9 ///< BREAK 0 or undefined BREAK\r
-#define EXCEPT_EBC_STEP 10 ///< to support debug stepping\r
+#define EXCEPT_EBC_INSTRUCTION_ENCODING 8 ///< Malformed instruction.\r
+#define EXCEPT_EBC_BAD_BREAK 9 ///< BREAK 0 or undefined BREAK.\r
+#define EXCEPT_EBC_STEP 10 ///< To support debug stepping.\r
///\r
/// For coding convenience, define the maximum valid EBC exception.\r
///\r
#define MAX_EBC_EXCEPTION EXCEPT_EBC_STEP\r
\r
///\r
-/// EBC processor context definition\r
+/// EBC processor context definition.\r
///\r
typedef struct {\r
UINT64 R0;\r
\r
\r
///\r
-/// ARM processor exception types\r
+/// ARM processor exception types.\r
///\r
#define EXCEPT_ARM_RESET 0\r
#define EXCEPT_ARM_UNDEFINED_INSTRUCTION 1\r
#define MAX_ARM_EXCEPTION EXCEPT_ARM_FIQ\r
\r
///\r
-/// ARM processor context definition\r
+/// ARM processor context definition.\r
///\r
typedef struct {\r
UINT32 R0;\r
} EFI_SYSTEM_CONTEXT_ARM;\r
\r
///\r
-/// Universal EFI_SYSTEM_CONTEXT definition\r
+/// Universal EFI_SYSTEM_CONTEXT definition.\r
///\r
typedef union {\r
EFI_SYSTEM_CONTEXT_EBC *SystemContextEbc;\r
/** \r
Registers and enables an exception callback function for the specified exception.\r
\r
- @param ExceptionType Exception types in EBC, IA-32, x64, or IPF\r
+ @param ExceptionType Exception types in EBC, IA-32, x64, or IPF.\r
@param SystemContext Exception content.\r
\r
**/\r
from a software point of view. The path must persist from boot to boot, so \r
it can not contain things like PCI bus numbers that change from boot to boot.\r
\r
- Copyright (c) 2006 - 2009, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
#include <Guid/PcAnsi.h>\r
\r
///\r
-/// Device Path protocol\r
+/// Device Path protocol.\r
///\r
#define EFI_DEVICE_PATH_PROTOCOL_GUID \\r
{ \\r
that make up the Device Path.\r
**/\r
typedef struct {\r
- UINT8 Type; ///< 0x01 Hardware Device Path\r
- ///< 0x02 ACPI Device Path\r
- ///< 0x03 Messaging Device Path\r
- ///< 0x04 Media Device Path\r
- ///< 0x05 BIOS Boot Specification Device Path\r
- ///< 0x7F End of Hardware Device Path\r
+ UINT8 Type; ///< 0x01 Hardware Device Path.\r
+ ///< 0x02 ACPI Device Path.\r
+ ///< 0x03 Messaging Device Path.\r
+ ///< 0x04 Media Device Path.\r
+ ///< 0x05 BIOS Boot Specification Device Path.\r
+ ///< 0x7F End of Hardware Device Path.\r
\r
UINT8 SubType; ///< Varies by Type\r
///< 0xFF End Entire Device Path, or\r
///< 0x01 End This Instance of a Device Path and start a new\r
- ///< Device Path\r
+ ///< Device Path.\r
\r
UINT8 Length[2]; ///< Specific Device Path data. Type and Sub-Type define\r
///< type of data. Size of data is included in Length.\r
typedef EFI_DEVICE_PATH_PROTOCOL EFI_DEVICE_PATH;\r
\r
///\r
-/// Hardware Device Paths\r
+/// Hardware Device Paths.\r
///\r
#define HARDWARE_DEVICE_PATH 0x01\r
\r
///\r
-/// PCI Device Path SubType\r
+/// PCI Device Path SubType.\r
///\r
#define HW_PCI_DP 0x01\r
\r
///\r
-/// PCI Device Path\r
+/// PCI Device Path.\r
///\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
///\r
- /// PCI Function Number\r
+ /// PCI Function Number.\r
///\r
UINT8 Function;\r
///\r
- /// PCI Device Number\r
+ /// PCI Device Number.\r
///\r
UINT8 Device;\r
} PCI_DEVICE_PATH;\r
\r
///\r
-/// PCCARD Device Path SubType\r
+/// PCCARD Device Path SubType.\r
///\r
#define HW_PCCARD_DP 0x02\r
\r
///\r
-/// PCCARD Device Path\r
+/// PCCARD Device Path.\r
///\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
///\r
- /// Function Number (0 = First Function)\r
+ /// Function Number (0 = First Function).\r
///\r
UINT8 FunctionNumber;\r
} PCCARD_DEVICE_PATH;\r
\r
///\r
-/// Memory Mapped Device Path SubType\r
+/// Memory Mapped Device Path SubType.\r
///\r
#define HW_MEMMAP_DP 0x03\r
\r
///\r
-/// Memory Mapped Device Path\r
+/// Memory Mapped Device Path.\r
///\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
///\r
EFI_PHYSICAL_ADDRESS StartingAddress;\r
///\r
- /// Ending Memory Address\r
+ /// Ending Memory Address.\r
///\r
EFI_PHYSICAL_ADDRESS EndingAddress;\r
} MEMMAP_DEVICE_PATH;\r
\r
///\r
-/// Hardware Vendor Device Path SubType\r
+/// Hardware Vendor Device Path SubType.\r
///\r
#define HW_VENDOR_DP 0x04\r
\r
} VENDOR_DEVICE_PATH;\r
\r
///\r
-/// Controller Device Path SubType\r
+/// Controller Device Path SubType.\r
///\r
#define HW_CONTROLLER_DP 0x05\r
\r
///\r
-/// Controller Device Path\r
+/// Controller Device Path.\r
///\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
} CONTROLLER_DEVICE_PATH;\r
\r
///\r
-/// ACPI Device Paths \r
+/// ACPI Device Paths.\r
///\r
#define ACPI_DEVICE_PATH 0x02\r
\r
///\r
-/// ACPI Device Path SubType\r
+/// ACPI Device Path SubType.\r
///\r
#define ACPI_DP 0x01\r
typedef struct {\r
/// Unique ID that is required by ACPI if two devices have the\r
/// same _HID. This value must also match the corresponding\r
/// _UID/_HID pair in the ACPI name space. Only the 32-bit\r
- /// numeric value type of _UID is supported; thus strings must\r
+ /// numeric value type of _UID is supported. Thus, strings must\r
/// not be used for the _UID in the ACPI name space.\r
///\r
UINT32 UID;\r
} ACPI_HID_DEVICE_PATH;\r
\r
///\r
-/// Expanded ACPI Device Path SubType\r
+/// Expanded ACPI Device Path SubType.\r
///\r
#define ACPI_EXTENDED_DP 0x02\r
typedef struct {\r
///\r
UINT32 CID;\r
///\r
- /// Optional variable length _HIDSTR\r
- /// Optional variable length _UIDSTR\r
- /// Optional variable length _CIDSTR\r
+ /// Optional variable length _HIDSTR.\r
+ /// Optional variable length _UIDSTR.\r
+ /// Optional variable length _CIDSTR.\r
///\r
} ACPI_EXTENDED_HID_DEVICE_PATH;\r
\r
#define EISA_ID_TO_NUM(_Id) ((_Id) >> 16)\r
\r
///\r
-/// ACPI _ADR Device Path SubType\r
+/// ACPI _ADR Device Path SubType.\r
///\r
#define ACPI_ADR_DP 0x03\r
\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
///\r
/// _ADR value. For video output devices the value of this\r
- /// field comes from Table B-2 ACPI 3.0 specification. At\r
+ /// field comes from Table B-2 of the ACPI 3.0 specification. At\r
/// least one _ADR value is required.\r
///\r
UINT32 ADR;\r
((_Index) & 0xf) ))\r
\r
///\r
-/// Messaging Device Paths\r
+/// Messaging Device Paths.\r
/// This Device Path is used to describe the connection of devices outside the resource domain of the\r
/// system. This Device Path can describe physical messaging information like SCSI ID, or abstract\r
/// information like networking protocol IP addresses.\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
///\r
- /// Set to zero for primary or one for secondary\r
+ /// Set to zero for primary, or one for secondary.\r
///\r
UINT8 PrimarySecondary;\r
///\r
- /// Set to zero for master or one for slave mode\r
+ /// Set to zero for master, or one for slave mode.\r
///\r
UINT8 SlaveMaster;\r
///\r
- /// Logical Unit Number\r
+ /// Logical Unit Number.\r
///\r
UINT16 Lun;\r
} ATAPI_DEVICE_PATH;\r
\r
///\r
-/// SCSI Device Path SubType\r
+/// SCSI Device Path SubType.\r
///\r
#define MSG_SCSI_DP 0x02\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
///\r
- /// Target ID on the SCSI bus (PUN)\r
+ /// Target ID on the SCSI bus (PUN).\r
///\r
UINT16 Pun;\r
///\r
- /// Logical Unit Number (LUN)\r
+ /// Logical Unit Number (LUN).\r
///\r
UINT16 Lun;\r
} SCSI_DEVICE_PATH;\r
\r
///\r
-/// Fibre Channel SubType\r
+/// Fibre Channel SubType.\r
///\r
#define MSG_FIBRECHANNEL_DP 0x03\r
typedef struct {\r
} F1394_DEVICE_PATH;\r
\r
///\r
-/// USB Device Path SubType\r
+/// USB Device Path SubType.\r
///\r
#define MSG_USB_DP 0x05\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
///\r
- /// USB Parent Port Number\r
+ /// USB Parent Port Number.\r
///\r
UINT8 ParentPortNumber;\r
///\r
- /// USB Interface Number\r
+ /// USB Interface Number.\r
///\r
UINT8 InterfaceNumber;\r
} USB_DEVICE_PATH;\r
\r
///\r
-/// USB Class Device Path SubType\r
+/// USB Class Device Path SubType.\r
///\r
#define MSG_USB_CLASS_DP 0x0f\r
typedef struct {\r
} USB_CLASS_DEVICE_PATH;\r
\r
///\r
-/// USB WWID Device Path SubType\r
+/// USB WWID Device Path SubType.\r
///\r
#define MSG_USB_WWID_DP 0x10\r
\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
///\r
- /// USB interface number\r
+ /// USB interface number.\r
///\r
UINT16 InterfaceNumber;\r
///\r
- /// USB vendor id of the device\r
+ /// USB vendor id of the device.\r
///\r
UINT16 VendorId;\r
///\r
- /// USB product id of the device\r
+ /// USB product id of the device.\r
///\r
UINT16 ProductId;\r
///\r
} USB_WWID_DEVICE_PATH;\r
\r
///\r
-/// Device Logical Unit SubType\r
+/// Device Logical Unit SubType.\r
///\r
#define MSG_DEVICE_LOGICAL_UNIT_DP 0x11\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
///\r
- /// Logical Unit Number for the interface\r
+ /// Logical Unit Number for the interface.\r
///\r
UINT8 Lun;\r
} DEVICE_LOGICAL_UNIT_DEVICE_PATH;\r
\r
///\r
-/// SATA Device Path SubType\r
+/// SATA Device Path SubType.\r
///\r
#define MSG_SATA_DP 0x12\r
typedef struct {\r
#define SATA_HBA_DIRECT_CONNECT_FLAG 0x8000\r
\r
///\r
-/// I2O Device Path SubType\r
+/// I2O Device Path SubType.\r
///\r
#define MSG_I2O_DP 0x06\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
///\r
- /// Target ID (TID) for a device\r
+ /// Target ID (TID) for a device.\r
///\r
UINT32 Tid;\r
} I2O_DEVICE_PATH;\r
\r
///\r
-/// MAC Address Device Path SubType\r
+/// MAC Address Device Path SubType.\r
///\r
#define MSG_MAC_ADDR_DP 0x0b\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
///\r
- /// The MAC address for a network interface padded with 0s\r
+ /// The MAC address for a network interface padded with 0s.\r
///\r
EFI_MAC_ADDRESS MacAddress;\r
///\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
///\r
- /// The local IPv4 address\r
+ /// The local IPv4 address.\r
///\r
EFI_IPv4_ADDRESS LocalIpAddress;\r
///\r
- /// The remote IPv4 address\r
+ /// The remote IPv4 address.\r
///\r
EFI_IPv4_ADDRESS RemoteIpAddress;\r
///\r
- /// The local port number\r
+ /// The local port number.\r
///\r
UINT16 LocalPort;\r
///\r
- /// The remote port number\r
+ /// The remote port number.\r
///\r
UINT16 RemotePort;\r
///\r
///\r
UINT16 Protocol;\r
///\r
- /// 0x00 - The Source IP Address was assigned though DHCP\r
- /// 0x01 - The Source IP Address is statically bound\r
+ /// 0x00 - The Source IP Address was assigned though DHCP.\r
+ /// 0x01 - The Source IP Address is statically bound.\r
///\r
BOOLEAN StaticIpAddress;\r
} IPv4_DEVICE_PATH;\r
\r
///\r
-/// IPv6 Device Path SubType\r
+/// IPv6 Device Path SubType.\r
///\r
#define MSG_IPv6_DP 0x0d\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
///\r
- /// The local IPv6 address\r
+ /// The local IPv6 address.\r
///\r
EFI_IPv6_ADDRESS LocalIpAddress;\r
///\r
- /// The remote IPv6 address\r
+ /// The remote IPv6 address.\r
///\r
EFI_IPv6_ADDRESS RemoteIpAddress;\r
///\r
- /// The local port number\r
+ /// The local port number.\r
///\r
UINT16 LocalPort;\r
///\r
- /// The remote port number\r
+ /// The remote port number.\r
///\r
UINT16 RemotePort;\r
///\r
///\r
UINT16 Protocol;\r
///\r
- /// 0x00 - The Source IP Address was assigned though DHCP\r
- /// 0x01 - The Source IP Address is statically bound\r
+ /// 0x00 - The Source IP Address was assigned though DHCP.\r
+ /// 0x01 - The Source IP Address is statically bound.\r
///\r
BOOLEAN StaticIpAddress;\r
} IPv6_DEVICE_PATH;\r
\r
///\r
-/// InfiniBand Device Path SubType\r
+/// InfiniBand Device Path SubType.\r
///\r
#define MSG_INFINIBAND_DP 0x09\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
///\r
/// Flags to help identify/manage InfiniBand device path elements:\r
- /// Bit 0 - IOC/Service (0b = IOC, 1b = Service)\r
- /// Bit 1 - Extend Boot Environment\r
- /// Bit 2 - Console Protocol\r
- /// Bit 3 - Storage Protocol\r
- /// Bit 4 - Network Protocol\r
+ /// Bit 0 - IOC/Service (0b = IOC, 1b = Service).\r
+ /// Bit 1 - Extend Boot Environment.\r
+ /// Bit 2 - Console Protocol.\r
+ /// Bit 3 - Storage Protocol.\r
+ /// Bit 4 - Network Protocol.\r
/// All other bits are reserved.\r
///\r
UINT32 ResourceFlags;\r
///\r
- /// 128-bit Global Identifier for remote fabric port\r
+ /// 128-bit Global Identifier for remote fabric port.\r
///\r
UINT8 PortGid[16];\r
///\r
/// 64-bit unique identifier to remote IOC or server process.\r
- /// Interpretation of field specified by Resource Flags (bit 0)\r
+ /// Interpretation of field specified by Resource Flags (bit 0).\r
///\r
UINT64 ServiceId;\r
///\r
- /// 64-bit persistent ID of remote IOC port\r
+ /// 64-bit persistent ID of remote IOC port.\r
///\r
UINT64 TargetPortId;\r
///\r
- /// 64-bit persistent ID of remote device\r
+ /// 64-bit persistent ID of remote device.\r
///\r
UINT64 DeviceId;\r
} INFINIBAND_DEVICE_PATH;\r
#define INFINIBAND_RESOURCE_FLAG_NETWORK_PROTOCOL 0x10\r
\r
///\r
-/// UART Device Path SubType\r
+/// UART Device Path SubType.\r
///\r
#define MSG_UART_DP 0x0e\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
///\r
- /// Reserved\r
+ /// Reserved.\r
///\r
UINT32 Reserved;\r
///\r
UINT8 DataBits;\r
///\r
/// The parity setting for the UART style device.\r
- /// Parity 0x00 - Default Parity\r
- /// Parity 0x01 - No Parity\r
- /// Parity 0x02 - Even Parity\r
- /// Parity 0x03 - Odd Parity\r
- /// Parity 0x04 - Mark Parity\r
- /// Parity 0x05 - Space Parity\r
+ /// Parity 0x00 - Default Parity.\r
+ /// Parity 0x01 - No Parity.\r
+ /// Parity 0x02 - Even Parity.\r
+ /// Parity 0x03 - Odd Parity.\r
+ /// Parity 0x04 - Mark Parity.\r
+ /// Parity 0x05 - Space Parity.\r
///\r
UINT8 Parity;\r
///\r
/// The number of stop bits for the UART style device.\r
- /// Stop Bits 0x00 - Default Stop Bits\r
- /// Stop Bits 0x01 - 1 Stop Bit\r
- /// Stop Bits 0x02 - 1.5 Stop Bits\r
- /// Stop Bits 0x03 - 2 Stop Bits\r
+ /// Stop Bits 0x00 - Default Stop Bits.\r
+ /// Stop Bits 0x01 - 1 Stop Bit.\r
+ /// Stop Bits 0x02 - 1.5 Stop Bits.\r
+ /// Stop Bits 0x03 - 2 Stop Bits.\r
///\r
UINT8 StopBits;\r
} UART_DEVICE_PATH;\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
///\r
- /// DEVICE_PATH_MESSAGING_UART_FLOW_CONTROL GUID\r
+ /// DEVICE_PATH_MESSAGING_UART_FLOW_CONTROL GUID.\r
///\r
EFI_GUID Guid;\r
///\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
///\r
- /// DEVICE_PATH_MESSAGING_SAS GUID\r
+ /// DEVICE_PATH_MESSAGING_SAS GUID.\r
///\r
EFI_GUID Guid;\r
///\r
///\r
UINT64 Lun;\r
///\r
- /// More Information about the device and its interconnect\r
+ /// More Information about the device and its interconnect.\r
///\r
UINT16 DeviceTopology;\r
///\r
- /// Relative Target Port (RTP)\r
+ /// Relative Target Port (RTP).\r
///\r
UINT16 RelativeTargetPort;\r
} SAS_DEVICE_PATH;\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
///\r
- /// Network Protocol (0 = TCP, 1+ = reserved)\r
+ /// Network Protocol (0 = TCP, 1+ = reserved).\r
///\r
UINT16 NetworkProtocol;\r
///\r
- /// iSCSI Login Options\r
+ /// iSCSI Login Options.\r
///\r
UINT16 LoginOption;\r
///\r
- /// iSCSI Logical Unit Number\r
+ /// iSCSI Logical Unit Number.\r
///\r
UINT64 Lun;\r
///\r
/// iSCSI NodeTarget Name. The length of the name\r
/// is determined by subtracting the offset of this field from Length.\r
///\r
- /// CHAR8 iSCSI Target Name\r
+ /// CHAR8 iSCSI Target Name.\r
} ISCSI_DEVICE_PATH;\r
\r
#define ISCSI_LOGIN_OPTION_NO_HEADER_DIGEST 0x0000\r
#define ISCSI_LOGIN_OPTION_CHAP_UNI 0x2000\r
\r
///\r
-/// VLAN Device Path SubType\r
+/// VLAN Device Path SubType.\r
///\r
#define MSG_VLAN_DP 0x14\r
typedef struct {\r
EFI_DEVICE_PATH_PROTOCOL Header;\r
///\r
- /// VLAN identifier (0-4094)\r
+ /// VLAN identifier (0-4094).\r
///\r
UINT16 VlanId;\r
} VLAN_DEVICE_PATH;\r
#define MEDIA_DEVICE_PATH 0x04\r
\r
///\r
-/// Hard Drive Media Device Path SubType\r
+/// Hard Drive Media Device Path SubType.\r
///\r
#define MEDIA_HARDDRIVE_DP 0x01\r
\r
///\r
UINT32 PartitionNumber;\r
///\r
- /// Starting LBA of the partition on the hard drive\r
+ /// Starting LBA of the partition on the hard drive.\r
///\r
UINT64 PartitionStart;\r
///\r
- /// Size of the partition in units of Logical Blocks\r
+ /// Size of the partition in units of Logical Blocks.\r
///\r
UINT64 PartitionSize;\r
///\r
///\r
UINT8 Signature[16];\r
///\r
- /// Partition Format: (Unused values reserved)\r
- /// 0x01 - PC-AT compatible legacy MBR\r
- /// 0x02 - GUID Partition Table\r
+ /// Partition Format: (Unused values reserved).\r
+ /// 0x01 - PC-AT compatible legacy MBR.\r
+ /// 0x02 - GUID Partition Table.\r
///\r
UINT8 MBRType;\r
///\r
- /// Type of Disk Signature: (Unused values reserved)\r
+ /// Type of Disk Signature: (Unused values reserved).\r
/// 0x00 - No Disk Signature.\r
/// 0x01 - 32-bit signature from address 0x1b8 of the type 0x01 MBR.\r
/// 0x02 - GUID signature.\r
#define SIGNATURE_TYPE_GUID 0x02\r
\r
///\r
-/// CD-ROM Media Device Path SubType\r
+/// CD-ROM Media Device Path SubType.\r
///\r
#define MEDIA_CDROM_DP 0x02\r
\r
//\r
// Use VENDOR_DEVICE_PATH struct\r
//\r
-#define MEDIA_VENDOR_DP 0x03 ///< Media vendor device path subtype\r
+#define MEDIA_VENDOR_DP 0x03 ///< Media vendor device path subtype.\r
\r
///\r
/// File Path Media Device Path SubType\r
#define SIZE_OF_FILEPATH_DEVICE_PATH OFFSET_OF(FILEPATH_DEVICE_PATH,PathName)\r
\r
///\r
-/// Media Protocol Device Path SubType\r
+/// Media Protocol Device Path SubType.\r
///\r
#define MEDIA_PROTOCOL_DP 0x05\r
\r
} MEDIA_PROTOCOL_DEVICE_PATH;\r
\r
///\r
-/// PIWG Firmware Volume Device Path SubType\r
+/// PIWG Firmware Volume Device Path SubType.\r
///\r
#define MEDIA_PIWG_FW_FILE_DP 0x06\r
\r
} MEDIA_FW_VOL_FILEPATH_DEVICE_PATH;\r
\r
///\r
-/// PIWG Firmware Volume Device Path SubType\r
+/// PIWG Firmware Volume Device Path SubType.\r
///\r
#define MEDIA_PIWG_FW_VOL_DP 0x07\r
\r
} MEDIA_FW_VOL_DEVICE_PATH;\r
\r
///\r
-/// Media relative offset range device path\r
+/// Media relative offset range device path.\r
///\r
#define MEDIA_RELATIVE_OFFSET_RANGE_DP 0x08\r
\r
} MEDIA_RELATIVE_OFFSET_RANGE_DEVICE_PATH;\r
\r
///\r
-/// BIOS Boot Specification Device Path\r
+/// BIOS Boot Specification Device Path.\r
///\r
#define BBS_DEVICE_PATH 0x05\r
\r
///\r
-/// BIOS Boot Specification Device Path SubType\r
+/// BIOS Boot Specification Device Path SubType.\r
///\r
#define BBS_BBS_DP 0x01\r
\r
///\r
UINT16 DeviceType;\r
///\r
- /// Status Flags as defined by the BIOS Boot Specification\r
+ /// Status Flags as defined by the BIOS Boot Specification.\r
///\r
UINT16 StatusFlag;\r
///\r
\r
\r
///\r
-/// Union of all possible Device Paths and pointers to Device Paths\r
+/// Union of all possible Device Paths and pointers to Device Paths.\r
///\r
typedef union {\r
EFI_DEVICE_PATH_PROTOCOL DevPath;\r
These protocols are used to collect configuration information for the EFI IPv4 Protocol\r
drivers and to provide DHCPv4 server and PXE boot server discovery services.\r
\r
- Copyright (c) 2006 - 2010, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@par Revision Reference: \r
- This Protocol is introduced in UEFI Specification 2.0\r
+ This Protocol was introduced in UEFI Specification 2.0.\r
\r
**/\r
\r
UINT32 Xid;\r
UINT16 Seconds;\r
UINT16 Reserved;\r
- EFI_IPv4_ADDRESS ClientAddr; ///< Client IP address from client\r
- EFI_IPv4_ADDRESS YourAddr; ///< Client IP address from server\r
- EFI_IPv4_ADDRESS ServerAddr; ///< IP address of next server in bootstrap\r
- EFI_IPv4_ADDRESS GatewayAddr; ///< Relay agent IP address\r
- UINT8 ClientHwAddr[16]; ///< Client hardware address\r
+ EFI_IPv4_ADDRESS ClientAddr; ///< Client IP address from client.\r
+ EFI_IPv4_ADDRESS YourAddr; ///< Client IP address from server.\r
+ EFI_IPv4_ADDRESS ServerAddr; ///< IP address of next server in bootstrap.\r
+ EFI_IPv4_ADDRESS GatewayAddr; ///< Relay agent IP address.\r
+ UINT8 ClientHwAddr[16]; ///< Client hardware address.\r
CHAR8 ServerName[64];\r
CHAR8 BootFileName[128];\r
}EFI_DHCP4_HEADER;\r
\r
typedef enum {\r
///\r
- /// The EFI DHCPv4 Protocol driver is stopped\r
+ /// The EFI DHCPv4 Protocol driver is stopped.\r
///\r
Dhcp4Stopped = 0x0,\r
///\r
- /// The EFI DHCPv4 Protocol driver is inactive\r
+ /// The EFI DHCPv4 Protocol driver is inactive.\r
///\r
Dhcp4Init = 0x1,\r
///\r
///\r
Dhcp4Rebinding = 0x6,\r
///\r
- /// The EFI DHCPv4 Protocol driver is initialized with a previously\r
+ /// The EFI DHCPv4 Protocol driver was initialized with a previously\r
/// allocated or known IP address.\r
///\r
Dhcp4InitReboot = 0x7,\r
There are three possible returned values, which are described in the following\r
table.\r
\r
- @param This Pointer to the EFI DHCPv4 Protocol instance that is used to\r
+ @param This The pointer to the EFI DHCPv4 Protocol instance that is used to\r
configure this callback function.\r
- @param Context Pointer to the context that is initialized by\r
+ @param Context The pointer to the context that is initialized by\r
EFI_DHCP4_PROTOCOL.Configure().\r
@param CurrentState The current operational state of the EFI DHCPv4 Protocol\r
driver.\r
\r
typedef struct {\r
///\r
- /// Number of times to try sending a packet during the Dhcp4SendDiscover\r
+ /// The number of times to try sending a packet during the Dhcp4SendDiscover\r
/// event and waiting for a response during the Dhcp4RcvdOffer event.\r
/// Set to zero to use the default try counts and timeout values.\r
///\r
UINT32 DiscoverTryCount;\r
///\r
- /// Maximum amount of time (in seconds) to wait for returned packets in each \r
+ /// The maximum amount of time (in seconds) to wait for returned packets in each \r
/// of the retries. Timeout values of zero will default to a timeout value \r
/// of one second. Set to NULL to use default timeout values.\r
///\r
UINT32 *DiscoverTimeout;\r
///\r
- /// Number of times to try sending a packet during the Dhcp4SendRequest event\r
+ /// The number of times to try sending a packet during the Dhcp4SendRequest event\r
/// and waiting for a response during the Dhcp4RcvdAck event before accepting\r
/// failure. Set to zero to use the default try counts and timeout values.\r
///\r
UINT32 RequestTryCount;\r
///\r
- /// Maximum amount of time (in seconds) to wait for return packets in each of the retries. \r
+ /// The maximum amount of time (in seconds) to wait for return packets in each of the retries. \r
/// Timeout values of zero will default to a timeout value of one second. \r
/// Set to NULL to use default timeout values.\r
///\r
///\r
EFI_DHCP4_CALLBACK Dhcp4Callback;\r
///\r
- /// Pointer to the context that will be passed to Dhcp4Callback when it is called.\r
+ /// The pointer to the context that will be passed to Dhcp4Callback when it is called.\r
///\r
VOID *CallbackContext;\r
///\r
///\r
EFI_EVENT CompletionEvent;\r
///\r
- /// Pointer to the server IP address. This address may be a unicast, multicast, or broadcast address.\r
+ /// The pointer to the server IP address. This address may be a unicast, multicast, or broadcast address.\r
///\r
EFI_IPv4_ADDRESS RemoteAddress;\r
///\r
- /// Server listening port number. If zero, the default server listening port number (67) will be used.\r
+ /// The server listening port number. If zero, the default server listening port number (67) will be used.\r
///\r
UINT16 RemotePort;\r
///\r
- /// Pointer to the gateway address to override the existing setting.\r
+ /// The pointer to the gateway address to override the existing setting.\r
///\r
EFI_IPv4_ADDRESS GatewayAddress;\r
///\r
///\r
EFI_DHCP4_LISTEN_POINT *ListenPoints;\r
///\r
- /// Number of seconds to collect responses. Zero is invalid.\r
+ /// The number of seconds to collect responses. Zero is invalid.\r
///\r
UINT32 TimeoutValue;\r
///\r
- /// Pointer to the packet to be transmitted.\r
+ /// The pointer to the packet to be transmitted.\r
///\r
EFI_DHCP4_PACKET *Packet;\r
///\r
///\r
UINT32 ResponseCount;\r
///\r
- /// Pointer to the allocated list of received packets.\r
+ /// The pointer to the allocated list of received packets.\r
///\r
EFI_DHCP4_PACKET *ResponseList;\r
} EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN;\r
The GetModeData() function returns the current operating mode and cached data\r
packet for the EFI DHCPv4 Protocol driver.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
- @param Dhcp4ModeData Pointer to storage for the EFI_DHCP4_MODE_DATA structure.\r
+ @param This The pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param Dhcp4ModeData The pointer to storage for the EFI_DHCP4_MODE_DATA structure.\r
\r
@retval EFI_SUCCESS The mode data was returned.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
When this driver is in the Dhcp4Stopped state, it can transfer into one of the\r
following two possible initial states:\r
* Dhcp4Init\r
- * Dhcp4InitReboot\r
+ * Dhcp4InitReboot.\r
The driver can transfer into these states by calling Configure() with a non-NULL\r
Dhcp4CfgData. The driver will transfer into the appropriate state based on the\r
supplied client network address in the ClientAddress parameter and DHCP options\r
wants to make it possible for another instance to configure the EFI DHCPv4 Protocol\r
driver, it must call this function with Dhcp4CfgData set to NULL.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
- @param Dhcp4CfgData Pointer to the EFI_DHCP4_CONFIG_DATA.\r
+ @param This The pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param Dhcp4CfgData The pointer to the EFI_DHCP4_CONFIG_DATA.\r
\r
@retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Init or\r
Dhcp4InitReboot state, if the original state of this driver\r
by EFI_DHCP4_PROTOCOL.Configure() will be called and the user can take this\r
opportunity to control the process.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
- @param CompletionEvent If not NULL, indicates the event that will be signaled when the\r
+ @param This The pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param CompletionEvent If not NULL, it indicates the event that will be signaled when the\r
EFI DHCPv4 Protocol driver is transferred into the\r
Dhcp4Bound state or when the DHCP process is aborted.\r
EFI_DHCP4_PROTOCOL.GetModeData() can be called to\r
Extends the lease time by sending a request packet.\r
\r
The RenewRebind() function is used to manually extend the lease time when the\r
- EFI DHCPv4 Protocol driver is in the Dhcp4Bound state and the lease time has\r
+ EFI DHCPv4 Protocol driver is in the Dhcp4Bound state, and the lease time has\r
not expired yet. This function will send a request packet to the previously\r
found server (or to any server when RebindRequest is TRUE) and transfer the\r
state into the Dhcp4Renewing state (or Dhcp4Rebinding when RebindingRequest is\r
If no response is received before the try count is exceeded (the RequestTryCount\r
field that is specified in EFI_DHCP4_CONFIG_DATA) but before the lease time that\r
was issued by the previous server expires, the driver will return to the Dhcp4Bound\r
- state and the previous configuration is restored. The outgoing and incoming packets\r
+ state, and the previous configuration is restored. The outgoing and incoming packets\r
can be captured by the EFI_DHCP4_CALLBACK function.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_DHCP4_PROTOCOL instance.\r
@param RebindRequest If TRUE, this function broadcasts the request packets and enters\r
the Dhcp4Rebinding state. Otherwise, it sends a unicast\r
request packet and enters the Dhcp4Renewing state.\r
EFI_DHCP4_PROTOCOL.Configure() function to 0.0.0.0 when the driver is in\r
Dhcp4InitReboot state\r
After a successful call to this function, the EFI DHCPv4 Protocol driver returns\r
- to the Dhcp4Init state and any subsequent incoming packets will be discarded silently.\r
+ to the Dhcp4Init state, and any subsequent incoming packets will be discarded silently.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_DHCP4_PROTOCOL instance.\r
\r
@retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Init phase.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
before DHCP configuration process can be started again. This function can be\r
called when the EFI DHCPv4 Protocol driver is in any state.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_DHCP4_PROTOCOL instance.\r
\r
@retval EFI_SUCCESS The EFI DHCPv4 Protocol driver is now in the Dhcp4Stopped phase.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
does not change any state of the EFI DHCPv4 Protocol driver and can be used at\r
any time.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_DHCP4_PROTOCOL instance.\r
@param SeedPacket Initial packet to be used as a base for building new packet.\r
@param DeleteCount Number of opcodes in the DeleteList.\r
@param DeleteList List of opcodes to be deleted from the seed packet.\r
Ignored if DeleteCount is zero.\r
@param AppendCount Number of entries in the OptionList.\r
- @param AppendList Pointer to a DHCP option list to be appended to SeedPacket.\r
+ @param AppendList The pointer to a DHCP option list to be appended to SeedPacket.\r
If SeedPacket also contains options in this list, they are\r
replaced by new options (except pad option). Ignored if\r
AppendCount is zero. Type EFI_DHCP4_PACKET_OPTION\r
- @param NewPacket Pointer to storage for the pointer to the new allocated packet.\r
+ @param NewPacket The pointer to storage for the pointer to the new allocated packet.\r
Use the EFI Boot Service FreePool() on the resulting pointer\r
when done with the packet.\r
\r
\r
The TransmitReceive() function is used to transmit a DHCP packet and optionally\r
wait for the response from servers. This function does not change the state of\r
- the EFI DHCPv4 Protocol driver and thus can be used at any time.\r
+ the EFI DHCPv4 Protocol driver. It can be used at any time because of this.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
- @param Token Pointer to the EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN structure.\r
+ @param This The pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param Token The pointer to the EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN structure.\r
\r
@retval EFI_SUCCESS The packet was successfully queued for transmission.\r
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
If *OptionCount is zero or there isn't enough space for all of them, the number\r
of DHCP options in the Packet is returned in OptionCount.\r
\r
- @param This Pointer to the EFI_DHCP4_PROTOCOL instance.\r
- @param Packet Pointer to packet to be parsed.\r
+ @param This The pointer to the EFI_DHCP4_PROTOCOL instance.\r
+ @param Packet The pointer to packet to be parsed.\r
@param OptionCount On input, the number of entries in the PacketOptionList.\r
On output, the number of entries that were written into the\r
PacketOptionList.\r
- @param PacketOptionList List of packet option entries to be filled in. End option or pad\r
+ @param PacketOptionList A list of packet option entries to be filled in. End option or pad\r
options are not included.\r
\r
@retval EFI_SUCCESS The packet was successfully parsed.\r
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
This is NULL.\r
- Packet is NULL.\r
- Packet is not a well-formed DHCP packet.\r
+ The packet is NULL.\r
+ The packet is not a well-formed DHCP packet.\r
OptionCount is NULL.\r
@retval EFI_BUFFER_TOO_SMALL One or more of the following conditions is TRUE:\r
1) *OptionCount is smaller than the number of options that\r
were found in the Packet.\r
2) PacketOptionList is NULL.\r
- @retval EFI_OUT_OF_RESOURCE The packet is failed to parse because of resource shortage.\r
+ @retval EFI_OUT_OF_RESOURCE The packet failed to parse because of a resource shortage.\r
\r
**/\r
typedef\r
This protocol is produced by every driver that follows the UEFI Driver Model, \r
and it is the central component that allows drivers and controllers to be managed.\r
\r
- Copyright (c) 2006 - 2009, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
#define __EFI_DRIVER_BINDING_H__\r
\r
///\r
-/// Global ID for the ControllerHandle Driver Protocol\r
+/// The global ID for the ControllerHandle Driver Protocol.\r
///\r
#define EFI_DRIVER_BINDING_PROTOCOL_GUID \\r
{ \\r
device specified by ControllerHandle may already be managed by the same driver or a \r
different driver. This function must match its calls to AllocatePages() with FreePages(), \r
AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol(). \r
- Since ControllerHandle may have been previously started by the same driver, if a protocol is \r
+ Because ControllerHandle may have been previously started by the same driver, if a protocol is \r
already in the opened state, then it must not be closed with CloseProtocol(). This is required \r
to guarantee the state of ControllerHandle is not modified by this function.\r
\r
The Start() function is designed to be invoked from the EFI boot service ConnectController().\r
As a result, much of the error checking on the parameters to Start() has been moved into this \r
common boot service. It is legal to call Start() from other locations, \r
- but the following calling restrictions must be followed or the system behavior will not be deterministic.\r
+ but the following calling restrictions must be followed, or the system behavior will not be deterministic.\r
1. ControllerHandle must be a valid EFI_HANDLE.\r
2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned\r
EFI_DEVICE_PATH_PROTOCOL.\r
The Stop() function is designed to be invoked from the EFI boot service DisconnectController(). \r
As a result, much of the error checking on the parameters to Stop() has been moved \r
into this common boot service. It is legal to call Stop() from other locations, \r
- but the following calling restrictions must be followed or the system behavior will not be deterministic.\r
+ but the following calling restrictions must be followed, or the system behavior will not be deterministic.\r
1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this\r
same driver's Start() function.\r
2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid\r
/** @file\r
EFI Driver Diagnostics 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
#define __EFI_DRIVER_DIAGNOSTICS_H__\r
\r
///\r
-/// Global ID for the Driver Diagnostics Protocol as defined in EFI 1.1.\r
+/// The global ID for the Driver Diagnostics Protocol as defined in EFI 1.1.\r
///\r
#define EFI_DRIVER_DIAGNOSTICS_PROTOCOL_GUID \\r
{ \\r
@retval EFI_SUCCESS The controller specified by ControllerHandle and\r
ChildHandle passed the diagnostic.\r
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
- @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.\r
+ @retval EFI_INVALID_PARAMETER ChildHandle is not NULL, and it is not a valid EFI_HANDLE.\r
@retval EFI_INVALID_PARAMETER Language is NULL.\r
@retval EFI_INVALID_PARAMETER ErrorType is NULL.\r
@retval EFI_INVALID_PARAMETER BufferType is NULL.\r
/** @file\r
UEFI Driver Family Protocol\r
\r
- Copyright (c) 2007 - 2009, 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) 2007 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
/** @file\r
This file provides control over block-oriented firmware devices.\r
\r
- Copyright (c) 2006 - 2009, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@par Revision Reference: PI\r
Version 1.0 and 1.2.\r
return from GetPhysicalAddress(), contains the\r
base address of the firmware volume.\r
\r
- @retval EFI_SUCCESS The firmware volume base address is returned.\r
+ @retval EFI_SUCCESS The firmware volume base address was returned.\r
\r
@retval EFI_NOT_SUPPORTED The firmware volume is not memory mapped.\r
\r
BlockSize.\r
\r
\r
- @retval EFI_SUCCESS The firmware volume base address is returned.\r
+ @retval EFI_SUCCESS The firmware volume base address was returned.\r
\r
@retval EFI_INVALID_PARAMETER The requested LBA is out of range.\r
\r
@param Buffer Pointer to a caller-allocated buffer that will\r
be used to hold the data that is read.\r
\r
- @retval EFI_SUCCESS The firmware volume was read successfully\r
+ @retval EFI_SUCCESS The firmware volume was read successfully,\r
and contents are in Buffer.\r
\r
@retval EFI_BAD_BUFFER_SIZE Read attempted across an LBA\r
function, or else the result will be unpredictable. This\r
unpredictability arises because, for a sticky-write firmware\r
volume, a write may negate a bit in the EFI_FVB_ERASE_POLARITY\r
- state but cannot flip it back again. In general, before\r
- calling the Write() function, the caller should call the\r
- EraseBlocks() function first to erase the specified block to\r
+ state but cannot flip it back again. Before calling the\r
+ Write() function, it is recommended for the caller to first call \r
+ the EraseBlocks() function to erase the specified block to\r
write. A block erase cycle will transition bits from the\r
(NOT)EFI_FVB_ERASE_POLARITY state back to the\r
EFI_FVB_ERASE_POLARITY state. Implementations should be\r
\r
@param Offset Offset into the block at which to begin writing.\r
\r
- @param NumBytes Pointer to a UINTN. At entry, *NumBytes\r
+ @param NumBytes The pointer to a UINTN. At entry, *NumBytes\r
contains the total size of the buffer. At\r
exit, *NumBytes contains the total number of\r
bytes actually written.\r
\r
- @param Buffer Pointer to a caller-allocated buffer that\r
+ @param Buffer The pointer to a caller-allocated buffer that\r
contains the source for the write.\r
\r
@retval EFI_SUCCESS The firmware volume was written successfully.\r
and consists of the following:\r
- An EFI_LBA that indicates the starting LBA\r
- A UINTN that indicates the number of blocks to\r
- erase\r
+ erase.\r
\r
The list is terminated with an\r
EFI_LBA_LIST_TERMINATOR. For example, the\r
(5-7 and 10-11) are to be erased: EraseBlocks\r
(This, 5, 3, 10, 2, EFI_LBA_LIST_TERMINATOR);\r
\r
- @retval EFI_SUCCESS The erase request was successfully\r
+ @retval EFI_SUCCESS The erase request successfully\r
completed.\r
\r
@retval EFI_ACCESS_DENIED The firmware volume is in the\r
EFI_FVB_WRITE Write;\r
EFI_FVB_ERASE_BLOCKS EraseBlocks;\r
///\r
- /// Handle of the parent firmware volume.\r
+ /// The handle of the parent firmware volume.\r
/// \r
EFI_HANDLE ParentHandle;\r
};\r
The EFI_FORM_BROWSER2_PROTOCOL is the interface to call for drivers to \r
leverage the EFI configuration driver interface.\r
\r
- Copyright (c) 2006 - 2009, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
/**\r
\r
- @param LeftColumn Value that designates the text column\r
+ @param LeftColumn The value that designates the text column\r
where the browser window will begin from\r
the left-hand side of the screen\r
\r
- @param RightColumn Value that designates the text\r
+ @param RightColumn The value that designates the text\r
column where the browser window will end\r
on the right-hand side of the screen.\r
\r
- @param TopRow Value that designates the text row from the\r
+ @param TopRow The value that designates the text row from the\r
top of the screen where the browser window\r
will start.\r
\r
- @param BottomRow Value that designates the text row from the\r
+ @param BottomRow The value that designates the text row from the\r
bottom of the screen where the browser\r
window will end. \r
**/\r
\r
@param ResultsDataSize A pointer to the size of the buffer\r
associated with ResultsData. On input, the size in\r
- bytes of ResultsData. On output, the size of data returned in ResultsData.\r
+ bytes of ResultsData. On output, the size of data \r
+ returned in ResultsData.\r
\r
@param ResultsData A string returned from an IFR browser or\r
equivalent. The results string will have\r
provided by a driver and to create and destroy instances of the EFI Hash Protocol \r
so that a multiple drivers can use the underlying hashing services.\r
\r
- Copyright (c) 2006 - 2009, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@retval EFI_SUCCESS Hash returned successfully.\r
@retval EFI_INVALID_PARAMETER Message or Hash is NULL\r
@retval EFI_UNSUPPORTED The algorithm specified by HashAlgorithm is not supported by this\r
- driver. Or extend is TRUE and the algorithm doesn't support extending the hash.\r
+ driver. Or, Extend is TRUE, and the algorithm doesn't support extending the hash.\r
\r
**/\r
typedef\r
This protocol is published by drivers providing and requesting \r
configuration data from HII. It may only be invoked by HII.\r
\r
- Copyright (c) 2006 - 2010, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
failing name / value pair (or the beginning\r
of the string if the failure is in the first\r
name / value pair) if the request was not\r
- successful\r
+ successful.\r
\r
@param Results A null-terminated Unicode string in\r
<MultiConfigAltResp> format which has all values\r
information from configuration applications, routing the\r
results to the appropriate drivers.\r
\r
- Copyright (c) 2006 - 2010, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
This function allows the caller to request the current\r
configuration for one or more named elements from one or more\r
drivers. The resulting string is in the standard HII\r
- configuration string format. If Successful Results contains an\r
+ configuration string format. If Successful, Results contains an\r
equivalent string with "=" and the values associated with all\r
names added in. The expected implementation is for each\r
- <ConfigRequest> substring in the Request, call the HII\r
+ <ConfigRequest> substring in the Request to call the HII\r
Configuration Routing Protocol ExtractProtocol function for the\r
driver corresponding to the <ConfigHdr> at the start of the\r
<ConfigRequest> substring. The request fails if no driver\r
\r
@param Progress On return, points to a character in the\r
Request string. Points to the string's null\r
- terminator if request was successful. Points\r
+ terminator if the request was successful. Points\r
to the most recent '&' before the first\r
failing name / value pair (or the beginning\r
of the string if the failure is in the first\r
configuration extraction.\r
\r
@retval EFI_INVALID_PARAMETER Illegal syntax. Progress set\r
- to most recent & before the\r
- error or the beginning of the\r
+ to the most recent & before the\r
+ error, or the beginning of the\r
string.\r
@retval EFI_INVALID_PARAMETER Unknown name.\r
\r
offset of the most recent '&' before the\r
first failing name / value pair (or the\r
beginning of the string if the failure is in\r
- the first name / value pair) or the\r
+ the first name / value pair), or the\r
terminating NULL if all was successful.\r
\r
@retval EFI_SUCCESS The results have been distributed or are\r
Results parameter would result\r
in this type of error.\r
\r
- @retval EFI_NOT_FOUND Target for the specified routing data\r
- was not found\r
+ @retval EFI_NOT_FOUND The target for the specified routing data\r
+ was not found.\r
\r
**/\r
typedef\r
\r
@param ConfigRequest A null-terminated string in <ConfigRequest> format.\r
\r
- @param Block Array of bytes defining the block's\r
+ @param Block An array of bytes defining the block's\r
configuration.\r
\r
- @param BlockSize Length in bytes of Block.\r
+ @param BlockSize The length in bytes of Block.\r
\r
- @param Config Filled-in configuration string. String\r
+ @param Config The filled-in configuration string. String\r
allocated by the function. Returned only if\r
call is successful. The null-terminated string \r
will be <ConfigResp> format.\r
offset of the most recent '&' before the\r
first failing name / value pair (or the\r
beginning of the string if the failure is in\r
- the first name / value pair) or the\r
+ the first name / value pair), or the\r
terminating NULL if all was successful.\r
\r
@retval EFI_SUCCESS The request succeeded. Progress points\r
to the first character of\r
ConfigRequest.\r
\r
- @retval EFI_NOT_FOUND Target for the specified routing data\r
+ @retval EFI_NOT_FOUND The target for the specified routing data\r
was not found. Progress points to the\r
'G' in "GUID" of the errant routing\r
data. \r
- @retval EFI_DEVICE_ERROR Block not large enough. Progress undefined.\r
+ @retval EFI_DEVICE_ERROR The block is not large enough. Progress undefined.\r
\r
@retval EFI_INVALID_PARAMETER Encountered non <BlockName>\r
formatted string. Block is\r
BlockLength parameter is (on input)\r
shorter than required by the\r
Configuration string, only the BlockSize\r
- parameter is updated and an appropriate\r
+ parameter is updated, and an appropriate\r
status (see below) is returned.\r
\r
@param BlockSize The length of the Block in units of UINT8.\r
of the most recent "&" before the first\r
failing name / value pair (or the beginning\r
of the string if the failure is in the first\r
- name / value pair) or the terminating NULL\r
+ name / value pair), or the terminating NULL\r
if all was successful.\r
\r
@retval EFI_SUCCESS The request succeeded. Progress points to the null\r
and placed in the newly allocated AltCfgResp buffer.\r
@retval EFI_OUT_OF_RESOURCES Not enough memory to allocate AltCfgResp. \r
@retval EFI_INVALID_PARAMETER Any parameter is invalid.\r
- @retval EFI_NOT_FOUND Target for the specified routing data was not found.\r
+ @retval EFI_NOT_FOUND The target for the specified routing data was not found.\r
**/\r
typedef\r
EFI_STATUS \r
The file provides Database manager for HII-related data\r
structures.\r
\r
- Copyright (c) 2006 - 2010, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
\r
///\r
-/// EFI_HII_DATABASE_NOTIFY_TYPE\r
+/// EFI_HII_DATABASE_NOTIFY_TYPE.\r
/// \r
typedef UINTN EFI_HII_DATABASE_NOTIFY_TYPE;\r
\r
resources for the new database\r
contents.\r
\r
- @retval EFI_INVALID_PARAMETER PackageList is NULL or Handle is NULL.\r
+ @retval EFI_INVALID_PARAMETER PackageList is NULL, or Handle is NULL.\r
\r
**/\r
typedef\r
the length of the handle buffer\r
that is required for the handles found.\r
\r
- @param Handle An array of EFI_HII_HANDLE instances returned.\r
+ @param Handle An array of EFI_HII_HANDLE instances returned.\r
\r
@retval EFI_SUCCESS The matching handles are outputed successfully.\r
HandleBufferLength is updated with the actual length.\r
handles. HandleBufferLength is\r
updated with a value that will\r
enable the data to fit.\r
- @retval EFI_NOT_FOUND No matching handle could not be found in database.\r
+ @retval EFI_NOT_FOUND No matching handle could be found in database.\r
@retval EFI_INVALID_PARAMETER Handle or HandleBufferLength was NULL.\r
@retval EFI_INVALID_PARAMETER PackageType is not a EFI_HII_PACKAGE_TYPE_GUID but\r
PackageGuid is not NULL, PackageType is a EFI_HII_\r
\r
@param NotifyType Describes the types of notification which\r
this function will be receiving. See\r
- EFI_HII_DATABASE_NOTIFY_TYPE for more a\r
+ EFI_HII_DATABASE_NOTIFY_TYPE for a\r
list of types.\r
\r
@param NotifyHandle Points to the unique handle assigned to\r
@param NotificationHandle The handle of the notification\r
function being unregistered.\r
\r
- @retval EFI_SUCCESS Unregister the notification Successsfully\r
+ @retval EFI_SUCCESS Successsfully unregistered the notification. \r
\r
@retval EFI_NOT_FOUND The incoming notification handle does not exist \r
in the current hii database.\r
/**\r
\r
This routine retrieves the requested keyboard layout. The layout\r
- is a physical description of the keys on a keyboard and the\r
+ is a physical description of the keys on a keyboard, and the\r
character(s) that are associated with a particular set of key\r
strokes.\r
\r
/** @file\r
The file provides services to retrieve font information.\r
\r
- Copyright (c) 2006 - 2009, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
typedef VOID *EFI_FONT_HANDLE;\r
\r
///\r
-/// EFI_HII_OUT_FLAGS\r
+/// EFI_HII_OUT_FLAGS.\r
/// \r
typedef UINT32 EFI_HII_OUT_FLAGS;\r
\r
\r
This function renders a string to a bitmap or the screen using\r
the specified font, color and options. It either draws the\r
- string and glyphs on an existing bitmap, allocates a new bitmap\r
+ string and glyphs on an existing bitmap, allocates a new bitmap,\r
or uses the screen. The strings can be clipped or wrapped.\r
Optionally, the function also returns the information about each\r
row and the character position on that row. If\r
outside the bounding box specified by Width and Height are\r
ignored. The information in the RowInfoArray only describes\r
characters which are at least partially displayed. For the final\r
- row, the LineHeight and BaseLine may describe pixels which are\r
+ row, the LineHeight and BaseLine may describe pixels that are\r
outside the limit specified by Height (unless\r
EFI_HII_OUT_FLAG_CLIP_CLEAN_Y is specified) even though those\r
pixels were not drawn. The LineWidth may describe pixels which\r
containing row information and\r
RowInfoArraySize will be updated to contain\r
the number of elements. This array describes\r
- the characters which were at least partially\r
+ the characters that were at least partially\r
drawn and the heights of the rows. It is the\r
caller's responsibility to free this buffer.\r
\r
can be drawn transparently or opaquely. The function can also\r
return information about each row and each character's\r
position on the row. If EFI_HII_OUT_FLAG_CLIP is set, then\r
- text will be formatted only based on explicit line breaks and\r
- all pixels which would lie outside the bounding box specified\r
+ text will be formatted based only on explicit line breaks, and\r
+ all pixels that would lie outside the bounding box specified\r
by Width and Height are ignored. The information in the\r
RowInfoArray only describes characters which are at least\r
partially displayed. For the final row, the LineHeight and\r
@retval EFI_OUT_OF_RESOURCES Unable to allocate an output\r
buffer for RowInfoArray or Blt.\r
\r
- @retval EFI_INVALID_PARAMETER The String or Blt or Height or\r
+ @retval EFI_INVALID_PARAMETER The String, or Blt, or Height, or\r
Width was NULL.\r
@retval EFI_INVALID_PARAMETER The Blt or PackageList was NULL.\r
@retval EFI_INVALID_PARAMETER Flags were invalid combination.\r
- @retval EFI_NOT_FOUND The specified PackageList is not in the Database \r
+ @retval EFI_NOT_FOUND The specified PackageList is not in the Database, \r
or the stringid is not in the specified PackageList. \r
\r
**/\r
\r
@param This A pointer to the EFI_HII_FONT_PROTOCOL instance.\r
\r
- @param Char Character to retrieve.\r
+ @param Char The character to retrieve.\r
\r
@param StringInfo Points to the string font and color\r
information or NULL if the string should use\r
the default system font and color.\r
\r
- @param Blt Thus must point to a NULL on entry. A buffer will\r
+ @param Blt This must point to a NULL on entry. A buffer will\r
be allocated to hold the output and the pointer\r
updated on exit. It is the caller's responsibility\r
to free this buffer.\r
\r
- @param Baseline Number of pixels from the bottom of the bitmap\r
+ @param Baseline The number of pixels from the bottom of the bitmap\r
to the baseline.\r
\r
\r
- @retval EFI_SUCCESS Glyph bitmap created.\r
+ @retval EFI_SUCCESS The glyph bitmap created.\r
\r
@retval EFI_OUT_OF_RESOURCES Unable to allocate the output buffer Blt.\r
\r
replaced with the glyph for\r
Unicode character code 0xFFFD.\r
\r
- @retval EFI_INVALID_PARAMETER Blt is NULL or Width is NULL or\r
+ @retval EFI_INVALID_PARAMETER Blt is NULL, or Width is NULL, or\r
Height is NULL\r
\r
\r
to NULL if there are no more matching fonts.\r
\r
@param StringInfoIn Upon entry, points to the font to return\r
- information about. If NULL, then the information about the system default \r
- font will be returned.\r
+ information about. If NULL, then the information \r
+ about the system default font will be returned.\r
\r
@param StringInfoOut Upon return, contains the matching\r
font's information. If NULL, then no\r
/** @file\r
The file provides services to manipulate string data.\r
\r
- Copyright (c) 2006 - 2010, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
/**\r
This function adds the string String to the group of strings owned by PackageList, with the\r
- specified font information StringFontInfo and returns a new string id.\r
+ specified font information StringFontInfo, and returns a new string id.\r
The new string identifier is guaranteed to be unique within the package list. \r
That new string identifier is reserved for all languages in the package list. \r
\r
@param This A pointer to the EFI_HII_STRING_PROTOCOL instance.\r
- @param PackageList Handle of the package list where this string will\r
+ @param PackageList The handle of the package list where this string will\r
be added.\r
@param StringId On return, contains the new strings id, which is\r
unique within PackageList.\r
with the passed in Language field.If LanguageName\r
is not NULL and the string package header's\r
LanguageName associated with a given Language is\r
- not zero, the LanguageName being passed in will\r
+ not zero, the LanguageName being passed in will\r
be ignored.\r
@param String Points to the new null-terminated string.\r
@param StringFontInfo Points to the new string's font information or\r
@retval EFI_NOT_FOUND The specified PackageList could not be found in\r
database.\r
@retval EFI_OUT_OF_RESOURCES Could not add the string due to lack of resources.\r
- @retval EFI_INVALID_PARAMETER String is NULL or StringId is NULL or Language is NULL.\r
+ @retval EFI_INVALID_PARAMETER String is NULL, or StringId is NULL, or Language is NULL.\r
@retval EFI_INVALID_PARAMETER The specified StringFontInfo does not exist in\r
current database.\r
\r
\r
A device handle for an IDE controller must contain an EFI_DEVICE_PATH_PROTOCOL.\r
\r
- Copyright (c) 2007 - 2010, 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) 2007 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@par Revision Reference:\r
This Protocol is defined in UEFI Platform Initialization Specification 1.2 \r
- Volume 5: Standards\r
+ Volume 5: Standards.\r
\r
**/\r
\r
#include <IndustryStandard/Atapi.h>\r
\r
///\r
-/// Global ID for the EFI_IDE_CONTROLLER_INIT_PROTOCOL\r
+/// Global ID for the EFI_IDE_CONTROLLER_INIT_PROTOCOL.\r
///\r
#define EFI_IDE_CONTROLLER_INIT_PROTOCOL_GUID \\r
{ \\r
}\r
\r
///\r
-/// Forward declaration for EFI_IDE_CONTROLLER_INIT_PROTOCOL\r
+/// Forward declaration for EFI_IDE_CONTROLLER_INIT_PROTOCOL.\r
///\r
typedef struct _EFI_IDE_CONTROLLER_INIT_PROTOCOL EFI_IDE_CONTROLLER_INIT_PROTOCOL;\r
\r
///\r
-/// The phase of the IDE Controller enumeration\r
+/// The phase of the IDE Controller enumeration.\r
///\r
typedef enum {\r
///\r
#define EFI_SATA_GEN2_SPEED 2\r
\r
///\r
-/// EFI_ATA_MODE structure\r
+/// EFI_ATA_MODE structure.\r
///\r
typedef struct {\r
BOOLEAN Valid; ///< TRUE if Mode is valid.\r
} EFI_ATA_EXTENDED_MODE;\r
\r
///\r
-/// EFI_ATA_COLLECTIVE_MODE structure\r
+/// EFI_ATA_COLLECTIVE_MODE structure.\r
///\r
typedef struct {\r
///\r
///\r
/// This field specifies the single word DMA mode. Single word DMA modes are defined\r
/// in the ATA/ATAPI specification, versions 1 and 2. Single word DMA support was\r
- /// obsoleted in the ATA/ATAPI specification, version 3; therefore, most devices and\r
+ /// obsoleted in the ATA/ATAPI specification, version 3. Therefore, most devices and\r
/// controllers will not support this transfer mode. The ATA/ATAPI specification defines\r
/// the enumeration. In other words, a value of 1 in this field means single word DMA\r
/// mode 1. The actual meaning of single word DMA mode 1 is governed by the ATA/\r
#define EFI_ATAPI_DEVICE_IDENTIFY_DATA 0x8000\r
\r
///\r
-/// EFI_IDENTIFY_DATA structure\r
+/// EFI_IDENTIFY_DATA structure.\r
///\r
typedef union {\r
///\r
For most of today's controllers, MaxDevices will either be 1 or 2. For SATA \r
controllers, this value will always be 1. SATA configurations can contain SATA \r
port multipliers. SATA port multipliers behave like SATA bridges and can support\r
- up to 16 devices on the other side. If an SATA port out of the IDE controller \r
+ up to 16 devices on the other side. If a SATA port out of the IDE controller \r
is connected to a port multiplier, MaxDevices will be set to the number of SATA \r
devices that the port multiplier supports. Because today's port multipliers \r
- support up to 15 SATA devices, this number can be as large as 15. The IDE bus \r
- driver is required to scan for the presence of port multipliers behind an SATA \r
+ support up to fifteen SATA devices, this number can be as large as fifteen. The IDE \r
+ bus driver is required to scan for the presence of port multipliers behind an SATA \r
controller and enumerate up to MaxDevices number of devices behind the port \r
multiplier. \r
\r
In this context, the devices behind a port multiplier constitute a channel. \r
\r
- @param[in] This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+ @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
@param[in] Channel Zero-based channel number.\r
@param[out] Enabled TRUE if this channel is enabled. Disabled channels \r
are not scanned to see if any devices are present.\r
@param[out] MaxDevices The maximum number of IDE devices that the bus driver\r
can expect on this channel. For the ATA/ATAPI \r
specification, version 6, this number will either be \r
- 1 or 2. For Serial ATA (SATA) configurations with a \r
- port multiplier, this number can be as large as 15.\r
+ one or two. For Serial ATA (SATA) configurations with a \r
+ port multiplier, this number can be as large as fifteen.\r
\r
@retval EFI_SUCCESS Information was returned without any errors.\r
@retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).\r
\r
More synchronization points may be added as required in the future. \r
\r
- @param[in] This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+ @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
@param[in] Phase The phase during enumeration.\r
@param[in] Channel Zero-based channel number.\r
\r
EFI_IDE_CONTROLLER_INIT_PROTOCOL.SubmitData() can be called only once for a \r
given (Channel, Device) pair. \r
\r
- @param[in] This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+ @param[in] This A pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
@param[in] Channel Zero-based channel number.\r
@param[in] Device Zero-based device number on the Channel.\r
@param[in] IdentifyData The device's response to the ATA IDENTIFY_DEVICE command.\r
may inform the IDE controller driver to not use second-generation (Gen2) speeds \r
for a certain SATA drive.\r
\r
- @param[in] This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
- @param[in] Channel Zero-based channel number.\r
- @param[in] Device Zero-based device number on the Channel.\r
+ @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+ @param[in] Channel The zero-based channel number.\r
+ @param[in] Device The zero-based device number on the Channel.\r
@param[in] BadModes The modes that the device does not support and that\r
should be disqualified.\r
\r
\r
The IDE bus driver may collect timing information for various devices in any \r
order. The IDE bus driver is responsible for making sure that all the dependencies\r
- are satisfied; for example, the SupportedModes information for device A that \r
+ are satisfied. For example, the SupportedModes information for device A that \r
was previously returned may become stale after a call to \r
EFI_IDE_CONTROLLER_INIT_PROTOCOL.DisqualifyMode() for device B.\r
\r
also allow the IDE bus driver to stay with the speed that has been negotiated \r
by the physical layer.\r
\r
- @param[in] This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
- @param[in] Channel Zero-based channel number.\r
- @param[in] Device Zero-based device number on the Channel.\r
+ @param[in] This The pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+ @param[in] Channel A zero-based channel number.\r
+ @param[in] Device A zero-based device number on the Channel.\r
@param[out] SupportedModes The optimum modes for the device.\r
\r
@retval EFI_SUCCESS SupportedModes was returned.\r
\r
///\r
/// Set to TRUE if the enumeration group includes all the channels that are\r
- /// produced by this controller. FALSE if an enumeration group consists of\r
+ /// produced by this controller. Set to FALSE if an enumeration group consists of\r
/// only one channel. \r
///\r
BOOLEAN EnumAll;\r
/// (PATA) controllers can support up to two channels. Advanced Host Controller \r
/// Interface (AHCI) Serial ATA (SATA) controllers can support up to 32 channels,\r
/// each of which can have up to one device. In the presence of a multiplier, \r
- /// each channel can have 15 devices.\r
+ /// each channel can have fifteen devices.\r
///\r
UINT8 ChannelCount;\r
};\r
sections:\r
- EFI IPv4 Service Binding Protocol\r
- EFI IPv4 Variable\r
- - EFI IPv4 Protocol\r
+ - EFI IPv4 Protocol.\r
The EFI IPv4 Protocol provides basic network IPv4 packet I/O services,\r
which includes support foR a subset of the Internet Control Message \r
Protocol (ICMP) and may include support for the Internet Group Management\r
Protocol (IGMP).\r
\r
- Copyright (c) 2006 - 2009, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@par Revision Reference: \r
- This Protocol is introduced in UEFI Specification 2.0 \r
+ This Protocol is introduced in UEFI Specification 2.0. \r
\r
**/\r
\r
function is used optionally to retrieve the operational mode data of underlying\r
networks or drivers.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
- @param Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure.\r
- @param MnpConfigData Pointer to the managed network configuration data structure.\r
- @param SnpModeData Pointer to the simple network mode data structure.\r
+ @param This The pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param Ip4ModeData The pointer to the EFI IPv4 Protocol mode data structure.\r
+ @param MnpConfigData The pointer to the managed network configuration data structure.\r
+ @param SnpModeData The pointer to the simple network mode data structure.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
requests will be cancelled. Their completion token status will be set to EFI_ABORTED\r
and their events will be signaled.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
- @param IpConfigData Pointer to the EFI IPv4 Protocol configuration data structure.\r
+ @param This The pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param IpConfigData The pointer to the EFI IPv4 Protocol configuration data structure.\r
\r
@retval EFI_SUCCESS The driver instance was successfully opened.\r
@retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
\r
If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_IP4_PROTOCOL instance.\r
@param JoinFlag Set to TRUE to join the multicast group session and FALSE to leave.\r
- @param GroupAddress Pointer to the IPv4 multicast address.\r
+ @param GroupAddress The pointer to the IPv4 multicast address.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_INVALID_PARAMETER One or more of the following is TRUE:\r
copies will be updated whenever the EIF IPv4 Protocol driver reconfigures its\r
instances. As a result, client modification to the routing table will be lost.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_IP4_PROTOCOL instance.\r
@param DeleteRoute Set to TRUE to delete this route from the routing table. Set to\r
FALSE to add this route to the routing table. SubnetAddress\r
and SubnetMask are used as the key to each route entry.\r
EFI IPv4 Protocol instance. Whenever the packet in the token is sent out or some\r
errors occur, the event in the token will be signaled and the status is updated.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
- @param Token Pointer to the transmit token.\r
+ @param This The pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param Token The pointer to the transmit token.\r
\r
@retval EFI_SUCCESS The data has been queued for transmission.\r
@retval EFI_NOT_STARTED This instance has not been started.\r
driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event\r
is signaled.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
- @param Token Pointer to a token that is associated with the receive data descriptor.\r
+ @param This The pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param Token The pointer to a token that is associated with the receive data descriptor.\r
\r
@retval EFI_SUCCESS The receive completion token was cached.\r
@retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r
asynchronous operation has completed, this function will not signal the token\r
and EFI_NOT_FOUND is returned.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
- @param Token Pointer to a token that has been issued by\r
+ @param This The pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param Token The pointer to a token that has been issued by\r
EFI_IP4_PROTOCOL.Transmit() or\r
EFI_IP4_PROTOCOL.Receive(). If NULL, all pending\r
tokens are aborted. Type EFI_IP4_COMPLETION_TOKEN is\r
experiencing packet loss should try calling the EFI_IP4_PROTOCOL.Poll() function\r
more often.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_IP4_PROTOCOL instance.\r
\r
@retval EFI_SUCCESS Incoming or outgoing data was processed.\r
@retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r
This file provides a definition of the EFI IPv4 Configuration\r
Protocol.\r
\r
- Copyright (c) 2006 - 2009, 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<BR>\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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@par Revision Reference: \r
- This Protocol is introduced in UEFI Specification 2.0\r
+ This Protocol is introduced in UEFI Specification 2.0.\r
\r
**/\r
#ifndef __EFI_IP4CONFIG_PROTOCOL_H__\r
Until the configuration completes successfully, EFI IPv4 Protocol driver instances \r
that are attempting to use default configurations must return EFI_NO_MAPPING.\r
Once the configuration is complete, the EFI IPv4 Configuration Protocol driver \r
- signals DoneEvent. The configuration may need to be updated in the future, \r
- however; in this case, the EFI IPv4 Configuration Protocol driver must signal \r
+ signals DoneEvent. The configuration may need to be updated in the future. \r
+ Note that in this case the EFI IPv4 Configuration Protocol driver must signal \r
ReconfigEvent, and all EFI IPv4 Protocol driver instances that are using default \r
configurations must return EFI_NO_MAPPING until the configuration policy has \r
been rerun.\r
\r
- @param This Pointer to the EFI_IP4_CONFIG_PROTOCOL instance.\r
+ @param This The pointer to the EFI_IP4_CONFIG_PROTOCOL instance.\r
@param DoneEvent Event that will be signaled when the EFI IPv4 \r
Protocol driver configuration policy completes \r
execution. This event must be of type EVT_NOTIFY_SIGNAL.\r
The Stop() function stops the configuration policy for the EFI IPv4 Protocol driver. \r
All configuration data will be lost after calling Stop().\r
\r
- @param This Pointer to the EFI_IP4_CONFIG_PROTOCOL instance.\r
+ @param This The pointer to the EFI_IP4_CONFIG_PROTOCOL instance.\r
\r
@retval EFI_SUCCESS The configuration policy for the EFI IPv4 Protocol \r
driver has been stopped.\r
The GetData() function returns the current configuration data for the EFI IPv4 \r
Protocol driver after the configuration policy has completed.\r
\r
- @param This Pointer to the EFI_IP4_CONFIG_PROTOCOL instance.\r
+ @param This The pointer to the EFI_IP4_CONFIG_PROTOCOL instance.\r
@param IpConfigDataSize On input, the size of the IpConfigData buffer. \r
On output, the count of bytes that were written \r
into the IpConfigData buffer.\r
- @param IpConfigData Pointer to the EFI IPv4 Configuration Protocol \r
+ @param IpConfigData The pointer to the EFI IPv4 Configuration Protocol \r
driver configuration data structure. \r
Type EFI_IP4_IPCONFIG_DATA is defined in \r
"Related Definitions" below.\r
);\r
\r
///\r
-/// The EFI_IP4_CONFIG_PROTOCOL driver performs platform- and policy-dependent \r
-/// configuration for the EFI IPv4 Protocol driver. \r
+/// The EFI_IP4_CONFIG_PROTOCOL driver performs platform-dependent and policy-dependent \r
+/// configurations for the EFI IPv4 Protocol driver. \r
///\r
struct _EFI_IP4_CONFIG_PROTOCOL {\r
EFI_IP4_CONFIG_START Start;\r
/** @file\r
Load File protocol as defined in the UEFI 2.0 specification.\r
\r
- Load file protocol exists to supports the addition of new boot devices, \r
+ The load file protocol exists to supports the addition of new boot devices, \r
and to support booting from devices that do not map well to file system. \r
Network boot is done via a LoadFile protocol.\r
\r
UEFI 2.0 can boot from any device that produces a LoadFile 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@retval EFI_NO_MEDIA No medium was present to load the file.\r
@retval EFI_DEVICE_ERROR The file was not loaded due to a device error.\r
@retval EFI_NO_RESPONSE The remote system did not respond.\r
- @retval EFI_NOT_FOUND The file was not found\r
+ @retval EFI_NOT_FOUND The file was not found.\r
@retval EFI_ABORTED The file load process was manually cancelled.\r
\r
**/\r
EFI_MANAGED_NETWORK_SERVICE_BINDING_PROTOCOL as defined in UEFI 2.0.\r
EFI_MANAGED_NETWORK_PROTOCOL as defined in UEFI 2.0.\r
\r
- Copyright (c) 2006 - 2009, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@par Revision Reference: \r
This Protocol is introduced in UEFI Specification 2.0\r
/**\r
Returns the operational parameters for the current MNP child driver.\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
- @param MnpConfigData Pointer to storage for MNP operational parameters.\r
- @param SnpModeData Pointer to storage for SNP operational parameters.\r
+ @param This The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param MnpConfigData The pointer to storage for MNP operational parameters.\r
+ @param SnpModeData The pointer to storage for SNP operational parameters.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
/**\r
Sets or clears the operational parameters for the MNP child driver.\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
- @param MnpConfigData Pointer to configuration data that will be assigned to the MNP\r
+ @param This The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param MnpConfigData The pointer to configuration data that will be assigned to the MNP\r
child driver instance. If NULL, the MNP child driver instance is\r
reset to startup defaults and all pending transmit and receive\r
requests are flushed.\r
/**\r
Translates an IP multicast address to a hardware (MAC) multicast address.\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param This The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
@param Ipv6Flag Set to TRUE to if IpAddress is an IPv6 multicast address.\r
Set to FALSE if IpAddress is an IPv4 multicast address.\r
- @param IpAddress Pointer to the multicast IP address (in network byte order) to convert.\r
- @param MacAddress Pointer to the resulting multicast MAC address.\r
+ @param IpAddress The pointer to the multicast IP address (in network byte order) to convert.\r
+ @param MacAddress The pointer to the resulting multicast MAC address.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_INVALID_PARAMETER One of the following conditions is TRUE:\r
/**\r
Enables and disables receive filters for multicast address.\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param This The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
@param JoinFlag Set to TRUE to join this multicast group.\r
Set to FALSE to leave this multicast group.\r
- @param MacAddress Pointer to the multicast MAC group (address) to join or leave.\r
+ @param MacAddress The pointer to the multicast MAC group (address) to join or leave.\r
\r
@retval EFI_SUCCESS The requested operation completed successfully.\r
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
/**\r
Places asynchronous outgoing data packets into the transmit queue.\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
- @param Token Pointer to a token associated with the transmit data descriptor.\r
+ @param This The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param Token The pointer to a token associated with the transmit data descriptor.\r
\r
@retval EFI_SUCCESS The transmit completion token was cached.\r
@retval EFI_NOT_STARTED This MNP child driver instance has not been configured.\r
/**\r
Places an asynchronous receiving request into the receiving queue.\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
- @param Token Pointer to a token associated with the receive data descriptor.\r
+ @param This The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param Token The pointer to a token associated with the receive data descriptor.\r
\r
@retval EFI_SUCCESS The receive completion token was cached.\r
@retval EFI_NOT_STARTED This MNP child driver instance has not been configured.\r
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
- This is NULL.\r
- Token is NULL.\r
- - Token.Event is NULL\r
+ - Token.Event is NULL.\r
@retval EFI_OUT_OF_RESOURCES The transmit data could not be queued due to a lack of system resources\r
(usually memory).\r
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
/**\r
Aborts an asynchronous transmit or receive request.\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
- @param Token Pointer to a token that has been issued by\r
+ @param This The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param Token The pointer to a token that has been issued by\r
EFI_MANAGED_NETWORK_PROTOCOL.Transmit() or\r
EFI_MANAGED_NETWORK_PROTOCOL.Receive(). If\r
NULL, all pending tokens are aborted.\r
/**\r
Polls for incoming data packets and processes outgoing data packets.\r
\r
- @param This Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
+ @param This The pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.\r
\r
@retval EFI_SUCCESS Incoming or outgoing data was processed.\r
@retval EFI_NOT_STARTED This MNP child driver instance has not been configured.\r
/** @file\r
Monotonic Counter Architectural Protocol as defined in PI SPEC VOLUME 2 DXE\r
\r
- This code provides the services required to access the systems monotonic counter\r
+ This code provides the services required to access the system's monotonic counter\r
\r
- Copyright (c) 2006 - 2010, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
#define __ARCH_PROTOCOL_MONTONIC_COUNTER_H__\r
\r
///\r
-/// Global ID for the Monotonic Counter Architectural Protocol\r
+/// Global ID for the Monotonic Counter Architectural Protocol.\r
///\r
#define EFI_MONOTONIC_COUNTER_ARCH_PROTOCOL_GUID \\r
{0x1da97072, 0xbddc, 0x4b30, {0x99, 0xf1, 0x72, 0xa0, 0xb5, 0x6f, 0xff, 0x2a} }\r
APs to help test system memory in parallel with other device initialization.\r
Diagnostics applications may also use this protocol for multi-processor.\r
\r
- Copyright (c) 2006 - 2009, 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<BR>\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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@par Revision Reference:\r
This Protocol is defined in the UEFI Platform Initialization Specification 1.2, \r
#define _MP_SERVICE_PROTOCOL_H_\r
\r
///\r
-/// Global ID for the EFI_MP_SERVICES_PROTOCOL\r
+/// Global ID for the EFI_MP_SERVICES_PROTOCOL.\r
///\r
#define EFI_MP_SERVICES_PROTOCOL_GUID \\r
{ \\r
}\r
\r
///\r
-/// Forward declaration for the EFI_MP_SERVICES_PROTOCOL\r
+/// Forward declaration for the EFI_MP_SERVICES_PROTOCOL.\r
///\r
typedef struct _EFI_MP_SERVICES_PROTOCOL EFI_MP_SERVICES_PROTOCOL;\r
\r
/// 1 0 0 Invalid. The BSP can never be in the disabled state.\r
/// 1 0 1 Invalid. The BSP can never be in the disabled state.\r
/// 1 1 0 Unhealthy Enabled BSP.\r
- /// 1 1 1 Healthy Enabled BSP\r
+ /// 1 1 1 Healthy Enabled BSP.\r
/// </pre>\r
///\r
UINT32 StatusFlag;\r
///\r
/// The physical location of the processor, including the physical package number\r
/// that identifies the cartridge, the physical core number within package, and \r
- /// logical threadnumber within core.\r
+ /// logical thread number within core.\r
///\r
EFI_CPU_PHYSICAL_LOCATION Location;\r
} EFI_PROCESSOR_INFORMATION;\r
This service may only be called from the BSP.\r
\r
This function is used to retrieve the following information:\r
- - The number of logical processors that are present in the system\r
+ - The number of logical processors that are present in the system.\r
- The number of enabled logical processors in the system at the instant \r
this call is made.\r
\r
- Since MP Service Protocol provides services to enable and disable processors \r
+ Because MP Service Protocol provides services to enable and disable processors \r
dynamically, the number of enabled logical processors may vary during the \r
course of a boot session.\r
\r
@retval EFI_SUCCESS The number of logical processors and enabled \r
logical processors was retrieved.\r
@retval EFI_DEVICE_ERROR The calling processor is an AP.\r
- @retval EFI_INVALID_PARAMETER NumberOfProcessors is NULL\r
- @retval EFI_INVALID_PARAMETER NumberOfEnabledProcessors is NULL\r
+ @retval EFI_INVALID_PARAMETER NumberOfProcessors is NULL.\r
+ @retval EFI_INVALID_PARAMETER NumberOfEnabledProcessors is NULL.\r
\r
**/\r
typedef\r
BSP requests the function specified by \r
Procedure to be started on all the enabled \r
APs, and go on executing immediately. If \r
- all return from Procedure or TimeoutInMicroSeconds\r
+ all return from Procedure, or TimeoutInMicroSeconds\r
expires, this event is signaled. The BSP \r
can use the CheckEvent() or WaitForEvent() \r
services to check the state of event. Type \r
bits are ignored. If it is NULL, this parameter \r
is ignored.\r
\r
- @retval EFI_SUCCESS The specified AP successfully enabled or disabled.\r
+ @retval EFI_SUCCESS The specified AP was enabled or disabled successfully.\r
@retval EFI_UNSUPPORTED Enabling or disabling an AP cannot be completed \r
prior to this service returning.\r
@retval EFI_UNSUPPORTED Enabling or disabling an AP is not supported.\r
\r
@retval EFI_SUCCESS The current processor handle number was returned \r
in ProcessorNumber.\r
- @retval EFI_INVALID_PARAMETER ProcessorNumber is NULL\r
+ @retval EFI_INVALID_PARAMETER ProcessorNumber is NULL.\r
\r
**/\r
typedef\r
/// guarantee that all non-blocking mode requests on all APs have been completed \r
/// before the UEFI event EFI_EVENT_GROUP_READY_TO_BOOT is signaled. Since the \r
/// order that event notification functions in the same event group are executed \r
-/// is not deterministic, an event of type EFI_EVENT_GROUP_READY_TO_BOOT can not \r
+/// is not deterministic, an event of type EFI_EVENT_GROUP_READY_TO_BOOT cannot \r
/// be used to guarantee that APs have completed their non-blocking mode requests.\r
///\r
/// When the UEFI event EFI_EVENT_GROUP_READY_TO_BOOT is signaled, the StartAllAPs() \r
/** @file\r
EFI Multicast Trivial File Tranfer Protocol Definition\r
\r
- Copyright (c) 2006 - 2010, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@par Revision Reference:\r
This Protocol is introduced in UEFI Specification 2.0\r
#pragma pack()\r
\r
///\r
-/// MTFTP4 option definition\r
+/// MTFTP4 option definition.\r
///\r
typedef struct {\r
UINT8 *OptionStr;\r
EFI_MTFTP4_OPCODE_OACK or EFI_MTFTP4_OPCODE_ERROR packets during a call to\r
EFI_MTFTP4_PROTOCOL.ReadFile(), WriteFile() or ReadDirectory().\r
\r
- @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.\r
@param Token The token that the caller provided in the\r
EFI_MTFTP4_PROTOCOL.ReadFile(), WriteFile()\r
or ReadDirectory() function.\r
@param PacketLen Indicates the length of the packet.\r
- @param Packet Pointer to an MTFTPv4 packet.\r
+ @param Packet The pointer to an MTFTPv4 packet.\r
\r
- @retval EFI_SUCCESS Operation sucess\r
- @retval Others Abort transfer process\r
+ @retval EFI_SUCCESS The operation was successful.\r
+ @retval Others Aborts the transfer process.\r
\r
**/\r
typedef\r
/**\r
Timeout callback funtion.\r
\r
- @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.\r
@param Token The token that is provided in the\r
EFI_MTFTP4_PROTOCOL.ReadFile() or\r
EFI_MTFTP4_PROTOCOL.WriteFile() or\r
EFI_MTFTP4_PROTOCOL.ReadDirectory() functions\r
by the caller.\r
\r
- @retval EFI_SUCCESS Operation sucess\r
+ @retval EFI_SUCCESS The operation was successful.\r
@retval Others Aborts download process.\r
\r
**/\r
A callback function that the caller provides to feed data to the\r
EFI_MTFTP4_PROTOCOL.WriteFile() function.\r
\r
- @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.\r
@param Token The token provided in the\r
EFI_MTFTP4_PROTOCOL.WriteFile() by the caller.\r
@param Length Indicates the length of the raw data wanted on input, and the\r
length the data available on output.\r
- @param Buffer Pointer to the buffer where the data is stored.\r
+ @param Buffer The pointer to the buffer where the data is stored.\r
\r
- @retval EFI_SUCCESS Operation sucess\r
+ @retval EFI_SUCCESS The operation was successful.\r
@retval Others Aborts session.\r
\r
**/\r
/**\r
Submits an asynchronous interrupt transfer to an interrupt endpoint of a USB device.\r
\r
- @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.\r
- @param ModeData Pointer to storage for the EFI MTFTPv4 Protocol driver mode data.\r
+ @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.\r
+ @param ModeData The pointer to storage for the EFI MTFTPv4 Protocol driver mode data.\r
\r
@retval EFI_SUCCESS The configuration data was successfully returned.\r
@retval EFI_OUT_OF_RESOURCES The required mode data could not be allocated.\r
Initializes, changes, or resets the default operational setting for this\r
EFI MTFTPv4 Protocol driver instance.\r
\r
- @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.\r
- @param MtftpConfigData Pointer to the configuration data structure.\r
+ @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.\r
+ @param MtftpConfigData The pointer to the configuration data structure.\r
\r
@retval EFI_SUCCESS The EFI MTFTPv4 Protocol driver was configured successfully.\r
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r
/**\r
Gets information about a file from an MTFTPv4 server.\r
\r
- @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.\r
@param OverrideData Data that is used to override the existing parameters. If NULL,\r
the default parameters that were set in the\r
EFI_MTFTP4_PROTOCOL.Configure() function are used.\r
- @param Filename Pointer to ASCIIZ file name string.\r
- @param ModeStr Pointer to ASCIIZ mode string. If NULL, "octet" will be used.\r
+ @param Filename The pointer to ASCIIZ file name string.\r
+ @param ModeStr The pointer to ASCIIZ mode string. If NULL, "octet" will be used.\r
@param OptionCount Number of option/value string pairs in OptionList.\r
- @param OptionList Pointer to array of option/value string pairs. Ignored if\r
+ @param OptionList The pointer to array of option/value string pairs. Ignored if\r
OptionCount is zero.\r
@param PacketLength The number of bytes in the returned packet.\r
@param Packet The pointer to the received packet. This buffer must be freed by\r
/**\r
Parses the options in an MTFTPv4 OACK packet.\r
\r
- @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.\r
@param PacketLen Length of the OACK packet to be parsed.\r
- @param Packet Pointer to the OACK packet to be parsed.\r
- @param OptionCount Pointer to the number of options in following OptionList.\r
- @param OptionList Pointer to EFI_MTFTP4_OPTION storage. Call the EFI Boot\r
+ @param Packet The pointer to the OACK packet to be parsed.\r
+ @param OptionCount The pointer to the number of options in following OptionList.\r
+ @param OptionList The pointer to EFI_MTFTP4_OPTION storage. Call the EFI Boot\r
Service FreePool() to release the OptionList if the options\r
in this OptionList are not needed any more.\r
\r
/**\r
Downloads a file from an MTFTPv4 server.\r
\r
- @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.\r
- @param Token Pointer to the token structure to provide the parameters that are\r
+ @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.\r
+ @param Token The pointer to the token structure to provide the parameters that are\r
used in this operation.\r
\r
@retval EFI_SUCCESS The data file has been transferred successfully.\r
/**\r
Sends a file to an MTFTPv4 server.\r
\r
- @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.\r
- @param Token Pointer to the token structure to provide the parameters that are\r
+ @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.\r
+ @param Token The pointer to the token structure to provide the parameters that are\r
used in this operation.\r
\r
@retval EFI_SUCCESS The upload session has started.\r
Downloads a data file "directory" from an MTFTPv4 server. May be unsupported in some EFI\r
implementations.\r
\r
- @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.\r
- @param Token Pointer to the token structure to provide the parameters that are\r
+ @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.\r
+ @param Token The pointer to the token structure to provide the parameters that are\r
used in this operation.\r
\r
@retval EFI_SUCCESS The MTFTPv4 related file "directory" has been downloaded.\r
/**\r
Polls for incoming data packets and processes outgoing data packets.\r
\r
- @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.\r
\r
@retval EFI_SUCCESS Incoming or outgoing data was processed.\r
@retval EFI_NOT_STARTED This EFI MTFTPv4 Protocol instance has not been started.\r
///\r
EFI_MTFTP4_OVERRIDE_DATA *OverrideData;\r
///\r
- /// Pointer to the ASCIIZ file name string.\r
+ /// The pointer to the ASCIIZ file name string.\r
///\r
UINT8 *Filename;\r
///\r
- /// Pointer to the ASCIIZ mode string. If NULL, "octet" is used.\r
+ /// The pointer to the ASCIIZ mode string. If NULL, "octet" is used.\r
///\r
UINT8 *ModeStr;\r
///\r
///\r
UINT32 OptionCount;\r
///\r
- /// Pointer to an array of option/value string pairs. Ignored if OptionCount is zero.\r
+ /// The pointer to an array of option/value string pairs. Ignored if OptionCount is zero.\r
///\r
EFI_MTFTP4_OPTION *OptionList;\r
///\r
- /// Size of the data buffer.\r
+ /// The size of the data buffer.\r
///\r
UINT64 BufferSize;\r
///\r
- /// Pointer to the data buffer. Data that is downloaded from the\r
+ /// The pointer to the data buffer. Data that is downloaded from the\r
/// MTFTPv4 server is stored here. Data that is uploaded to the\r
/// MTFTPv4 server is read from here. Ignored if BufferSize is zero.\r
///\r
VOID *Buffer;\r
///\r
- /// Pointer to the context that will be used by CheckPacket,\r
+ /// The pointer to the context that will be used by CheckPacket,\r
/// TimeoutCallback and PacketNeeded.\r
///\r
VOID *Context;\r
///\r
- /// Pointer to the callback function to check the contents of the received packet.\r
+ /// The pointer to the callback function to check the contents of the received packet.\r
///\r
EFI_MTFTP4_CHECK_PACKET CheckPacket;\r
///\r
- /// Pointer to the function to be called when a timeout occurs.\r
+ /// The pointer to the function to be called when a timeout occurs.\r
///\r
EFI_MTFTP4_TIMEOUT_CALLBACK TimeoutCallback;\r
///\r
- /// Pointer to the function to provide the needed packet contents.\r
+ /// The pointer to the function to provide the needed packet contents.\r
///\r
EFI_MTFTP4_PACKET_NEEDED PacketNeeded;\r
};\r
/** @file\r
- EFI Network Interface Identifier Protocol\r
+ EFI Network Interface Identifier Protocol.\r
\r
- Copyright (c) 2006 - 2009, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@par Revision Reference: \r
- This Protocol is introduced in EFI Specification 1.10\r
+ This Protocol is introduced in EFI Specification 1.10.\r
\r
**/\r
\r
#define EFI_NETWORK_INTERFACE_IDENTIFIER_INTERFACE_REVISION EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_REVISION\r
\r
///\r
-/// Forward reference for pure ANSI compatability\r
+/// Forward reference for pure ANSI compatability.\r
///\r
typedef struct _EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL;\r
\r
///\r
struct _EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL {\r
UINT64 Revision; ///< The revision of the EFI_NETWORK_INTERFACE_IDENTIFIER protocol.\r
- UINT64 Id; ///< Address of the first byte of the identifying structure for this network \r
+ UINT64 Id; ///< The address of the first byte of the identifying structure for this network \r
///< interface. This is only valid when the network interface is started \r
///< (see Start()). When the network interface is not started, this field is set to zero.\r
- UINT64 ImageAddr; ///< Address of the first byte of the identifying structure for this\r
+ UINT64 ImageAddr; ///< The address of the first byte of the identifying structure for this\r
///< network interface. This is set to zero if there is no structure.\r
- UINT32 ImageSize; ///< Size of unrelocated network interface image.\r
+ UINT32 ImageSize; ///< The size of unrelocated network interface image.\r
CHAR8 StringId[4];///< A four-character ASCII string that is sent in the class identifier field of\r
///< option 60 in DHCP. For a Type of EfiNetworkInterfaceUndi, this field is UNDI.\r
UINT8 Type; ///< Network interface type. This will be set to one of the values \r
The interfaces in dynamic type PCD do not require the token space guid as parameter,\r
but interfaces in dynamic-ex type PCD require token space guid as parameter.\r
\r
- Copyright (c) 2006 - 2010, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
the maximum size supported for this TokenNumber.\r
@param[in] Buffer The buffer to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
the maximum size supported for this TokenNumber.\r
@param[in] Buffer The buffer to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
@param[in] TokenNumber The PCD token number. \r
@param[in] Value The value to set for the PCD token.\r
\r
- @retval EFI_SUCCESS Procedure returned successfully.\r
+ @retval EFI_SUCCESS The procedure returned successfully.\r
@retval EFI_INVALID_PARAMETER The PCD service determined that the size of the data \r
being set was incompatible with a call to this function. \r
Use GetSize() to retrieve the size of the target data.\r
Retrieves the next valid token number in a given namespace. \r
\r
This is useful since the PCD infrastructure contains a sparse list of token numbers, \r
- and one cannot a priori know what token numbers are valid in the database. \r
+ and one cannot know without examination or by deduction what token numbers are valid in the database. \r
\r
If TokenNumber is 0 and Guid is not NULL, then the first token from the token space specified by Guid is returned. \r
If TokenNumber is not 0 and Guid is not NULL, then the next token in the token space specified by Guid is returned. \r
EFI_SUCCESS. \r
\r
@retval EFI_SUCCESS The PCD service retrieved the next valid token space Guid. \r
- Or the input token space Guid is already the last valid token space Guid \r
+ Or, the input token space Guid is already the last valid token space Guid \r
in the PCD database. In the later case, *Guid is updated with the value of NULL.\r
@retval EFI_NOT_FOUND If the input token namespace does not exist on the platform.\r
\r
provides the basic interfaces to abstract a PCI host bridge resource allocation. \r
This protocol is mandatory if the system includes PCI devices.\r
\r
- Copyright (c) 2007 - 2009, 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) 2007 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@par Revision Reference:\r
This Protocol is defined in UEFI Platform Initialization Specification 1.2 \r
- Volume 5: Standards\r
+ Volume 5: Standards.\r
\r
**/\r
\r
#include <Protocol/PciRootBridgeIo.h>\r
\r
///\r
-/// Global ID for the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL\r
+/// Global ID for the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL.\r
///\r
#define EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL_GUID \\r
{ \\r
}\r
\r
///\r
-/// Forward declaration for EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL\r
+/// Forward declaration for EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL.\r
///\r
typedef struct _EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL;\r
\r
#define EFI_RESOURCE_NOT_SATISFIED 0xFFFFFFFFFFFFFFFFULL\r
\r
///\r
-/// This enum is used to specify the phase of the PCI enumaeration process\r
+/// This enum is used to specify the phase of the PCI enumaeration process.\r
///\r
typedef enum {\r
///\r
These are the notifications from the PCI bus driver that it is about to enter a certain phase of the PCI \r
enumeration process.\r
\r
- @param[in] This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL \r
+ @param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL \r
instance.\r
- @param[in] Phase The phase during enumeration\r
+ @param[in] Phase The phase during enumeration.\r
\r
@retval EFI_SUCCESS The notification was accepted without any errors.\r
@retval EFI_INVALID_PARAMETER The Phase is invalid.\r
/**\r
Returns the device handle of the next PCI root bridge that is associated with this host bridge.\r
\r
- @param[in] This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL \r
+ @param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL \r
instance.\r
@param[in,out] RootBridgeHandle Returns the device handle of the next PCI root bridge. On input, it holds the \r
RootBridgeHandle that was returned by the most recent call to \r
/**\r
Returns the allocation attributes of a PCI root bridge.\r
\r
- @param[in] This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL \r
+ @param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL \r
instance.\r
@param[in] RootBridgeHandle The device handle of the PCI root bridge in which the caller is interested.\r
@param[out] Attribute The pointer to attributes of the PCI root bridge.\r
/**\r
Sets up the specified PCI root bridge for the bus enumeration process.\r
\r
- @param[in] This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL \r
+ @param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL \r
instance.\r
@param[in] RootBridgeHandle The PCI root bridge to be set up.\r
- @param[out] Configuration Pointer to the pointer to the PCI bus resource descriptor.\r
+ @param[out] Configuration The pointer to the pointer to the PCI bus resource descriptor.\r
\r
@retval EFI_SUCCESS The PCI root bridge was set up and the bus range was returned in \r
Configuration.\r
/**\r
Programs the PCI root bridge hardware so that it decodes the specified PCI bus range.\r
\r
- @param[in] This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL\r
+ @param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL\r
instance. \r
@param[in] RootBridgeHandle The PCI root bridge whose bus range is to be programmed.\r
- @param[in] Configuration The pointer to the PCI bus resource descriptor..\r
+ @param[in] Configuration The pointer to the PCI bus resource descriptor.\r
\r
@retval EFI_SUCCESS The bus range for the PCI root bridge was programmed.\r
@retval EFI_INVALID_PARAMETER RootBridgeHandle is not a valid root bridge handle.\r
/**\r
Submits the I/O and memory resource requirements for the specified PCI root bridge.\r
\r
- @param[in] This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL \r
+ @param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL \r
instance.\r
@param[in] RootBridgeHandle The PCI root bridge whose I/O and memory resource requirements are being \r
submitted.\r
/**\r
Returns the proposed resource settings for the specified PCI root bridge.\r
\r
- @param[in] This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL \r
+ @param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL \r
instance.\r
@param[in] RootBridgeHandle The PCI root bridge handle.\r
@param[out] Configuration The pointer to the pointer to the PCI I/O and memory resource descriptor.\r
stages of the PCI enumeration process that allow the host bridge driver to preinitialize individual \r
PCI controllers before enumeration.\r
\r
- @param[in] This Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance.\r
+ @param[in] This The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance.\r
@param[in] RootBridgeHandle The associated PCI root bridge handle.\r
@param[in] PciAddress The address of the PCI device on the PCI bus.\r
@param[in] Phase The phase of the PCI device enumeration.\r
/** @file\r
- This file declares PlatfromOpRom protocols which provides the interface between \r
+ This file declares PlatfromOpRom protocols that provide the interface between \r
the PCI bus driver/PCI Host Bridge Resource Allocation driver and a platform-specific \r
driver to describe the unique features of a platform. \r
This protocol is optional.\r
\r
- Copyright (c) 2007 - 2009, 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) 2007 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@par Revision Reference:\r
This Protocol is defined in UEFI Platform Initialization Specification 1.2 \r
\r
///\r
/// This file must be included because the EFI_PCI_PLATFORM_PROTOCOL uses\r
-/// EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE\r
+/// EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE.\r
///\r
#include <Protocol/PciHostBridgeResourceAllocation.h>\r
\r
///\r
-/// Global ID for the EFI_PCI_PLATFORM_PROTOCOL\r
+/// Global ID for the EFI_PCI_PLATFORM_PROTOCOL.\r
///\r
#define EFI_PCI_PLATFORM_PROTOCOL_GUID \\r
{ \\r
}\r
\r
///\r
-/// Forward declaration for EFI_PCI_PLATFORM_PROTOCOL\r
+/// Forward declaration for EFI_PCI_PLATFORM_PROTOCOL.\r
///\r
typedef struct _EFI_PCI_PLATFORM_PROTOCOL EFI_PCI_PLATFORM_PROTOCOL;\r
\r
/// - EFI_RESERVE_ISA_IO_ALIAS | EFI_RESERVE_VGA_IO_ALIAS:<BR>\r
/// Sets aside the ISA I/O range and all the aliases during PCI\r
/// enumeration. VGA I/O ranges and aliases are included in ISA alias\r
-/// ranges. In this scheme, 75 percent of the I/O space remains unused.\r
+/// ranges. In this scheme, seventy-five percent of the I/O space remains unused.\r
/// By using this selection, the platform indicates that it wants to support\r
/// PCI devices that require the following, at the cost of wasted I/O space:\r
/// ISA range and its aliases\r
/// The first device that requests the legacy VGA range will get all the\r
/// legacy VGA range plus its aliased addresses forwarded to it. The first\r
/// device that requests the legacy ISA range will get all the legacy ISA\r
-/// range plus its aliased addresses forwarded to it.\r
+/// range, plus its aliased addresses, forwarded to it.\r
/// - EFI_RESERVE_ISA_IO_NO_ALIAS | EFI_RESERVE_VGA_IO_ALIAS:<BR>\r
/// Sets aside the ISA I/O range (0x100 - 0x3FF) during PCI enumeration\r
/// and the aliases of the VGA I/O ranges. By using this selection, the\r
#define EFI_RESERVE_NONE_IO_ALIAS 0x0000\r
\r
///\r
-/// Sets aside ISA I/O range and all aliases\r
+/// Sets aside ISA I/O range and all aliases:\r
/// - n100..n3FF\r
/// - n500..n7FF\r
/// - n900..nBFF\r
-/// - nD00..nFFF\r
+/// - nD00..nFFF.\r
///\r
#define EFI_RESERVE_ISA_IO_ALIAS 0x0001\r
\r
///\r
-/// Sets aside ISA I/O range 0x100-0x3FF\r
+/// Sets aside ISA I/O range 0x100-0x3FF.\r
///\r
#define EFI_RESERVE_ISA_IO_NO_ALIAS 0x0002\r
\r
///\r
-/// Sets aside VGA I/O ranges and all aliases\r
+/// Sets aside VGA I/O ranges and all aliases.\r
///\r
#define EFI_RESERVE_VGA_IO_ALIAS 0x0004\r
\r
///\r
-/// Sets aside VGA I/O rangess\r
+/// Sets aside VGA I/O ranges\r
///\r
#define EFI_RESERVE_VGA_IO_NO_ALIAS 0x0008\r
\r
it needs to handle those errors on its own because there is no way to surface any\r
errors to the caller.\r
\r
- @param[in] This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.\r
+ @param[in] This The pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.\r
@param[in] HostBridge The handle of the host bridge controller.\r
@param[in] Phase The phase of the PCI bus enumeration.\r
@param[in] ExecPhase Defines the execution phase of the PCI chipset driver.\r
needs to handle those errors on its own because there is no way to surface any errors to\r
the caller.\r
\r
- @param[in] This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.\r
+ @param[in] This The pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.\r
@param[in] HostBridge The associated PCI host bridge handle.\r
@param[in] RootBridge The associated PCI root bridge handle.\r
@param[in] PciAddress The address of the PCI device on the PCI bus.\r
enumeration. The PCI bus driver and the PCI Host Bridge Resource Allocation Protocol\r
driver can call this member function to retrieve the policy.\r
\r
- @param[in] This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.\r
+ @param[in] This The pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.\r
@param[out] PciPolicy The platform policy with respect to VGA and ISA aliasing.\r
\r
@retval EFI_SUCCESS The function completed successfully.\r
scanning the ROM that is attached to any controller, which allows a platform to specify a ROM\r
image that is different from the ROM image on a PCI card.\r
\r
- @param[in] This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.\r
+ @param[in] This The pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.\r
@param[in] PciHandle The handle of the PCI device.\r
@param[out] RomImage If the call succeeds, the pointer to the pointer to the option ROM image.\r
Otherwise, this field is undefined. The memory for RomImage is allocated\r
@retval EFI_SUCCESS The option ROM was available for this device and loaded into memory.\r
@retval EFI_NOT_FOUND No option ROM was available for this device.\r
@retval EFI_OUT_OF_RESOURCES No memory was available to load the option ROM.\r
- @retval EFI_DEVICE_ERROR An error occurred in getting the option ROM.\r
+ @retval EFI_DEVICE_ERROR An error occurred in obtaining the option ROM.\r
\r
**/\r
typedef\r
EFI PXE Base Code Protocol definitions, which is used to access PXE-compatible \r
devices for network access and network booting.\r
\r
- Copyright (c) 2006 - 2010, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@par Revision Reference: \r
- This Protocol is introduced in EFI Specification 1.10 \r
+ This Protocol is introduced in EFI Specification 1.10. \r
\r
**/\r
#ifndef __PXE_BASE_CODE_PROTOCOL_H__\r
#define __PXE_BASE_CODE_PROTOCOL_H__\r
\r
///\r
-/// PXE Base Code protocol\r
+/// PXE Base Code protocol.\r
///\r
#define EFI_PXE_BASE_CODE_PROTOCOL_GUID \\r
{ \\r
#define DEFAULT_ToS 0\r
\r
///\r
-/// ICMP error format\r
+/// ICMP error format.\r
///\r
typedef struct {\r
UINT8 Type;\r
} EFI_PXE_BASE_CODE_ICMP_ERROR;\r
\r
///\r
-/// TFTP error format\r
+/// TFTP error format.\r
///\r
typedef struct {\r
UINT8 ErrorCode;\r
} EFI_PXE_BASE_CODE_TFTP_ERROR;\r
\r
///\r
-/// IP Receive Filter definitions\r
+/// IP Receive Filter definitions.\r
///\r
#define EFI_PXE_BASE_CODE_MAX_IPCNT 8\r
\r
///\r
-/// IP Receive Filter structure\r
+/// IP Receive Filter structure.\r
///\r
typedef struct {\r
UINT8 Filters;\r
#define EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS_MULTICAST 0x0008\r
\r
///\r
-/// ARP cache entries\r
+/// ARP cache entries.\r
///\r
typedef struct {\r
EFI_IP_ADDRESS IpAddr;\r
} EFI_PXE_BASE_CODE_ARP_ENTRY;\r
\r
///\r
-/// ARP route table entries\r
+/// ARP route table entries.\r
///\r
typedef struct {\r
EFI_IP_ADDRESS IpAddr;\r
} EFI_PXE_BASE_CODE_DISCOVER_INFO;\r
\r
///\r
-/// TFTP opcode definitions\r
+/// TFTP opcode definitions.\r
///\r
typedef enum {\r
EFI_PXE_BASE_CODE_TFTP_FIRST,\r
} EFI_PXE_BASE_CODE_MTFTP_INFO;\r
\r
///\r
-/// DHCPV4 Packet structure\r
+/// DHCPV4 Packet structure.\r
///\r
typedef struct {\r
UINT8 BootpOpcode;\r
} EFI_PXE_BASE_CODE_DHCPV6_PACKET;\r
\r
///\r
-/// Packet structure\r
+/// Packet structure.\r
///\r
typedef union {\r
UINT8 Raw[1472];\r
#define EFI_PXE_BASE_CODE_MAX_ROUTE_ENTRIES 8\r
\r
///\r
-/// EFI_PXE_BASE_CODE_MODE\r
+/// EFI_PXE_BASE_CODE_MODE.\r
/// The data values in this structure are read-only and \r
/// are updated by the code that produces the\r
/// EFI_PXE_BASE_CODE_PROTOCOL functions.\r
MakeCallbacksSet to TRUE if the PXE Base Code Callback Protocol is available.\r
Set to FALSE if the PXE Base Code Callback Protocol is not available.\r
\r
- @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
+ @param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
@param UseIpv6 Specifies the type of IP addresses that are to be used during the session\r
that is being started. Set to TRUE for IPv6 addresses, and FALSE for \r
IPv4 addresses. \r
set to FALSE and EFI_SUCCESS is returned. If the Started field of the EFI_PXE_BASE_CODE_MODE\r
structure is already FALSE, then EFI_NOT_STARTED will be returned.\r
\r
- @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
+ @param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
\r
@retval EFI_SUCCESS The PXE Base Code Protocol was stopped.\r
@retval EFI_NOT_STARTED The PXE Base Code Protocol is already in the stopped state. \r
If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,\r
then the DHCP sequence will be stopped and EFI_ABORTED will be returned.\r
\r
- @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
+ @param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
@param SortOffers TRUE if the offers received should be sorted. Set to FALSE to try the\r
offers in the order that they are received. \r
\r
If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,\r
then the Discovery sequence is stopped and EFI_ABORTED will be returned.\r
\r
- @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
+ @param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
@param Type The type of bootstrap to perform.\r
- @param Layer Pointer to the boot server layer number to discover, which must be\r
+ @param Layer The pointer to the boot server layer number to discover, which must be\r
PXE_BOOT_LAYER_INITIAL when a new server type is being \r
discovered. \r
@param UseBis TRUE if Boot Integrity Services are to be used. FALSE otherwise. \r
- @param Info Pointer to a data structure that contains additional information on the\r
+ @param Info The pointer to a data structure that contains additional information on the\r
type of discovery operation that is to be performed. \r
\r
@retval EFI_SUCCESS The Discovery sequence has been completed.\r
entry is itself null-terminated, so that the final information string is terminated\r
with two null octets.\r
\r
- @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
+ @param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
@param Operation The type of operation to perform.\r
@param BufferPtr A pointer to the data buffer. \r
@param Overwrite Only used on write file operations. TRUE if a file on a remote server can\r
@param ServerIp The TFTP / MTFTP server IP address.\r
@param Filename A Null-terminated ASCII string that specifies a directory name or a file\r
name. \r
- @param Info Pointer to the MTFTP information.\r
+ @param Info The pointer to the MTFTP information.\r
@param DontUseBuffer Set to FALSE for normal TFTP and MTFTP read file operation. \r
\r
@retval EFI_SUCCESS The TFTP/MTFTP operation was completed.\r
EFI_ICMP_ERROR will be returned. If the Callback Protocol does not return\r
EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED will be returned.\r
\r
- @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
+ @param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
@param OpFlags The UDP operation flags. \r
@param DestIp The destination IP address.\r
@param DestPort The destination UDP port number. \r
\r
This function reads a UDP packet from a network interface. The data contents\r
are returned in (the optional HeaderPtr and) BufferPtr, and the size of the\r
- buffer received is returned in BufferSize . If the input BufferSize is smaller\r
+ buffer received is returned in BufferSize. If the input BufferSize is smaller\r
than the UDP packet received (less optional HeaderSize), it will be set to the\r
required size, and EFI_BUFFER_TOO_SMALL will be returned. In this case, the\r
contents of BufferPtr are undefined, and the packet is lost. If a UDP packet is\r
input values, different types of UDP packet receive filtering will be performed.\r
The following tables summarize these receive filter operations.\r
\r
- @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
+ @param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
@param OpFlags The UDP operation flags. \r
@param DestIp The destination IP address.\r
@param DestPort The destination UDP port number.\r
If an application or driver wishes to preserve the IP receive filter settings,\r
it will have to preserve the IP receive filter settings before these calls, and\r
use SetIpFilter() to restore them after the calls. If incompatible filtering is\r
- requested (for example, PROMISCUOUS with anything else) or if the device does not\r
+ requested (for example, PROMISCUOUS with anything else), or if the device does not\r
support a requested filter setting and it cannot be accommodated in software\r
(for example, PROMISCUOUS not supported), EFI_INVALID_PARAMETER will be returned.\r
The IPlist field is used to enable IPs other than the StationIP. They may be\r
multicast or unicast. If IPcnt is set as well as EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP,\r
then both the StationIP and the IPs from the IPlist will be used.\r
\r
- @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
- @param NewFilter Pointer to the new set of IP receive filters.\r
+ @param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
+ @param NewFilter The pointer to the new set of IP receive filters.\r
\r
@retval EFI_SUCCESS The IP receive filter settings were updated.\r
@retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED is\r
returned.\r
\r
- @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
- @param IpAddr Pointer to the IP address that is used to resolve a MAC address.\r
+ @param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
+ @param IpAddr The pointer to the IP address that is used to resolve a MAC address.\r
@param MacAddr If not NULL, a pointer to the MAC address that was resolved with the\r
ARP protocol. \r
\r
The SetParameters() call must be invoked after a Callback Protocol is installed\r
to enable the use of callbacks.\r
\r
- @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
+ @param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
@param NewAutoArp If not NULL, a pointer to a value that specifies whether to replace the\r
current value of AutoARP. \r
@param NewSendGUID If not NULL, a pointer to a value that specifies whether to replace the\r
Otherwise, this function updates the SubnetMask field of the EFI_PXE_BASE_CODE_MODE\r
structure with NewSubnetMask.\r
\r
- @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
- @param NewStationIp Pointer to the new IP address to be used by the network device. \r
- @param NewSubnetMask Pointer to the new subnet mask to be used by the network device. \r
+ @param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
+ @param NewStationIp The pointer to the new IP address to be used by the network device. \r
+ @param NewSubnetMask The pointer to the new subnet mask to be used by the network device. \r
\r
@retval EFI_SUCCESS The new station IP address and/or subnet mask were updated.\r
@retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
The pointers to the new packets are used to update the contents of the cached\r
packets in the EFI_PXE_BASE_CODE_MODE structure.\r
\r
- @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
- @param NewDhcpDiscoverValid Pointer to a value that will replace the current\r
+ @param This The pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r
+ @param NewDhcpDiscoverValid The pointer to a value that will replace the current\r
DhcpDiscoverValid field. \r
- @param NewDhcpAckReceived Pointer to a value that will replace the current\r
+ @param NewDhcpAckReceived The pointer to a value that will replace the current\r
DhcpAckReceived field. \r
- @param NewProxyOfferReceived Pointer to a value that will replace the current\r
+ @param NewProxyOfferReceived The pointer to a value that will replace the current\r
ProxyOfferReceived field. \r
- @param NewPxeDiscoverValid Pointer to a value that will replace the current \r
+ @param NewPxeDiscoverValid The pointer to a value that will replace the current \r
ProxyOfferReceived field. \r
- @param NewPxeReplyReceived Pointer to a value that will replace the current\r
+ @param NewPxeReplyReceived The pointer to a value that will replace the current\r
PxeReplyReceived field. \r
- @param NewPxeBisReplyReceived Pointer to a value that will replace the current\r
+ @param NewPxeBisReplyReceived The pointer to a value that will replace the current\r
PxeBisReplyReceived field. \r
- @param NewDhcpDiscover Pointer to the new cached DHCP Discover packet contents. \r
- @param NewDhcpAck Pointer to the new cached DHCP Ack packet contents.\r
- @param NewProxyOffer Pointer to the new cached Proxy Offer packet contents.\r
- @param NewPxeDiscover Pointer to the new cached PXE Discover packet contents.\r
- @param NewPxeReply Pointer to the new cached PXE Reply packet contents.\r
- @param NewPxeBisReply Pointer to the new cached PXE BIS Reply packet contents.\r
+ @param NewDhcpDiscover The pointer to the new cached DHCP Discover packet contents. \r
+ @param NewDhcpAck The pointer to the new cached DHCP Ack packet contents.\r
+ @param NewProxyOffer The pointer to the new cached Proxy Offer packet contents.\r
+ @param NewPxeDiscover The pointer to the new cached PXE Discover packet contents.\r
+ @param NewPxeReply The pointer to the new cached PXE Reply packet contents.\r
+ @param NewPxeBisReply The pointer to the new cached PXE BIS Reply packet contents.\r
\r
@retval EFI_SUCCESS The cached packet contents were updated.\r
@retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r
EFI_PXE_BASE_CODE_SET_STATION_IP SetStationIp;\r
EFI_PXE_BASE_CODE_SET_PACKETS SetPackets;\r
///\r
- /// Pointer to the EFI_PXE_BASE_CODE_MODE data for this device.\r
+ /// The pointer to the EFI_PXE_BASE_CODE_MODE data for this device.\r
///\r
EFI_PXE_BASE_CODE_MODE *Mode;\r
};\r
It is invoked when the PXE Base Code Protocol is about to transmit, has received, \r
or is waiting to receive a packet.\r
\r
- Copyright (c) 2006 - 2009, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@par Revision Reference: \r
This Protocol is introduced in EFI Specification 1.10\r
#define _PXE_BASE_CODE_CALLBACK_H_\r
\r
///\r
-/// Call Back Definitions\r
+/// Call Back Definitions.\r
///\r
#define EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_GUID \\r
{ \\r
}\r
\r
///\r
-/// UEFI Revision Number Definition\r
+/// UEFI Revision Number Definition.\r
///\r
#define EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION 0x00010000\r
\r
///\r
-/// EFI 1.1 Revision Number defintion\r
+/// EFI 1.1 Revision Number defintion.\r
///\r
#define EFI_PXE_BASE_CODE_CALLBACK_INTERFACE_REVISION \\r
EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION\r
\r
///\r
-/// UEFI Protocol name\r
+/// UEFI Protocol name.\r
///\r
typedef struct _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL;\r
\r
///\r
-/// EFI1.1 Protocol name\r
+/// EFI1.1 Protocol name.\r
/// \r
typedef EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL EFI_PXE_BASE_CODE_CALLBACK;\r
\r
///\r
-/// Event type list for PXE Base Code Protocol function\r
+/// Event type list for PXE Base Code Protocol function.\r
///\r
typedef enum {\r
EFI_PXE_BASE_CODE_FUNCTION_FIRST,\r
} EFI_PXE_BASE_CODE_FUNCTION;\r
\r
///\r
-/// Callback status type\r
+/// Callback status type.\r
///\r
typedef enum {\r
EFI_PXE_BASE_CODE_CALLBACK_STATUS_FIRST,\r
The SetParameters() function must be called after a Callback Protocol is installed to enable the\r
use of callbacks.\r
\r
- @param This Pointer to the EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL instance.\r
+ @param This The pointer to the EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL instance.\r
@param Function The PXE Base Code Protocol function that is waiting for an event. \r
@param Received TRUE if the callback is being invoked due to a receive event. FALSE if\r
the callback is being invoked due to a transmit event. \r
\r
UEFI 2.0 can boot from any valid EFI image contained in a SimpleFileSystem.\r
\r
- Copyright (c) 2006 - 2009, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@retval EFI_UNSUPPORTED This volume does not support the file system.\r
@retval EFI_NO_MEDIA The device has no media.\r
@retval EFI_DEVICE_ERROR The device reported an error.\r
- @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r
- @retval EFI_ACCESS_DENIED The service denied access to the file\r
- @retval EFI_OUT_OF_RESOURCES The volume was not opened due to lack of resources\r
+ @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
+ @retval EFI_ACCESS_DENIED The service denied access to the file.\r
+ @retval EFI_OUT_OF_RESOURCES The volume was not opened due to lack of resources.\r
\r
**/\r
typedef\r
/**\r
Opens a new file relative to the source file's location.\r
\r
- @param This Protocol instance pointer.\r
- @param NewHandle Returns File Handle for FileName\r
- @param FileName Null terminated string. "\", ".", and ".." are supported\r
+ @param This The protocol instance pointer.\r
+ @param NewHandle Returns File Handle for FileName.\r
+ @param FileName Null terminated string. "\", ".", and ".." are supported.\r
@param OpenMode Open mode for file.\r
- @param Attributes Only used for EFI_FILE_MODE_CREATE\r
+ @param Attributes Only used for EFI_FILE_MODE_CREATE.\r
\r
@retval EFI_SUCCESS The device was opened.\r
- @retval EFI_NOT_FOUND The specified file could not be found on the device\r
+ @retval EFI_NOT_FOUND The specified file could not be found on the device.\r
@retval EFI_NO_MEDIA The device has no media.\r
- @retval EFI_MEDIA_CHANGED The media has changed\r
+ @retval EFI_MEDIA_CHANGED The media has changed.\r
@retval EFI_DEVICE_ERROR The device reported an error.\r
- @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r
- @retval EFI_ACCESS_DENIED The service denied access to the file\r
- @retval EFI_OUT_OF_RESOURCES The volume was not opened due to lack of resources\r
+ @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
+ @retval EFI_ACCESS_DENIED The service denied access to the file.\r
+ @retval EFI_OUT_OF_RESOURCES The volume was not opened due to lack of resources.\r
@retval EFI_VOLUME_FULL The volume is full.\r
\r
**/\r
);\r
\r
/**\r
- Close and delete the file handle\r
+ Close and delete the file handle.\r
\r
@param This Protocol instance pointer.\r
\r
@retval EFI_SUCCESS The device was opened.\r
- @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted\r
+ @retval EFI_WARN_DELETE_FAILURE The handle was closed but the file was not deleted.\r
\r
**/\r
typedef\r
@param Buffer The buffer in which data is read.\r
\r
@retval EFI_SUCCESS Data was read.\r
- @retval EFI_NO_MEDIA The device has no media\r
- @retval EFI_DEVICE_ERROR The device reported an error\r
- @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r
- @retval EFI_BUFFER_TO_SMALL BufferSize is too small. BufferSize contains required size\r
+ @retval EFI_NO_MEDIA The device has no media.\r
+ @retval EFI_DEVICE_ERROR The device reported an error.\r
+ @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
+ @retval EFI_BUFFER_TO_SMALL BufferSize is too small. BufferSize contains required size.\r
\r
**/\r
typedef\r
@param Buffer The buffer in which data to write.\r
\r
@retval EFI_SUCCESS Data was written.\r
- @retval EFI_UNSUPPORT Writes to Open directory are not supported\r
- @retval EFI_NO_MEDIA The device has no media\r
- @retval EFI_DEVICE_ERROR The device reported an error\r
- @retval EFI_DEVICE_ERROR An attempt was made to write to a deleted file\r
- @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r
- @retval EFI_WRITE_PROTECTED The device is write protected\r
- @retval EFI_ACCESS_DENIED The file was open for read only\r
- @retval EFI_VOLUME_FULL The volume is full\r
+ @retval EFI_UNSUPPORT Writes to Open directory are not supported.\r
+ @retval EFI_NO_MEDIA The device has no media.\r
+ @retval EFI_DEVICE_ERROR The device reported an error.\r
+ @retval EFI_DEVICE_ERROR An attempt was made to write to a deleted file.\r
+ @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
+ @retval EFI_WRITE_PROTECTED The device is write protected.\r
+ @retval EFI_ACCESS_DENIED The file was open for read only.\r
+ @retval EFI_VOLUME_FULL The volume is full.\r
\r
**/\r
typedef\r
Set a files current position\r
\r
@param This Protocol instance pointer.\r
- @param Position Byte position from the start of the file\r
+ @param Position Byte position from the start of the file.\r
\r
@retval EFI_SUCCESS Data was written.\r
@retval EFI_UNSUPPORTED Seek request for non-zero is not valid on open.\r
Get a file's current position\r
\r
@param This Protocol instance pointer.\r
- @param Position Byte position from the start of the file\r
+ @param Position Byte position from the start of the file.\r
\r
@retval EFI_SUCCESS Data was written.\r
- @retval EFI_UNSUPPORTED Seek request for non-zero is not valid on open.\r
+ @retval EFI_UNSUPPORTED Seek request for non-zero is not valid on open..\r
\r
**/\r
typedef\r
);\r
\r
/**\r
- Get information about a file\r
+ Get information about a file.\r
\r
@param This Protocol instance pointer.\r
- @param InformationType Type of info to return in Buffer\r
+ @param InformationType Type of information to return in Buffer.\r
@param BufferSize On input size of buffer, on output amount of data in buffer.\r
@param Buffer The buffer to return data.\r
\r
@retval EFI_SUCCESS Data was returned.\r
- @retval EFI_UNSUPPORT InformationType is not supported\r
- @retval EFI_NO_MEDIA The device has no media\r
- @retval EFI_DEVICE_ERROR The device reported an error\r
- @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r
- @retval EFI_WRITE_PROTECTED The device is write protected\r
- @retval EFI_ACCESS_DENIED The file was open for read only\r
- @retval EFI_BUFFER_TOO_SMALL Buffer was too small, required size returned in BufferSize\r
+ @retval EFI_UNSUPPORT InformationType is not supported.\r
+ @retval EFI_NO_MEDIA The device has no media.\r
+ @retval EFI_DEVICE_ERROR The device reported an error.\r
+ @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
+ @retval EFI_WRITE_PROTECTED The device is write protected.\r
+ @retval EFI_ACCESS_DENIED The file was open for read only.\r
+ @retval EFI_BUFFER_TOO_SMALL Buffer was too small; required size returned in BufferSize.\r
\r
**/\r
typedef\r
Set information about a file\r
\r
@param File Protocol instance pointer.\r
- @param InformationType Type of info in Buffer\r
+ @param InformationType Type of information in Buffer.\r
@param BufferSize Size of buffer.\r
@param Buffer The data to write.\r
\r
@retval EFI_SUCCESS Data was returned.\r
- @retval EFI_UNSUPPORT InformationType is not supported\r
- @retval EFI_NO_MEDIA The device has no media\r
- @retval EFI_DEVICE_ERROR The device reported an error\r
- @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r
- @retval EFI_WRITE_PROTECTED The device is write protected\r
- @retval EFI_ACCESS_DENIED The file was open for read only\r
+ @retval EFI_UNSUPPORT InformationType is not supported.\r
+ @retval EFI_NO_MEDIA The device has no media.\r
+ @retval EFI_DEVICE_ERROR The device reported an error.\r
+ @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
+ @retval EFI_WRITE_PROTECTED The device is write protected.\r
+ @retval EFI_ACCESS_DENIED The file was open for read only.\r
\r
**/\r
typedef\r
);\r
\r
/**\r
- Flush data back for the file handle\r
+ Flush data back for the file handle.\r
\r
@param This Protocol instance pointer.\r
\r
@retval EFI_SUCCESS Data was written.\r
- @retval EFI_UNSUPPORT Writes to Open directory are not supported\r
- @retval EFI_NO_MEDIA The device has no media\r
- @retval EFI_DEVICE_ERROR The device reported an error\r
- @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted\r
- @retval EFI_WRITE_PROTECTED The device is write protected\r
- @retval EFI_ACCESS_DENIED The file was open for read only\r
- @retval EFI_VOLUME_FULL The volume is full\r
+ @retval EFI_UNSUPPORT Writes to Open directory are not supported.\r
+ @retval EFI_NO_MEDIA The device has no media.\r
+ @retval EFI_DEVICE_ERROR The device reported an error.\r
+ @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.\r
+ @retval EFI_WRITE_PROTECTED The device is write protected.\r
+ @retval EFI_ACCESS_DENIED The file was open for read only.\r
+ @retval EFI_VOLUME_FULL The volume is full.\r
\r
**/\r
typedef\r
MCast - MultiCast\r
...\r
\r
- Copyright (c) 2006 - 2009, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@par Revision Reference: \r
- This Protocol is introduced in EFI Specification 1.10 \r
+ This Protocol is introduced in EFI Specification 1.10. \r
\r
**/\r
\r
typedef EFI_SIMPLE_NETWORK_PROTOCOL EFI_SIMPLE_NETWORK;\r
\r
///\r
-/// Simple Network Protocol data structures\r
+/// Simple Network Protocol data structures.\r
///\r
typedef struct {\r
///\r
} EFI_NETWORK_STATISTICS;\r
\r
///\r
-/// State of the network interface\r
+/// The state of the network interface.\r
/// When an EFI_SIMPLE_NETWORK_PROTOCOL driver initializes a\r
/// network interface, the network interface is left in the EfiSimpleNetworkStopped state.\r
///\r
required by the network interface; optionally, also requests allocation \r
of additional transmit and receive buffers.\r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
@param ExtraRxBufferSize The size, in bytes, of the extra receive buffer space\r
that the driver should allocate for the network interface.\r
Some network interfaces will not be able to use the extra\r
being used.\r
\r
@retval EFI_SUCCESS The network interface was initialized.\r
- @retval EFI_NOT_STARTED The network interface has not been started\r
+ @retval EFI_NOT_STARTED The network interface has not been started.\r
@retval EFI_OUT_OF_RESOURCES There was not enough memory for the transmit and\r
receive buffers.\r
@retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.\r
Resets a network adapter and re-initializes it with the parameters that were \r
provided in the previous call to Initialize(). \r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
@param ExtendedVerification Indicates that the driver may perform a more\r
exhaustive verification operation of the device\r
during reset.\r
\r
@retval EFI_SUCCESS The network interface was reset.\r
- @retval EFI_NOT_STARTED The network interface has not been started\r
+ @retval EFI_NOT_STARTED The network interface has not been started.\r
@retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.\r
@retval EFI_DEVICE_ERROR The command could not be sent to the network interface.\r
@retval EFI_UNSUPPORTED This function is not supported by the network interface.\r
@param This Protocol instance pointer.\r
\r
@retval EFI_SUCCESS The network interface was shutdown.\r
- @retval EFI_NOT_STARTED The network interface has not been started\r
+ @retval EFI_NOT_STARTED The network interface has not been started.\r
@retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.\r
@retval EFI_DEVICE_ERROR The command could not be sent to the network interface.\r
@retval EFI_UNSUPPORTED This function is not supported by the network interface.\r
/**\r
Manages the multicast receive filters of a network interface.\r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
@param Enable A bit mask of receive filters to enable on the network interface.\r
@param Disable A bit mask of receive filters to disable on the network interface.\r
@param ResetMCastFilter Set to TRUE to reset the contents of the multicast receive\r
ResetMCastFilter is TRUE.\r
\r
@retval EFI_SUCCESS The multicast receive filter list was updated.\r
- @retval EFI_NOT_STARTED The network interface has not been started\r
+ @retval EFI_NOT_STARTED The network interface has not been started.\r
@retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.\r
@retval EFI_DEVICE_ERROR The command could not be sent to the network interface.\r
@retval EFI_UNSUPPORTED This function is not supported by the network interface.\r
/**\r
Modifies or resets the current station address, if supported.\r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
@param Reset Flag used to reset the station address to the network interfaces\r
permanent address.\r
- @param New New station address to be used for the network interface.\r
+ @param New The new station address to be used for the network interface.\r
\r
@retval EFI_SUCCESS The network interfaces station address was updated.\r
- @retval EFI_NOT_STARTED The network interface has not been started\r
+ @retval EFI_NOT_STARTED The network interface has not been started.\r
@retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.\r
@retval EFI_DEVICE_ERROR The command could not be sent to the network interface.\r
@retval EFI_UNSUPPORTED This function is not supported by the network interface.\r
/**\r
Converts a multicast IP address to a multicast HW MAC address.\r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
@param IPv6 Set to TRUE if the multicast IP address is IPv6 [RFC 2460]. Set\r
to FALSE if the multicast IP address is IPv4 [RFC 791].\r
@param IP The multicast IP address that is to be converted to a multicast\r
Performs read and write operations on the NVRAM device attached to a \r
network interface.\r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
@param ReadWrite TRUE for read operations, FALSE for write operations.\r
@param Offset Byte offset in the NVRAM device at which to start the read or\r
write operation. This must be a multiple of NvRamAccessSize and\r
Reads the current interrupt status and recycled transmit buffer status from \r
a network interface.\r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
@param InterruptStatus A pointer to the bit mask of the currently active interrupts\r
If this is NULL, the interrupt status will not be read from\r
the device. If this is not NULL, the interrupt status will\r
/**\r
Places a packet in the transmit queue of a network interface.\r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
@param HeaderSize The size, in bytes, of the media header to be filled in by\r
the Transmit() function. If HeaderSize is non-zero, then it\r
must be equal to This->Mode->MediaHeaderSize and the DestAddr\r
/**\r
Receives a packet from a network interface.\r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
@param HeaderSize The size, in bytes, of the media header received on the network\r
interface. If this parameter is NULL, then the media header size\r
will not be returned.\r
a single hardware device or a virtual device that is an aggregation\r
of multiple physical devices.\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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
Reset the text output device hardware and optionaly run diagnostics\r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
@param ExtendedVerification Driver may perform more exhaustive verfication\r
operation of the device during reset.\r
\r
/**\r
Write a string to the output device.\r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
@param String The NULL-terminated string to be displayed on the output\r
device(s). All output devices must also support the Unicode\r
drawing character codes defined in this file.\r
Verifies that all characters in a string can be output to the \r
target device.\r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
@param String The NULL-terminated string to be examined for the output\r
device(s).\r
\r
Returns information for an available text mode that the output device(s)\r
supports.\r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
@param ModeNumber The mode number to return information on.\r
@param Columns Returns the geometry of the text output device for the\r
requested ModeNumber.\r
/**\r
Sets the output device(s) to a specified mode.\r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
@param ModeNumber The mode number to set.\r
\r
@retval EFI_SUCCESS The requested text mode was set.\r
Sets the background and foreground colors for the OutputString () and\r
ClearScreen () functions.\r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
@param Attribute The attribute to set. Bits 0..3 are the foreground color, and\r
bits 4..6 are the background color. All other bits are undefined\r
and must be zero. The valid Attributes are defined in this file.\r
Clears the output device(s) display to the currently selected background \r
color.\r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_DEVICE_ERROR The device had an error and could not complete the request.\r
/**\r
Sets the current coordinates of the cursor position\r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
@param Column The position to set the cursor to. Must be greater than or\r
equal to zero and less than the number of columns and rows\r
by QueryMode ().\r
/**\r
Makes the cursor visible or invisible\r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
@param Visible If TRUE, the cursor is set to be visible. If FALSE, the cursor is\r
set to be invisible.\r
\r
///\r
INT32 Mode;\r
///\r
- /// The current character output attribute\r
+ /// The current character output attribute.\r
///\r
INT32 Attribute;\r
///\r
EFI_TAPE_IO_PROTOCOL as defined in the UEFI 2.0.\r
Provide services to control and access a tape device.\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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
Reads from the tape.\r
\r
@param This A pointer to the EFI_TAPE_IO_PROTOCOL instance.\r
- @param BufferSize Size of the buffer in bytes pointed to by Buffer.\r
- @param Buffer Pointer to the buffer for data to be read into.\r
+ @param BufferSize The size of the buffer in bytes pointed to by Buffer.\r
+ @param Buffer The pointer to the buffer for data to be read into.\r
\r
@retval EFI_SUCCESS Data was successfully transferred from the media.\r
@retval EFI_END_OF_FILE A filemark was encountered which limited the data\r
The transfer was aborted since the current position of the\r
media may be incorrect.\r
@retval EFI_INVALID_PARAMETER A NULL Buffer was specified with a non-zero\r
- BufferSize or the device is operating in fixed block\r
+ BufferSize, or the device is operating in fixed block\r
size mode and the BufferSize was not a multiple of\r
device's fixed block size\r
@retval EFI_DEVICE_ERROR A device error occurred while attempting to transfer data\r
\r
@param This A pointer to the EFI_TAPE_IO_PROTOCOL instance.\r
@param BufferSize Size of the buffer in bytes pointed to by Buffer.\r
- @param Buffer Pointer to the buffer for data to be written from.\r
+ @param Buffer The pointer to the buffer for data to be written from.\r
\r
@retval EFI_SUCCESS Data was successfully transferred to the media.\r
@retval EFI_END_OF_MEDIA The logical end of media has been reached. Data may have\r
@retval EFI_WRITE_PROTECTED The media in the device is write-protected. The transfer\r
was aborted since a write cannot be completed.\r
@retval EFI_INVALID_PARAMETER A NULL Buffer was specified with a non-zero\r
- BufferSize or the device is operating in fixed block\r
+ BufferSize, or the device is operating in fixed block\r
size mode and the BufferSize was not a multiple of\r
device's fixed block size\r
@retval EFI_DEVICE_ERROR A device error occurred while attempting to transfer data\r
TCG Service Protocol as defined in TCG_EFI_Protocol_1_20_Final\r
See http://trustedcomputinggroup.org for the latest specification\r
\r
- Copyright (c) 2007 - 2009, 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) 2007 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
} TCG_VERSION;\r
\r
typedef struct _TCG_EFI_BOOT_SERVICE_CAPABILITY {\r
- UINT8 Size; /// Size of this structure\r
+ UINT8 Size; /// Size of this structure.\r
TCG_VERSION StructureVersion; \r
TCG_VERSION ProtocolSpecVersion;\r
- UINT8 HashAlgorithmBitmap; /// Hash algorithms \r
- /// this protocol is capable of : 01=SHA-1\r
- BOOLEAN TPMPresentFlag; /// 00h = TPM not present\r
- BOOLEAN TPMDeactivatedFlag; /// 01h = TPM currently deactivated\r
+ UINT8 HashAlgorithmBitmap; /// Hash algorithms . \r
+ /// This protocol is capable of : 01=SHA-1.\r
+ BOOLEAN TPMPresentFlag; /// 00h = TPM not present.\r
+ BOOLEAN TPMDeactivatedFlag; /// 01h = TPM currently deactivated.\r
} TCG_EFI_BOOT_SERVICE_CAPABILITY;\r
\r
typedef UINT32 TCG_ALGORITHM_ID;\r
this is a pointer to the address of the start of \r
the last entry in the event log in memory. \r
\r
- @retval EFI_SUCCESS Operation completed successfully.\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_INVALID_PARAMETER ProtocolCapability does not match TCG capability.\r
**/\r
typedef\r
/**\r
This service abstracts the capability to do a hash operation on a data buffer.\r
\r
- @param This Indicates the calling context\r
- @param HashData Pointer to the data buffer to be hashed\r
- @param HashDataLen Length of the data buffer to be hashed\r
- @param AlgorithmId Identification of the Algorithm to use for the hashing operation\r
- @param HashedDataLen Resultant length of the hashed data\r
- @param HashedDataResult Resultant buffer of the hashed data \r
+ @param This Indicates the calling context.\r
+ @param HashData The pointer to the data buffer to be hashed.\r
+ @param HashDataLen The length of the data buffer to be hashed.\r
+ @param AlgorithmId Identification of the Algorithm to use for the hashing operation.\r
+ @param HashedDataLen Resultant length of the hashed data.\r
+ @param HashedDataResult Resultant buffer of the hashed data.\r
\r
- @retval EFI_SUCCESS Operation completed successfully.\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_INVALID_PARAMETER HashDataLen is NULL.\r
@retval EFI_INVALID_PARAMETER HashDataLenResult is NULL.\r
@retval EFI_OUT_OF_RESOURCES Cannot allocate buffer of size *HashedDataLen.\r
This service abstracts the capability to add an entry to the Event Log.\r
\r
@param This Indicates the calling context\r
- @param TCGLogData Pointer to the start of the data buffer containing \r
+ @param TCGLogData The pointer to the start of the data buffer containing \r
the TCG_PCR_EVENT data structure. All fields in \r
this structure are properly filled by the caller.\r
- @param EventNumber The event number of the event just logged\r
- @param Flags Indicate additional flags. Only one flag has been \r
+ @param EventNumber The event number of the event just logged.\r
+ @param Flags Indicates additional flags. Only one flag has been \r
defined at this time, which is 0x01 and means the \r
extend operation should not be performed. All \r
other bits are reserved. \r
\r
- @retval EFI_SUCCESS Operation completed successfully.\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_OUT_OF_RESOURCES Insufficient memory in the event log to complete this action.\r
**/\r
typedef\r
/**\r
This service is a proxy for commands to the TPM.\r
\r
- @param This Indicates the calling context\r
- @param TpmInputParameterBlockSize Size of the TPM input parameter block\r
- @param TpmInputParameterBlock Pointer to the TPM input parameter block\r
- @param TpmOutputParameterBlockSize Size of the TPM output parameter block\r
- @param TpmOutputParameterBlock Pointer to the TPM output parameter block\r
+ @param This Indicates the calling context.\r
+ @param TpmInputParameterBlockSize Size of the TPM input parameter block.\r
+ @param TpmInputParameterBlock The pointer to the TPM input parameter block.\r
+ @param TpmOutputParameterBlockSize Size of the TPM output parameter block.\r
+ @param TpmOutputParameterBlock The pointer to the TPM output parameter block.\r
\r
- @retval EFI_SUCCESS Operation completed successfully.\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_INVALID_PARAMETER Invalid ordinal.\r
@retval EFI_UNSUPPORTED Current Task Priority Level >= EFI_TPL_CALLBACK.\r
@retval EFI_TIMEOUT The TIS timed-out.\r
This service abstracts the capability to do a hash operation on a data buffer, extend a specific TPM PCR with the hash result, and add an entry to the Event Log\r
\r
@param This Indicates the calling context\r
- @param HashData Physical address of the start of the data buffer \r
+ @param HashData The physical address of the start of the data buffer \r
to be hashed, extended, and logged.\r
@param HashDataLen The length, in bytes, of the buffer referenced by HashData\r
@param AlgorithmId Identification of the Algorithm to use for the hashing operation\r
@param TCGLogData The physical address of the start of the data \r
buffer containing the TCG_PCR_EVENT data structure.\r
@param EventNumber The event number of the event just logged.\r
- @param EventLogLastEntry Physical address of the first byte of the entry \r
+ @param EventLogLastEntry The physical address of the first byte of the entry \r
just placed in the Event Log. If the Event Log was \r
empty when this function was called then this physical \r
address will be the same as the physical address of \r
the start of the Event Log.\r
\r
- @retval EFI_SUCCESS Operation completed successfully.\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_UNSUPPORTED AlgorithmId != TPM_ALG_SHA.\r
@retval EFI_UNSUPPORTED Current TPL >= EFI_TPL_CALLBACK.\r
@retval EFI_DEVICE_ERROR The command was unsuccessful.\r
and destroy child of the driver to communicate with other host using TCP protocol.\r
The EFI TCPv4 Protocol provides services to send and receive data stream.\r
\r
- Copyright (c) 2006 - 2010, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@par Revision Reference:\r
- This Protocol is introduced in UEFI Specification 2.0\r
+ This Protocol is introduced in UEFI Specification 2.0.\r
\r
**/\r
\r
/**\r
Get the current operational status.\r
\r
- @param This Pointer to the EFI_TCP4_PROTOCOL instance.\r
- @param Tcp4State Pointer to the buffer to receive the current TCP state.\r
- @param Tcp4ConfigData Pointer to the buffer to receive the current TCP configuration.\r
- @param Ip4ModeData Pointer to the buffer to receive the current IPv4 configuration\r
+ @param This The pointer to the EFI_TCP4_PROTOCOL instance.\r
+ @param Tcp4State The pointer to the buffer to receive the current TCP state.\r
+ @param Tcp4ConfigData The pointer to the buffer to receive the current TCP configuration.\r
+ @param Ip4ModeData The pointer to the buffer to receive the current IPv4 configuration\r
data used by the TCPv4 instance.\r
- @param MnpConfigData Pointer to the buffer to receive the current MNP configuration\r
+ @param MnpConfigData The pointer to the buffer to receive the current MNP configuration\r
data used indirectly by the TCPv4 instance.\r
- @param SnpModeData Pointer to the buffer to receive the current SNP configuration\r
+ @param SnpModeData The pointer to the buffer to receive the current SNP configuration\r
data used indirectly by the TCPv4 instance.\r
\r
@retval EFI_SUCCESS The mode data was read.\r
/**\r
Initialize or brutally reset the operational parameters for this EFI TCPv4 instance.\r
\r
- @param This Pointer to the EFI_TCP4_PROTOCOL instance.\r
- @param Tcp4ConfigData Pointer to the configure data to configure the instance.\r
+ @param This The pointer to the EFI_TCP4_PROTOCOL instance.\r
+ @param Tcp4ConfigData The pointer to the configure data to configure the instance.\r
\r
@retval EFI_SUCCESS The operational settings are set, changed, or reset\r
successfully.\r
/**\r
Add or delete a route entry to the route table\r
\r
- @param This Pointer to the EFI_TCP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_TCP4_PROTOCOL instance.\r
@param DeleteRoute Set it to TRUE to delete this route from the routing table. Set it to\r
FALSE to add this route to the routing table.\r
DestinationAddress and SubnetMask are used as the\r
/**\r
Initiate a nonblocking TCP connection request for an active TCP instance.\r
\r
- @param This Pointer to the EFI_TCP4_PROTOCOL instance.\r
- @param ConnectionToken Pointer to the connection token to return when the TCP three\r
+ @param This The pointer to the EFI_TCP4_PROTOCOL instance.\r
+ @param ConnectionToken The pointer to the connection token to return when the TCP three\r
way handshake finishes.\r
\r
@retval EFI_SUCCESS The connection request is successfully initiated and the state\r
/**\r
Listen on the passive instance to accept an incoming connection request. This is a nonblocking operation.\r
\r
- @param This Pointer to the EFI_TCP4_PROTOCOL instance.\r
- @param ListenToken Pointer to the listen token to return when operation finishes.\r
+ @param This The pointer to the EFI_TCP4_PROTOCOL instance.\r
+ @param ListenToken The pointer to the listen token to return when operation finishes.\r
\r
@retval EFI_SUCCESS The listen token has been queued successfully.\r
@retval EFI_NOT_STARTED This EFI TCPv4 Protocol instance has not been configured.\r
/**\r
Queues outgoing data into the transmit queue.\r
\r
- @param This Pointer to the EFI_TCP4_PROTOCOL instance.\r
- @param Token Pointer to the completion token to queue to the transmit queue.\r
+ @param This The pointer to the EFI_TCP4_PROTOCOL instance.\r
+ @param Token The pointer to the completion token to queue to the transmit queue.\r
\r
@retval EFI_SUCCESS The data has been queued for transmission.\r
@retval EFI_NOT_STARTED This EFI TCPv4 Protocol instance has not been configured.\r
/**\r
Places an asynchronous receive request into the receiving queue.\r
\r
- @param This Pointer to the EFI_TCP4_PROTOCOL instance.\r
- @param Token Pointer to a token that is associated with the receive data\r
+ @param This The pointer to the EFI_TCP4_PROTOCOL instance.\r
+ @param Token The pointer to a token that is associated with the receive data\r
descriptor.\r
\r
@retval EFI_SUCCESS The receive completion token was cached.\r
Disconnecting a TCP connection gracefully or reset a TCP connection. This function is a\r
nonblocking operation.\r
\r
- @param This Pointer to the EFI_TCP4_PROTOCOL instance.\r
- @param CloseToken Pointer to the close token to return when operation finishes.\r
+ @param This The pointer to the EFI_TCP4_PROTOCOL instance.\r
+ @param CloseToken The pointer to the close token to return when operation finishes.\r
\r
@retval EFI_SUCCESS The Close() is called successfully.\r
@retval EFI_NOT_STARTED This EFI TCPv4 Protocol instance has not been configured.\r
/**\r
Abort an asynchronous connection, listen, transmission or receive request.\r
\r
- @param This Pointer to the EFI_TCP4_PROTOCOL instance.\r
- @param Token Pointer to a token that has been issued by\r
+ @param This The pointer to the EFI_TCP4_PROTOCOL instance.\r
+ @param Token The pointer to a token that has been issued by\r
EFI_TCP4_PROTOCOL.Connect(),\r
EFI_TCP4_PROTOCOL.Accept(),\r
EFI_TCP4_PROTOCOL.Transmit() or\r
/**\r
Poll to receive incoming data and transmit outgoing segments.\r
\r
- @param This Pointer to the EFI_TCP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_TCP4_PROTOCOL instance.\r
\r
@retval EFI_SUCCESS Incoming or outgoing data was processed.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
The EFI UDPv4 Protocol provides simple packet-oriented services \r
to transmit and receive UDP packets. \r
\r
- Copyright (c) 2006 - 2009, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@par Revision Reference: \r
- This Protocol is introduced in UEFI Specification 2.0 \r
+ This Protocol is introduced in UEFI Specification 2.0. \r
\r
**/\r
\r
optionally to retrieve the operational mode data of underlying networks or\r
drivers.\r
\r
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
- @param Udp4ConfigData Pointer to the buffer to receive the current configuration data.\r
- @param Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure.\r
- @param MnpConfigData Pointer to the managed network configuration data structure.\r
- @param SnpModeData Pointer to the simple network mode data structure.\r
+ @param This The pointer to the EFI_UDP4_PROTOCOL instance.\r
+ @param Udp4ConfigData The pointer to the buffer to receive the current configuration data.\r
+ @param Ip4ModeData The pointer to the EFI IPv4 Protocol mode data structure.\r
+ @param MnpConfigData The pointer to the managed network configuration data structure.\r
+ @param SnpModeData The pointer to the simple network mode data structure.\r
\r
@retval EFI_SUCCESS The mode data was read.\r
@retval EFI_NOT_STARTED When Udp4ConfigData is queried, no configuration data is\r
With different parameters in UdpConfigData, Configure() can be used to bind\r
this instance to specified port.\r
\r
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
- @param Udp4ConfigData Pointer to the buffer to receive the current configuration data.\r
+ @param This The pointer to the EFI_UDP4_PROTOCOL instance.\r
+ @param Udp4ConfigData The pointer to the buffer to receive the current configuration data.\r
\r
@retval EFI_SUCCESS The configuration settings were set, changed, or reset successfully.\r
@retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,\r
filtering. If the JoinFlag is FALSE and the MulticastAddress is NULL, then all\r
currently joined groups are left.\r
\r
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_UDP4_PROTOCOL instance.\r
@param JoinFlag Set to TRUE to join a multicast group. Set to FALSE to leave one\r
or all multicast groups.\r
- @param MulticastAddress Pointer to multicast group address to join or leave.\r
+ @param MulticastAddress The pointer to multicast group address to join or leave.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_NOT_STARTED The EFI UDPv4 Protocol instance has not been started.\r
copies will be updated automatically whenever the IP driver reconfigures its\r
instances; as a result, the previous modification to these copies will be lost.\r
\r
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_UDP4_PROTOCOL instance.\r
@param DeleteRoute Set to TRUE to delete this route from the routing table.\r
Set to FALSE to add this route to the routing table.\r
@param SubnetAddress The destination network address that needs to be routed.\r
Drivers and applications that are experiencing packet loss should try calling\r
the Poll() function more often.\r
\r
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_UDP4_PROTOCOL instance.\r
\r
@retval EFI_SUCCESS Incoming or outgoing data was processed.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
will enable the user to receive the notification and receiving status. That\r
notification function is guaranteed to not be re-entered.\r
\r
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
- @param Token Pointer to a token that is associated with the receive data\r
+ @param This The pointer to the EFI_UDP4_PROTOCOL instance.\r
+ @param Token The pointer to a token that is associated with the receive data\r
descriptor.\r
\r
@retval EFI_SUCCESS The receive completion token was cached.\r
and context for the event will enable the user to receive the notification and\r
transmitting status.\r
\r
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
- @param Token Pointer to the completion token that will be placed into the\r
+ @param This The pointer to the EFI_UDP4_PROTOCOL instance.\r
+ @param Token The pointer to the completion token that will be placed into the\r
transmit queue.\r
\r
@retval EFI_SUCCESS The data has been queued for transmission.\r
the asynchronous operation has completed, this function will not signal the\r
token and EFI_NOT_FOUND is returned.\r
\r
- @param This Pointer to the EFI_UDP4_PROTOCOL instance.\r
- @param Token Pointer to a token that has been issued by\r
+ @param This The pointer to the EFI_UDP4_PROTOCOL instance.\r
+ @param Token The pointer to a token that has been issued by\r
EFI_UDP4_PROTOCOL.Transmit() or\r
EFI_UDP4_PROTOCOL.Receive().If NULL, all pending\r
tokens are aborted.\r
This protocol is used to allow code running in the boot services environment \r
to perform lexical comparison functions on Unicode strings for given languages.\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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@param Str1 A pointer to a Null-terminated string.\r
@param Str2 A pointer to a Null-terminated string.\r
\r
- @retval 0 Str1 is equivalent to Str2\r
- @retval >0 Str1 is lexically greater than Str2\r
- @retval <0 Str1 is lexically less than Str2\r
+ @retval 0 Str1 is equivalent to Str2.\r
+ @retval >0 Str1 is lexically greater than Str2.\r
+ @retval <0 Str1 is lexically less than Str2.\r
\r
**/\r
typedef\r
types defined via this include file and can be ported easily to any \r
environment. \r
\r
-Copyright (c) 2006 - 2007, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
/** @file\r
Defines data types and constants introduced in UEFI.\r
\r
- Copyright (c) 2006 - 2009, Intel Corporation<BR>\r
- Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<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
- 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
typedef GUID EFI_GUID;\r
///\r
-/// Function return status for EFI API\r
+/// Function return status for EFI API.\r
///\r
typedef RETURN_STATUS EFI_STATUS;\r
///\r
} EFI_IPv4_ADDRESS;\r
\r
///\r
-/// 16-byte buffer. An IPv6 internet protocol address\r
+/// 16-byte buffer. An IPv6 internet protocol address.\r
///\r
typedef struct {\r
UINT8 Addr[16];\r
#define EFI_PAGES_TO_SIZE(a) ( (a) << EFI_PAGE_SHIFT)\r
\r
///\r
-/// PE32+ Machine type for IA32 UEFI images\r
+/// PE32+ Machine type for IA32 UEFI images.\r
///\r
#define EFI_IMAGE_MACHINE_IA32 0x014C\r
\r
///\r
-/// PE32+ Machine type for IA64 UEFI images\r
+/// PE32+ Machine type for IA64 UEFI images.\r
///\r
#define EFI_IMAGE_MACHINE_IA64 0x0200\r
\r
///\r
-/// PE32+ Machine type for EBC UEFI images\r
+/// PE32+ Machine type for EBC UEFI images.\r
///\r
#define EFI_IMAGE_MACHINE_EBC 0x0EBC\r
\r
///\r
-/// PE32+ Machine type for X64 UEFI images\r
+/// PE32+ Machine type for X64 UEFI images.\r
///\r
#define EFI_IMAGE_MACHINE_X64 0x8664\r
\r
///\r
-/// PE32+ Machine type for ARM mixed ARM and Thumb/Thumb2 images\r
+/// PE32+ Machine type for ARM mixed ARM and Thumb/Thumb2 images.\r
///\r
#define EFI_IMAGE_MACHINE_ARMTHUMB_MIXED 0x01C2\r
\r
/** @file\r
EFI Guid Partition Table Format Definition.\r
\r
- Copyright (c) 2006 - 2009, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
#define PRIMARY_PART_HEADER_LBA 1\r
///\r
-/// EFI Partition Table Signature: "EFI PART"\r
+/// EFI Partition Table Signature: "EFI PART".\r
/// \r
#define EFI_PTAB_HEADER_ID SIGNATURE_64 ('E','F','I',' ','P','A','R','T')\r
\r
#pragma pack(1)\r
\r
///\r
-/// GPT Partition Table Header\r
+/// GPT Partition Table Header.\r
///\r
typedef struct {\r
///\r
/// The table header for the GPT partition Table.\r
- /// This header contains EFI_PTAB_HEADER_ID\r
+ /// This header contains EFI_PTAB_HEADER_ID.\r
///\r
EFI_TABLE_HEADER Header;\r
///\r
} EFI_PARTITION_TABLE_HEADER;\r
\r
///\r
-/// GPT Partition Entry\r
+/// GPT Partition Entry.\r
///\r
typedef struct {\r
///\r
/// partition indicates that deletion or modification of the contents can result in loss of platform\r
/// features or failure for the platform to boot or operate. The system cannot function normally if\r
/// this partition is removed, and it should be considered part of the hardware of the system.\r
- /// Actions such as running diagnostics, system recovery, or even OS install or boot could\r
+ /// Actions such as running diagnostics, system recovery, or even OS install or boot, could\r
/// potentially stop working if this partition is removed. Unless OS software or firmware\r
/// recognizes this partition, it should never be removed or modified as the UEFI firmware or\r
/// platform hardware may become non-functional.\r
IFR is primarily consumed by the EFI presentation engine, and produced by EFI\r
internal application and drivers as well as all add-in card option-ROM drivers\r
\r
- Copyright (c) 2006 - 2010, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@par Revision Reference:\r
These definitions are from UEFI 2.1 and 2.2.\r
//\r
\r
///\r
-/// Contents of EFI_NARROW_GLYPH.Attributes\r
+/// Contents of EFI_NARROW_GLYPH.Attributes.\r
///@{\r
#define EFI_GLYPH_NON_SPACING 0x01\r
#define EFI_GLYPH_WIDE 0x02\r
} EFI_HII_GLYPH_INFO;\r
\r
///\r
-/// The fixed header consists of a standard record header and\r
+/// The fixed header consists of a standard record header,\r
/// then the character values in this section, the flags\r
/// (including the encoding method) and the offsets of the glyph\r
/// information, the glyph bitmaps and the character map.\r
///\r
/// For EFI_IFR_TO_STRING, when converting from\r
/// unsigned integers, these flags control the format:\r
-/// 0 = unsigned decimal\r
-/// 1 = signed decimal\r
-/// 2 = hexadecimal (lower-case alpha)\r
-/// 3 = hexadecimal (upper-case alpha)\r
+/// 0 = unsigned decimal.\r
+/// 1 = signed decimal.\r
+/// 2 = hexadecimal (lower-case alpha).\r
+/// 3 = hexadecimal (upper-case alpha).\r
///@{\r
#define EFI_IFR_STRING_UNSIGNED_DEC 0\r
#define EFI_IFR_STRING_SIGNED_DEC 1\r
\r
///\r
/// When converting from a buffer, these flags control the format:\r
-/// 0 = ASCII\r
-/// 8 = Unicode\r
+/// 0 = ASCII.\r
+/// 8 = Unicode.\r
///@{\r
#define EFI_IFR_STRING_ASCII 0\r
#define EFI_IFR_STRING_UNICODE 8\r
} EFI_IFR_ANIMATION;\r
\r
///\r
-/// HII animation package header\r
+/// HII animation package header.\r
///\r
typedef struct _EFI_HII_ANIMATION_PACKAGE_HDR {\r
///\r
\r
///\r
/// Animation information is encoded as a series of blocks,\r
-/// with each block prefixed by a single byte header EFI_HII_ANIMATION_BLOCK\r
+/// with each block prefixed by a single byte header EFI_HII_ANIMATION_BLOCK.\r
///\r
typedef struct _EFI_HII_ANIMATION_BLOCK {\r
UINT8 BlockType;\r
} EFI_HII_ANIMATION_BLOCK;\r
\r
///\r
-/// Animation block types\r
+/// Animation block types.\r
///\r
#define EFI_HII_AIBT_END 0x00\r
#define EFI_HII_AIBT_OVERLAY_IMAGES 0x10\r
\r
typedef struct _EFI_HII_AIBT_EXT1_BLOCK {\r
///\r
- /// Standard animation header, where Header.BlockType = EFI_HII_AIBT_EXT1\r
+ /// Standard animation header, where Header.BlockType = EFI_HII_AIBT_EXT1.\r
///\r
EFI_HII_ANIMATION_BLOCK Header;\r
///\r
- /// The block type\r
+ /// The block type.\r
///\r
UINT8 BlockType2;\r
///\r
\r
typedef struct _EFI_HII_AIBT_EXT2_BLOCK {\r
///\r
- /// Standard animation header, where Header.BlockType = EFI_HII_AIBT_EXT2\r
+ /// Standard animation header, where Header.BlockType = EFI_HII_AIBT_EXT2.\r
///\r
EFI_HII_ANIMATION_BLOCK Header;\r
///\r
\r
typedef struct _EFI_HII_AIBT_EXT4_BLOCK {\r
///\r
- /// Standard animation header, where Header.BlockType = EFI_HII_AIBT_EXT4\r
+ /// Standard animation header, where Header.BlockType = EFI_HII_AIBT_EXT4.\r
///\r
EFI_HII_ANIMATION_BLOCK Header;\r
///\r
/** @file\r
This includes some definitions introduced in UEFI that will be used in both PEI and DXE phases.\r
\r
- Copyright (c) 2006 - 2009, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
EfiLoaderData,\r
///\r
- /// The code portions of a loaded Boot Services Driver\r
+ /// The code portions of a loaded Boot Services Driver.\r
///\r
EfiBootServicesCode,\r
///\r
/// key associated w/ the public/private 2048-bit RSA key-pair. The\r
/// WIN_CERTIFICATE shall be used to describe the signature of the\r
/// Variable data *Data. In addition, the signature will also\r
-/// include the MonotonicCount value to guard against replay attacks\r
+/// include the MonotonicCount value to guard against replay attacks.\r
/// \r
typedef struct {\r
///\r
structure prototypes, global variables and constants that\r
are needed for porting PXE to EFI.\r
\r
- Copyright (c) 2006 - 2010, 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@par Revision Reference:\r
32/64-bit PXE specification:\r
- alpha-4, 99-Dec-17\r
+ alpha-4, 99-Dec-17.\r
\r
**/\r
\r
)\r
\r
///\r
-/// UNDI ROM ID and devive ID signature\r
+/// UNDI ROM ID and devive ID signature.\r
///\r
#define PXE_BUSTYPE_PXE PXE_BUSTYPE ('!', 'P', 'X', 'E')\r
\r
///\r
-/// BUS ROM ID signatures\r
+/// BUS ROM ID signatures.\r
///\r
#define PXE_BUSTYPE_PCI PXE_BUSTYPE ('P', 'C', 'I', 'R')\r
#define PXE_BUSTYPE_PC_CARD PXE_BUSTYPE ('P', 'C', 'C', 'R')\r
typedef UINTN PXE_UINTN;\r
\r
///\r
-/// typedef unsigned long PXE_UINT64;\r
+/// Typedef unsigned long PXE_UINT64.\r
///\r
typedef UINT64 PXE_UINT64;\r
\r
#define PXE_OPFLAGS_RESET_DISABLE_FILTERS 0x0002\r
\r
///\r
-/// UNDI Shutdown\r
+/// UNDI Shutdown.\r
///\r
-/// No OpFlags\r
+/// No OpFlags.\r
\r
///\r
-/// UNDI Interrupt Enables\r
+/// UNDI Interrupt Enables.\r
///\r
///\r
/// Select whether to enable or disable external interrupt signals.\r
#define PXE_OPFLAGS_INTERRUPT_SOFTWARE 0x0008\r
\r
///\r
-/// UNDI Receive Filters\r
+/// UNDI Receive Filters.\r
///\r
///\r
/// Select whether to enable or disable receive filters.\r
#define PXE_OPFLAGS_RECEIVE_FILTER_ALL_MULTICAST 0x0010\r
\r
///\r
-/// UNDI Station Address\r
+/// UNDI Station Address.\r
///\r
#define PXE_OPFLAGS_STATION_ADDRESS_READ 0x0000\r
#define PXE_OPFLAGS_STATION_ADDRESS_WRITE 0x0000\r
#define PXE_OPFLAGS_STATION_ADDRESS_RESET 0x0001\r
\r
///\r
-/// UNDI Statistics\r
+/// UNDI Statistics.\r
///\r
#define PXE_OPFLAGS_STATISTICS_READ 0x0000\r
#define PXE_OPFLAGS_STATISTICS_RESET 0x0001\r
\r
///\r
-/// UNDI MCast IP to MAC\r
+/// UNDI MCast IP to MAC.\r
///\r
///\r
/// Identify the type of IP address in the CPB.\r
#define PXE_OPFLAGS_MCAST_IPV6_TO_MAC 0x0001\r
\r
///\r
-/// UNDI NvData\r
+/// UNDI NvData.\r
///\r
///\r
/// Select the type of non-volatile data operation.\r
#define PXE_OPFLAGS_NVDATA_WRITE 0x0001\r
\r
///\r
-/// UNDI Get Status\r
+/// UNDI Get Status.\r
///\r
///\r
/// Return current interrupt status. This will also clear any interrupts\r
#define PXE_OPFLAGS_GET_MEDIA_STATUS 0x0004\r
\r
///\r
-/// UNDI Fill Header\r
+/// UNDI Fill Header.\r
///\r
#define PXE_OPFLAGS_FILL_HEADER_OPMASK 0x0001\r
#define PXE_OPFLAGS_FILL_HEADER_FRAGMENTED 0x0001\r
#define PXE_OPFLAGS_FILL_HEADER_WHOLE 0x0000\r
\r
///\r
-/// UNDI Transmit\r
+/// UNDI Transmit.\r
///\r
///\r
/// S/W UNDI only. Return after the packet has been transmitted. A\r
#define PXE_OPFLAGS_TRANSMIT_WHOLE 0x0000\r
\r
///\r
-/// UNDI Receive\r
+/// UNDI Receive.\r
///\r
-/// No OpFlags\r
+/// No OpFlags.\r
///\r
\r
///\r
-/// PXE STATFLAGS\r
+/// PXE STATFLAGS.\r
///\r
typedef PXE_UINT16 PXE_STATFLAGS;\r
\r
#define PXE_STATFLAGS_COMMAND_QUEUED 0x4000\r
\r
///\r
-/// UNDI Get State\r
+/// UNDI Get State.\r
///\r
#define PXE_STATFLAGS_GET_STATE_MASK 0x0003\r
#define PXE_STATFLAGS_GET_STATE_INITIALIZED 0x0002\r
#define PXE_STATFLAGS_GET_STATE_STOPPED 0x0000\r
\r
///\r
-/// UNDI Start\r
+/// UNDI Start.\r
///\r
-/// No additional StatFlags\r
+/// No additional StatFlags.\r
///\r
\r
///\r
-/// UNDI Get Init Info\r
+/// UNDI Get Init Info.\r
///\r
#define PXE_STATFLAGS_CABLE_DETECT_MASK 0x0001\r
#define PXE_STATFLAGS_CABLE_DETECT_NOT_SUPPORTED 0x0000\r
#define PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED 0x0002\r
\r
///\r
-/// UNDI Initialize\r
+/// UNDI Initialize.\r
///\r
#define PXE_STATFLAGS_INITIALIZED_NO_MEDIA 0x0001\r
\r
///\r
-/// UNDI Reset\r
+/// UNDI Reset.\r
///\r
#define PXE_STATFLAGS_RESET_NO_MEDIA 0x0001\r
\r
///\r
-/// UNDI Shutdown\r
+/// UNDI Shutdown.\r
///\r
-/// No additional StatFlags\r
+/// No additional StatFlags.\r
\r
///\r
-/// UNDI Interrupt Enables\r
+/// UNDI Interrupt Enables.\r
///\r
///\r
/// If set, receive interrupts are enabled.\r
#define PXE_STATFLAGS_INTERRUPT_COMMAND 0x0004\r
\r
///\r
-/// UNDI Receive Filters\r
+/// UNDI Receive Filters.\r
///\r
\r
///\r
#define PXE_STATFLAGS_RECEIVE_FILTER_ALL_MULTICAST 0x0010\r
\r
///\r
-/// UNDI Station Address\r
+/// UNDI Station Address.\r
///\r
-/// No additional StatFlags\r
+/// No additional StatFlags.\r
///\r
\r
///\r
-/// UNDI Statistics\r
+/// UNDI Statistics.\r
///\r
-/// No additional StatFlags\r
+/// No additional StatFlags.\r
///\r
\r
///\r
-//// UNDI MCast IP to MAC\r
+//// UNDI MCast IP to MAC.\r
////\r
-//// No additional StatFlags\r
+//// No additional StatFlags.\r
\r
///\r
-/// UNDI NvData\r
+/// UNDI NvData.\r
///\r
-/// No additional StatFlags\r
+/// No additional StatFlags.\r
///\r
\r
///\r
-/// UNDI Get Status\r
+/// UNDI Get Status.\r
///\r
\r
///\r
#define PXE_STATFLAGS_GET_STATUS_NO_MEDIA 0x0040\r
\r
///\r
-/// UNDI Fill Header\r
+/// UNDI Fill Header.\r
///\r
-/// No additional StatFlags\r
+/// No additional StatFlags.\r
///\r
\r
///\r
-/// UNDI Transmit\r
+/// UNDI Transmit.\r
///\r
/// No additional StatFlags.\r
\r
///\r
/// UNDI Receive\r
-///\r
+///.\r
\r
///\r
/// No additional StatFlags.\r
#define PXE_IFTYPE_FIBRE_CHANNEL 0x12\r
\r
typedef struct s_pxe_hw_undi {\r
- PXE_UINT32 Signature; ///< PXE_ROMID_SIGNATURE\r
- PXE_UINT8 Len; ///< sizeof(PXE_HW_UNDI)\r
- PXE_UINT8 Fudge; ///< makes 8-bit cksum equal zero\r
- PXE_UINT8 Rev; ///< PXE_ROMID_REV\r
- PXE_UINT8 IFcnt; ///< physical connector count\r
- PXE_UINT8 MajorVer; ///< PXE_ROMID_MAJORVER\r
- PXE_UINT8 MinorVer; ///< PXE_ROMID_MINORVER\r
- PXE_UINT16 reserved; ///< zero, not used\r
- PXE_UINT32 Implementation; ///< implementation flags\r
- ///< reserved ///< vendor use\r
- ///< UINT32 Status; ///< status port\r
- ///< UINT32 Command; ///< command port\r
- ///< UINT64 CDBaddr; ///< CDB address port\r
+ PXE_UINT32 Signature; ///< PXE_ROMID_SIGNATURE.\r
+ PXE_UINT8 Len; ///< sizeof(PXE_HW_UNDI).\r
+ PXE_UINT8 Fudge; ///< makes 8-bit cksum equal zero.\r
+ PXE_UINT8 Rev; ///< PXE_ROMID_REV.\r
+ PXE_UINT8 IFcnt; ///< physical connector count.\r
+ PXE_UINT8 MajorVer; ///< PXE_ROMID_MAJORVER.\r
+ PXE_UINT8 MinorVer; ///< PXE_ROMID_MINORVER.\r
+ PXE_UINT16 reserved; ///< zero, not used.\r
+ PXE_UINT32 Implementation; ///< implementation flags.\r
+ ///< reserved ///< vendor use.\r
+ ///< UINT32 Status; ///< status port.\r
+ ///< UINT32 Command; ///< command port.\r
+ ///< UINT64 CDBaddr; ///< CDB address port.\r
///<\r
} PXE_HW_UNDI;\r
\r
///\r
-/// Status port bit definitions\r
+/// Status port bit definitions.\r
///\r
\r
///\r
-/// UNDI operation state\r
+/// UNDI operation state.\r
///\r
#define PXE_HWSTAT_STATE_MASK 0xC0000000\r
#define PXE_HWSTAT_BUSY 0xC0000000\r
#define PXE_HWSTAT_STOPPED 0x00000000\r
\r
///\r
-/// If set, last command failed\r
+/// If set, last command failed.\r
///\r
#define PXE_HWSTAT_COMMAND_FAILED 0x20000000\r
\r
///\r
-/// If set, identifies enabled receive filters\r
+/// If set, identifies enabled receive filters.\r
///\r
#define PXE_HWSTAT_PROMISCUOUS_MULTICAST_RX_ENABLED 0x00001000\r
#define PXE_HWSTAT_PROMISCUOUS_RX_ENABLED 0x00000800\r
#define PXE_HWSTAT_UNICAST_RX_ENABLED 0x00000100\r
\r
///\r
-/// If set, identifies enabled external interrupts\r
+/// If set, identifies enabled external interrupts.\r
///\r
#define PXE_HWSTAT_SOFTWARE_INT_ENABLED 0x00000080\r
#define PXE_HWSTAT_TX_COMPLETE_INT_ENABLED 0x00000040\r
#define PXE_HWSTAT_CMD_COMPLETE_INT_ENABLED 0x00000010\r
\r
///\r
-/// If set, identifies pending interrupts\r
+/// If set, identifies pending interrupts.\r
///\r
#define PXE_HWSTAT_SOFTWARE_INT_PENDING 0x00000008\r
#define PXE_HWSTAT_TX_COMPLETE_INT_PENDING 0x00000004\r
#define PXE_HWSTAT_CMD_COMPLETE_INT_PENDING 0x00000001\r
\r
///\r
-/// Command port definitions\r
+/// Command port definitions.\r
///\r
\r
///\r
#define PXE_HWCMD_UNICAST_RX_ENABLE 0x00000100\r
\r
///\r
-/// Use these to enable/disable external interrupts\r
+/// Use these to enable/disable external interrupts.\r
///\r
#define PXE_HWCMD_SOFTWARE_INT_ENABLE 0x00000080\r
#define PXE_HWCMD_TX_COMPLETE_INT_ENABLE 0x00000040\r
#define PXE_HWCMD_CMD_COMPLETE_INT_ENABLE 0x00000010\r
\r
///\r
-/// Use these to clear pending external interrupts\r
+/// Use these to clear pending external interrupts.\r
///\r
#define PXE_HWCMD_CLEAR_SOFTWARE_INT 0x00000008\r
#define PXE_HWCMD_CLEAR_TX_COMPLETE_INT 0x00000004\r
#define PXE_HWCMD_CLEAR_CMD_COMPLETE_INT 0x00000001\r
\r
typedef struct s_pxe_sw_undi {\r
- PXE_UINT32 Signature; ///< PXE_ROMID_SIGNATURE\r
- PXE_UINT8 Len; ///< sizeof(PXE_SW_UNDI)\r
- PXE_UINT8 Fudge; ///< makes 8-bit cksum zero\r
- PXE_UINT8 Rev; ///< PXE_ROMID_REV\r
- PXE_UINT8 IFcnt; ///< physical connector count\r
- PXE_UINT8 MajorVer; ///< PXE_ROMID_MAJORVER\r
- PXE_UINT8 MinorVer; ///< PXE_ROMID_MINORVER\r
- PXE_UINT16 reserved1; ///< zero, not used\r
- PXE_UINT32 Implementation; ///< Implementation flags\r
- PXE_UINT64 EntryPoint; ///< API entry point\r
- PXE_UINT8 reserved2[3]; ///< zero, not used\r
- PXE_UINT8 BusCnt; ///< number of bustypes supported\r
- PXE_UINT32 BusType[1]; ///< list of supported bustypes\r
+ PXE_UINT32 Signature; ///< PXE_ROMID_SIGNATURE.\r
+ PXE_UINT8 Len; ///< sizeof(PXE_SW_UNDI).\r
+ PXE_UINT8 Fudge; ///< makes 8-bit cksum zero.\r
+ PXE_UINT8 Rev; ///< PXE_ROMID_REV.\r
+ PXE_UINT8 IFcnt; ///< physical connector count.\r
+ PXE_UINT8 MajorVer; ///< PXE_ROMID_MAJORVER.\r
+ PXE_UINT8 MinorVer; ///< PXE_ROMID_MINORVER.\r
+ PXE_UINT16 reserved1; ///< zero, not used.\r
+ PXE_UINT32 Implementation; ///< Implementation flags.\r
+ PXE_UINT64 EntryPoint; ///< API entry point.\r
+ PXE_UINT8 reserved2[3]; ///< zero, not used.\r
+ PXE_UINT8 BusCnt; ///< number of bustypes supported.\r
+ PXE_UINT32 BusType[1]; ///< list of supported bustypes.\r
} PXE_SW_UNDI;\r
\r
typedef union u_pxe_undi {\r
} PXE_UNDI;\r
\r
///\r
-/// Signature of !PXE structure\r
+/// Signature of !PXE structure.\r
///\r
#define PXE_ROMID_SIGNATURE PXE_BUSTYPE ('!', 'P', 'X', 'E')\r
\r
///\r
/// !PXE structure format revision\r
-///\r
+///.\r
#define PXE_ROMID_REV 0x02\r
\r
///\r
#define PXE_ROMID_MINORVER 0x01\r
\r
///\r
-/// Implementation flags\r
+/// Implementation flags.\r
///\r
#define PXE_ROMID_IMP_HW_UNDI 0x80000000\r
#define PXE_ROMID_IMP_SW_VIRT_ADDR 0x40000000\r
///\r
/// cpb and db definitions\r
///\r
-#define MAX_PCI_CONFIG_LEN 64 ///< # of dwords\r
-#define MAX_EEPROM_LEN 128 ///< # of dwords\r
-#define MAX_XMIT_BUFFERS 32 ///< recycling Q length for xmit_done\r
+#define MAX_PCI_CONFIG_LEN 64 ///< # of dwords.\r
+#define MAX_EEPROM_LEN 128 ///< # of dwords.\r
+#define MAX_XMIT_BUFFERS 32 ///< recycling Q length for xmit_done.\r
#define MAX_MCAST_ADDRESS_CNT 8\r
\r
typedef struct s_pxe_cpb_start_30 {\r
/// used with the DMA, it converts the given virtual address to it's\r
/// physical address and write that in the mapped address pointer.\r
///\r
- /// This field can be set to zero if there is no mapping service available\r
+ /// This field can be set to zero if there is no mapping service available.\r
///\r
UINT64 Map_Mem;\r
\r
/// PXE_VOID UnMap_Mem(UINT64 unq_id, UINT64 virtual_addr, UINT32 size,\r
/// UINT32 Direction, UINT64 mapped_addr);\r
///\r
- /// UNDI will pass the virtual and mapped addresses of a buffer\r
- /// This call will un map the given address\r
+ /// UNDI will pass the virtual and mapped addresses of a buffer.\r
+ /// This call will un map the given address.\r
///\r
- /// This field can be set to zero if there is no unmapping service available\r
+ /// This field can be set to zero if there is no unmapping service available.\r
///\r
UINT64 UnMap_Mem;\r
\r
/// PXE_VOID Sync_Mem(UINT64 unq_id, UINT64 virtual,\r
/// UINT32 size, UINT32 Direction, UINT64 mapped_addr);\r
///\r
- /// UNDI will pass the virtual and mapped addresses of a buffer\r
- /// This call will synchronize the contents of both the virtual and mapped\r
+ /// UNDI will pass the virtual and mapped addresses of a buffer.\r
+ /// This call will synchronize the contents of both the virtual and mapped.\r
/// buffers for the given Direction.\r
///\r
- /// This field can be set to zero if there is no service available\r
+ /// This field can be set to zero if there is no service available.\r
///\r
UINT64 Sync_Mem;\r
\r
UINT32 BusType;\r
\r
///\r
- /// This identifies the PCI network device that this UNDI interface\r
+ /// This identifies the PCI network device that this UNDI interface.\r
/// is bound to.\r
///\r
UINT16 Bus;\r
If a code construct is defined in the UEFI 2.1 specification it must be included\r
by this include file.\r
\r
- Copyright (c) 2006 - 2010, Intel Corporation<BR>\r
- Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<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
- 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 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
typedef enum {\r
///\r
- /// Allocate any available range of pages that satisfies the request\r
+ /// Allocate any available range of pages that satisfies the request.\r
///\r
AllocateAnyPages,\r
///\r
/// Allocate any available range of pages whose uppermost address is less than \r
- /// or equal to a specified maximum address\r
+ /// or equal to a specified maximum address.\r
///\r
AllocateMaxAddress,\r
///\r
- /// Allocate pages at a specified address\r
+ /// Allocate pages at a specified address.\r
///\r
AllocateAddress,\r
///\r
- /// Maximum enumeration value that may be used for bounds checking\r
+ /// Maximum enumeration value that may be used for bounds checking.\r
///\r
MaxAllocateType\r
} EFI_ALLOCATE_TYPE;\r
#define EFI_TIME_IN_DAYLIGHT 0x02\r
\r
///\r
-/// Value definition for EFI_TIME.TimeZone\r
+/// Value definition for EFI_TIME.TimeZone.\r
///\r
#define EFI_UNSPECIFIED_TIMEZONE 0x07FF\r
\r
#define EFI_MEMORY_RUNTIME 0x8000000000000000ULL\r
\r
///\r
-/// Memory descriptor version number\r
+/// Memory descriptor version number.\r
///\r
#define EFI_MEMORY_DESCRIPTOR_VERSION 1\r
\r
///\r
-/// Definition of an EFI memory descriptor\r
+/// Definition of an EFI memory descriptor.\r
///\r
typedef struct {\r
///\r
- /// Type of the memory region. See EFI_MEMORY_TYPE\r
+ /// Type of the memory region. See EFI_MEMORY_TYPE.\r
///\r
UINT32 Type;\r
///\r
@param Type The type of allocation to perform.\r
@param MemoryType The type of memory to allocate.\r
@param Pages The number of contiguous 4 KB pages to allocate.\r
- @param Memory Pointer to a physical address. On input, the way in which the address is\r
+ @param Memory The pointer to a physical address. On input, the way in which the address is\r
used depends on the value of Type.\r
\r
@retval EFI_SUCCESS The requested pages were allocated.\r
/**\r
Returns pool memory to the system.\r
\r
- @param Buffer Pointer to the buffer to free.\r
+ @param Buffer The pointer to the buffer to free.\r
\r
@retval EFI_SUCCESS The memory was returned to the system.\r
@retval EFI_INVALID_PARAMETER Buffer was invalid.\r
Invoke a notification event\r
\r
@param Event Event whose notification function is being invoked.\r
- @param Context Pointer to the notification function's context,\r
+ @param Context The pointer to the notification function's context,\r
which is implementation-dependent.\r
\r
**/\r
\r
@param Type The type of event to create and its mode and attributes.\r
@param NotifyTpl The task priority level of event notifications, if needed.\r
- @param NotifyFunction Pointer to the event's notification function, if any.\r
- @param NotifyContext Pointer to the notification function's context; corresponds to parameter\r
+ @param NotifyFunction The pointer to the event's notification function, if any.\r
+ @param NotifyContext The pointer to the notification function's context; corresponds to parameter\r
Context in the notification function.\r
- @param Event Pointer to the newly created event if the call succeeds; undefined\r
+ @param Event The pointer to the newly created event if the call succeeds; undefined\r
otherwise.\r
\r
@retval EFI_SUCCESS The event structure was created.\r
\r
@param Type The type of event to create and its mode and attributes.\r
@param NotifyTpl The task priority level of event notifications,if needed.\r
- @param NotifyFunction Pointer to the event's notification function, if any.\r
- @param NotifyContext Pointer to the notification function's context; corresponds to parameter\r
+ @param NotifyFunction The pointer to the event's notification function, if any.\r
+ @param NotifyContext The pointer to the notification function's context; corresponds to parameter\r
Context in the notification function.\r
- @param EventGroup Pointer to the unique identifier of the group to which this event belongs.\r
+ @param EventGroup The pointer to the unique identifier of the group to which this event belongs.\r
If this is NULL, then the function behaves as if the parameters were passed\r
to CreateEvent.\r
- @param Event Pointer to the newly created event if the call succeeds; undefined\r
+ @param Event The pointer to the newly created event if the call succeeds; undefined\r
otherwise.\r
\r
@retval EFI_SUCCESS The event structure was created.\r
///\r
typedef enum {\r
///\r
- /// An event's timer settings is to be cancelled and not trigger time is to be set\r
+ /// An event's timer settings is to be cancelled and not trigger time is to be set/\r
///\r
TimerCancel,\r
///\r
\r
@param NumberOfEvents The number of events in the Event array.\r
@param Event An array of EFI_EVENT.\r
- @param Index Pointer to the index of the event which satisfied the wait condition.\r
+ @param Index The pointer to the index of the event which satisfied the wait condition.\r
\r
@retval EFI_SUCCESS The event indicated by Index was signaled.\r
@retval EFI_INVALID_PARAMETER 1) NumberOfEvents is 0.\r
@param SourceBuffer If not NULL, a pointer to the memory location containing a copy\r
of the image to be loaded.\r
@param SourceSize The size in bytes of SourceBuffer. Ignored if SourceBuffer is NULL.\r
- @param ImageHandle Pointer to the returned image handle that is created when the\r
+ @param ImageHandle The pointer to the returned image handle that is created when the\r
image is successfully loaded.\r
\r
@retval EFI_SUCCESS Image was loaded into memory correctly.\r
Transfers control to a loaded image's entry point.\r
\r
@param ImageHandle Handle of image to be started.\r
- @param ExitDataSize Pointer to the size, in bytes, of ExitData.\r
- @param ExitData Pointer to a pointer to a data buffer that includes a Null-terminated\r
+ @param ExitDataSize The pointer to the size, in bytes, of ExitData.\r
+ @param ExitData The pointer to a pointer to a data buffer that includes a Null-terminated\r
string, optionally followed by additional binary data.\r
\r
@retval EFI_INVALID_PARAMETER ImageHandle is either an invalid image handle or the image\r
- has already been initialized with StartImage\r
+ has already been initialized with StartImage.\r
@return Exit code from image\r
\r
**/\r
image on entry.\r
@param ExitStatus The image's exit code.\r
@param ExitDataSize The size, in bytes, of ExitData. Ignored if ExitStatus is EFI_SUCCESS.\r
- @param ExitData Pointer to a data buffer that includes a Null-terminated string,\r
+ @param ExitData The pointer to a data buffer that includes a Null-terminated string,\r
optionally followed by additional binary data. The string is a \r
description that the caller may use to further indicate the reason \r
for the image's exit. ExitData is only valid if ExitStatus \r
@retval EFI_SUCCESS The timeout has been set.\r
@retval EFI_INVALID_PARAMETER The supplied WatchdogCode is invalid.\r
@retval EFI_UNSUPPORTED The system does not have a watchdog timer.\r
- @retval EFI_DEVICE_ERROR The watch dog timer could not be programmed due to a hardware\r
+ @retval EFI_DEVICE_ERROR The watchdog timer could not be programmed due to a hardware\r
error.\r
\r
**/\r
/**\r
Returns a monotonically increasing count for the platform.\r
\r
- @param Count Pointer to returned value.\r
+ @param Count The pointer to returned value.\r
\r
@retval EFI_SUCCESS The next monotonic count was returned.\r
@retval EFI_INVALID_PARAMETER Count is NULL.\r
/**\r
Returns the next high 32 bits of the platform's monotonic counter.\r
\r
- @param HighCount Pointer to returned value.\r
+ @param HighCount The pointer to returned value.\r
\r
@retval EFI_SUCCESS The next high monotonic count was returned.\r
@retval EFI_INVALID_PARAMETER HighCount is NULL.\r
/**\r
Copies the contents of one buffer to another buffer.\r
\r
- @param Destination Pointer to the destination buffer of the memory copy.\r
- @param Source Pointer to the source buffer of the memory copy.\r
+ @param Destination The pointer to the destination buffer of the memory copy.\r
+ @param Source The pointer to the source buffer of the memory copy.\r
@param Length Number of bytes to copy from Source to Destination.\r
\r
**/\r
/**\r
The SetMem() function fills a buffer with a specified value.\r
\r
- @param Buffer Pointer to the buffer to fill.\r
+ @param Buffer The pointer to the buffer to fill.\r
@param Size Number of bytes in Buffer to fill.\r
@param Value Value to fill Buffer with.\r
\r
} EFI_CAPSULE_BLOCK_DESCRIPTOR;\r
\r
///\r
-/// EFI Capsule Header\r
+/// EFI Capsule Header.\r
///\r
typedef struct {\r
///\r
#define EFI_RUNTIME_SERVICES_REVISION EFI_2_30_SYSTEM_TABLE_REVISION\r
\r
///\r
-/// EFI Runtime Services Table\r
+/// EFI Runtime Services Table.\r
///\r
typedef struct {\r
///\r
#define EFI_BOOT_SERVICES_REVISION EFI_2_30_SYSTEM_TABLE_REVISION\r
\r
///\r
-/// EFI Boot Services Table\r
+/// EFI Boot Services Table.\r
///\r
typedef struct {\r
///\r
@param SystemTable A pointer to the EFI System Table.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
- @retval Others Some unexpected error happened.\r
+ @retval Others An unexpected error occurred.\r
**/\r
typedef\r
EFI_STATUS\r
} EFI_BOOT_KEY_DATA;\r
\r
///\r
-/// EFI Key Option\r
+/// EFI Key Option.\r
///\r
typedef struct {\r
///\r
projects / mirror_edk2.git / commitdiff