update codes per MdePkg doxgen review comments.
authorvanjeff <vanjeff@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 11 Jun 2009 01:46:51 +0000 (01:46 +0000)
committervanjeff <vanjeff@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 11 Jun 2009 01:46:51 +0000 (01:46 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8526 6f19259b-4bc3-4df7-8a09-765794883524

31 files changed:
MdePkg/Include/Base.h
MdePkg/Include/IndustryStandard/Tpm12.h
MdePkg/Include/Library/HobLib.h
MdePkg/Include/Library/PcdLib.h
MdePkg/Include/Library/PciLib.h
MdePkg/Include/Protocol/ComponentName.h
MdePkg/Include/Protocol/ComponentName2.h
MdePkg/Include/Protocol/DeviceIo.h
MdePkg/Include/Protocol/DriverSupportedEfiVersion.h
MdePkg/Include/Protocol/Ebc.h
MdePkg/Include/Protocol/FirmwareVolumeBlock.h
MdePkg/Include/Protocol/FormBrowser2.h
MdePkg/Include/Protocol/GraphicsOutput.h
MdePkg/Include/Protocol/Hash.h
MdePkg/Include/Protocol/HiiConfigRouting.h
MdePkg/Include/Protocol/HiiDatabase.h
MdePkg/Include/Protocol/HiiFont.h
MdePkg/Include/Protocol/Ip4.h
MdePkg/Include/Protocol/Metronome.h
MdePkg/Include/Protocol/Mtftp4.h
MdePkg/Include/Protocol/PlatformToDriverConfiguration.h
MdePkg/Include/Protocol/ScsiPassThruExt.h
MdePkg/Include/Protocol/SerialIo.h
MdePkg/Include/Protocol/SimpleFileSystem.h
MdePkg/Include/Protocol/SimpleTextInEx.h
MdePkg/Include/Protocol/SimpleTextOut.h
MdePkg/Include/Protocol/SmbusHc.h
MdePkg/Include/Protocol/Tcp4.h
MdePkg/Include/Protocol/WatchdogTimer.h
MdePkg/Include/Uefi/UefiBaseType.h
MdePkg/Include/Uefi/UefiSpec.h

index 4eedffde0b8ed1bb150530c7b758fbd92072fc93..f429acd65834ad8edeb39d730e494ce7011ee6db 100644 (file)
@@ -489,7 +489,7 @@ typedef UINTN  *BASE_LIST;
   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
@@ -518,7 +518,6 @@ typedef UINTN  *BASE_LIST;
   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
@@ -534,7 +533,6 @@ typedef UINTN  *BASE_LIST;
   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
index 398f5956dd5345a7cf7c9f508502678323fe8499..f0e307ba4d20a9af4ffcf61060b6848c79956d19 100644 (file)
@@ -1601,18 +1601,12 @@ typedef struct tdTPM_CONTEXT_SENSITIVE {
 #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
-  TPM_NV_PER_ATTRIBUTES           attributes;\r
+  UINT32                          attributes;\r
 } TPM_NV_ATTRIBUTES;\r
 \r
 #define TPM_NV_PER_READ_STCLEAR        (BIT31)\r
index 15905244938da7b08e629423c5444b525930392b..d17de0b35ef4695ccf2dc50a94da4a3f677560fd 100644 (file)
@@ -8,7 +8,7 @@
   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
@@ -419,9 +419,9 @@ BuildMemoryAllocationHob (
   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
 \r
-  @param  Hob   A pointer to a HOB.\r
+  @param  HobStart   A pointer to a HOB.\r
   \r
   @return HobType.\r
   \r
@@ -433,9 +433,9 @@ BuildMemoryAllocationHob (
   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
 \r
-  @param  Hob   A pointer to a HOB.\r
+  @param  HobStart   A pointer to a HOB.\r
 \r
   @return HobLength.\r
 \r
@@ -447,9 +447,9 @@ BuildMemoryAllocationHob (
   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
 \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
@@ -460,23 +460,23 @@ BuildMemoryAllocationHob (
 /**\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
-  @param  Hob   A pointer to a HOB.\r
+  @param  HobStart   A pointer to a HOB.\r
 \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
 \r
 **/\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
-  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
@@ -489,8 +489,8 @@ BuildMemoryAllocationHob (
 /**\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
index 3b0f830e7f96023838a1289d66d725f545c3f074..00548bebc4e0845e51f73853cae7699e02035415 100644 (file)
@@ -6,7 +6,7 @@
   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
index 708571bfd32f020e6fc39c7537c2c895c1306617..b15f69b0da30b41c9df7073c0b2019e8be59fd85 100644 (file)
@@ -10,7 +10,7 @@
   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
@@ -37,8 +37,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   @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
@@ -167,7 +167,7 @@ PciAnd8 (
 \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
index f7f287137552cbe48b377447f0ceae6203433067..1f0f5f1749b8ff8f665be9a4bfbcd308bda69b3e 100644 (file)
@@ -1,6 +1,6 @@
 /** @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
@@ -29,7 +29,7 @@ typedef struct _EFI_COMPONENT_NAME_PROTOCOL  EFI_COMPONENT_NAME_PROTOCOL;
 \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
index 45b2a8a8817eb6b90ca5a1eb184c6d808118dd51..08efec6b8dce897ab48f48218e9b527a6ef8f169 100644 (file)
@@ -27,7 +27,7 @@ typedef struct _EFI_COMPONENT_NAME2_PROTOCOL  EFI_COMPONENT_NAME2_PROTOCOL;
 \r
 \r
 /**\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
index fc68603b346f6bda5427007bcea7ba123ab5a5d1..99a48cdccbf5249e15389e82a9e8249b1d22009e 100644 (file)
@@ -135,7 +135,7 @@ typedef enum {
   @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
index dc72ecb756be00e64ecff0d1d29737c0eb98351f..9f4d199c88e59c6a7a4a98168ebaba18553125c8 100644 (file)
@@ -32,7 +32,7 @@
 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
index 13ece4a22767b710abfeb8878919f0f4c61e52f0..6266eb5531aae4149e2b63de4a8ad4649f237d39 100644 (file)
@@ -42,7 +42,7 @@ typedef struct _EFI_EBC_PROTOCOL EFI_EBC_PROTOCOL;
   @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
@@ -119,7 +119,7 @@ EFI_STATUS
   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
index d25a2a0fa0fabdc743a6a2614dc86993e2e57f29..0f9a9c1f7ae02b3309520ba31eb27978e28e78e3 100644 (file)
@@ -208,7 +208,7 @@ EFI_STATUS
   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
@@ -276,7 +276,7 @@ EFI_STATUS
 /**\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
index 43589c1399e5a0875550cfb021c81c14de18db1a..9cb3f9657c1a8f2707a9faee4919db1e8b451b33 100644 (file)
@@ -29,10 +29,12 @@ typedef struct _EFI_FORM_BROWSER2_PROTOCOL   EFI_FORM_BROWSER2_PROTOCOL;
 /**\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
-                      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
index 5f2e6e174635f5e59f8b467463d2b7b1c7f61ef9..8d63f9787e952a67b903c23395a12b1a58bc0fc9 100644 (file)
@@ -33,7 +33,7 @@ typedef struct {
 \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
@@ -41,7 +41,7 @@ typedef enum {
   ///\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
index e5cc8ded3a04eb26d59c0a34706ec38c3f3130ef..6441bfe7a8de8ab7bafb68a9f0cb4766aba0c0c8 100644 (file)
@@ -79,7 +79,7 @@ typedef union {
 } 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
@@ -100,7 +100,7 @@ EFI_STATUS
   );      \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
index dbdaca382775c0c4e94074808bad5828c88aa817..3cbca370f11df4b30173271b054e4ecbfaa0cf09 100644 (file)
@@ -402,7 +402,7 @@ struct _EFI_HII_CONFIG_ROUTING_PROTOCOL {
   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
index 4fb26134bc8bd8267d5d437fa4760507ca7e4287..45012717fc6aa16a6337983c65c69b996c0f6710 100644 (file)
@@ -147,7 +147,8 @@ EFI_STATUS
   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
index 2b836158d9272c83a836806c9f74ede943a4da10..607964c7e27f5a368f66959ab78f22bb31d93837 100644 (file)
@@ -90,10 +90,10 @@ typedef struct {
 /**\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
-  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
index 5dc2dc69e7105ae6552df87ddd756e7fe5381baa..beb114a6e51090390a26485a613703947aa1dc70 100644 (file)
@@ -512,7 +512,7 @@ EFI_STATUS
   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
index bef64a5963d6ac8ece342070fee7c7b0adc565b6..2383c73046446f020639a49a11c11a0222f40b1e 100644 (file)
@@ -33,7 +33,7 @@ typedef struct _EFI_METRONOME_ARCH_PROTOCOL   EFI_METRONOME_ARCH_PROTOCOL;
   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
index 149c6270e01eba5df7b1063d5a74c7d11020da4f..988cbe16278b6f147d9db3ecb6aeef1cbade3f61 100644 (file)
@@ -184,7 +184,7 @@ typedef struct {
 /**\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
index 6c974caf640a81933149a19a166ff43a4a78eecf..628873c59e6014a1b23ed4ef9bc7dc9ce3fed4f4 100644 (file)
@@ -76,7 +76,7 @@ typedef struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL EFI_PLATFORM_TO_DR
                               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
@@ -85,7 +85,7 @@ typedef struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL EFI_PLATFORM_TO_DR
                               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
@@ -201,33 +201,33 @@ typedef enum {
   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
 \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
 \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
 \r
-  @param Instance           Instance data passed to Query().\r
+  @param Instance            Instance data passed to Query().\r
 \r
-  @param ParameterTypeGuid  ParameterTypeGuid returned from Query.\r
+  @param ParameterTypeGuid   ParameterTypeGuid returned from Query.\r
 \r
-  @param ParameterBlock     ParameterBlock returned from Query.\r
+  @param ParameterBlock      ParameterBlock returned from Query.\r
 \r
-  @param ParameterBlockSize The ParameterBlock size returned from Query.\r
+  @param ParameterBlockSize  The ParameterBlock size returned from Query.\r
 \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
index 176db59aee539745ecd21fb1897402b0be62fa1c..611e8a28871835f76d401b3664a0aad7138f0926 100644 (file)
@@ -153,8 +153,8 @@ typedef struct {
   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
@@ -201,7 +201,7 @@ EFI_STATUS
 /**\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
@@ -317,7 +317,7 @@ EFI_STATUS
   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
index 4fbfe027ebf37f616ea68a9a47073a87ef5dc1d0..aca2cac18864d263260349eb61fa336173218a6b 100644 (file)
@@ -104,13 +104,8 @@ EFI_STATUS
   );\r
 \r
 /**\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
@@ -208,7 +203,7 @@ EFI_STATUS
   @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
@@ -277,8 +272,8 @@ typedef struct {
 \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
index 07332351808f9f445ae65ea540e6b6cdd7ab3f11..6396e4df361f95cbaad60da14f82cf5bc874e51e 100644 (file)
@@ -181,16 +181,17 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Write data from or to the file.\r
+  Write data to a file.\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
+  @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
@@ -209,7 +210,7 @@ EFI_STATUS
   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
@@ -226,7 +227,7 @@ EFI_STATUS
   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
@@ -244,7 +245,7 @@ EFI_STATUS
 \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
index 98d0c583dcd8e693a1561bbdcbe587f318378062..5baede162ffb6d9810f337ba459a36e18c24e546 100644 (file)
@@ -151,27 +151,28 @@ typedef struct {
   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
-  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
-  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
-  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
-  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
@@ -238,7 +239,7 @@ EFI_STATUS
 \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
@@ -271,8 +272,8 @@ EFI_STATUS
 );\r
 \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
index f2d22030ed2276ef079a86ca93b74125cbf910c2..b75e52a69605c9c7298c1e593f237e7b6e880973 100644 (file)
@@ -262,9 +262,9 @@ EFI_STATUS
                     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_UNSUPPORTED The attribute requested is not defined.\r
+  @retval EFI_UNSUPPORTED   The attribute requested is not defined.\r
 \r
 **/\r
 typedef\r
@@ -342,35 +342,34 @@ EFI_STATUS
   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
-///\r
-/// The text mode of the output device(s).\r
-///\r
+  ///\r
+  /// The text mode of the output device(s).\r
+  ///\r
   INT32   Mode;\r
-\r
-///\r
-/// The current character output attribute\r
-///\r
+  ///\r
+  /// The current character output attribute\r
+  ///\r
   INT32   Attribute;\r
-///\r
-/// The cursor's column.\r
-///\r
+  ///\r
+  /// The cursor's column.\r
+  ///\r
   INT32   CursorColumn;\r
-///\r
-/// The cursor's row.\r
-///\r
+  ///\r
+  /// The cursor's row.\r
+  ///\r
   INT32   CursorRow;\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
index 067ebb2b0a1b0443ca75ba61fb2c0de7325bbf7d..ffa7cff50e56c77e2848b3cd9563c2e488e3d9ad 100644 (file)
@@ -51,6 +51,7 @@ typedef struct _EFI_SMBUS_HC_PROTOCOL EFI_SMBUS_HC_PROTOCOL;
                   EFI_SMBUS_DEVICE_COMMAND is defined in\r
                   EFI_PEI_SMBUS_PPI.Execute() in the Platform\r
                   Initialization SMBus PPI Specification.\r
+\r
  @param Operation Signifies the particular SMBus\r
                   hardware protocol instance it will use to\r
                   execute the SMBus transactions. This SMBus\r
@@ -249,10 +250,10 @@ EFI_STATUS
   @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
-                          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
index 544236b10dbcca38f2ddb9bd468c81b9849859f3..d750fe9c788ba2ceb0c0dee81664373510613fe9 100644 (file)
@@ -279,7 +279,7 @@ EFI_STATUS
                                 - 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
@@ -308,8 +308,8 @@ EFI_STATUS
                                 - 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
 \r
 **/\r
 typedef\r
@@ -389,7 +389,7 @@ EFI_STATUS
                                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
@@ -419,8 +419,8 @@ EFI_STATUS
                                 - 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
 \r
 **/\r
 typedef\r
index efe898765f7861f427fd02af9c6cc8ed74555703..27278620387d26e1afbc4ccfb9fd48dcdd1f86f5 100644 (file)
@@ -108,7 +108,8 @@ EFI_STATUS
                            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
index 405e9bbed383cf1941e17c53a006a5ceaef08021..c500a0fc1f3cb9862b0063268cae3a446cacb13c 100644 (file)
@@ -224,7 +224,7 @@ typedef union {
 ///\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
index 65153fa18526814dbbce4c044204fb85d1bd1bfe..a555350527419d8699e7067dc50547b435fb2b8c 100644 (file)
@@ -964,7 +964,7 @@ typedef enum {
   ///\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