UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm

[mirror_edk2.git] / PcAtChipsetPkg / Include / Library / IoApicLib.h

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