mirror of
https://github.com/CloverHackyColor/CloverBootloader.git
synced 2024-11-30 12:43:41 +01:00
100 lines
3.2 KiB
C
100 lines
3.2 KiB
C
/** @file
|
|
Public include file for I/O APIC library.
|
|
|
|
I/O APIC library assumes I/O APIC is enabled. It does not
|
|
handles cases where I/O APIC is disabled.
|
|
|
|
Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
#ifndef __IO_APIC_LIB_H__
|
|
#define __IO_APIC_LIB_H__
|
|
|
|
/**
|
|
Read a 32-bit I/O APIC register.
|
|
|
|
If Index is >= 0x100, then ASSERT().
|
|
|
|
@param Index Specifies the I/O APIC register to read.
|
|
|
|
@return The 32-bit value read from the I/O APIC register specified by Index.
|
|
**/
|
|
UINT32
|
|
EFIAPI
|
|
IoApicRead (
|
|
IN UINTN Index
|
|
);
|
|
|
|
/**
|
|
Write a 32-bit I/O APIC register.
|
|
|
|
If Index is >= 0x100, then ASSERT().
|
|
|
|
@param Index Specifies the I/O APIC register to write.
|
|
@param Value Specifies the value to write to the I/O APIC register specified by Index.
|
|
|
|
@return The 32-bit value written to I/O APIC register specified by Index.
|
|
**/
|
|
UINT32
|
|
EFIAPI
|
|
IoApicWrite (
|
|
IN UINTN Index,
|
|
IN UINT32 Value
|
|
);
|
|
|
|
/**
|
|
Set the interrupt mask of an I/O APIC interrupt.
|
|
|
|
If Irq is larger than the maximum number I/O APIC redirection entries, then ASSERT().
|
|
|
|
@param Irq Specifies the I/O APIC interrupt to enable or disable.
|
|
@param Enable If TRUE, then enable the I/O APIC interrupt specified by Irq.
|
|
If FALSE, then disable the I/O APIC interrupt specified by Irq.
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
IoApicEnableInterrupt (
|
|
IN UINTN Irq,
|
|
IN BOOLEAN Enable
|
|
);
|
|
|
|
/**
|
|
Configures an I/O APIC interrupt.
|
|
|
|
Configure an I/O APIC Redirection Table Entry to deliver an interrupt in physical
|
|
mode to the Local APIC of the currntly executing CPU. The default state of the
|
|
entry is for the interrupt to be disabled (masked). IoApicEnableInterrupts() must
|
|
be used to enable(unmask) the I/O APIC Interrupt.
|
|
|
|
If Irq is larger than the maximum number I/O APIC redirection entries, then ASSERT().
|
|
If Vector >= 0x100, then ASSERT().
|
|
If DeliveryMode is not supported, then ASSERT().
|
|
|
|
@param Irq Specifies the I/O APIC interrupt to initialize.
|
|
@param Vector The 8-bit interrupt vector associated with the I/O APIC
|
|
Interrupt. Must be in the range 0x10..0xFE.
|
|
@param DeliveryMode A 3-bit value that specifies how the recept of the I/O APIC
|
|
interrupt is handled. The only supported values are:
|
|
0: IO_APIC_DELIVERY_MODE_FIXED
|
|
1: IO_APIC_DELIVERY_MODE_LOWEST_PRIORITY
|
|
2: IO_APIC_DELIVERY_MODE_SMI
|
|
4: IO_APIC_DELIVERY_MODE_NMI
|
|
5: IO_APIC_DELIVERY_MODE_INIT
|
|
7: IO_APIC_DELIVERY_MODE_EXTINT
|
|
@param LevelTriggered TRUE specifies a level triggered interrupt.
|
|
FALSE specifies an edge triggered interrupt.
|
|
@param AssertionLevel TRUE specified an active high interrupt.
|
|
FALSE specifies an active low interrupt.
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
IoApicConfigureInterrupt (
|
|
IN UINTN Irq,
|
|
IN UINTN Vector,
|
|
IN UINTN DeliveryMode,
|
|
IN BOOLEAN LevelTriggered,
|
|
IN BOOLEAN AssertionLevel
|
|
);
|
|
#endif
|