Macros
#define	LOCAL_APIC_MODE_XAPIC 0x1
	xAPIC mode.

#define	LOCAL_APIC_MODE_X2APIC 0x2
	x2APIC mode.

Functions
UINTN EFIAPI	GetLocalApicBaseAddress (VOID)

VOID EFIAPI	SetLocalApicBaseAddress (IN UINTN BaseAddress)

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	SendStartupIpiAllExcludingSelf (IN UINT32 StartupRoutine)

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

Public include file for Local APIC library.

Local APIC library assumes local APIC is enabled. It does not handles cases where local APIC is disabled.

Copyright (c) 2010 - 2023, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file LocalApicLib.h.

Macro Definition Documentation

◆ LOCAL_APIC_MODE_X2APIC

#define LOCAL_APIC_MODE_X2APIC 0x2

x2APIC mode.

Definition at line 16 of file LocalApicLib.h.

◆ LOCAL_APIC_MODE_XAPIC

#define LOCAL_APIC_MODE_XAPIC 0x1

xAPIC mode.

Definition at line 15 of file LocalApicLib.h.

Function Documentation

◆ DisableApicTimerInterrupt()

VOID EFIAPI DisableApicTimerInterrupt ( VOID )

Disable the local APIC timer interrupt.

Definition at line 851 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 676 of file BaseXApicLib.c.

◆ EnableApicTimerInterrupt()

VOID EFIAPI EnableApicTimerInterrupt ( VOID )

Enable the local APIC timer interrupt.

Definition at line 835 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.

Get APIC ID of the executing processor.

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

Definition at line 337 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_XAPIC	current APIC mode is xAPIC.
LOCAL_APIC_MODE_X2APIC	current APIC mode is x2APIC.

Definition at line 242 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 900 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

Vector	The 8-bit interrupt vector associated with the MSI. Must be in the range 0x10..0xFE
DeliveryMode	A 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
LevelTriggered	TRUE specifies a level triggered interrupt. FALSE specifies an edge triggered interrupt.
AssertionLevel	Ignored 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 946 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 712 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 698 of file BaseXApicLib.c.

◆ GetApicTimerInterruptState()

BOOLEAN EFIAPI GetApicTimerInterruptState ( VOID )

Get the local APIC timer interrupt state.

Return values

TRUE	The local APIC timer interrupt is enabled.
FALSE	The local APIC timer interrupt is disabled.

Definition at line 870 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.

Parameters

DivideValue	Return the divide value for the DCR. It is one of 1,2,4,8,16,32,64,128.
PeriodicMode	Return the timer mode. If TRUE, timer mode is peridoic. Othewise, timer mode is one-shot.
Vector	Return the timer interrupt vector number.

Get the state of the local APIC timer.

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

Parameters

DivideValue	Return the divide value for the DCR. It is one of 1,2,4,8,16,32,64,128.
PeriodicMode	Return the timer mode. If TRUE, timer mode is peridoic. Othewise, timer mode is one-shot.
Vector	Return the timer interrupt vector number.

Definition at line 790 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 364 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 298 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 66 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/Module ID/Tile ID/Die 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]	InitialApicId	Initial APIC ID of the target logical processor.
[out]	Package	Returns the processor package ID.
[out]	Die	Returns the processor die ID.
[out]	Tile	Returns the processor tile ID.
[out]	Module	Returns the processor module ID.
[out]	Core	Returns the processor core ID.
[out]	Thread	Returns the processor thread ID.

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]	InitialApicId	Initial APIC ID of the target logical processor.
[out]	Package	Returns the processor package ID.
[out]	Die	Returns the processor die ID.
[out]	Tile	Returns the processor tile ID.
[out]	Module	Returns the processor module ID.
[out]	Core	Returns the processor core ID.
[out]	Thread	Returns the processor thread ID.

Definition at line 1297 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]	InitialApicId	Initial APIC ID of the target logical processor.
[out]	Package	Returns the processor package ID.
[out]	Core	Returns the processor core ID.
[out]	Thread	Returns the processor thread ID.

Definition at line 985 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

DivideValue	The 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.
InitCount	The initial count value.
PeriodicMode	If TRUE, timer mode is peridoic. Othewise, timer mode is one-shot.
Vector	The timer interrupt vector number.

Definition at line 732 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

Enable If TRUE, then set SoftwareEnable to 1 If FALSE, then set SoftwareEnable to 0.

Definition at line 600 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 633 of file BaseXApicLib.c.

◆ SendApicEoi()

VOID EFIAPI SendApicEoi ( VOID )

Send EOI to the local APIC.

Definition at line 885 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

ApicId	The local APIC ID of the target processor.
Vector	The vector number of the interrupt being sent.

Definition at line 381 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

Vector The vector number of the interrupt being sent.

Definition at line 404 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

ApicId Specify the local APIC ID of the target processor.

Definition at line 468 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 487 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

ApicId	Specify the local APIC ID of the target processor.
StartupRoutine	Points to a start-up routine which is below 1M physical address and 4K aligned.

Definition at line 541 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

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

Definition at line 577 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

ApicId Specify the local APIC ID of the target processor.

Definition at line 427 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 446 of file BaseXApicLib.c.

◆ SendStartupIpiAllExcludingSelf()

VOID EFIAPI SendStartupIpiAllExcludingSelf ( IN UINT32 StartupRoutine )

Send a Start-up IPI 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

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

Definition at line 510 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

ApicMode APIC 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 279 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] BaseAddress Local APIC base address to be set.

Definition at line 96 of file BaseXApicLib.c.

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ LOCAL_APIC_MODE_X2APIC

◆ LOCAL_APIC_MODE_XAPIC

Function Documentation

◆ DisableApicTimerInterrupt()

◆ DisableLvtInterrupts()

◆ EnableApicTimerInterrupt()

◆ GetApicId()

◆ GetApicMode()

◆ GetApicMsiAddress()

◆ GetApicMsiValue()

◆ GetApicTimerCurrentCount()

◆ GetApicTimerInitCount()

◆ GetApicTimerInterruptState()

◆ GetApicTimerState()

◆ GetApicVersion()

◆ GetInitialApicId()

◆ GetLocalApicBaseAddress()

◆ GetProcessorLocation2ByApicId()

◆ GetProcessorLocationByApicId()

◆ InitializeApicTimer()

◆ InitializeLocalApicSoftwareEnable()

◆ ProgramVirtualWireMode()

◆ SendApicEoi()

◆ SendFixedIpi()

◆ SendFixedIpiAllExcludingSelf()

◆ SendInitIpi()

◆ SendInitIpiAllExcludingSelf()

◆ SendInitSipiSipi()

◆ SendInitSipiSipiAllExcludingSelf()

◆ SendSmiIpi()

◆ SendSmiIpiAllExcludingSelf()

◆ SendStartupIpiAllExcludingSelf()

◆ SetApicMode()

◆ SetLocalApicBaseAddress()