root/arch/x86/include/asm/apicdef.h
/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _ASM_X86_APICDEF_H
#define _ASM_X86_APICDEF_H

#include <linux/bits.h>

/*
 * Constants for various Intel APICs. (local APIC, IOAPIC, etc.)
 *
 * Alan Cox <Alan.Cox@linux.org>, 1995.
 * Ingo Molnar <mingo@redhat.com>, 1999, 2000
 */

#define IO_APIC_DEFAULT_PHYS_BASE       0xfec00000
#define APIC_DEFAULT_PHYS_BASE          0xfee00000

/*
 * This is the IO-APIC register space as specified
 * by Intel docs:
 */
#define IO_APIC_SLOT_SIZE               1024

#define APIC_DELIVERY_MODE_FIXED        0
#define APIC_DELIVERY_MODE_LOWESTPRIO   1
#define APIC_DELIVERY_MODE_SMI          2
#define APIC_DELIVERY_MODE_NMI          4
#define APIC_DELIVERY_MODE_INIT         5
#define APIC_DELIVERY_MODE_EXTINT       7

#define APIC_ID         0x20

#define APIC_LVR        0x30
#define         APIC_LVR_MASK           0xFF00FF
#define         APIC_LVR_DIRECTED_EOI   (1 << 24)
#define         GET_APIC_VERSION(x)     ((x) & 0xFFu)
#define         GET_APIC_MAXLVT(x)      (((x) >> 16) & 0xFFu)
#ifdef CONFIG_X86_32
#  define       APIC_INTEGRATED(x)      ((x) & 0xF0u)
#else
#  define       APIC_INTEGRATED(x)      (1)
#endif
#define         APIC_XAPIC(x)           ((x) >= 0x14)
#define         APIC_EXT_SPACE(x)       ((x) & 0x80000000)
#define APIC_TASKPRI    0x80
#define         APIC_TPRI_MASK          0xFFu
#define APIC_ARBPRI     0x90
#define         APIC_ARBPRI_MASK        0xFFu
#define APIC_PROCPRI    0xA0
#define APIC_EOI        0xB0
#define         APIC_EOI_ACK            0x0 /* Docs say 0 for future compat. */
#define APIC_RRR        0xC0
#define APIC_LDR        0xD0
#define         APIC_LDR_MASK           (0xFFu << 24)
#define         GET_APIC_LOGICAL_ID(x)  (((x) >> 24) & 0xFFu)
#define         SET_APIC_LOGICAL_ID(x)  (((x) << 24))
#define         APIC_ALL_CPUS           0xFFu
#define APIC_DFR        0xE0
#define         APIC_DFR_CLUSTER                0x0FFFFFFFul
#define         APIC_DFR_FLAT                   0xFFFFFFFFul
#define APIC_SPIV       0xF0
#define         APIC_SPIV_DIRECTED_EOI          (1 << 12)
#define         APIC_SPIV_FOCUS_DISABLED        (1 << 9)
#define         APIC_SPIV_APIC_ENABLED          (1 << 8)
#define APIC_ISR        0x100
#define APIC_ISR_NR     0x8     /* Number of 32 bit ISR registers. */
#define APIC_TMR        0x180
#define APIC_IRR        0x200
#define APIC_ESR        0x280
#define         APIC_ESR_SEND_CS        0x00001
#define         APIC_ESR_RECV_CS        0x00002
#define         APIC_ESR_SEND_ACC       0x00004
#define         APIC_ESR_RECV_ACC       0x00008
#define         APIC_ESR_SENDILL        0x00020
#define         APIC_ESR_RECVILL        0x00040
#define         APIC_ESR_ILLREGA        0x00080
#define         APIC_LVTCMCI    0x2f0
#define APIC_ICR        0x300
#define         APIC_DEST_SELF          0x40000
#define         APIC_DEST_ALLINC        0x80000
#define         APIC_DEST_ALLBUT        0xC0000
#define         APIC_ICR_RR_MASK        0x30000
#define         APIC_ICR_RR_INVALID     0x00000
#define         APIC_ICR_RR_INPROG      0x10000
#define         APIC_ICR_RR_VALID       0x20000
#define         APIC_INT_LEVELTRIG      0x08000
#define         APIC_INT_ASSERT         0x04000
#define         APIC_ICR_BUSY           0x01000
#define         APIC_DEST_LOGICAL       0x00800
#define         APIC_DEST_PHYSICAL      0x00000
#define         APIC_DM_FIXED           0x00000
#define         APIC_DM_FIXED_MASK      0x00700
#define         APIC_DM_LOWEST          0x00100
#define         APIC_DM_SMI             0x00200
#define         APIC_DM_REMRD           0x00300
#define         APIC_DM_NMI             0x00400
#define         APIC_DM_INIT            0x00500
#define         APIC_DM_STARTUP         0x00600
#define         APIC_DM_EXTINT          0x00700
#define         APIC_VECTOR_MASK        0x000FF
#define APIC_ICR2       0x310
#define         GET_XAPIC_DEST_FIELD(x) (((x) >> 24) & 0xFF)
#define         SET_XAPIC_DEST_FIELD(x) ((x) << 24)
#define APIC_LVTT       0x320
#define APIC_LVTTHMR    0x330
#define APIC_LVTPC      0x340
#define APIC_LVT0       0x350
#define         APIC_LVT_TIMER_ONESHOT          (0 << 17)
#define         APIC_LVT_TIMER_PERIODIC         (1 << 17)
#define         APIC_LVT_TIMER_TSCDEADLINE      (2 << 17)
#define         APIC_LVT_MASKED                 (1 << 16)
#define         APIC_LVT_LEVEL_TRIGGER          (1 << 15)
#define         APIC_LVT_REMOTE_IRR             (1 << 14)
#define         APIC_INPUT_POLARITY             (1 << 13)
#define         APIC_SEND_PENDING               (1 << 12)
#define         APIC_MODE_MASK                  0x700
#define         GET_APIC_DELIVERY_MODE(x)       (((x) >> 8) & 0x7)
#define         SET_APIC_DELIVERY_MODE(x, y)    (((x) & ~0x700) | ((y) << 8))
#define                 APIC_MODE_FIXED         0x0
#define                 APIC_MODE_NMI           0x4
#define                 APIC_MODE_EXTINT        0x7
#define APIC_LVT1       0x360
#define APIC_LVTERR     0x370
#define APIC_TMICT      0x380
#define APIC_TMCCT      0x390
#define APIC_TDCR       0x3E0
#define APIC_SELF_IPI   0x3F0
#define         APIC_TDR_DIV_TMBASE     (1 << 2)
#define         APIC_TDR_DIV_1          0xB
#define         APIC_TDR_DIV_2          0x0
#define         APIC_TDR_DIV_4          0x1
#define         APIC_TDR_DIV_8          0x2
#define         APIC_TDR_DIV_16         0x3
#define         APIC_TDR_DIV_32         0x8
#define         APIC_TDR_DIV_64         0x9
#define         APIC_TDR_DIV_128        0xA
#define APIC_EFEAT      0x400
#define APIC_ECTRL      0x410
#define APIC_SEOI       0x420
#define APIC_IER        0x480
#define APIC_EILVTn(n)  (0x500 + 0x10 * n)
#define         APIC_EILVT_NR_AMD_K8    1       /* # of extended interrupts */
#define         APIC_EILVT_NR_AMD_10H   4
#define         APIC_EILVT_NR_MAX       APIC_EILVT_NR_AMD_10H
#define         APIC_EILVT_LVTOFF(x)    (((x) >> 4) & 0xF)
#define         APIC_EILVT_MSG_FIX      0x0
#define         APIC_EILVT_MSG_SMI      0x2
#define         APIC_EILVT_MSG_NMI      0x4
#define         APIC_EILVT_MSG_EXT      0x7
#define         APIC_EILVT_MASKED       (1 << 16)

#define APIC_BASE (fix_to_virt(FIX_APIC_BASE))
#define APIC_BASE_MSR           0x800
#define APIC_X2APIC_ID_MSR      0x802
#define XAPIC_ENABLE            BIT(11)
#define X2APIC_ENABLE           BIT(10)

#ifdef CONFIG_X86_32
# define MAX_IO_APICS 64
# define MAX_LOCAL_APIC 256
#else
# define MAX_IO_APICS 128
# define MAX_LOCAL_APIC 32768
#endif

/*
 * All x86-64 systems are xAPIC compatible.
 * In the following, "apicid" is a physical APIC ID.
 */
#define XAPIC_DEST_CPUS_SHIFT   4
#define XAPIC_DEST_CPUS_MASK    ((1u << XAPIC_DEST_CPUS_SHIFT) - 1)
#define XAPIC_DEST_CLUSTER_MASK (XAPIC_DEST_CPUS_MASK << XAPIC_DEST_CPUS_SHIFT)
#define APIC_CLUSTER(apicid)    ((apicid) & XAPIC_DEST_CLUSTER_MASK)
#define APIC_CLUSTERID(apicid)  (APIC_CLUSTER(apicid) >> XAPIC_DEST_CPUS_SHIFT)
#define APIC_CPUID(apicid)      ((apicid) & XAPIC_DEST_CPUS_MASK)
#define NUM_APIC_CLUSTERS       ((BAD_APICID + 1) >> XAPIC_DEST_CPUS_SHIFT)

#ifdef CONFIG_X86_32
 #define BAD_APICID 0xFFu
#else
 #define BAD_APICID 0xFFFFu
#endif

#endif /* _ASM_X86_APICDEF_H */