Commit Graph

384 Commits

Author SHA1 Message Date
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
eric_tian ef73b4a854 add comment on mismatch between code and MiscSubclass spec.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9013 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-27 05:48:29 +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 7f58645482 Move those status code definitions that exactly match the PI 1.2 Specification from the IntelFrameworkPkg to MdePkg
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8989 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-24 03:27:05 +00:00
eric_tian 409669d53e comments refine
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8978 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-22 04:55:02 +00:00
eric_tian bc34515d50 improve the doxgen style comments.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8965 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-17 09:43:55 +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 c9a4a97748 Remove the following PPIs from the IntelFrameworkPkg because they were identical to PPIs from the PI 1.2 Specification
1) Block I/O PPI 
2) Device Recovery PPI 
3) Recovery Module PPI 
4) S3 Resume PPI 

Also add Include/Guid/BlockIo.h that contains two hardware device specific GUIDs for recovery devices that are only defined in the Framework Specifications



git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8915 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-13 05:01: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 ccd1862c8b Fix Doxygen comment syntax
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8909 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-13 00:09:04 +00:00
mdkinney fa712ebc56 Add "FRAMEWORK_" to remove name collision with Security2 PPI in MdePkg
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8908 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-12 23:50:04 +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 ede15247fc Make CR/LF consistent in source file
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8894 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-11 16:03: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
darylm503 22be261ccf Document the macro definitions for Variable Attributes.
Clean up some sentence syntax.
Add direction tags to @param directives to match the declaration being commented.


git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8890 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-10 22:09:04 +00:00
darylm503 d29e6bb638 Adjust syntax of comment contents.
Document members of the Device Recovery Module PPI.


git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8889 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-10 22:00:05 +00:00
darylm503 ab6fc27acd Add Doxygen comment block to SMRAM state macro definitions.
Clean up comment for the EFI_SMRAM_HOB_DESCRIPTOR_BLOCK structure type to combine the orphan comment about the specification inconsistency with the comment for the type.


git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8888 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-10 21:55:33 +00:00
eric_tian afb84e4247 restore @par Revision Reference.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8884 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-10 12:40:31 +00:00
eric_tian 55c1c87cba restore @par Revision Reference.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8883 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-10 12:17:41 +00:00
eric_tian 7611ea1143 fix build issue
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8882 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-10 10:25:44 +00:00
eric_tian 6115bccfc3 roll back the change on the naming of DataHubRecords.h for backward compatibility.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8881 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-10 10:20:57 +00:00
jchen20 1db0e83a24 To keep the code not change as original for compatible purpose. GetNextVariable --> PeiGetVariable. SetVariable--> PeiSetVariable
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8880 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-10 10:19:26 +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
klu2 64419615f2 1, Add @par section in file header comment
2, Rollback the member name changing in last modification to keep backward compatible. Although add more comment to declaration the these inconsistent issue.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8867 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-10 08:07:23 +00:00
jchen20 c031fd2369 Add comments to describe the difference between code and spec and move the processor invalid reason macro to StatusCode.h from CPU pkg to fix the bug #202469
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8865 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-10 08:05:50 +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
xli24 d405baa0b6 Refine comments.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8858 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-10 03:53:02 +00:00
xli24 3ae0837720 Refine comments.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8857 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-10 03:41:20 +00:00
xli24 a5baf84537 Keep inconsistency in code and add additional comments for that.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8856 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-10 03:28:16 +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 18d7ae2ee6 describe the difference with Spec to fix the bug #202465
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8837 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-09 09:41:35 +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
xli24 56fd2fa44c Refine the comments to describe inconsistency between code and spec.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8830 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-09 07:22:06 +00:00
vanjeff 2a924b007f updated comments per review comments.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8827 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-09 03:03:32 +00:00
jchen20 a69dbb0e9e the Comment the gap between Framework spec and code in the definition of FRAMEWORK_EFI_PEI_SERVICES
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8826 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-09 02:19:02 +00:00
eric_tian 13b3137440 according to DataHubSubclass spec, all fields of data record should be naturally alignment.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8821 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-08 09:56:07 +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
jchen20 40038403ea to fill the gap between Framework and code to fix the bug #202405, #202419, #202418, #202435,#202437, #202439, #202440
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8817 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-08 09:38:08 +00:00
eric_tian 631344e6d3 refine the DataHubRecords.h to comply with DataHubSubclass/MemSubclass/ProcSubclass/CacheSubclass spec.
add comments to notify there are gaps between code and specs.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8808 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-08 07:17:48 +00:00
jchen20 fdf3ad8135 Add comments to indicate the gap with Framework Spec
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8807 6f19259b-4bc3-4df7-8a09-765794883524
2009-07-08 07:08:53 +00:00