]> git.proxmox.com Git - mirror_edk2.git/blobdiff - Nt32Pkg/CpuRuntimeDxe/Cpu.c
Reviewed the code comments in the Include/Protocol directory for typos, grammar issue...
[mirror_edk2.git] / Nt32Pkg / CpuRuntimeDxe / Cpu.c
index 499ec2da8c5212a06e1d3813944e8c40458905a4..d8d63d3da9408f7d813d7f16e96f2437e4f32a4f 100644 (file)
@@ -1,4 +1,4 @@
-/*++\r
+/**@file\r
 \r
 Copyright (c) 2006 - 2007, Intel Corporation\r
 All rights reserved. This program and the accompanying materials\r
@@ -20,30 +20,40 @@ Abstract:
   the CPU-specific setjump/long pair.  Other services are not implemented\r
   in this driver.\r
 \r
---*/\r
+**/\r
 \r
-//\r
-// Include common header file for this module.\r
-//\r
-#include "CommonHeader.h"\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
-EFI_STATUS\r
-EFIAPI\r
-InitializeCpu (\r
-  IN EFI_HANDLE        ImageHandle,\r
-  IN EFI_SYSTEM_TABLE  *SystemTable\r
-  );\r
 \r
-VOID\r
-EFIAPI\r
-WinNtIoProtocolNotifyFunction (\r
-  IN EFI_EVENT                Event,\r
-  IN VOID                     *Context\r
-  );\r
 \r
 typedef union {\r
   EFI_CPU_DATA_RECORD *DataRecord;\r
@@ -61,7 +71,6 @@ EFI_SUBCLASS_TYPE1_HEADER mCpuDataRecordHeader = {
 //\r
 // Service routines for the driver\r
 //\r
-STATIC\r
 EFI_STATUS\r
 EFIAPI\r
 WinNtFlushCpuDataCache (\r
@@ -108,7 +117,7 @@ Returns:
   return EFI_UNSUPPORTED;\r
 }\r
 \r
-STATIC\r
+\r
 EFI_STATUS\r
 EFIAPI\r
 WinNtEnableInterrupt (\r
@@ -142,7 +151,7 @@ Returns:
   return EFI_SUCCESS;\r
 }\r
 \r
-STATIC\r
+\r
 EFI_STATUS\r
 EFIAPI\r
 WinNtDisableInterrupt (\r
@@ -176,7 +185,7 @@ Returns:
   return EFI_SUCCESS;\r
 }\r
 \r
-STATIC\r
+\r
 EFI_STATUS\r
 EFIAPI\r
 WinNtGetInterruptState (\r
@@ -217,7 +226,7 @@ Returns:
   return EFI_SUCCESS;\r
 }\r
 \r
-STATIC\r
+\r
 EFI_STATUS\r
 EFIAPI\r
 WinNtInit (\r
@@ -245,13 +254,10 @@ Returns:
 // TODO:    This - add argument and description to function comment\r
 // TODO:    InitType - 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
   return EFI_UNSUPPORTED;\r
 }\r
 \r
-STATIC\r
+\r
 EFI_STATUS\r
 EFIAPI\r
 WinNtRegisterInterruptHandler (\r
@@ -282,7 +288,6 @@ Returns:
 // TODO:    InterruptType - add argument and description to function comment\r
 // TODO:    InterruptHandler - add argument and description to function comment\r
 {\r
-  CPU_ARCH_PROTOCOL_PRIVATE *Private;\r
 \r
   //\r
   // Do parameter checking for EFI spec conformance\r
@@ -293,11 +298,10 @@ Returns:
   //\r
   // Do nothing for Nt32 emulation\r
   //\r
-  Private = CPU_ARCH_PROTOCOL_PRIVATE_DATA_FROM_THIS (This);\r
   return EFI_UNSUPPORTED;\r
 }\r
 \r
-STATIC\r
+\r
 EFI_STATUS\r
 EFIAPI\r
 WinNtGetTimerValue (\r
@@ -337,7 +341,7 @@ Returns:
   return EFI_UNSUPPORTED;\r
 }\r
 \r
-STATIC\r
+\r
 EFI_STATUS\r
 EFIAPI\r
 WinNtSetMemoryAttributes (\r
@@ -372,8 +376,6 @@ Returns:
 // TODO:    Attributes - 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
   //\r
   // Check for invalid parameter for Spec conformance\r
   //\r
@@ -384,348 +386,143 @@ Returns:
   //\r
   // Do nothing for Nt32 emulation\r
   //\r
-  Private = CPU_ARCH_PROTOCOL_PRIVATE_DATA_FROM_THIS (This);\r
   return EFI_UNSUPPORTED;\r
 }\r
 \r
 \r
-EFI_STATUS\r
-EFIAPI\r
-InitializeCpu (\r
-  IN EFI_HANDLE        ImageHandle,\r
-  IN EFI_SYSTEM_TABLE  *SystemTable\r
+VOID\r
+CpuUpdateDataHub (\r
+  VOID\r
   )\r
 /*++\r
 \r
 Routine Description:\r
-\r
-  Initialize the state information for the CPU Architectural Protocol\r
+  This function will log processor version and frequency data to data hub.\r
 \r
 Arguments:\r
-\r
-  ImageHandle of the loaded driver\r
-  Pointer to the System Table\r
+  Event        - Event whose notification function is being invoked.\r
+  Context      - Pointer to the notification function's context.\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
+  None.\r
 \r
 --*/\r
-// TODO:    SystemTable - add argument and description to function comment\r
 {\r
-  EFI_STATUS                Status;\r
-  EFI_EVENT                 Event;\r
-  CPU_ARCH_PROTOCOL_PRIVATE *Private;\r
-  VOID                      *Registration;\r
-\r
-  Private = AllocatePool (sizeof (CPU_ARCH_PROTOCOL_PRIVATE));\r
-  ASSERT (Private != NULL);\r
-\r
-  Private->Signature                    = CPU_ARCH_PROT_PRIVATE_SIGNATURE;\r
-  Private->Cpu.FlushDataCache           = WinNtFlushCpuDataCache;\r
-  Private->Cpu.EnableInterrupt          = WinNtEnableInterrupt;\r
-  Private->Cpu.DisableInterrupt         = WinNtDisableInterrupt;\r
-  Private->Cpu.GetInterruptState        = WinNtGetInterruptState;\r
-  Private->Cpu.Init                     = WinNtInit;\r
-  Private->Cpu.RegisterInterruptHandler = WinNtRegisterInterruptHandler;\r
-  Private->Cpu.GetTimerValue            = WinNtGetTimerValue;\r
-  Private->Cpu.SetMemoryAttributes      = WinNtSetMemoryAttributes;\r
-\r
-  Private->Cpu.NumberOfTimers           = 0;\r
-  Private->Cpu.DmaBufferAlignment       = 4;\r
-\r
-  Private->InterruptState               = TRUE;\r
-\r
-  Private->CpuIo.Mem.Read   = CpuMemoryServiceRead;\r
-  Private->CpuIo.Mem.Write  = CpuMemoryServiceWrite;\r
-  Private->CpuIo.Io.Read    = CpuIoServiceRead;\r
-  Private->CpuIo.Io.Write   = CpuIoServiceWrite;\r
-\r
-\r
-  Private->Handle                       = NULL;\r
-  Status = gBS->InstallMultipleProtocolInterfaces (\r
-                  &Private->Handle,\r
-                  &gEfiCpuArchProtocolGuid,   &Private->Cpu,\r
-                  &gEfiCpuIoProtocolGuid,     &Private->CpuIo,\r
-                  NULL\r
-                  );\r
-  ASSERT_EFI_ERROR (Status);\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
-  // Install notify function to store processor data to HII database and data hub.\r
+  // Locate DataHub protocol.\r
   //\r
-  Status = gBS->CreateEvent (\r
-                  EVT_NOTIFY_SIGNAL,\r
-                  TPL_CALLBACK,\r
-                  WinNtIoProtocolNotifyFunction,\r
-                  ImageHandle,\r
-                  &Event\r
-                  );\r
-  ASSERT (!EFI_ERROR (Status));\r
-\r
-  Status = gBS->RegisterProtocolNotify (\r
-                  &gEfiWinNtIoProtocolGuid,\r
-                  Event,\r
-                  &Registration\r
-                  );\r
-  ASSERT (!EFI_ERROR (Status));\r
+  Status = gBS->LocateProtocol (&gEfiDataHubProtocolGuid, NULL, (VOID**)&DataHub);\r
+  if (EFI_ERROR (Status)) {\r
+    return;\r
+  }\r
 \r
   //\r
-  // Should be at EFI_D_INFO, but lets us now things are running\r
+  // Initialize data record header\r
   //\r
-  DEBUG ((EFI_D_ERROR, "CPU Architectural Protocol Loaded\n"));\r
-\r
-\r
+  mCpuDataRecordHeader.Instance = 1;\r
+  HeaderSize                    = sizeof (EFI_SUBCLASS_TYPE1_HEADER);\r
 \r
-  return Status;\r
-}\r
+  RecordBuffer.Raw              = AllocatePool (HeaderSize + EFI_CPU_DATA_MAXIMUM_LENGTH);\r
+  if (RecordBuffer.Raw == NULL) {\r
+    return ;\r
+  }\r
 \r
-UINTN\r
-Atoi (\r
-  CHAR16  *String\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
-Routine Description:\r
-  Convert a unicode string to a UINTN\r
+  CopyMem (RecordBuffer.Raw, &mCpuDataRecordHeader, HeaderSize);\r
 \r
-Arguments:\r
-  String - Unicode string.\r
 \r
-Returns:\r
-  UINTN of the number represented by String.\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
---*/\r
-{\r
-  UINTN   Number;\r
-  CHAR16  *Str;\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
-  // skip preceeding white space\r
-  //\r
-  Str = String;\r
-  while ((*Str) && (*Str == ' ' || *Str == '"')) {\r
-    Str++;\r
-  }\r
-  //\r
-  // Convert ot a Number\r
+  // Store CPU frequency data record to data hub - It's an emulator so make up a value\r
   //\r
-  Number = 0;\r
-  while (*Str != '\0') {\r
-    if ((*Str >= '0') && (*Str <= '9')) {\r
-      Number = (Number * 10) +*Str - '0';\r
-    } else {\r
-      break;\r
-    }\r
-\r
-    Str++;\r
-  }\r
-\r
-  return Number;\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
-VOID\r
+\r
+\r
+EFI_STATUS\r
 EFIAPI\r
-WinNtIoProtocolNotifyFunction (\r
-  IN EFI_EVENT                Event,\r
-  IN VOID                     *Context\r
+InitializeCpu (\r
+  IN EFI_HANDLE        ImageHandle,\r
+  IN EFI_SYSTEM_TABLE  *SystemTable\r
   )\r
 /*++\r
 \r
 Routine Description:\r
-  This function will log processor version and frequency data to data hub.\r
+\r
+  Initialize the state information for the CPU Architectural Protocol\r
 \r
 Arguments:\r
-  Event        - Event whose notification function is being invoked.\r
-  Context      - Pointer to the notification function's context.\r
+\r
+  ImageHandle of the loaded driver\r
+  Pointer to the System Table\r
 \r
 Returns:\r
-  None.\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
-  EFI_CPU_DATA_RECORD_BUFFER  RecordBuffer;\r
-  EFI_DATA_RECORD_HEADER      *Record;\r
-  EFI_SUBCLASS_TYPE1_HEADER   *DataHeader;\r
-  UINT32                      HeaderSize;\r
-  UINT32                      TotalSize;\r
-  UINTN                       HandleCount;\r
-  UINTN                       HandleIndex;\r
-  UINT64                      MonotonicCount;\r
-  BOOLEAN                     RecordFound;\r
-  EFI_HANDLE                  *HandleBuffer;\r
-  EFI_WIN_NT_IO_PROTOCOL      *WinNtIo;\r
-  EFI_DATA_HUB_PROTOCOL       *DataHub;\r
-  EFI_HII_PROTOCOL            *Hii;\r
-  EFI_HII_HANDLE              StringHandle;\r
-  EFI_HII_PACKAGES            *PackageList;\r
-  STRING_REF                  Token;\r
+  EFI_STATUS                Status;\r
 \r
-  DataHub         = NULL;\r
-  Token           = 0;\r
-  MonotonicCount  = 0;\r
-  RecordFound     = FALSE;\r
+  CpuUpdateDataHub ();\r
 \r
-  //\r
-  // Retrieve the list of all handles from the handle database\r
-  //\r
-  Status = gBS->LocateHandleBuffer (\r
-                  AllHandles,\r
-                  &gEfiWinNtIoProtocolGuid,\r
-                  NULL,\r
-                  &HandleCount,\r
-                  &HandleBuffer\r
+  Status = gBS->InstallMultipleProtocolInterfaces (\r
+                  &mCpuTemplate.Handle,\r
+                  &gEfiCpuArchProtocolGuid,   &mCpuTemplate.Cpu,\r
+                  &gEfiCpuIoProtocolGuid,     &mCpuTemplate.CpuIo,\r
+                  NULL\r
                   );\r
-  if (EFI_ERROR (Status)) {\r
-    return ;\r
-  }\r
-  //\r
-  // Locate HII protocol\r
-  //\r
-  Status = gBS->LocateProtocol (&gEfiHiiProtocolGuid, NULL, &Hii);\r
-  if (EFI_ERROR (Status)) {\r
-    return ;\r
-  }\r
-  //\r
-  // Locate DataHub protocol.\r
-  //\r
-  Status = gBS->LocateProtocol (&gEfiDataHubProtocolGuid, NULL, &DataHub);\r
-  if (EFI_ERROR (Status)) {\r
-    return ;\r
-  }\r
-  //\r
-  // Initialize data record header\r
-  //\r
-  mCpuDataRecordHeader.Instance = 1;\r
-  HeaderSize                    = sizeof (EFI_SUBCLASS_TYPE1_HEADER);\r
+  ASSERT_EFI_ERROR (Status);\r
 \r
-  RecordBuffer.Raw              = AllocatePool (HeaderSize + EFI_CPU_DATA_MAXIMUM_LENGTH);\r
-  if (RecordBuffer.Raw == NULL) {\r
-    return ;\r
-  }\r
+  return Status;\r
+}\r
 \r
-  CopyMem (RecordBuffer.Raw, &mCpuDataRecordHeader, HeaderSize);\r
 \r
-  //\r
-  // Search the Handle array to find the CPU model and speed information\r
-  //\r
-  for (HandleIndex = 0; HandleIndex < HandleCount; HandleIndex++) {\r
-    Status = gBS->OpenProtocol (\r
-                    HandleBuffer[HandleIndex],\r
-                    &gEfiWinNtIoProtocolGuid,\r
-                    &WinNtIo,\r
-                    Context,\r
-                    NULL,\r
-                    EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
-                    );\r
-    if (EFI_ERROR (Status)) {\r
-      continue;\r
-    }\r
-\r
-    if ((WinNtIo->WinNtThunk->Signature == EFI_WIN_NT_THUNK_PROTOCOL_SIGNATURE) &&\r
-        CompareGuid (WinNtIo->TypeGuid, &gEfiWinNtCPUModelGuid)\r
-          ) {\r
-      //\r
-      // Check if this record has been stored in data hub\r
-      //\r
-      do {\r
-        Status = DataHub->GetNextRecord (DataHub, &MonotonicCount, NULL, &Record);\r
-        if (Record->DataRecordClass == EFI_DATA_RECORD_CLASS_DATA) {\r
-          DataHeader = (EFI_SUBCLASS_TYPE1_HEADER *) (Record + 1);\r
-          if (CompareGuid (&Record->DataRecordGuid, &gEfiProcessorSubClassGuid) &&\r
-              (DataHeader->RecordType == ProcessorVersionRecordType)\r
-              ) {\r
-            RecordFound = TRUE;\r
-          }\r
-        }\r
-      } while (MonotonicCount != 0);\r
-\r
-      if (RecordFound) {\r
-        RecordFound = FALSE;\r
-        continue;\r
-      }\r
-      //\r
-      // Initialize strings to HII database\r
-      //\r
-      PackageList = PreparePackages (1, &gEfiProcessorProducerGuid, CpuStrings);\r
-\r
-      Status      = Hii->NewPack (Hii, PackageList, &StringHandle);\r
-      ASSERT (!EFI_ERROR (Status));\r
-\r
-      FreePool (PackageList);\r
-\r
-      //\r
-      // Store processor version data record to data hub\r
-      //\r
-      Status = Hii->NewString (Hii, NULL, StringHandle, &Token, WinNtIo->EnvString);\r
-      ASSERT (!EFI_ERROR (Status));\r
-\r
-      RecordBuffer.DataRecord->DataRecordHeader.RecordType      = ProcessorVersionRecordType;\r
-      RecordBuffer.DataRecord->VariableRecord.ProcessorVersion  = Token;\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
-    if ((WinNtIo->WinNtThunk->Signature == EFI_WIN_NT_THUNK_PROTOCOL_SIGNATURE) &&\r
-        CompareGuid (WinNtIo->TypeGuid, &gEfiWinNtCPUSpeedGuid)\r
-          ) {\r
-      //\r
-      // Check if this record has been stored in data hub\r
-      //\r
-      do {\r
-        Status = DataHub->GetNextRecord (DataHub, &MonotonicCount, NULL, &Record);\r
-        if (Record->DataRecordClass == EFI_DATA_RECORD_CLASS_DATA) {\r
-          DataHeader = (EFI_SUBCLASS_TYPE1_HEADER *) (Record + 1);\r
-          if (CompareGuid (&Record->DataRecordGuid, &gEfiProcessorSubClassGuid) &&\r
-              (DataHeader->RecordType == ProcessorCoreFrequencyRecordType)\r
-              ) {\r
-            RecordFound = TRUE;\r
-          }\r
-        }\r
-      } while (MonotonicCount != 0);\r
-\r
-      if (RecordFound) {\r
-        RecordFound = FALSE;\r
-        continue;\r
-      }\r
-      //\r
-      // Store CPU frequency data record to data hub\r
-      //\r
-      RecordBuffer.DataRecord->DataRecordHeader.RecordType                    = ProcessorCoreFrequencyRecordType;\r
-      RecordBuffer.DataRecord->VariableRecord.ProcessorCoreFrequency.Value    = (UINT16) Atoi (WinNtIo->EnvString);\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
-    gBS->CloseProtocol (\r
-          HandleBuffer[HandleIndex],\r
-          &gEfiWinNtIoProtocolGuid,\r
-          Context,\r
-          NULL\r
-          );\r
-  }\r
-}\r