Commit Graph

706 Commits

Author SHA1 Message Date
lgao4 1bf793701b Add comments for enumeration, structure data members those are referred by UefiService, Runtime Service, Dxe Service and Pei Service.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6974 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-10 08:22:03 +00:00
gikidy 2281e7a9c3 Synchronize the h files with c files.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6967 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-10 06:13:43 +00:00
vanjeff 190f29c01b added comment for some structure
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6965 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-10 05:07:52 +00:00
lgao4 27a57d4735 Move common smbus structure from Smbus PPI to Industry Standard Smbus.h shared between Smbus PPI and Protocol
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6937 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-09 14:35:34 +00:00
lgao4 992f22b99a Add the detailed descriptions for the structure data member in these protocol.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6935 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-09 14:04:41 +00:00
lgao4 d0a915a5ad Add EFI_NETWORK_INTERFACE_TYPE definition
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6934 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-09 09:33:47 +00:00
vanjeff 3609613ee9 remove unnecessary detailed description for InvalidateInstructionCache(), since no more additional information than the brief description.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6933 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-09 08:59:48 +00:00
lgao4 2a53dabf62 Correct minor comments
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6932 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-09 08:22:53 +00:00
gikidy 2fe241a290 Synchronize comment of BaseLib.h and it's implementation to match the Spec.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6929 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-09 07:02:26 +00:00
vanjeff 1833218d93 1. added functions header for MACROS in PCI22.h.
2. move IS_PCI_GFX to modules, since it not defined in PCI spec.
3. added comments for some structure in ElTorito.h.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6928 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-09 06:40:02 +00:00
lgao4 9319d2c206 Add comments for most of enum data type.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6924 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-08 14:48:27 +00:00
klu2 db5d3dbd76 Fix a typo
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6923 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-08 12:13:16 +00:00
vanjeff cc078d72a6 added comments for some structures and apply for doxgen format
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6919 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-08 07:40:58 +00:00
klu2 f7e994abcc Fix a type for undeclared word
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6918 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-08 07:38:56 +00:00
vanjeff bf7ea00943 added comments for some structures and apply for doxgen format
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6917 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-08 06:59:18 +00:00
lgao4 25cfda03f6 Remove undefined comments for status PCD.
Add comments for DebugImageInfoTable, FileInfo, FileSystemInfo and FileSystemVolumeLabelInfo Guid structure.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6914 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-08 03:24:04 +00:00
lgao4 527079789c correct 0X to 0x
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6912 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-08 01:44:52 +00:00
lgao4 c3d4e543f0 Correct the unknown character and update ChangeLog.txt
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6911 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-08 01:42:01 +00:00
mdkinney daa6553a39 Use BIT8-1 insetad of UINT8_MAX
Fix a typo in a comment


git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6910 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-07 23:59:51 +00:00
mdkinney f4ec40abd6 Add more detailed comments for many of the Base Types
Remove all declarations of UINT8_MAX.  Use BIT8-1 instead.


git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6909 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-07 23:10:08 +00:00
mdkinney 2a3f6a21d3 1) Add descriptions for the enum values or struc members for the following types:
EFI_ALLOCATION_TYPE
  EFI_MEKORY_DESCRITOR
  EFI_TIMER_DEALY
  EFI_RESET_TYPE
  EFI_INTERFACE_TYPE
  EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
  EFI_LOCATE_SEARCH_TYPE
  EFI_CAPSULE_BLOCK_DESCRIPTOR
  EFI_CAPSULE_HEADER

2) Rearrange some content to eliminate the need for the forward declaration of EFI_SYSTEM_TABLE
3) Update signature declarations to use EFI_SIGNATURE_64().
4) Move macro NEXT_MEMORY_DESCRITOR() from this file to the UEFI Library.  It is not part of the UEFI Specification.
5) Fix hot key related type names to match the UEFI Specification


git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6908 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-07 23:08:08 +00:00
mdkinney 6617fcc2e8 Add descriptions of EFI_PHYSICAL_ADDRESS and EFI_VIRTUAL_ADDRESS
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6907 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-07 23:01:34 +00:00
mdkinney 97c4afffcb Add descriptions for each of the width values in the enumeration
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6906 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-07 23:00:13 +00:00
mdkinney f1409bb2ea Make sure the #define for a subtype and the device path node for a subtype each have their own comment block.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6905 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-07 22:59:27 +00:00
mdkinney d1c810fcb5 Update SAL_PROC declaration to following coding standard. There should be no spaces between ')' and '(' for function typedefs.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6904 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-07 22:57:13 +00:00
mdkinney b7ca87839d Add full description of the Format string to the file header of the Print Library
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6903 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-07 22:56:33 +00:00
mdkinney 9bfdfa522d Move NEXT_MEMORY_DESCRIPTOR() from UefiSpec.h to UEFI Library
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6902 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-07 22:55:55 +00:00
mdkinney c0edac24d5 Remove unused declarations from the UEFI Runtime Library for:
extern const EFI_EVENT_NOTIFY _gDriverExitBootServicesEvent[];
  extern const EFI_EVENT_NOTIFY _gDriverSetVirtualAddressMapEvent[];



git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6901 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-07 22:55:17 +00:00
mdkinney a5c1c592c4 Update PE_COFF_LOADER_READ_FILE declaration to following coding standard. There should be no spaces between ')' and '(' for function typedefs.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6900 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-07 22:53:34 +00:00
mdkinney d75f9fc227 Add macro comments for SWITCH_STACK_ENTRY_POINT
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6899 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-07 22:52:30 +00:00
ywu21 2a2df9bec9 git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6890 6f19259b-4bc3-4df7-8a09-765794883524 2008-12-06 03:54:53 +00:00
mdkinney 22ce9dc5b9 Change _CR() to BASE_CR() to follow naming convention
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6886 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-06 01:19:56 +00:00
mdkinney 9a1d00cbb5 Update FUNCTION_ENTRY_POINT() to be compatible with a wider variety of input parameters.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6883 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-05 23:23:59 +00:00
gikidy 62991af27f Make comments match the Spec.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6876 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-05 09:50:02 +00:00
jji4 2297186d22 Comments have been checked with spec
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6873 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-05 09:25:16 +00:00
jji4 0c95b03bcd Code has been reviewed with spec
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6870 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-05 08:58:10 +00:00
jji4 5720947029 Comments have been checked with spec
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6868 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-05 08:21:57 +00:00
jji4 98db57b0ae Function name corrected
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6866 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-05 07:44:12 +00:00
gikidy 4d24730c55 Modified the #defines for BIT32..BIT63 to match the Spec.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6865 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-05 07:43:51 +00:00
gikidy d11195a3ea Update the comment for RegisterForRunimeAccess() functions to match the Spec.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6862 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-05 07:07:50 +00:00
gikidy 6cf18cdd9b Synchronized Macro definition of GET_GUID_HOB_DATA_SIZE, GET_GUID_HOB_DATA, END_OF_HOB_LIST, GET_NEXT_HOB, GET_HOB_LENGTH, GET_HOB_TYPE with Spec.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6861 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-05 06:35:33 +00:00
gikidy cc4aa4644e Synchronized Macro definition of GET_GUID_HOB_DATA_SIZE, GET_GUID_HOB_DATA, END_OF_HOB_LIST, GET_NEXT_HOB, GET_HOB_LENGTH, GET_HOB_TYPE with Spec.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6860 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-05 06:33:55 +00:00
ywu21 6b005af911 add [in] [out] in comment
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6859 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-05 05:50:37 +00:00
ywu21 0a015b7d06 update (EFIAPI *EFI_IMAGE_ENTRY_POINT) comment
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6855 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-05 04:37:01 +00:00
qhuang8 030cd1a2e9 Update the text to use "x64" instead of "X64" in MdePkg.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6854 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-05 03:23:13 +00:00
gikidy 3963c4bf44 Add comments for the MACRO follow the Spec, and change some definition not match the Spec.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6852 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-05 02:28:51 +00:00
lgao4 7ca066f99b Remove todo comment in BaseLib.h
Update DxeServicesLib return status align to MdeLib spec.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6849 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-04 14:00:52 +00:00
lgao4 14996c9669 Correct Minor Comments in M3 to M4 review.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6842 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-04 08:35:07 +00:00
jji4 9ccbe812c5 Function comments have been checked with spec.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6840 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-04 07:15:13 +00:00
gikidy cc39b88baa Change function IpfFlushCacheRange() to AsmFlushCacheRange() follow the Mde_Lib_Spec 0.61k
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6834 6f19259b-4bc3-4df7-8a09-765794883524
2008-12-04 06:52:09 +00:00