StandaloneMmPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / UefiCpuPkg / Library / RegisterCpuFeaturesLib / RegisterCpuFeatures.h

/** @file\r
  CPU Register Table Library definitions.\r
\r
  Copyright (c) 2017 - 2019, 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
\r
**/\r
\r
#ifndef _REGISTER_CPU_FEATURES_H_\r
#define _REGISTER_CPU_FEATURES_H_\r
#include <PiPei.h>\r
#include <PiDxe.h>\r
#include <Ppi/MpServices.h>\r
#include <Protocol/MpService.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/RegisterCpuFeaturesLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/SynchronizationLib.h>\r
#include <Library/IoLib.h>\r
#include <Library/LocalApicLib.h>\r
\r
#include <AcpiCpuData.h>\r
\r
#define CPU_FEATURE_ENTRY_SIGNATURE  SIGNATURE_32 ('C', 'F', 'E', 'S')\r
\r
#define CPU_FEATURE_NAME_SIZE        128\r
\r
typedef struct {\r
  REGISTER_CPU_FEATURE_INFORMATION     CpuInfo;\r
  UINT8                                *FeaturesSupportedMask;\r
  LIST_ENTRY                           OrderList;\r
} CPU_FEATURES_INIT_ORDER;\r
\r
typedef struct {\r
  UINT32                       Signature;\r
  LIST_ENTRY                   Link;\r
  UINT8                        *FeatureMask;\r
  CHAR8                        *FeatureName;\r
  CPU_FEATURE_GET_CONFIG_DATA  GetConfigDataFunc;\r
  CPU_FEATURE_SUPPORT          SupportFunc;\r
  CPU_FEATURE_INITIALIZE       InitializeFunc;\r
  UINT8                        *BeforeFeatureBitMask;\r
  UINT8                        *AfterFeatureBitMask;\r
  UINT8                        *CoreBeforeFeatureBitMask;\r
  UINT8                        *CoreAfterFeatureBitMask;\r
  UINT8                        *PackageBeforeFeatureBitMask;\r
  UINT8                        *PackageAfterFeatureBitMask;\r
  VOID                         *ConfigData;\r
  BOOLEAN                      BeforeAll;\r
  BOOLEAN                      AfterAll;\r
} CPU_FEATURES_ENTRY;\r
\r
//\r
// Flags used when program the register.\r
//\r
typedef struct {\r
  volatile UINTN           ConsoleLogLock;          // Spinlock used to control console.\r
  volatile UINTN           MemoryMappedLock;        // Spinlock used to program mmio\r
  volatile UINT32          *CoreSemaphoreCount;     // Semaphore containers used to program Core semaphore.\r
  volatile UINT32          *PackageSemaphoreCount;  // Semaphore containers used to program Package semaphore.\r
} PROGRAM_CPU_REGISTER_FLAGS;\r
\r
typedef union {\r
  EFI_MP_SERVICES_PROTOCOL  *Protocol;\r
  EFI_PEI_MP_SERVICES_PPI   *Ppi;\r
} MP_SERVICES;\r
\r
typedef struct {\r
  UINTN                    FeaturesCount;\r
  UINT32                   BitMaskSize;\r
  LIST_ENTRY               FeatureList;\r
\r
  CPU_FEATURES_INIT_ORDER  *InitOrder;\r
  UINT8                    *CapabilityPcd;\r
  UINT8                    *SettingPcd;\r
\r
  UINT32                   NumberOfCpus;\r
  ACPI_CPU_DATA            *AcpiCpuData;\r
\r
  CPU_REGISTER_TABLE       *RegisterTable;\r
  CPU_REGISTER_TABLE       *PreSmmRegisterTable;\r
  UINTN                    BspNumber;\r
\r
  PROGRAM_CPU_REGISTER_FLAGS  CpuFlags;\r
\r
  MP_SERVICES              MpService;\r
} CPU_FEATURES_DATA;\r
\r
#define CPU_FEATURE_ENTRY_FROM_LINK(a) \\r
  CR ( \\r
  (a), \\r
  CPU_FEATURES_ENTRY, \\r
  Link, \\r
  CPU_FEATURE_ENTRY_SIGNATURE \\r
  )\r
\r
/**\r
  Worker function to get CPU_FEATURES_DATA pointer.\r
\r
  @return Pointer to CPU_FEATURES_DATA.\r
**/\r
CPU_FEATURES_DATA *\r
GetCpuFeaturesData (\r
  VOID\r
  );\r
\r
/**\r
  Worker function to return processor index.\r
\r
  @param  CpuFeaturesData    Cpu Feature Data structure.\r
\r
  @return  The processor index.\r
**/\r
UINTN\r
GetProcessorIndex (\r
  IN CPU_FEATURES_DATA        *CpuFeaturesData\r
  );\r
\r
/**\r
  Gets detailed MP-related information on the requested processor at the\r
  instant this call is made.\r
\r
  @param[in]  ProcessorNumber       The handle number of processor.\r
  @param[out] ProcessorInfoBuffer   A pointer to the buffer where information for\r
                                    the requested processor is deposited.\r
\r
  @return Status of MpServices->GetProcessorInfo().\r
**/\r
EFI_STATUS\r
GetProcessorInformation (\r
  IN  UINTN                            ProcessorNumber,\r
  OUT EFI_PROCESSOR_INFORMATION        *ProcessorInfoBuffer\r
  );\r
\r
/**\r
  Worker function to execute a caller provided function on all enabled APs.\r
\r
  @param[in]  Procedure               A pointer to the function to be run on\r
                                      enabled APs of the system.\r
  @param[in]  MpEvent                 A pointer to the event to be used later\r
                                      to check whether procedure has done.\r
**/\r
VOID\r
StartupAPsWorker (\r
  IN  EFI_AP_PROCEDURE                 Procedure,\r
  IN  EFI_EVENT                        MpEvent\r
  );\r
\r
/**\r
  Worker function to retrieve the number of logical processor in the platform.\r
\r
  @param[out] NumberOfCpus                Pointer to the total number of logical\r
                                          processors in the system, including the BSP\r
                                          and disabled APs.\r
  @param[out] NumberOfEnabledProcessors   Pointer to the number of enabled logical\r
                                          processors that exist in system, including\r
                                          the BSP.\r
**/\r
VOID\r
GetNumberOfProcessor (\r
  OUT UINTN                            *NumberOfCpus,\r
  OUT UINTN                            *NumberOfEnabledProcessors\r
  );\r
\r
/**\r
  Worker function to switch the requested AP to be the BSP from that point onward.\r
\r
  @param[in] ProcessorNumber   The handle number of AP that is to become the new BSP.\r
**/\r
VOID\r
SwitchNewBsp (\r
  IN  UINTN                            ProcessorNumber\r
  );\r
\r
/**\r
  Function that uses DEBUG() macros to display the contents of a a CPU feature bit mask.\r
\r
  @param[in]  FeatureMask  A pointer to the CPU feature bit mask.\r
**/\r
VOID\r
DumpCpuFeatureMask (\r
  IN UINT8               *FeatureMask\r
  );\r
\r
/**\r
  Dump CPU feature name or CPU feature bit mask.\r
\r
  @param[in]  CpuFeature   Pointer to CPU_FEATURES_ENTRY\r
**/\r
VOID\r
DumpCpuFeature (\r
  IN CPU_FEATURES_ENTRY  *CpuFeature\r
  );\r
\r
/**\r
  Return feature dependence result.\r
\r
  @param[in]  CpuFeature            Pointer to CPU feature.\r
  @param[in]  Before                Check before dependence or after.\r
  @param[in]  NextCpuFeatureMask    Pointer to next CPU feature Mask.\r
\r
  @retval     return the dependence result.\r
**/\r
CPU_FEATURE_DEPENDENCE_TYPE\r
DetectFeatureScope (\r
  IN CPU_FEATURES_ENTRY         *CpuFeature,\r
  IN BOOLEAN                    Before,\r
  IN UINT8                      *NextCpuFeatureMask\r
  );\r
\r
/**\r
  Return feature dependence result.\r
\r
  @param[in]  CpuFeature            Pointer to CPU feature.\r
  @param[in]  Before                Check before dependence or after.\r
  @param[in]  FeatureList           Pointer to CPU feature list.\r
\r
  @retval     return the dependence result.\r
**/\r
CPU_FEATURE_DEPENDENCE_TYPE\r
DetectNoneNeighborhoodFeatureScope (\r
  IN CPU_FEATURES_ENTRY         *CpuFeature,\r
  IN BOOLEAN                    Before,\r
  IN LIST_ENTRY                 *FeatureList\r
  );\r
\r
/**\r
  Programs registers for the calling processor.\r
\r
  @param[in,out] Buffer  The pointer to private data buffer.\r
\r
**/\r
VOID\r
EFIAPI\r
SetProcessorRegister (\r
  IN OUT VOID            *Buffer\r
  );\r
\r
/**\r
  Return ACPI_CPU_DATA data.\r
\r
  @return  Pointer to ACPI_CPU_DATA data.\r
**/\r
ACPI_CPU_DATA *\r
GetAcpiCpuData (\r
  VOID\r
  );\r
\r
/**\r
  Worker function to get MP service pointer.\r
\r
  @return MP_SERVICES variable.\r
**/\r
MP_SERVICES\r
GetMpService (\r
  VOID\r
  );\r
\r
#endif\r