DevIoApic.cpp@ 86927

Last change on this file since 86927 was 86927, checked in by vboxsync, 4 years ago
AMD IOMMU: bugref:9654 DevIoApic: Fix passing the correct BDF (southbridge I/O APIC's BDF) to the IOMMU for remapping line-based interrupts.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 66.2 KB

Line
1	/* $Id: DevIoApic.cpp 86927 2020-11-20 08:47:25Z vboxsync $ */
2	/** @file
3	* IO APIC - Input/Output Advanced Programmable Interrupt Controller.
4	*/
5
6	/*
7	* Copyright (C) 2016-2020 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18
19	/*********************************************************************************************************************************
20	* Header Files *
21	*********************************************************************************************************************************/
22	#define LOG_GROUP LOG_GROUP_DEV_IOAPIC
23	#include <VBox/log.h>
24	#include <VBox/vmm/hm.h>
25	#include <VBox/msi.h>
26	#include <VBox/pci.h>
27	#include <VBox/vmm/pdmdev.h>
28
29	#include "VBoxDD.h"
30	#include <iprt/x86.h>
31	#include <iprt/string.h>
32
33
34	/*********************************************************************************************************************************
35	* Defined Constants And Macros *
36	*********************************************************************************************************************************/
37	/** The current IO APIC saved state version. */
38	#define IOAPIC_SAVED_STATE_VERSION 2
39	/** The saved state version used by VirtualBox 5.0 and
40	* earlier. */
41	#define IOAPIC_SAVED_STATE_VERSION_VBOX_50 1
42
43	/** Implementation specified by the "Intel I/O Controller Hub 9
44	* (ICH9) Family" */
45	#define IOAPIC_VERSION_ICH9 0x20
46	/** Implementation specified by the "82093AA I/O Advanced Programmable Interrupt
47	Controller" */
48	#define IOAPIC_VERSION_82093AA 0x11
49
50	/** The default MMIO base physical address. */
51	#define IOAPIC_MMIO_BASE_PHYSADDR UINT64_C(0xfec00000)
52	/** The size of the MMIO range. */
53	#define IOAPIC_MMIO_SIZE X86_PAGE_4K_SIZE
54	/** The mask for getting direct registers from physical address. */
55	#define IOAPIC_MMIO_REG_MASK 0xff
56
57	/** The number of interrupt input pins. */
58	#define IOAPIC_NUM_INTR_PINS 24
59	/** Maximum redirection entires. */
60	#define IOAPIC_MAX_RTE_INDEX (IOAPIC_NUM_INTR_PINS - 1)
61	/** Reduced RTEs used by SIO.A (82379AB). */
62	#define IOAPIC_REDUCED_MAX_RTE_INDEX (16 - 1)
63
64	/** Version register - Gets the version. */
65	#define IOAPIC_VER_GET_VER(a_Reg) ((a_Reg) & 0xff)
66	/** Version register - Gets the maximum redirection entry. */
67	#define IOAPIC_VER_GET_MRE(a_Reg) (((a_Reg) >> 16) & 0xff)
68	/** Version register - Gets whether Pin Assertion Register (PRQ) is
69	* supported. */
70	#define IOAPIC_VER_HAS_PRQ(a_Reg) RT_BOOL((a_Reg) & RT_BIT_32(15))
71
72	/** Index register - Valid write mask. */
73	#define IOAPIC_INDEX_VALID_WRITE_MASK UINT32_C(0xff)
74
75	/** Arbitration register - Gets the ID. */
76	#define IOAPIC_ARB_GET_ID(a_Reg) ((a_Reg) >> 24 & 0xf)
77
78	/** ID register - Gets the ID. */
79	#define IOAPIC_ID_GET_ID(a_Reg) ((a_Reg) >> 24 & 0xff)
80
81	/** Redirection table entry - Vector. */
82	#define IOAPIC_RTE_VECTOR UINT64_C(0xff)
83	/** Redirection table entry - Delivery mode. */
84	#define IOAPIC_RTE_DELIVERY_MODE (RT_BIT_64(8) \| RT_BIT_64(9) \| RT_BIT_64(10))
85	/** Redirection table entry - Destination mode. */
86	#define IOAPIC_RTE_DEST_MODE RT_BIT_64(11)
87	/** Redirection table entry - Delivery status. */
88	#define IOAPIC_RTE_DELIVERY_STATUS RT_BIT_64(12)
89	/** Redirection table entry - Interrupt input pin polarity. */
90	#define IOAPIC_RTE_POLARITY RT_BIT_64(13)
91	/** Redirection table entry - Remote IRR. */
92	#define IOAPIC_RTE_REMOTE_IRR RT_BIT_64(14)
93	/** Redirection table entry - Trigger Mode. */
94	#define IOAPIC_RTE_TRIGGER_MODE RT_BIT_64(15)
95	/** Redirection table entry - the mask bit number. */
96	#define IOAPIC_RTE_MASK_BIT 16
97	/** Redirection table entry - the mask. */
98	#define IOAPIC_RTE_MASK RT_BIT_64(IOAPIC_RTE_MASK_BIT)
99	/** Redirection table entry - Extended Destination ID. */
100	#define IOAPIC_RTE_EXT_DEST_ID UINT64_C(0x00ff000000000000)
101	/** Redirection table entry - Destination. */
102	#define IOAPIC_RTE_DEST UINT64_C(0xff00000000000000)
103
104	/** Redirection table entry - Gets the destination. */
105	#define IOAPIC_RTE_GET_DEST(a_Reg) ((a_Reg) >> 56 & 0xff)
106	/** Redirection table entry - Gets the mask flag. */
107	#define IOAPIC_RTE_GET_MASK(a_Reg) (((a_Reg) >> IOAPIC_RTE_MASK_BIT) & 0x1)
108	/** Redirection table entry - Checks whether it's masked. */
109	#define IOAPIC_RTE_IS_MASKED(a_Reg) ((a_Reg) & IOAPIC_RTE_MASK)
110	/** Redirection table entry - Gets the trigger mode. */
111	#define IOAPIC_RTE_GET_TRIGGER_MODE(a_Reg) (((a_Reg) >> 15) & 0x1)
112	/** Redirection table entry - Gets the remote IRR flag. */
113	#define IOAPIC_RTE_GET_REMOTE_IRR(a_Reg) (((a_Reg) >> 14) & 0x1)
114	/** Redirection table entry - Gets the interrupt pin polarity. */
115	#define IOAPIC_RTE_GET_POLARITY(a_Reg) (((a_Reg) >> 13) & 0x1)
116	/** Redirection table entry - Gets the delivery status. */
117	#define IOAPIC_RTE_GET_DELIVERY_STATUS(a_Reg) (((a_Reg) >> 12) & 0x1)
118	/** Redirection table entry - Gets the destination mode. */
119	#define IOAPIC_RTE_GET_DEST_MODE(a_Reg) (((a_Reg) >> 11) & 0x1)
120	/** Redirection table entry - Gets the delivery mode. */
121	#define IOAPIC_RTE_GET_DELIVERY_MODE(a_Reg) (((a_Reg) >> 8) & 0x7)
122	/** Redirection table entry - Gets the vector. */
123	#define IOAPIC_RTE_GET_VECTOR(a_Reg) ((a_Reg) & IOAPIC_RTE_VECTOR)
124
125	/** Redirection table entry - Valid write mask for 82093AA. */
126	#define IOAPIC_RTE_VALID_WRITE_MASK_82093AA ( IOAPIC_RTE_DEST \| IOAPIC_RTE_MASK \| IOAPIC_RTE_TRIGGER_MODE \
127	\| IOAPIC_RTE_POLARITY \| IOAPIC_RTE_DEST_MODE \| IOAPIC_RTE_DELIVERY_MODE \
128	\| IOAPIC_RTE_VECTOR)
129	/** Redirection table entry - Valid read mask for 82093AA. */
130	#define IOAPIC_RTE_VALID_READ_MASK_82093AA ( IOAPIC_RTE_DEST \| IOAPIC_RTE_MASK \| IOAPIC_RTE_TRIGGER_MODE \
131	\| IOAPIC_RTE_REMOTE_IRR \| IOAPIC_RTE_POLARITY \| IOAPIC_RTE_DELIVERY_STATUS \
132	\| IOAPIC_RTE_DEST_MODE \| IOAPIC_RTE_DELIVERY_MODE \| IOAPIC_RTE_VECTOR)
133
134	/** Redirection table entry - Valid write mask for ICH9. */
135	/** @note The remote IRR bit has been reverted to read-only as it turns out the
136	* ICH9 spec. is wrong, see @bugref{8386#c46}. */
137	#define IOAPIC_RTE_VALID_WRITE_MASK_ICH9 ( IOAPIC_RTE_DEST \| IOAPIC_RTE_MASK \| IOAPIC_RTE_TRIGGER_MODE \
138	/\| IOAPIC_RTE_REMOTE_IRR /\| IOAPIC_RTE_POLARITY \| IOAPIC_RTE_DEST_MODE \
139	\| IOAPIC_RTE_DELIVERY_MODE \| IOAPIC_RTE_VECTOR)
140	/** Redirection table entry - Valid read mask (incl. ExtDestID) for ICH9. */
141	#define IOAPIC_RTE_VALID_READ_MASK_ICH9 ( IOAPIC_RTE_DEST \| IOAPIC_RTE_EXT_DEST_ID \| IOAPIC_RTE_MASK \
142	\| IOAPIC_RTE_TRIGGER_MODE \| IOAPIC_RTE_REMOTE_IRR \| IOAPIC_RTE_POLARITY \
143	\| IOAPIC_RTE_DELIVERY_STATUS \| IOAPIC_RTE_DEST_MODE \| IOAPIC_RTE_DELIVERY_MODE \
144	\| IOAPIC_RTE_VECTOR)
145
146	/** Redirection table entry - Trigger mode edge. */
147	#define IOAPIC_RTE_TRIGGER_MODE_EDGE 0
148	/** Redirection table entry - Trigger mode level. */
149	#define IOAPIC_RTE_TRIGGER_MODE_LEVEL 1
150	/** Redirection table entry - Destination mode physical. */
151	#define IOAPIC_RTE_DEST_MODE_PHYSICAL 0
152	/** Redirection table entry - Destination mode logical. */
153	#define IOAPIC_RTE_DEST_MODE_LOGICAL 1
154
155
156	/** Index of indirect registers in the I/O APIC register table. */
157	#define IOAPIC_INDIRECT_INDEX_ID 0x0
158	#define IOAPIC_INDIRECT_INDEX_VERSION 0x1
159	#define IOAPIC_INDIRECT_INDEX_ARB 0x2 /* Older I/O APIC only. */
160	#define IOAPIC_INDIRECT_INDEX_REDIR_TBL_START 0x10 /* First valid RTE register index. */
161	#define IOAPIC_INDIRECT_INDEX_RTE_END 0x3F /* Last valid RTE register index (24 RTEs). */
162	#define IOAPIC_REDUCED_INDIRECT_INDEX_RTE_END 0x2F /* Last valid RTE register index (16 RTEs). */
163
164	/** Offset of direct registers in the I/O APIC MMIO space. */
165	#define IOAPIC_DIRECT_OFF_INDEX 0x00
166	#define IOAPIC_DIRECT_OFF_DATA 0x10
167	#define IOAPIC_DIRECT_OFF_EOI 0x40 /* Newer I/O APIC only. */
168
169	/* Use PDM critsect for now for I/O APIC locking, see @bugref{8245#c121}. */
170	#define IOAPIC_WITH_PDM_CRITSECT
171	#ifdef IOAPIC_WITH_PDM_CRITSECT
172	# define IOAPIC_LOCK(a_pDevIns, a_pThis, a_pThisCC, rcBusy) (a_pThisCC)->pIoApicHlp->pfnLock((a_pDevIns), (rcBusy))
173	# define IOAPIC_UNLOCK(a_pDevIns, a_pThis, a_pThisCC) (a_pThisCC)->pIoApicHlp->pfnUnlock((a_pDevIns))
174	#else
175	# define IOAPIC_LOCK(a_pDevIns, a_pThis, a_pThisCC, rcBusy) PDMDevHlpCritSectEnter((a_pDevIns), &(a_pThis)->CritSect, (rcBusy))
176	# define IOAPIC_UNLOCK(a_pDevIns, a_pThis, a_pThisCC) PDMDevHlpCritSectLeave((a_pDevIns), &(a_pThis)->CritSect)
177	#endif
178
179
180	/*********************************************************************************************************************************
181	* Structures and Typedefs *
182	*********************************************************************************************************************************/
183	/**
184	* The shared I/O APIC device state.
185	*/
186	typedef struct IOAPIC
187	{
188	/** The ID register. */
189	uint8_t volatile u8Id;
190	/** The index register. */
191	uint8_t volatile u8Index;
192	/** Number of CPUs. */
193	uint8_t cCpus;
194	/** I/O APIC version. */
195	uint8_t u8ApicVer;
196	/** I/O APIC ID mask. */
197	uint8_t u8IdMask;
198	/** Maximum Redirection Table Entry (RTE) Entry. */
199	uint8_t u8MaxRte;
200	/** Last valid RTE indirect register index. */
201	uint8_t u8LastRteRegIdx;
202	/* Alignment padding. */
203	uint8_t u8Padding0[1];
204	/** Redirection table entry - Valid write mask. */
205	uint64_t u64RteWriteMask;
206	/** Redirection table entry - Valid read mask. */
207	uint64_t u64RteReadMask;
208
209	/** The redirection table registers. */
210	uint64_t au64RedirTable[IOAPIC_NUM_INTR_PINS];
211	/** The IRQ tags and source IDs for each pin (tracing purposes). */
212	uint32_t au32TagSrc[IOAPIC_NUM_INTR_PINS];
213
214	/** The internal IRR reflecting state of the interrupt lines. */
215	uint32_t uIrr;
216	/** Alignment padding. */
217	uint32_t u32Padding2;
218
219	#ifndef IOAPIC_WITH_PDM_CRITSECT
220	/** The critsect for updating to the RTEs. */
221	PDMCRITSECT CritSect;
222	#endif
223
224	/** The MMIO region. */
225	IOMMMIOHANDLE hMmio;
226
227	#ifdef VBOX_WITH_STATISTICS
228	/** Number of MMIO reads in RZ. */
229	STAMCOUNTER StatMmioReadRZ;
230	/** Number of MMIO reads in R3. */
231	STAMCOUNTER StatMmioReadR3;
232
233	/** Number of MMIO writes in RZ. */
234	STAMCOUNTER StatMmioWriteRZ;
235	/** Number of MMIO writes in R3. */
236	STAMCOUNTER StatMmioWriteR3;
237
238	/** Number of SetIrq calls in RZ. */
239	STAMCOUNTER StatSetIrqRZ;
240	/** Number of SetIrq calls in R3. */
241	STAMCOUNTER StatSetIrqR3;
242
243	/** Number of SetEoi calls in RZ. */
244	STAMCOUNTER StatSetEoiRZ;
245	/** Number of SetEoi calls in R3. */
246	STAMCOUNTER StatSetEoiR3;
247
248	/** Number of redundant edge-triggered interrupts. */
249	STAMCOUNTER StatRedundantEdgeIntr;
250	/** Number of redundant level-triggered interrupts. */
251	STAMCOUNTER StatRedundantLevelIntr;
252	/** Number of suppressed level-triggered interrupts (by remote IRR). */
253	STAMCOUNTER StatSuppressedLevelIntr;
254	/** Number of IOMMU remapped interrupts (signaled by RTE). */
255	STAMCOUNTER StatIommuRemappedIntr;
256	/** Number of IOMMU discarded interrupts (signaled by RTE). */
257	STAMCOUNTER StatIommuDiscardedIntr;
258	/** Number of IOMMU remapped MSIs. */
259	STAMCOUNTER StatIommuRemappedMsi;
260	/** Number of IOMMU denied or failed MSIs. */
261	STAMCOUNTER StatIommuDiscardedMsi;
262	/** Number of returns to ring-3 due to EOI broadcast lock contention. */
263	STAMCOUNTER StatEoiContention;
264	/** Number of returns to ring-3 due to Set RTE lock contention. */
265	STAMCOUNTER StatSetRteContention;
266	/** Number of level-triggered interrupts dispatched to the local APIC(s). */
267	STAMCOUNTER StatLevelIrqSent;
268	/** Number of EOIs received for level-triggered interrupts from the local
269	* APIC(s). */
270	STAMCOUNTER StatEoiReceived;
271	#endif
272	/** Per-vector stats. */
273	STAMCOUNTER aStatVectors[256];
274	} IOAPIC;
275	AssertCompileMemberAlignment(IOAPIC, au64RedirTable, 8);
276	/** Pointer to shared IOAPIC data. */
277	typedef IOAPIC *PIOAPIC;
278	/** Pointer to const shared IOAPIC data. */
279	typedef IOAPIC const *PCIOAPIC;
280
281
282	/**
283	* The I/O APIC device state for ring-3.
284	*/
285	typedef struct IOAPICR3
286	{
287	/** The IOAPIC helpers. */
288	R3PTRTYPE(PCPDMIOAPICHLP) pIoApicHlp;
289	} IOAPICR3;
290	/** Pointer to the I/O APIC device state for ring-3. */
291	typedef IOAPICR3 *PIOAPICR3;
292
293
294	/**
295	* The I/O APIC device state for ring-0.
296	*/
297	typedef struct IOAPICR0
298	{
299	/** The IOAPIC helpers. */
300	R0PTRTYPE(PCPDMIOAPICHLP) pIoApicHlp;
301	} IOAPICR0;
302	/** Pointer to the I/O APIC device state for ring-0. */
303	typedef IOAPICR0 *PIOAPICR0;
304
305
306	/**
307	* The I/O APIC device state for raw-mode.
308	*/
309	typedef struct IOAPICRC
310	{
311	/** The IOAPIC helpers. */
312	RCPTRTYPE(PCPDMIOAPICHLP) pIoApicHlp;
313	} IOAPICRC;
314	/** Pointer to the I/O APIC device state for raw-mode. */
315	typedef IOAPICRC *PIOAPICRC;
316
317
318	/** The I/O APIC device state for the current context. */
319	typedef CTX_SUFF(IOAPIC) IOAPICCC;
320	/** Pointer to the I/O APIC device state for the current context. */
321	typedef CTX_SUFF(PIOAPIC) PIOAPICCC;
322
323
324	/**
325	* xAPIC interrupt.
326	*/
327	typedef struct XAPICINTR
328	{
329	/** The interrupt vector. */
330	uint8_t u8Vector;
331	/** The destination (mask or ID). */
332	uint8_t u8Dest;
333	/** The destination mode. */
334	uint8_t u8DestMode;
335	/** Delivery mode. */
336	uint8_t u8DeliveryMode;
337	/** Trigger mode. */
338	uint8_t u8TriggerMode;
339	/** Redirection hint. */
340	uint8_t u8RedirHint;
341	/** Polarity. */
342	uint8_t u8Polarity;
343	/** Padding. */
344	uint8_t abPadding0;
345	} XAPICINTR;
346	/** Pointer to an I/O xAPIC interrupt struct. */
347	typedef XAPICINTR *PXAPICINTR;
348	/** Pointer to a const xAPIC interrupt struct. */
349	typedef XAPICINTR const *PCXAPICINTR;
350
351
352	#ifndef VBOX_DEVICE_STRUCT_TESTCASE
353
354	/**
355	* Gets the arbitration register.
356	*
357	* @returns The arbitration.
358	*/
359	DECLINLINE(uint32_t) ioapicGetArb(void)
360	{
361	Log2(("IOAPIC: ioapicGetArb: returns 0\n"));
362	return 0;
363	}
364
365
366	/**
367	* Gets the version register.
368	*
369	* @returns The version.
370	*/
371	DECLINLINE(uint32_t) ioapicGetVersion(PCIOAPIC pThis)
372	{
373	uint32_t uValue = RT_MAKE_U32(pThis->u8ApicVer, pThis->u8MaxRte);
374	Log2(("IOAPIC: ioapicGetVersion: returns %#RX32\n", uValue));
375	return uValue;
376	}
377
378
379	/**
380	* Sets the ID register.
381	*
382	* @param pThis The shared I/O APIC device state.
383	* @param uValue The value to set.
384	*/
385	DECLINLINE(void) ioapicSetId(PIOAPIC pThis, uint32_t uValue)
386	{
387	Log2(("IOAPIC: ioapicSetId: uValue=%#RX32\n", uValue));
388	ASMAtomicWriteU8(&pThis->u8Id, (uValue >> 24) & pThis->u8IdMask);
389	}
390
391
392	/**
393	* Gets the ID register.
394	*
395	* @returns The ID.
396	* @param pThis The shared I/O APIC device state.
397	*/
398	DECLINLINE(uint32_t) ioapicGetId(PCIOAPIC pThis)
399	{
400	uint32_t uValue = (uint32_t)pThis->u8Id << 24;
401	Log2(("IOAPIC: ioapicGetId: returns %#RX32\n", uValue));
402	return uValue;
403	}
404
405
406	/**
407	* Sets the index register.
408	*
409	* @param pThis The shared I/O APIC device state.
410	* @param uValue The value to set.
411	*/
412	DECLINLINE(void) ioapicSetIndex(PIOAPIC pThis, uint32_t uValue)
413	{
414	LogFlow(("IOAPIC: ioapicSetIndex: uValue=%#RX32\n", uValue));
415	ASMAtomicWriteU8(&pThis->u8Index, uValue & IOAPIC_INDEX_VALID_WRITE_MASK);
416	}
417
418
419	/**
420	* Gets the index register.
421	*
422	* @returns The index value.
423	*/
424	DECLINLINE(uint32_t) ioapicGetIndex(PCIOAPIC pThis)
425	{
426	uint32_t const uValue = pThis->u8Index;
427	LogFlow(("IOAPIC: ioapicGetIndex: returns %#x\n", uValue));
428	return uValue;
429	}
430
431
432	/**
433	* Converts an MSI message to an APIC interrupt.
434	*
435	* @param pMsi The MSI message to convert.
436	* @param pIntr Where to store the APIC interrupt.
437	*/
438	DECLINLINE(void) ioapicGetApicIntrFromMsi(PCMSIMSG pMsi, PXAPICINTR pIntr)
439	{
440	/*
441	* Parse the message from the physical address and data
442	* See Intel spec. 10.11.1 "Message Address Register Format".
443	* See Intel spec. 10.11.2 "Message Data Register Format".
444	*/
445	pIntr->u8Dest = pMsi->Addr.n.u8DestId;
446	pIntr->u8DestMode = pMsi->Addr.n.u1DestMode;
447	pIntr->u8RedirHint = pMsi->Addr.n.u1RedirHint;
448
449	pIntr->u8Vector = pMsi->Data.n.u8Vector;
450	pIntr->u8TriggerMode = pMsi->Data.n.u1TriggerMode;
451	pIntr->u8DeliveryMode = pMsi->Data.n.u3DeliveryMode;
452	}
453
454
455	#ifdef VBOX_WITH_IOMMU_AMD
456	/**
457	* Convert an APIC interrupt to an MSI message.
458	*
459	* @param pIntr The APIC interrupt to convert.
460	* @param pMsi Where to store the MSI message.
461	*/
462	DECLINLINE(void) ioapicGetMsiFromApicIntr(PCXAPICINTR pIntr, PMSIMSG pMsi)
463	{
464	pMsi->Addr.n.u12Addr = VBOX_MSI_ADDR_BASE >> VBOX_MSI_ADDR_SHIFT;
465	pMsi->Addr.n.u8DestId = pIntr->u8Dest;
466	pMsi->Addr.n.u1RedirHint = pIntr->u8RedirHint;
467	pMsi->Addr.n.u1DestMode = pIntr->u8DestMode;
468
469	pMsi->Data.n.u8Vector = pIntr->u8Vector;
470	pMsi->Data.n.u3DeliveryMode = pIntr->u8DeliveryMode;
471	pMsi->Data.n.u1TriggerMode = pIntr->u8TriggerMode;
472
473	/* pMsi->Data.n.u1Level = ??? */
474	/** @todo r=ramshankar: Level triggered MSIs don't make much sense though
475	* possible in theory? Maybe document this more explicitly... */
476	}
477	#endif
478
479
480	/**
481	* Signals the next pending interrupt for the specified Redirection Table Entry
482	* (RTE).
483	*
484	* @param pDevIns The device instance.
485	* @param pThis The shared I/O APIC device state.
486	* @param pThisCC The I/O APIC device state for the current context.
487	* @param idxRte The index of the RTE (validated).
488	*
489	* @remarks It is the responsibility of the caller to verify that an interrupt is
490	* pending for the pin corresponding to the RTE before calling this
491	* function.
492	*/
493	static void ioapicSignalIntrForRte(PPDMDEVINS pDevIns, PIOAPIC pThis, PIOAPICCC pThisCC, uint8_t idxRte)
494	{
495	#ifndef IOAPIC_WITH_PDM_CRITSECT
496	Assert(PDMCritSectIsOwner(&pThis->CritSect));
497	#endif
498
499	/*
500	* Ensure the interrupt isn't masked.
501	*/
502	uint64_t const u64Rte = pThis->au64RedirTable[idxRte];
503	if (!IOAPIC_RTE_IS_MASKED(u64Rte))
504	{
505	/* We cannot accept another level-triggered interrupt until remote IRR has been cleared. */
506	uint8_t const u8TriggerMode = IOAPIC_RTE_GET_TRIGGER_MODE(u64Rte);
507	if (u8TriggerMode == IOAPIC_RTE_TRIGGER_MODE_LEVEL)
508	{
509	uint8_t const u8RemoteIrr = IOAPIC_RTE_GET_REMOTE_IRR(u64Rte);
510	if (u8RemoteIrr)
511	{
512	STAM_COUNTER_INC(&pThis->StatSuppressedLevelIntr);
513	return;
514	}
515	}
516
517	XAPICINTR ApicIntr;
518	RT_ZERO(ApicIntr);
519	ApicIntr.u8Vector = IOAPIC_RTE_GET_VECTOR(u64Rte);
520	ApicIntr.u8Dest = IOAPIC_RTE_GET_DEST(u64Rte);
521	ApicIntr.u8DestMode = IOAPIC_RTE_GET_DEST_MODE(u64Rte);
522	ApicIntr.u8DeliveryMode = IOAPIC_RTE_GET_DELIVERY_MODE(u64Rte);
523	ApicIntr.u8Polarity = IOAPIC_RTE_GET_POLARITY(u64Rte);
524	ApicIntr.u8TriggerMode = u8TriggerMode;
525	ApicIntr.u8RedirHint = 0;
526
527	#ifdef VBOX_WITH_IOMMU_AMD
528	/*
529	* The interrupt may need to be remapped (or discarded) if an IOMMU is present.
530	* For line-based interrupts we must use the southbridge I/O APIC's BDF as
531	* the origin of the interrupt, see @bugref{9654#c74}.
532	*/
533	MSIMSG MsiOut;
534	MSIMSG MsiIn;
535	RT_ZERO(MsiOut);
536	RT_ZERO(MsiIn);
537	ioapicGetMsiFromApicIntr(&ApicIntr, &MsiIn);
538	int rcRemap = pThisCC->pIoApicHlp->pfnIommuMsiRemap(pDevIns, VBOX_PCI_BDF_SB_IOAPIC, &MsiIn, &MsiOut);
539	if (RT_SUCCESS(rcRemap))
540	{
541	STAM_COUNTER_INC(&pThis->StatIommuRemappedIntr);
542	LogFlow(("IOAPIC: IOMMU remapped interrupt %#x to %#x\n", rcRemap, MsiIn.Data.n.u8Vector, MsiOut.Data.n.u8Vector));
543	ioapicGetApicIntrFromMsi(&MsiOut, &ApicIntr);
544	Assert(ApicIntr.u8Polarity == IOAPIC_RTE_GET_POLARITY(u64Rte)); /* Ensure polarity hasn't changed. */
545	Assert(ApicIntr.u8TriggerMode == u8TriggerMode); /* Ensure trigger mode hasn't changed. */
546	}
547	else
548	{
549	STAM_COUNTER_INC(&pThis->StatIommuDiscardedIntr);
550	Log(("IOAPIC: IOMMU discarded interrupt %#x. rc=%Rrc\n", ApicIntr.u8Vector, rcRemap));
551	return;
552	}
553	#endif
554
555	uint32_t const u32TagSrc = pThis->au32TagSrc[idxRte];
556	Log2(("IOAPIC: Signaling %s-triggered interrupt. Dest=%#x DestMode=%s Vector=%#x (%u)\n",
557	ApicIntr.u8TriggerMode == IOAPIC_RTE_TRIGGER_MODE_EDGE ? "edge" : "level", ApicIntr.u8Dest,
558	ApicIntr.u8DestMode == IOAPIC_RTE_DEST_MODE_PHYSICAL ? "physical" : "logical",
559	ApicIntr.u8Vector, ApicIntr.u8Vector));
560
561	/*
562	* Deliver to the local APIC via the system/3-wire-APIC bus.
563	*/
564	int rc = pThisCC->pIoApicHlp->pfnApicBusDeliver(pDevIns,
565	ApicIntr.u8Dest,
566	ApicIntr.u8DestMode,
567	ApicIntr.u8DeliveryMode,
568	ApicIntr.u8Vector,
569	ApicIntr.u8Polarity,
570	ApicIntr.u8TriggerMode,
571	u32TagSrc);
572	/* Can't reschedule to R3. */
573	Assert(rc == VINF_SUCCESS \|\| rc == VERR_APIC_INTR_DISCARDED);
574	#ifdef DEBUG_ramshankar
575	if (rc == VERR_APIC_INTR_DISCARDED)
576	AssertMsgFailed(("APIC: Interrupt discarded u8Vector=%#x (%u) u64Rte=%#RX64\n", u8Vector, u8Vector, u64Rte));
577	#endif
578
579	/*
580	* For level-triggered interrupts, we set the remote IRR bit to indicate
581	* the local APIC has accepted the interrupt.
582	*
583	* For edge-triggered interrupts, we should not clear the IRR bit as it
584	* should remain intact to reflect the state of the interrupt line.
585	* The device will explicitly transition to inactive state via the
586	* ioapicSetIrq() callback.
587	*/
588	if ( u8TriggerMode == IOAPIC_RTE_TRIGGER_MODE_LEVEL
589	&& rc == VINF_SUCCESS)
590	{
591	Assert(u8TriggerMode == IOAPIC_RTE_TRIGGER_MODE_LEVEL);
592	pThis->au64RedirTable[idxRte] \|= IOAPIC_RTE_REMOTE_IRR;
593	STAM_COUNTER_INC(&pThis->StatLevelIrqSent);
594	}
595	}
596	}
597
598
599	/**
600	* Gets the redirection table entry.
601	*
602	* @returns The redirection table entry.
603	* @param pThis The shared I/O APIC device state.
604	* @param uIndex The index value.
605	*/
606	DECLINLINE(uint32_t) ioapicGetRedirTableEntry(PCIOAPIC pThis, uint32_t uIndex)
607	{
608	uint8_t const idxRte = (uIndex - IOAPIC_INDIRECT_INDEX_REDIR_TBL_START) >> 1;
609	AssertMsgReturn(idxRte < RT_ELEMENTS(pThis->au64RedirTable),
610	("Invalid index %u, expected < %u\n", idxRte, RT_ELEMENTS(pThis->au64RedirTable)),
611	UINT32_MAX);
612	uint32_t uValue;
613	if (!(uIndex & 1))
614	uValue = RT_LO_U32(pThis->au64RedirTable[idxRte]) & RT_LO_U32(pThis->u64RteReadMask);
615	else
616	uValue = RT_HI_U32(pThis->au64RedirTable[idxRte]) & RT_HI_U32(pThis->u64RteReadMask);
617
618	LogFlow(("IOAPIC: ioapicGetRedirTableEntry: uIndex=%#RX32 idxRte=%u returns %#RX32\n", uIndex, idxRte, uValue));
619	return uValue;
620	}
621
622
623	/**
624	* Sets the redirection table entry.
625	*
626	* @returns Strict VBox status code (VINF_IOM_R3_MMIO_WRITE / VINF_SUCCESS).
627	* @param pDevIns The device instance.
628	* @param pThis The shared I/O APIC device state.
629	* @param pThisCC The I/O APIC device state for the current context.
630	* @param uIndex The index value.
631	* @param uValue The value to set.
632	*/
633	static VBOXSTRICTRC ioapicSetRedirTableEntry(PPDMDEVINS pDevIns, PIOAPIC pThis, PIOAPICCC pThisCC,
634	uint32_t uIndex, uint32_t uValue)
635	{
636	uint8_t const idxRte = (uIndex - IOAPIC_INDIRECT_INDEX_REDIR_TBL_START) >> 1;
637	AssertMsgReturn(idxRte < RT_ELEMENTS(pThis->au64RedirTable),
638	("Invalid index %u, expected < %u\n", idxRte, RT_ELEMENTS(pThis->au64RedirTable)),
639	VINF_SUCCESS);
640
641	VBOXSTRICTRC rc = IOAPIC_LOCK(pDevIns, pThis, pThisCC, VINF_IOM_R3_MMIO_WRITE);
642	if (rc == VINF_SUCCESS)
643	{
644	/*
645	* Write the low or high 32-bit value into the specified 64-bit RTE register,
646	* update only the valid, writable bits.
647	*
648	* We need to preserve the read-only bits as it can have dire consequences
649	* otherwise, see @bugref{8386#c24}.
650	*/
651	uint64_t const u64Rte = pThis->au64RedirTable[idxRte];
652	if (!(uIndex & 1))
653	{
654	uint32_t const u32RtePreserveLo = RT_LO_U32(u64Rte) & ~RT_LO_U32(pThis->u64RteWriteMask);
655	uint32_t const u32RteNewLo = (uValue & RT_LO_U32(pThis->u64RteWriteMask)) \| u32RtePreserveLo;
656	uint64_t const u64RteHi = u64Rte & UINT64_C(0xffffffff00000000);
657	pThis->au64RedirTable[idxRte] = u64RteHi \| u32RteNewLo;
658	}
659	else
660	{
661	uint32_t const u32RtePreserveHi = RT_HI_U32(u64Rte) & ~RT_HI_U32(pThis->u64RteWriteMask);
662	uint32_t const u32RteLo = RT_LO_U32(u64Rte);
663	uint64_t const u64RteNewHi = ((uint64_t)((uValue & RT_HI_U32(pThis->u64RteWriteMask)) \| u32RtePreserveHi) << 32);
664	pThis->au64RedirTable[idxRte] = u64RteNewHi \| u32RteLo;
665	}
666
667	LogFlow(("IOAPIC: ioapicSetRedirTableEntry: uIndex=%#RX32 idxRte=%u uValue=%#RX32\n", uIndex, idxRte, uValue));
668
669	/*
670	* Signal the next pending interrupt for this RTE.
671	*/
672	uint32_t const uPinMask = UINT32_C(1) << idxRte;
673	if (pThis->uIrr & uPinMask)
674	{
675	LogFlow(("IOAPIC: ioapicSetRedirTableEntry: Signalling pending interrupt. idxRte=%u\n", idxRte));
676	ioapicSignalIntrForRte(pDevIns, pThis, pThisCC, idxRte);
677	}
678
679	IOAPIC_UNLOCK(pDevIns, pThis, pThisCC);
680	}
681	else
682	STAM_COUNTER_INC(&pThis->StatSetRteContention);
683
684	return rc;
685	}
686
687
688	/**
689	* Gets the data register.
690	*
691	* @returns The data value.
692	* @param pThis The shared I/O APIC device state.
693	*/
694	static uint32_t ioapicGetData(PCIOAPIC pThis)
695	{
696	uint8_t const uIndex = pThis->u8Index;
697	RT_UNTRUSTED_NONVOLATILE_COPY_FENCE();
698	if ( uIndex >= IOAPIC_INDIRECT_INDEX_REDIR_TBL_START
699	&& uIndex <= pThis->u8LastRteRegIdx)
700	return ioapicGetRedirTableEntry(pThis, uIndex);
701
702	uint32_t uValue;
703	switch (uIndex)
704	{
705	case IOAPIC_INDIRECT_INDEX_ID:
706	uValue = ioapicGetId(pThis);
707	break;
708
709	case IOAPIC_INDIRECT_INDEX_VERSION:
710	uValue = ioapicGetVersion(pThis);
711	break;
712
713	case IOAPIC_INDIRECT_INDEX_ARB:
714	if (pThis->u8ApicVer == IOAPIC_VERSION_82093AA)
715	{
716	uValue = ioapicGetArb();
717	break;
718	}
719	RT_FALL_THRU();
720
721	default:
722	uValue = UINT32_C(0xffffffff);
723	Log2(("IOAPIC: Attempt to read register at invalid index %#x\n", uIndex));
724	break;
725	}
726	return uValue;
727	}
728
729
730	/**
731	* Sets the data register.
732	*
733	* @returns Strict VBox status code.
734	* @param pDevIns The device instance.
735	* @param pThis The shared I/O APIC device state.
736	* @param pThisCC The I/O APIC device state for the current context.
737	* @param uValue The value to set.
738	*/
739	static VBOXSTRICTRC ioapicSetData(PPDMDEVINS pDevIns, PIOAPIC pThis, PIOAPICCC pThisCC, uint32_t uValue)
740	{
741	uint8_t const uIndex = pThis->u8Index;
742	RT_UNTRUSTED_NONVOLATILE_COPY_FENCE();
743	LogFlow(("IOAPIC: ioapicSetData: uIndex=%#x uValue=%#RX32\n", uIndex, uValue));
744
745	if ( uIndex >= IOAPIC_INDIRECT_INDEX_REDIR_TBL_START
746	&& uIndex <= pThis->u8LastRteRegIdx)
747	return ioapicSetRedirTableEntry(pDevIns, pThis, pThisCC, uIndex, uValue);
748
749	if (uIndex == IOAPIC_INDIRECT_INDEX_ID)
750	ioapicSetId(pThis, uValue);
751	else
752	Log2(("IOAPIC: ioapicSetData: Invalid index %#RX32, ignoring write request with uValue=%#RX32\n", uIndex, uValue));
753
754	return VINF_SUCCESS;
755	}
756
757
758	/**
759	* @interface_method_impl{PDMIOAPICREG,pfnSetEoi}
760	*/
761	static DECLCALLBACK(VBOXSTRICTRC) ioapicSetEoi(PPDMDEVINS pDevIns, uint8_t u8Vector)
762	{
763	PIOAPIC pThis = PDMDEVINS_2_DATA(pDevIns, PIOAPIC);
764	PIOAPICCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PIOAPICCC);
765	STAM_COUNTER_INC(&pThis->CTX_SUFF_Z(StatSetEoi));
766	LogFlow(("IOAPIC: ioapicSetEoi: u8Vector=%#x (%u)\n", u8Vector, u8Vector));
767
768	bool fRemoteIrrCleared = false;
769	VBOXSTRICTRC rc = IOAPIC_LOCK(pDevIns, pThis, pThisCC, VINF_IOM_R3_MMIO_WRITE);
770	if (rc == VINF_SUCCESS)
771	{
772	for (uint8_t idxRte = 0; idxRte < RT_ELEMENTS(pThis->au64RedirTable); idxRte++)
773	{
774	uint64_t const u64Rte = pThis->au64RedirTable[idxRte];
775	if (IOAPIC_RTE_GET_VECTOR(u64Rte) == u8Vector)
776	{
777	#ifdef DEBUG_ramshankar
778	/* This assertion may trigger when restoring saved-states created using the old, incorrect I/O APIC code. */
779	Assert(IOAPIC_RTE_GET_REMOTE_IRR(u64Rte));
780	#endif
781	pThis->au64RedirTable[idxRte] &= ~IOAPIC_RTE_REMOTE_IRR;
782	fRemoteIrrCleared = true;
783	STAM_COUNTER_INC(&pThis->StatEoiReceived);
784	Log2(("IOAPIC: ioapicSetEoi: Cleared remote IRR, idxRte=%u vector=%#x (%u)\n", idxRte, u8Vector, u8Vector));
785
786	/*
787	* Signal the next pending interrupt for this RTE.
788	*/
789	uint32_t const uPinMask = UINT32_C(1) << idxRte;
790	if (pThis->uIrr & uPinMask)
791	ioapicSignalIntrForRte(pDevIns, pThis, pThisCC, idxRte);
792	}
793	}
794
795	IOAPIC_UNLOCK(pDevIns, pThis, pThisCC);
796	#ifndef VBOX_WITH_IOMMU_AMD
797	AssertMsg(fRemoteIrrCleared, ("Failed to clear remote IRR for vector %#x (%u)\n", u8Vector, u8Vector));
798	#endif
799	}
800	else
801	STAM_COUNTER_INC(&pThis->StatEoiContention);
802
803	return rc;
804	}
805
806
807	/**
808	* @interface_method_impl{PDMIOAPICREG,pfnSetIrq}
809	*/
810	static DECLCALLBACK(void) ioapicSetIrq(PPDMDEVINS pDevIns, PCIBDF uBusDevFn, int iIrq, int iLevel, uint32_t uTagSrc)
811	{
812	RT_NOREF(uBusDevFn); /** @todo r=ramshankar: Remove this argument if it's also unnecessary with Intel IOMMU. */
813	#define IOAPIC_ASSERT_IRQ(a_uBusDevFn, a_idxRte, a_PinMask) do { \
814	pThis->au32TagSrc[(a_idxRte)] = !pThis->au32TagSrc[(a_idxRte)] ? uTagSrc : RT_BIT_32(31); \
815	pThis->uIrr \|= a_PinMask; \
816	ioapicSignalIntrForRte(pDevIns, pThis, pThisCC, (a_idxRte)); \
817	} while (0)
818
819	PIOAPIC pThis = PDMDEVINS_2_DATA(pDevIns, PIOAPIC);
820	PIOAPICCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PIOAPICCC);
821	LogFlow(("IOAPIC: ioapicSetIrq: iIrq=%d iLevel=%d uTagSrc=%#x\n", iIrq, iLevel, uTagSrc));
822
823	STAM_COUNTER_INC(&pThis->CTX_SUFF_Z(StatSetIrq));
824
825	if (RT_LIKELY((unsigned)iIrq < RT_ELEMENTS(pThis->au64RedirTable)))
826	{
827	int rc = IOAPIC_LOCK(pDevIns, pThis, pThisCC, VINF_SUCCESS);
828	AssertRC(rc);
829
830	uint8_t const idxRte = iIrq;
831	uint32_t const uPinMask = UINT32_C(1) << idxRte;
832	uint32_t const u32RteLo = RT_LO_U32(pThis->au64RedirTable[idxRte]);
833	uint8_t const u8TriggerMode = IOAPIC_RTE_GET_TRIGGER_MODE(u32RteLo);
834
835	bool fActive = RT_BOOL(iLevel & 1);
836	/** @todo Polarity is busted elsewhere, we need to fix that
837	* first. See @bugref{8386#c7}. */
838	#if 0
839	uint8_t const u8Polarity = IOAPIC_RTE_GET_POLARITY(u32RteLo);
840	fActive ^= u8Polarity; */
841	#endif
842	if (!fActive)
843	{
844	pThis->uIrr &= ~uPinMask;
845	IOAPIC_UNLOCK(pDevIns, pThis, pThisCC);
846	return;
847	}
848
849	bool const fFlipFlop = ((iLevel & PDM_IRQ_LEVEL_FLIP_FLOP) == PDM_IRQ_LEVEL_FLIP_FLOP);
850	uint32_t const uPrevIrr = pThis->uIrr & uPinMask;
851	if (!fFlipFlop)
852	{
853	if (u8TriggerMode == IOAPIC_RTE_TRIGGER_MODE_EDGE)
854	{
855	/*
856	* For edge-triggered interrupts, we need to act only on a low to high edge transition.
857	* See ICH9 spec. 13.5.7 "REDIR_TBL: Redirection Table (LPC I/F-D31:F0)".
858	*/
859	if (!uPrevIrr)
860	IOAPIC_ASSERT_IRQ(uBusDevFn, idxRte, uPinMask);
861	else
862	{
863	STAM_COUNTER_INC(&pThis->StatRedundantEdgeIntr);
864	Log2(("IOAPIC: Redundant edge-triggered interrupt %#x (%u)\n", idxRte, idxRte));
865	}
866	}
867	else
868	{
869	Assert(u8TriggerMode == IOAPIC_RTE_TRIGGER_MODE_LEVEL);
870
871	/*
872	* For level-triggered interrupts, redundant interrupts are not a problem
873	* and will eventually be delivered anyway after an EOI, but our PDM devices
874	* should not typically call us with no change to the level.
875	*/
876	if (!uPrevIrr)
877	{ /* likely */ }
878	else
879	{
880	STAM_COUNTER_INC(&pThis->StatRedundantLevelIntr);
881	Log2(("IOAPIC: Redundant level-triggered interrupt %#x (%u)\n", idxRte, idxRte));
882	}
883
884	IOAPIC_ASSERT_IRQ(uBusDevFn, idxRte, uPinMask);
885	}
886	}
887	else
888	{
889	/*
890	* The device is flip-flopping the interrupt line, which implies we should de-assert
891	* and assert the interrupt line. The interrupt line is left in the asserted state
892	* after a flip-flop request. The de-assert is a NOP wrts to signaling an interrupt
893	* hence just the assert is done.
894	*/
895	IOAPIC_ASSERT_IRQ(uBusDevFn, idxRte, uPinMask);
896	}
897
898	IOAPIC_UNLOCK(pDevIns, pThis, pThisCC);
899	}
900	#undef IOAPIC_ASSERT_IRQ
901	}
902
903
904	/**
905	* @interface_method_impl{PDMIOAPICREG,pfnSendMsi}
906	*/
907	static DECLCALLBACK(void) ioapicSendMsi(PPDMDEVINS pDevIns, PCIBDF uBusDevFn, PCMSIMSG pMsi, uint32_t uTagSrc)
908	{
909	PIOAPICCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PIOAPICCC);
910	PIOAPIC pThis = PDMDEVINS_2_DATA(pDevIns, PIOAPIC);
911	LogFlow(("IOAPIC: ioapicSendMsi: uBusDevFn=%#x Addr=%#RX64 Data=%#RX32\n", uBusDevFn, pMsi->Addr.u64, pMsi->Data.u32));
912
913	XAPICINTR ApicIntr;
914	RT_ZERO(ApicIntr);
915
916	#ifdef VBOX_WITH_IOMMU_AMD
917	/*
918	* The MSI may need to be remapped (or discarded) if an IOMMU is present.
919	*/
920	MSIMSG MsiOut;
921	RT_ZERO(MsiOut);
922	Assert(PCIBDF_IS_VALID(uBusDevFn));
923	int rcRemap = pThisCC->pIoApicHlp->pfnIommuMsiRemap(pDevIns, uBusDevFn, pMsi, &MsiOut);
924	if (RT_SUCCESS(rcRemap))
925	{
926	STAM_COUNTER_INC(&pThis->StatIommuRemappedMsi);
927	ioapicGetApicIntrFromMsi(&MsiOut, &ApicIntr);
928	}
929	else
930	{
931	STAM_COUNTER_INC(&pThis->StatIommuDiscardedMsi);
932	Log(("IOAPIC: MSI (Addr=%#RX64 Data=%#RX32) remapping failed. rc=%Rrc", pMsi->Addr.u64, pMsi->Data.u32, rcRemap));
933	return;
934	}
935	#else
936	NOREF(uBusDevFn);
937	ioapicGetApicIntrFromMsi(pMsi, &ApicIntr);
938	#endif
939
940	/*
941	* Deliver to the local APIC via the system/3-wire-APIC bus.
942	*/
943	STAM_REL_COUNTER_INC(&pThis->aStatVectors[ApicIntr.u8Vector]);
944
945	int rc = pThisCC->pIoApicHlp->pfnApicBusDeliver(pDevIns,
946	ApicIntr.u8Dest,
947	ApicIntr.u8DestMode,
948	ApicIntr.u8DeliveryMode,
949	ApicIntr.u8Vector,
950	0 /* u8Polarity - N/A */,
951	ApicIntr.u8TriggerMode,
952	uTagSrc);
953	/* Can't reschedule to R3. */
954	Assert(rc == VINF_SUCCESS \|\| rc == VERR_APIC_INTR_DISCARDED); NOREF(rc);
955	}
956
957
958	/**
959	* @callback_method_impl{FNIOMMMIONEWREAD}
960	*/
961	static DECLCALLBACK(VBOXSTRICTRC) ioapicMmioRead(PPDMDEVINS pDevIns, void pvUser, RTGCPHYS off, void pv, unsigned cb)
962	{
963	PIOAPIC pThis = PDMDEVINS_2_DATA(pDevIns, PIOAPIC);
964	STAM_COUNTER_INC(&pThis->CTX_SUFF_Z(StatMmioRead));
965	Assert(cb == 4); RT_NOREF_PV(cb); /* registered for dwords only */
966	RT_NOREF_PV(pvUser);
967
968	VBOXSTRICTRC rc = VINF_SUCCESS;
969	uint32_t puValue = (uint32_t )pv;
970	uint32_t offReg = off & IOAPIC_MMIO_REG_MASK;
971	switch (offReg)
972	{
973	case IOAPIC_DIRECT_OFF_INDEX:
974	*puValue = ioapicGetIndex(pThis);
975	break;
976
977	case IOAPIC_DIRECT_OFF_DATA:
978	*puValue = ioapicGetData(pThis);
979	break;
980
981	default:
982	Log2(("IOAPIC: ioapicMmioRead: Invalid offset. off=%#RGp offReg=%#x\n", off, offReg));
983	rc = VINF_IOM_MMIO_UNUSED_FF;
984	break;
985	}
986
987	LogFlow(("IOAPIC: ioapicMmioRead: offReg=%#x, returns %#RX32\n", offReg, *puValue));
988	return rc;
989	}
990
991
992	/**
993	* @callback_method_impl{FNIOMMMIONEWWRITE}
994	*/
995	static DECLCALLBACK(VBOXSTRICTRC) ioapicMmioWrite(PPDMDEVINS pDevIns, void pvUser, RTGCPHYS off, void const pv, unsigned cb)
996	{
997	PIOAPIC pThis = PDMDEVINS_2_DATA(pDevIns, PIOAPIC);
998	PIOAPICCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PIOAPICCC);
999	RT_NOREF_PV(pvUser);
1000
1001	STAM_COUNTER_INC(&pThis->CTX_SUFF_Z(StatMmioWrite));
1002
1003	Assert(!(off & 3));
1004	Assert(cb == 4); RT_NOREF_PV(cb); /* registered for dwords only */
1005
1006	VBOXSTRICTRC rc = VINF_SUCCESS;
1007	uint32_t const uValue = (uint32_t const )pv;
1008	uint32_t const offReg = off & IOAPIC_MMIO_REG_MASK;
1009
1010	LogFlow(("IOAPIC: ioapicMmioWrite: pThis=%p off=%#RGp cb=%u uValue=%#RX32\n", pThis, off, cb, uValue));
1011	switch (offReg)
1012	{
1013	case IOAPIC_DIRECT_OFF_INDEX:
1014	ioapicSetIndex(pThis, uValue);
1015	break;
1016
1017	case IOAPIC_DIRECT_OFF_DATA:
1018	rc = ioapicSetData(pDevIns, pThis, pThisCC, uValue);
1019	break;
1020
1021	case IOAPIC_DIRECT_OFF_EOI:
1022	if (pThis->u8ApicVer == IOAPIC_VERSION_ICH9)
1023	rc = ioapicSetEoi(pDevIns, uValue);
1024	else
1025	Log(("IOAPIC: ioapicMmioWrite: Write to EOI register ignored!\n"));
1026	break;
1027
1028	default:
1029	Log2(("IOAPIC: ioapicMmioWrite: Invalid offset. off=%#RGp offReg=%#x\n", off, offReg));
1030	break;
1031	}
1032
1033	return rc;
1034	}
1035
1036
1037	#ifdef IN_RING3
1038
1039	/** @interface_method_impl{DBGFREGDESC,pfnGet} */
1040	static DECLCALLBACK(int) ioapicR3DbgReg_GetIndex(void *pvUser, PCDBGFREGDESC pDesc, PDBGFREGVAL pValue)
1041	{
1042	RT_NOREF(pDesc);
1043	pValue->u32 = ioapicGetIndex(PDMDEVINS_2_DATA((PPDMDEVINS)pvUser, PCIOAPIC));
1044	return VINF_SUCCESS;
1045	}
1046
1047
1048	/** @interface_method_impl{DBGFREGDESC,pfnSet} */
1049	static DECLCALLBACK(int) ioapicR3DbgReg_SetIndex(void *pvUser, PCDBGFREGDESC pDesc, PCDBGFREGVAL pValue, PCDBGFREGVAL pfMask)
1050	{
1051	RT_NOREF(pDesc, pfMask);
1052	ioapicSetIndex(PDMDEVINS_2_DATA((PPDMDEVINS)pvUser, PIOAPIC), pValue->u8);
1053	return VINF_SUCCESS;
1054	}
1055
1056
1057	/** @interface_method_impl{DBGFREGDESC,pfnGet} */
1058	static DECLCALLBACK(int) ioapicR3DbgReg_GetData(void *pvUser, PCDBGFREGDESC pDesc, PDBGFREGVAL pValue)
1059	{
1060	RT_NOREF(pDesc);
1061	pValue->u32 = ioapicGetData((PDMDEVINS_2_DATA((PPDMDEVINS)pvUser, PCIOAPIC)));
1062	return VINF_SUCCESS;
1063	}
1064
1065
1066	/** @interface_method_impl{DBGFREGDESC,pfnSet} */
1067	static DECLCALLBACK(int) ioapicR3DbgReg_SetData(void *pvUser, PCDBGFREGDESC pDesc, PCDBGFREGVAL pValue, PCDBGFREGVAL pfMask)
1068	{
1069	PPDMDEVINS pDevIns = (PPDMDEVINS)pvUser;
1070	PIOAPIC pThis = PDMDEVINS_2_DATA(pDevIns, PIOAPIC);
1071	PIOAPICCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PIOAPICCC);
1072	RT_NOREF(pDesc, pfMask);
1073	return VBOXSTRICTRC_VAL(ioapicSetData(pDevIns, pThis, pThisCC, pValue->u32));
1074	}
1075
1076
1077	/** @interface_method_impl{DBGFREGDESC,pfnGet} */
1078	static DECLCALLBACK(int) ioapicR3DbgReg_GetVersion(void *pvUser, PCDBGFREGDESC pDesc, PDBGFREGVAL pValue)
1079	{
1080	PCIOAPIC pThis = PDMDEVINS_2_DATA((PPDMDEVINS)pvUser, PCIOAPIC);
1081	RT_NOREF(pDesc);
1082	pValue->u32 = ioapicGetVersion(pThis);
1083	return VINF_SUCCESS;
1084	}
1085
1086
1087	/** @interface_method_impl{DBGFREGDESC,pfnGet} */
1088	static DECLCALLBACK(int) ioapicR3DbgReg_GetArb(void *pvUser, PCDBGFREGDESC pDesc, PDBGFREGVAL pValue)
1089	{
1090	RT_NOREF(pvUser, pDesc);
1091	pValue->u32 = ioapicGetArb();
1092	return VINF_SUCCESS;
1093	}
1094
1095
1096	/** @interface_method_impl{DBGFREGDESC,pfnGet} */
1097	static DECLCALLBACK(int) ioapicR3DbgReg_GetRte(void *pvUser, PCDBGFREGDESC pDesc, PDBGFREGVAL pValue)
1098	{
1099	PCIOAPIC pThis = PDMDEVINS_2_DATA((PPDMDEVINS)pvUser, PCIOAPIC);
1100	Assert(pDesc->offRegister < RT_ELEMENTS(pThis->au64RedirTable));
1101	pValue->u64 = pThis->au64RedirTable[pDesc->offRegister];
1102	return VINF_SUCCESS;
1103	}
1104
1105
1106	/** @interface_method_impl{DBGFREGDESC,pfnSet} */
1107	static DECLCALLBACK(int) ioapicR3DbgReg_SetRte(void *pvUser, PCDBGFREGDESC pDesc, PCDBGFREGVAL pValue, PCDBGFREGVAL pfMask)
1108	{
1109	RT_NOREF(pfMask);
1110	PIOAPIC pThis = PDMDEVINS_2_DATA((PPDMDEVINS)pvUser, PIOAPIC);
1111	/* No locks, no checks, just do it. */
1112	Assert(pDesc->offRegister < RT_ELEMENTS(pThis->au64RedirTable));
1113	pThis->au64RedirTable[pDesc->offRegister] = pValue->u64;
1114	return VINF_SUCCESS;
1115	}
1116
1117
1118	/** IOREDTBLn sub fields. */
1119	static DBGFREGSUBFIELD const g_aRteSubs[] =
1120	{
1121	{ "vector", 0, 8, 0, 0, NULL, NULL },
1122	{ "dlvr_mode", 8, 3, 0, 0, NULL, NULL },
1123	{ "dest_mode", 11, 1, 0, 0, NULL, NULL },
1124	{ "dlvr_status", 12, 1, 0, DBGFREGSUBFIELD_FLAGS_READ_ONLY, NULL, NULL },
1125	{ "polarity", 13, 1, 0, 0, NULL, NULL },
1126	{ "remote_irr", 14, 1, 0, DBGFREGSUBFIELD_FLAGS_READ_ONLY, NULL, NULL },
1127	{ "trigger_mode", 15, 1, 0, 0, NULL, NULL },
1128	{ "mask", 16, 1, 0, 0, NULL, NULL },
1129	{ "ext_dest_id", 48, 8, 0, DBGFREGSUBFIELD_FLAGS_READ_ONLY, NULL, NULL },
1130	{ "dest", 56, 8, 0, 0, NULL, NULL },
1131	DBGFREGSUBFIELD_TERMINATOR()
1132	};
1133
1134
1135	/** Register descriptors for DBGF. */
1136	static DBGFREGDESC const g_aRegDesc[] =
1137	{
1138	{ "index", DBGFREG_END, DBGFREGVALTYPE_U8, 0, 0, ioapicR3DbgReg_GetIndex, ioapicR3DbgReg_SetIndex, NULL, NULL },
1139	{ "data", DBGFREG_END, DBGFREGVALTYPE_U32, 0, 0, ioapicR3DbgReg_GetData, ioapicR3DbgReg_SetData, NULL, NULL },
1140	{ "version", DBGFREG_END, DBGFREGVALTYPE_U32, DBGFREG_FLAGS_READ_ONLY, 0, ioapicR3DbgReg_GetVersion, NULL, NULL, NULL },
1141	{ "arb", DBGFREG_END, DBGFREGVALTYPE_U32, DBGFREG_FLAGS_READ_ONLY, 0, ioapicR3DbgReg_GetArb, NULL, NULL, NULL },
1142	{ "rte0", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 0, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1143	{ "rte1", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 1, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1144	{ "rte2", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 2, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1145	{ "rte3", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 3, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1146	{ "rte4", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 4, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1147	{ "rte5", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 5, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1148	{ "rte6", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 6, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1149	{ "rte7", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 7, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1150	{ "rte8", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 8, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1151	{ "rte9", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 9, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1152	{ "rte10", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 10, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1153	{ "rte11", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 11, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1154	{ "rte12", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 12, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1155	{ "rte13", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 13, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1156	{ "rte14", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 14, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1157	{ "rte15", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 15, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1158	{ "rte16", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 16, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1159	{ "rte17", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 17, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1160	{ "rte18", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 18, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1161	{ "rte19", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 19, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1162	{ "rte20", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 20, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1163	{ "rte21", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 21, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1164	{ "rte22", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 22, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1165	{ "rte23", DBGFREG_END, DBGFREGVALTYPE_U64, 0, 23, ioapicR3DbgReg_GetRte, ioapicR3DbgReg_SetRte, NULL, &g_aRteSubs[0] },
1166	DBGFREGDESC_TERMINATOR()
1167	};
1168
1169
1170	/**
1171	* @callback_method_impl{FNDBGFHANDLERDEV}
1172	*/
1173	static DECLCALLBACK(void) ioapicR3DbgInfo(PPDMDEVINS pDevIns, PCDBGFINFOHLP pHlp, const char *pszArgs)
1174	{
1175	RT_NOREF(pszArgs);
1176	PCIOAPIC pThis = PDMDEVINS_2_DATA(pDevIns, PIOAPIC);
1177	LogFlow(("IOAPIC: ioapicR3DbgInfo: pThis=%p pszArgs=%s\n", pThis, pszArgs));
1178
1179	pHlp->pfnPrintf(pHlp, "I/O APIC at %#010x:\n", IOAPIC_MMIO_BASE_PHYSADDR);
1180
1181	uint32_t const uId = ioapicGetId(pThis);
1182	pHlp->pfnPrintf(pHlp, " ID = %#RX32\n", uId);
1183	pHlp->pfnPrintf(pHlp, " ID = %#x\n", IOAPIC_ID_GET_ID(uId));
1184
1185	uint32_t const uVer = ioapicGetVersion(pThis);
1186	pHlp->pfnPrintf(pHlp, " Version = %#RX32\n", uVer);
1187	pHlp->pfnPrintf(pHlp, " Version = %#x\n", IOAPIC_VER_GET_VER(uVer));
1188	pHlp->pfnPrintf(pHlp, " Pin Assert Reg. Support = %RTbool\n", IOAPIC_VER_HAS_PRQ(uVer));
1189	pHlp->pfnPrintf(pHlp, " Max. Redirection Entry = %u\n", IOAPIC_VER_GET_MRE(uVer));
1190
1191	if (pThis->u8ApicVer == IOAPIC_VERSION_82093AA)
1192	{
1193	uint32_t const uArb = ioapicGetArb();
1194	pHlp->pfnPrintf(pHlp, " Arbitration = %#RX32\n", uArb);
1195	pHlp->pfnPrintf(pHlp, " Arbitration ID = %#x\n", IOAPIC_ARB_GET_ID(uArb));
1196	}
1197
1198	pHlp->pfnPrintf(pHlp, " Current index = %#x\n", ioapicGetIndex(pThis));
1199
1200	pHlp->pfnPrintf(pHlp, " I/O Redirection Table and IRR:\n");
1201	pHlp->pfnPrintf(pHlp, " idx dst_mode dst_addr mask irr trigger rirr polar dlvr_st dlvr_mode vector\n");
1202
1203	uint8_t const idxMaxRte = RT_MIN(pThis->u8MaxRte, RT_ELEMENTS(pThis->au64RedirTable) - 1);
1204	for (uint8_t idxRte = 0; idxRte <= idxMaxRte; idxRte++)
1205	{
1206	static const char * const s_apszDeliveryModes[] =
1207	{
1208	"Fixed ",
1209	"LowPri",
1210	"SMI ",
1211	"Rsvd ",
1212	"NMI ",
1213	"INIT ",
1214	"Rsvd ",
1215	"ExtINT"
1216	};
1217
1218	const uint64_t u64Rte = pThis->au64RedirTable[idxRte];
1219	const char *pszDestMode = IOAPIC_RTE_GET_DEST_MODE(u64Rte) == 0 ? "phys" : "log ";
1220	const uint8_t uDest = IOAPIC_RTE_GET_DEST(u64Rte);
1221	const uint8_t uMask = IOAPIC_RTE_GET_MASK(u64Rte);
1222	const char *pszTriggerMode = IOAPIC_RTE_GET_TRIGGER_MODE(u64Rte) == 0 ? "edge " : "level";
1223	const uint8_t uRemoteIrr = IOAPIC_RTE_GET_REMOTE_IRR(u64Rte);
1224	const char *pszPolarity = IOAPIC_RTE_GET_POLARITY(u64Rte) == 0 ? "acthi" : "actlo";
1225	const char *pszDeliveryStatus = IOAPIC_RTE_GET_DELIVERY_STATUS(u64Rte) == 0 ? "idle" : "pend";
1226	const uint8_t uDeliveryMode = IOAPIC_RTE_GET_DELIVERY_MODE(u64Rte);
1227	Assert(uDeliveryMode < RT_ELEMENTS(s_apszDeliveryModes));
1228	const char *pszDeliveryMode = s_apszDeliveryModes[uDeliveryMode];
1229	const uint8_t uVector = IOAPIC_RTE_GET_VECTOR(u64Rte);
1230
1231	pHlp->pfnPrintf(pHlp, " %02d %s %02x %u %u %s %u %s %s %s %3u (%016llx)\n",
1232	idxRte,
1233	pszDestMode,
1234	uDest,
1235	uMask,
1236	(pThis->uIrr >> idxRte) & 1,
1237	pszTriggerMode,
1238	uRemoteIrr,
1239	pszPolarity,
1240	pszDeliveryStatus,
1241	pszDeliveryMode,
1242	uVector,
1243	u64Rte);
1244	}
1245	}
1246
1247
1248	/**
1249	* @copydoc FNSSMDEVSAVEEXEC
1250	*/
1251	static DECLCALLBACK(int) ioapicR3SaveExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM)
1252	{
1253	PCIOAPIC pThis = PDMDEVINS_2_DATA(pDevIns, PCIOAPIC);
1254	PCPDMDEVHLPR3 pHlp = pDevIns->pHlpR3;
1255	LogFlow(("IOAPIC: ioapicR3SaveExec\n"));
1256
1257	pHlp->pfnSSMPutU32(pSSM, pThis->uIrr);
1258	pHlp->pfnSSMPutU8(pSSM, pThis->u8Id);
1259	pHlp->pfnSSMPutU8(pSSM, pThis->u8Index);
1260	for (uint8_t idxRte = 0; idxRte < RT_ELEMENTS(pThis->au64RedirTable); idxRte++)
1261	pHlp->pfnSSMPutU64(pSSM, pThis->au64RedirTable[idxRte]);
1262
1263	return VINF_SUCCESS;
1264	}
1265
1266
1267	/**
1268	* @copydoc FNSSMDEVLOADEXEC
1269	*/
1270	static DECLCALLBACK(int) ioapicR3LoadExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass)
1271	{
1272	PIOAPIC pThis = PDMDEVINS_2_DATA(pDevIns, PIOAPIC);
1273	PCPDMDEVHLPR3 pHlp = pDevIns->pHlpR3;
1274	LogFlow(("APIC: apicR3LoadExec: uVersion=%u uPass=%#x\n", uVersion, uPass));
1275
1276	Assert(uPass == SSM_PASS_FINAL);
1277	NOREF(uPass);
1278
1279	/* Weed out invalid versions. */
1280	if ( uVersion != IOAPIC_SAVED_STATE_VERSION
1281	&& uVersion != IOAPIC_SAVED_STATE_VERSION_VBOX_50)
1282	{
1283	LogRel(("IOAPIC: ioapicR3LoadExec: Invalid/unrecognized saved-state version %u (%#x)\n", uVersion, uVersion));
1284	return VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION;
1285	}
1286
1287	if (uVersion == IOAPIC_SAVED_STATE_VERSION)
1288	pHlp->pfnSSMGetU32(pSSM, &pThis->uIrr);
1289
1290	pHlp->pfnSSMGetU8V(pSSM, &pThis->u8Id);
1291	pHlp->pfnSSMGetU8V(pSSM, &pThis->u8Index);
1292	for (uint8_t idxRte = 0; idxRte < RT_ELEMENTS(pThis->au64RedirTable); idxRte++)
1293	pHlp->pfnSSMGetU64(pSSM, &pThis->au64RedirTable[idxRte]);
1294
1295	return VINF_SUCCESS;
1296	}
1297
1298
1299	/**
1300	* @interface_method_impl{PDMDEVREG,pfnReset}
1301	*/
1302	static DECLCALLBACK(void) ioapicR3Reset(PPDMDEVINS pDevIns)
1303	{
1304	PIOAPIC pThis = PDMDEVINS_2_DATA(pDevIns, PIOAPIC);
1305	PIOAPICCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PIOAPICCC);
1306	LogFlow(("IOAPIC: ioapicR3Reset: pThis=%p\n", pThis));
1307
1308	/* There might be devices threads calling ioapicSetIrq() in parallel, hence the lock. */
1309	IOAPIC_LOCK(pDevIns, pThis, pThisCC, VERR_IGNORED);
1310
1311	pThis->uIrr = 0;
1312	pThis->u8Index = 0;
1313	pThis->u8Id = 0;
1314
1315	for (uint8_t idxRte = 0; idxRte < RT_ELEMENTS(pThis->au64RedirTable); idxRte++)
1316	{
1317	pThis->au64RedirTable[idxRte] = IOAPIC_RTE_MASK;
1318	pThis->au32TagSrc[idxRte] = 0;
1319	}
1320
1321	IOAPIC_UNLOCK(pDevIns, pThis, pThisCC);
1322	}
1323
1324
1325	/**
1326	* @interface_method_impl{PDMDEVREG,pfnRelocate}
1327	*/
1328	static DECLCALLBACK(void) ioapicR3Relocate(PPDMDEVINS pDevIns, RTGCINTPTR offDelta)
1329	{
1330	PIOAPICRC pThisRC = PDMINS_2_DATA_RC(pDevIns, PIOAPICRC);
1331	LogFlow(("IOAPIC: ioapicR3Relocate: pThis=%p offDelta=%RGi\n", PDMDEVINS_2_DATA(pDevIns, PIOAPIC), offDelta));
1332
1333	pThisRC->pIoApicHlp += offDelta;
1334	}
1335
1336
1337	/**
1338	* @interface_method_impl{PDMDEVREG,pfnDestruct}
1339	*/
1340	static DECLCALLBACK(int) ioapicR3Destruct(PPDMDEVINS pDevIns)
1341	{
1342	PDMDEV_CHECK_VERSIONS_RETURN_QUIET(pDevIns);
1343	PIOAPIC pThis = PDMDEVINS_2_DATA(pDevIns, PIOAPIC);
1344	LogFlow(("IOAPIC: ioapicR3Destruct: pThis=%p\n", pThis));
1345
1346	# ifndef IOAPIC_WITH_PDM_CRITSECT
1347	/*
1348	* Destroy the RTE critical section.
1349	*/
1350	if (PDMCritSectIsInitialized(&pThis->CritSect))
1351	PDMR3CritSectDelete(&pThis->CritSect);
1352	# else
1353	RT_NOREF_PV(pThis);
1354	# endif
1355
1356	return VINF_SUCCESS;
1357	}
1358
1359
1360	/**
1361	* @interface_method_impl{PDMDEVREG,pfnConstruct}
1362	*/
1363	static DECLCALLBACK(int) ioapicR3Construct(PPDMDEVINS pDevIns, int iInstance, PCFGMNODE pCfg)
1364	{
1365	PDMDEV_CHECK_VERSIONS_RETURN(pDevIns);
1366	PIOAPIC pThis = PDMDEVINS_2_DATA(pDevIns, PIOAPIC);
1367	PIOAPICCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PIOAPICCC);
1368	PCPDMDEVHLPR3 pHlp = pDevIns->pHlpR3;
1369	LogFlow(("IOAPIC: ioapicR3Construct: pThis=%p iInstance=%d\n", pThis, iInstance));
1370	Assert(iInstance == 0); RT_NOREF(iInstance);
1371
1372	/*
1373	* Validate and read the configuration.
1374	*/
1375	PDMDEV_VALIDATE_CONFIG_RETURN(pDevIns, "NumCPUs\|ChipType", "");
1376
1377	/* The number of CPUs is currently unused, but left in CFGM and saved-state in case an ID of 0
1378	upsets some guest which we haven't yet been tested. */
1379	uint32_t cCpus;
1380	int rc = pHlp->pfnCFGMQueryU32Def(pCfg, "NumCPUs", &cCpus, 1);
1381	if (RT_FAILURE(rc))
1382	return PDMDEV_SET_ERROR(pDevIns, rc, N_("Configuration error: Failed to query integer value \"NumCPUs\""));
1383	pThis->cCpus = (uint8_t)cCpus;
1384
1385	char szChipType[16];
1386	rc = pHlp->pfnCFGMQueryStringDef(pCfg, "ChipType", &szChipType[0], sizeof(szChipType), "ICH9");
1387	if (RT_FAILURE(rc))
1388	return PDMDEV_SET_ERROR(pDevIns, rc, N_("Configuration error: Failed to query string value \"ChipType\""));
1389
1390	if (!strcmp(szChipType, "ICH9"))
1391	{
1392	/* Newer 2007-ish I/O APIC integrated into ICH southbridges. */
1393	pThis->u8ApicVer = IOAPIC_VERSION_ICH9;
1394	pThis->u8IdMask = 0xff;
1395	pThis->u8MaxRte = IOAPIC_MAX_RTE_INDEX;
1396	pThis->u8LastRteRegIdx = IOAPIC_INDIRECT_INDEX_RTE_END;
1397	pThis->u64RteWriteMask = IOAPIC_RTE_VALID_WRITE_MASK_ICH9;
1398	pThis->u64RteReadMask = IOAPIC_RTE_VALID_READ_MASK_ICH9;
1399	}
1400	else if (!strcmp(szChipType, "82093AA"))
1401	{
1402	/* Older 1995-ish discrete I/O APIC, used in P6 class systems. */
1403	pThis->u8ApicVer = IOAPIC_VERSION_82093AA;
1404	pThis->u8IdMask = 0x0f;
1405	pThis->u8MaxRte = IOAPIC_MAX_RTE_INDEX;
1406	pThis->u8LastRteRegIdx = IOAPIC_INDIRECT_INDEX_RTE_END;
1407	pThis->u64RteWriteMask = IOAPIC_RTE_VALID_WRITE_MASK_82093AA;
1408	pThis->u64RteReadMask = IOAPIC_RTE_VALID_READ_MASK_82093AA;
1409	}
1410	else if (!strcmp(szChipType, "82379AB"))
1411	{
1412	/* Even older 1993-ish I/O APIC built into SIO.A, used in EISA and early PCI systems. */
1413	/* Exact same version and behavior as 82093AA, only the number of RTEs is different. */
1414	pThis->u8ApicVer = IOAPIC_VERSION_82093AA;
1415	pThis->u8IdMask = 0x0f;
1416	pThis->u8MaxRte = IOAPIC_REDUCED_MAX_RTE_INDEX;
1417	pThis->u8LastRteRegIdx = IOAPIC_REDUCED_INDIRECT_INDEX_RTE_END;
1418	pThis->u64RteWriteMask = IOAPIC_RTE_VALID_WRITE_MASK_82093AA;
1419	pThis->u64RteReadMask = IOAPIC_RTE_VALID_READ_MASK_82093AA;
1420	}
1421	else
1422	return PDMDevHlpVMSetError(pDevIns, VERR_PDM_DEVINS_UNKNOWN_CFG_VALUES, RT_SRC_POS,
1423	N_("I/O APIC configuration error: The \"ChipType\" value \"%s\" is unsupported"), szChipType);
1424	Log2(("IOAPIC: cCpus=%u fRZEnabled=%RTbool szChipType=%s\n", cCpus, pDevIns->fR0Enabled \| pDevIns->fRCEnabled, szChipType));
1425
1426	/*
1427	* We will use our own critical section for the IOAPIC device.
1428	*/
1429	rc = PDMDevHlpSetDeviceCritSect(pDevIns, PDMDevHlpCritSectGetNop(pDevIns));
1430	AssertRCReturn(rc, rc);
1431
1432	# ifndef IOAPIC_WITH_PDM_CRITSECT
1433	/*
1434	* Setup the critical section to protect concurrent writes to the RTEs.
1435	*/
1436	rc = PDMDevHlpCritSectInit(pDevIns, &pThis->CritSect, RT_SRC_POS, "IOAPIC");
1437	AssertRCReturn(rc, rc);
1438	# endif
1439
1440	/*
1441	* Register the IOAPIC.
1442	*/
1443	PDMIOAPICREG IoApicReg;
1444	IoApicReg.u32Version = PDM_IOAPICREG_VERSION;
1445	IoApicReg.pfnSetIrq = ioapicSetIrq;
1446	IoApicReg.pfnSendMsi = ioapicSendMsi;
1447	IoApicReg.pfnSetEoi = ioapicSetEoi;
1448	IoApicReg.u32TheEnd = PDM_IOAPICREG_VERSION;
1449	rc = PDMDevHlpIoApicRegister(pDevIns, &IoApicReg, &pThisCC->pIoApicHlp);
1450	AssertRCReturn(rc, rc);
1451
1452	/*
1453	* Register MMIO region.
1454	*/
1455	rc = PDMDevHlpMmioCreateAndMap(pDevIns, IOAPIC_MMIO_BASE_PHYSADDR, IOAPIC_MMIO_SIZE, ioapicMmioWrite, ioapicMmioRead,
1456	IOMMMIO_FLAGS_READ_DWORD \| IOMMMIO_FLAGS_WRITE_DWORD_ZEROED, "I/O APIC", &pThis->hMmio);
1457	AssertRCReturn(rc, rc);
1458
1459	/*
1460	* Register the saved state.
1461	*/
1462	rc = PDMDevHlpSSMRegister(pDevIns, IOAPIC_SAVED_STATE_VERSION, sizeof(*pThis), ioapicR3SaveExec, ioapicR3LoadExec);
1463	AssertRCReturn(rc, rc);
1464
1465	/*
1466	* Register debugger info item.
1467	*/
1468	rc = PDMDevHlpDBGFInfoRegister(pDevIns, "ioapic", "Display IO APIC state.", ioapicR3DbgInfo);
1469	AssertRCReturn(rc, rc);
1470
1471	/*
1472	* Register debugger register access.
1473	*/
1474	rc = PDMDevHlpDBGFRegRegister(pDevIns, g_aRegDesc);
1475	AssertRCReturn(rc, rc);
1476
1477	# ifdef VBOX_WITH_STATISTICS
1478	/*
1479	* Statistics.
1480	*/
1481	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatMmioReadRZ, STAMTYPE_COUNTER, "RZ/MmioRead", STAMUNIT_OCCURENCES, "Number of IOAPIC MMIO reads in RZ.");
1482	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatMmioWriteRZ, STAMTYPE_COUNTER, "RZ/MmioWrite", STAMUNIT_OCCURENCES, "Number of IOAPIC MMIO writes in RZ.");
1483	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatSetIrqRZ, STAMTYPE_COUNTER, "RZ/SetIrq", STAMUNIT_OCCURENCES, "Number of IOAPIC SetIrq calls in RZ.");
1484	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatSetEoiRZ, STAMTYPE_COUNTER, "RZ/SetEoi", STAMUNIT_OCCURENCES, "Number of IOAPIC SetEoi calls in RZ.");
1485
1486	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatMmioReadR3, STAMTYPE_COUNTER, "R3/MmioRead", STAMUNIT_OCCURENCES, "Number of IOAPIC MMIO reads in R3");
1487	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatMmioWriteR3, STAMTYPE_COUNTER, "R3/MmioWrite", STAMUNIT_OCCURENCES, "Number of IOAPIC MMIO writes in R3.");
1488	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatSetIrqR3, STAMTYPE_COUNTER, "R3/SetIrq", STAMUNIT_OCCURENCES, "Number of IOAPIC SetIrq calls in R3.");
1489	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatSetEoiR3, STAMTYPE_COUNTER, "R3/SetEoi", STAMUNIT_OCCURENCES, "Number of IOAPIC SetEoi calls in R3.");
1490
1491	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatRedundantEdgeIntr, STAMTYPE_COUNTER, "RedundantEdgeIntr", STAMUNIT_OCCURENCES, "Number of redundant edge-triggered interrupts (no IRR change).");
1492	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatRedundantLevelIntr, STAMTYPE_COUNTER, "RedundantLevelIntr", STAMUNIT_OCCURENCES, "Number of redundant level-triggered interrupts (no IRR change).");
1493	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatSuppressedLevelIntr, STAMTYPE_COUNTER, "SuppressedLevelIntr", STAMUNIT_OCCURENCES, "Number of suppressed level-triggered interrupts by remote IRR.");
1494
1495	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatIommuRemappedIntr, STAMTYPE_COUNTER, "Iommu/RemappedIntr", STAMUNIT_OCCURENCES, "Number of interrupts remapped by the IOMMU.");
1496	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatIommuRemappedMsi, STAMTYPE_COUNTER, "Iommu/RemappedMsi", STAMUNIT_OCCURENCES, "Number of MSIs remapped by the IOMMU.");
1497	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatIommuDiscardedIntr, STAMTYPE_COUNTER, "Iommu/DiscardedIntr", STAMUNIT_OCCURENCES, "Number of interrupts discarded by the IOMMU.");
1498	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatIommuDiscardedMsi, STAMTYPE_COUNTER, "Iommu/DiscardedMsi", STAMUNIT_OCCURENCES, "Number of MSIs discarded by the IOMMU.");
1499
1500	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatEoiContention, STAMTYPE_COUNTER, "CritSect/ContentionSetEoi", STAMUNIT_OCCURENCES, "Number of times the critsect is busy during EOI writes causing trips to R3.");
1501	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatSetRteContention, STAMTYPE_COUNTER, "CritSect/ContentionSetRte", STAMUNIT_OCCURENCES, "Number of times the critsect is busy during RTE writes causing trips to R3.");
1502
1503	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatLevelIrqSent, STAMTYPE_COUNTER, "LevelIntr/Sent", STAMUNIT_OCCURENCES, "Number of level-triggered interrupts sent to the local APIC(s).");
1504	PDMDevHlpSTAMRegister(pDevIns, &pThis->StatEoiReceived, STAMTYPE_COUNTER, "LevelIntr/Recv", STAMUNIT_OCCURENCES, "Number of EOIs received for level-triggered interrupts from the local APIC(s).");
1505	# endif
1506	for (size_t i = 0; i < RT_ELEMENTS(pThis->aStatVectors); i++)
1507	PDMDevHlpSTAMRegisterF(pDevIns, &pThis->aStatVectors[i], STAMTYPE_COUNTER, STAMVISIBILITY_USED, STAMUNIT_OCCURENCES,
1508	"Number of ioapicSendMsi/pfnApicBusDeliver calls for the vector.", "Vectors/%02x", i);
1509
1510	/*
1511	* Init. the device state.
1512	*/
1513	LogRel(("IOAPIC: Using implementation 2.0! I/O APIC version is %d.%d\n", pThis->u8ApicVer >> 4, pThis->u8ApicVer & 0x0F));
1514	ioapicR3Reset(pDevIns);
1515
1516	return VINF_SUCCESS;
1517	}
1518
1519	#else /* !IN_RING3 */
1520
1521	/**
1522	* @callback_method_impl{PDMDEVREGR0,pfnConstruct}
1523	*/
1524	static DECLCALLBACK(int) ioapicRZConstruct(PPDMDEVINS pDevIns)
1525	{
1526	PDMDEV_CHECK_VERSIONS_RETURN(pDevIns);
1527	PIOAPIC pThis = PDMDEVINS_2_DATA(pDevIns, PIOAPIC);
1528	PIOAPICCC pThisCC = PDMDEVINS_2_DATA_CC(pDevIns, PIOAPICCC);
1529
1530	int rc = PDMDevHlpSetDeviceCritSect(pDevIns, PDMDevHlpCritSectGetNop(pDevIns));
1531	AssertRCReturn(rc, rc);
1532
1533	PDMIOAPICREG IoApicReg;
1534	IoApicReg.u32Version = PDM_IOAPICREG_VERSION;
1535	IoApicReg.pfnSetIrq = ioapicSetIrq;
1536	IoApicReg.pfnSendMsi = ioapicSendMsi;
1537	IoApicReg.pfnSetEoi = ioapicSetEoi;
1538	IoApicReg.u32TheEnd = PDM_IOAPICREG_VERSION;
1539	rc = PDMDevHlpIoApicSetUpContext(pDevIns, &IoApicReg, &pThisCC->pIoApicHlp);
1540	AssertRCReturn(rc, rc);
1541
1542	rc = PDMDevHlpMmioSetUpContext(pDevIns, pThis->hMmio, ioapicMmioWrite, ioapicMmioRead, NULL /pvUser/);
1543	AssertRCReturn(rc, rc);
1544
1545	return VINF_SUCCESS;
1546	}
1547
1548	#endif /* !IN_RING3 */
1549
1550	/**
1551	* IO APIC device registration structure.
1552	*/
1553	const PDMDEVREG g_DeviceIOAPIC =
1554	{
1555	/* .u32Version = */ PDM_DEVREG_VERSION,
1556	/* .uReserved0 = */ 0,
1557	/* .szName = */ "ioapic",
1558	/* .fFlags = */ PDM_DEVREG_FLAGS_DEFAULT_BITS \| PDM_DEVREG_FLAGS_RZ \| PDM_DEVREG_FLAGS_NEW_STYLE
1559	\| PDM_DEVREG_FLAGS_REQUIRE_R0 \| PDM_DEVREG_FLAGS_REQUIRE_RC,
1560	/* .fClass = */ PDM_DEVREG_CLASS_PIC,
1561	/* .cMaxInstances = */ 1,
1562	/* .uSharedVersion = */ 42,
1563	/* .cbInstanceShared = */ sizeof(IOAPIC),
1564	/* .cbInstanceCC = */ sizeof(IOAPICCC),
1565	/* .cbInstanceRC = */ sizeof(IOAPICRC),
1566	/* .cMaxPciDevices = */ 0,
1567	/* .cMaxMsixVectors = */ 0,
1568	/* .pszDescription = */ "I/O Advanced Programmable Interrupt Controller (IO-APIC) Device",
1569	#if defined(IN_RING3)
1570	/* .pszRCMod = */ "VBoxDDRC.rc",
1571	/* .pszR0Mod = */ "VBoxDDR0.r0",
1572	/* .pfnConstruct = */ ioapicR3Construct,
1573	/* .pfnDestruct = */ ioapicR3Destruct,
1574	/* .pfnRelocate = */ ioapicR3Relocate,
1575	/* .pfnMemSetup = */ NULL,
1576	/* .pfnPowerOn = */ NULL,
1577	/* .pfnReset = */ ioapicR3Reset,
1578	/* .pfnSuspend = */ NULL,
1579	/* .pfnResume = */ NULL,
1580	/* .pfnAttach = */ NULL,
1581	/* .pfnDetach = */ NULL,
1582	/* .pfnQueryInterface = */ NULL,
1583	/* .pfnInitComplete = */ NULL,
1584	/* .pfnPowerOff = */ NULL,
1585	/* .pfnSoftReset = */ NULL,
1586	/* .pfnReserved0 = */ NULL,
1587	/* .pfnReserved1 = */ NULL,
1588	/* .pfnReserved2 = */ NULL,
1589	/* .pfnReserved3 = */ NULL,
1590	/* .pfnReserved4 = */ NULL,
1591	/* .pfnReserved5 = */ NULL,
1592	/* .pfnReserved6 = */ NULL,
1593	/* .pfnReserved7 = */ NULL,
1594	#elif defined(IN_RING0)
1595	/* .pfnEarlyConstruct = */ NULL,
1596	/* .pfnConstruct = */ ioapicRZConstruct,
1597	/* .pfnDestruct = */ NULL,
1598	/* .pfnFinalDestruct = */ NULL,
1599	/* .pfnRequest = */ NULL,
1600	/* .pfnReserved0 = */ NULL,
1601	/* .pfnReserved1 = */ NULL,
1602	/* .pfnReserved2 = */ NULL,
1603	/* .pfnReserved3 = */ NULL,
1604	/* .pfnReserved4 = */ NULL,
1605	/* .pfnReserved5 = */ NULL,
1606	/* .pfnReserved6 = */ NULL,
1607	/* .pfnReserved7 = */ NULL,
1608	#elif defined(IN_RC)
1609	/* .pfnConstruct = */ ioapicRZConstruct,
1610	/* .pfnReserved0 = */ NULL,
1611	/* .pfnReserved1 = */ NULL,
1612	/* .pfnReserved2 = */ NULL,
1613	/* .pfnReserved3 = */ NULL,
1614	/* .pfnReserved4 = */ NULL,
1615	/* .pfnReserved5 = */ NULL,
1616	/* .pfnReserved6 = */ NULL,
1617	/* .pfnReserved7 = */ NULL,
1618	#else
1619	# error "Not in IN_RING3, IN_RING0 or IN_RC!"
1620	#endif
1621	/* .u32VersionEnd = */ PDM_DEVREG_VERSION
1622	};
1623
1624
1625	#endif /* !VBOX_DEVICE_STRUCT_TESTCASE */
1626

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Devices/PC/DevIoApic.cpp@ 86927

Download in other formats: