added comments for some structures and apply for doxgen format

[mirror_edk2.git] / MdePkg / Include / IndustryStandard / Sal.h

diff --git a/MdePkg/Include/IndustryStandard/Sal.h b/MdePkg/Include/IndustryStandard/Sal.h
index b792df6f6e453bb165a6eb1cf77716920e55c076..2199efe14c44fddc0fef4dfaea86a81adf0f3efa 100644 (file)
--- a/MdePkg/Include/IndustryStandard/Sal.h
+++ b/MdePkg/Include/IndustryStandard/Sal.h
@@ -87,7 +87,7 @@ typedef struct {
 /**\r
   Prototype of SAL procedures.\r
 \r
-  @param  Arg0               Functional identifier.\r
+  @param  FunctionId         Functional identifier.\r
                              The upper 32 bits are ignored and only the lower 32 bits\r
                              are used. The following functional identifiers are defined:\r
                              0x01XXXXXX - Architected SAL functional group.\r
@@ -111,15 +111,15 @@ typedef struct {
 **/\r
 typedef\r
 SAL_RETURN_REGS\r
-(EFIAPI *SAL_PROC) (\r
+(EFIAPI *SAL_PROC)(\r
   IN UINT64 FunctionId,\r
+  IN UINT64 Arg1,\r
   IN UINT64 Arg2,\r
   IN UINT64 Arg3,\r
   IN UINT64 Arg4,\r
   IN UINT64 Arg5,\r
   IN UINT64 Arg6,\r
-  IN UINT64 Arg7,\r
-  IN UINT64 Arg8\r
+  IN UINT64 Arg7\r
   );\r
 \r
 //\r
@@ -392,7 +392,6 @@ typedef struct {
   ///\r
   UINT8   Reserved2[8];\r
 } SAL_SYSTEM_TABLE_HEADER;\r
-#pragma pack()\r
 \r
 #define EFI_SAL_ST_HEADER_SIGNATURE "SST_"\r
 #define EFI_SAL_REVISION            0x0320\r
@@ -416,9 +415,8 @@ typedef struct {
 #define EFI_SAL_ST_PTC_SIZE                16\r
 #define EFI_SAL_ST_AP_WAKEUP_SIZE          16\r
 \r
-#pragma pack(1)\r
 ///\r
-/// Format Entrypoint Descriptor Entry\r
+/// Format of Entrypoint Descriptor Entry\r
 ///\r
 typedef struct {\r
   UINT8   Type;         ///< Type here should be 0\r
@@ -429,16 +427,15 @@ typedef struct {
   UINT64  Reserved2[2];\r
 } SAL_ST_ENTRY_POINT_DESCRIPTOR;\r
 \r
-#pragma pack(1)\r
 ///\r
-/// Format Platform Features Descriptor Entry\r
+/// Format of Platform Features Descriptor Entry\r
 ///\r
 typedef struct {\r
   UINT8 Type;           ///< Type here should be 2\r
   UINT8 PlatformFeatures;\r
   UINT8 Reserved[14];\r
 } SAL_ST_PLATFORM_FEATURES;\r
-#pragma pack()\r
+\r
 //\r
 // Value of Platform Feature List\r
 //\r
@@ -446,7 +443,6 @@ typedef struct {
 #define SAL_PLAT_FEAT_PLAT_IPI_HINT 0x02\r
 #define SAL_PLAT_FEAT_PROC_IPI_HINT 0x04\r
 \r
-#pragma pack(1)\r
 ///\r
 /// Format of Translation Register Descriptor Entry\r
 ///\r
@@ -459,14 +455,13 @@ typedef struct {
   UINT64  EncodedPageSize;\r
   UINT64  Reserved1;\r
 } SAL_ST_TR_DECRIPTOR;\r
-#pragma pack()\r
+\r
 //\r
 // Type of Translation Register\r
 //\r
 #define EFI_SAL_ST_TR_USAGE_INSTRUCTION 00\r
 #define EFI_SAL_ST_TR_USAGE_DATA        01\r
 \r
-#pragma pack(1)\r
 ///\r
 /// Definition of Coherence Domain Information\r
 ///\r
@@ -474,9 +469,7 @@ typedef struct {
   UINT64  NumberOfProcessors;\r
   UINT64  LocalIDRegister;\r
 } SAL_COHERENCE_DOMAIN_INFO;\r
-#pragma pack()\r
-\r
-#pragma pack(1)\r
+           \r
 ///\r
 /// Format of Purge Translation Cache Coherence Domain Entry\r
 ///\r
@@ -486,9 +479,7 @@ typedef struct {
   UINT32                    NumberOfDomains;\r
   SAL_COHERENCE_DOMAIN_INFO *DomainInformation;\r
 } SAL_ST_CACHE_COHERENCE_DECRIPTOR;\r
-#pragma pack()\r
 \r
-#pragma pack(1)\r
 ///\r
 /// Format of Application Processor Wake-Up Descriptor Entry\r
 ///\r
@@ -498,7 +489,6 @@ typedef struct {
   UINT8   Reserved[6];\r
   UINT64  ExternalInterruptVector;\r
 } SAL_ST_AP_WAKEUP_DECRIPTOR;\r
-#pragma pack()\r
 \r
 ///\r
 /// Format of Firmware Interface Table (FIT) Entry\r
@@ -739,10 +729,14 @@ typedef struct {
 #define PCI_BUS_OEM_ID_VALID_BIT_MASK           0x200\r
 #define PCI_BUS_OEM_DATA_STRUCT_VALID_BIT_MASK  0x400\r
 \r
+///\r
+/// Designated PCI Bus identifier\r
+///\r
 typedef struct {\r
   UINT8 BusNumber;\r
   UINT8 SegmentNumber;\r
 } PCI_BUS_ID;\r
+\r
 ///\r
 /// Definition of Platform PCI Bus Error Info Record\r
 ///\r