Commit Graph

194 Commits

Author SHA1 Message Date
eric_tian 7c6b044003 1. cleanup to refine the doxgen comment.
2. remove unused macro EFI_VARIABLE_READ_ONLY, which is not define by PeiCIS spec.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8782 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-07 07:04:59 +00:00
eric_tian cb8df8c596 supply comments on data structure to follow spec.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8779 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-07 06:36:42 +00:00
eric_tian 7bfed576b0 Due to SmBios2.6 spec section 3.3.8.5 doesn't enumerate 24-way set-associative for cache info, so remove this value to follow spec.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8772 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-07 03:35:59 +00:00
klu2 ef1ac01521 Refine comments.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8765 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-07 02:15:40 +00:00
xli24 444bf90deb Refine include file of GUID HOB for SMRAM memory reserve, according to review comments.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8763 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-06 15:09:45 +00:00
xli24 918294597a Refine include file for Device Recovery Module PPI.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8758 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-06 06:06:15 +00:00
xli24 ebcfa88032 Refine include file for SMM Base Protocol.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8756 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-06 04:02:37 +00:00
jchen20 18998e40a5 Fixed bug 202575. mainly follow Doxygen rule
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8755 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-06 03:33:08 +00:00
xli24 c7d5f35f1f Add space for alignment.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8754 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-06 03:27:59 +00:00
vanjeff 516e9f2863 updated function headers.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8753 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-06 03:15:53 +00:00
xli24 e5fe626f52 Add tag of in/out for @param comments in function header.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8751 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-06 03:00:59 +00:00
vanjeff 8ba0729797 add detailed description for functions.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8748 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-06 02:22:21 +00:00
darylm503 fab84ef535 Clean up formatting and some Doxygen comments.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8746 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-03 23:40:55 +00:00
darylm503 dbb698cbb5 Clean up Doxygen group comments.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8745 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-03 23:20:37 +00:00
darylm503 03df16089f Clean up Doxygen commenting.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8743 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-03 21:59:06 +00:00
mdkinney 2cec3ea527 Change FRAMEWORK_EFI_HII_CALLBACK_PACKET back to EFI_HII_CALLBACK_PACKET to match Framework HII 0.92 Specification
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8741 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-03 20:14:12 +00:00
vanjeff e02a0e9245 remove stranger characters.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8737 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-03 11:30:19 +00:00
klu2 8d303ef304 Synchronize the structure's member's name and comments for structure modified in CSM 0.97 specification.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8735 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-03 07:36:43 +00:00
vanjeff 9ca1b12e00 added comments per framework spec.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8734 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-03 06:46:14 +00:00
klu2 e3e7f36a58 1, Synchronize CSM related structure definition's comments with Intel framework specification.
2, To following specification, correct following member's name:
   a) change the member name of EFI_COMPATIBILITY16_TABLE.OemintSegement to EFI_COMPATIBILITY16_TABLE.OemInt15Segment. 
   b) change the member name of EFI_COMPATIBILITY16_TABLE.OemIntOffset to EFI_COMPATIBILITY16_TABLE. OemInt15Offset. 
   c) change the member name of EFI_DISPATCH_OPROM_TABLE. BbsTablePointer to EFI_DISPATCH_OPROM_TABLE. BbsTable.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8733 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-03 06:25:35 +00:00
rsun3 61c244aa10 Change naming of bit value definitions of AuthenticationStatus for Section Extraction PPI to match PEI CIS spec. Also do some coding style clean up.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8731 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-03 02:42:12 +00:00
rsun3 2baf6c6837 PeiCis.h clean up.
1. Add Doxygen comments for FRAMEWORK_EFI_PEI_SERVICES;
2. Remove definition of EFI_PEI_STARTUP_DESCRIPTOR. It is not defined in the PEI CIS spec and is implementation specific.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8730 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-03 01:33:47 +00:00
klu2 2e747cee12 Correct the enumeration value's name for EFI_COMPATIBILITY_FUNCTIONS with Intel Framework specification.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8727 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-02 18:46:07 +00:00
lgao4 aa4a31e348 Update code comments according to intel framework specification.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8724 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-02 08:52:18 +00:00
rsun3 e1d8d892f2 DxeCis.h clean up.
1. Add comments
2. TIANO_DEVICE_PATH and TIANO_MEDIA_FW_VOL_FILEPATH_DEVICE_PATH_TYPE structures removed. They are not in DXE CIS spec.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8723 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-02 08:18:29 +00:00
klu2 2bbaeb0d62 Correct the structure's comments to follow doxygen format.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8721 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-02 07:40:24 +00:00
xli24 d97286f4b3 Refine SMM USB Dispatch Protocol definition.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8720 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-02 07:16:44 +00:00
rsun3 badb54ab92 code clean up for Security.h.
1. Incorrect comment style preceding _EFI_PEI_SECURITY_PPI.  The comments in the file have the format used to describe a function, and should have the format for a structure.
2.  Latest PEI CIS (0.91) indicates the param should be:
IN OUT BOOLEAN     *DeferExecution
whereas in the H file it's:
IN OUT BOOLEAN     *StartCrisisRecovery


git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8719 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-02 05:58:27 +00:00
xli24 c715423427 Refine CPU I/O Protocol definition.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8718 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-02 05:27:47 +00:00
xli24 358e78ed4c Correct element description of EFI_SMM_PERIODIC_TIMER_DISPATCH_CONTEXT.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8717 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-02 03:33:49 +00:00
gikidy c41da1c6a6 Remove the unknown characters.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8716 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-02 02:41:14 +00:00
lgao4 55db3d4442 Remove the unknown characters.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8715 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-02 02:35:04 +00:00
lgao4 f0d6194dfa Add the missing LEGACY_USED definition.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8714 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-02 02:31:56 +00:00
jljusten ac9868ecb8 Update comments for coding style.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8711 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-02 00:47:58 +00:00
lgr 412fb9ef2d tabs were set incorrectly in previous check in
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8709 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-01 21:35:11 +00:00
jljusten b4420c3607 Change single quote to use standard ascii character.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8708 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-01 18:18:10 +00:00
lgr 04dd6cc01a Per code review, Update Doxygen comments - add the missing info from spec with the description,
params and retvals that vary for each value in the mode enums.  
Correct some func parameter modifiers and retvals

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8706 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-01 16:03:32 +00:00
lgr ef775b0f1d Per code review, Update Doxygen comments - add /// comments to protocol struct
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8705 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-01 15:59:08 +00:00
lgr 053d977438 Per code review, Update Doxygen comments - add /// comments from spec to data and protocol struct.
Add some missing retval's to func comments

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8704 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-01 15:57:13 +00:00
lgr c3b35b6099 Per code review, Update Doxygen comments - restore reference to framework spec in header, add /// comments from spec to data and protocol structs
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8703 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-01 15:55:08 +00:00
darylm503 5ba364466d Update Copyright. Delete erroneous "Module Name" line.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8673 6f19259b-4bc3-4df7-8a09-765794883524
2009-06-26 19:44:34 +00:00
darylm503 8d129536f9 Updated copyright. Deleted erroneous "Module Name" line. Changed preceding macro, enum, and structure comments to Doxygen style. Changed existing structure member comments to Doxygen style. Cleaned up some comment blocks to conform to the coding specification. Changed @bug comments on structure members to the postfix style so that the correct members are documented. Removed duplicate, orphan, EFI_TO_COMPATIBILITY16_BOOT_TABLE comment and move remaining comment to the correct location. Add descriptive comment to terminating #endif.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8672 6f19259b-4bc3-4df7-8a09-765794883524
2009-06-26 19:36:51 +00:00
darylm503 c7ab4e83a6 Changed Copyright to 2006-2009 to reflect original through current revisions. Deleted the Module Name line. Changed "Firmware Volume Block Attributes" comments to Doxygen Style and grouped the #defines together under that comment. EFI_FVB_CAPABILITIES macro Values were not aligned. Alignment made it unclear whether this was a simple or parameterized macro. Enhanced comments to make this clear. Re-aligned the EFI_TEST_FFS_ATTRIBUTES_BIT macro to make it easier to read. Added an identifying comment to the terminating #endif.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8671 6f19259b-4bc3-4df7-8a09-765794883524
2009-06-26 19:09:39 +00:00
gikidy a244f400e5 Verified some definitions of DataHubRecord.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8666 6f19259b-4bc3-4df7-8a09-765794883524
2009-06-26 06:16:33 +00:00
klu2 736e104fa3 Refine the comments for IntelFrameworkPkg/Include/Protocol/DataHub.h
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8639 6f19259b-4bc3-4df7-8a09-765794883524
2009-06-24 03:01:38 +00:00
klu2 4e97801cfa Update structure's comments to doxygen style.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8635 6f19259b-4bc3-4df7-8a09-765794883524
2009-06-24 02:18:54 +00:00
xli24 7698f336b7 Refine include file for PCI Platform Protocol, and update C source code accordingly.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8614 6f19259b-4bc3-4df7-8a09-765794883524
2009-06-19 09:35:07 +00:00
lgao4 8bcd1d7003 Retire FrameworkDevicePath header file. It is not defined in framework spec. And it is not used by EDKII modules.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8592 6f19259b-4bc3-4df7-8a09-765794883524
2009-06-18 05:21:54 +00:00
lgao4 920d2c23a1 Update header file comments.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8583 6f19259b-4bc3-4df7-8a09-765794883524
2009-06-17 08:46:49 +00:00
jcarsey f391357d3c git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8576 6f19259b-4bc3-4df7-8a09-765794883524 2009-06-16 13:16:06 +00:00