UefiCpuPkg/Include/Register/LocalApic.h

   1 /** @file
   2   IA32 Local APIC Definitions.
   3
   4   Copyright (c) 2010 - 2013, Intel Corporation. All rights reserved.<BR>
   5   This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef __LOCAL_APIC_H__
  16 #define __LOCAL_APIC_H__
  17
  18 //
  19 // Definitions for IA32 architectural MSRs
  20 //
  21 #define MSR_IA32_APIC_BASE_ADDRESS              0x1B
  22
  23 //
  24 // Definitions for CPUID instruction
  25 //
  26 #define CPUID_SIGNATURE                         0x0
  27 #define CPUID_VERSION_INFO                      0x1
  28 #define CPUID_EXTENDED_TOPOLOGY                 0xB
  29 #define CPUID_EXTENDED_FUNCTION                 0x80000000
  30 #define CPUID_VIR_PHY_ADDRESS_SIZE              0x80000008
  31
  32 //
  33 // Definition for Local APIC registers and related values
  34 //
  35 #define XAPIC_ID_OFFSET                         0x20
  36 #define XAPIC_VERSION_OFFSET                    0x30
  37 #define XAPIC_EOI_OFFSET                        0x0b0
  38 #define XAPIC_ICR_DFR_OFFSET                    0x0e0
  39 #define XAPIC_SPURIOUS_VECTOR_OFFSET            0x0f0
  40 #define XAPIC_ICR_LOW_OFFSET                    0x300
  41 #define XAPIC_ICR_HIGH_OFFSET                   0x310
  42 #define XAPIC_LVT_TIMER_OFFSET                  0x320
  43 #define XAPIC_LVT_LINT0_OFFSET                  0x350
  44 #define XAPIC_LVT_LINT1_OFFSET                  0x360
  45 #define XAPIC_TIMER_INIT_COUNT_OFFSET           0x380
  46 #define XAPIC_TIMER_CURRENT_COUNT_OFFSET        0x390
  47 #define XAPIC_TIMER_DIVIDE_CONFIGURATION_OFFSET 0x3E0
  48
  49 #define X2APIC_MSR_BASE_ADDRESS                 0x800
  50 #define X2APIC_MSR_ICR_ADDRESS                  0x830
  51
  52 #define LOCAL_APIC_DELIVERY_MODE_FIXED           0
  53 #define LOCAL_APIC_DELIVERY_MODE_LOWEST_PRIORITY 1
  54 #define LOCAL_APIC_DELIVERY_MODE_SMI             2
  55 #define LOCAL_APIC_DELIVERY_MODE_NMI             4
  56 #define LOCAL_APIC_DELIVERY_MODE_INIT            5
  57 #define LOCAL_APIC_DELIVERY_MODE_STARTUP         6
  58 #define LOCAL_APIC_DELIVERY_MODE_EXTINT          7
  59
  60 #define LOCAL_APIC_DESTINATION_SHORTHAND_NO_SHORTHAND       0
  61 #define LOCAL_APIC_DESTINATION_SHORTHAND_SELF               1
  62 #define LOCAL_APIC_DESTINATION_SHORTHAND_ALL_INCLUDING_SELF 2
  63 #define LOCAL_APIC_DESTINATION_SHORTHAND_ALL_EXCLUDING_SELF 3
  64
  65 typedef union {
  66   struct {
  67     UINT32  Reserved0:8;     ///< Reserved.
  68     UINT32  Bsp:1;           ///< Processor is BSP.
  69     UINT32  Reserved1:1;     ///< Reserved.
  70     UINT32  Extd:1;          ///< Enable x2APIC mode.
  71     UINT32  En:1;            ///< xAPIC global enable/disable.
  72     UINT32  ApicBaseLow:20;  ///< APIC Base physical address. The actual field width depends on physical address width.
  73     UINT32  ApicBaseHigh:32;
  74   } Bits;
  75   UINT64    Uint64;
  76 } MSR_IA32_APIC_BASE;
  77
  78 //
  79 // Local APIC Version Register.
  80 //
  81 typedef union {
  82   struct {
  83     UINT32  Version:8;                  ///< The version numbers of the local APIC.
  84     UINT32  Reserved0:8;                ///< Reserved.
  85     UINT32  MaxLvtEntry:8;              ///< Number of LVT entries minus 1.
  86     UINT32  EoiBroadcastSuppression:1;  ///< 1 if EOI-broadcast suppression supported.
  87     UINT32  Reserved1:7;                ///< Reserved.
  88   } Bits;
  89   UINT32    Uint32;
  90 } LOCAL_APIC_VERSION;
  91
  92 //
  93 // Low half of Interrupt Command Register (ICR).
  94 //
  95 typedef union {
  96   struct {
  97     UINT32  Vector:8;                ///< The vector number of the interrupt being sent.
  98     UINT32  DeliveryMode:3;          ///< Specifies the type of IPI to be sent.
  99     UINT32  DestinationMode:1;       ///< 0: physical destination mode, 1: logical destination mode.
 100     UINT32  DeliveryStatus:1;        ///< Indicates the IPI delivery status. This field is reserved in x2APIC mode.
 101     UINT32  Reserved0:1;             ///< Reserved.
 102     UINT32  Level:1;                 ///< 0 for the INIT level de-assert delivery mode. Otherwise 1.
 103     UINT32  TriggerMode:1;           ///< 0: edge, 1: level when using the INIT level de-assert delivery mode.
 104     UINT32  Reserved1:2;             ///< Reserved.
 105     UINT32  DestinationShorthand:2;  ///< A shorthand notation to specify the destination of the interrupt.
 106     UINT32  Reserved2:12;            ///< Reserved.
 107   } Bits;
 108   UINT32    Uint32;
 109 } LOCAL_APIC_ICR_LOW;
 110
 111 //
 112 // High half of Interrupt Command Register (ICR)
 113 //
 114 typedef union {
 115   struct {
 116     UINT32  Reserved0:24;   ///< Reserved.
 117     UINT32  Destination:8;  ///< Specifies the target processor or processors in xAPIC mode.
 118   } Bits;
 119   UINT32    Uint32;         ///< Destination field expanded to 32-bit in x2APIC mode.
 120 } LOCAL_APIC_ICR_HIGH;
 121
 122 //
 123 // Spurious-Interrupt Vector Register (SVR)
 124 //
 125 typedef union {
 126   struct {
 127     UINT32  SpuriousVector:8;           ///< Spurious Vector.
 128     UINT32  SoftwareEnable:1;           ///< APIC Software Enable/Disable.
 129     UINT32  FocusProcessorChecking:1;   ///< Focus Processor Checking.
 130     UINT32  Reserved0:2;                ///< Reserved.
 131     UINT32  EoiBroadcastSuppression:1;  ///< EOI-Broadcast Suppression.
 132     UINT32  Reserved1:19;               ///< Reserved.
 133   } Bits;
 134   UINT32    Uint32;
 135 } LOCAL_APIC_SVR;
 136
 137 //
 138 // Divide Configuration Register (DCR)
 139 //
 140 typedef union {
 141   struct {
 142     UINT32  DivideValue1:2;  ///< Low 2 bits of the divide value.
 143     UINT32  Reserved0:1;     ///< Always 0.
 144     UINT32  DivideValue2:1;  ///< Highest 1 bit of the divide value.
 145     UINT32  Reserved1:28;    ///< Reserved.
 146   } Bits;
 147   UINT32    Uint32;
 148 } LOCAL_APIC_DCR;
 149
 150 //
 151 // LVT Timer Register
 152 //
 153 typedef union {
 154   struct {
 155     UINT32  Vector:8;          ///< The vector number of the interrupt being sent.
 156     UINT32  Reserved0:4;       ///< Reserved.
 157     UINT32  DeliveryStatus:1;  ///< 0: Idle, 1: send pending.
 158     UINT32  Reserved1:3;       ///< Reserved.
 159     UINT32  Mask:1;            ///< 0: Not masked, 1: Masked.
 160     UINT32  TimerMode:1;       ///< 0: One-shot, 1: Periodic.
 161     UINT32  Reserved2:14;      ///< Reserved.
 162   } Bits;
 163   UINT32    Uint32;
 164 } LOCAL_APIC_LVT_TIMER;
 165
 166 //
 167 // LVT LINT0/LINT1 Register
 168 //
 169 typedef union {
 170   struct {
 171     UINT32  Vector:8;            ///< The vector number of the interrupt being sent.
 172     UINT32  DeliveryMode:3;      ///< Specifies the type of interrupt to be sent.
 173     UINT32  Reserved0:1;         ///< Reserved.
 174     UINT32  DeliveryStatus:1;    ///< 0: Idle, 1: send pending.
 175     UINT32  InputPinPolarity:1;  ///< Interrupt Input Pin Polarity.
 176     UINT32  RemoteIrr:1;         ///< RO. Set when the local APIC accepts the interrupt and reset when an EOI is received.
 177     UINT32  TriggerMode:1;       ///< 0:edge, 1:level.
 178     UINT32  Mask:1;              ///< 0: Not masked, 1: Masked.
 179     UINT32  Reserved1:15;        ///< Reserved.
 180   } Bits;
 181   UINT32    Uint32;
 182 } LOCAL_APIC_LVT_LINT;
 183
 184 //
 185 // MSI Address Register
 186 //
 187 typedef union {
 188   struct {
 189     UINT32  Reserved0:2;         ///< Reserved
 190     UINT32  DestinationMode:1;   ///< Specifies the Destination Mode.
 191     UINT32  RedirectionHint:1;   ///< Specifies the Redirection Hint.
 192     UINT32  Reserved1:8;         ///< Reserved.
 193     UINT32  DestinationId:8;     ///< Specifies the Destination ID.
 194     UINT32  BaseAddress:12;      ///< Must be 0FEEH
 195   } Bits;
 196   UINT32    Uint32;
 197 } LOCAL_APIC_MSI_ADDRESS;
 198
 199 //
 200 // MSI Address Register
 201 //
 202 typedef union {
 203   struct {
 204     UINT32  Vector:8;            ///< Interrupt vector in range 010h..0FEH
 205     UINT32  DeliveryMode:3;      ///< Specifies the type of interrupt to be sent.
 206     UINT32  Reserved0:3;         ///< Reserved.
 207     UINT32  Level:1;             ///< 0:Deassert, 1:Assert.  Ignored for Edge triggered interrupts.
 208     UINT32  TriggerMode:1;       ///< 0:Edge,     1:Level.
 209     UINT32  Reserved1:16;        ///< Reserved.
 210     UINT32  Reserved2:32;        ///< Reserved.
 211   } Bits;
 212   UINT64    Uint64;
 213 } LOCAL_APIC_MSI_DATA;
 214
 215 #endif
 216