UefiCpuPkg/MpInitLib: Add MP_ASSEMBLY_ADDRESS_MAP

[mirror_edk2.git] / UefiCpuPkg / Library / MpInitLib / MpLib.c

/** @file\r
  CPU MP Initialize Library common functions.\r
\r
  Copyright (c) 2016, 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
#include "MpLib.h"\r
\r
\r
/**\r
  MP Initialize Library initialization.\r
\r
  This service will allocate AP reset vector and wakeup all APs to do APs\r
  initialization.\r
\r
  This service must be invoked before all other MP Initialize Library\r
  service are invoked.\r
\r
  @retval  EFI_SUCCESS           MP initialization succeeds.\r
  @retval  Others                MP initialization fails.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
MpInitLibInitialize (\r
  VOID\r
  )\r
{\r
  MP_ASSEMBLY_ADDRESS_MAP  AddressMap;\r
  UINTN                    ApResetVectorSize;\r
\r
  AsmGetAddressMap (&AddressMap);\r
  ApResetVectorSize = AddressMap.RendezvousFunnelSize + sizeof (MP_CPU_EXCHANGE_INFO);\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Gets detailed MP-related information on the requested processor at the\r
  instant this call is made. This service may only be called from the BSP.\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
  @param[out]  HealthData            Return processor health data.\r
\r
  @retval EFI_SUCCESS             Processor information was returned.\r
  @retval EFI_DEVICE_ERROR        The calling processor is an AP.\r
  @retval EFI_INVALID_PARAMETER   ProcessorInfoBuffer is NULL.\r
  @retval EFI_NOT_FOUND           The processor with the handle specified by\r
                                  ProcessorNumber does not exist in the platform.\r
  @retval EFI_NOT_READY           MP Initialize Library is not initialized.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
MpInitLibGetProcessorInfo (\r
  IN  UINTN                      ProcessorNumber,\r
  OUT EFI_PROCESSOR_INFORMATION  *ProcessorInfoBuffer,\r
  OUT EFI_HEALTH_FLAGS           *HealthData  OPTIONAL\r
  )\r
{\r
  return EFI_UNSUPPORTED;\r
}\r
/**\r
  This return the handle number for the calling processor.  This service may be\r
  called from the BSP and APs.\r
\r
  @param[out] ProcessorNumber  Pointer to the handle number of AP.\r
                               The range is from 0 to the total number of\r
                               logical processors minus 1. The total number of\r
                               logical processors can be retrieved by\r
                               MpInitLibGetNumberOfProcessors().\r
\r
  @retval EFI_SUCCESS             The current processor handle number was returned\r
                                  in ProcessorNumber.\r
  @retval EFI_INVALID_PARAMETER   ProcessorNumber is NULL.\r
  @retval EFI_NOT_READY           MP Initialize Library is not initialized.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
MpInitLibWhoAmI (\r
  OUT UINTN                    *ProcessorNumber\r
  )\r
{\r
  return EFI_UNSUPPORTED;\r
}\r
/**\r
  Retrieves the number of logical processor in the platform and the number of\r
  those logical processors that are enabled on this boot. This service may only\r
  be called from the BSP.\r
\r
  @param[out] NumberOfProcessors          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
  @retval EFI_SUCCESS             The number of logical processors and enabled\r
                                  logical processors was retrieved.\r
  @retval EFI_DEVICE_ERROR        The calling processor is an AP.\r
  @retval EFI_INVALID_PARAMETER   NumberOfProcessors is NULL and NumberOfEnabledProcessors\r
                                  is NULL.\r
  @retval EFI_NOT_READY           MP Initialize Library is not initialized.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
MpInitLibGetNumberOfProcessors (\r
  OUT UINTN                     *NumberOfProcessors,       OPTIONAL\r
  OUT UINTN                     *NumberOfEnabledProcessors OPTIONAL\r
  )\r
{\r
  return EFI_UNSUPPORTED;\r
}\r