TianoCore EDK2 master
BaseXApicLib.c File Reference

Go to the source code of this file.

Functions

BOOLEAN LocalApicBaseAddressMsrSupported (VOID)
 
UINTN EFIAPI GetLocalApicBaseAddress (VOID)
 
VOID EFIAPI SetLocalApicBaseAddress (IN UINTN BaseAddress)
 
UINT32 EFIAPI ReadLocalApicReg (IN UINTN MmioOffset)
 
VOID EFIAPI WriteLocalApicReg (IN UINTN MmioOffset, IN UINT32 Value)
 
VOID SendIpi (IN UINT32 IcrLow, IN UINT32 ApicId)
 
UINTN EFIAPI GetApicMode (VOID)
 
VOID EFIAPI SetApicMode (IN UINTN ApicMode)
 
UINT32 EFIAPI GetInitialApicId (VOID)
 
UINT32 EFIAPI GetApicId (VOID)
 
UINT32 EFIAPI GetApicVersion (VOID)
 
VOID EFIAPI SendFixedIpi (IN UINT32 ApicId, IN UINT8 Vector)
 
VOID EFIAPI SendFixedIpiAllExcludingSelf (IN UINT8 Vector)
 
VOID EFIAPI SendSmiIpi (IN UINT32 ApicId)
 
VOID EFIAPI SendSmiIpiAllExcludingSelf (VOID)
 
VOID EFIAPI SendInitIpi (IN UINT32 ApicId)
 
VOID EFIAPI SendInitIpiAllExcludingSelf (VOID)
 
VOID EFIAPI SendInitSipiSipi (IN UINT32 ApicId, IN UINT32 StartupRoutine)
 
VOID EFIAPI SendInitSipiSipiAllExcludingSelf (IN UINT32 StartupRoutine)
 
VOID EFIAPI InitializeLocalApicSoftwareEnable (IN BOOLEAN Enable)
 
VOID EFIAPI ProgramVirtualWireMode (VOID)
 
VOID EFIAPI DisableLvtInterrupts (VOID)
 
UINT32 EFIAPI GetApicTimerInitCount (VOID)
 
UINT32 EFIAPI GetApicTimerCurrentCount (VOID)
 
VOID EFIAPI InitializeApicTimer (IN UINTN DivideValue, IN UINT32 InitCount, IN BOOLEAN PeriodicMode, IN UINT8 Vector)
 
VOID EFIAPI GetApicTimerState (OUT UINTN *DivideValue OPTIONAL, OUT BOOLEAN *PeriodicMode OPTIONAL, OUT UINT8 *Vector OPTIONAL)
 
VOID EFIAPI EnableApicTimerInterrupt (VOID)
 
VOID EFIAPI DisableApicTimerInterrupt (VOID)
 
BOOLEAN EFIAPI GetApicTimerInterruptState (VOID)
 
VOID EFIAPI SendApicEoi (VOID)
 
UINT32 EFIAPI GetApicMsiAddress (VOID)
 
UINT64 EFIAPI GetApicMsiValue (IN UINT8 Vector, IN UINTN DeliveryMode, IN BOOLEAN LevelTriggered, IN BOOLEAN AssertionLevel)
 
VOID EFIAPI GetProcessorLocationByApicId (IN UINT32 InitialApicId, OUT UINT32 *Package OPTIONAL, OUT UINT32 *Core OPTIONAL, OUT UINT32 *Thread OPTIONAL)
 
VOID EFIAPI GetProcessorLocation2ByApicId (IN UINT32 InitialApicId, OUT UINT32 *Package OPTIONAL, OUT UINT32 *Die OPTIONAL, OUT UINT32 *Tile OPTIONAL, OUT UINT32 *Module OPTIONAL, OUT UINT32 *Core OPTIONAL, OUT UINT32 *Thread OPTIONAL)
 

Detailed Description

Local APIC Library.

This local APIC library instance supports xAPIC mode only.

Copyright (c) 2010 - 2019, Intel Corporation. All rights reserved.
Copyright (c) 2017 - 2020, AMD Inc. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file BaseXApicLib.c.

Function Documentation

◆ DisableApicTimerInterrupt()

VOID EFIAPI DisableApicTimerInterrupt ( VOID  )

Disable the local APIC timer interrupt.

Definition at line 835 of file BaseXApicLib.c.

◆ DisableLvtInterrupts()

VOID EFIAPI DisableLvtInterrupts ( VOID  )

Disable LINT0 & LINT1 interrupts.

This function sets the mask flag in the LVT LINT0 & LINT1 registers.

Definition at line 660 of file BaseXApicLib.c.

◆ EnableApicTimerInterrupt()

VOID EFIAPI EnableApicTimerInterrupt ( VOID  )

Enable the local APIC timer interrupt.

Definition at line 819 of file BaseXApicLib.c.

◆ GetApicId()

UINT32 EFIAPI GetApicId ( VOID  )

Get the local APIC ID of the executing processor.

Returns
32-bit local APIC ID of the executing processor.

Definition at line 338 of file BaseXApicLib.c.

◆ GetApicMode()

UINTN EFIAPI GetApicMode ( VOID  )

Get the current local APIC mode.

If local APIC is disabled, then ASSERT.

Return values
LOCAL_APIC_MODE_XAPICcurrent APIC mode is xAPIC.
LOCAL_APIC_MODE_X2APICcurrent APIC mode is x2APIC.

Definition at line 243 of file BaseXApicLib.c.

◆ GetApicMsiAddress()

UINT32 EFIAPI GetApicMsiAddress ( VOID  )

Get the 32-bit address that a device should use to send a Message Signaled Interrupt (MSI) to the Local APIC of the currently executing processor.

Returns
32-bit address used to send an MSI to the Local APIC.

Definition at line 884 of file BaseXApicLib.c.

◆ GetApicMsiValue()

UINT64 EFIAPI GetApicMsiValue ( IN UINT8  Vector,
IN UINTN  DeliveryMode,
IN BOOLEAN  LevelTriggered,
IN BOOLEAN  AssertionLevel 
)

Get the 64-bit data value that a device should use to send a Message Signaled Interrupt (MSI) to the Local APIC of the currently executing processor.

If Vector is not in range 0x10..0xFE, then ASSERT(). If DeliveryMode is not supported, then ASSERT().

Parameters
VectorThe 8-bit interrupt vector associated with the MSI. Must be in the range 0x10..0xFE
DeliveryModeA 3-bit value that specifies how the recept of the MSI is handled. The only supported values are: 0: LOCAL_APIC_DELIVERY_MODE_FIXED 1: LOCAL_APIC_DELIVERY_MODE_LOWEST_PRIORITY 2: LOCAL_APIC_DELIVERY_MODE_SMI 4: LOCAL_APIC_DELIVERY_MODE_NMI 5: LOCAL_APIC_DELIVERY_MODE_INIT 7: LOCAL_APIC_DELIVERY_MODE_EXTINT
LevelTriggeredTRUE specifies a level triggered interrupt. FALSE specifies an edge triggered interrupt.
AssertionLevelIgnored if LevelTriggered is FALSE. TRUE specifies a level triggered interrupt that active when the interrupt line is asserted. FALSE specifies a level triggered interrupt that active when the interrupt line is deasserted.
Returns
64-bit data value used to send an MSI to the Local APIC.

Definition at line 930 of file BaseXApicLib.c.

◆ GetApicTimerCurrentCount()

UINT32 EFIAPI GetApicTimerCurrentCount ( VOID  )

Read the current count value from the current-count register.

Returns
The current count value read from the current-count register.

Definition at line 696 of file BaseXApicLib.c.

◆ GetApicTimerInitCount()

UINT32 EFIAPI GetApicTimerInitCount ( VOID  )

Read the initial count value from the init-count register.

Returns
The initial count value read from the init-count register.

Definition at line 682 of file BaseXApicLib.c.

◆ GetApicTimerInterruptState()

BOOLEAN EFIAPI GetApicTimerInterruptState ( VOID  )

Get the local APIC timer interrupt state.

Return values
TRUEThe local APIC timer interrupt is enabled.
FALSEThe local APIC timer interrupt is disabled.

Definition at line 854 of file BaseXApicLib.c.

◆ GetApicTimerState()

VOID EFIAPI GetApicTimerState ( OUT UINTN *DivideValue  OPTIONAL,
OUT BOOLEAN *PeriodicMode  OPTIONAL,
OUT UINT8 *Vector  OPTIONAL 
)

Get the state of the local APIC timer.

This function will ASSERT if the local APIC is not software enabled.

Parameters
DivideValueReturn the divide value for the DCR. It is one of 1,2,4,8,16,32,64,128.
PeriodicModeReturn the timer mode. If TRUE, timer mode is peridoic. Othewise, timer mode is one-shot.
VectorReturn the timer interrupt vector number.

Definition at line 774 of file BaseXApicLib.c.

◆ GetApicVersion()

UINT32 EFIAPI GetApicVersion ( VOID  )

Get the value of the local APIC version register.

Returns
the value of the local APIC version register.

Definition at line 365 of file BaseXApicLib.c.

◆ GetInitialApicId()

UINT32 EFIAPI GetInitialApicId ( VOID  )

Get the initial local APIC ID of the executing processor assigned by hardware upon power on or reset.

In xAPIC mode, the initial local APIC ID may be different from current APIC ID. In x2APIC mode, the local APIC ID can't be changed and there is no concept of initial APIC ID. In this case, the 32-bit local APIC ID is returned as initial APIC ID.

Returns
32-bit initial local APIC ID of the executing processor.

Definition at line 299 of file BaseXApicLib.c.

◆ GetLocalApicBaseAddress()

UINTN EFIAPI GetLocalApicBaseAddress ( VOID  )

Retrieve the base address of local APIC.

Returns
The base address of local APIC.

Definition at line 67 of file BaseXApicLib.c.

◆ GetProcessorLocation2ByApicId()

VOID EFIAPI GetProcessorLocation2ByApicId ( IN UINT32  InitialApicId,
OUT UINT32 *Package  OPTIONAL,
OUT UINT32 *Die  OPTIONAL,
OUT UINT32 *Tile  OPTIONAL,
OUT UINT32 *Module  OPTIONAL,
OUT UINT32 *Core  OPTIONAL,
OUT UINT32 *Thread  OPTIONAL 
)

Get Package ID/Die ID/Tile ID/Module ID/Core ID/Thread ID of a processor.

The algorithm assumes the target system has symmetry across physical package boundaries with respect to the number of threads per core, number of cores per module, number of modules per tile, number of tiles per die, number of dies per package.

Parameters
[in]InitialApicIdInitial APIC ID of the target logical processor.
[out]PackageReturns the processor package ID.
[out]DieReturns the processor die ID.
[out]TileReturns the processor tile ID.
[out]ModuleReturns the processor module ID.
[out]CoreReturns the processor core ID.
[out]ThreadReturns the processor thread ID.

Definition at line 1161 of file BaseXApicLib.c.

◆ GetProcessorLocationByApicId()

VOID EFIAPI GetProcessorLocationByApicId ( IN UINT32  InitialApicId,
OUT UINT32 *Package  OPTIONAL,
OUT UINT32 *Core  OPTIONAL,
OUT UINT32 *Thread  OPTIONAL 
)

Get Package ID/Core ID/Thread ID of a processor.

The algorithm assumes the target system has symmetry across physical package boundaries with respect to the number of logical processors per package, number of cores per package.

Parameters
[in]InitialApicIdInitial APIC ID of the target logical processor.
[out]PackageReturns the processor package ID.
[out]CoreReturns the processor core ID.
[out]ThreadReturns the processor thread ID.

Definition at line 969 of file BaseXApicLib.c.

◆ InitializeApicTimer()

VOID EFIAPI InitializeApicTimer ( IN UINTN  DivideValue,
IN UINT32  InitCount,
IN BOOLEAN  PeriodicMode,
IN UINT8  Vector 
)

Initialize the local APIC timer.

The local APIC timer is initialized and enabled.

Parameters
DivideValueThe divide value for the DCR. It is one of 1,2,4,8,16,32,64,128. If it is 0, then use the current divide value in the DCR.
InitCountThe initial count value.
PeriodicModeIf TRUE, timer mode is peridoic. Othewise, timer mode is one-shot.
VectorThe timer interrupt vector number.

Definition at line 716 of file BaseXApicLib.c.

◆ InitializeLocalApicSoftwareEnable()

VOID EFIAPI InitializeLocalApicSoftwareEnable ( IN BOOLEAN  Enable)

Initialize the state of the SoftwareEnable bit in the Local APIC Spurious Interrupt Vector register.

Parameters
EnableIf TRUE, then set SoftwareEnable to 1 If FALSE, then set SoftwareEnable to 0.

Definition at line 584 of file BaseXApicLib.c.

◆ LocalApicBaseAddressMsrSupported()

BOOLEAN LocalApicBaseAddressMsrSupported ( VOID  )

Determine if the CPU supports the Local APIC Base Address MSR.

Return values
TRUEThe CPU supports the Local APIC Base Address MSR.
FALSEThe CPU does not support the Local APIC Base Address MSR.

Definition at line 39 of file BaseXApicLib.c.

◆ ProgramVirtualWireMode()

VOID EFIAPI ProgramVirtualWireMode ( VOID  )

Programming Virtual Wire Mode.

This function programs the local APIC for virtual wire mode following the example described in chapter A.3 of the MP 1.4 spec.

IOxAPIC is not involved in this type of virtual wire mode.

Definition at line 617 of file BaseXApicLib.c.

◆ ReadLocalApicReg()

UINT32 EFIAPI ReadLocalApicReg ( IN UINTN  MmioOffset)

Read from a local APIC register.

This function reads from a local APIC register either in xAPIC or x2APIC mode. It is required that in xAPIC mode wider registers (64-bit or 256-bit) must be accessed using multiple 32-bit loads or stores, so this function only performs 32-bit read.

Parameters
MmioOffsetThe MMIO offset of the local APIC register in xAPIC mode. It must be 16-byte aligned.
Returns
32-bit Value read from the register.

Definition at line 135 of file BaseXApicLib.c.

◆ SendApicEoi()

VOID EFIAPI SendApicEoi ( VOID  )

Send EOI to the local APIC.

Definition at line 869 of file BaseXApicLib.c.

◆ SendFixedIpi()

VOID EFIAPI SendFixedIpi ( IN UINT32  ApicId,
IN UINT8  Vector 
)

Send a Fixed IPI to a specified target processor.

This function returns after the IPI has been accepted by the target processor.

Parameters
ApicIdThe local APIC ID of the target processor.
VectorThe vector number of the interrupt being sent.

Definition at line 382 of file BaseXApicLib.c.

◆ SendFixedIpiAllExcludingSelf()

VOID EFIAPI SendFixedIpiAllExcludingSelf ( IN UINT8  Vector)

Send a Fixed IPI to all processors excluding self.

This function returns after the IPI has been accepted by the target processors.

Parameters
VectorThe vector number of the interrupt being sent.

Definition at line 405 of file BaseXApicLib.c.

◆ SendInitIpi()

VOID EFIAPI SendInitIpi ( IN UINT32  ApicId)

Send an INIT IPI to a specified target processor.

This function returns after the IPI has been accepted by the target processor.

Parameters
ApicIdSpecify the local APIC ID of the target processor.

Definition at line 469 of file BaseXApicLib.c.

◆ SendInitIpiAllExcludingSelf()

VOID EFIAPI SendInitIpiAllExcludingSelf ( VOID  )

Send an INIT IPI to all processors excluding self.

This function returns after the IPI has been accepted by the target processors.

Definition at line 488 of file BaseXApicLib.c.

◆ SendInitSipiSipi()

VOID EFIAPI SendInitSipiSipi ( IN UINT32  ApicId,
IN UINT32  StartupRoutine 
)

Send an INIT-Start-up-Start-up IPI sequence to a specified target processor.

This function returns after the IPI has been accepted by the target processor.

if StartupRoutine >= 1M, then ASSERT. if StartupRoutine is not multiple of 4K, then ASSERT.

Parameters
ApicIdSpecify the local APIC ID of the target processor.
StartupRoutinePoints to a start-up routine which is below 1M physical address and 4K aligned.

Definition at line 515 of file BaseXApicLib.c.

◆ SendInitSipiSipiAllExcludingSelf()

VOID EFIAPI SendInitSipiSipiAllExcludingSelf ( IN UINT32  StartupRoutine)

Send an INIT-Start-up-Start-up IPI sequence to all processors excluding self.

This function returns after the IPI has been accepted by the target processors.

if StartupRoutine >= 1M, then ASSERT. if StartupRoutine is not multiple of 4K, then ASSERT.

Parameters
StartupRoutinePoints to a start-up routine which is below 1M physical address and 4K aligned.

Definition at line 551 of file BaseXApicLib.c.

◆ SendIpi()

VOID SendIpi ( IN UINT32  IcrLow,
IN UINT32  ApicId 
)

Send an IPI by writing to ICR.

This function returns after the IPI has been accepted by the target processor.

Parameters
IcrLow32-bit value to be written to the low half of ICR.
ApicIdAPIC ID of the target processor if this IPI is targeted for a specific processor.

Definition at line 181 of file BaseXApicLib.c.

◆ SendSmiIpi()

VOID EFIAPI SendSmiIpi ( IN UINT32  ApicId)

Send a SMI IPI to a specified target processor.

This function returns after the IPI has been accepted by the target processor.

Parameters
ApicIdSpecify the local APIC ID of the target processor.

Definition at line 428 of file BaseXApicLib.c.

◆ SendSmiIpiAllExcludingSelf()

VOID EFIAPI SendSmiIpiAllExcludingSelf ( VOID  )

Send a SMI IPI to all processors excluding self.

This function returns after the IPI has been accepted by the target processors.

Definition at line 447 of file BaseXApicLib.c.

◆ SetApicMode()

VOID EFIAPI SetApicMode ( IN UINTN  ApicMode)

Set the current local APIC mode.

If the specified local APIC mode is not valid, then ASSERT. If the specified local APIC mode can't be set as current, then ASSERT.

Parameters
ApicModeAPIC mode to be set.
Note
This API must not be called from an interrupt handler or SMI handler. It may result in unpredictable behavior.

Definition at line 280 of file BaseXApicLib.c.

◆ SetLocalApicBaseAddress()

VOID EFIAPI SetLocalApicBaseAddress ( IN UINTN  BaseAddress)

Set the base address of local APIC.

If BaseAddress is not aligned on a 4KB boundary, then ASSERT().

Parameters
[in]BaseAddressLocal APIC base address to be set.

Definition at line 97 of file BaseXApicLib.c.

◆ WriteLocalApicReg()

VOID EFIAPI WriteLocalApicReg ( IN UINTN  MmioOffset,
IN UINT32  Value 
)

Write to a local APIC register.

This function writes to a local APIC register either in xAPIC or x2APIC mode. It is required that in xAPIC mode wider registers (64-bit or 256-bit) must be accessed using multiple 32-bit loads or stores, so this function only performs 32-bit write.

if the register index is invalid or unsupported in current APIC mode, then ASSERT.

Parameters
MmioOffsetThe MMIO offset of the local APIC register in xAPIC mode. It must be 16-byte aligned.
ValueValue to be written to the register.

Definition at line 161 of file BaseXApicLib.c.