git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8526
6f19259b-4bc3-4df7-8a09-
765794883524
31 files changed:
This function rounds the pointer specified by Pointer to the next alignment boundary \r
specified by Alignment. The pointer to the aligned address is returned. \r
\r
This function rounds the pointer specified by Pointer to the next alignment boundary \r
specified by Alignment. The pointer to the aligned address is returned. \r
\r
- @param Value The value to round up.\r
+ @param Pointer The pointer to round up.\r
@param Alignment The alignment boundary to use to return an aligned pointer.\r
\r
@return Pointer to the aligned address.\r
@param Alignment The alignment boundary to use to return an aligned pointer.\r
\r
@return Pointer to the aligned address.\r
This macro returns the maximum of two operand specified by a and b. \r
Both a and b must be the same numerical types, signed or unsigned.\r
\r
This macro returns the maximum of two operand specified by a and b. \r
Both a and b must be the same numerical types, signed or unsigned.\r
\r
- @param TYPE Any numerical data types.\r
@param a The first operand with any numerical type.\r
@param b The second operand. It should be the same any numerical type with a.\r
\r
@param a The first operand with any numerical type.\r
@param b The second operand. It should be the same any numerical type with a.\r
\r
This macro returns the minimal of two operand specified by a and b. \r
Both a and b must be the same numerical types, signed or unsigned.\r
\r
This macro returns the minimal of two operand specified by a and b. \r
Both a and b must be the same numerical types, signed or unsigned.\r
\r
- @param TYPE Any numerical data types.\r
@param a The first operand with any numerical type.\r
@param b The second operand. It should be the same any numerical type with a.\r
\r
@param a The first operand with any numerical type.\r
@param b The second operand. It should be the same any numerical type with a.\r
\r
#define TPM_NV_INDEX_PERIPHERAL_BASE ((UINT32)0x00011500)\r
#define TPM_NV_INDEX_GROUP_RESV_BASE ((UINT32)0x00010000)\r
\r
#define TPM_NV_INDEX_PERIPHERAL_BASE ((UINT32)0x00011500)\r
#define TPM_NV_INDEX_GROUP_RESV_BASE ((UINT32)0x00010000)\r
\r
-///\r
-/// The typedefs TPM_NV_PER_ATTRIBUTES (not present in TPM 1.2 Spec. have been added \r
-/// and structure fields that were to hold the following values\r
-///\r
-typedef UINT32 TPM_NV_PER_ATTRIBUTES;\r
-\r
///\r
/// Part 2, section 19.2: TPM_NV_ATTRIBUTES\r
///\r
typedef struct tdTPM_NV_ATTRIBUTES {\r
TPM_STRUCTURE_TAG tag;\r
///\r
/// Part 2, section 19.2: TPM_NV_ATTRIBUTES\r
///\r
typedef struct tdTPM_NV_ATTRIBUTES {\r
TPM_STRUCTURE_TAG tag;\r
- TPM_NV_PER_ATTRIBUTES attributes;\r
} TPM_NV_ATTRIBUTES;\r
\r
#define TPM_NV_PER_READ_STCLEAR (BIT31)\r
} TPM_NV_ATTRIBUTES;\r
\r
#define TPM_NV_PER_READ_STCLEAR (BIT31)\r
allows the PEI phase to pass information to the DXE phase. HOBs are position \r
independent and can be relocated easily to different memory memory locations.\r
\r
allows the PEI phase to pass information to the DXE phase. HOBs are position \r
independent and can be relocated easily to different memory memory locations.\r
\r
-Copyright (c) 2006 - 2008, Intel Corporation<BR>\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
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
Returns the type of a HOB.\r
\r
This macro returns the HobType field from the HOB header for the \r
Returns the type of a HOB.\r
\r
This macro returns the HobType field from the HOB header for the \r
- HOB specified by Hob.\r
+ HOB specified by HobStart.\r
- @param Hob A pointer to a HOB.\r
+ @param HobStart A pointer to a HOB.\r
Returns the length, in bytes, of a HOB.\r
\r
This macro returns the HobLength field from the HOB header for the \r
Returns the length, in bytes, of a HOB.\r
\r
This macro returns the HobLength field from the HOB header for the \r
- HOB specified by Hob.\r
+ HOB specified by HobStart.\r
- @param Hob A pointer to a HOB.\r
+ @param HobStart A pointer to a HOB.\r
\r
@return HobLength.\r
\r
\r
@return HobLength.\r
\r
Returns a pointer to the next HOB in the HOB list.\r
\r
This macro returns a pointer to HOB that follows the \r
Returns a pointer to the next HOB in the HOB list.\r
\r
This macro returns a pointer to HOB that follows the \r
- HOB specified by Hob in the HOB List.\r
+ HOB specified by HobStart in the HOB List.\r
- @param Hob A pointer to a HOB.\r
+ @param HobStart A pointer to a HOB.\r
\r
@return A pointer to the next HOB in the HOB list.\r
\r
\r
@return A pointer to the next HOB in the HOB list.\r
\r
/**\r
Determines if a HOB is the last HOB in the HOB list.\r
\r
/**\r
Determines if a HOB is the last HOB in the HOB list.\r
\r
- This macro determine if the HOB specified by Hob is the \r
- last HOB in the HOB list. If Hob is last HOB in the HOB list, \r
+ This macro determine if the HOB specified by HobStart is the \r
+ last HOB in the HOB list. If HobStart is last HOB in the HOB list, \r
then TRUE is returned. Otherwise, FALSE is returned.\r
\r
then TRUE is returned. Otherwise, FALSE is returned.\r
\r
- @param Hob A pointer to a HOB.\r
+ @param HobStart A pointer to a HOB.\r
- @retval TRUE The HOB specified by Hob is the last HOB in the HOB list.\r
- @retval FALSE The HOB specified by Hob is not the last HOB in the HOB list.\r
+ @retval TRUE The HOB specified by HobStart is the last HOB in the HOB list.\r
+ @retval FALSE The HOB specified by HobStart is not the last HOB in the HOB list.\r
-#define END_OF_HOB_LIST(Hob) (GET_HOB_TYPE (Hob) == (UINT16)EFI_HOB_TYPE_END_OF_HOB_LIST)\r
+#define END_OF_HOB_LIST(HobStart) (GET_HOB_TYPE (HobStart) == (UINT16)EFI_HOB_TYPE_END_OF_HOB_LIST)\r
\r
/**\r
Returns a pointer to data buffer from a HOB of type EFI_HOB_TYPE_GUID_EXTENSION.\r
\r
\r
/**\r
Returns a pointer to data buffer from a HOB of type EFI_HOB_TYPE_GUID_EXTENSION.\r
\r
- This macro returns a pointer to the data buffer in a HOB specified by Hob.\r
- Hob is assumed to be a HOB of type EFI_HOB_TYPE_GUID_EXTENSION. \r
+ This macro returns a pointer to the data buffer in a HOB specified by HobStart.\r
+ HobStart is assumed to be a HOB of type EFI_HOB_TYPE_GUID_EXTENSION. \r
\r
@param GuidHob A pointer to a HOB.\r
\r
\r
@param GuidHob A pointer to a HOB.\r
\r
/**\r
Returns the size of the data buffer from a HOB of type EFI_HOB_TYPE_GUID_EXTENSION.\r
\r
/**\r
Returns the size of the data buffer from a HOB of type EFI_HOB_TYPE_GUID_EXTENSION.\r
\r
- This macro returns the size, in bytes, of the data buffer in a HOB specified by Hob.\r
- Hob is assumed to be a HOB of type EFI_HOB_TYPE_GUID_EXTENSION.\r
+ This macro returns the size, in bytes, of the data buffer in a HOB specified by HobStart.\r
+ HobStart is assumed to be a HOB of type EFI_HOB_TYPE_GUID_EXTENSION.\r
\r
@param GuidHob A pointer to a HOB.\r
\r
\r
@param GuidHob A pointer to a HOB.\r
\r
PCD, module should be linked to a PEIM/DXE library instance to access that PCD.\r
If a module uses PatchableInModule type PCD, it also needs the library instance to produce\r
LibPatchPcdSetPtr() interface. For FeatureFlag/Fixed PCD, the macro interface is\r
PCD, module should be linked to a PEIM/DXE library instance to access that PCD.\r
If a module uses PatchableInModule type PCD, it also needs the library instance to produce\r
LibPatchPcdSetPtr() interface. For FeatureFlag/Fixed PCD, the macro interface is\r
- translated to n variable or macro that is auto-generated by build tool in\r
+ translated to a variable or macro that is auto-generated by build tool in\r
module's autogen.h/autogen.c.\r
The PcdGetXX(), PcdSetXX(), PcdToken(), and PcdGetNextTokenSpace() operations are \r
only available prior to ExitBootServices(). If access to PCD values are required \r
module's autogen.h/autogen.c.\r
The PcdGetXX(), PcdSetXX(), PcdToken(), and PcdGetNextTokenSpace() operations are \r
only available prior to ExitBootServices(). If access to PCD values are required \r
these three libraries is identical. The PCI CF8 Library and PCI Express Library simply use \r
explicit access methods.\r
\r
these three libraries is identical. The PCI CF8 Library and PCI Express Library simply use \r
explicit access methods.\r
\r
-Copyright (c) 2006 - 2008, Intel Corporation<BR>\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
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
@return The encoded PCI address.\r
\r
**/\r
@return The encoded PCI address.\r
\r
**/\r
-#define PCI_LIB_ADDRESS(Bus,Device,Function,Offset) \\r
- (((Offset) & 0xfff) | (((Function) & 0x07) << 12) | (((Device) & 0x1f) << 15) | (((Bus) & 0xff) << 20))\r
+#define PCI_LIB_ADDRESS(Bus,Device,Function,Register) \\r
+ (((Register) & 0xfff) | (((Function) & 0x07) << 12) | (((Device) & 0x1f) << 15) | (((Bus) & 0xff) << 20))\r
\r
/**\r
Registers a PCI device so PCI configuration registers may be accessed after \r
\r
/**\r
Registers a PCI device so PCI configuration registers may be accessed after \r
\r
/**\r
Performs a bitwise AND of an 8-bit PCI configuration register with an 8-bit\r
\r
/**\r
Performs a bitwise AND of an 8-bit PCI configuration register with an 8-bit\r
- value, followed by a bitwise OR with another 8-bit value.\r
+ value, followed by a bitwise OR with another 8-bit value.\r
\r
Reads the 8-bit PCI configuration register specified by Address, performs a\r
bitwise AND between the read result and the value specified by AndData,\r
\r
Reads the 8-bit PCI configuration register specified by Address, performs a\r
bitwise AND between the read result and the value specified by AndData,\r
/** @file\r
EFI Component Name Protocol as defined in the EFI 1.1 specification.\r
/** @file\r
EFI Component Name Protocol as defined in the EFI 1.1 specification.\r
- This protocol is used to retrieve user-readable names of EFI Drivers \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
and controllers managed by EFI Drivers.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation \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
\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
- Retrieves a Unicode string that is the user-readable name of\r
+ Retrieves a Unicode string that is the user readable name of\r
the EFI Driver.\r
\r
@param This A pointer to the\r
the EFI Driver.\r
\r
@param This A pointer to the\r
@param Operation Indicates if the bus master is going to read or write to system memory.\r
@param HostAddress The system memory address to map to the device.\r
@param NumberOfBytes On input, the number of bytes to map.\r
@param Operation Indicates if the bus master is going to read or write to system memory.\r
@param HostAddress The system memory address to map to the device.\r
@param NumberOfBytes On input, the number of bytes to map.\r
- On output the number of bytes that were mapped.\r
+ On output, the number of bytes that were mapped.\r
@param DeviceAddress The resulting map address for the bus master device to use to access the\r
hosts HostAddress.\r
@param Mapping A resulting value to pass to Unmap().\r
@param DeviceAddress The resulting map address for the bus master device to use to access the\r
hosts HostAddress.\r
@param Mapping A resulting value to pass to Unmap().\r
typedef struct _EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL {\r
///\r
/// The size, in bytes, of the entire structure. Future versions of this \r
typedef struct _EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL {\r
///\r
/// The size, in bytes, of the entire structure. Future versions of this \r
- /// specification may increase the size of the structure.\r
+ /// specification may grow the size of the structure.\r
/// \r
UINT32 Length;\r
///\r
/// \r
UINT32 Length;\r
///\r
@param This A pointer to the EFI_EBC_PROTOCOL instance.\r
@param ImageHandle Handle of image for which the thunk is being created.\r
@param EbcEntryPoint Address of the actual EBC entry point or protocol service the thunk should call.\r
@param This A pointer to the EFI_EBC_PROTOCOL instance.\r
@param ImageHandle Handle of image for which the thunk is being created.\r
@param EbcEntryPoint Address of the actual EBC entry point or protocol service the thunk should call.\r
- @param Thunk Returned pointer to a created thunk.\r
+ @param Thunk Returned pointer to a thunk created.\r
\r
@retval EFI_SUCCESS The function completed successfully.\r
@retval EFI_INVALID_PARAMETER Image entry point is not 2-byte aligned.\r
\r
@retval EFI_SUCCESS The function completed successfully.\r
@retval EFI_INVALID_PARAMETER Image entry point is not 2-byte aligned.\r
returned version is identical to that returned by the EBC BREAK 1 instruction.\r
\r
@param This A pointer to the EFI_EBC_PROTOCOL instance. \r
returned version is identical to that returned by the EBC BREAK 1 instruction.\r
\r
@param This A pointer to the EFI_EBC_PROTOCOL instance. \r
- @param Version Pointer to the location to store the returned version of the interpreter.\r
+ @param Version Pointer to where to store the returned version of the interpreter.\r
\r
@retval EFI_SUCCESS The function completed successfully.\r
@retval EFI_INVALID_PARAMETER Version pointer is NULL.\r
\r
@retval EFI_SUCCESS The function completed successfully.\r
@retval EFI_INVALID_PARAMETER Version pointer is NULL.\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
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 block it intends to\r
+ EraseBlocks() function first 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
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
Erases and initializes a firmware volume block.\r
\r
/**\r
Erases and initializes a firmware volume block.\r
\r
- The EraseBlocks() function erases one or more blocks, as denoted\r
+ The EraseBlocks() function erases one or more blocks as denoted\r
by the variable argument list. The entire parameter list of\r
blocks must be verified before erasing any blocks. If a block is\r
requested that does not exist within the associated firmware\r
by the variable argument list. The entire parameter list of\r
blocks must be verified before erasing any blocks. If a block is\r
requested that does not exist within the associated firmware\r
/**\r
\r
@param LeftColumn Value that designates the text column\r
/**\r
\r
@param LeftColumn Value that designates the text column\r
- at which the browser window will begin (left-most 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
\r
@param RightColumn Value that designates the text\r
- column at which the browser window will end (right-most column).\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
top of the screen where the browser window\r
\r
@param TopRow Value that designates the text row from the\r
top of the screen where the browser window\r
\r
typedef enum {\r
///\r
\r
typedef enum {\r
///\r
- /// A pixel is 32-bits. Byte zero represents red, byte one represents green, \r
+ /// A pixel is 32-bits and byte zero represents red, byte one represents green, \r
/// byte two represents blue, and byte three is reserved. This is the definition \r
/// for the physical frame buffer. The byte values for the red, green, and blue \r
/// components represent the color intensity. This color intensity value range \r
/// byte two represents blue, and byte three is reserved. This is the definition \r
/// for the physical frame buffer. The byte values for the red, green, and blue \r
/// components represent the color intensity. This color intensity value range \r
///\r
PixelRedGreenBlueReserved8BitPerColor,\r
///\r
///\r
PixelRedGreenBlueReserved8BitPerColor,\r
///\r
- /// A pixel is 32-bits. Byte zero represents blue, byte one represents green, \r
+ /// A pixel is 32-bits and byte zero represents blue, byte one represents green, \r
/// byte two represents red, and byte three is reserved. This is the definition \r
/// for the physical frame buffer. The byte values for the red, green, and blue \r
/// components represent the color intensity. This color intensity value range \r
/// byte two represents red, and byte three is reserved. This is the definition \r
/// for the physical frame buffer. The byte values for the red, green, and blue \r
/// components represent the color intensity. This color intensity value range \r
} EFI_HASH_OUTPUT;\r
\r
/**\r
} EFI_HASH_OUTPUT;\r
\r
/**\r
- Returns the size of the hash that results from a specific algorithm.\r
+ Returns the size of the hash which results from a specific algorithm.\r
\r
@param This Points to this instance of EFI_HASH_PROTOCOL.\r
@param HashAlgorithm Points to the EFI_GUID which identifies the algorithm to use.\r
\r
@param This Points to this instance of EFI_HASH_PROTOCOL.\r
@param HashAlgorithm Points to the EFI_GUID which identifies the algorithm to use.\r
- Returns the size of the hash that results from a specific algorithm.\r
+ Returns the size of the hash which results from a specific algorithm.\r
\r
@param This Points to this instance of EFI_HASH_PROTOCOL.\r
@param HashAlgorithm Points to the EFI_GUID which identifies the algorithm to use.\r
\r
@param This Points to this instance of EFI_HASH_PROTOCOL.\r
@param HashAlgorithm Points to the EFI_GUID which identifies the algorithm to use.\r
EFI_HII_ROUTE_CONFIG RouteConfig;\r
EFI_HII_BLOCK_TO_CONFIG BlockToConfig;\r
EFI_HII_CONFIG_TO_BLOCK ConfigToBlock;\r
EFI_HII_ROUTE_CONFIG RouteConfig;\r
EFI_HII_BLOCK_TO_CONFIG BlockToConfig;\r
EFI_HII_CONFIG_TO_BLOCK ConfigToBlock;\r
- EFI_HII_GET_ALT_CFG GetAltConfig;\r
+ EFI_HII_GET_ALT_CFG GetAltConfig;\r
};\r
\r
extern EFI_GUID gEfiHiiConfigRoutingProtocolGuid;\r
};\r
\r
extern EFI_GUID gEfiHiiConfigRoutingProtocolGuid;\r
EFI_HII_PACKAGE_TYPE_GUID, the Guid field, as defined in\r
EFI_HII_PACKAGE_GUID_HEADER. Iterate through the packages within\r
the existing package list in the HII database specified by\r
EFI_HII_PACKAGE_TYPE_GUID, the Guid field, as defined in\r
EFI_HII_PACKAGE_GUID_HEADER. Iterate through the packages within\r
the existing package list in the HII database specified by\r
- Handle. If a package's type matches one of the collected types, then perform the following steps:\r
+ Handle. If a package's type matches one of the collected types collected\r
+ in step 1, then perform the following steps:\r
- Call any functions registered with the notification type\r
REMOVE_PACK.\r
- Remove the package from the package list and the HII\r
- Call any functions registered with the notification type\r
REMOVE_PACK.\r
- Remove the package from the package list and the HII\r
/**\r
Describes font output-related information.\r
\r
/**\r
Describes font output-related information.\r
\r
- This structure is used for describing the way a string\r
+ This structure is used for describing the way in which a string\r
should be rendered in a particular font. FontInfo specifies the\r
should be rendered in a particular font. FontInfo specifies the\r
- basic font information, and ForegroundColor and BackgroundColor\r
- specify the color in which the characters should be displayed. The flags\r
+ basic font information and ForegroundColor and BackgroundColor\r
+ specify the color in which they should be displayed. The flags\r
in FontInfoMask describe where the system default should be\r
supplied instead of the specified information. The flags also\r
describe what options can be used to make a match between the\r
in FontInfoMask describe where the system default should be\r
supplied instead of the specified information. The flags also\r
describe what options can be used to make a match between the\r
Abort an asynchronous transmit or receive request.\r
\r
The Cancel() function is used to abort a pending transmit or receive request.\r
Abort an asynchronous transmit or receive request.\r
\r
The Cancel() function is used to abort a pending transmit or receive request.\r
- If the token is in the transmit or receive request queues, then after calling this\r
+ If the token is in the transmit or receive request queues, after calling this\r
function, Token->Status will be set to EFI_ABORTED and then Token->Event will\r
be signaled. If the token is not in one of the queues, which usually means the\r
asynchronous operation has completed, this function will not signal the token\r
function, Token->Status will be set to EFI_ABORTED and then Token->Event will\r
be signaled. If the token is not in one of the queues, which usually means the\r
asynchronous operation has completed, this function will not signal the token\r
TickNumber from a known time source in the platform. If TickNumber of \r
ticks are detected, then EFI_SUCCESS is returned. The actual time passed \r
between entry of this function and the first tick is between 0 and \r
TickNumber from a known time source in the platform. If TickNumber of \r
ticks are detected, then EFI_SUCCESS is returned. The actual time passed \r
between entry of this function and the first tick is between 0 and \r
- TickPeriod 100 nS units. To guarantee that at least TickPeriod \r
+ TickPeriod 100 nS units. If you want to guarantee that at least TickPeriod \r
time has elapsed, wait for two ticks. This function waits for a hardware \r
event to determine when a tick occurs. It is possible for interrupt \r
processing, or exception processing to interrupt the execution of the \r
time has elapsed, wait for two ticks. This function waits for a hardware \r
event to determine when a tick occurs. It is possible for interrupt \r
processing, or exception processing to interrupt the execution of the \r
/**\r
A callback function that is provided by the caller to intercept \r
the EFI_MTFTP4_OPCODE_DATA or EFI_MTFTP4_OPCODE_DATA8 packets processed in the\r
/**\r
A callback function that is provided by the caller to intercept \r
the EFI_MTFTP4_OPCODE_DATA or EFI_MTFTP4_OPCODE_DATA8 packets processed in the\r
- EFI_MTFTP4_PROTOCOL.ReadFile() function, or alternatively to intercept \r
+ EFI_MTFTP4_PROTOCOL.ReadFile() function, and alternatively to intercept \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
EFI_MTFTP4_OPCODE_OACK or EFI_MTFTP4_OPCODE_ERROR packets during a call to \r
EFI_MTFTP4_PROTOCOL.ReadFile(), WriteFile() or ReadDirectory(). \r
\r
should not attempt to free ParameterTypeGuid.\r
\r
@param ParameterBlock The platform returns a pointer to the\r
should not attempt to free ParameterTypeGuid.\r
\r
@param ParameterBlock The platform returns a pointer to the\r
- ParameterBlock structure, which\r
+ ParameterBlock structure which\r
contains details about the\r
configuration parameters specific to\r
the ParameterTypeGuid. This structure\r
contains details about the\r
configuration parameters specific to\r
the ParameterTypeGuid. This structure\r
protocols. UEFI driver decodes this\r
structure and its contents based on\r
ProtocolGuid. ParameterBlock is\r
protocols. UEFI driver decodes this\r
structure and its contents based on\r
ProtocolGuid. ParameterBlock is\r
- allocated by the platform. The\r
+ allocated by the platform and the\r
platform is responsible for freeing\r
the ParameterBlock after Result is\r
called.\r
platform is responsible for freeing\r
the ParameterBlock after Result is\r
called.\r
ParameterTypeGuid. The platform is responsible for freeing\r
ParameterBlock and the UEFI driver must not try to free it.\r
\r
ParameterTypeGuid. The platform is responsible for freeing\r
ParameterBlock and the UEFI driver must not try to free it.\r
\r
- @param This A pointer to the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL instance.\r
+ @param This A pointer to the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL instance.\r
- @param ControllerHandle The handle the driver is returning\r
- configuration information about.\r
+ @param ControllerHandle The handle the driver is returning\r
+ configuration information about.\r
- @param ChildHandle The handle of the child controller to\r
- return information on. This is an optional\r
- parameter that may be NULL. It will be\r
- NULL for device drivers, and for bus\r
- drivers that attempt to get options for\r
- the bus controller. It will not be NULL\r
- for a bus driver that attempts to get\r
- options for one of its child controllers.\r
- Instance Instance data returned from\r
- Query().\r
+ @param ChildHandle The handle of the child controller to\r
+ return information on. This is an optional\r
+ parameter that may be NULL. It will be\r
+ NULL for device drivers, and for bus\r
+ drivers that attempt to get options for\r
+ the bus controller. It will not be NULL\r
+ for a bus driver that attempts to get\r
+ options for one of its child controllers.\r
+ Instance Instance data returned from\r
+ Query().\r
- @param Instance Instance data passed to Query().\r
+ @param Instance Instance data passed to Query().\r
- @param ParameterTypeGuid ParameterTypeGuid returned from Query.\r
+ @param ParameterTypeGuid ParameterTypeGuid returned from Query.\r
- @param ParameterBlock ParameterBlock returned from Query.\r
+ @param ParameterBlock ParameterBlock returned from Query.\r
- @param ParameterBlockSize The ParameterBlock size returned from Query.\r
+ @param ParameterBlockSize The ParameterBlock size returned from Query.\r
- @param ConfigurationAction The driver tells the platform what\r
- action is required for ParameterBlock to\r
- take effect.\r
+ @param ConfigurationAction The driver tells the platform what\r
+ action is required for ParameterBlock to\r
+ take effect.\r
\r
\r
@retval EFI_SUCCESS The platform return parameter information\r
\r
\r
@retval EFI_SUCCESS The platform return parameter information\r
nonblocking I/O functionality is optional. \r
\r
@param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.\r
nonblocking I/O functionality is optional. \r
\r
@param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.\r
- @param Target The Target is an array of size TARGET_MAX_BYTES. It represents\r
- the id of the SCSI device that will send the SCSI Request Packet. Each\r
+ @param Target The Target is an array of size TARGET_MAX_BYTES and it represents\r
+ the id of the SCSI device to send the SCSI Request Packet. Each\r
transport driver may choose to utilize a subset of this size to suit the needs\r
of transport target representation. For example, a Fibre Channel driver\r
may use only 8 bytes (WWN) to represent an FC target.\r
transport driver may choose to utilize a subset of this size to suit the needs\r
of transport target representation. For example, a Fibre Channel driver\r
may use only 8 bytes (WWN) to represent an FC target.\r
/**\r
Used to retrieve the list of legal Target IDs and LUNs for SCSI devices on a SCSI channel. These \r
can either be the list SCSI devices that are actually present on the SCSI channel, or the list of legal\r
/**\r
Used to retrieve the list of legal Target IDs and LUNs for SCSI devices on a SCSI channel. These \r
can either be the list SCSI devices that are actually present on the SCSI channel, or the list of legal\r
- Target Ids and LUNs for the SCSI channel. Either way, the caller of this function must probe the \r
+ Target Ids and LUNs for the SCSI channel. Regardless, the caller of this function must probe the \r
Target ID and LUN returned to see if a SCSI device is actually present at that location on the SCSI \r
channel. \r
\r
Target ID and LUN returned to see if a SCSI device is actually present at that location on the SCSI \r
channel. \r
\r
Resets a SCSI logical unit that is connected to a SCSI channel.\r
\r
@param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.\r
Resets a SCSI logical unit that is connected to a SCSI channel.\r
\r
@param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.\r
- @param Target The Target is an array of size TARGET_MAX_BYTE. It represents the\r
+ @param Target The Target is an array of size TARGET_MAX_BYTE and it represents the\r
target port ID of the SCSI device containing the SCSI logical unit to\r
reset. Transport drivers may chose to utilize a subset of this array to suit\r
the representation of their targets.\r
target port ID of the SCSI device containing the SCSI logical unit to\r
reset. Transport drivers may chose to utilize a subset of this array to suit\r
the representation of their targets.\r
- Sets the following attributes for a serial device:\r
- * baud rate\r
- * receive FIFO depth\r
- * transmit/receive time out\r
- * parity \r
- * data bits\r
- * stop bits\r
+ Sets the baud rate, receive FIFO depth, transmit/receice time out, parity, \r
+ data buts, and stop bits on a serial device.\r
\r
@param This Protocol instance pointer.\r
@param BaudRate The requested baud rate. A BaudRate value of 0 will use the\r
\r
@param This Protocol instance pointer.\r
@param BaudRate The requested baud rate. A BaudRate value of 0 will use the\r
@param This Protocol instance pointer.\r
@param BufferSize On input, the size of the Buffer. On output, the amount of\r
data returned in Buffer.\r
@param This Protocol instance pointer.\r
@param BufferSize On input, the size of the Buffer. On output, the amount of\r
data returned in Buffer.\r
- @param Buffer The buffer to which to return the data.\r
+ @param Buffer The buffer to return the data into.\r
\r
@retval EFI_SUCCESS The data was read.\r
@retval EFI_DEVICE_ERROR The device reported an error.\r
\r
@retval EFI_SUCCESS The data was read.\r
@retval EFI_DEVICE_ERROR The device reported an error.\r
\r
///\r
/// The Serial I/O protocol is used to communicate with UART-style serial devices. \r
\r
///\r
/// The Serial I/O protocol is used to communicate with UART-style serial devices. \r
-/// These can be standard UART serial ports in PC-AT systems, or serial ports attached \r
-/// to a USB interface or any character-based I/O device.\r
+/// These can be standard UART serial ports in PC-AT systems, serial ports attached \r
+/// to a USB interface, or potentially any character-based I/O device.\r
///\r
struct _EFI_SERIAL_IO_PROTOCOL {\r
///\r
///\r
struct _EFI_SERIAL_IO_PROTOCOL {\r
///\r
- Write data from or to the file.\r
+ Write data to a file.\r
\r
@param This Protocol instance pointer.\r
\r
@param This Protocol instance pointer.\r
- @param BufferSize On input: size of buffer. On output: amount of data in buffer.\r
- @param Buffer The buffer in which to write data.\r
+ @param BufferSize On input size of buffer, on output amount of data in buffer.\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
\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_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
Set a files current position\r
\r
@param This Protocol instance pointer.\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
\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
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
\r
@retval EFI_SUCCESS Data was written.\r
@retval EFI_UNSUPPORTED Seek request for non-zero is not valid on open.\r
\r
@param This Protocol instance pointer.\r
@param InformationType Type of info to return in Buffer\r
\r
@param This Protocol instance pointer.\r
@param InformationType Type of info to return in Buffer\r
- @param BufferSize On input: size of buffer. On output: amount of data 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
@param Buffer The buffer to return data.\r
\r
@retval EFI_SUCCESS Data was returned.\r
EFI_NOT_READY. If there is a pending keystroke, then\r
KeyData.Key.ScanCode is the EFI scan code defined in Error!\r
Reference source not found. The KeyData.Key.UnicodeChar is the\r
EFI_NOT_READY. If there is a pending keystroke, then\r
KeyData.Key.ScanCode is the EFI scan code defined in Error!\r
Reference source not found. The KeyData.Key.UnicodeChar is the\r
- actual printable character, or is zero if the key does not\r
+ actual printable character or is zero if the key does not\r
represent a printable character (control key, function key,\r
etc.). The KeyData.KeyState is shift state for the character\r
reflected in KeyData.Key.UnicodeChar or KeyData.Key.ScanCode .\r
represent a printable character (control key, function key,\r
etc.). The KeyData.KeyState is shift state for the character\r
reflected in KeyData.Key.UnicodeChar or KeyData.Key.ScanCode .\r
- When interpreting the data from this function, printable characters that are\r
+ When interpreting the data from this function, it should be\r
+ noted that if a class of printable characters that are\r
normally adjusted by shift modifiers (e.g. Shift Key + "f"\r
normally adjusted by shift modifiers (e.g. Shift Key + "f"\r
- key) are presented solely as a KeyData.Key.UnicodeChar\r
- without the associated shift state. For example,\r
- if Shift Key + "f" key are pressed, the only pertinent\r
+ key) would be presented solely as a KeyData.Key.UnicodeChar\r
+ without the associated shift state. So in the previous example\r
+ of a Shift Key + "f" key being pressed, the only pertinent\r
data returned would be KeyData.Key.UnicodeChar with the value\r
data returned would be KeyData.Key.UnicodeChar with the value\r
- of "F". This would not typically be the case for\r
- non-printable characters such as pressing the Right\r
- Shift Key + F10 key, since the corresponding returned data\r
+ of "F". This of course would not typically be the case for\r
+ non-printable characters such as the pressing of the Right\r
+ Shift Key + F10 key since the corresponding returned data\r
would be reflected both in the KeyData.KeyState.KeyShiftState\r
and KeyData.Key.ScanCode values. UEFI drivers which implement\r
the EFI_SIMPLE_TEXT_INPUT_EX protocol are required to return\r
KeyData.Key and KeyData.KeyState values. These drivers must\r
always return the most current state of\r
KeyData.KeyState.KeyShiftState and\r
would be reflected both in the KeyData.KeyState.KeyShiftState\r
and KeyData.Key.ScanCode values. UEFI drivers which implement\r
the EFI_SIMPLE_TEXT_INPUT_EX protocol are required to return\r
KeyData.Key and KeyData.KeyState values. These drivers must\r
always return the most current state of\r
KeyData.KeyState.KeyShiftState and\r
- KeyData.KeyState.KeyToggleState. \r
- Certain input devices may not be able to produce shift or toggle\r
+ KeyData.KeyState.KeyToggleState. It should also be noted that\r
+ certain input devices may not be able to produce shift or toggle\r
state information, and in those cases the high order bit in the\r
respective Toggle and Shift state fields should not be active.\r
\r
state information, and in those cases the high order bit in the\r
respective Toggle and Shift state fields should not be active.\r
\r
\r
/**\r
The RegisterKeystrokeNotify() function registers a function\r
\r
/**\r
The RegisterKeystrokeNotify() function registers a function\r
- to be called when a specified keystroke will occur.\r
+ which will be called when a specified keystroke will occur.\r
\r
@param This A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.\r
\r
\r
@param This A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.\r
\r
- The UnregisterKeystrokeNotify() function removes a\r
- notification that was previously registered.\r
+ The UnregisterKeystrokeNotify() function removes the\r
+ notification which was previously registered.\r
\r
@param This A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.\r
\r
\r
@param This A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.\r
\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
\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
\r
- @retval EFI_SUCCESS The attribute was set.\r
+ @retval EFI_SUCCESS The attribute was set.\r
@retval EFI_DEVICE_ERROR The device had an error and could not complete the request.\r
@retval EFI_DEVICE_ERROR The device had an error and could not complete the request.\r
- @retval EFI_UNSUPPORTED The attribute requested is not defined.\r
+ @retval EFI_UNSUPPORTED The attribute requested is not defined.\r
Mode Structure pointed to by Simple Text Out protocol.\r
**/\r
typedef struct {\r
Mode Structure pointed to by Simple Text Out protocol.\r
**/\r
typedef struct {\r
-///\r
-/// The number of modes supported by QueryMode () and SetMode ().\r
-///\r
+ ///\r
+ /// The number of modes supported by QueryMode () and SetMode ().\r
+ ///\r
INT32 MaxMode;\r
\r
//\r
// current settings\r
//\r
\r
INT32 MaxMode;\r
\r
//\r
// current settings\r
//\r
\r
-///\r
-/// The text mode of the output device(s).\r
-///\r
+ ///\r
+ /// The text mode of the output device(s).\r
+ ///\r
-\r
-///\r
-/// The current character output attribute\r
-///\r
+ ///\r
+ /// The current character output attribute\r
+ ///\r
-///\r
-/// The cursor's column.\r
-///\r
+ ///\r
+ /// The cursor's column.\r
+ ///\r
-///\r
-/// The cursor's row.\r
-///\r
+ ///\r
+ /// The cursor's row.\r
+ ///\r
-///\r
-/// The cursor is currently visbile or not.\r
-///\r
+ ///\r
+ /// The cursor is currently visbile or not.\r
+ ///\r
BOOLEAN CursorVisible;\r
} EFI_SIMPLE_TEXT_OUTPUT_MODE;\r
\r
BOOLEAN CursorVisible;\r
} EFI_SIMPLE_TEXT_OUTPUT_MODE;\r
\r
EFI_SMBUS_DEVICE_COMMAND is defined in\r
EFI_PEI_SMBUS_PPI.Execute() in the Platform\r
Initialization SMBus PPI Specification.\r
EFI_SMBUS_DEVICE_COMMAND is defined in\r
EFI_PEI_SMBUS_PPI.Execute() in the Platform\r
Initialization SMBus PPI Specification.\r
@param Operation Signifies the particular SMBus\r
hardware protocol instance it will use to\r
execute the SMBus transactions. This SMBus\r
@param Operation Signifies the particular SMBus\r
hardware protocol instance it will use to\r
execute the SMBus transactions. This SMBus\r
@param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance.\r
\r
@param SlaveAddress Address that the host controller detects\r
@param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance.\r
\r
@param SlaveAddress Address that the host controller detects\r
- as sending a message, and that calls all the registered function.\r
+ as sending a message and calls all the registered function.\r
\r
@param Data Data that the host controller detects as sending\r
\r
@param Data Data that the host controller detects as sending\r
- message, and that calls all the registered function.\r
+ message and calls all the registered function.\r
\r
\r
@param NotifyFunction The function to call when the bus\r
\r
\r
@param NotifyFunction The function to call when the bus\r
- This is NULL.\r
- ConnectionToken is NULL.\r
- ConnectionToken->CompletionToken.Event is NULL.\r
- This is NULL.\r
- ConnectionToken is NULL.\r
- ConnectionToken->CompletionToken.Event is NULL.\r
- @retval EFI_OUT_OF_RESOURCES The driver can't allocate enough resources to initiate the activeopen.\r
+ @retval EFI_OUT_OF_RESOURCES The driver can't allocate enough resource to initiate the activeopen.\r
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
\r
**/\r
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
\r
**/\r
- This is NULL.\r
- ListenToken is NULL.\r
- ListentToken->CompletionToken.Event is NULL.\r
- This is NULL.\r
- ListenToken is NULL.\r
- ListentToken->CompletionToken.Event is NULL.\r
- @retval EFI_OUT_OF_RESOURCES Could not allocate enough resources to finish the operation.\r
- @retval EFI_DEVICE_ERROR Any unexpected error not covered by another error.\r
+ @retval EFI_OUT_OF_RESOURCES Could not allocate enough resource to finish the operation.\r
+ @retval EFI_DEVICE_ERROR Any unexpected and not belonged to above category error.\r
Tcp4StateListen state.\r
- User has called Close() to disconnect this connection.\r
@retval EFI_CONNECTION_FIN The communication peer has closed the connection and there is\r
Tcp4StateListen state.\r
- User has called Close() to disconnect this connection.\r
@retval EFI_CONNECTION_FIN The communication peer has closed the connection and there is\r
- no buffered data in the receive buffer of this instance.\r
+ no any buffered data in the receive buffer of this instance.\r
@retval EFI_NOT_READY The receive request could not be queued because the receive queue is full.\r
\r
**/\r
@retval EFI_NOT_READY The receive request could not be queued because the receive queue is full.\r
\r
**/\r
- This is NULL.\r
- CloseToken is NULL.\r
- CloseToken->CompletionToken.Event is NULL.\r
- This is NULL.\r
- CloseToken is NULL.\r
- CloseToken->CompletionToken.Event is NULL.\r
- @retval EFI_OUT_OF_RESOURCES Could not allocate enough resources to finish the operation.\r
- @retval EFI_DEVICE_ERROR Any unexpected error not covered by another error.\r
+ @retval EFI_OUT_OF_RESOURCES Could not allocate enough resource to finish the operation.\r
+ @retval EFI_DEVICE_ERROR Any unexpected and not belonged to above category error.\r
will wait before the watchdog timer is fired. If TimerPeriod of\r
zero is returned, then the watchdog timer is disabled.\r
\r
will wait before the watchdog timer is fired. If TimerPeriod of\r
zero is returned, then the watchdog timer is disabled.\r
\r
- @retval EFI_SUCCESS The function successfully returned TimerPeriod with the amount of time that the system will wait before firing the watchdog timer.\r
+ @retval EFI_SUCCESS The amount of time that the system will wait before\r
+ firing the watchdog timer was returned in TimerPeriod.\r
@retval EFI_INVALID_PARAMETER TimerPeriod is NULL.\r
\r
**/\r
@retval EFI_INVALID_PARAMETER TimerPeriod is NULL.\r
\r
**/\r
///\r
/// This is just to make sure you can cross compile with the EBC compiler.\r
/// It does not make sense to have a PE loader coded in EBC. You need to \r
///\r
/// This is just to make sure you can cross compile with the EBC compiler.\r
/// It does not make sense to have a PE loader coded in EBC. You need to \r
-/// understand the basic \r
+/// understand the basic.\r
///\r
#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_EBC)\r
\r
///\r
#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_EBC)\r
\r
///\r
EfiResetWarm,\r
///\r
///\r
EfiResetWarm,\r
///\r
- /// Used to induce an entry into the power state equivalent to the ACPI G2/S5 or G3\r
+ /// Used to induce an entry into a power state equivalent to the ACPI G2/S5 or G3\r
/// state. If the system does not support this reset type, then when the system\r
/// is rebooted, it should exhibit the EfiResetCold attributes.\r
///\r
/// state. If the system does not support this reset type, then when the system\r
/// is rebooted, it should exhibit the EfiResetCold attributes.\r
///\r
projects / mirror_edk2.git / commitdiff