Commit Graph

119 Commits

Author SHA1 Message Date
eric_tian 33d228aa02 refine some definitions comments.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9031 6f19259b-4bc3-4df7-8a09-765794883524
2009-08-10 06:32:30 +00:00
vanjeff d9fdf2ca96 fixed wrong comments format.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9019 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-28 14:24:26 +00:00
pkandel 5259c97d7a Committing changes to the comments, after review with engineers.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9018 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-28 13:25:37 +00:00
mdkinney d5555a107c Move EFI_SMM_COMMUNICATE_HEADER into SmmBase.h because this structure is really associated with the ComminicationBuffer parameter to the EFI_SMM_CALLBACK_ENTRY_POINT in the SMM Base Protocol and not the gSmmCommunicateHeaderGuid. This GUID is just one of many possible GUIDs that could be used to fill in the HeaderGuid field of the EFI_SMM_COMMUNICATE_HEADER.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8990 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-24 04:35:02 +00:00
mdkinney 347bbfc6ed Remove the following Protocols from the IntelFrameworkPkg because they are identical to Protocols from the PI 1.2 Specification that have been added to the MdePkg
1) IDE Controller Init
2) Incompatible PCI Device Support
3) PCI Hot Bridge Resource Allocation
4) PCI Hot Plug
5) PCI Platform


git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8941 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-14 19:34:24 +00:00
klu2 a543bca5a6 Fix a wrong doxygen comment tag usage of ///>. The correct one is ///<.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8933 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-13 13:06:59 +00:00
lgao4 33801c0c8e Make code definition alignment.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8925 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-13 09:35:40 +00:00
lgao4 108854b2b8 Remove unnecessary FRAMEWORK_ prefix in IntelFrameworkPkg definitions for those definitions that don't conflict with ones in UEFI/PI specification.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8923 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-13 09:28:00 +00:00
vanjeff 21d2b17f98 updated parameters name to match spec.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8920 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-13 05:53:48 +00:00
mdkinney b6d47a83ac Add Framework MP Services Protocol
Change EFI_AP_PROCEDURE to FRAMEWORK_EFI_AP_PROCEDURE to remove name collision with PI 1.2 MP Services Protocol in MdePkg


git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8912 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-13 00:18:41 +00:00
mdkinney 050b79ebb0 Clean up doxygen comments
Remove *_GRANULARITY #defines that are not defined in the Framework CSM Specification


git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8911 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-13 00:16:54 +00:00
mdkinney 87d6344732 1) Add Include/Framework/BootScript.h that contains defines shared between Boot Script Executer PPI and Boot Script Save Protocol. Remove those safe defines from Include/Ppi/BootScriptExecuter.h
2) Remove Include/Framework/DataHubRecords.h and merge its content into Include/Guid/DataHubRecords.h
3) Remove Include/Framework/Legacy16.h and merge its contents into Include/Protocol/LegacyBios.h
4) Update FrameworkDxe.h to no longer include all the Legacy16.h and DataHubRecords.h contents.  This reduces the number of include file and definitions pulled in when a module include FrameworkDxe.h.  The Legacy16.h contents can now be included by a module through Protocol/LegacyBios.h and the DataHubRecords.h contents can be included by a module through Guid/DataHubRecords.h
5) Update Include/Guid/StatusCodeDataTypeId.h so it can be safely included by both PEIMs and DXE Modules since both the PEI and DXE phases support status codes
6) Remove extra #includes where possible to reduce number of files included during a build.
7) Update Include/Protocol/LegacyBiosPlatform.h to #include Include/Protocol/LegacyBios.h since it depends on HDD_INFO and COMPATIBILITY16 strictures carried by LegacyBios.h



git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8899 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-11 23:25:44 +00:00
mdkinney 3a228b9ed5 Remove "Module Name:" from include file headers.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8893 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-11 16:02:13 +00:00
mdkinney e7be5d903a Fix Doxygen document generation for function prototypes
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8892 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-10 23:56:39 +00:00
lgao4 0e0eeecad4 Clean the public header files to remove the unnecessary include files.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8871 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-10 09:30:53 +00:00
rsun3 06a098c478 Code clean up to match with Framework HII 0.92 spec. Add comments for mismatches between code and spec.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8864 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-10 07:59:23 +00:00
mdkinney 2997220ab7 Remove structure declaration for EFI_UGA_PIXEL.
This structure is already defined in MdePkg/Include/Protocol/UgaDraw.h and this extra declaration is generating build breaks for a redefinition


git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8847 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-09 23:26:39 +00:00
jchen20 6d1824fc6e Add comments to describe the difference between code and spec to fix the bug #202430
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8839 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-09 10:27:43 +00:00
jchen20 e89985504d Add comments to describe the difference between code and spec to fix the bug #202409
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8838 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-09 09:56:42 +00:00
jchen20 b59768ca63 Add definition on SmmStatusCodeProtocol to comply the SMMCIS spec to fix the bug #202466
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8834 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-09 09:17:18 +00:00
jchen20 da879e3f7d Add comments to describe the difference with Spec to fix the bug #202466
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8833 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-09 09:13:30 +00:00
jchen20 220c61c1ee Add the FRAMEWORK_EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL definition to comply with Framework spec
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8831 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-09 07:43:00 +00:00
jchen20 66ea28dffd to describe the gap between Framework spec and code to fix the bug #202434
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8820 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-08 09:49:07 +00:00
lgao4 3f17e6d73e Add comments for the inconsistent definition with framework specification.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8798 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-08 03:41:46 +00:00
xli24 99caac3b19 Add [in], [out] tag for function description.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8792 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-08 03:05:55 +00:00
vanjeff 574bb8b749 Add IncompatiblePciDeviceSupportDxe module in IntelFrameworkModulePkg.
This module provided one typical incompatible PCI device list to be one template and install EFI incompatible PCI device support protocol.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8783 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-07 07:09:31 +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 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
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
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 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
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
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
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
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