[mirror_edk2.git] / Nt32Pkg / CpuRuntimeDxe / Cpu.c

/**@file\r
\r
Copyright (c) 2006 - 2007, Intel Corporation\r
All rights reserved. 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
\r
Module Name:\r
\r
  Cpu.c\r
\r
Abstract:\r
\r
  NT Emulation Architectural Protocol Driver as defined in Tiano.\r
  This CPU module abstracts the interrupt subsystem of a platform and\r
  the CPU-specific setjump/long pair.  Other services are not implemented\r
  in this driver.\r
\r
**/\r
\r
\r
#include "CpuDriver.h"\r
\r
\r
CPU_ARCH_PROTOCOL_PRIVATE mCpuTemplate = {\r
  CPU_ARCH_PROT_PRIVATE_SIGNATURE,\r
  NULL,\r
  {\r
    WinNtFlushCpuDataCache,\r
    WinNtEnableInterrupt,\r
    WinNtDisableInterrupt,\r
    WinNtGetInterruptState,\r
    WinNtInit,\r
    WinNtRegisterInterruptHandler,\r
    WinNtGetTimerValue,\r
    WinNtSetMemoryAttributes,\r
    0,\r
    4\r
  },\r
  {\r
    CpuMemoryServiceRead,\r
    CpuMemoryServiceWrite,\r
    CpuIoServiceRead,\r
    CpuIoServiceWrite\r
  },\r
  0,\r
  TRUE\r
};\r
\r
#define EFI_CPU_DATA_MAXIMUM_LENGTH 0x100\r
\r
\r
\r
typedef union {\r
  EFI_CPU_DATA_RECORD *DataRecord;\r
  UINT8               *Raw;\r
} EFI_CPU_DATA_RECORD_BUFFER;\r
\r
EFI_SUBCLASS_TYPE1_HEADER mCpuDataRecordHeader = {\r
  EFI_PROCESSOR_SUBCLASS_VERSION,       // Version\r
  sizeof (EFI_SUBCLASS_TYPE1_HEADER),   // Header Size\r
  0,                                    // Instance, Initialize later\r
  EFI_SUBCLASS_INSTANCE_NON_APPLICABLE, // SubInstance\r
  0                                     // RecordType, Initialize later\r
};\r
\r
//\r
// Service routines for the driver\r
//\r
EFI_STATUS\r
EFIAPI\r
WinNtFlushCpuDataCache (\r
  IN EFI_CPU_ARCH_PROTOCOL  *This,\r
  IN EFI_PHYSICAL_ADDRESS   Start,\r
  IN UINT64                 Length,\r
  IN EFI_CPU_FLUSH_TYPE     FlushType\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This routine would provide support for flushing the CPU data cache.\r
  In the case of NT emulation environment, this flushing is not necessary and\r
  is thus not implemented.\r
\r
Arguments:\r
\r
  Pointer to CPU Architectural Protocol interface\r
  Start adddress in memory to flush\r
  Length of memory to flush\r
  Flush type\r
\r
Returns:\r
\r
  Status\r
    EFI_SUCCESS\r
\r
--*/\r
// TODO:    This - add argument and description to function comment\r
// TODO:    FlushType - add argument and description to function comment\r
// TODO:    EFI_UNSUPPORTED - add return value to function comment\r
{\r
  if (FlushType == EfiCpuFlushTypeWriteBackInvalidate) {\r
    //\r
    // Only WB flush is supported. We actually need do nothing on NT emulator\r
    // environment. Classify this to follow EFI spec\r
    //\r
    return EFI_SUCCESS;\r
  }\r
  //\r
  // Other flush types are not supported by NT emulator\r
  //\r
  return EFI_UNSUPPORTED;\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
WinNtEnableInterrupt (\r
  IN EFI_CPU_ARCH_PROTOCOL  *This\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This routine provides support for emulation of the interrupt enable of the\r
  the system.  For our purposes, CPU enable is just a BOOLEAN that the Timer\r
  Architectural Protocol observes in order to defer behaviour while in its\r
  emulated interrupt, or timer tick.\r
\r
Arguments:\r
\r
  Pointer to CPU Architectural Protocol interface\r
\r
Returns:\r
\r
  Status\r
    EFI_SUCCESS\r
\r
--*/\r
// TODO:    This - add argument and description to function comment\r
{\r
  CPU_ARCH_PROTOCOL_PRIVATE *Private;\r
\r
  Private                 = CPU_ARCH_PROTOCOL_PRIVATE_DATA_FROM_THIS (This);\r
  Private->InterruptState = TRUE;\r
  return EFI_SUCCESS;\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
WinNtDisableInterrupt (\r
  IN EFI_CPU_ARCH_PROTOCOL  *This\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This routine provides support for emulation of the interrupt disable of the\r
  the system.  For our purposes, CPU enable is just a BOOLEAN that the Timer\r
  Architectural Protocol observes in order to defer behaviour while in its\r
  emulated interrupt, or timer tick.\r
\r
Arguments:\r
\r
  Pointer to CPU Architectural Protocol interface\r
\r
Returns:\r
\r
  Status\r
    EFI_SUCCESS\r
\r
--*/\r
// TODO:    This - add argument and description to function comment\r
{\r
  CPU_ARCH_PROTOCOL_PRIVATE *Private;\r
\r
  Private                 = CPU_ARCH_PROTOCOL_PRIVATE_DATA_FROM_THIS (This);\r
  Private->InterruptState = FALSE;\r
  return EFI_SUCCESS;\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
WinNtGetInterruptState (\r
  IN EFI_CPU_ARCH_PROTOCOL  *This,\r
  OUT BOOLEAN               *State\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This routine provides support for emulation of the interrupt disable of the\r
  the system.  For our purposes, CPU enable is just a BOOLEAN that the Timer\r
  Architectural Protocol observes in order to defer behaviour while in its\r
  emulated interrupt, or timer tick.\r
\r
Arguments:\r
\r
  Pointer to CPU Architectural Protocol interface\r
\r
Returns:\r
\r
  Status\r
    EFI_SUCCESS\r
\r
--*/\r
// TODO:    This - add argument and description to function comment\r
// TODO:    State - add argument and description to function comment\r
// TODO:    EFI_INVALID_PARAMETER - add return value to function comment\r
{\r
  CPU_ARCH_PROTOCOL_PRIVATE *Private;\r
\r
  if (State == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Private = CPU_ARCH_PROTOCOL_PRIVATE_DATA_FROM_THIS (This);\r
  *State  = Private->InterruptState;\r
  return EFI_SUCCESS;\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
WinNtInit (\r
  IN EFI_CPU_ARCH_PROTOCOL  *This,\r
  IN EFI_CPU_INIT_TYPE      InitType\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This routine would support generation of a CPU INIT.  At\r
  present, this code does not provide emulation.\r
\r
Arguments:\r
\r
  Pointer to CPU Architectural Protocol interface\r
  INIT Type\r
\r
Returns:\r
\r
  Status\r
    EFI_UNSUPPORTED - not yet implemented\r
\r
--*/\r
// TODO:    This - add argument and description to function comment\r
// TODO:    InitType - add argument and description to function comment\r
{\r
  return EFI_UNSUPPORTED;\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
WinNtRegisterInterruptHandler (\r
  IN EFI_CPU_ARCH_PROTOCOL      *This,\r
  IN EFI_EXCEPTION_TYPE         InterruptType,\r
  IN EFI_CPU_INTERRUPT_HANDLER  InterruptHandler\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This routine would support registration of an interrupt handler.  At\r
  present, this code does not provide emulation.\r
\r
Arguments:\r
\r
  Pointer to CPU Architectural Protocol interface\r
  Pointer to interrupt handlers\r
  Interrupt type\r
\r
Returns:\r
\r
  Status\r
    EFI_UNSUPPORTED - not yet implemented\r
\r
--*/\r
// TODO:    This - add argument and description to function comment\r
// TODO:    InterruptType - add argument and description to function comment\r
// TODO:    InterruptHandler - add argument and description to function comment\r
{\r
\r
  //\r
  // Do parameter checking for EFI spec conformance\r
  //\r
  if (InterruptType < 0 || InterruptType > 0xff) {\r
    return EFI_UNSUPPORTED;\r
  }\r
  //\r
  // Do nothing for Nt32 emulation\r
  //\r
  return EFI_UNSUPPORTED;\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
WinNtGetTimerValue (\r
  IN  EFI_CPU_ARCH_PROTOCOL *This,\r
  IN  UINT32                TimerIndex,\r
  OUT UINT64                *TimerValue,\r
  OUT UINT64                *TimerPeriod OPTIONAL\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This routine would support querying of an on-CPU timer.  At present,\r
  this code does not provide timer emulation.\r
\r
Arguments:\r
\r
  This        - Pointer to CPU Architectural Protocol interface\r
  TimerIndex  - Index of given CPU timer\r
  TimerValue  - Output of the timer\r
  TimerPeriod - Output of the timer period\r
\r
Returns:\r
\r
  EFI_UNSUPPORTED       - not yet implemented\r
  EFI_INVALID_PARAMETER - TimeValue is NULL\r
\r
--*/\r
{\r
  if (TimerValue == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // No timer supported\r
  //\r
  return EFI_UNSUPPORTED;\r
}\r
\r
\r
EFI_STATUS\r
EFIAPI\r
WinNtSetMemoryAttributes (\r
  IN EFI_CPU_ARCH_PROTOCOL  *This,\r
  IN EFI_PHYSICAL_ADDRESS   BaseAddress,\r
  IN UINT64                 Length,\r
  IN UINT64                 Attributes\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This routine would support querying of an on-CPU timer.  At present,\r
  this code does not provide timer emulation.\r
\r
Arguments:\r
\r
  Pointer to CPU Architectural Protocol interface\r
  Start address of memory region\r
  The size in bytes of the memory region\r
  The bit mask of attributes to set for the memory region\r
\r
Returns:\r
\r
  Status\r
    EFI_UNSUPPORTED - not yet implemented\r
\r
--*/\r
// TODO:    This - add argument and description to function comment\r
// TODO:    BaseAddress - add argument and description to function comment\r
// TODO:    Length - add argument and description to function comment\r
// TODO:    Attributes - add argument and description to function comment\r
// TODO:    EFI_INVALID_PARAMETER - add return value to function comment\r
{\r
  //\r
  // Check for invalid parameter for Spec conformance\r
  //\r
  if (Length == 0) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Do nothing for Nt32 emulation\r
  //\r
  return EFI_UNSUPPORTED;\r
}\r
\r
\r
VOID\r
CpuUpdateDataHub (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
  This function will log processor version and frequency data to data hub.\r
\r
Arguments:\r
  Event        - Event whose notification function is being invoked.\r
  Context      - Pointer to the notification function's context.\r
\r
Returns:\r
  None.\r
\r
--*/\r
{\r
  EFI_STATUS                  Status;\r
  EFI_CPU_DATA_RECORD_BUFFER  RecordBuffer;\r
  UINT32                      HeaderSize;\r
  UINT32                      TotalSize;\r
  EFI_DATA_HUB_PROTOCOL       *DataHub;\r
  EFI_HII_HANDLE              HiiHandle;\r
\r
  //\r
  // Locate DataHub protocol.\r
  //\r
  Status = gBS->LocateProtocol (&gEfiDataHubProtocolGuid, NULL, (VOID**)&DataHub);\r
  if (EFI_ERROR (Status)) {\r
    return;\r
  }\r
\r
  //\r
  // Initialize data record header\r
  //\r
  mCpuDataRecordHeader.Instance = 1;\r
  HeaderSize                    = sizeof (EFI_SUBCLASS_TYPE1_HEADER);\r
\r
  RecordBuffer.Raw              = AllocatePool (HeaderSize + EFI_CPU_DATA_MAXIMUM_LENGTH);\r
  if (RecordBuffer.Raw == NULL) {\r
    return ;\r
  }\r
\r
  //\r
  // Initialize strings to HII database\r
  //\r
  HiiHandle = HiiAddPackages (\r
                &gEfiProcessorProducerGuid,\r
                NULL,\r
                CpuStrings,\r
                NULL\r
                );\r
  ASSERT (HiiHandle != NULL);\r
\r
  CopyMem (RecordBuffer.Raw, &mCpuDataRecordHeader, HeaderSize);\r
\r
\r
  RecordBuffer.DataRecord->DataRecordHeader.RecordType      = ProcessorVersionRecordType;\r
  RecordBuffer.DataRecord->VariableRecord.ProcessorVersion  = STRING_TOKEN (STR_PROCESSOR_VERSION);\r
  TotalSize = HeaderSize + sizeof (EFI_PROCESSOR_VERSION_DATA);\r
\r
  Status = DataHub->LogData (\r
                      DataHub,\r
                      &gEfiProcessorSubClassGuid,\r
                      &gEfiProcessorProducerGuid,\r
                      EFI_DATA_RECORD_CLASS_DATA,\r
                      RecordBuffer.Raw,\r
                      TotalSize\r
                      );\r
\r
  //\r
  // Store CPU frequency data record to data hub - It's an emulator so make up a value\r
  //\r
  RecordBuffer.DataRecord->DataRecordHeader.RecordType                    = ProcessorCoreFrequencyRecordType;\r
  RecordBuffer.DataRecord->VariableRecord.ProcessorCoreFrequency.Value    = 1234;\r
  RecordBuffer.DataRecord->VariableRecord.ProcessorCoreFrequency.Exponent = 6;\r
  TotalSize = HeaderSize + sizeof (EFI_PROCESSOR_CORE_FREQUENCY_DATA);\r
\r
  Status = DataHub->LogData (\r
                      DataHub,\r
                      &gEfiProcessorSubClassGuid,\r
                      &gEfiProcessorProducerGuid,\r
                      EFI_DATA_RECORD_CLASS_DATA,\r
                      RecordBuffer.Raw,\r
                      TotalSize\r
                      );\r
\r
  FreePool (RecordBuffer.Raw);\r
}\r
\r
\r
\r
EFI_STATUS\r
EFIAPI\r
InitializeCpu (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Initialize the state information for the CPU Architectural Protocol\r
\r
Arguments:\r
\r
  ImageHandle of the loaded driver\r
  Pointer to the System Table\r
\r
Returns:\r
\r
  Status\r
\r
  EFI_SUCCESS           - protocol instance can be published\r
  EFI_OUT_OF_RESOURCES  - cannot allocate protocol data structure\r
  EFI_DEVICE_ERROR      - cannot create the thread\r
\r
--*/\r
{\r
  EFI_STATUS                Status;\r
\r
  CpuUpdateDataHub ();\r
\r
  Status = gBS->InstallMultipleProtocolInterfaces (\r
                  &mCpuTemplate.Handle,\r
                  &gEfiCpuArchProtocolGuid,   &mCpuTemplate.Cpu,\r
                  &gEfiCpuIoProtocolGuid,     &mCpuTemplate.CpuIo,\r
                  NULL\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return Status;\r
}\r
\r
\r
Commit	Line	Data
6ae81428	1	/**@file\r
770bcbb6	2	\r
	3	Copyright (c) 2006 - 2007, Intel Corporation\r
	4	All rights reserved. This program and the accompanying materials\r
	5	are licensed and made available under the terms and conditions of the BSD License\r
	6	which accompanies this distribution. The full text of the license may be found at\r
	7	http://opensource.org/licenses/bsd-license.php\r
	8	\r
	9	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	10	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	11	\r
	12	Module Name:\r
	13	\r
	14	Cpu.c\r
	15	\r
	16	Abstract:\r
	17	\r
	18	NT Emulation Architectural Protocol Driver as defined in Tiano.\r
	19	This CPU module abstracts the interrupt subsystem of a platform and\r
	20	the CPU-specific setjump/long pair. Other services are not implemented\r
	21	in this driver.\r
	22	\r
6ae81428	23	**/\r
770bcbb6	24	\r
770bcbb6	25	\r
	26	#include "CpuDriver.h"\r
	27	\r
b397fbbb A	28	\r
	29	CPU_ARCH_PROTOCOL_PRIVATE mCpuTemplate = {\r
	30	CPU_ARCH_PROT_PRIVATE_SIGNATURE,\r
	31	NULL,\r
	32	{\r
	33	WinNtFlushCpuDataCache,\r
	34	WinNtEnableInterrupt,\r
	35	WinNtDisableInterrupt,\r
	36	WinNtGetInterruptState,\r
	37	WinNtInit,\r
	38	WinNtRegisterInterruptHandler,\r
	39	WinNtGetTimerValue,\r
	40	WinNtSetMemoryAttributes,\r
	41	0,\r
	42	4\r
	43	},\r
	44	{\r
	45	CpuMemoryServiceRead,\r
	46	CpuMemoryServiceWrite,\r
	47	CpuIoServiceRead,\r
	48	CpuIoServiceWrite\r
	49	},\r
	50	0,\r
	51	TRUE\r
	52	};\r
	53	\r
770bcbb6	54	#define EFI_CPU_DATA_MAXIMUM_LENGTH 0x100\r
770bcbb6	55	\r
770bcbb6	56	\r
770bcbb6	57	\r
	58	typedef union {\r
	59	EFI_CPU_DATA_RECORD *DataRecord;\r
	60	UINT8 *Raw;\r
	61	} EFI_CPU_DATA_RECORD_BUFFER;\r
	62	\r
	63	EFI_SUBCLASS_TYPE1_HEADER mCpuDataRecordHeader = {\r
	64	EFI_PROCESSOR_SUBCLASS_VERSION, // Version\r
	65	sizeof (EFI_SUBCLASS_TYPE1_HEADER), // Header Size\r
	66	0, // Instance, Initialize later\r
	67	EFI_SUBCLASS_INSTANCE_NON_APPLICABLE, // SubInstance\r
	68	0 // RecordType, Initialize later\r
	69	};\r
	70	\r
	71	//\r
	72	// Service routines for the driver\r
	73	//\r
770bcbb6	74	EFI_STATUS\r
	75	EFIAPI\r
	76	WinNtFlushCpuDataCache (\r
	77	IN EFI_CPU_ARCH_PROTOCOL *This,\r
	78	IN EFI_PHYSICAL_ADDRESS Start,\r
	79	IN UINT64 Length,\r
	80	IN EFI_CPU_FLUSH_TYPE FlushType\r
	81	)\r
	82	/*++\r
	83	\r
	84	Routine Description:\r
	85	\r
	86	This routine would provide support for flushing the CPU data cache.\r
	87	In the case of NT emulation environment, this flushing is not necessary and\r
	88	is thus not implemented.\r
	89	\r
	90	Arguments:\r
	91	\r
	92	Pointer to CPU Architectural Protocol interface\r
	93	Start adddress in memory to flush\r
	94	Length of memory to flush\r
	95	Flush type\r
	96	\r
	97	Returns:\r
	98	\r
	99	Status\r
	100	EFI_SUCCESS\r
	101	\r
	102	--*/\r
	103	// TODO: This - add argument and description to function comment\r
	104	// TODO: FlushType - add argument and description to function comment\r
	105	// TODO: EFI_UNSUPPORTED - add return value to function comment\r
	106	{\r
	107	if (FlushType == EfiCpuFlushTypeWriteBackInvalidate) {\r
	108	//\r
	109	// Only WB flush is supported. We actually need do nothing on NT emulator\r
	110	// environment. Classify this to follow EFI spec\r
	111	//\r
	112	return EFI_SUCCESS;\r
	113	}\r
	114	//\r
	115	// Other flush types are not supported by NT emulator\r
	116	//\r
	117	return EFI_UNSUPPORTED;\r
	118	}\r
	119	\r
b397fbbb	120	\r
770bcbb6	121	EFI_STATUS\r
	122	EFIAPI\r
	123	WinNtEnableInterrupt (\r
	124	IN EFI_CPU_ARCH_PROTOCOL *This\r
	125	)\r
	126	/*++\r
	127	\r
	128	Routine Description:\r
	129	\r
	130	This routine provides support for emulation of the interrupt enable of the\r
	131	the system. For our purposes, CPU enable is just a BOOLEAN that the Timer\r
	132	Architectural Protocol observes in order to defer behaviour while in its\r
	133	emulated interrupt, or timer tick.\r
	134	\r
	135	Arguments:\r
	136	\r
	137	Pointer to CPU Architectural Protocol interface\r
	138	\r
	139	Returns:\r
	140	\r
	141	Status\r
	142	EFI_SUCCESS\r
	143	\r
	144	--*/\r
	145	// TODO: This - add argument and description to function comment\r
	146	{\r
	147	CPU_ARCH_PROTOCOL_PRIVATE *Private;\r
	148	\r
	149	Private = CPU_ARCH_PROTOCOL_PRIVATE_DATA_FROM_THIS (This);\r
	150	Private->InterruptState = TRUE;\r
	151	return EFI_SUCCESS;\r
	152	}\r
	153	\r
b397fbbb	154	\r
770bcbb6	155	EFI_STATUS\r
	156	EFIAPI\r
	157	WinNtDisableInterrupt (\r
	158	IN EFI_CPU_ARCH_PROTOCOL *This\r
	159	)\r
	160	/*++\r
	161	\r
	162	Routine Description:\r
	163	\r
	164	This routine provides support for emulation of the interrupt disable of the\r
	165	the system. For our purposes, CPU enable is just a BOOLEAN that the Timer\r
	166	Architectural Protocol observes in order to defer behaviour while in its\r
	167	emulated interrupt, or timer tick.\r
	168	\r
	169	Arguments:\r
	170	\r
	171	Pointer to CPU Architectural Protocol interface\r
	172	\r
	173	Returns:\r
	174	\r
	175	Status\r
	176	EFI_SUCCESS\r
	177	\r
	178	--*/\r
	179	// TODO: This - add argument and description to function comment\r
	180	{\r
	181	CPU_ARCH_PROTOCOL_PRIVATE *Private;\r
	182	\r
	183	Private = CPU_ARCH_PROTOCOL_PRIVATE_DATA_FROM_THIS (This);\r
	184	Private->InterruptState = FALSE;\r
	185	return EFI_SUCCESS;\r
	186	}\r
	187	\r
b397fbbb	188	\r
770bcbb6	189	EFI_STATUS\r
	190	EFIAPI\r
	191	WinNtGetInterruptState (\r
	192	IN EFI_CPU_ARCH_PROTOCOL *This,\r
	193	OUT BOOLEAN *State\r
	194	)\r
	195	/*++\r
	196	\r
	197	Routine Description:\r
	198	\r
	199	This routine provides support for emulation of the interrupt disable of the\r
	200	the system. For our purposes, CPU enable is just a BOOLEAN that the Timer\r
	201	Architectural Protocol observes in order to defer behaviour while in its\r
	202	emulated interrupt, or timer tick.\r
	203	\r
	204	Arguments:\r
	205	\r
	206	Pointer to CPU Architectural Protocol interface\r
	207	\r
	208	Returns:\r
	209	\r
	210	Status\r
	211	EFI_SUCCESS\r
	212	\r
	213	--*/\r
	214	// TODO: This - add argument and description to function comment\r
	215	// TODO: State - add argument and description to function comment\r
	216	// TODO: EFI_INVALID_PARAMETER - add return value to function comment\r
	217	{\r
	218	CPU_ARCH_PROTOCOL_PRIVATE *Private;\r
	219	\r
	220	if (State == NULL) {\r
	221	return EFI_INVALID_PARAMETER;\r
	222	}\r
	223	\r
	224	Private = CPU_ARCH_PROTOCOL_PRIVATE_DATA_FROM_THIS (This);\r
	225	*State = Private->InterruptState;\r
	226	return EFI_SUCCESS;\r
	227	}\r
	228	\r
b397fbbb	229	\r
770bcbb6	230	EFI_STATUS\r
	231	EFIAPI\r
	232	WinNtInit (\r
	233	IN EFI_CPU_ARCH_PROTOCOL *This,\r
	234	IN EFI_CPU_INIT_TYPE InitType\r
	235	)\r
	236	/*++\r
	237	\r
	238	Routine Description:\r
	239	\r
	240	This routine would support generation of a CPU INIT. At\r
	241	present, this code does not provide emulation.\r
	242	\r
	243	Arguments:\r
	244	\r
	245	Pointer to CPU Architectural Protocol interface\r
	246	INIT Type\r
	247	\r
	248	Returns:\r
	249	\r
	250	Status\r
	251	EFI_UNSUPPORTED - not yet implemented\r
	252	\r
	253	--*/\r
	254	// TODO: This - add argument and description to function comment\r
	255	// TODO: InitType - add argument and description to function comment\r
	256	{\r
770bcbb6	257	return EFI_UNSUPPORTED;\r
	258	}\r
	259	\r
b397fbbb	260	\r
770bcbb6	261	EFI_STATUS\r
	262	EFIAPI\r
	263	WinNtRegisterInterruptHandler (\r
	264	IN EFI_CPU_ARCH_PROTOCOL *This,\r
	265	IN EFI_EXCEPTION_TYPE InterruptType,\r
	266	IN EFI_CPU_INTERRUPT_HANDLER InterruptHandler\r
	267	)\r
	268	/*++\r
	269	\r
	270	Routine Description:\r
	271	\r
	272	This routine would support registration of an interrupt handler. At\r
	273	present, this code does not provide emulation.\r
	274	\r
	275	Arguments:\r
	276	\r
	277	Pointer to CPU Architectural Protocol interface\r
	278	Pointer to interrupt handlers\r
	279	Interrupt type\r
	280	\r
	281	Returns:\r
	282	\r
	283	Status\r
	284	EFI_UNSUPPORTED - not yet implemented\r
	285	\r
	286	--*/\r
	287	// TODO: This - add argument and description to function comment\r
	288	// TODO: InterruptType - add argument and description to function comment\r
	289	// TODO: InterruptHandler - add argument and description to function comment\r
	290	{\r
770bcbb6	291	\r
	292	//\r
	293	// Do parameter checking for EFI spec conformance\r
	294	//\r
	295	if (InterruptType < 0 \|\| InterruptType > 0xff) {\r
	296	return EFI_UNSUPPORTED;\r
	297	}\r
	298	//\r
	299	// Do nothing for Nt32 emulation\r
	300	//\r
770bcbb6	301	return EFI_UNSUPPORTED;\r
	302	}\r
	303	\r
b397fbbb	304	\r
770bcbb6	305	EFI_STATUS\r
	306	EFIAPI\r
	307	WinNtGetTimerValue (\r
	308	IN EFI_CPU_ARCH_PROTOCOL *This,\r
	309	IN UINT32 TimerIndex,\r
	310	OUT UINT64 *TimerValue,\r
	311	OUT UINT64 *TimerPeriod OPTIONAL\r
	312	)\r
	313	/*++\r
	314	\r
	315	Routine Description:\r
	316	\r
	317	This routine would support querying of an on-CPU timer. At present,\r
	318	this code does not provide timer emulation.\r
	319	\r
	320	Arguments:\r
	321	\r
	322	This - Pointer to CPU Architectural Protocol interface\r
	323	TimerIndex - Index of given CPU timer\r
	324	TimerValue - Output of the timer\r
	325	TimerPeriod - Output of the timer period\r
	326	\r
	327	Returns:\r
	328	\r
	329	EFI_UNSUPPORTED - not yet implemented\r
	330	EFI_INVALID_PARAMETER - TimeValue is NULL\r
	331	\r
	332	--*/\r
	333	{\r
	334	if (TimerValue == NULL) {\r
	335	return EFI_INVALID_PARAMETER;\r
	336	}\r
	337	\r
	338	//\r
	339	// No timer supported\r
	340	//\r
	341	return EFI_UNSUPPORTED;\r
	342	}\r
	343	\r
b397fbbb	344	\r
770bcbb6	345	EFI_STATUS\r
	346	EFIAPI\r
	347	WinNtSetMemoryAttributes (\r
	348	IN EFI_CPU_ARCH_PROTOCOL *This,\r
	349	IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
	350	IN UINT64 Length,\r
	351	IN UINT64 Attributes\r
	352	)\r
	353	/*++\r
	354	\r
	355	Routine Description:\r
	356	\r
	357	This routine would support querying of an on-CPU timer. At present,\r
	358	this code does not provide timer emulation.\r
	359	\r
	360	Arguments:\r
	361	\r
	362	Pointer to CPU Architectural Protocol interface\r
	363	Start address of memory region\r
	364	The size in bytes of the memory region\r
	365	The bit mask of attributes to set for the memory region\r
	366	\r
	367	Returns:\r
	368	\r
	369	Status\r
	370	EFI_UNSUPPORTED - not yet implemented\r
	371	\r
	372	--*/\r
	373	// TODO: This - add argument and description to function comment\r
	374	// TODO: BaseAddress - add argument and description to function comment\r
	375	// TODO: Length - add argument and description to function comment\r
	376	// TODO: Attributes - add argument and description to function comment\r
	377	// TODO: EFI_INVALID_PARAMETER - add return value to function comment\r
	378	{\r
770bcbb6	379	//\r
	380	// Check for invalid parameter for Spec conformance\r
	381	//\r
	382	if (Length == 0) {\r
	383	return EFI_INVALID_PARAMETER;\r
	384	}\r
	385	\r
	386	//\r
	387	// Do nothing for Nt32 emulation\r
	388	//\r
770bcbb6	389	return EFI_UNSUPPORTED;\r
	390	}\r
	391	\r
	392	\r
770bcbb6	393	VOID\r
b397fbbb A	394	CpuUpdateDataHub (\r
b397fbbb A	395	VOID\r
770bcbb6	396	)\r
	397	/*++\r
	398	\r
	399	Routine Description:\r
	400	This function will log processor version and frequency data to data hub.\r
	401	\r
	402	Arguments:\r
	403	Event - Event whose notification function is being invoked.\r
	404	Context - Pointer to the notification function's context.\r
	405	\r
	406	Returns:\r
	407	None.\r
	408	\r
	409	--*/\r
	410	{\r
	411	EFI_STATUS Status;\r
	412	EFI_CPU_DATA_RECORD_BUFFER RecordBuffer;\r
770bcbb6	413	UINT32 HeaderSize;\r
770bcbb6	414	UINT32 TotalSize;\r
770bcbb6	415	EFI_DATA_HUB_PROTOCOL *DataHub;\r
5fd5fcd3	416	EFI_HII_HANDLE HiiHandle;\r
770bcbb6	417	\r
770bcbb6	418	//\r
b397fbbb	419	// Locate DataHub protocol.\r
770bcbb6	420	//\r
0b94e319	421	Status = gBS->LocateProtocol (&gEfiDataHubProtocolGuid, NULL, (VOID**)&DataHub);\r
770bcbb6	422	if (EFI_ERROR (Status)) {\r
b397fbbb	423	return;\r
770bcbb6	424	}\r
b397fbbb	425	\r
770bcbb6	426	//\r
	427	// Initialize data record header\r
	428	//\r
	429	mCpuDataRecordHeader.Instance = 1;\r
	430	HeaderSize = sizeof (EFI_SUBCLASS_TYPE1_HEADER);\r
	431	\r
	432	RecordBuffer.Raw = AllocatePool (HeaderSize + EFI_CPU_DATA_MAXIMUM_LENGTH);\r
	433	if (RecordBuffer.Raw == NULL) {\r
	434	return ;\r
	435	}\r
	436	\r
b397fbbb A	437	//\r
	438	// Initialize strings to HII database\r
	439	//\r
cb7d01c0	440	HiiHandle = HiiAddPackages (\r
	441	&gEfiProcessorProducerGuid,\r
	442	NULL,\r
	443	CpuStrings,\r
	444	NULL\r
	445	);\r
	446	ASSERT (HiiHandle != NULL);\r
b397fbbb	447	\r
770bcbb6	448	CopyMem (RecordBuffer.Raw, &mCpuDataRecordHeader, HeaderSize);\r
770bcbb6	449	\r
b397fbbb A	450	\r
b397fbbb A	451	RecordBuffer.DataRecord->DataRecordHeader.RecordType = ProcessorVersionRecordType;\r
e0f06862	452	RecordBuffer.DataRecord->VariableRecord.ProcessorVersion = STRING_TOKEN (STR_PROCESSOR_VERSION);\r
b397fbbb A	453	TotalSize = HeaderSize + sizeof (EFI_PROCESSOR_VERSION_DATA);\r
	454	\r
	455	Status = DataHub->LogData (\r
	456	DataHub,\r
	457	&gEfiProcessorSubClassGuid,\r
	458	&gEfiProcessorProducerGuid,\r
	459	EFI_DATA_RECORD_CLASS_DATA,\r
	460	RecordBuffer.Raw,\r
	461	TotalSize\r
	462	);\r
	463	\r
	464	//\r
e0f06862	465	// Store CPU frequency data record to data hub - It's an emulator so make up a value\r
b397fbbb A	466	//\r
b397fbbb A	467	RecordBuffer.DataRecord->DataRecordHeader.RecordType = ProcessorCoreFrequencyRecordType;\r
e0f06862	468	RecordBuffer.DataRecord->VariableRecord.ProcessorCoreFrequency.Value = 1234;\r
b397fbbb A	469	RecordBuffer.DataRecord->VariableRecord.ProcessorCoreFrequency.Exponent = 6;\r
	470	TotalSize = HeaderSize + sizeof (EFI_PROCESSOR_CORE_FREQUENCY_DATA);\r
	471	\r
	472	Status = DataHub->LogData (\r
	473	DataHub,\r
	474	&gEfiProcessorSubClassGuid,\r
	475	&gEfiProcessorProducerGuid,\r
	476	EFI_DATA_RECORD_CLASS_DATA,\r
	477	RecordBuffer.Raw,\r
	478	TotalSize\r
	479	);\r
	480	\r
	481	FreePool (RecordBuffer.Raw);\r
	482	}\r
	483	\r
	484	\r
	485	\r
	486	EFI_STATUS\r
	487	EFIAPI\r
	488	InitializeCpu (\r
	489	IN EFI_HANDLE ImageHandle,\r
	490	IN EFI_SYSTEM_TABLE *SystemTable\r
	491	)\r
	492	/*++\r
	493	\r
	494	Routine Description:\r
	495	\r
	496	Initialize the state information for the CPU Architectural Protocol\r
	497	\r
	498	Arguments:\r
	499	\r
	500	ImageHandle of the loaded driver\r
	501	Pointer to the System Table\r
	502	\r
	503	Returns:\r
	504	\r
	505	Status\r
	506	\r
	507	EFI_SUCCESS - protocol instance can be published\r
	508	EFI_OUT_OF_RESOURCES - cannot allocate protocol data structure\r
	509	EFI_DEVICE_ERROR - cannot create the thread\r
	510	\r
	511	--*/\r
	512	{\r
	513	EFI_STATUS Status;\r
	514	\r
	515	CpuUpdateDataHub ();\r
	516	\r
	517	Status = gBS->InstallMultipleProtocolInterfaces (\r
	518	&mCpuTemplate.Handle,\r
	519	&gEfiCpuArchProtocolGuid, &mCpuTemplate.Cpu,\r
	520	&gEfiCpuIoProtocolGuid, &mCpuTemplate.CpuIo,\r
	521	NULL\r
	522	);\r
	523	ASSERT_EFI_ERROR (Status);\r
	524	\r
	525	return Status;\r
770bcbb6	526	}\r
b397fbbb A	527	\r
b397fbbb A	528	\r