1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
/* $Id: pdmpcidevint.h $ */
/** @file
* DevPCI - PDM PCI Internal header - Only for hiding bits of PDMPCIDEV.
*/
/*
* Copyright (C) 2006-2019 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*/
#ifndef VBOX_INCLUDED_vmm_pdmpcidevint_h
#define VBOX_INCLUDED_vmm_pdmpcidevint_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include <VBox/vmm/pdmdev.h>
/** @defgroup grp_pdm_pcidev_int The PDM PCI Device Internals
* @ingroup grp_pdm_pcidev
*
* @remarks The PDM PCI device internals are visible to both PDM and the PCI Bus
* implementation, thus it lives among the the public headers despite
* being rather private and internal.
*
* @{
*/
/**
* PCI I/O region.
*/
typedef struct PCIIOREGION
{
/** Current PCI mapping address, 0xffffffff means not mapped. */
uint64_t addr;
uint64_t size;
uint8_t type; /* PCIADDRESSSPACE */
uint8_t padding[HC_ARCH_BITS == 32 ? 3 : 7];
/** Callback called when the region is mapped. */
R3PTRTYPE(PFNPCIIOREGIONMAP) map_func;
} PCIIOREGION, PCIIORegion;
/** Pointer to PCI I/O region. */
typedef PCIIOREGION *PPCIIOREGION;
/**
* Callback function for reading from the PCI configuration space.
*
* @returns The register value.
* @param pDevIns Pointer to the device instance of the PCI bus.
* @param iBus The bus number this device is on.
* @param iDevice The number of the device on the bus.
* @param u32Address The configuration space register address. [0..255]
* @param cb The register size. [1,2,4]
*/
typedef DECLCALLBACK(uint32_t) FNPCIBRIDGECONFIGREAD(PPDMDEVINSR3 pDevIns, uint8_t iBus, uint8_t iDevice, uint32_t u32Address, unsigned cb);
/** Pointer to a FNPCICONFIGREAD() function. */
typedef FNPCIBRIDGECONFIGREAD *PFNPCIBRIDGECONFIGREAD;
/** Pointer to a PFNPCICONFIGREAD. */
typedef PFNPCIBRIDGECONFIGREAD *PPFNPCIBRIDGECONFIGREAD;
/**
* Callback function for writing to the PCI configuration space.
*
* @param pDevIns Pointer to the device instance of the PCI bus.
* @param iBus The bus number this device is on.
* @param iDevice The number of the device on the bus.
* @param u32Address The configuration space register address. [0..255]
* @param u32Value The value that's being written. The number of bits actually used from
* this value is determined by the cb parameter.
* @param cb The register size. [1,2,4]
*/
typedef DECLCALLBACK(void) FNPCIBRIDGECONFIGWRITE(PPDMDEVINSR3 pDevIns, uint8_t iBus, uint8_t iDevice, uint32_t u32Address, uint32_t u32Value, unsigned cb);
/** Pointer to a FNPCICONFIGWRITE() function. */
typedef FNPCIBRIDGECONFIGWRITE *PFNPCIBRIDGECONFIGWRITE;
/** Pointer to a PFNPCICONFIGWRITE. */
typedef PFNPCIBRIDGECONFIGWRITE *PPFNPCIBRIDGECONFIGWRITE;
/* Forward declaration */
struct DEVPCIBUS;
enum {
/** Flag whether the device is a pci-to-pci bridge.
* This is set prior to device registration. */
PCIDEV_FLAG_PCI_TO_PCI_BRIDGE = RT_BIT_32(1),
/** Flag whether the device is a PCI Express device.
* This is set prior to device registration. */
PCIDEV_FLAG_PCI_EXPRESS_DEVICE = RT_BIT_32(2),
/** Flag whether the device is capable of MSI.
* This one is set by MsiInit(). */
PCIDEV_FLAG_MSI_CAPABLE = RT_BIT_32(3),
/** Flag whether the device is capable of MSI-X.
* This one is set by MsixInit(). */
PCIDEV_FLAG_MSIX_CAPABLE = RT_BIT_32(4),
/** Flag if device represents real physical device in passthrough mode. */
PCIDEV_FLAG_PASSTHROUGH = RT_BIT_32(5),
/** Flag whether the device is capable of MSI using 64-bit address. */
PCIDEV_FLAG_MSI64_CAPABLE = RT_BIT_32(6)
};
/**
* PDM PCI Device - Internal data.
*
* @sa PDMPCIDEV
*/
typedef struct PDMPCIDEVINT
{
/** @name Owned by PDM.
* @remarks The bus may use the device instance pointers.
* @{
*/
/** Pointer to the PDM device the PCI device belongs to. (R3 ptr) */
PPDMDEVINSR3 pDevInsR3;
/** Pointer to the next PDM device associate with the PDM device. (R3 ptr) */
R3PTRTYPE(PPDMPCIDEV) pNextR3;
/** Pointer to the internal PDM PCI bus for the device. (R3 ptr) */
R3PTRTYPE(struct PDMPCIBUS *) pPdmBusR3;
/** Pointer to the PDM device the PCI device belongs to. (R0 ptr) */
PPDMDEVINSR0 pDevInsR0;
/** Pointer to the next PDM device associate with the PDM device. (R0 ptr) */
R0PTRTYPE(PPDMPCIDEV) pNextR0;
/** Pointer to the internal PDM PCI bus for the device. (R0 ptr) */
R0PTRTYPE(struct PDMPCIBUS *) pPdmBusR0;
/** Pointer to the PDM device the PCI device belongs to. (RC ptr) */
PPDMDEVINSRC pDevInsRC;
/** Pointer to the next PDM device associate with the PDM device. (RC ptr) */
RCPTRTYPE(PPDMPCIDEV) pNextRC;
/** Pointer to the internal PDM PCI bus for the device. (RC ptr) */
RCPTRTYPE(struct PDMPCIBUS *) pPdmBusRC;
/** The CFGM device configuration index (default, PciDev1..255).
* This also works as the internal sub-device ordinal with MMIOEx. */
uint8_t idxDevCfg;
/** Set if the it can be reassigned to a different PCI device number. */
bool fReassignableDevNo;
/** Set if the it can be reassigned to a different PCI function number. */
bool fReassignableFunNo;
/** Alignment padding. */
uint8_t bPadding0;
/** @} */
/** @name Owned by the PCI Bus
* @remarks PDM will not touch anything here (includes not relocating anything).
* @{
*/
/** Pointer to the PCI bus of the device. (R3 ptr) */
R3PTRTYPE(struct DEVPCIBUS *) pBusR3;
/** Page used for MSI-X state. (R3 ptr) */
R3PTRTYPE(void *) pMsixPageR3;
/** Read config callback. */
R3PTRTYPE(PFNPCICONFIGREAD) pfnConfigRead;
/** Write config callback. */
R3PTRTYPE(PFNPCICONFIGWRITE) pfnConfigWrite;
/** Read config callback for PCI bridges to pass requests
* to devices on another bus. */
R3PTRTYPE(PFNPCIBRIDGECONFIGREAD) pfnBridgeConfigRead;
/** Write config callback for PCI bridges to pass requests
* to devices on another bus. */
R3PTRTYPE(PFNPCIBRIDGECONFIGWRITE) pfnBridgeConfigWrite;
/** Pointer to the PCI bus of the device. (R0 ptr) */
R0PTRTYPE(struct DEVPCIBUS *) pBusR0;
/** Page used for MSI-X state. (R0 ptr) */
R0PTRTYPE(void *) pMsixPageR0;
/** Pointer to the PCI bus of the device. (RC ptr) */
RCPTRTYPE(struct DEVPCIBUS *) pBusRC;
/** Page used for MSI-X state. (RC ptr) */
RCPTRTYPE(void *) pMsixPageRC;
/** Flags of this PCI device, see PCIDEV_FLAG_XXX constants. */
uint32_t fFlags;
/** Current state of the IRQ pin of the device. */
int32_t uIrqPinState;
/** Offset of MSI PCI capability in config space, or 0.
* @todo fix non-standard naming. */
uint8_t u8MsiCapOffset;
/** Size of MSI PCI capability in config space, or 0.
* @todo fix non-standard naming. */
uint8_t u8MsiCapSize;
/** Offset of MSI-X PCI capability in config space, or 0.
* @todo fix non-standard naming. */
uint8_t u8MsixCapOffset;
/** Size of MSI-X PCI capability in config space, or 0.
* @todo fix non-standard naming. */
uint8_t u8MsixCapSize;
/** Size of the MSI-X region. */
uint16_t cbMsixRegion;
/** Offset to the PBA for MSI-X. */
uint16_t offMsixPba;
#if HC_ARCH_BITS == 32
/** Add padding to align aIORegions to an 8 byte boundary. */
uint8_t abPadding1[12];
#endif
/** Pointer to bus specific data. (R3 ptr) */
R3PTRTYPE(const void *) pPciBusPtrR3;
/** I/O regions. */
PCIIOREGION aIORegions[VBOX_PCI_NUM_REGIONS];
/** @} */
} PDMPCIDEVINT;
AssertCompileMemberAlignment(PDMPCIDEVINT, aIORegions, 8);
AssertCompileSize(PDMPCIDEVINT, HC_ARCH_BITS == 32 ? 280 : 384);
/** Indicate that PDMPCIDEV::Int.s can be declared. */
#define PDMPCIDEVINT_DECLARED
/** @} */
#endif /* !VBOX_INCLUDED_vmm_pdmpcidevint_h */
|
