xref: /openbmc/qemu/include/hw/i386/apic_internal.h (revision b45c03f5)
1 /*
2  *  APIC support - internal interfaces
3  *
4  *  Copyright (c) 2004-2005 Fabrice Bellard
5  *  Copyright (c) 2011      Jan Kiszka, Siemens AG
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this library; if not, see <http://www.gnu.org/licenses/>
19  */
20 #ifndef QEMU_APIC_INTERNAL_H
21 #define QEMU_APIC_INTERNAL_H
22 
23 #include "cpu.h"
24 #include "exec/memory.h"
25 #include "hw/cpu/icc_bus.h"
26 #include "qemu/timer.h"
27 
28 /* APIC Local Vector Table */
29 #define APIC_LVT_TIMER                  0
30 #define APIC_LVT_THERMAL                1
31 #define APIC_LVT_PERFORM                2
32 #define APIC_LVT_LINT0                  3
33 #define APIC_LVT_LINT1                  4
34 #define APIC_LVT_ERROR                  5
35 #define APIC_LVT_NB                     6
36 
37 /* APIC delivery modes */
38 #define APIC_DM_FIXED                   0
39 #define APIC_DM_LOWPRI                  1
40 #define APIC_DM_SMI                     2
41 #define APIC_DM_NMI                     4
42 #define APIC_DM_INIT                    5
43 #define APIC_DM_SIPI                    6
44 #define APIC_DM_EXTINT                  7
45 
46 /* APIC destination mode */
47 #define APIC_DESTMODE_FLAT              0xf
48 #define APIC_DESTMODE_CLUSTER           1
49 
50 #define APIC_TRIGGER_EDGE               0
51 #define APIC_TRIGGER_LEVEL              1
52 
53 #define APIC_LVT_TIMER_PERIODIC         (1<<17)
54 #define APIC_LVT_MASKED                 (1<<16)
55 #define APIC_LVT_LEVEL_TRIGGER          (1<<15)
56 #define APIC_LVT_REMOTE_IRR             (1<<14)
57 #define APIC_INPUT_POLARITY             (1<<13)
58 #define APIC_SEND_PENDING               (1<<12)
59 
60 #define ESR_ILLEGAL_ADDRESS (1 << 7)
61 
62 #define APIC_SV_DIRECTED_IO             (1<<12)
63 #define APIC_SV_ENABLE                  (1<<8)
64 
65 #define VAPIC_ENABLE_BIT                0
66 #define VAPIC_ENABLE_MASK               (1 << VAPIC_ENABLE_BIT)
67 
68 #define MAX_APICS 255
69 
70 typedef struct APICCommonState APICCommonState;
71 
72 #define TYPE_APIC_COMMON "apic-common"
73 #define APIC_COMMON(obj) \
74      OBJECT_CHECK(APICCommonState, (obj), TYPE_APIC_COMMON)
75 #define APIC_COMMON_CLASS(klass) \
76      OBJECT_CLASS_CHECK(APICCommonClass, (klass), TYPE_APIC_COMMON)
77 #define APIC_COMMON_GET_CLASS(obj) \
78      OBJECT_GET_CLASS(APICCommonClass, (obj), TYPE_APIC_COMMON)
79 
80 typedef struct APICCommonClass
81 {
82     ICCDeviceClass parent_class;
83 
84     DeviceRealize realize;
85     void (*set_base)(APICCommonState *s, uint64_t val);
86     void (*set_tpr)(APICCommonState *s, uint8_t val);
87     uint8_t (*get_tpr)(APICCommonState *s);
88     void (*enable_tpr_reporting)(APICCommonState *s, bool enable);
89     void (*vapic_base_update)(APICCommonState *s);
90     void (*external_nmi)(APICCommonState *s);
91     void (*pre_save)(APICCommonState *s);
92     void (*post_load)(APICCommonState *s);
93     void (*reset)(APICCommonState *s);
94 } APICCommonClass;
95 
96 struct APICCommonState {
97     ICCDevice busdev;
98 
99     MemoryRegion io_memory;
100     X86CPU *cpu;
101     uint32_t apicbase;
102     uint8_t id;
103     uint8_t version;
104     uint8_t arb_id;
105     uint8_t tpr;
106     uint32_t spurious_vec;
107     uint8_t log_dest;
108     uint8_t dest_mode;
109     uint32_t isr[8];  /* in service register */
110     uint32_t tmr[8];  /* trigger mode register */
111     uint32_t irr[8]; /* interrupt request register */
112     uint32_t lvt[APIC_LVT_NB];
113     uint32_t esr; /* error register */
114     uint32_t icr[2];
115 
116     uint32_t divide_conf;
117     int count_shift;
118     uint32_t initial_count;
119     int64_t initial_count_load_time;
120     int64_t next_time;
121     int idx;
122     QEMUTimer *timer;
123     int64_t timer_expiry;
124     int sipi_vector;
125     int wait_for_sipi;
126 
127     uint32_t vapic_control;
128     DeviceState *vapic;
129     hwaddr vapic_paddr; /* note: persistence via kvmvapic */
130 };
131 
132 typedef struct VAPICState {
133     uint8_t tpr;
134     uint8_t isr;
135     uint8_t zero;
136     uint8_t irr;
137     uint8_t enabled;
138 } QEMU_PACKED VAPICState;
139 
140 extern bool apic_report_tpr_access;
141 
142 void apic_report_irq_delivered(int delivered);
143 bool apic_next_timer(APICCommonState *s, int64_t current_time);
144 void apic_enable_tpr_access_reporting(DeviceState *d, bool enable);
145 void apic_enable_vapic(DeviceState *d, hwaddr paddr);
146 
147 void vapic_report_tpr_access(DeviceState *dev, CPUState *cpu, target_ulong ip,
148                              TPRAccess access);
149 
150 #endif /* !QEMU_APIC_INTERNAL_H */
151