Refine function header comments of PalCallLib.h.
authorxli24 <xli24@de2fecce-e211-0410-80a6-f3fac2684e05>
Sun, 27 Jul 2008 11:46:08 +0000 (11:46 +0000)
committerxli24 <xli24@de2fecce-e211-0410-80a6-f3fac2684e05>
Sun, 27 Jul 2008 11:46:08 +0000 (11:46 +0000)
git-svn-id: https://edk2.tianocore.org/svn/edk2/trunk@5574 de2fecce-e211-0410-80a6-f3fac2684e05

edk2/MdePkg/Include/Library/PalCallLib.h

index aab6b8d..480c95d 100644 (file)
@@ -36,7 +36,6 @@
 #define PAL_CACHE_FLUSH_NO_INTERRUPT         0\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_CACHE_FLUSH.\r
 \r
   Flush the instruction or data caches. It is required by IPF.\r
 \r
   @param Index              Index of PAL_CACHE_FLUSH within the\r
                             list of PAL procedures.\r
-\r
   @param CacheType          Unsigned 64-bit integer indicating\r
                             which cache to flush.\r
-\r
   @param Operation          Formatted bit vector indicating the\r
                             operation of this call.\r
-\r
   @param ProgressIndicator  Unsigned 64-bit integer specifying\r
                             the starting position of the flush\r
                             operation.\r
 \r
-  @return R9      Unsigned 64-bit integer specifying the vector\r
-                  number of the pending interrupt.\r
-\r
-  @return R10     Unsigned 64-bit integer specifying the\r
-                  starting position of the flush operation.\r
-\r
-  @return R11     Unsigned 64-bit integer specifying the vector\r
-                  number of the pending interrupt.\r
-\r
-  @return Status  2 - Call completed without error, but a PMI\r
-                  was taken during the execution of this\r
-                  procedure.\r
-\r
-  @return Status  1 - Call has not completed flushing due to\r
-                  a pending interrupt.\r
+  @retval 2                 Call completed without error, but a PMI\r
+                            was taken during the execution of this\r
+                            procedure.\r
+  @retval 1                 Call has not completed flushing due to\r
+                            a pending interrupt.\r
+  @retval 0                 Call completed without error\r
+  @retval -2                Invalid argument\r
+  @retval -3                Call completed with error\r
 \r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error\r
+  @return R9                Unsigned 64-bit integer specifying the vector\r
+                            number of the pending interrupt.\r
+  @return R10               Unsigned 64-bit integer specifying the\r
+                            starting position of the flush operation.\r
+  @return R11               Unsigned 64-bit integer specifying the vector\r
+                            number of the pending interrupt.\r
 \r
 **/\r
 #define PAL_CACHE_FLUSH   1\r
@@ -135,7 +125,6 @@ typedef struct {
 } PAL_CACHE_INFO_RETURN2;\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_CACHE_INFO.\r
 \r
   Return detailed instruction or data cache information. It is\r
@@ -145,38 +134,29 @@ typedef struct {
 \r
   @param Index        Index of PAL_CACHE_INFO within the list of\r
                       PAL procedures.\r
-\r
   @param CacheLevel   Unsigned 64-bit integer specifying the\r
                       level in the cache hierarchy for which\r
                       information is requested. This value must\r
                       be between 0 and one less than the value\r
                       returned in the cache_levels return value\r
                       from PAL_CACHE_SUMMARY.\r
-\r
   @param CacheType    Unsigned 64-bit integer with a value of 1\r
                       for instruction cache and 2 for data or\r
                       unified cache. All other values are\r
                       reserved.\r
-\r
   @param Reserved     Should be 0.\r
 \r
+  @retval 0           Call completed without error\r
+  @retval -2          Invalid argument\r
+  @retval -3          Call completed with error\r
 \r
-  @return R9      Detail the characteristics of a given\r
-                  processor controlled cache in the cache\r
-                  hierarchy. See PAL_CACHE_INFO_RETURN1.\r
-\r
-  @return R10     Detail the characteristics of a given\r
-                  processor controlled cache in the cache\r
-                  hierarchy. See PAL_CACHE_INFO_RETURN2.\r
-\r
-  @return R11     Reserved with 0.\r
-\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error\r
+  @return R9          Detail the characteristics of a given\r
+                      processor controlled cache in the cache\r
+                      hierarchy. See PAL_CACHE_INFO_RETURN1.\r
+  @return R10         Detail the characteristics of a given\r
+                      processor controlled cache in the cache\r
+                      hierarchy. See PAL_CACHE_INFO_RETURN2.\r
+  @return R11         Reserved with 0.\r
 \r
 **/\r
 #define PAL_CACHE_INFO    2\r
@@ -202,29 +182,25 @@ typedef struct {
 #define PAL_CACHE_INIT_RESTRICTED   1\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_CACHE_INIT.\r
 \r
   Initialize the instruction or data caches. It is required by\r
   IPF. The PAL procedure supports the Static Registers calling\r
   convention. It could be called at physical mode.\r
 \r
-  @param Index  Index of PAL_CACHE_INIT within the list of PAL\r
-                procedures.\r
-\r
-  @param Level  Unsigned 64-bit integer containing the level of\r
-                cache to initialize. If the cache level can be\r
-                initialized independently, only that level will\r
-                be initialized. Otherwise\r
-                implementation-dependent side-effects will\r
-                occur.\r
-\r
+  @param Index      Index of PAL_CACHE_INIT within the list of PAL\r
+                    procedures.\r
+  @param Level      Unsigned 64-bit integer containing the level of\r
+                    cache to initialize. If the cache level can be\r
+                    initialized independently, only that level will\r
+                    be initialized. Otherwise\r
+                    implementation-dependent side-effects will\r
+                    occur.\r
   @param CacheType  Unsigned 64-bit integer with a value of 1 to\r
                     initialize the instruction cache, 2 to\r
                     initialize the data cache, or 3 to\r
                     initialize both. All other values are\r
                     reserved.\r
-\r
   @param Restrict   Unsigned 64-bit integer with a value of 0 or\r
                     1. All other values are reserved. If\r
                     restrict is 1 and initializing the specified\r
@@ -232,16 +208,12 @@ typedef struct {
                     cause side-effects, PAL_CACHE_INIT will\r
                     return -4 instead of initializing the cache.\r
 \r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
-\r
-  @return Status  -4 - Call could not initialize the specified\r
-                  level and cache_type of the cache without\r
-                  side-effects and restrict was 1.\r
+  @retval 0         Call completed without error\r
+  @retval -2        Invalid argument\r
+  @retval -3        Call completed with error.\r
+  @retval -4        Call could not initialize the specified\r
+                    level and cache_type of the cache without\r
+                    side-effects and restrict was 1.\r
 \r
 **/\r
 #define PAL_CACHE_INIT    3\r
@@ -278,7 +250,6 @@ typedef struct {
 } PAL_CACHE_PROTECTION;\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_CACHE_PROT_INFO.\r
 \r
   Return instruction or data cache protection information. It is\r
@@ -286,39 +257,32 @@ typedef struct {
   Registers calling convention. It could be called at physical\r
   mode and Virtual mode.\r
 \r
-  @param Index  Index of PAL_CACHE_PROT_INFO within the list of\r
-                PAL procedures.\r
-\r
+  @param Index      Index of PAL_CACHE_PROT_INFO within the list of\r
+                    PAL procedures.\r
   @param CacheLevel Unsigned 64-bit integer specifying the level\r
                     in the cache hierarchy for which information\r
                     is requested. This value must be between 0\r
                     and one less than the value returned in the\r
                     cache_levels return value from\r
                     PAL_CACHE_SUMMARY.\r
-\r
   @param CacheType  Unsigned 64-bit integer with a value of 1\r
                     for instruction cache and 2 for data or\r
                     unified cache. All other values are\r
                     reserved.\r
 \r
-  @return R9      Detail the characteristics of a given\r
-                  processor controlled cache in the cache\r
-                  hierarchy. See PAL_CACHE_PROTECTION[0..1].\r
-\r
-  @return R10     Detail the characteristics of a given\r
-                  processor controlled cache in the cache\r
-                  hierarchy. See PAL_CACHE_PROTECTION[2..3].\r
-\r
-  @return R11     Detail the characteristics of a given\r
-                  processor controlled cache in the cache\r
-                  hierarchy. See PAL_CACHE_PROTECTION[4..5].\r
-\r
+  @retval 0         Call completed without error\r
+  @retval -2        Invalid argument\r
+  @retval -3        Call completed with error.\r
 \r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @return R9        Detail the characteristics of a given\r
+                    processor controlled cache in the cache\r
+                    hierarchy. See PAL_CACHE_PROTECTION[0..1].\r
+  @return R10       Detail the characteristics of a given\r
+                    processor controlled cache in the cache\r
+                    hierarchy. See PAL_CACHE_PROTECTION[2..3].\r
+  @return R11       Detail the characteristics of a given\r
+                    processor controlled cache in the cache\r
+                    hierarchy. See PAL_CACHE_PROTECTION[4..5].\r
 \r
 **/\r
 #define PAL_CACHE_PROT_INFO     38\r
@@ -360,7 +324,6 @@ typedef struct {
 } PAL_PCOC_N_CACHE_INFO2;\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_CACHE_SHARED_INFO.\r
 \r
   Returns information on which logical processors share caches.\r
@@ -368,53 +331,44 @@ typedef struct {
   Registers calling convention. It could be called at physical\r
   mode and Virtual mode.\r
 \r
-  @param Index  Index of PAL_CACHE_SHARED_INFO within the list\r
-                of PAL procedures.\r
-\r
-  @param CacheLevel   Unsigned 64-bit integer specifying the\r
-                      level in the cache hierarchy for which\r
-                      information is requested. This value must\r
-                      be between 0 and one less than the value\r
-                      returned in the cache_levels return value\r
-                      from PAL_CACHE_SUMMARY.\r
-\r
-  @param CacheType  Unsigned 64-bit integer with a value of 1\r
-                    for instruction cache and 2 for data or\r
-                    unified cache. All other values are\r
-                    reserved.\r
-\r
-  @param ProcNumber   Unsigned 64-bit integer that specifies for\r
-                      which logical processor information is\r
-                      being requested. This input argument must\r
-                      be zero for the first call to this\r
-                      procedure and can be a maximum value of\r
-                      one less than the number of logical\r
-                      processors sharing this cache, which is\r
-                      returned by the num_shared return value.\r
-\r
-  @return R9    Unsigned integer that returns the number of\r
-                logical processors that share the processor\r
-                cache level and type, for which information was\r
-                requested.\r
-\r
-  @return R10   The format of PAL_PCOC_N_CACHE_INFO1.\r
-\r
-  @return R11   The format of PAL_PCOC_N_CACHE_INFO2.\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -1 - Unimplemented procedure\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @param Index       Index of PAL_CACHE_SHARED_INFO within the list\r
+                     of PAL procedures.\r
+  @param CacheLevel  Unsigned 64-bit integer specifying the\r
+                     level in the cache hierarchy for which\r
+                     information is requested. This value must\r
+                     be between 0 and one less than the value\r
+                     returned in the cache_levels return value\r
+                     from PAL_CACHE_SUMMARY.\r
+  @param CacheType   Unsigned 64-bit integer with a value of 1\r
+                     for instruction cache and 2 for data or\r
+                     unified cache. All other values are\r
+                     reserved.\r
+  @param ProcNumber  Unsigned 64-bit integer that specifies for\r
+                     which logical processor information is\r
+                     being requested. This input argument must\r
+                     be zero for the first call to this\r
+                     procedure and can be a maximum value of\r
+                     one less than the number of logical\r
+                     processors sharing this cache, which is\r
+                     returned by the num_shared return value.\r
+\r
+  @retval 0          Call completed without error\r
+  @retval -1         Unimplemented procedure\r
+  @retval -2         Invalid argument\r
+  @retval -3         Call completed with error.\r
+\r
+  @return R9         Unsigned integer that returns the number of\r
+                     logical processors that share the processor\r
+                     cache level and type, for which information was\r
+                     requested.\r
+  @return R10        The format of PAL_PCOC_N_CACHE_INFO1.\r
+  @return R11        The format of PAL_PCOC_N_CACHE_INFO2.\r
 \r
 **/\r
 #define PAL_CACHE_SHARED_INFO   43\r
 \r
 \r
 /**\r
-\r
   PAL Procedure - PAL_CACHE_SUMMARY.\r
 \r
   Return a summary of the cache hierarchy. It is required by\r
@@ -425,30 +379,26 @@ typedef struct {
   @param Index  Index of PAL_CACHE_SUMMARY within the list of\r
                 PAL procedures.\r
 \r
-\r
-  @return R9  CacheLevels   Unsigned 64-bit integer denoting the\r
-                            number of levels of cache\r
-                            implemented by the processor.\r
-                            Strictly, this is the number of\r
-                            levels for which the cache\r
-                            controller is integrated into the\r
-                            processor (the cache SRAMs may be\r
-                            external to the processor).\r
-\r
-  @return R10 UniqueCaches  Unsigned 64-bit integer denoting the\r
-                            number of unique caches implemented\r
-                            by the processor. This has a maximum\r
-                            of 2*cache_levels, but may be less\r
-                            if any of the levels in the cache\r
-                            hierarchy are unified caches or do\r
-                            not have both instruction and data\r
-                            caches.\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @retval 0     Call completed without error\r
+  @retval -2    Invalid argument\r
+  @retval -3    Call completed with error.\r
+\r
+  @return R9    CacheLevels   Unsigned 64-bit integer denoting the\r
+                              number of levels of cache\r
+                              implemented by the processor.\r
+                              Strictly, this is the number of\r
+                              levels for which the cache\r
+                              controller is integrated into the\r
+                              processor (the cache SRAMs may be\r
+                              external to the processor).\r
+  @return R10   UniqueCaches  Unsigned 64-bit integer denoting the\r
+                              number of unique caches implemented\r
+                              by the processor. This has a maximum\r
+                              of 2*cache_levels, but may be less\r
+                              if any of the levels in the cache\r
+                              hierarchy are unified caches or do\r
+                              not have both instruction and data\r
+                              caches.\r
 \r
 **/\r
 #define PAL_CACHE_SUMMARY   4\r
@@ -464,7 +414,6 @@ typedef struct {
 #define PAL_MEMORY_ATTR_NATPAGE 7\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_MEM_ATTRIB.\r
 \r
   Return a list of supported memory attributes.. It is required\r
@@ -475,23 +424,19 @@ typedef struct {
   @param Index  Index of PAL_MEM_ATTRIB within the list of PAL\r
                 procedures.\r
 \r
+  @retval 0     Call completed without error\r
+  @retval -2    Invalid argument\r
+  @retval -3    Call completed with error.\r
 \r
-  @return R9  Attributes  8-bit vector of memory attributes\r
-                          implemented by processor. See Virtual\r
-                          Memory Attributes above.\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @return R9    Attributes  8-bit vector of memory attributes\r
+                            implemented by processor. See Virtual\r
+                            Memory Attributes above.\r
 \r
 **/\r
 \r
 #define PAL_MEM_ATTRIB      5\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_PREFETCH_VISIBILITY.\r
 \r
   Used in architected sequence to transition pages from a\r
@@ -500,28 +445,23 @@ typedef struct {
   Registers calling convention. It could be called at physical\r
   mode and Virtual mode.\r
 \r
-  @param Index  Index of PAL_PREFETCH_VISIBILITY within the list\r
-                of PAL procedures.\r
-\r
-  @param TransitionType   Unsigned integer specifying the type\r
-                          of memory attribute transition that is\r
-                          being performed.\r
-\r
-  @return Status  1       Call completed without error; this\r
-                          call is not necessary on remote\r
-                          processors.\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
+  @param Index          Index of PAL_PREFETCH_VISIBILITY within the list\r
+                        of PAL procedures.\r
+  @param TransitionType Unsigned integer specifying the type\r
+                        of memory attribute transition that is\r
+                        being performed.\r
 \r
-  @return Status  -3 - Call completed with error.\r
+  @retval 1             Call completed without error; this\r
+                        call is not necessary on remote\r
+                        processors.\r
+  @retval 0             Call completed without error\r
+  @retval -2            Invalid argument\r
+  @retval -3            Call completed with error.\r
 \r
 **/\r
 #define PAL_PREFETCH_VISIBILITY   41\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_PTCE_INFO.\r
 \r
   Return information needed for ptc.e instruction to purge\r
@@ -532,27 +472,23 @@ typedef struct {
   @param Index  Index of PAL_PTCE_INFO within the list\r
                 of PAL procedures.\r
 \r
-  @return R9  Unsigned 64-bit integer denoting the beginning\r
-              address to be used by the first PTCE instruction\r
-              in the purge loop.\r
-\r
-  @return R10 Two unsigned 32-bit integers denoting the loop\r
-              counts of the outer (loop 1) and inner (loop 2)\r
-              purge loops. count1 (loop 1) is contained in bits\r
-              63:32 of the parameter, and count2 (loop 2) is\r
-              contained in bits 31:0 of the parameter.\r
-\r
-  @return R11 Two unsigned 32-bit integers denoting the loop\r
-              strides of the outer (loop 1) and inner (loop 2)\r
-              purge loops. stride1 (loop 1) is contained in bits\r
-              63:32 of the parameter, and stride2 (loop 2) is\r
-              contained in bits 31:0 of the parameter.\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @retval 0     Call completed without error\r
+  @retval -2    Invalid argument\r
+  @retval -3    Call completed with error.\r
+\r
+  @return R9    Unsigned 64-bit integer denoting the beginning\r
+                address to be used by the first PTCE instruction\r
+                in the purge loop.\r
+  @return R10   Two unsigned 32-bit integers denoting the loop\r
+                counts of the outer (loop 1) and inner (loop 2)\r
+                purge loops. count1 (loop 1) is contained in bits\r
+                63:32 of the parameter, and count2 (loop 2) is\r
+                contained in bits 31:0 of the parameter.\r
+  @return R11   Two unsigned 32-bit integers denoting the loop\r
+                strides of the outer (loop 1) and inner (loop 2)\r
+                purge loops. stride1 (loop 1) is contained in bits\r
+                63:32 of the parameter, and stride2 (loop 2) is\r
+                contained in bits 31:0 of the parameter.\r
 \r
 **/\r
 #define PAL_PTCE_INFO     6\r
@@ -599,7 +535,6 @@ typedef struct {
 } PAL_TC_INFO;\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_VM_INFO.\r
 \r
   Return detailed information about virtual memory features\r
@@ -607,40 +542,34 @@ typedef struct {
   procedure supports the Static Registers calling convention. It\r
   could be called at physical mode and Virtual mode.\r
 \r
-  @param Index  Index of PAL_VM_INFO within the list\r
-                of PAL procedures.\r
-\r
+  @param Index    Index of PAL_VM_INFO within the list\r
+                  of PAL procedures.\r
   @param TcLevel  Unsigned 64-bit integer specifying the level\r
                   in the TLB hierarchy for which information is\r
                   required. This value must be between 0 and one\r
                   less than the value returned in the\r
                   vm_info_1.num_tc_levels return value from\r
                   PAL_VM_SUMMARY.\r
-\r
   @param TcType   Unsigned 64-bit integer with a value of 1 for\r
                   instruction translation cache and 2 for data\r
                   or unified translation cache. All other values\r
                   are reserved.\r
 \r
+  @retval 0       Call completed without error\r
+  @retval -2      Invalid argument\r
+  @retval -3      Call completed with error.\r
+\r
   @return R9      8-byte formatted value returning information\r
                   about the specified TC. See PAL_TC_INFO above.\r
-\r
   @return R10     64-bit vector containing a bit for each page\r
                   size supported in the specified TC, where bit\r
                   position n indicates a page size of 2**n.\r
 \r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
-\r
 **/\r
 #define PAL_VM_INFO       7\r
 \r
 \r
 /**\r
-\r
   PAL Procedure - PAL_VM_PAGE_SIZE.\r
 \r
   Return virtual memory TC and hardware walker page sizes\r
@@ -651,20 +580,16 @@ typedef struct {
   @param Index  Index of PAL_VM_PAGE_SIZE within the list\r
                 of PAL procedures.\r
 \r
+  @retval 0     Call completed without error\r
+  @retval -2    Invalid argument\r
+  @retval -3    Call completed with error.\r
 \r
-  @return R9      64-bit vector containing a bit for each\r
-                  architected page size that is supported for\r
-                  TLB insertions and region registers.\r
-\r
-  @return R10     64-bit vector containing a bit for each\r
-                  architected page size supported for TLB purge\r
-                  operations.\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @return R9    64-bit vector containing a bit for each\r
+                architected page size that is supported for\r
+                TLB insertions and region registers.\r
+  @return R10   64-bit vector containing a bit for each\r
+                architected page size supported for TLB purge\r
+                operations.\r
 \r
 **/\r
 #define PAL_VM_PAGE_SIZE 34\r
@@ -746,7 +671,6 @@ typedef struct {
 } PAL_VM_INFO2;\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_VM_SUMMARY.\r
 \r
   Return summary information about virtual memory features\r
@@ -757,19 +681,15 @@ typedef struct {
   @param Index  Index of PAL_VM_SUMMARY within the list\r
                 of PAL procedures.\r
 \r
+  @retval 0     Call completed without error\r
+  @retval -2    Invalid argument\r
+  @retval -3    Call completed with error.\r
 \r
   @return R9    8-byte formatted value returning global virtual\r
                 memory information. See PAL_VM_INFO1 above.\r
-\r
   @return R10   8-byte formatted value returning global virtual\r
                 memory information. See PAL_VM_INFO2 above.\r
 \r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
-\r
 **/\r
 #define PAL_VM_SUMMARY  8\r
 \r
@@ -784,34 +704,28 @@ typedef struct {
 \r
 \r
 /**\r
-\r
   PAL Procedure - PAL_VM_TR_READ.\r
 \r
   Read contents of a translation register. It is required by\r
   IPF. The PAL procedure supports the Stacked Register calling\r
   convention. It could be called at physical mode.\r
 \r
-  @param Index  Index of PAL_VM_TR_READ within the list\r
-                of PAL procedures.\r
-\r
+  @param Index      Index of PAL_VM_TR_READ within the list\r
+                    of PAL procedures.\r
   @param RegNumber  Unsigned 64-bit number denoting which TR to\r
                     read.\r
+  @param TrType     Unsigned 64-bit number denoting whether to\r
+                    read an ITR (0) or DTR (1). All other values\r
+                    are reserved.\r
+  @param TrBuffer   64-bit pointer to the 32-byte memory buffer in\r
+                    which translation data is returned.\r
 \r
-  @param TrType   Unsigned 64-bit number denoting whether to\r
-                  read an ITR (0) or DTR (1). All other values\r
-                  are reserved.\r
-\r
-  @param TrBuffer 64-bit pointer to the 32-byte memory buffer in\r
-                  which translation data is returned.\r
-\r
-  @return R9    Formatted bit vector denoting which fields are\r
-                valid. See TR_valid above.\r
-\r
-  @return Status  0 - Call completed without error\r
+  @retval 0         Call completed without error\r
+  @retval -2        Invalid argument\r
+  @retval -3        Call completed with error.\r
 \r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @return R9        Formatted bit vector denoting which fields are\r
+                    valid. See TR_valid above.\r
 \r
 **/\r
 #define PAL_VM_TR_READ  261\r
@@ -982,7 +896,6 @@ typedef struct {
 \r
 \r
 /**\r
-\r
   PAL Procedure - PAL_BUS_GET_FEATURES.\r
 \r
   Return configurable processor bus interface features and their\r
@@ -993,25 +906,20 @@ typedef struct {
   @param Index  Index of PAL_BUS_GET_FEATURES within the list\r
                 of PAL procedures.\r
 \r
+  @retval 0     Call completed without error\r
+  @retval -2    Invalid argument\r
+  @retval -3    Call completed with error.\r
+\r
   @return R9    64-bit vector of features implemented.\r
                 (1=implemented, 0=not implemented)\r
-\r
   @return R10   64-bit vector of current feature settings.\r
-\r
   @return R11   64-bit vector of features controllable by\r
                 software. (1=controllable, 0= not controllable)\r
 \r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
-\r
 **/\r
 #define PAL_BUS_GET_FEATURES 9\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_BUS_SET_FEATURES.\r
 \r
   Enable or disable configurable features in processor bus\r
@@ -1019,24 +927,20 @@ typedef struct {
   supports the Static Registers calling convention. It could be\r
   called at physical mode.\r
 \r
-  @param Index  Index of PAL_BUS_SET_FEATURES within the list\r
-                of PAL procedures.\r
-\r
+  @param Index          Index of PAL_BUS_SET_FEATURES within the list\r
+                        of PAL procedures.\r
   @param FeatureSelect  64-bit vector denoting desired state of\r
                         each feature (1=select, 0=non-select).\r
 \r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @retval 0             Call completed without error\r
+  @retval -2            Invalid argument\r
+  @retval -3            Call completed with error.\r
 \r
 **/\r
 #define PAL_BUS_SET_FEATURES 10\r
 \r
 \r
 /**\r
-\r
   PAL Procedure - PAL_DEBUG_INFO.\r
 \r
   Return the number of instruction and data breakpoint\r
@@ -1048,25 +952,21 @@ typedef struct {
   @param Index  Index of PAL_DEBUG_INFO within the list of PAL\r
                 procedures.\r
 \r
-  @return R9  Unsigned 64-bit integer denoting the number of\r
-              pairs of instruction debug registers implemented\r
-              by the processor.\r
-\r
-  @return R10 Unsigned 64-bit integer denoting the number of\r
-              pairs of data debug registers implemented by the\r
-              processor.\r
-\r
-  @return Status  0 - Call completed without error\r
+  @retval 0     Call completed without error\r
+  @retval -2    Invalid argument\r
+  @retval -3    Call completed with error.\r
 \r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @return R9    Unsigned 64-bit integer denoting the number of\r
+                pairs of instruction debug registers implemented\r
+                by the processor.\r
+  @return R10   Unsigned 64-bit integer denoting the number of\r
+                pairs of data debug registers implemented by the\r
+                processor.\r
 \r
 **/\r
 #define PAL_DEBUG_INFO  11\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_FIXED_ADDR.\r
 \r
   Return the fixed component of a processor's directed address.\r
@@ -1077,20 +977,16 @@ typedef struct {
   @param Index  Index of PAL_FIXED_ADDR within the list of PAL\r
                 procedures.\r
 \r
-  @return R9  Fixed geographical address of this processor.\r
-\r
-\r
-  @return Status  0 - Call completed without error\r
+  @retval 0     Call completed without error\r
+  @retval -2    Invalid argument\r
+  @retval -3    Call completed with error.\r
 \r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @return R9    Fixed geographical address of this processor.\r
 \r
 **/\r
 #define PAL_FIXED_ADDR 12\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_FREQ_BASE.\r
 \r
   Return the frequency of the output clock for use by the\r
@@ -1102,24 +998,19 @@ typedef struct {
   @param Index  Index of PAL_FREQ_BASE within the list of PAL\r
                 procedures.\r
 \r
-  @return R9  Base frequency of the platform if generated by the\r
-              processor chip.\r
-\r
-\r
-  @return Status  0 - Call completed without error\r
+  @retval 0     Call completed without error\r
+  @retval -1    Unimplemented procedure\r
+  @retval -2    Invalid argument\r
+  @retval -3    Call completed with error.\r
 \r
-  @return Status  -1 - Unimplemented procedure\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @return R9    Base frequency of the platform if generated by the\r
+                processor chip.\r
 \r
 **/\r
 #define PAL_FREQ_BASE 13\r
 \r
 \r
 /**\r
-\r
   PAL Procedure - PAL_FREQ_RATIOS.\r
 \r
   Return ratio of processor, bus, and interval time counter to\r
@@ -1131,29 +1022,25 @@ typedef struct {
   @param Index  Index of PAL_FREQ_RATIOS within the list of PAL\r
                 procedures.\r
 \r
-  @return R9  Ratio of the processor frequency to the input\r
-              clock of the processor, if the platform clock is\r
-              generated externally or to the output clock to the\r
-              platform, if the platform clock is generated by\r
-              the processor.\r
-\r
-  @return R10 Ratio of the bus frequency to the input clock of\r
-              the processor, if the platform clock is generated\r
-              externally or to the output clock to the platform,\r
-              if the platform clock is generated by the\r
-              processor.\r
-\r
-  @return R11 Ratio of the interval timer counter rate to input\r
-              clock of the processor, if the platform clock is\r
-              generated externally or to the output clock to the\r
-              platform, if the platform clock is generated by\r
-              the processor.\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @retval 0     Call completed without error\r
+  @retval -2    Invalid argument\r
+  @retval -3    Call completed with error.\r
+\r
+  @return R9    Ratio of the processor frequency to the input\r
+                clock of the processor, if the platform clock is\r
+                generated externally or to the output clock to the\r
+                platform, if the platform clock is generated by\r
+                the processor.\r
+  @return R10   Ratio of the bus frequency to the input clock of\r
+                the processor, if the platform clock is generated\r
+                externally or to the output clock to the platform,\r
+                if the platform clock is generated by the\r
+                processor.\r
+  @return R11   Ratio of the interval timer counter rate to input\r
+                clock of the processor, if the platform clock is\r
+                generated externally or to the output clock to the\r
+                platform, if the platform clock is generated by\r
+                the processor.\r
 \r
 **/\r
 #define PAL_FREQ_RATIOS 14\r
@@ -1228,7 +1115,6 @@ typedef struct {
 } PAL_LOGICAL_PROCESSORN_INFO2;\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_LOGICAL_TO_PHYSICAL.\r
 \r
   Return information on which logical processors map to a\r
@@ -1236,9 +1122,8 @@ typedef struct {
   supports the Static Registers calling convention. It could be\r
   called at physical mode and virtual mode.\r
 \r
-  @param Index  Index of PAL_LOGICAL_TO_PHYSICAL within the list of PAL\r
-                procedures.\r
-\r
+  @param Index            Index of PAL_LOGICAL_TO_PHYSICAL within the list of PAL\r
+                          procedures.\r
   @param ProcessorNumber  Signed 64-bit integer that specifies\r
                           for which logical processor\r
                           information is being requested. When\r
@@ -1251,21 +1136,14 @@ typedef struct {
                           returned by num_log in the\r
                           log_overview return value.\r
 \r
+  @retval 0               Call completed without error\r
+  @retval -1              Unimplemented procedure\r
+  @retval -2              Invalid argument\r
+  @retval -3              Call completed with error.\r
 \r
-  @return R9  The format of PAL_LOGICAL_PROCESSPR_OVERVIEW.\r
-\r
-  @return R10 The format of PAL_LOGICAL_PROCESSORN_INFO1.\r
-\r
-  @return R11 The format of PAL_LOGICAL_PROCESSORN_INFO2.\r
-\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -1 - Unimplemented procedure\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @return R9              The format of PAL_LOGICAL_PROCESSPR_OVERVIEW.\r
+  @return R10             The format of PAL_LOGICAL_PROCESSORN_INFO1.\r
+  @return R11             The format of PAL_LOGICAL_PROCESSORN_INFO2.\r
 \r
 **/\r
 #define PAL_LOGICAL_TO_PHYSICAL 42\r
@@ -1300,7 +1178,6 @@ typedef struct {
 } PAL_PERFORMANCE_INFO;\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_PERF_MON_INFO.\r
 \r
   Return the number and type of performance monitors. It is\r
@@ -1308,21 +1185,17 @@ typedef struct {
   Registers calling convention. It could be called at physical\r
   mode and virtual mode.\r
 \r
-  @param Index  Index of PAL_PERF_MON_INFO within the list of\r
-                PAL procedures.\r
-\r
+  @param Index              Index of PAL_PERF_MON_INFO within the list of\r
+                            PAL procedures.\r
   @param PerformanceBuffer  An address to an 8-byte aligned\r
                             128-byte memory buffer.\r
 \r
+  @retval 0                 Call completed without error\r
+  @retval -2                Invalid argument\r
+  @retval -3                Call completed with error.\r
 \r
-  @return R9  Information about the performance monitors\r
-              implemented. See PAL_PERFORMANCE_INFO;\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @return R9                Information about the performance monitors\r
+                            implemented. See PAL_PERFORMANCE_INFO;\r
 \r
 **/\r
 #define PAL_PERF_MON_INFO 15\r
@@ -1331,7 +1204,6 @@ typedef struct {
 #define PAL_PLATFORM_ADDR_IO_BLOCK_TOKEN                              0x1\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_PLATFORM_ADDR.\r
 \r
   Specify processor interrupt block address and I/O port space\r
@@ -1339,29 +1211,23 @@ typedef struct {
   Static Registers calling convention. It could be called at\r
   physical mode and virtual mode.\r
 \r
-  @param Index  Index of PAL_PLATFORM_ADDR within the list of\r
-                PAL procedures.\r
-\r
-  @param Type   Unsigned 64-bit integer specifying the type of\r
-                block. 0 indicates that the processor interrupt\r
-                block pointer should be initialized. 1 indicates\r
-                that the processor I/O block pointer should be\r
-                initialized.\r
-\r
+  @param Index    Index of PAL_PLATFORM_ADDR within the list of\r
+                  PAL procedures.\r
+  @param Type     Unsigned 64-bit integer specifying the type of\r
+                  block. 0 indicates that the processor interrupt\r
+                  block pointer should be initialized. 1 indicates\r
+                  that the processor I/O block pointer should be\r
+                  initialized.\r
   @param Address  Unsigned 64-bit integer specifying the address\r
                   to which the processor I/O block or interrupt\r
                   block shall be set. The address must specify\r
                   an implemented physical address on the\r
                   processor model, bit 63 is ignored.\r
 \r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -1 - Unimplemented procedure.\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @retval 0       Call completed without error\r
+  @retval -1      Unimplemented procedure.\r
+  @retval -2      Invalid argument\r
+  @retval -3      Call completed with error.\r
 \r
 **/\r
 #define PAL_PLATFORM_ADDR 16\r
@@ -1712,7 +1578,6 @@ typedef struct {
 } PAL_PROCESSOR_FEATURES;\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_PROC_GET_FEATURES.\r
 \r
   Return configurable processor features and their current\r
@@ -1720,43 +1585,33 @@ typedef struct {
   Static Registers calling convention. It could be called at\r
   physical mode and virtual mode.\r
 \r
-  @param Index  Index of PAL_PROC_GET_FEATURES within the list of\r
-                PAL procedures.\r
-\r
+  @param Index      Index of PAL_PROC_GET_FEATURES within the list of\r
+                    PAL procedures.\r
   @param Reserved   Reserved parameter.\r
-\r
-  @param FeatureSet   Feature set information is being requested\r
-                      for.\r
-\r
-\r
-  @return R9  64-bit vector of features implemented. See\r
-              PAL_PROCESSOR_FEATURES.\r
-\r
-  @return R10 64-bit vector of current feature settings. See\r
-              PAL_PROCESSOR_FEATURES.\r
-\r
-  @return R11 64-bit vector of features controllable by\r
-              software.\r
-\r
-  @return Status  1 - Call completed without error; The\r
-                  feature_set passed is not supported but a\r
-                  feature_set of a larger value is supported.\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
-\r
-  @return Status  -8 - feature_set passed is beyond the maximum\r
-                  feature_set supported\r
+  @param FeatureSet Feature set information is being requested\r
+                    for.\r
+\r
+  @retval 1         Call completed without error; The\r
+                    feature_set passed is not supported but a\r
+                    feature_set of a larger value is supported.\r
+  @retval 0         Call completed without error\r
+  @retval -2        Invalid argument\r
+  @retval -3        Call completed with error.\r
+  @retval -8        feature_set passed is beyond the maximum\r
+                    feature_set supported\r
+\r
+  @return R9        64-bit vector of features implemented. See\r
+                    PAL_PROCESSOR_FEATURES.\r
+  @return R10       64-bit vector of current feature settings. See\r
+                    PAL_PROCESSOR_FEATURES.\r
+  @return R11       64-bit vector of features controllable by\r
+                    software.\r
 \r
 **/\r
 #define PAL_PROC_GET_FEATURES 17\r
 \r
 \r
 /**\r
-\r
   PAL Procedure - PAL_PROC_SET_FEATURES.\r
 \r
   Enable or disable configurable processor features. It is\r
@@ -1764,30 +1619,22 @@ typedef struct {
   Registers calling convention. It could be called at physical\r
   mode.\r
 \r
-  @param Index  Index of PAL_PROC_SET_FEATURES within the list of\r
-                PAL procedures.\r
-\r
+  @param Index          Index of PAL_PROC_SET_FEATURES within the list of\r
+                        PAL procedures.\r
   @param FeatureSelect  64-bit vector denoting desired state of\r
                         each feature (1=select, 0=non-select).\r
+  @param FeatureSet     Feature set to apply changes to. See\r
+                        PAL_PROC_GET_FEATURES for more information\r
+                        on feature sets.\r
 \r
-  @param FeatureSet   Feature set to apply changes to. See\r
-                      PAL_PROC_GET_FEATURES for more information\r
-                      on feature sets.\r
-\r
-\r
-\r
-  @return Status  1 - Call completed without error; The\r
-                  feature_set passed is not supported but a\r
-                  feature_set of a larger value is supported\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
-\r
-  @return Status  -8 - feature_set passed is beyond the maximum\r
-                  feature_set supported\r
+  @retval 1             Call completed without error; The\r
+                        feature_set passed is not supported but a\r
+                        feature_set of a larger value is supported\r
+  @retval 0             Call completed without error\r
+  @retval -2            Invalid argument\r
+  @retval -3            Call completed with error.\r
+  @retval -8            feature_set passed is beyond the maximum\r
+                        feature_set supported\r
 \r
 **/\r
 #define PAL_PROC_SET_FEATURES 18\r
@@ -1803,7 +1650,6 @@ typedef struct {
 \r
 \r
 /**\r
-\r
   PAL Procedure - PAL_REGISTER_INFO.\r
 \r
   Return AR and CR register information. It is required by IPF.\r
@@ -1811,56 +1657,44 @@ typedef struct {
   convention. It could be called at physical mode and virtual\r
   mode.\r
 \r
-  @param Index  Index of PAL_REGISTER_INFO within the list of\r
-                PAL procedures.\r
-\r
+  @param Index        Index of PAL_REGISTER_INFO within the list of\r
+                      PAL procedures.\r
   @param InfoRequest  Unsigned 64-bit integer denoting what\r
                       register information is requested. See\r
                       PAL_REGISTER_INFO.InfoRequest above.\r
 \r
-  @return R9  64-bit vector denoting information for registers\r
-              0-63. Bit 0 is register 0, bit 63 is register 63.\r
-\r
-  @return R10 64-bit vector denoting information for registers\r
-              64-127. Bit 0 is register 64, bit 63 is register\r
-              127.\r
-\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @retval 0           Call completed without error\r
+  @retval -2          Invalid argument\r
+  @retval -3          Call completed with error.\r
 \r
+  @return R9          64-bit vector denoting information for registers\r
+                      0-63. Bit 0 is register 0, bit 63 is register 63.\r
+  @return R10         64-bit vector denoting information for registers\r
+                      64-127. Bit 0 is register 64, bit 63 is register\r
+                      127.\r
 \r
 **/\r
 #define PAL_REGISTER_INFO 39\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_RSE_INFO.\r
 \r
   Return RSE information. It is required by IPF. The PAL\r
   procedure supports the Static Registers calling convention. It\r
   could be called at physical mode and virtual mode.\r
 \r
-  @param Index  Index of PAL_RSE_INFO within the list of\r
-                PAL procedures.\r
-\r
+  @param Index        Index of PAL_RSE_INFO within the list of\r
+                      PAL procedures.\r
   @param InfoRequest  Unsigned 64-bit integer denoting what\r
                       register information is requested. See\r
                       PAL_REGISTER_INFO.InfoRequest above.\r
 \r
-  @return R9  Number of physical stacked general registers.\r
-\r
-  @return R10 RSE hints supported by processor.\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @retval 0           Call completed without error\r
+  @retval -2          Invalid argument\r
+  @retval -3          Call completed with error.\r
 \r
+  @return R9          Number of physical stacked general registers.\r
+  @return R10         RSE hints supported by processor.\r
 \r
 **/\r
 #define PAL_RSE_INFO 19\r
@@ -1893,34 +1727,28 @@ typedef struct {
 } PAL_VERSION_INFO;\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_VERSION.\r
 \r
   Return version of PAL code. It is required by IPF. The PAL\r
   procedure supports the Static Registers calling convention. It\r
   could be called at physical mode and virtual mode.\r
 \r
-  @param Index  Index of PAL_VERSION within the list of\r
-                PAL procedures.\r
-\r
+  @param Index        Index of PAL_VERSION within the list of\r
+                      PAL procedures.\r
   @param InfoRequest  Unsigned 64-bit integer denoting what\r
                       register information is requested. See\r
                       PAL_REGISTER_INFO.InfoRequest above.\r
 \r
-  @return R9  8-byte formatted value returning the minimum PAL\r
-              version needed for proper operation of the\r
-              processor. See PAL_VERSION_INFO above.\r
-\r
-  @return R10 8-byte formatted value returning the current PAL\r
-              version running on the processor. See\r
-              PAL_VERSION_INFO above.\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @retval 0           Call completed without error\r
+  @retval -2          Invalid argument\r
+  @retval -3          Call completed with error.\r
 \r
+  @return R9          8-byte formatted value returning the minimum PAL\r
+                      version needed for proper operation of the\r
+                      processor. See PAL_VERSION_INFO above.\r
+  @return R10         8-byte formatted value returning the current PAL\r
+                      version running on the processor. See\r
+                      PAL_VERSION_INFO above.\r
 \r
 **/\r
 #define PAL_VERSION 20\r
@@ -1934,7 +1762,6 @@ typedef struct {
 #define PAL_INIT_PENDING  BIT1\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_MC_CLEAR_LOG.\r
 \r
   Clear all error information from processor error logging\r
@@ -1945,23 +1772,17 @@ typedef struct {
   @param Index  Index of PAL_MC_CLEAR_LOG within the list of\r
                 PAL procedures.\r
 \r
+  @retval 0     Call completed without error\r
+  @retval -2    Invalid argument\r
+  @retval -3    Call completed with error.\r
 \r
-  @return R9  64-bit vector denoting whether an event is\r
-              pending. See PAL_MC_CLEAR_LOG.pending above.\r
-\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
-\r
+  @return R9    64-bit vector denoting whether an event is\r
+                pending. See PAL_MC_CLEAR_LOG.pending above.\r
 \r
 **/\r
 #define PAL_MC_CLEAR_LOG 21\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_MC_DRAIN.\r
 \r
   Ensure that all operations that could cause an MCA have\r
@@ -1972,20 +1793,15 @@ typedef struct {
   @param Index  Index of PAL_MC_DRAIN within the list of PAL\r
                 procedures.\r
 \r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
-\r
+  @retval 0     Call completed without error\r
+  @retval -2    Invalid argument\r
+  @retval -3    Call completed with error.\r
 \r
 **/\r
 #define PAL_MC_DRAIN 22\r
 \r
 \r
 /**\r
-\r
   PAL Procedure - PAL_MC_DYNAMIC_STATE.\r
 \r
   Return Processor Dynamic State for logging by SAL. It is\r
@@ -1994,23 +1810,17 @@ typedef struct {
 \r
   @param Index  Index of PAL_MC_DYNAMIC_STATE within the list of PAL\r
                 procedures.\r
-\r
   @param Offset Offset of the next 8 bytes of Dynamic Processor\r
                 State to return. (multiple of 8).\r
 \r
-  @return R9  Unsigned 64-bit integer denoting bytes of Dynamic\r
-              Processor State returned.\r
-\r
-  @return R10 Next 8 bytes of Dynamic Processor State.\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -1 - Unimplemented procedure.\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @retval 0     Call completed without error\r
+  @retval -1    Unimplemented procedure.\r
+  @retval -2    Invalid argument\r
+  @retval -3    Call completed with error.\r
 \r
+  @return R9    Unsigned 64-bit integer denoting bytes of Dynamic\r
+                Processor State returned.\r
+  @return R10   Next 8 bytes of Dynamic Processor State.\r
 \r
 **/\r
 #define PAL_MC_DYNAMIC_STATE 24\r
@@ -2318,7 +2128,6 @@ typedef struct {
 } PAL_TLB_CHECK_INFO;\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_MC_ERROR_INFO.\r
 \r
   Return Processor Machine Check Information and Processor\r
@@ -2326,79 +2135,62 @@ typedef struct {
   PAL procedure supports the Static Registers calling\r
   convention. It could be called at physical and virtual mode.\r
 \r
-  @param Index  Index of PAL_MC_ERROR_INFO within the list of PAL\r
-                procedures.\r
-\r
-  @param InfoIndex  Unsigned 64-bit integer identifying the\r
-                    error information that is being requested.\r
-                    See PAL_MC_ERROR_INFO.InfoIndex.\r
-\r
-  @param LevelIndex   8-byte formatted value identifying the\r
-                      structure to return error information\r
-                      on. See PAL_MC_ERROR_INFO_LEVEL_INDEX.\r
-\r
+  @param Index            Index of PAL_MC_ERROR_INFO within the list of PAL\r
+                          procedures.\r
+  @param InfoIndex        Unsigned 64-bit integer identifying the\r
+                          error information that is being requested.\r
+                          See PAL_MC_ERROR_INFO.InfoIndex.\r
+  @param LevelIndex       8-byte formatted value identifying the\r
+                          structure to return error information\r
+                          on. See PAL_MC_ERROR_INFO_LEVEL_INDEX.\r
   @param ErrorTypeIndex   Unsigned 64-bit integer denoting the\r
                           type of error information that is\r
                           being requested for the structure\r
                           identified in LevelIndex.\r
 \r
+  @retval 0               Call completed without error\r
+  @retval -2              Invalid argument\r
+  @retval -3              Call completed with error.\r
+  @retval -6              Argument was valid, but no error\r
+                          information was available\r
 \r
-  @return R9  Error information returned. The format of this\r
-              value is dependant on the input values passed.\r
-\r
-  @return R10 If this value is zero, all the error information\r
-              specified by err_type_index has been returned. If\r
-              this value is one, more structure-specific error\r
-              information is available and the caller needs to\r
-              make this procedure call again with level_index\r
-              unchanged and err_type_index, incremented.\r
-\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
-\r
-  @return Status  -6 - Argument was valid, but no error\r
-                  information was available\r
-\r
+  @return R9              Error information returned. The format of this\r
+                          value is dependant on the input values passed.\r
+  @return R10             If this value is zero, all the error information\r
+                          specified by err_type_index has been returned. If\r
+                          this value is one, more structure-specific error\r
+                          information is available and the caller needs to\r
+                          make this procedure call again with level_index\r
+                          unchanged and err_type_index, incremented.\r
 \r
 **/\r
 #define PAL_MC_ERROR_INFO 25\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_MC_EXPECTED.\r
 \r
   Set/Reset Expected Machine Check Indicator. It is required by\r
   IPF. The PAL procedure supports the Static Registers calling\r
   convention. It could be called at physical mode.\r
 \r
-  @param Index  Index of PAL_MC_EXPECTED within the list of PAL\r
-                procedures.\r
-\r
+  @param Index      Index of PAL_MC_EXPECTED within the list of PAL\r
+                    procedures.\r
   @param Expected   Unsigned integer with a value of 0 or 1 to\r
                     set or reset the hardware resource\r
                     PALE_CHECK examines for expected machine\r
                     checks.\r
 \r
+  @retval 0         Call completed without error\r
+  @retval -2        Invalid argument\r
+  @retval -3        Call completed with error.\r
 \r
-  @return R9  Unsigned integer denoting whether a machine check\r
-              was previously expected.\r
-\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @return R9        Unsigned integer denoting whether a machine check\r
+                    was previously expected.\r
 \r
 **/\r
 #define PAL_MC_EXPECTED 23\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_MC_REGISTER_MEM.\r
 \r
   Register min-state save area with PAL for machine checks and\r
@@ -2406,25 +2198,19 @@ typedef struct {
   Static Registers calling convention. It could be called at\r
   physical mode.\r
 \r
-  @param Index  Index of PAL_MC_REGISTER_MEM within the list of PAL\r
-                procedures.\r
-\r
+  @param Index    Index of PAL_MC_REGISTER_MEM within the list of PAL\r
+                  procedures.\r
   @param Address  Physical address of the buffer to be\r
                   registered with PAL.\r
 \r
-\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @retval 0       Call completed without error\r
+  @retval -2      Invalid argument\r
+  @retval -3      Call completed with error.\r
 \r
 **/\r
 #define PAL_MC_REGISTER_MEM 27\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_MC_RESUME.\r
 \r
   Restore minimal architected state and return to interrupted\r
@@ -2432,18 +2218,15 @@ typedef struct {
   Static Registers calling convention. It could be called at\r
   physical mode.\r
 \r
-  @param Index  Index of PAL_MC_RESUME within the list of PAL\r
-                procedures.\r
-\r
-  @param SetCmci  Unsigned 64 bit integer denoting whether to\r
-                  set the CMC interrupt. A value of 0 indicates\r
-                  not to set the interrupt, a value of 1\r
-                  indicated to set the interrupt, and all other\r
-                  values are reserved.\r
-\r
-  @param SavePtr  Physical address of min-state save area used\r
-                  to used to restore processor state.\r
-\r
+  @param Index        Index of PAL_MC_RESUME within the list of PAL\r
+                      procedures.\r
+  @param SetCmci      Unsigned 64 bit integer denoting whether to\r
+                      set the CMC interrupt. A value of 0 indicates\r
+                      not to set the interrupt, a value of 1\r
+                      indicated to set the interrupt, and all other\r
+                      values are reserved.\r
+  @param SavePtr      Physical address of min-state save area used\r
+                      to used to restore processor state.\r
   @param NewContext   Unsigned 64-bit integer denoting whether\r
                       the caller is returning to a new context.\r
                       A value of 0 indicates the caller is\r
@@ -2451,17 +2234,13 @@ typedef struct {
                       value of 1 indicates that the caller is\r
                       returning to a new context.\r
 \r
-\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @retval -2          Invalid argument\r
+  @retval -3          Call completed with error.\r
 \r
 **/\r
 #define PAL_MC_RESUME 26\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_HALT.\r
 \r
   Enter the low-power HALT state or an implementation-dependent\r
@@ -2469,35 +2248,27 @@ typedef struct {
   Static Registers calling convention. It could be called at\r
   physical mode.\r
 \r
-  @param Index  Index of PAL_HALT within the list of PAL\r
-                procedures.\r
-\r
-  @param HaltState  Unsigned 64-bit integer denoting low power\r
-                    state requested.\r
-\r
+  @param Index        Index of PAL_HALT within the list of PAL\r
+                      procedures.\r
+  @param HaltState    Unsigned 64-bit integer denoting low power\r
+                      state requested.\r
   @param IoDetailPtr  8-byte aligned physical address pointer to\r
                       information on the type of I/O\r
                       (load/store) requested.\r
 \r
+  @retval 0           Call completed without error\r
+  @retval -1          Unimplemented procedure\r
+  @retval -2          Invalid argument\r
+  @retval -3          Call completed with error.\r
 \r
-  @return R9  Value returned if a load instruction is requested\r
-              in the io_detail_ptr\r
-\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -1 - Unimplemented procedure\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @return R9          Value returned if a load instruction is requested\r
+                      in the io_detail_ptr\r
 \r
 **/\r
 #define PAL_HALT 28\r
 \r
 \r
 /**\r
-\r
   PAL Procedure - PAL_HALT_INFO.\r
 \r
   Return the low power capabilities of the processor. It is\r
@@ -2505,26 +2276,20 @@ typedef struct {
   Stacked Registers calling convention. It could be called at\r
   physical and virtual mode.\r
 \r
-  @param Index  Index of PAL_HALT_INFO within the list of PAL\r
-                procedures.\r
-\r
+  @param Index        Index of PAL_HALT_INFO within the list of PAL\r
+                      procedures.\r
   @param PowerBuffer  64-bit pointer to a 64-byte buffer aligned\r
                       on an 8-byte boundary.\r
 \r
-\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @retval 0           Call completed without error\r
+  @retval -2          Invalid argument\r
+  @retval -3          Call completed with error.\r
 \r
 **/\r
 #define PAL_HALT_INFO 257\r
 \r
 \r
 /**\r
-\r
   PAL Procedure - PAL_HALT_LIGHT.\r
 \r
   Enter the low power LIGHT HALT state. It is required by\r
@@ -2534,18 +2299,14 @@ typedef struct {
   @param Index  Index of PAL_HALT_LIGHT within the list of PAL\r
                 procedures.\r
 \r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @retval 0     Call completed without error\r
+  @retval -2    Invalid argument\r
+  @retval -3    Call completed with error.\r
 \r
 **/\r
 #define PAL_HALT_LIGHT 29\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_CACHE_LINE_INIT.\r
 \r
   Initialize tags and data of a cache line for processor\r
@@ -2553,30 +2314,24 @@ typedef struct {
   Static Registers calling convention. It could be called at\r
   physical and virtual mode.\r
 \r
-  @param Index  Index of PAL_CACHE_LINE_INIT within the list of PAL\r
-                procedures.\r
-\r
-  @param Address  Unsigned 64-bit integer value denoting the\r
-                  physical address from which the physical page\r
-                  number is to be generated. The address must be\r
-                  an implemented physical address, bit 63 must\r
-                  be zero.\r
-\r
+  @param Index      Index of PAL_CACHE_LINE_INIT within the list of PAL\r
+                    procedures.\r
+  @param Address    Unsigned 64-bit integer value denoting the\r
+                    physical address from which the physical page\r
+                    number is to be generated. The address must be\r
+                    an implemented physical address, bit 63 must\r
+                    be zero.\r
   @param DataValue  64-bit data value which is used to\r
                     initialize the cache line.\r
 \r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @retval 0         Call completed without error\r
+  @retval -2        Invalid argument\r
+  @retval -3        Call completed with error.\r
 \r
 **/\r
 #define PAL_CACHE_LINE_INIT 31\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_CACHE_READ.\r
 \r
   Read tag and data of a cache line for diagnostic testing. It\r
@@ -2584,81 +2339,62 @@ typedef struct {
   Satcked Registers calling convention. It could be called at\r
   physical mode.\r
 \r
-  @param Index  Index of PAL_CACHE_READ within the list of PAL\r
-                procedures.\r
-\r
+  @param Index    Index of PAL_CACHE_READ within the list of PAL\r
+                  procedures.\r
   @param LineId   8-byte formatted value describing where in the\r
                   cache to read the data.\r
-\r
   @param Address  64-bit 8-byte aligned physical address from\r
                   which to read the data. The address must be an\r
                   implemented physical address on the processor\r
                   model with bit 63 set to zero.\r
 \r
-  @return R9  Right-justified value returned from the cache\r
-              line.\r
-\r
-  @return R10 The number of bits returned in data.\r
-\r
-  @return R11 The status of the cache line.\r
-\r
-\r
-\r
-  @return Status  1 - The word at address was found in the\r
+  @retval 1       The word at address was found in the\r
                   cache, but the line was invalid.\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
-\r
-  @return Status  -5 - The word at address was not found in the\r
+  @retval 0       Call completed without error\r
+  @retval -2      Invalid argument\r
+  @retval -3      Call completed with error.\r
+  @retval -5      The word at address was not found in the\r
                   cache.\r
-\r
-  @return Status  -7 - The operation requested is not supported\r
+  @retval -7      The operation requested is not supported\r
                   for this cache_type and level.\r
 \r
+  @return R9      Right-justified value returned from the cache\r
+                  line.\r
+  @return R10     The number of bits returned in data.\r
+  @return R11     The status of the cache line.\r
+\r
 **/\r
 #define PAL_CACHE_READ 259\r
 \r
 \r
 /**\r
+  PAL Procedure - PAL_CACHE_WRITE.\r
 \r
   Write tag and data of a cache for diagnostic testing. It is\r
   optional. The PAL procedure supports the Satcked Registers\r
   calling convention. It could be called at physical mode.\r
 \r
-  @param Index  Index of PAL_CACHE_WRITE within the list of PAL\r
-                procedures.\r
-\r
+  @param Index    Index of PAL_CACHE_WRITE within the list of PAL\r
+                  procedures.\r
   @param LineId   8-byte formatted value describing where in the\r
                   cache to write the data.\r
-\r
   @param Address  64-bit 8-byte aligned physical address at\r
                   which the data should be written. The address\r
                   must be an implemented physical address on the\r
                   processor model with bit 63 set to 0.\r
-\r
   @param Data     Unsigned 64-bit integer value to write into\r
                   the specified part of the cache.\r
 \r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
-\r
-\r
-  @return Status  -7 - The operation requested is not supported\r
+  @retval 0       Call completed without error\r
+  @retval -2      Invalid argument\r
+  @retval -3      Call completed with error.\r
+  @retval -7      The operation requested is not supported\r
                   for this cache_type and level.\r
 \r
 **/\r
 #define PAL_CACHE_WRITE 260\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_TEST_INFO.\r
 \r
   Returns alignment and size requirements needed for the memory\r
@@ -2668,9 +2404,8 @@ typedef struct {
   Static Registers calling convention. It could be called at\r
   physical mode.\r
 \r
-  @param Index  Index of PAL_TEST_INFO within the list of PAL\r
-                procedures.\r
-\r
+  @param Index      Index of PAL_TEST_INFO within the list of PAL\r
+                    procedures.\r
   @param TestPhase  Unsigned integer that specifies which phase\r
                     of the processor self-test information is\r
                     being requested on. A value of 0 indicates\r
@@ -2679,25 +2414,19 @@ typedef struct {
                     processor self-test. All other values are\r
                     reserved.\r
 \r
-  @return R9  Unsigned 64-bit integer denoting the number of\r
-              bytes of main memory needed to perform the second\r
-              phase of processor self-test.\r
-\r
-  @return R10   Unsigned 64-bit integer denoting the alignment\r
-                required for the memory buffer.\r
-\r
-  @return R11   48-bit wide bit-field indicating if control of\r
-                the processor self-tests is supported and which\r
-                bits of the test_control field are defined for\r
-                use.\r
-\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @retval 0         Call completed without error\r
+  @retval -2        Invalid argument\r
+  @retval -3        Call completed with error.\r
 \r
+  @return R9        Unsigned 64-bit integer denoting the number of\r
+                    bytes of main memory needed to perform the second\r
+                    phase of processor self-test.\r
+  @return R10       Unsigned 64-bit integer denoting the alignment\r
+                    required for the memory buffer.\r
+  @return R11       48-bit wide bit-field indicating if control of\r
+                    the processor self-tests is supported and which\r
+                    bits of the test_control field are defined for\r
+                    use.\r
 \r
 **/\r
 #define PAL_TEST_INFO 37\r
@@ -2850,45 +2579,35 @@ typedef struct {
 } PAL_TEST_CONTROL;\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_TEST_PROC.\r
 \r
   Perform late processor self test. It is required by IPF. The\r
   PAL procedure supports the Static Registers calling\r
   convention. It could be called at physical mode.\r
 \r
-  @param Index  Index of PAL_TEST_PROC within the list of PAL\r
-                procedures.\r
-\r
+  @param Index        Index of PAL_TEST_PROC within the list of PAL\r
+                      procedures.\r
   @param TestAddress  64-bit physical address of main memory\r
                       area to be used by processor self-test.\r
                       The memory region passed must be\r
                       cacheable, bit 63 must be zero.\r
+  @param TestInfo     Input argument specifying the size of the\r
+                      memory buffer passed and the phase of the\r
+                      processor self-test that should be run. See\r
+                      PAL_TEST_INFO.\r
+  @param TestParam    Input argument specifying the self-test\r
+                      control word and the allowable memory\r
+                      attributes that can be used with the memory\r
+                      buffer. See PAL_TEST_CONTROL.\r
 \r
-  @param TestInfo   Input argument specifying the size of the\r
-                    memory buffer passed and the phase of the\r
-                    processor self-test that should be run. See\r
-                    PAL_TEST_INFO.\r
-\r
-  @param TestParam  Input argument specifying the self-test\r
-                    control word and the allowable memory\r
-                    attributes that can be used with the memory\r
-                    buffer. See PAL_TEST_CONTROL.\r
-\r
-  @return R9  Formatted 8-byte value denoting the state of the\r
-              processor after self-test\r
-\r
-\r
-\r
-  @return Status  1 - Call completed without error, but hardware\r
-                  failures occurred during self-test.\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @retval 1           Call completed without error, but hardware\r
+                      failures occurred during self-test.\r
+  @retval 0           Call completed without error\r
+  @retval -2          Invalid argument\r
+  @retval -3          Call completed with error.\r
 \r
+  @return R9          Formatted 8-byte value denoting the state of the\r
+                      processor after self-test\r
 \r
 **/\r
 #define PAL_TEST_PROC 258\r
@@ -2909,7 +2628,6 @@ typedef struct {
 } PAL_PLATFORM_INFO;\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_COPY_INFO.\r
 \r
   Return information needed to relocate PAL procedures and PAL\r
@@ -2917,44 +2635,33 @@ typedef struct {
   supports the Static Registers calling convention. It could be\r
   called at physical mode.\r
 \r
-  @param Index  Index of PAL_COPY_INFO within the list of PAL\r
-                procedures.\r
-\r
-  @param CopyType   Unsigned integer denoting type of procedures\r
-                    for which copy information is requested.\r
-\r
-  @param PlatformInfo   8-byte formatted value describing the\r
-                        number of processors and the number of\r
-                        interrupt controllers currently enabled\r
-                        on the system. See PAL_PLATFORM_INFO.\r
-\r
-\r
+  @param Index              Index of PAL_COPY_INFO within the list of PAL\r
+                            procedures.\r
+  @param CopyType           Unsigned integer denoting type of procedures\r
+                            for which copy information is requested.\r
+  @param PlatformInfo       8-byte formatted value describing the\r
+                            number of processors and the number of\r
+                            interrupt controllers currently enabled\r
+                            on the system. See PAL_PLATFORM_INFO.\r
   @param McaProcStateInfo   Unsigned integer denoting the number\r
                             of bytes that SAL needs for the\r
                             min-state save area for each\r
                             processor.\r
 \r
+  @retval 0                 Call completed without error\r
+  @retval -2                Invalid argument\r
+  @retval -3                Call completed with error.\r
 \r
-\r
-  @return R9  Unsigned integer denoting the number of bytes of\r
-              PAL information that must be copied to main\r
-              memory.\r
-\r
-  @return R10 Unsigned integer denoting the starting alignment\r
-              of the data to be copied.\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
-\r
+  @return R9                Unsigned integer denoting the number of bytes of\r
+                            PAL information that must be copied to main\r
+                            memory.\r
+  @return R10               Unsigned integer denoting the starting alignment\r
+                            of the data to be copied.\r
 \r
 **/\r
 #define PAL_COPY_INFO 30\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_COPY_PAL.\r
 \r
   Relocate PAL procedures and PAL PMI code to memory. It is\r
@@ -2962,38 +2669,29 @@ typedef struct {
   Registers calling convention. It could be called at physical\r
   mode.\r
 \r
-  @param Index  Index of PAL_COPY_PAL within the list of PAL\r
-                procedures.\r
-\r
+  @param Index          Index of PAL_COPY_PAL within the list of PAL\r
+                        procedures.\r
   @param TargetAddress  Physical address of a memory buffer to\r
                         copy relocatable PAL procedures and PAL\r
                         PMI code.\r
+  @param AllocSize      Unsigned integer denoting the size of the\r
+                        buffer passed by SAL for the copy operation.\r
+  @param CopyOption     Unsigned integer indicating whether\r
+                        relocatable PAL code and PAL PMI code\r
+                        should be copied from firmware address\r
+                        space to main memory.\r
 \r
-  @param AllocSize  Unsigned integer denoting the size of the\r
-                    buffer passed by SAL for the copy operation.\r
-\r
-\r
-  @param CopyOption   Unsigned integer indicating whether\r
-                      relocatable PAL code and PAL PMI code\r
-                      should be copied from firmware address\r
-                      space to main memory.\r
-\r
-\r
-  @return R9  Unsigned integer denoting the offset of PAL_PROC\r
-              in the relocatable segment copied.\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @retval 0             Call completed without error\r
+  @retval -2            Invalid argument\r
+  @retval -3            Call completed with error.\r
 \r
+  @return R9            Unsigned integer denoting the offset of PAL_PROC\r
+                        in the relocatable segment copied.\r
 \r
 **/\r
 #define PAL_COPY_PAL 256\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_ENTER_IA_32_ENV.\r
 \r
   Enter IA-32 System environment. It is optional. The PAL\r
@@ -3019,7 +2717,7 @@ typedef struct {
                 procedures.\r
 \r
 \r
-  @return Status  The status is returned in GR4.\r
+  @retval  The status is returned in GR4.\r
                   -1 - Un-implemented procedure 0 JMPE detected\r
                   at privilege level\r
 \r
@@ -3063,26 +2761,20 @@ typedef struct {
 #define PAL_ENTER_IA_32_ENV 33\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_PMI_ENTRYPOINT.\r
 \r
   Register PMI memory entrypoints with processor. It is required\r
   by IPF. The PAL procedure supports the Stacked Registers\r
   calling convention. It could be called at physical mode.\r
 \r
-  @param Index  Index of PAL_PMI_ENTRYPOINT within the list of\r
-                PAL procedures.\r
-\r
+  @param Index        Index of PAL_PMI_ENTRYPOINT within the list of\r
+                      PAL procedures.\r
   @param SalPmiEntry  256-byte aligned physical address of SAL\r
                       PMI entrypoint in memory.\r
 \r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
-\r
+  @retval 0           Call completed without error\r
+  @retval -2          Invalid argument\r
+  @retval -3          Call completed with error.\r
 \r
 **/\r
 #define PAL_PMI_ENTRYPOINT 32\r
@@ -3103,45 +2795,34 @@ typedef struct {
 #define PAL_BRAND_INFO_ID_REQUEST  0\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_BRAND_INFO.\r
 \r
   Provides processor branding information. It is optional by\r
   IPF. The PAL procedure supports the Stacked Registers calling\r
   convention. It could be called at physical and Virtual mode.\r
 \r
-\r
-  @param Index  Index of PAL_BRAND_INFO within the list of PAL\r
-                procedures.\r
-\r
+  @param Index        Index of PAL_BRAND_INFO within the list of PAL\r
+                      procedures.\r
   @param InfoRequest  Unsigned 64-bit integer specifying the\r
                       information that is being requested. (See\r
                       PAL_BRAND_INFO_ID_REQUEST)\r
+  @param Address      Unsigned 64-bit integer specifying the\r
+                      address of the 128-byte block to which the\r
+                      processor brand string shall be written.\r
 \r
-  @param Address    Unsigned 64-bit integer specifying the\r
-                    address of the 128-byte block to which the\r
-                    processor brand string shall be written.\r
-\r
-\r
-  @return R9  Brand information returned. The format of this\r
-              value is dependent on the input values passed.\r
-\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -1 - Unimplemented procedure\r
-\r
-  @return Status  -2 - Invalid argument\r
+  @retval 0           Call completed without error\r
+  @retval -1          Unimplemented procedure\r
+  @retval -2          Invalid argument\r
+  @retval -3          Call completed with error.\r
+  @retval -6          Input argument is not implemented.\r
 \r
-  @return Status  -3 - Call completed with error.\r
-\r
-  @return Status  -6 - Input argument is not implemented.\r
+  @return R9          Brand information returned. The format of this\r
+                      value is dependent on the input values passed.\r
 \r
 **/\r
 #define PAL_BRAND_INFO  274\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_GET_HW_POLICY.\r
 \r
   Returns the current hardware resource sharing policy of the\r
@@ -3150,9 +2831,8 @@ typedef struct {
   physical and Virtual mode.\r
 \r
 \r
-  @param Index  Index of PAL_GET_HW_POLICY within the list of PAL\r
-                procedures.\r
-\r
+  @param Index            Index of PAL_GET_HW_POLICY within the list of PAL\r
+                          procedures.\r
   @param ProcessorNumber  Unsigned 64-bit integer that specifies\r
                           for which logical processor\r
                           information is being requested. This\r
@@ -3164,28 +2844,20 @@ typedef struct {
                           sharing policy, which is returned by\r
                           the R10 return value.\r
 \r
+  @retval 0               Call completed without error\r
+  @retval -1              Unimplemented procedure\r
+  @retval -2              Invalid argument\r
+  @retval -3              Call completed with error.\r
+  @retval -9              Call requires PAL memory buffer.\r
 \r
-  @return R9  Unsigned 64-bit integer representing the current\r
-              hardware resource sharing policy.\r
-\r
-  @return R10   Unsigned 64-bit integer that returns the number\r
-                of logical processors impacted by the policy\r
-                input argument.\r
-\r
-  @return R11   Unsigned 64-bit integer containing the logical\r
-                address of one of the logical processors\r
-                impacted by policy modification.\r
-\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -1 - Unimplemented procedure\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
-\r
-  @return Status  -9 - Call requires PAL memory buffer.\r
+  @return R9              Unsigned 64-bit integer representing the current\r
+                          hardware resource sharing policy.\r
+  @return R10             Unsigned 64-bit integer that returns the number\r
+                          of logical processors impacted by the policy\r
+                          input argument.\r
+  @return R11             Unsigned 64-bit integer containing the logical\r
+                          address of one of the logical processors\r
+                          impacted by policy modification.\r
 \r
 **/\r
 #define PAL_GET_HW_POLICY   48\r
@@ -3200,7 +2872,6 @@ typedef struct {
 #define PAL_SET_HW_POLICY_EXCLUSIVE_HIGH_PRIORITY   3\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_SET_HW_POLICY.\r
 \r
   Sets the current hardware resource sharing policy of the\r
@@ -3208,29 +2879,21 @@ typedef struct {
   the Static Registers calling convention. It could be called at\r
   physical and Virtual mode.\r
 \r
-\r
-  @param Index  Index of PAL_SET_HW_POLICY within the list of PAL\r
-                procedures.\r
-\r
+  @param Index    Index of PAL_SET_HW_POLICY within the list of PAL\r
+                  procedures.\r
   @param Policy   Unsigned 64-bit integer specifying the hardware\r
                   resource sharing policy the caller is setting.\r
                   See Value of PAL_SET_HW_POLICY.Policy above.\r
 \r
-\r
-  @return Status  1 - Call completed successfully but could not\r
-                      change the hardware policy since a\r
-                      competing logical processor is set in\r
-                      exclusive high priority.\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -1 - Unimplemented procedure\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
-\r
-  @return Status  -9 - Call requires PAL memory buffer.\r
+  @retval 1       Call completed successfully but could not\r
+                  change the hardware policy since a\r
+                  competing logical processor is set in\r
+                  exclusive high priority.\r
+  @retval 0       Call completed without error\r
+  @retval -1      Unimplemented procedure\r
+  @retval -2      Invalid argument\r
+  @retval -3      Call completed with error.\r
+  @retval -9      Call requires PAL memory buffer.\r
 \r
 **/\r
 #define PAL_SET_HW_POLICY   49\r
@@ -3421,7 +3084,6 @@ typedef struct {
 } PAL_MC_ERROR_DATA_BUFFER_TLB;\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_MC_ERROR_INJECT.\r
 \r
   Injects the requested processor error or returns information\r
@@ -3430,52 +3092,40 @@ typedef struct {
   procedure supports the Stacked Registers calling convention.\r
   It could be called at physical and Virtual mode.\r
 \r
-\r
-  @param Index  Index of PAL_MC_ERROR_INJECT within the list of PAL\r
-                procedures.\r
-\r
-  @param ErrorTypeInfo  Unsigned 64-bit integer specifying the\r
-                        first level error information which\r
-                        identifies the error structure and\r
-                        corresponding structure hierarchy, and\r
-                        the error severity.\r
-\r
+  @param Index            Index of PAL_MC_ERROR_INJECT within the list of PAL\r
+                          procedures.\r
+  @param ErrorTypeInfo    Unsigned 64-bit integer specifying the\r
+                          first level error information which\r
+                          identifies the error structure and\r
+                          corresponding structure hierarchy, and\r
+                          the error severity.\r
   @param ErrorStructInfo  Unsigned 64-bit integer identifying\r
                           the optional structure specific\r
                           information that provides the  second\r
                           level details for the requested error.\r
-\r
   @param ErrorDataBuffer  64-bit physical address of a buffer\r
                           providing additional parameters for\r
                           the requested error. The address of\r
                           this buffer must be 8-byte aligned.\r
 \r
-  @return R9    64-bit vector specifying the supported error\r
-                injection capabilities for the input argument\r
-                combination of struct_hier, err_struct and\r
-                err_sev fields in ErrorTypeInfo.\r
-\r
-  @return R10   64-bit vector specifying the architectural\r
-                resources that are used by the procedure.\r
-\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -1 - Unimplemented procedure\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
-\r
-  @return Status  -4 - Call completed with error; the requested\r
-                  error could not be injected due to failure in\r
-                  locating the target location in the specified\r
-                  structure.\r
-\r
-  @return Status  -5 - Argument was valid, but requested error\r
-                  injection capability is not supported.\r
-\r
-  @return Status  -9 - Call requires PAL memory buffer.\r
+  @retval 0               Call completed without error\r
+  @retval -1              Unimplemented procedure\r
+  @retval -2              Invalid argument\r
+  @retval -3              Call completed with error.\r
+  @retval -4              Call completed with error; the requested\r
+                          error could not be injected due to failure in\r
+                          locating the target location in the specified\r
+                          structure.\r
+  @retval -5              Argument was valid, but requested error\r
+                          injection capability is not supported.\r
+  @retval -9              Call requires PAL memory buffer.\r
+\r
+  @return R9              64-bit vector specifying the supported error\r
+                          injection capabilities for the input argument\r
+                          combination of struct_hier, err_struct and\r
+                          err_sev fields in ErrorTypeInfo.\r
+  @return R10             64-bit vector specifying the architectural\r
+                          resources that are used by the procedure.\r
 \r
 **/\r
 #define PAL_MC_ERROR_INJECT 276\r
@@ -3490,7 +3140,6 @@ typedef struct {
 #define PAL_GET_PSTATE_NOW                    3\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_GET_PSTATE.\r
 \r
   Returns the performance index of the processor. It is optional\r
@@ -3498,13 +3147,20 @@ typedef struct {
   calling convention. It could be called at physical and Virtual\r
   mode.\r
 \r
-\r
   @param Index  Index of PAL_GET_PSTATE within the list of PAL\r
                 procedures.\r
-\r
   @param Type   Type of performance_index value to be returned\r
                 by this procedure.See PAL_GET_PSTATE.Type above.\r
 \r
+  @retval 1     Call completed without error, but accuracy\r
+                of performance index has been impacted by a\r
+                thermal throttling event, or a\r
+                hardware-initiated event.\r
+  @retval 0     Call completed without error\r
+  @retval -1    Unimplemented procedure\r
+  @retval -2    Invalid argument\r
+  @retval -3    Call completed with error.\r
+  @retval -9    Call requires PAL memory buffer.\r
 \r
   @return R9    Unsigned integer denoting the processor\r
                 performance for the time duration since the last\r
@@ -3513,21 +3169,6 @@ typedef struct {
                 relative to the performance index of the highest\r
                 available P-state.\r
 \r
-  @return Status  1 - Call completed without error, but accuracy\r
-                  of performance index has been impacted by a\r
-                  thermal throttling event, or a\r
-                  hardware-initiated event.\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -1 - Unimplemented procedure\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
-\r
-  @return Status  -9 - Call requires PAL memory buffer.\r
-\r
 **/\r
 #define PAL_GET_PSTATE      262\r
 \r
@@ -3547,7 +3188,6 @@ typedef struct {
 \r
 \r
 /**\r
-\r
   PAL Procedure - PAL_PSTATE_INFO.\r
 \r
   Returns information about the P-states supported by the\r
@@ -3555,35 +3195,26 @@ typedef struct {
   the Static Registers calling convention. It could be called\r
   at physical and Virtual mode.\r
 \r
-\r
-  @param Index  Index of PAL_PSTATE_INFO within the list of PAL\r
-                procedures.\r
-\r
+  @param Index          Index of PAL_PSTATE_INFO within the list of PAL\r
+                        procedures.\r
   @param PStateBuffer   64-bit pointer to a 256-byte buffer\r
                         aligned on an 8-byte boundary. See\r
                         PAL_PSTATE_INFO_BUFFER above.\r
 \r
+  @retval 0             Call completed without error\r
+  @retval -1            Unimplemented procedure\r
+  @retval -2            Invalid argument\r
+  @retval -3            Call completed with error.\r
 \r
-  @return R9    Unsigned integer denoting the number of P-states\r
-                supported. The maximum value of this field is 16.\r
-\r
-  @return R10   Dependency domain information\r
-\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -1 - Unimplemented procedure\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
+  @return R9            Unsigned integer denoting the number of P-states\r
+                        supported. The maximum value of this field is 16.\r
+  @return R10           Dependency domain information\r
 \r
 **/\r
 #define PAL_PSTATE_INFO     44\r
 \r
 \r
 /**\r
-\r
   PAL Procedure - PAL_SET_PSTATE.\r
 \r
   To request a processor transition to a given P-state. It is\r
@@ -3591,39 +3222,26 @@ typedef struct {
   Registers calling convention. It could be called at physical\r
   and Virtual mode.\r
 \r
-\r
-  @param Index  Index of PAL_SET_PSTATE within the list of PAL\r
-                procedures.\r
-\r
-  @param PState   Unsigned integer denoting the processor\r
-                  P-state being requested.\r
-\r
+  @param Index        Index of PAL_SET_PSTATE within the list of PAL\r
+                      procedures.\r
+  @param PState       Unsigned integer denoting the processor\r
+                      P-state being requested.\r
   @param ForcePState  Unsigned integer denoting whether the\r
                       P-state change should be forced for the\r
                       logical processor.\r
 \r
-\r
-\r
-\r
-\r
-  @return Status  1 - Call completed without error, but\r
-                  transition request was not accepted\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -1 - Unimplemented procedure\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
-\r
-  @return Status  -9 - Call requires PAL memory buffer.\r
+  @retval 1           Call completed without error, but\r
+                      transition request was not accepted\r
+  @retval 0           Call completed without error\r
+  @retval -1          Unimplemented procedure\r
+  @retval -2          Invalid argument\r
+  @retval -3          Call completed with error.\r
+  @retval -9          Call requires PAL memory buffer.\r
 \r
 **/\r
 #define PAL_SET_PSTATE      263\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_SHUTDOWN.\r
 \r
   Put the logical processor into a low power state which can be\r
@@ -3631,23 +3249,18 @@ typedef struct {
   procedure supports the Static Registers calling convention. It\r
   could be called at physical mode.\r
 \r
-\r
-  @param Index  Index of PAL_SHUTDOWN within the list of PAL\r
-                procedures.\r
-\r
+  @param Index            Index of PAL_SHUTDOWN within the list of PAL\r
+                          procedures.\r
   @param NotifyPlatform   8-byte aligned physical address\r
                           pointer providing details on how to\r
                           optionally notify the platform that\r
                           the processor is entering a shutdown\r
                           state.\r
 \r
-  @return Status  -1 - Unimplemented procedure\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
-\r
-  @return Status  -9 - Call requires PAL memory buffer.\r
+  @retval -1              Unimplemented procedure\r
+  @retval -2              Invalid argument\r
+  @retval -3              Call completed with error.\r
+  @retval -9              Call requires PAL memory buffer.\r
 \r
 **/\r
 #define PAL_SHUTDOWN        45\r
@@ -3664,7 +3277,6 @@ typedef struct {
 } PAL_MEMORY_CONTROL_WORD;\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_MEMORY_BUFFER.\r
 \r
   Provides cacheable memory to PAL for exclusive use during\r
@@ -3672,43 +3284,33 @@ typedef struct {
   Static Registers calling convention. It could be called at\r
   physical mode.\r
 \r
-\r
-  @param Index  Index of PAL_MEMORY_BUFFER within the list of PAL\r
-                procedures.\r
-\r
+  @param Index        Index of PAL_MEMORY_BUFFER within the list of PAL\r
+                      procedures.\r
   @param BaseAddress  Physical address of the memory buffer\r
                       allocated for PAL use.\r
-\r
-  @param AllocSize  Unsigned integer denoting the size of the\r
-                    memory buffer.\r
-\r
+  @param AllocSize    Unsigned integer denoting the size of the\r
+                      memory buffer.\r
   @param ControlWord  Formatted bit vector that provides control\r
                       options for this procedure. See\r
                       PAL_MEMORY_CONTROL_WORD above.\r
 \r
-  @return R9    Returns the minimum size of the memory buffer\r
-                required if the alloc_size input argument was\r
-                not large enough.\r
-\r
-  @return Status  1 - Call has not completed a buffer relocation\r
-                  due to a pending interrupt\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -1 - Unimplemented procedure\r
-\r
-  @return Status  -2 - Invalid argument\r
+  @retval 1           Call has not completed a buffer relocation\r
+                      due to a pending interrupt\r
+  @retval 0           Call completed without error\r
+  @retval -1          Unimplemented procedure\r
+  @retval -2          Invalid argument\r
+  @retval -3          Call completed with error.\r
+  @retval -9          Call requires PAL memory buffer.\r
 \r
-  @return Status  -3 - Call completed with error.\r
-\r
-  @return Status  -9 - Call requires PAL memory buffer.\r
+  @return R9          Returns the minimum size of the memory buffer\r
+                      required if the alloc_size input argument was\r
+                      not large enough.\r
 \r
 **/\r
 #define PAL_MEMORY_BUFFER   277\r
 \r
 \r
 /**\r
-\r
   PAL Procedure - PAL_VP_CREATE.\r
 \r
   Initializes a new vpd for the operation of a new virtual\r
@@ -3716,30 +3318,21 @@ typedef struct {
   The PAL procedure supports the Stacked Registers calling\r
   convention. It could be called at Virtual mode.\r
 \r
-\r
-  @param Index  Index of PAL_VP_CREATE within the list of PAL\r
-                procedures.\r
-\r
-  @param Vpd    64-bit host virtual pointer to the Virtual\r
-                Processor Descriptor (VPD).\r
-\r
-  @param HostIva  64-bit host virtual pointer to the host IVT\r
-                  for the virtual processor\r
-\r
+  @param Index            Index of PAL_VP_CREATE within the list of PAL\r
+                          procedures.\r
+  @param Vpd              64-bit host virtual pointer to the Virtual\r
+                          Processor Descriptor (VPD).\r
+  @param HostIva          64-bit host virtual pointer to the host IVT\r
+                          for the virtual processor\r
   @param OptionalHandler  64-bit non-zero host-virtual pointer\r
                           to an optional handler for\r
                           virtualization intercepts.\r
 \r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -1 - Unimplemented procedure\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
-\r
-  @return Status  -9 - Call requires PAL memory buffer.\r
+  @retval 0               Call completed without error\r
+  @retval -1              Unimplemented procedure\r
+  @retval -2              Invalid argument\r
+  @retval -3              Call completed with error.\r
+  @retval -9              Call requires PAL memory buffer.\r
 \r
 **/\r
 #define PAL_VP_CREATE       265\r
@@ -3756,7 +3349,6 @@ typedef struct {
 } PAL_VP_ENV_INFO_RETURN;\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_VP_ENV_INFO.\r
 \r
   Returns the parameters needed to enter a virtual environment.\r
@@ -3764,42 +3356,33 @@ typedef struct {
   Registers calling convention. It could be called at Virtual\r
   mode.\r
 \r
-\r
-  @param Index  Index of PAL_VP_ENV_INFO within the list of PAL\r
-                procedures.\r
-\r
-  @param Vpd    64-bit host virtual pointer to the Virtual\r
-                Processor Descriptor (VPD).\r
-\r
-  @param HostIva  64-bit host virtual pointer to the host IVT\r
-                  for the virtual processor\r
-\r
+  @param Index            Index of PAL_VP_ENV_INFO within the list of PAL\r
+                          procedures.\r
+  @param Vpd              64-bit host virtual pointer to the Virtual\r
+                          Processor Descriptor (VPD).\r
+  @param HostIva          64-bit host virtual pointer to the host IVT\r
+                          for the virtual processor\r
   @param OptionalHandler  64-bit non-zero host-virtual pointer\r
                           to an optional handler for\r
                           virtualization intercepts.\r
-  @return R9    Unsigned integer denoting the number of bytes\r
-                required by the PAL virtual environment buffer\r
-                during PAL_VP_INIT_ENV\r
-\r
-  @return R10   64-bit vector of virtual environment\r
-                information. See PAL_VP_ENV_INFO_RETURN.\r
-\r
-\r
-  @return Status  0 - Call completed without error\r
 \r
-  @return Status  -1 - Unimplemented procedure\r
+  @retval 0               Call completed without error\r
+  @retval -1              Unimplemented procedure\r
+  @retval -2              Invalid argument\r
+  @retval -3              Call completed with error.\r
+  @retval -9              Call requires PAL memory buffer.\r
 \r
-  @return Status  -2 - Invalid argument\r
+  @return R9              Unsigned integer denoting the number of bytes\r
+                          required by the PAL virtual environment buffer\r
+                          during PAL_VP_INIT_ENV\r
+  @return R10             64-bit vector of virtual environment\r
+                          information. See PAL_VP_ENV_INFO_RETURN.\r
 \r
-  @return Status  -3 - Call completed with error.\r
-\r
-  @return Status  -9 - Call requires PAL memory buffer.\r
 \r
 **/\r
 #define PAL_VP_ENV_INFO       266\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_VP_EXIT_ENV.\r
 \r
   Allows a logical processor to exit a virtual environment.\r
@@ -3807,22 +3390,16 @@ typedef struct {
   Registers calling convention. It could be called at Virtual\r
   mode.\r
 \r
-\r
   @param Index  Index of PAL_VP_EXIT_ENV within the list of PAL\r
                 procedures.\r
-\r
   @param Iva    Optional 64-bit host virtual pointer to the IVT\r
                 when this procedure is done\r
 \r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -1 - Unimplemented procedure\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
-\r
-  @return Status  -9 - Call requires PAL memory buffer.\r
+  @retval 0     Call completed without error\r
+  @retval -1    Unimplemented procedure\r
+  @retval -2    Invalid argument\r
+  @retval -3    Call completed with error.\r
+  @retval -9    Call requires PAL memory buffer.\r
 \r
 **/\r
 #define PAL_VP_EXIT_ENV       267\r
@@ -3830,7 +3407,6 @@ typedef struct {
 \r
 \r
 /**\r
-\r
   PAL Procedure - PAL_VP_INIT_ENV.\r
 \r
   Allows a logical processor to enter a virtual environment. It\r
@@ -3838,13 +3414,10 @@ typedef struct {
   Registers calling convention. It could be called at Virtual\r
   mode.\r
 \r
-\r
-  @param Index  Index of PAL_VP_INIT_ENV within the list of PAL\r
-                procedures.\r
-\r
+  @param Index          Index of PAL_VP_INIT_ENV within the list of PAL\r
+                        procedures.\r
   @param ConfigOptions  64-bit vector of global configuration\r
                         settings.\r
-\r
   @param PhysicalBase   Host physical base address of a block of\r
                         contiguous physical memory for the PAL\r
                         virtual environment buffer 1) This\r
@@ -3853,40 +3426,34 @@ typedef struct {
                         processor to enter the environment will\r
                         initialize the physical block for\r
                         virtualization operations.\r
+  @param VirtualBase    Host virtual base address of the\r
+                        corresponding physical memory block for\r
+                        the PAL virtual environment buffer : The\r
+                        VMM must maintain the host virtual to host\r
+                        physical data and instruction translations\r
+                        in TRs for addresses within the allocated\r
+                        address space. Logical processors in this\r
+                        virtual environment will use this address\r
+                        when transitioning to virtual mode\r
+                        operations.\r
+\r
+  @retval 0             Call completed without error\r
+  @retval -1            Unimplemented procedure\r
+  @retval -2            Invalid argument\r
+  @retval -3            Call completed with error.\r
+  @retval -9            Call requires PAL memory buffer.\r
+\r
+  @return R9            Virtualization Service Address - VSA specifies\r
+                        the virtual base address of the PAL\r
+                        virtualization services in this virtual\r
+                        environment.\r
 \r
-  @param VirtualBase  Host virtual base address of the\r
-                      corresponding physical memory block for\r
-                      the PAL virtual environment buffer : The\r
-                      VMM must maintain the host virtual to host\r
-                      physical data and instruction translations\r
-                      in TRs for addresses within the allocated\r
-                      address space. Logical processors in this\r
-                      virtual environment will use this address\r
-                      when transitioning to virtual mode\r
-                      operations.\r
-\r
-  @return R9    Virtualization Service Address - VSA specifies\r
-                the virtual base address of the PAL\r
-                virtualization services in this virtual\r
-                environment.\r
-\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -1 - Unimplemented procedure\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
-\r
-  @return Status  -9 - Call requires PAL memory buffer.\r
 \r
 **/\r
 #define PAL_VP_INIT_ENV       268\r
 \r
 \r
 /**\r
-\r
   PAL Procedure - PAL_VP_REGISTER.\r
 \r
   Register a different host IVT and/or a different optional\r
@@ -3895,36 +3462,27 @@ typedef struct {
   supports the Stacked Registers calling convention. It could be\r
   called at Virtual mode.\r
 \r
-\r
-  @param Index  Index of PAL_VP_REGISTER within the list of PAL\r
-                procedures.\r
-\r
-  @param Vpd    64-bit host virtual pointer to the Virtual\r
-                Processor Descriptor (VPD) host_iva 64-bit host\r
-                virtual pointer to the host IVT for the virtual\r
-                processor\r
-\r
+  @param Index            Index of PAL_VP_REGISTER within the list of PAL\r
+                          procedures.\r
+  @param Vpd              64-bit host virtual pointer to the Virtual\r
+                          Processor Descriptor (VPD) host_iva 64-bit host\r
+                          virtual pointer to the host IVT for the virtual\r
+                          processor\r
   @param OptionalHandler  64-bit non-zero host-virtual pointer\r
                           to an optional handler for\r
                           virtualization intercepts.\r
 \r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -1 - Unimplemented procedure\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
-\r
-  @return Status  -9 - Call requires PAL memory buffer.\r
+  @retval 0               Call completed without error\r
+  @retval -1              Unimplemented procedure\r
+  @retval -2              Invalid argument\r
+  @retval -3              Call completed with error.\r
+  @retval -9              Call requires PAL memory buffer.\r
 \r
 **/\r
 #define PAL_VP_REGISTER       269\r
 \r
 \r
 /**\r
-\r
   PAL Procedure - PAL_VP_RESTORE.\r
 \r
   Restores virtual processor state for the specified vpd on the\r
@@ -3932,35 +3490,26 @@ typedef struct {
   supports the Stacked Registers calling convention. It could be\r
   called at Virtual mode.\r
 \r
-\r
-  @param Index  Index of PAL_VP_RESTORE within the list of PAL\r
-                procedures.\r
-\r
-  @param Vpd    64-bit host virtual pointer to the Virtual\r
-                Processor Descriptor (VPD) host_iva 64-bit host\r
-                virtual pointer to the host IVT for the virtual\r
-                processor\r
-\r
+  @param Index      Index of PAL_VP_RESTORE within the list of PAL\r
+                    procedures.\r
+  @param Vpd        64-bit host virtual pointer to the Virtual\r
+                    Processor Descriptor (VPD) host_iva 64-bit host\r
+                    virtual pointer to the host IVT for the virtual\r
+                    processor\r
   @param PalVector  Vector specifies PAL procedure\r
                     implementation-specific state to be\r
                     restored.\r
 \r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -1 - Unimplemented procedure\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
-\r
-  @return Status  -9 - Call requires PAL memory buffer.\r
+  @retval 0         Call completed without error\r
+  @retval -1        Unimplemented procedure\r
+  @retval -2        Invalid argument\r
+  @retval -3        Call completed with error.\r
+  @retval -9        Call requires PAL memory buffer.\r
 \r
 **/\r
 #define PAL_VP_RESTORE       270\r
 \r
 /**\r
-\r
   PAL Procedure - PAL_VP_SAVE.\r
 \r
   Saves virtual processor state for the specified vpd on the\r
@@ -3968,36 +3517,27 @@ typedef struct {
   supports the Stacked Registers calling convention. It could be\r
   called at Virtual mode.\r
 \r
-\r
-  @param Index  Index of PAL_VP_SAVE within the list of PAL\r
-                procedures.\r
-\r
-  @param Vpd    64-bit host virtual pointer to the Virtual\r
-                Processor Descriptor (VPD) host_iva 64-bit host\r
-                virtual pointer to the host IVT for the virtual\r
-                processor\r
-\r
+  @param Index      Index of PAL_VP_SAVE within the list of PAL\r
+                    procedures.\r
+  @param Vpd        64-bit host virtual pointer to the Virtual\r
+                    Processor Descriptor (VPD) host_iva 64-bit host\r
+                    virtual pointer to the host IVT for the virtual\r
+                    processor\r
   @param PalVector  Vector specifies PAL procedure\r
                     implementation-specific state to be\r
                     restored.\r
 \r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -1 - Unimplemented procedure\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
-\r
-  @return Status  -9 - Call requires PAL memory buffer.\r
+  @retval 0         Call completed without error\r
+  @retval -1        Unimplemented procedure\r
+  @retval -2        Invalid argument\r
+  @retval -3        Call completed with error.\r
+  @retval -9        Call requires PAL memory buffer.\r
 \r
 **/\r
 #define PAL_VP_SAVE       271\r
 \r
 \r
 /**\r
-\r
   PAL Procedure - PAL_VP_TERMINATE.\r
 \r
   Terminates operation for the specified virtual processor. It\r
@@ -4005,25 +3545,18 @@ typedef struct {
   Registers calling convention. It could be called at Virtual\r
   mode.\r
 \r
-\r
   @param Index  Index of PAL_VP_TERMINATE within the list of PAL\r
                 procedures.\r
+  @param Vpd    64-bit host virtual pointer to the Virtual\r
+                Processor Descriptor (VPD)\r
+  @param Iva    Optional 64-bit host virtual pointer to the IVT\r
+                when this procedure is done.\r
 \r
-  @param Vpd  64-bit host virtual pointer to the Virtual\r
-              Processor Descriptor (VPD)\r
-\r
-  @param Iva  Optional 64-bit host virtual pointer to the IVT\r
-              when this procedure is done.\r
-\r
-  @return Status  0 - Call completed without error\r
-\r
-  @return Status  -1 - Unimplemented procedure\r
-\r
-  @return Status  -2 - Invalid argument\r
-\r
-  @return Status  -3 - Call completed with error.\r
-\r
-  @return Status  -9 - Call requires PAL memory buffer.\r
+  @retval 0     Call completed without error\r
+  @retval -1    Unimplemented procedure\r
+  @retval -2    Invalid argument\r
+  @retval -3    Call completed with error.\r
+  @retval -9    Call requires PAL memory buffer.\r
 \r
 **/\r
 #define PAL_VP_TERMINATE       272\r
@@ -4046,10 +3579,10 @@ typedef struct {
   returned or undefined result may occur during the execution of the procedure.\r
   This function is only available on IPF.\r
 \r
-  @param Index - The PAL procedure Index number.\r
-  @param Arg2 - The 2nd parameter for PAL procedure calls.\r
-  @param Arg3  - The 3rd parameter for PAL procedure calls.\r
-  @param Arg4  - The 4th parameter for PAL procedure calls.\r
+  @param Index  The PAL procedure Index number.\r
+  @param Arg2   The 2nd parameter for PAL procedure calls.\r
+  @param Arg3   The 3rd parameter for PAL procedure calls.\r
+  @param Arg4   The 4th parameter for PAL procedure calls.\r
 \r
   @return structure returned from the PAL Call procedure, including the status and return value.\r
 \r