/** @file\r
Intel Processor Trace feature.\r
\r
- Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>\r
- This program and the accompanying materials\r
- are licensed and made available under the terms and conditions of the BSD License\r
- which accompanies this distribution. The full text of the license may be found at\r
- http://opensource.org/licenses/bsd-license.php\r
-\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+ Copyright (c) 2017 - 2018, Intel Corporation. All rights reserved.<BR>\r
+ SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
\r
///\r
/// This macro define the max entries in the Topa table.\r
-/// Each entry in the table contains some attribute bits, a pointer to an output region, and the size of the region. \r
-/// The last entry in the table may hold a pointer to the next table. This pointer can either point to the top of the \r
-/// current table (for circular array) or to the base of another table. \r
-/// At least 2 entries are needed because the list of entries must \r
-/// be terminated by an entry with the END bit set to 1, so 2 \r
+/// Each entry in the table contains some attribute bits, a pointer to an output region, and the size of the region.\r
+/// The last entry in the table may hold a pointer to the next table. This pointer can either point to the top of the\r
+/// current table (for circular array) or to the base of another table.\r
+/// At least 2 entries are needed because the list of entries must\r
+/// be terminated by an entry with the END bit set to 1, so 2\r
/// entries are required to use a single valid entry.\r
///\r
#define MAX_TOPA_ENTRY_COUNT 2\r
/// Processor trace output scheme selection.\r
///\r
typedef enum {\r
- OutputSchemeSingleRange = 0,\r
- OutputSchemeToPA,\r
- OutputSchemeInvalid\r
-} PROC_TRACE_OUTPUT_SCHEME;\r
+ RtitOutputSchemeSingleRange = 0,\r
+ RtitOutputSchemeToPA\r
+} RTIT_OUTPUT_SCHEME;\r
\r
typedef struct {\r
- BOOLEAN ProcTraceSupported;\r
- BOOLEAN TopaSupported;\r
- BOOLEAN SingleRangeSupported;\r
+ BOOLEAN TopaSupported;\r
+ BOOLEAN SingleRangeSupported;\r
+ MSR_IA32_RTIT_CTL_REGISTER RtitCtrl;\r
+ MSR_IA32_RTIT_OUTPUT_BASE_REGISTER RtitOutputBase;\r
+ MSR_IA32_RTIT_OUTPUT_MASK_PTRS_REGISTER RtitOutputMaskPtrs;\r
} PROC_TRACE_PROCESSOR_DATA;\r
\r
typedef struct {\r
UINT32 NumberOfProcessors;\r
\r
- UINT8 ProcTraceOutputScheme; \r
+ UINT8 ProcTraceOutputScheme;\r
UINT32 ProcTraceMemSize;\r
\r
UINTN *ThreadMemRegionTable;\r
UINTN AllocatedThreads;\r
\r
UINTN *TopaMemArray;\r
- UINTN TopaMemArrayCount;\r
\r
PROC_TRACE_PROCESSOR_DATA *ProcessorData;\r
} PROC_TRACE_DATA;\r
}\r
\r
/**\r
- Detects if Intel Processor Trace feature supported on current \r
+ Detects if Intel Processor Trace feature supported on current\r
processor.\r
\r
@param[in] ProcessorNumber The index of the CPU executing this function.\r
// Check if ProcTraceMemorySize option is enabled (0xFF means disable by user)\r
//\r
ProcTraceData = (PROC_TRACE_DATA *) ConfigData;\r
+ ASSERT (ProcTraceData != NULL);\r
if ((ProcTraceData->ProcTraceMemSize > RtitTopaMemorySize128M) ||\r
- (ProcTraceData->ProcTraceOutputScheme > ProcTraceOutputSchemeToPA)) {\r
+ (ProcTraceData->ProcTraceOutputScheme > RtitOutputSchemeToPA)) {\r
return FALSE;\r
}\r
\r
// Check if Processor Trace is supported\r
//\r
AsmCpuidEx (CPUID_STRUCTURED_EXTENDED_FEATURE_FLAGS, 0, NULL, &Ebx.Uint32, NULL, NULL);\r
- ProcTraceData->ProcessorData[ProcessorNumber].ProcTraceSupported = (BOOLEAN) (Ebx.Bits.IntelProcessorTrace == 1);\r
- if (!ProcTraceData->ProcessorData[ProcessorNumber].ProcTraceSupported) {\r
+ if (Ebx.Bits.IntelProcessorTrace == 0) {\r
return FALSE;\r
}\r
\r
AsmCpuidEx (CPUID_INTEL_PROCESSOR_TRACE, CPUID_INTEL_PROCESSOR_TRACE_MAIN_LEAF, NULL, NULL, &Ecx.Uint32, NULL);\r
ProcTraceData->ProcessorData[ProcessorNumber].TopaSupported = (BOOLEAN) (Ecx.Bits.RTIT == 1);\r
ProcTraceData->ProcessorData[ProcessorNumber].SingleRangeSupported = (BOOLEAN) (Ecx.Bits.SingleRangeOutput == 1);\r
- if (ProcTraceData->ProcessorData[ProcessorNumber].TopaSupported || \r
- ProcTraceData->ProcessorData[ProcessorNumber].SingleRangeSupported) {\r
+ if ((ProcTraceData->ProcessorData[ProcessorNumber].TopaSupported && (ProcTraceData->ProcTraceOutputScheme == RtitOutputSchemeToPA)) ||\r
+ (ProcTraceData->ProcessorData[ProcessorNumber].SingleRangeSupported && (ProcTraceData->ProcTraceOutputScheme == RtitOutputSchemeSingleRange))) {\r
+ ProcTraceData->ProcessorData[ProcessorNumber].RtitCtrl.Uint64 = AsmReadMsr64 (MSR_IA32_RTIT_CTL);\r
+ ProcTraceData->ProcessorData[ProcessorNumber].RtitOutputBase.Uint64 = AsmReadMsr64 (MSR_IA32_RTIT_OUTPUT_BASE);\r
+ ProcTraceData->ProcessorData[ProcessorNumber].RtitOutputMaskPtrs.Uint64 = AsmReadMsr64 (MSR_IA32_RTIT_OUTPUT_MASK_PTRS);\r
return TRUE;\r
}\r
\r
MSR_IA32_RTIT_OUTPUT_MASK_PTRS_REGISTER OutputMaskPtrsReg;\r
RTIT_TOPA_TABLE_ENTRY *TopaEntryPtr;\r
\r
- ProcTraceData = (PROC_TRACE_DATA *) ConfigData;\r
-\r
- MemRegionBaseAddr = 0;\r
- FirstIn = FALSE;\r
-\r
- if (ProcTraceData->ThreadMemRegionTable == NULL) {\r
- FirstIn = TRUE;\r
- DEBUG ((DEBUG_INFO, "Initialize Processor Trace\n"));\r
+ //\r
+ // The scope of the MSR_IA32_RTIT_* is core for below processor type, only program\r
+ // MSR_IA32_RTIT_* for thread 0 in each core.\r
+ //\r
+ if (IS_GOLDMONT_PROCESSOR (CpuInfo->DisplayFamily, CpuInfo->DisplayModel) ||\r
+ IS_GOLDMONT_PLUS_PROCESSOR (CpuInfo->DisplayFamily, CpuInfo->DisplayModel)) {\r
+ if (CpuInfo->ProcessorInfo.Location.Thread != 0) {\r
+ return RETURN_SUCCESS;\r
+ }\r
}\r
\r
- ///\r
- /// Refer to PROC_TRACE_MEM_SIZE Table for Size Encoding\r
- ///\r
- MemRegionSize = (UINT32) (1 << (ProcTraceData->ProcTraceMemSize + 12));\r
- if (FirstIn) {\r
- DEBUG ((DEBUG_INFO, "ProcTrace: MemSize requested: 0x%X \n", MemRegionSize));\r
- }\r
+ ProcTraceData = (PROC_TRACE_DATA *) ConfigData;\r
+ ASSERT (ProcTraceData != NULL);\r
\r
//\r
// Clear MSR_IA32_RTIT_CTL[0] and IA32_RTIT_STS only if MSR_IA32_RTIT_CTL[0]==1b\r
//\r
- CtrlReg.Uint64 = AsmReadMsr64 (MSR_IA32_RTIT_CTL);\r
+ CtrlReg.Uint64 = ProcTraceData->ProcessorData[ProcessorNumber].RtitCtrl.Uint64;\r
if (CtrlReg.Bits.TraceEn != 0) {\r
///\r
/// Clear bit 0 in MSR IA32_RTIT_CTL (570)\r
);\r
}\r
\r
+ if (!State) {\r
+ return RETURN_SUCCESS;\r
+ }\r
+\r
+ MemRegionBaseAddr = 0;\r
+ FirstIn = FALSE;\r
+\r
+ if (ProcTraceData->ThreadMemRegionTable == NULL) {\r
+ FirstIn = TRUE;\r
+ DEBUG ((DEBUG_INFO, "Initialize Processor Trace\n"));\r
+ }\r
+\r
+ ///\r
+ /// Refer to PROC_TRACE_MEM_SIZE Table for Size Encoding\r
+ ///\r
+ MemRegionSize = (UINT32) (1 << (ProcTraceData->ProcTraceMemSize + 12));\r
+ if (FirstIn) {\r
+ DEBUG ((DEBUG_INFO, "ProcTrace: MemSize requested: 0x%X \n", MemRegionSize));\r
+ }\r
+\r
if (FirstIn) {\r
//\r
// Let BSP allocate and create the necessary memory region (Aligned to the size of\r
// the memory region from setup option(ProcTraceMemSize) which is an integral multiple of 4kB)\r
- // for the all the enabled threads for storing Processor Trace debug data. Then Configure the trace\r
+ // for all the enabled threads to store Processor Trace debug data. Then Configure the trace\r
// address base in MSR, IA32_RTIT_OUTPUT_BASE (560h) bits 47:12. Note that all regions must be\r
- // aligned based on their size, not just 4K. Thus a 2M region must have bits 20:12 clear.\r
+ // aligned based on their size, not just 4K. Thus a 2M region must have bits 20:12 cleared.\r
//\r
ThreadMemRegionTable = (UINTN *) AllocatePool (ProcTraceData->NumberOfProcessors * sizeof (UINTN *));\r
if (ThreadMemRegionTable == NULL) {\r
}\r
\r
DEBUG ((DEBUG_INFO, "ProcTrace: Allocated PT mem for %d thread \n", ProcTraceData->AllocatedThreads));\r
- MemRegionBaseAddr = ThreadMemRegionTable[0];\r
+ }\r
+\r
+ if (ProcessorNumber < ProcTraceData->AllocatedThreads) {\r
+ MemRegionBaseAddr = ProcTraceData->ThreadMemRegionTable[ProcessorNumber];\r
} else {\r
- if (ProcessorNumber < ProcTraceData->AllocatedThreads) {\r
- MemRegionBaseAddr = ProcTraceData->ThreadMemRegionTable[ProcessorNumber];\r
- } else {\r
- return RETURN_SUCCESS;\r
- }\r
+ return RETURN_SUCCESS;\r
}\r
\r
///\r
//\r
// Single Range output scheme\r
//\r
- if (ProcTraceData->ProcessorData[ProcessorNumber].SingleRangeSupported && \r
- (ProcTraceData->ProcTraceOutputScheme == OutputSchemeSingleRange)) {\r
+ if (ProcTraceData->ProcessorData[ProcessorNumber].SingleRangeSupported &&\r
+ (ProcTraceData->ProcTraceOutputScheme == RtitOutputSchemeSingleRange)) {\r
if (FirstIn) {\r
DEBUG ((DEBUG_INFO, "ProcTrace: Enabling Single Range Output scheme \n"));\r
}\r
//\r
// Clear MSR IA32_RTIT_CTL (0x570) ToPA (Bit 8)\r
//\r
- CtrlReg.Uint64 = AsmReadMsr64 (MSR_IA32_RTIT_CTL);\r
CtrlReg.Bits.ToPA = 0;\r
CPU_REGISTER_TABLE_WRITE64 (\r
ProcessorNumber,\r
//\r
// Program MSR IA32_RTIT_OUTPUT_BASE (0x560) bits[63:7] with the allocated Memory Region\r
//\r
+ OutputBaseReg.Uint64 = ProcTraceData->ProcessorData[ProcessorNumber].RtitOutputBase.Uint64;\r
OutputBaseReg.Bits.Base = (MemRegionBaseAddr >> 7) & 0x01FFFFFF;\r
OutputBaseReg.Bits.BaseHi = RShiftU64 ((UINT64) MemRegionBaseAddr, 32) & 0xFFFFFFFF;\r
CPU_REGISTER_TABLE_WRITE64 (\r
//\r
// Program the Mask bits for the Memory Region to MSR IA32_RTIT_OUTPUT_MASK_PTRS (561h)\r
//\r
+ OutputMaskPtrsReg.Uint64 = ProcTraceData->ProcessorData[ProcessorNumber].RtitOutputMaskPtrs.Uint64;\r
OutputMaskPtrsReg.Bits.MaskOrTableOffset = ((MemRegionSize - 1) >> 7) & 0x01FFFFFF;\r
- OutputMaskPtrsReg.Bits.OutputOffset = RShiftU64 ((UINT64) (MemRegionSize - 1), 32) & 0xFFFFFFFF;\r
+ OutputMaskPtrsReg.Bits.OutputOffset = RShiftU64 (MemRegionSize - 1, 32) & 0xFFFFFFFF;\r
CPU_REGISTER_TABLE_WRITE64 (\r
ProcessorNumber,\r
Msr,\r
//\r
// ToPA(Table of physical address) scheme\r
//\r
- if (ProcTraceData->ProcessorData[ProcessorNumber].TopaSupported && \r
- (ProcTraceData->ProcTraceOutputScheme == OutputSchemeToPA)) {\r
+ if (ProcTraceData->ProcessorData[ProcessorNumber].TopaSupported &&\r
+ (ProcTraceData->ProcTraceOutputScheme == RtitOutputSchemeToPA)) {\r
//\r
// Create ToPA structure aligned at 4KB for each logical thread\r
// with at least 2 entries by 8 bytes size each. The first entry\r
if (Index < ProcTraceData->AllocatedThreads) {\r
ProcTraceData->AllocatedThreads = Index;\r
}\r
- DEBUG ((DEBUG_ERROR, "ProcTrace: Out of mem, allocating ToPA mem only for %d threads\n", ProcTraceData->AllocatedThreads));\r
+ DEBUG ((DEBUG_ERROR, "ProcTrace: Out of mem, allocated ToPA mem only for %d threads\n", ProcTraceData->AllocatedThreads));\r
if (Index == 0) {\r
//\r
- // Could not allocate for BSP\r
+ // Could not allocate for BSP even\r
//\r
FreePool ((VOID *) TopaMemArray);\r
TopaMemArray = NULL;\r
}\r
\r
DEBUG ((DEBUG_INFO, "ProcTrace: Allocated ToPA mem for %d thread \n", ProcTraceData->AllocatedThreads));\r
- //\r
- // BSP gets the first block\r
- //\r
- TopaTableBaseAddr = TopaMemArray[0];\r
+ }\r
+\r
+ if (ProcessorNumber < ProcTraceData->AllocatedThreads) {\r
+ TopaTableBaseAddr = ProcTraceData->TopaMemArray[ProcessorNumber];\r
} else {\r
- //\r
- // Count for currently executing AP.\r
- //\r
- if (ProcessorNumber < ProcTraceData->AllocatedThreads) {\r
- TopaTableBaseAddr = ProcTraceData->TopaMemArray[ProcessorNumber];\r
- } else {\r
- return RETURN_SUCCESS;\r
- }\r
+ return RETURN_SUCCESS;\r
}\r
\r
TopaTable = (PROC_TRACE_TOPA_TABLE *) TopaTableBaseAddr;\r
TopaEntryPtr = &TopaTable->TopaEntry[0];\r
+ TopaEntryPtr->Uint64 = 0;\r
TopaEntryPtr->Bits.Base = (MemRegionBaseAddr >> 12) & 0x000FFFFF;\r
TopaEntryPtr->Bits.BaseHi = RShiftU64 ((UINT64) MemRegionBaseAddr, 32) & 0xFFFFFFFF;\r
TopaEntryPtr->Bits.Size = ProcTraceData->ProcTraceMemSize;\r
TopaEntryPtr->Bits.END = 0;\r
\r
TopaEntryPtr = &TopaTable->TopaEntry[1];\r
+ TopaEntryPtr->Uint64 = 0;\r
TopaEntryPtr->Bits.Base = (TopaTableBaseAddr >> 12) & 0x000FFFFF;\r
TopaEntryPtr->Bits.BaseHi = RShiftU64 ((UINT64) TopaTableBaseAddr, 32) & 0xFFFFFFFF;\r
TopaEntryPtr->Bits.END = 1;\r
//\r
// Program the MSR IA32_RTIT_OUTPUT_BASE (0x560) bits[63:7] with ToPA base\r
//\r
+ OutputBaseReg.Uint64 = ProcTraceData->ProcessorData[ProcessorNumber].RtitOutputBase.Uint64;\r
OutputBaseReg.Bits.Base = (TopaTableBaseAddr >> 7) & 0x01FFFFFF;\r
OutputBaseReg.Bits.BaseHi = RShiftU64 ((UINT64) TopaTableBaseAddr, 32) & 0xFFFFFFFF;\r
CPU_REGISTER_TABLE_WRITE64 (\r
//\r
// Set the MSR IA32_RTIT_OUTPUT_MASK (0x561) bits[63:7] to 0\r
//\r
+ OutputMaskPtrsReg.Uint64 = ProcTraceData->ProcessorData[ProcessorNumber].RtitOutputMaskPtrs.Uint64;\r
OutputMaskPtrsReg.Bits.MaskOrTableOffset = 0;\r
OutputMaskPtrsReg.Bits.OutputOffset = 0;\r
CPU_REGISTER_TABLE_WRITE64 (\r
//\r
// Enable ToPA output scheme by enabling MSR IA32_RTIT_CTL (0x570) ToPA (Bit 8)\r
//\r
- CtrlReg.Uint64 = AsmReadMsr64 (MSR_IA32_RTIT_CTL);\r
CtrlReg.Bits.ToPA = 1;\r
CPU_REGISTER_TABLE_WRITE64 (\r
ProcessorNumber,\r
///\r
/// Enable the Processor Trace feature from MSR IA32_RTIT_CTL (570h)\r
///\r
- CtrlReg.Uint64 = AsmReadMsr64 (MSR_IA32_RTIT_CTL);\r
CtrlReg.Bits.OS = 1;\r
CtrlReg.Bits.User = 1;\r
CtrlReg.Bits.BranchEn = 1;\r
- if (!State) {\r
- CtrlReg.Bits.TraceEn = 0;\r
- } else {\r
- CtrlReg.Bits.TraceEn = 1;\r
- }\r
+ CtrlReg.Bits.TraceEn = 1;\r
CPU_REGISTER_TABLE_WRITE64 (\r
ProcessorNumber,\r
Msr,\r