UefiCpuPkg/AtomMsr.h: add MSR reference from SDM in comment

Cc: Michael Kinney <michael.d.kinney@intel.com>
Cc: Feng Tian <feng.tian@intel.com>
Cc: Giri P Mudusuru <giri.p.mudusuru@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jeff Fan <jeff.fan@intel.com>
Reviewed-by: Giri P Mudusuru <giri.p.mudusuru@intel.com>

diff --git a/UefiCpuPkg/Include/Register/Msr/AtomMsr.h b/UefiCpuPkg/Include/Register/Msr/AtomMsr.h
index 01e0d9a7a6af82cbaea9310eb7135ede7e6248cc..25e09276f87568b008048e52feceeb28890a45ec 100644 (file)
--- a/UefiCpuPkg/Include/Register/Msr/AtomMsr.h
+++ b/UefiCpuPkg/Include/Register/Msr/AtomMsr.h
@@ -41,6 +41,7 @@
 \r
   Msr.Uint64 = AsmReadMsr64 (MSR_ATOM_PLATFORM_ID);\r
   @endcode\r
+  @note MSR_ATOM_PLATFORM_ID is defined as MSR_PLATFORM_ID in SDM.\r
 **/\r
 #define MSR_ATOM_PLATFORM_ID                     0x00000017\r
 \r
@@ -88,6 +89,7 @@ typedef union {
   Msr.Uint64 = AsmReadMsr64 (MSR_ATOM_EBL_CR_POWERON);\r
   AsmWriteMsr64 (MSR_ATOM_EBL_CR_POWERON, Msr.Uint64);\r
   @endcode\r
+  @note MSR_ATOM_EBL_CR_POWERON is defined as MSR_EBL_CR_POWERON in SDM.\r
 **/\r
 #define MSR_ATOM_EBL_CR_POWERON                  0x0000002A\r
 \r
@@ -193,6 +195,14 @@ typedef union {
   Msr = AsmReadMsr64 (MSR_ATOM_LASTBRANCH_0_FROM_IP);\r
   AsmWriteMsr64 (MSR_ATOM_LASTBRANCH_0_FROM_IP, Msr);\r
   @endcode\r
+  @note MSR_ATOM_LASTBRANCH_0_FROM_IP is defined as MSR_LASTBRANCH_0_FROM_IP in SDM.\r
+        MSR_ATOM_LASTBRANCH_1_FROM_IP is defined as MSR_LASTBRANCH_1_FROM_IP in SDM.\r
+        MSR_ATOM_LASTBRANCH_2_FROM_IP is defined as MSR_LASTBRANCH_2_FROM_IP in SDM.\r
+        MSR_ATOM_LASTBRANCH_3_FROM_IP is defined as MSR_LASTBRANCH_3_FROM_IP in SDM.\r
+        MSR_ATOM_LASTBRANCH_4_FROM_IP is defined as MSR_LASTBRANCH_4_FROM_IP in SDM.\r
+        MSR_ATOM_LASTBRANCH_5_FROM_IP is defined as MSR_LASTBRANCH_5_FROM_IP in SDM.\r
+        MSR_ATOM_LASTBRANCH_6_FROM_IP is defined as MSR_LASTBRANCH_6_FROM_IP in SDM.\r
+        MSR_ATOM_LASTBRANCH_7_FROM_IP is defined as MSR_LASTBRANCH_7_FROM_IP in SDM.\r
   @{\r
 **/\r
 #define MSR_ATOM_LASTBRANCH_0_FROM_IP            0x00000040\r
@@ -223,6 +233,14 @@ typedef union {
   Msr = AsmReadMsr64 (MSR_ATOM_LASTBRANCH_0_TO_IP);\r
   AsmWriteMsr64 (MSR_ATOM_LASTBRANCH_0_TO_IP, Msr);\r
   @endcode\r
+  @note MSR_ATOM_LASTBRANCH_0_TO_IP is defined as MSR_LASTBRANCH_0_TO_IP in SDM.\r
+        MSR_ATOM_LASTBRANCH_1_TO_IP is defined as MSR_LASTBRANCH_1_TO_IP in SDM.\r
+        MSR_ATOM_LASTBRANCH_2_TO_IP is defined as MSR_LASTBRANCH_2_TO_IP in SDM.\r
+        MSR_ATOM_LASTBRANCH_3_TO_IP is defined as MSR_LASTBRANCH_3_TO_IP in SDM.\r
+        MSR_ATOM_LASTBRANCH_4_TO_IP is defined as MSR_LASTBRANCH_4_TO_IP in SDM.\r
+        MSR_ATOM_LASTBRANCH_5_TO_IP is defined as MSR_LASTBRANCH_5_TO_IP in SDM.\r
+        MSR_ATOM_LASTBRANCH_6_TO_IP is defined as MSR_LASTBRANCH_6_TO_IP in SDM.\r
+        MSR_ATOM_LASTBRANCH_7_TO_IP is defined as MSR_LASTBRANCH_7_TO_IP in SDM.\r
   @{\r
 **/\r
 #define MSR_ATOM_LASTBRANCH_0_TO_IP              0x00000060\r
@@ -252,6 +270,7 @@ typedef union {
 \r
   Msr.Uint64 = AsmReadMsr64 (MSR_ATOM_FSB_FREQ);\r
   @endcode\r
+  @note MSR_ATOM_FSB_FREQ is defined as MSR_FSB_FREQ in SDM.\r
 **/\r
 #define MSR_ATOM_FSB_FREQ                        0x000000CD\r
 \r
@@ -310,6 +329,7 @@ typedef union {
   Msr.Uint64 = AsmReadMsr64 (MSR_ATOM_BBL_CR_CTL3);\r
   AsmWriteMsr64 (MSR_ATOM_BBL_CR_CTL3, Msr.Uint64);\r
   @endcode\r
+  @note MSR_ATOM_BBL_CR_CTL3 is defined as MSR_BBL_CR_CTL3 in SDM.\r
 **/\r
 #define MSR_ATOM_BBL_CR_CTL3                     0x0000011E\r
 \r
@@ -368,6 +388,7 @@ typedef union {
   Msr.Uint64 = AsmReadMsr64 (MSR_ATOM_PERF_STATUS);\r
   AsmWriteMsr64 (MSR_ATOM_PERF_STATUS, Msr.Uint64);\r
   @endcode\r
+  @note MSR_ATOM_PERF_STATUS is defined as MSR_PERF_STATUS in SDM.\r
 **/\r
 #define MSR_ATOM_PERF_STATUS                     0x00000198\r
 \r
@@ -415,6 +436,7 @@ typedef union {
   Msr.Uint64 = AsmReadMsr64 (MSR_ATOM_THERM2_CTL);\r
   AsmWriteMsr64 (MSR_ATOM_THERM2_CTL, Msr.Uint64);\r
   @endcode\r
+  @note MSR_ATOM_THERM2_CTL is defined as MSR_THERM2_CTL in SDM.\r
 **/\r
 #define MSR_ATOM_THERM2_CTL                      0x0000019D\r
 \r
@@ -466,6 +488,7 @@ typedef union {
   Msr.Uint64 = AsmReadMsr64 (MSR_ATOM_IA32_MISC_ENABLE);\r
   AsmWriteMsr64 (MSR_ATOM_IA32_MISC_ENABLE, Msr.Uint64);\r
   @endcode\r
+  @note MSR_ATOM_IA32_MISC_ENABLE is defined as IA32_MISC_ENABLE in SDM.\r
 **/\r
 #define MSR_ATOM_IA32_MISC_ENABLE                0x000001A0\r
 \r
@@ -586,6 +609,7 @@ typedef union {
   Msr = AsmReadMsr64 (MSR_ATOM_LASTBRANCH_TOS);\r
   AsmWriteMsr64 (MSR_ATOM_LASTBRANCH_TOS, Msr);\r
   @endcode\r
+  @note MSR_ATOM_LASTBRANCH_TOS is defined as MSR_LASTBRANCH_TOS in SDM.\r
 **/\r
 #define MSR_ATOM_LASTBRANCH_TOS                  0x000001C9\r
 \r
@@ -605,6 +629,7 @@ typedef union {
 \r
   Msr = AsmReadMsr64 (MSR_ATOM_LER_FROM_LIP);\r
   @endcode\r
+  @note MSR_ATOM_LER_FROM_LIP is defined as MSR_LER_FROM_LIP in SDM.\r
 **/\r
 #define MSR_ATOM_LER_FROM_LIP                    0x000001DD\r
 \r
@@ -625,6 +650,7 @@ typedef union {
 \r
   Msr = AsmReadMsr64 (MSR_ATOM_LER_TO_LIP);\r
   @endcode\r
+  @note MSR_ATOM_LER_TO_LIP is defined as MSR_LER_TO_LIP in SDM.\r
 **/\r
 #define MSR_ATOM_LER_TO_LIP                      0x000001DE\r
 \r
@@ -644,6 +670,7 @@ typedef union {
   Msr = AsmReadMsr64 (MSR_ATOM_IA32_PERF_GLOBAL_STAUS);\r
   AsmWriteMsr64 (MSR_ATOM_IA32_PERF_GLOBAL_STAUS, Msr);\r
   @endcode\r
+  @note MSR_ATOM_IA32_PERF_GLOBAL_STAUS is defined as IA32_PERF_GLOBAL_STAUS in SDM.\r
 **/\r
 #define MSR_ATOM_IA32_PERF_GLOBAL_STAUS          0x0000038E\r
 \r
@@ -665,6 +692,7 @@ typedef union {
   Msr.Uint64 = AsmReadMsr64 (MSR_ATOM_PEBS_ENABLE);\r
   AsmWriteMsr64 (MSR_ATOM_PEBS_ENABLE, Msr.Uint64);\r
   @endcode\r
+  @note MSR_ATOM_PEBS_ENABLE is defined as MSR_PEBS_ENABLE in SDM.\r
 **/\r
 #define MSR_ATOM_PEBS_ENABLE                     0x000003F1\r
 \r
@@ -708,6 +736,7 @@ typedef union {
   Msr = AsmReadMsr64 (MSR_ATOM_MC3_CTL);\r
   AsmWriteMsr64 (MSR_ATOM_MC3_CTL, Msr);\r
   @endcode\r
+  @note MSR_ATOM_MC3_CTL is defined as MSR_MC3_CTL in SDM.\r
 **/\r
 #define MSR_ATOM_MC3_CTL                         0x0000040C\r
 \r
@@ -726,6 +755,7 @@ typedef union {
   Msr = AsmReadMsr64 (MSR_ATOM_MC3_STATUS);\r
   AsmWriteMsr64 (MSR_ATOM_MC3_STATUS, Msr);\r
   @endcode\r
+  @note MSR_ATOM_MC3_STATUS is defined as MSR_MC3_STATUS in SDM.\r
 **/\r
 #define MSR_ATOM_MC3_STATUS                      0x0000040D\r
 \r
@@ -748,6 +778,7 @@ typedef union {
   Msr = AsmReadMsr64 (MSR_ATOM_MC3_ADDR);\r
   AsmWriteMsr64 (MSR_ATOM_MC3_ADDR, Msr);\r
   @endcode\r
+  @note MSR_ATOM_MC3_ADDR is defined as MSR_MC3_ADDR in SDM.\r
 **/\r
 #define MSR_ATOM_MC3_ADDR                        0x0000040E\r
 \r
@@ -766,6 +797,7 @@ typedef union {
   Msr = AsmReadMsr64 (MSR_ATOM_MC4_CTL);\r
   AsmWriteMsr64 (MSR_ATOM_MC4_CTL, Msr);\r
   @endcode\r
+  @note MSR_ATOM_MC4_CTL is defined as MSR_MC4_CTL in SDM.\r
 **/\r
 #define MSR_ATOM_MC4_CTL                         0x00000410\r
 \r
@@ -784,6 +816,7 @@ typedef union {
   Msr = AsmReadMsr64 (MSR_ATOM_MC4_STATUS);\r
   AsmWriteMsr64 (MSR_ATOM_MC4_STATUS, Msr);\r
   @endcode\r
+  @note MSR_ATOM_MC4_STATUS is defined as MSR_MC4_STATUS in SDM.\r
 **/\r
 #define MSR_ATOM_MC4_STATUS                      0x00000411\r
 \r
@@ -806,6 +839,7 @@ typedef union {
   Msr = AsmReadMsr64 (MSR_ATOM_MC4_ADDR);\r
   AsmWriteMsr64 (MSR_ATOM_MC4_ADDR, Msr);\r
   @endcode\r
+  @note MSR_ATOM_MC4_ADDR is defined as MSR_MC4_ADDR in SDM.\r
 **/\r
 #define MSR_ATOM_MC4_ADDR                        0x00000412\r
 \r
@@ -828,6 +862,7 @@ typedef union {
   Msr = AsmReadMsr64 (MSR_ATOM_PKG_C2_RESIDENCY);\r
   AsmWriteMsr64 (MSR_ATOM_PKG_C2_RESIDENCY, Msr);\r
   @endcode\r
+  @note MSR_ATOM_PKG_C2_RESIDENCY is defined as MSR_PKG_C2_RESIDENCY in SDM.\r
 **/\r
 #define MSR_ATOM_PKG_C2_RESIDENCY                0x000003F8\r
 \r
@@ -850,6 +885,7 @@ typedef union {
   Msr = AsmReadMsr64 (MSR_ATOM_PKG_C4_RESIDENCY);\r
   AsmWriteMsr64 (MSR_ATOM_PKG_C4_RESIDENCY, Msr);\r
   @endcode\r
+  @note MSR_ATOM_PKG_C4_RESIDENCY is defined as MSR_PKG_C4_RESIDENCY in SDM.\r
 **/\r
 #define MSR_ATOM_PKG_C4_RESIDENCY                0x000003F9\r
 \r
@@ -872,6 +908,7 @@ typedef union {
   Msr = AsmReadMsr64 (MSR_ATOM_PKG_C6_RESIDENCY);\r
   AsmWriteMsr64 (MSR_ATOM_PKG_C6_RESIDENCY, Msr);\r
   @endcode\r
+  @note MSR_ATOM_PKG_C6_RESIDENCY is defined as MSR_PKG_C6_RESIDENCY in SDM.\r
 **/\r
 #define MSR_ATOM_PKG_C6_RESIDENCY                0x000003FA\r
 \r