Pal.h

Go to the documentation of this file.

 
#ifndef __PAL_API_H__
#define __PAL_API_H__
 
#define PAL_SUCCESS             0x0
 
#define PAL_CACHE_FLUSH_INSTRUCTION_ALL   1
#define PAL_CACHE_FLUSH_DATA_ALL          2
#define PAL_CACHE_FLUSH_ALL               3
#define PAL_CACHE_FLUSH_SYNC_TO_DATA      4
 
 
#define PAL_CACHE_FLUSH_INVALIDATE_LINES     BIT0
#define PAL_CACHE_FLUSH_NO_INVALIDATE_LINES  0
#define PAL_CACHE_FLUSH_POLL_INTERRUPT       BIT1
#define PAL_CACHE_FLUSH_NO_INTERRUPT         0
 
#define PAL_CACHE_FLUSH   1
 
 
#define PAL_CACHE_ATTR_WT   0
#define PAL_CACHE_ATTR_WB   1
 
#define PAL_CACHE_STORE_TEMPORAL      0
#define PAL_CACHE_STORE_NONE_TEMPORAL 3
 
#define PAL_CACHE_STORE_TEMPORAL_LVL_1        0
#define PAL_CACHE_STORE_NONE_TEMPORAL_LVL_ALL 3
 
#define PAL_CACHE_LOAD_TEMPORAL_LVL_1         0
#define PAL_CACHE_LOAD_NONE_TEMPORAL_LVL_1    1
#define PAL_CACHE_LOAD_NONE_TEMPORAL_LVL_ALL  3
 
typedef struct {
  UINT64  IsUnified   : 1;
  UINT64  Attributes  : 2;
  UINT64  Associativity:8;
  UINT64  LineSize:8;
  UINT64  Stride:8;
  UINT64  StoreLatency:8;
  UINT64  StoreHint:8;
  UINT64  LoadHint:8;
} PAL_CACHE_INFO_RETURN1;
 
typedef struct {
  UINT64  CacheSize:32;
  UINT64  AliasBoundary:8;
  UINT64  TagLsBits:8;
  UINT64  TagMsBits:8;
} PAL_CACHE_INFO_RETURN2;
 
#define PAL_CACHE_INFO    2
 
 
 
#define PAL_CACHE_INIT_ALL  0xffffffffffffffffULL
 
#define PAL_CACHE_INIT_TYPE_INSTRUCTION                 0x1
#define PAL_CACHE_INIT_TYPE_DATA                        0x2
#define PAL_CACHE_INIT_TYPE_INSTRUCTION_AND_DATA        0x3
 
#define PAL_CACHE_INIT_NO_RESTRICT  0
#define PAL_CACHE_INIT_RESTRICTED   1
 
#define PAL_CACHE_INIT    3
 
 
#define PAL_CACHE_PROTECTION_NONE_PROTECT   0
#define PAL_CACHE_PROTECTION_ODD_PROTECT    1
#define PAL_CACHE_PROTECTION_EVEN_PROTECT   2
#define PAL_CACHE_PROTECTION_ECC_PROTECT    3
 
 
 
#define PAL_CACHE_PROTECTION_PROTECT_DATA   0
#define PAL_CACHE_PROTECTION_PROTECT_TAG    1
#define PAL_CACHE_PROTECTION_PROTECT_TAG_ANDTHEN_DATA   2
#define PAL_CACHE_PROTECTION_PROTECT_DATA_ANDTHEN_TAG   3
 
typedef struct {
  UINT32  DataBits:8;
  UINT32  TagProtLsb:6;
  UINT32  TagProtMsb:6;
  UINT32  ProtBits:6;
  UINT32  Method:4;
  UINT32  TagOrData:2;
} PAL_CACHE_PROTECTION;
 
#define PAL_CACHE_PROT_INFO     38
 
typedef struct {
  UINT64  ThreadId : 16;    
  UINT64  Reserved1: 16;
  UINT64  CoreId: 16;       
  UINT64  Reserved2: 16;
} PAL_PCOC_N_CACHE_INFO1;
 
 
typedef struct {
  UINT64  LogicalAddress : 16;  
  UINT64  Reserved1: 16;
  UINT64  Reserved2: 32;
} PAL_PCOC_N_CACHE_INFO2;
 
#define PAL_CACHE_SHARED_INFO   43
 
 
#define PAL_CACHE_SUMMARY   4
 
 
//
// Virtual Memory Attributes implemented by processor.
//
#define PAL_MEMORY_ATTR_WB      0
#define PAL_MEMORY_ATTR_WC      6
#define PAL_MEMORY_ATTR_UC      4
#define PAL_MEMORY_ATTR_UCE     5
#define PAL_MEMORY_ATTR_NATPAGE 7
 
#define PAL_MEM_ATTRIB      5
 
#define PAL_PREFETCH_VISIBILITY   41
 
#define PAL_PTCE_INFO     6
 
typedef struct {
  UINT64  NumberSets:8;             
  UINT64  NumberWays:8;             
  UINT64  NumberEntries:16;         
  UINT64  PageSizeIsOptimized:1;    
  UINT64  TcIsUnified:1;            
  UINT64  EntriesReduction:1;       
} PAL_TC_INFO;
 
#define PAL_VM_INFO       7
 
 
#define PAL_VM_PAGE_SIZE 34
 
typedef struct {
  UINT64  WalkerPresent:1;              
  UINT64  WidthOfPhysicalAddress: 7;    
  UINT64  WidthOfKey:8;                 
  UINT64  MaxPkrIndex:8;                
  UINT64  HashTagId:8;                  
  UINT64  MaxDtrIndex:8;                
  UINT64  MaxItrIndex:8;                
  UINT64  NumberOfUniqueTc:8;           
  UINT64  NumberOfTcLevels:8;           
} PAL_VM_INFO1;
 
typedef struct {
  UINT64  WidthOfVirtualAddress:8;  
  UINT64  WidthOfRid:8;             
  UINT64  MaxPurgedTlbs:16;         
  UINT64  Reserved:32;
} PAL_VM_INFO2;
 
#define PAL_VM_SUMMARY  8
 
 
//
// Bit mask of TR_valid flag.
//
#define PAL_TR_ACCESS_RIGHT_IS_VALID      BIT0
#define PAL_TR_PRIVILEGE_LEVEL_IS_VALID   BIT1
#define PAL_TR_DIRTY_IS_VALID             BIT2
#define PAL_TR_MEMORY_ATTR_IS_VALID       BIT3
 
 
#define PAL_VM_TR_READ  261
 
 
 
 
//
// Bit Mask of Processor Bus Fesatures .
//
 
#define PAL_BUS_DISABLE_DATA_ERROR_SIGNALLING   BIT63
 
 
#define PAL_BUS_DISABLE_ADDRESS_ERROR_SIGNALLING   BIT62
 
 
 
 
#define PAL_BUS_DISABLE_ADDRESS_ERROR_CHECK   BIT61
 
 
#define PAL_BUS_DISABLE_INITIALIZATION_EVENT_SIGNALLING   BIT60
 
 
#define PAL_BUS_DISABLE_INITIALIZATION_EVENT_CHECK   BIT59
 
 
 
#define PAL_BUS_DISABLE_ERROR_SIGNALLING   BIT58
 
 
 
 
#define PAL_BUS_DISABLE__INTERNAL_ERROR_SIGNALLING   BIT57
 
 
#define PAL_BUS_DISABLE_ERROR_CHECK   BIT56
 
 
#define PAL_BUS_DISABLE_RSP_ERROR_CHECK   BIT55
 
 
#define PAL_BUS_DISABLE_TRANSACTION_QUEUE   BIT54
 
#define PAL_BUS_ENABLE_EXCLUSIVE_CACHE_LINE_REPLACEMENT   BIT53
 
 
#define PAL_BUS_ENABLE_SHARED_CACHE_LINE_REPLACEMENT   BIT52
 
 
 
#define PAL_BUS_ENABLE_HALF_TRANSFER   BIT30
 
#define PAL_BUS_REQUEST_BUS_PARKING   BIT29
 
 
#define PAL_BUS_GET_FEATURES 9
 
#define PAL_BUS_SET_FEATURES 10
 
 
#define PAL_DEBUG_INFO  11
 
#define PAL_FIXED_ADDR 12
 
#define PAL_FREQ_BASE 13
 
 
#define PAL_FREQ_RATIOS 14
 
typedef struct {
  UINT64  NumberOfLogicalProcessors:16;     
  UINT64  ThreadsPerCore:8;                 
  UINT64  Reserved1:8;
  UINT64  CoresPerProcessor:8;              
  UINT64  Reserved2:8;
  UINT64  PhysicalProcessorPackageId:8;     
  UINT64  Reserved3:8;
} PAL_LOGICAL_PROCESSPR_OVERVIEW;
 
typedef struct {
   UINT64 ThreadId:16;      
   UINT64 Reserved1:16;
   UINT64 CoreId:16;        
   UINT64 Reserved2:16;
} PAL_LOGICAL_PROCESSORN_INFO1;
 
typedef struct {
   UINT64 LogicalAddress:16;    
   UINT64 Reserved:48;
} PAL_LOGICAL_PROCESSORN_INFO2;
 
#define PAL_LOGICAL_TO_PHYSICAL 42
 
typedef struct {
  UINT64  NumberOfPmcPairs:8;               
  UINT64  WidthOfCounter:8;                 
  UINT64  TypeOfCycleCounting:8;            
  UINT64  TypeOfRetiredInstructionBundle:8; 
  UINT64  Reserved:32;
} PAL_PERFORMANCE_INFO;
 
#define PAL_PERF_MON_INFO 15
 
#define PAL_PLATFORM_ADDR_INTERRUPT_BLOCK_TOKEN                       0x0
#define PAL_PLATFORM_ADDR_IO_BLOCK_TOKEN                              0x1
 
#define PAL_PLATFORM_ADDR 16
 
typedef struct {
  UINT64  Reserved1:36;
  UINT64  FaultInUndefinedIns:1;                
 
  UINT64  NoPresentPmi:1;                       
 
  UINT64  NoSimpleImpInUndefinedIns:1;          
 
  UINT64  NoVariablePState:1;                   
 
  UINT64  NoVM:1;                               
 
  UINT64  NoXipXpsrXfs:1;                       
 
  UINT64  NoXr1ThroughXr3:1;                    
 
  UINT64  DisableDynamicPrediction:1;           
 
  UINT64  DisableSpontaneousDeferral:1;         
 
  UINT64  DisableDynamicDataCachePrefetch:1;    
 
  UINT64  DisableDynamicInsCachePrefetch:1;     
 
  UINT64  DisableBranchPrediction:1;            
  UINT64  Reserved2:4;
  UINT64  DisablePState:1;                      
 
  UINT64  EnableMcaOnDataPoisoning:1;           
 
  UINT64  EnableVmsw:1;                         
 
  UINT64  EnableEnvNotification:1;              
 
  UINT64  DisableBinitWithTimeout:1;            
 
  UINT64  DisableDPM:1;                         
 
  UINT64  DisableCoherency:1;                   
 
  UINT64  DisableCache:1;                       
 
  UINT64  EnableCmciPromotion:1;                
 
  UINT64  EnableMcaToBinitPromotion:1;          
 
  UINT64  EnableMcaPromotion:1;                 
 
  UINT64  EnableBerrPromotion:1;                
} PAL_PROCESSOR_FEATURES;
 
#define PAL_PROC_GET_FEATURES 17
 
 
#define PAL_PROC_SET_FEATURES 18
 
 
//
// Value of PAL_REGISTER_INFO.InfoRequest.
//
#define PAL_APPLICATION_REGISTER_IMPLEMENTED  0
#define PAL_APPLICATION_REGISTER_READABLE     1
#define PAL_CONTROL_REGISTER_IMPLEMENTED      2
#define PAL_CONTROL_REGISTER_READABLE         3
 
 
#define PAL_REGISTER_INFO 39
 
#define PAL_RSE_INFO 19
 
typedef struct {
  UINT64  VersionOfPalB:16;     
  UINT64  Reserved1:8;
  UINT64  PalVendor:8;          
  UINT64  VersionOfPalA:16;     
  UINT64  Reserved2:16;
} PAL_VERSION_INFO;
 
#define PAL_VERSION 20
 
 
 
//
// Vectors of PAL_MC_CLEAR_LOG.pending
//
#define PAL_MC_PENDING    BIT0
#define PAL_INIT_PENDING  BIT1
 
#define PAL_MC_CLEAR_LOG 21
 
#define PAL_MC_DRAIN 22
 
 
#define PAL_MC_DYNAMIC_STATE 24
 
 
 
//
// Values of PAL_MC_ERROR_INFO.InfoIndex.
//
#define PAL_PROCESSOR_ERROR_MAP       0
#define PAL_PROCESSOR_STATE_PARAM     1
#define PAL_STRUCTURE_SPECIFIC_ERROR  2
 
typedef struct {
 UINT64 CoreId:4;                   
 
 UINT64 ThreadId:4;                 
 
 UINT64 InfoOfInsCache:4;           
 
 UINT64 InfoOfDataCache:4;          
 
 UINT64 InfoOfInsTlb:4;             
 
 UINT64 InfoOfDataTlb:4;            
 
 UINT64 InfoOfProcessorBus:4;       
 UINT64 InfoOfRegisterFile:4;       
 UINT64 InfoOfMicroArch:4;          
 UINT64 Reserved:16;
} PAL_MC_ERROR_INFO_LEVEL_INDEX;
 
//
// Value of PAL_MC_ERROR_INFO.ErrorTypeIndex
//
#define PAL_ERR_INFO_BY_LEVEL_INDEX               0
#define PAL_ERR_INFO_TARGET_ADDRESS               1
#define PAL_ERR_INFO_REQUESTER_IDENTIFIER         2
#define PAL_ERR_INFO_REPONSER_INDENTIFIER         3
#define PAL_ERR_INFO_PRECISE_INSTRUCTION_POINTER  4
 
typedef struct {
  UINT64  Operation:4;                  
 
  UINT64  FailedCacheLevel:2;           
  UINT64  Reserved1:2;
  UINT64  FailedInDataPart:1;           
  UINT64  FailedInTagPart:1;            
  UINT64  FailedInDataCache:1;          
 
  UINT64  FailedInInsCache:1;           
 
  UINT64  Mesi:3;                       
 
  UINT64  MesiIsValid:1;                
 
  UINT64  FailedWay:5;                  
 
  UINT64  WayIndexIsValid:1;            
 
  UINT64  Reserved2:1;
  UINT64  MultipleBitsError:1;          
  UINT64  Reserved3:8;
  UINT64  IndexOfCacheLineError:20;     
  UINT64  Reserved4:2;
 
  UINT64  InstructionSet:1;             
 
  UINT64  InstructionSetIsValid:1;      
 
  UINT64  PrivilegeLevel:2;             
 
  UINT64  PrivilegeLevelIsValide:1;     
 
  UINT64  McCorrected:1;                
 
  UINT64  TargetAddressIsValid:1;       
 
  UINT64  RequesterIdentifier:1;        
 
  UINT64  ResponserIdentifier:1;        
 
  UINT64  PreciseInsPointer:1;          
 
} PAL_CACHE_CHECK_INFO;
 
 
typedef struct {
  UINT64  FailedSlot:8;                 
  UINT64  FailedSlotIsValid:1;          
  UINT64  Reserved1 :1;
  UINT64  TlbLevel:2;                   
  UINT64  Reserved2 :4;
 
  UINT64  FailedInDataTr:1;             
 
  UINT64  FailedInInsTr:1;              
 
  UINT64  FailedInDataTc:1;             
 
  UINT64  FailedInInsTc:1;              
 
  UINT64  FailedOperation:4;            
 
  UINT64  Reserved3:30;
  UINT64  InstructionSet:1;             
 
  UINT64  InstructionSetIsValid:1;      
 
  UINT64  PrivelegeLevel:2;             
 
  UINT64  PrivelegeLevelIsValid:1;      
 
  UINT64  McCorrected:1;                
 
  UINT64  TargetAddressIsValid:1;       
 
  UINT64  RequesterIdentifier:1;        
 
  UINT64  ResponserIdentifier:1;        
 
  UINT64  PreciseInsPointer:1;          
} PAL_TLB_CHECK_INFO;
 
#define PAL_MC_ERROR_INFO 25
 
#define PAL_MC_EXPECTED 23
 
#define PAL_MC_REGISTER_MEM 27
 
#define PAL_MC_RESUME 26
 
#define PAL_HALT 28
 
 
#define PAL_HALT_INFO 257
 
 
#define PAL_HALT_LIGHT 29
 
#define PAL_CACHE_LINE_INIT 31
 
#define PAL_CACHE_READ 259
 
 
#define PAL_CACHE_WRITE 260
 
#define PAL_TEST_INFO 37
 
typedef struct {
  UINT64  BufferSize:56;    
 
  UINT64  TestPhase:8;      
} PAL_TEST_INFO_INFO;
 
typedef struct {
  UINT64  TestControl:47;       
 
  UINT64  ControlSupport:1;     
  UINT64  Reserved:16;
} PAL_SELF_TEST_CONTROL;
 
typedef struct {
  UINT64  Attributes:8;         
  UINT64  Reserved:8;
  UINT64  TestControl:48;       
} PAL_TEST_CONTROL;
 
#define PAL_TEST_PROC 258
 
typedef struct {
  UINT32  NumberOfInterruptControllers;     
 
  UINT32  NumberOfProcessors;               
} PAL_PLATFORM_INFO;
 
#define PAL_COPY_INFO 30
 
#define PAL_COPY_PAL 256
 
#define PAL_ENTER_IA_32_ENV 33
 
#define PAL_PMI_ENTRYPOINT 32
 
 
#define PAL_BRAND_INFO_ID_REQUEST  0
 
#define PAL_BRAND_INFO  274
 
#define PAL_GET_HW_POLICY   48
 
 
//
// Value of PAL_SET_HW_POLICY.Policy
//
#define PAL_SET_HW_POLICY_PERFORMANCE               0
#define PAL_SET_HW_POLICY_FAIRNESS                  1
#define PAL_SET_HW_POLICY_HIGH_PRIORITY             2
#define PAL_SET_HW_POLICY_EXCLUSIVE_HIGH_PRIORITY   3
 
#define PAL_SET_HW_POLICY   49
 
typedef struct {
  UINT64  Mode:3;                   
 
  UINT64  ErrorInjection:3;         
 
  UINT64  ErrorSeverity:2;          
 
  UINT64  ErrorStructure:5;         
 
  UINT64  StructureHierarchy:3;     
 
  UINT64  Reserved:32;              
 
  UINT64  ImplSpec:16;              
} PAL_MC_ERROR_TYPE_INFO;
 
typedef struct {
  UINT64  StructInfoIsValid:1;              
 
  UINT64  CacheType:2;                      
 
  UINT64  PortionOfCacheLine:3;             
 
  UINT64  Mechanism:3;                      
 
  UINT64  DataPoisonOfCacheLine:1;          
 
  UINT64  Reserved1:22;
 
  UINT64  TrigerInfoIsValid:1;              
 
  UINT64  Triger:4;                         
 
  UINT64  PrivilegeOfTriger:3;              
 
  UINT64  Reserved2:24;
} PAL_MC_ERROR_STRUCT_INFO;
 
typedef struct {
  UINT64  TrigerAddress;
  UINT64  VirtualPageNumber:52;
  UINT64  Reserved1:8;
  UINT64  RegionId:24;
  UINT64  Reserved2:40;
} PAL_MC_ERROR_DATA_BUFFER_TLB;
 
#define PAL_MC_ERROR_INJECT 276
 
 
//
// Types of PAL_GET_PSTATE.Type
//
#define PAL_GET_PSTATE_RECENT                 0
#define PAL_GET_PSTATE_AVERAGE_NEW_START      1
#define PAL_GET_PSTATE_AVERAGE                2
#define PAL_GET_PSTATE_NOW                    3
 
#define PAL_GET_PSTATE      262
 
typedef struct {
  UINT32  PerformanceIndex:7;
  UINT32  Reserved1:5;
  UINT32  TypicalPowerDissipation:20;
  UINT32  TransitionLatency1;
  UINT32  TransitionLatency2;
  UINT32  Reserved2;
} PAL_PSTATE_INFO_BUFFER;
 
 
#define PAL_PSTATE_INFO     44
 
 
#define PAL_SET_PSTATE      263
 
#define PAL_SHUTDOWN        45
 
typedef struct {
  UINT64  Registration:1;
  UINT64  ProbeInterrupt:1;
  UINT64  Reserved:62;
} PAL_MEMORY_CONTROL_WORD;
 
#define PAL_MEMORY_BUFFER   277
 
 
#define PAL_VP_CREATE       265
 
typedef struct {
  UINT64    Reserved1:8;
  UINT64    Opcode:1;
  UINT64    Reserved:53;
} PAL_VP_ENV_INFO_RETURN;
 
#define PAL_VP_ENV_INFO       266
 
#define PAL_VP_EXIT_ENV       267
 
 
 
#define PAL_VP_INIT_ENV       268
 
 
#define PAL_VP_REGISTER       269
 
 
#define PAL_VP_RESTORE       270
 
#define PAL_VP_SAVE       271
 
 
#define PAL_VP_TERMINATE       272
 
#endif