]> git.proxmox.com Git - mirror_edk2.git/commitdiff
Function headers in .h and .c files synchronized with spec
authorjji4 <jji4@6f19259b-4bc3-4df7-8a09-765794883524>
Wed, 26 Nov 2008 06:38:05 +0000 (06:38 +0000)
committerjji4 <jji4@6f19259b-4bc3-4df7-8a09-765794883524>
Wed, 26 Nov 2008 06:38:05 +0000 (06:38 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6731 6f19259b-4bc3-4df7-8a09-765794883524

MdePkg/Include/Library/PeiServicesLib.h
MdePkg/Include/Library/PostCodeLib.h
MdePkg/Include/Library/ResourcePublicationLib.h
MdePkg/Library/BasePeCoffGetEntryPointLib/PeCoffGetEntryPoint.c
MdePkg/Library/BasePeCoffLib/BasePeCoff.c
MdePkg/Library/BasePostCodeLibDebug/PostCode.c
MdePkg/Library/BasePrintLib/PrintLib.c
MdePkg/Library/PeiDxePostCodeLibReportStatusCode/PostCode.c
MdePkg/Library/PeiPciSegmentLibPciCfg2/PciSegmentLib.c
MdePkg/Library/PeiResourcePublicationLib/PeiResourcePublicationLib.c
MdePkg/Library/PeiServicesLib/PeiServicesLib.c

index e417870cdbe679537dcd7d1c0503ce578a6dfb86..9714bb8ff10590262aa33a9a6bf5ce4755b58ed8 100644 (file)
@@ -16,7 +16,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define __PEI_SERVICES_LIB_H__\r
 \r
 /**\r
-  This service enables a given PEIM to register an interface into the PEI Foundation. \r
+  This service enables a given PEIM to register an interface into the PEI Foundation.\r
 \r
   @param  PpiList               A pointer to the list of interfaces that the caller shall install.\r
 \r
@@ -98,7 +98,7 @@ PeiServicesNotifyPpi (
   );\r
 \r
 /**\r
-  This service enables PEIMs to ascertain the present value of the boot mode.  \r
+  This service enables PEIMs to ascertain the present value of the boot mode.\r
 \r
   @param  BootMode              A pointer to contain the value of the boot mode.\r
 \r
@@ -113,7 +113,7 @@ PeiServicesGetBootMode (
   );\r
 \r
 /**\r
-  This service enables PEIMs to update the boot mode variable.    \r
+  This service enables PEIMs to update the boot mode variable.\r
 \r
   @param  BootMode              The value of the boot mode to set.\r
 \r
@@ -165,7 +165,7 @@ PeiServicesCreateHob (
 \r
   @param  Instance              This instance of the firmware volume to find.  The value 0 is the\r
                                 Boot Firmware Volume (BFV).\r
-  @param  VolumeHandle          Pointer to the firmware volume header of the volume to return.\r
+  @param  VolumeHandle          Handle of the firmware volume header of the volume to return.\r
 \r
   @retval EFI_SUCCESS           The volume was found.\r
   @retval EFI_NOT_FOUND         The volume was not found.\r
@@ -185,7 +185,7 @@ PeiServicesFfsFindNextVolume (
   @param  SearchType            A filter to find files only of this type.\r
   @param  VolumeHandle          Pointer to the firmware volume header of the volume to search.\r
                                 This parameter must point to a valid FFS volume.\r
-  @param  FileHandle            Pointer to the current file from which to begin searching.\r
+  @param  FileHandle            Handle of the current file from which to begin searching.\r
 \r
   @retval EFI_SUCCESS           The file was found.\r
   @retval EFI_NOT_FOUND         The file was not found.\r
index 092f7ee15e7616945c509b407d9acfcd68ce9675..86ad1c67613af18e36edf8508f14c8b09f5de223 100644 (file)
@@ -33,7 +33,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
   @param  Value  The 32-bit value to write to the POST card.\r
 \r
-  @return  Value The 32-bit value to write to the POST card.\r
+  @return The 32-bit value to write to the POST card.\r
 \r
 **/\r
 UINT32\r
@@ -55,16 +55,16 @@ PostCode (
   value on the status reporting device.  \r
 \r
   PostCodeWithDescription()must actively prevent recursion.  If \r
-  PostCodeWithDescription() is called while processing another any other \r
-  Post Code Library function, then PostCodeWithDescription() \r
-  must return Value immediately.\r
+  PostCodeWithDescription() is called while processing another any other Post \r
+  Code Library function, then PostCodeWithDescription() must return Value \r
+  immediately.\r
 \r
   @param  Value        The 32-bit value to write to the POST card.\r
   @param  Description  Pointer to an ASCII string that is a description of the \r
                        POST code value.  This is an optional parameter that may \r
                        be NULL.\r
 \r
-  @return  Value       The 32-bit value to write to the POST card.\r
+  @return The 32-bit value to write to the POST card.\r
 \r
 **/\r
 UINT32\r
index 542463b88f756131a89244a77eb9ba61dc632c0e..59d45b64a00ca457ca82fdbb163822009d6c2f5d 100644 (file)
@@ -16,7 +16,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define __RESOURCE_PUBLICATION_LIB__\r
 \r
 /**\r
-  \r
   Declares the presence of permanent system memory in the platform.\r
 \r
   Declares that the system memory buffer specified by MemoryBegin and MemoryLength\r
index 81a279afcad0af2a36ae126164d87ed6c6317e50..ed1982944c317fb43c658cb5eac21e322a013023 100644 (file)
@@ -127,7 +127,7 @@ PeCoffLoaderGetMachineType (
 \r
 /**\r
   Returns a pointer to the PDB file name for a PE/COFF image that has been\r
-  loaded into system memory with the PE/COFF Loader Library functions.\r
+  loaded into system memory with the PE/COFF Loader Library functions. \r
 \r
   Returns the PDB file name for the PE/COFF image specified by Pe32Data.  If\r
   the PE/COFF image specified by Pe32Data is not a valid, then NULL is\r
index 69033598e6ba70304a3de302edb117ca7ddbdf2e..9756520aa6d98815aea6ad9d6e7a6c72f7c3f627 100644 (file)
@@ -181,6 +181,8 @@ PeCoffLoaderGetPeHeader (
   If any errors occur while computing the fields of ImageContext, \r
   then the error status is returned in the ImageError field of ImageContext.  \r
   If the image is a TE image, then SectionAlignment is set to 0.\r
+  The ImageRead and Handle fields of ImageContext structure must be valid prior \r
+  to invoking this service.\r
 \r
   @param  ImageContext              Pointer to the image context structure that describes the PE/COFF\r
                                     image that needs to be examined by this function.\r
index 974adceca77daba2b8aea52af50f39564d9b99e0..f51af776c578246bba9c6ed61585201b2eaa62bf 100644 (file)
@@ -31,9 +31,9 @@
   processing another any other Post Code Library function, then \r
   PostCode() must return Value immediately.\r
 \r
-  @param   Value  The 32-bit value to write to the POST card.\r
+  @param  Value  The 32-bit value to write to the POST card.\r
 \r
-  @return  The 32-bit value to write to the POST card.\r
+  @return The 32-bit value to write to the POST card.\r
 \r
 **/\r
 UINT32\r
index d08024758a874fe71457c3ab5da3c1032ff74d78..308f6273bf0c1055e786c604fd4b4f0e5c61096f 100644 (file)
@@ -93,6 +93,7 @@ UnicodeVSPrint (
   @param  FormatString    Null-terminated Unicode format string.\r
   @param  ...             Variable argument list whose contents are accessed based on the \r
                           format string specified by FormatString.\r
+  \r
   @return The number of Unicode characters in the produced output buffer not including the\r
           Null-terminator.\r
 \r
index 1b8cd899c3f219362f773863328a06f935a970b6..6f010f2d3be541a3e598861387029db687102341 100644 (file)
 /**\r
   Sends an 32-bit value to a POST card.\r
 \r
-  Sends the 32-bit value specified by Value to a POST card, and returns Value.\r
-  Some implementations of this library function may perform I/O operations\r
-  directly to a POST card device.  Other implementations may send Value to\r
-  ReportStatusCode(), and the status code reporting mechanism will eventually\r
+  Sends the 32-bit value specified by Value to a POST card, and returns Value.  \r
+  Some implementations of this library function may perform I/O operations \r
+  directly to a POST card device.  Other implementations may send Value to \r
+  ReportStatusCode(), and the status code reporting mechanism will eventually \r
   display the 32-bit value on the status reporting device.\r
-\r
-  PostCode() must actively prevent recursion.  If PostCode() is called while\r
-  processing another any other Post Code Library function, then\r
+  \r
+  PostCode() must actively prevent recursion.  If PostCode() is called while \r
+  processing another any other Post Code Library function, then \r
   PostCode() must return Value immediately.\r
 \r
   @param  Value  The 32-bit value to write to the POST card.\r
 \r
-  @return  Value The 32-bit value to write to the POST card.\r
+  @return The 32-bit value to write to the POST card.\r
 \r
 **/\r
 UINT32\r
@@ -69,24 +69,24 @@ PostCode (
   Sends an 32-bit value to a POST and associated ASCII string.\r
 \r
   Sends the 32-bit value specified by Value to a POST card, and returns Value.\r
-  If Description is not NULL, then the ASCII string specified by Description is\r
-  also passed to the handler that displays the POST card value.  Some\r
-  implementations of this library function may perform I/O operations directly\r
-  to a POST card device.  Other implementations may send Value to ReportStatusCode(),\r
-  and the status code reporting mechanism will eventually display the 32-bit\r
-  value on the status reporting device.\r
-\r
-  PostCodeWithDescription()must actively prevent recursion.  If\r
-  PostCodeWithDescription() is called while processing another any other Post\r
-  Code Library function, then PostCodeWithDescription() must return Value\r
+  If Description is not NULL, then the ASCII string specified by Description is \r
+  also passed to the handler that displays the POST card value.  Some \r
+  implementations of this library function may perform I/O operations directly \r
+  to a POST card device.  Other implementations may send Value to ReportStatusCode(), \r
+  and the status code reporting mechanism will eventually display the 32-bit \r
+  value on the status reporting device.  \r
+\r
+  PostCodeWithDescription()must actively prevent recursion.  If \r
+  PostCodeWithDescription() is called while processing another any other Post \r
+  Code Library function, then PostCodeWithDescription() must return Value \r
   immediately.\r
 \r
   @param  Value        The 32-bit value to write to the POST card.\r
-  @param  Description  Pointer to an ASCII string that is a description of the\r
-                       POST code value.  This is an optional parameter that may\r
+  @param  Description  Pointer to an ASCII string that is a description of the \r
+                       POST code value.  This is an optional parameter that may \r
                        be NULL.\r
 \r
-  @return  Value       The 32-bit value to write to the POST card.\r
+  @return The 32-bit value to write to the POST card.\r
 \r
 **/\r
 UINT32\r
index 729391d9c995fa84094c6a123530223396558c1a..a02954ae0564fddbb4671d07a15e14e0a3a4e68e 100644 (file)
@@ -273,23 +273,19 @@ PciSegmentOr8 (
 }\r
 \r
 /**\r
-  Performs a bitwise AND of an 8-bit PCI configuration register with an 8-bit\r
-  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, and\r
-  writes the result to the 8-bit PCI configuration register specified by\r
-  Address. The value written to the PCI configuration register is returned.\r
-  This function must guarantee that all PCI read and write operations are\r
-  serialized.\r
+  Performs a bitwise AND of an 8-bit PCI configuration register with an 8-bit value.\r
 \r
+  Reads the 8-bit PCI configuration register specified by Address,\r
+  performs a bitwise AND between the read result and the value specified by AndData,\r
+  and writes the result to the 8-bit PCI configuration register specified by Address.\r
+  The value written to the PCI configuration register is returned.\r
+  This function must guarantee that all PCI read and write operations are serialized.\r
   If any reserved bits in Address are set, then ASSERT().\r
 \r
-  @param  Address Address that encodes the PCI Segment, Bus, Device, Function and\r
-                  Register.\r
-  @param  AndData The value to AND with the PCI configuration register.\r
+  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
+  @param  AndData   The value to AND with the PCI configuration register.\r
 \r
-  @return The value written back to the PCI configuration register.\r
+  @return The value written to the PCI configuration register.\r
 \r
 **/\r
 UINT8\r
@@ -303,25 +299,23 @@ PciSegmentAnd8 (
 }\r
 \r
 /**\r
-  Performs a bitwise AND of an 8-bit PCI configuration register with an 8-bit\r
-  value, followed a  bitwise inclusive 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
-  performs a bitwise inclusive OR between the result of the AND operation and\r
-  the value specified by OrData, and writes the result to the 8-bit PCI\r
-  configuration register specified by Address. The value written to the PCI\r
-  configuration register is returned. This function must guarantee that all PCI\r
-  read and write operations are serialized.\r
-\r
+  Performs a bitwise AND of an 8-bit PCI configuration register with an 8-bit value,\r
+  followed a  bitwise inclusive OR with another 8-bit value.\r
+  \r
+  Reads the 8-bit PCI configuration register specified by Address,\r
+  performs a bitwise AND between the read result and the value specified by AndData,\r
+  performs a bitwise inclusive OR between the result of the AND operation and the value specified by OrData,\r
+  and writes the result to the 8-bit PCI configuration register specified by Address.\r
+  The value written to the PCI configuration register is returned.\r
+  This function must guarantee that all PCI read and write operations are serialized.\r
+  \r
   If any reserved bits in Address are set, then ASSERT().\r
 \r
-  @param  Address Address that encodes the PCI Segment, Bus, Device, Function and\r
-                  Register.\r
-  @param  AndData The value to AND with the PCI configuration register.\r
-  @param  OrData  The value to OR with the result of the AND operation.\r
+  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
+  @param  AndData    The value to AND with the PCI configuration register.\r
+  @param  OrData    The value to OR with the PCI configuration register.\r
 \r
-  @return The value written back to the PCI configuration register.\r
+  @return The value written to the PCI configuration register.\r
 \r
 **/\r
 UINT8\r
@@ -617,23 +611,21 @@ PciSegmentOr16 (
 }\r
 \r
 /**\r
-  Performs a bitwise AND of a 16-bit PCI configuration register with a 16-bit\r
-  value.\r
-\r
-  Reads the 16-bit PCI configuration register specified by Address, performs a\r
-  bitwise AND between the read result and the value specified by AndData, and\r
-  writes the result to the 16-bit PCI configuration register specified by\r
-  Address. The value written to the PCI configuration register is returned.\r
-  This function must guarantee that all PCI read and write operations are\r
-  serialized.\r
+  Performs a bitwise AND of a 16-bit PCI configuration register with a 16-bit value.\r
 \r
+  Reads the 16-bit PCI configuration register specified by Address,\r
+  performs a bitwise AND between the read result and the value specified by AndData,\r
+  and writes the result to the 16-bit PCI configuration register specified by Address.\r
+  The value written to the PCI configuration register is returned.\r
+  This function must guarantee that all PCI read and write operations are serialized.\r
+  \r
   If any reserved bits in Address are set, then ASSERT().\r
+  If Address is not aligned on a 16-bit boundary, then ASSERT().\r
+  \r
+  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
+  @param  AndData   The value to AND with the PCI configuration register.\r
 \r
-  @param  Address Address that encodes the PCI Segment, Bus, Device, Function and\r
-                  Register.\r
-  @param  AndData The value to AND with the PCI configuration register.\r
-\r
-  @return The value written back to the PCI configuration register.\r
+  @return The value written to the PCI configuration register.\r
 \r
 **/\r
 UINT16\r
@@ -961,23 +953,21 @@ PciSegmentOr32 (
 }\r
 \r
 /**\r
-  Performs a bitwise AND of a 32-bit PCI configuration register with a 32-bit\r
-  value.\r
-\r
-  Reads the 32-bit PCI configuration register specified by Address, performs a\r
-  bitwise AND between the read result and the value specified by AndData, and\r
-  writes the result to the 32-bit PCI configuration register specified by\r
-  Address. The value written to the PCI configuration register is returned.\r
-  This function must guarantee that all PCI read and write operations are\r
-  serialized.\r
+  Performs a bitwise AND of a 32-bit PCI configuration register with a 32-bit value.\r
 \r
+  Reads the 32-bit PCI configuration register specified by Address,\r
+  performs a bitwise AND between the read result and the value specified by AndData,\r
+  and writes the result to the 32-bit PCI configuration register specified by Address.\r
+  The value written to the PCI configuration register is returned.\r
+  This function must guarantee that all PCI read and write operations are serialized.\r
+  \r
   If any reserved bits in Address are set, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
-  @param  Address Address that encodes the PCI Segment, Bus, Device, Function and\r
-                  Register.\r
-  @param  AndData The value to AND with the PCI configuration register.\r
+  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
+  @param  AndData   The value to AND with the PCI configuration register.\r
 \r
-  @return The value written back to the PCI configuration register.\r
+  @return The value written to the PCI configuration register.\r
 \r
 **/\r
 UINT32\r
@@ -991,25 +981,24 @@ PciSegmentAnd32 (
 }\r
 \r
 /**\r
-  Performs a bitwise AND of a 32-bit PCI configuration register with a 32-bit\r
-  value, followed a  bitwise inclusive OR with another 32-bit value.\r
-\r
-  Reads the 32-bit PCI configuration register specified by Address, performs a\r
-  bitwise AND between the read result and the value specified by AndData,\r
-  performs a bitwise inclusive OR between the result of the AND operation and\r
-  the value specified by OrData, and writes the result to the 32-bit PCI\r
-  configuration register specified by Address. The value written to the PCI\r
-  configuration register is returned. This function must guarantee that all PCI\r
-  read and write operations are serialized.\r
-\r
+  Performs a bitwise AND of a 32-bit PCI configuration register with a 32-bit value,\r
+  followed a  bitwise inclusive OR with another 32-bit value.\r
+  \r
+  Reads the 32-bit PCI configuration register specified by Address,\r
+  performs a bitwise AND between the read result and the value specified by AndData,\r
+  performs a bitwise inclusive OR between the result of the AND operation and the value specified by OrData,\r
+  and writes the result to the 32-bit PCI configuration register specified by Address.\r
+  The value written to the PCI configuration register is returned.\r
+  This function must guarantee that all PCI read and write operations are serialized.\r
+  \r
   If any reserved bits in Address are set, then ASSERT().\r
+  If Address is not aligned on a 32-bit boundary, then ASSERT().\r
 \r
-  @param  Address Address that encodes the PCI Segment, Bus, Device, Function and\r
-                  Register.\r
-  @param  AndData The value to AND with the PCI configuration register.\r
-  @param  OrData  The value to OR with the result of the AND operation.\r
+  @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
+  @param  AndData   The value to AND with the PCI configuration register.\r
+  @param  OrData    The value to OR with the PCI configuration register.\r
 \r
-  @return The value written back to the PCI configuration register.\r
+  @return The value written to the PCI configuration register.\r
 \r
 **/\r
 UINT32\r
index 175c2e9402e01c0d459b86cfef833e67fdb8b604..68e4f6acec40355a6aa3bcc5843d03d6066dc51c 100644 (file)
@@ -23,7 +23,6 @@
 \r
 \r
 /**\r
-  \r
   Declares the presence of permanent system memory in the platform.\r
 \r
   Declares that the system memory buffer specified by MemoryBegin and MemoryLength\r
index a2ce52dcd24de3752fea5b42b0bee42027bd9327..93495f04b8e9813978faa2df266a6ed51eba8c61 100644 (file)
@@ -282,7 +282,7 @@ PeiServicesFfsFindNextFile (
   This service enables PEIMs to discover sections of a given type within a valid FFS file.\r
 \r
   @param  SectionType           The value of the section type to find.\r
-  @param  FfsFileHeader         A pointer to the file header that contains the set of sections to\r
+  @param  FileHandle            A pointer to the file header that contains the set of sections to\r
                                 be searched.\r
   @param  SectionData           A pointer to the discovered section, if successful.\r
 \r
@@ -294,14 +294,14 @@ EFI_STATUS
 EFIAPI\r
 PeiServicesFfsFindSectionData (\r
   IN EFI_SECTION_TYPE           SectionType,\r
-  IN EFI_PEI_FILE_HANDLE        FfsFileHeader,\r
+  IN EFI_PEI_FILE_HANDLE        FileHandle,\r
   OUT VOID                      **SectionData\r
   )\r
 {\r
   CONST EFI_PEI_SERVICES **PeiServices;\r
 \r
   PeiServices = GetPeiServicesTablePointer ();\r
-  return (*PeiServices)->FfsFindSectionData (PeiServices, SectionType, FfsFileHeader, SectionData);\r
+  return (*PeiServices)->FfsFindSectionData (PeiServices, SectionType, FileHandle, SectionData);\r
 }\r
 \r
 /**\r
@@ -384,8 +384,6 @@ PeiServicesAllocatePool (
 /**\r
   Resets the entire platform.\r
 \r
-  @param  VOID\r
-\r
   @retval EFI_SUCCESS           The function completed successfully.\r
   @retval EFI_NOT_AVAILABLE_YET The service has not been installed yet.\r
 \r