Grammatical and disclaimer changes (does not follow internal C coding stds.)
authormyronporter <myronporter@6f19259b-4bc3-4df7-8a09-765794883524>
Sat, 13 Mar 2010 01:03:39 +0000 (01:03 +0000)
committermyronporter <myronporter@6f19259b-4bc3-4df7-8a09-765794883524>
Sat, 13 Mar 2010 01:03:39 +0000 (01:03 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10238 6f19259b-4bc3-4df7-8a09-765794883524

EdkCompatibilityPkg/Compatibility/Include/Guid/BootState.h
EdkCompatibilityPkg/Compatibility/Include/Guid/SmmBaseThunkCommunication.h
EdkCompatibilityPkg/Compatibility/Include/Library/LanguageLib.h
EdkCompatibilityPkg/Compatibility/Include/Ppi/EcpPciCfg.h
EdkCompatibilityPkg/Compatibility/Include/Protocol/Print.h

index 8211328443bfadc7fb5267240753af6290b1bb59..627521edb1368291986a9688767fc8a1e40176d4 100644 (file)
@@ -1,20 +1,21 @@
 /** @file\r
-  GUID and Name is used to configure PcdBootState to DynamicHii PCD, which can\r
-  make EDKII core work with EDK implementation.\r
+  GUID and Name are used to configure PcdBootState to DynamicHii PCD, which can\r
+  make EDKII core work with the EDK implementation.\r
 \r
-  EDK implementation may depend on this guid variable to check boot state. But \r
-  EDKII core uses the dynamic PcdBootState to save boot state. To be compatible to EDK implementation\r
-  BootStateGuid and BootStateName will be used to configure PcdBootState to DynamicHii PCD to\r
-  save boot state as variable.\r
+  The EDK implementation may depend on this guid variable to check the boot state.  \r
+  However, the EDKII core uses a dynamic PcdBootState to save the boot state. To be compatible with EDK implementations\r
+  BootStateGuid and BootStateName are used to configure PcdBootState to DynamicHii PCD to\r
+  save the boot state as a variable.\r
   \r
-  Copyright (c) 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) 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
 #ifndef _BOOT_STATE_H_\r
index 76deda869328a37b70b111222def298d78615adf..188aff9bd209281f21f406a6dd08eaab47a8331f 100644 (file)
@@ -2,14 +2,15 @@
   GUID and data structures for communication between SMM Base on SMM Base2 Thunk driver\r
   and SmmBaseHelper driver.\r
 \r
-  Copyright (c) 2009 - 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) 2009 - 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
 \r
 **/\r
 #ifndef  _SMM_BASE_THUNK_COMMUNICATION_H_\r
index 406704a25484dfce83d9bb3f5d8a58aa94b35461..a25fbae8c414927c959193f1a69da0262edf38d1 100644 (file)
@@ -1,11 +1,12 @@
 /** @file\r
   Provides functions for language conversion between ISO 639-2 and RFC 4646 styles.\r
 \r
-Copyright (c) 2009 - 2010, 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
@@ -28,7 +29,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
                                representing an RFC 4646 language code containing only\r
                                either a ISO 639-1 or ISO 639-2 primary language subtag.\r
                                This string is Null-terminated.\r
-  @param[in]  Iso639Language   Pointer to a 3-letter ASCII string that represents\r
+  @param[in]  Iso639Language   The pointer to a 3-letter ASCII string that represents\r
                                an ISO 639-2 language code. This string is not required\r
                                to be Null-terminated.\r
 \r
@@ -53,8 +54,10 @@ ConvertIso639ToRfc4646 (
   If Iso639Language is NULL, then ASSERT().\r
 \r
   @param[out] Iso639Language   Pointers to a buffer large enough for a 3-letter ASCII string\r
-                               representing an ISO 639-2 language code. The string is Null-terminated.\r
-  @param[in]  Rfc4646Language  Pointer to a RFC 4646 language code string. This string is terminated\r
+                               representing an ISO 639-2 language code. The string \r
+                               is Null-terminated.\r
+  @param[in]  Rfc4646Language  The pointer to a RFC 4646 language code string. \r
+                               This string is terminated\r
                                by a NULL or a ';' character.\r
 \r
   @retval TRUE                 Language code converted successfully.\r
@@ -79,8 +82,10 @@ ConvertRfc4646ToIso639 (
   \r
   @retval NULL                Invalid ISO 639-2 language code found.\r
   @retval NULL                Out of memory.\r
-  @return                     Pointer to the allocate buffer containing the Null-terminated converted language codes string.\r
-                              This string is composed of one or more RFC4646 language codes each of which has only\r
+  @return                     The pointer to the allocate buffer containing the \r
+                              Null-terminated converted language codes string.\r
+                              This string is composed of one or more RFC4646 \r
+                              language codes each of which has only\r
                               ISO 639-1 2-letter primary language subtag.\r
 \r
 **/\r
@@ -97,13 +102,15 @@ ConvertLanguagesIso639ToRfc4646 (
 \r
   If Rfc4646Languages is NULL, then ASSERT.\r
 \r
-  @param[in] Rfc4646Languages  Pointers to a Null-terminated RFC 4646 language codes string containing\r
-                               one or more RFC 4646 language codes.\r
+  @param[in] Rfc4646Languages  Pointers to a Null-terminated RFC 4646 language codes \r
+                               string containing one or more RFC 4646 language codes.\r
   \r
   @retval NULL                 Invalid or unsupported RFC 4646 language code found.\r
   @retval NULL                 Out of memory.\r
-  @return                      Pointer to the allocate buffer containing the Null-terminated converted language codes string.\r
-                               This string is composed of one or more ISO 639-2 language codes.\r
+  @return                      The pointer to the allocate buffer containing the \r
+                               Null-terminated converted language codes string.\r
+                               This string is composed of one or more ISO 639-2 \r
+                               language codes.\r
 \r
 **/\r
 CHAR8 *\r
index 9428ff91344140e83c5ffe80c6d03f9fd52db714..524aa12902ed1ffacda4952a07ac16e7b6fdbc32 100644 (file)
@@ -1,13 +1,15 @@
 /** @file\r
-This PPI is the same as the PPI in the framework PciCfg, with one exception: this PPI does not include a modify API, while the PPI in the framework PciCfg does. \r
-\r
-Copyright (c) 2008 - 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
+This PPI is the same as the PPI in the framework PciCfg, with one exception. \r
+Specifically, this PPI does not include a modify API, while the PPI in the framework PciCfg does. \r
+\r
+Copyright (c) 2008 - 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
 \r
 **/\r
@@ -23,19 +25,21 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 typedef struct _ECP_PEI_PCI_CFG_PPI ECP_PEI_PCI_CFG_PPI;\r
 \r
 /**\r
-  PCI read and write operation.\r
+  PCI read and write operation.\r
   \r
-  Writes to or reads from a given location in the PCI configuration space.\r
+  Writes to, or reads from, a given location in the PCI configuration space.\r
 \r
-  @param  PeiServices              An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
-  @param  This                     Pointer to local data for the interface.\r
+  @param  PeiServices              An indirect pointer to the PEI Services Table \r
+                                   published by the PEI Foundation.\r
+  @param  This                     The pointer to local data for the interface.\r
   @param  Width                    The width of the access. Enumerated in bytes.\r
   @param  Address                  The physical address of the access. The format of\r
                                    the address is described by EFI_PEI_PCI_CFG_PPI_PCI_ADDRESS.\r
   @param  Buffer                   A pointer to the buffer of data.\r
   @retval EFI_SUCCESS              The function completed successfully.\r
   @retval EFI_DEVICE_ERROR         There was a problem with the transaction.\r
-  @retval EFI_DEVICE_NOT_READY     The device is not capable of supporting the operation at this time.\r
+  @retval EFI_DEVICE_NOT_READY     The device is not capable of supporting the \r
+                                   operation at this time.\r
 **/\r
 typedef\r
 EFI_STATUS\r
index 5c0426232a5962cbf849acc3ea7fc7de8a7b9622..d6ccc50d3b8044157c808e6d83c8975b0a47eaa2 100644 (file)
@@ -3,11 +3,12 @@
   The lite print protocol defines only one print function to \r
   print the format unicode string.\r
 \r
-Copyright (c) 2006 - 2008, Intel Corporation\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
@@ -26,17 +27,17 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 typedef struct _EFI_PRINT_PROTOCOL  EFI_PRINT_PROTOCOL;\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
+  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
   \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
+  If BufferSize is 0 or 1, then no output buffer is produced, and 0 is returned.\r
 \r
   If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
   If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
@@ -46,13 +47,13 @@ typedef struct _EFI_PRINT_PROTOCOL  EFI_PRINT_PROTOCOL;
   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
                           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  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
@@ -69,9 +70,9 @@ UINTN
   );\r
 \r
 /**\r
-   The EFI_PRINT_PROTOCOL provides one service to produce a Null-terminated Unicode string\r
-   based on a Null-terminated Unicode format string and a VA_LIST argument list and fill into \r
-   the buffer as output\r
+   EFI_PRINT_PROTOCOL provides one service to produce a Null-terminated Unicode string,\r
+   based on a Null-terminated Unicode format string and a VA_LIST argument list, and fills into \r
+   the buffer as output.\r
 **/\r
 struct _EFI_PRINT_PROTOCOL {\r
   UNI_VSPRINT               VSPrint;\r