VirtualBox

source: vbox/trunk/include/VBox/pci.h@ 60562

Last change on this file since 60562 was 58111, checked in by vboxsync, 9 years ago

include,misc: More Doxygen grouping adjustments.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 47.1 KB
Line 
1/** @file
2 * PCI - The PCI Controller And Devices. (DEV)
3 */
4
5/*
6 * Copyright (C) 2006-2015 Oracle Corporation
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 */
25
26#ifndef ___VBox_pci_h
27#define ___VBox_pci_h
28
29#include <VBox/cdefs.h>
30#include <VBox/types.h>
31#include <iprt/assert.h>
32
33/** @defgroup grp_pci PCI - The PCI Controller.
34 * @ingroup grp_devdrv
35 * @{
36 */
37
38/** Pointer to a PCI device. */
39typedef struct PCIDevice *PPCIDEVICE;
40
41
42/**
43 * PCI configuration word 4 (command) and word 6 (status).
44 */
45typedef enum PCICONFIGCOMMAND
46{
47 /** Supports/uses memory accesses. */
48 PCI_COMMAND_IOACCESS = 0x0001,
49 PCI_COMMAND_MEMACCESS = 0x0002,
50 PCI_COMMAND_BUSMASTER = 0x0004
51} PCICONFIGCOMMAND;
52
53
54/**
55 * PCI Address space specification.
56 * This is used when registering a I/O region.
57 */
58/**
59 * Defined by the PCI specification.
60 */
61typedef enum PCIADDRESSSPACE
62{
63 /** Memory. */
64 PCI_ADDRESS_SPACE_MEM = 0x00,
65 /** I/O space. */
66 PCI_ADDRESS_SPACE_IO = 0x01,
67 /** 32-bit BAR. */
68 PCI_ADDRESS_SPACE_BAR32 = 0x00,
69 /** 64-bit BAR. */
70 PCI_ADDRESS_SPACE_BAR64 = 0x04,
71 /** Prefetch memory. */
72 PCI_ADDRESS_SPACE_MEM_PREFETCH = 0x08
73} PCIADDRESSSPACE;
74
75
76/**
77 * Callback function for mapping an PCI I/O region.
78 *
79 * @return VBox status code.
80 * @param pPciDev Pointer to PCI device. Use pPciDev->pDevIns to get the device instance.
81 * @param iRegion The region number.
82 * @param GCPhysAddress Physical address of the region. If enmType is PCI_ADDRESS_SPACE_IO, this
83 * is an I/O port, otherwise it's a physical address.
84 *
85 * NIL_RTGCPHYS indicates that a MMIO2 mapping is about to be unmapped and
86 * that the device deregister access handlers for it and update its internal
87 * state to reflect this.
88 *
89 * @param enmType One of the PCI_ADDRESS_SPACE_* values.
90 *
91 * @remarks Called with the PDM lock held. The device lock is NOT take because
92 * that is very likely be a lock order violation.
93 */
94typedef DECLCALLBACK(int) FNPCIIOREGIONMAP(PPCIDEVICE pPciDev, /*unsigned*/ int iRegion, RTGCPHYS GCPhysAddress, uint32_t cb, PCIADDRESSSPACE enmType);
95/** Pointer to a FNPCIIOREGIONMAP() function. */
96typedef FNPCIIOREGIONMAP *PFNPCIIOREGIONMAP;
97
98
99/** @name PCI Configuration Space Registers
100 * @{ */
101/* Commented out values common for different header types */
102/* Common part of the header */
103#define VBOX_PCI_VENDOR_ID 0x00 /**< 16-bit RO */
104#define VBOX_PCI_DEVICE_ID 0x02 /**< 16-bit RO */
105#define VBOX_PCI_COMMAND 0x04 /**< 16-bit RW, some bits RO */
106#define VBOX_PCI_STATUS 0x06 /**< 16-bit RW, some bits RO */
107#define VBOX_PCI_REVISION_ID 0x08 /**< 8-bit RO - - device revision */
108#define VBOX_PCI_CLASS_PROG 0x09 /**< 8-bit RO - - register-level programming class code (device specific). */
109#define VBOX_PCI_CLASS_SUB 0x0a /**< 8-bit RO - - sub-class code. */
110#define VBOX_PCI_CLASS_DEVICE VBOX_PCI_CLASS_SUB
111#define VBOX_PCI_CLASS_BASE 0x0b /**< 8-bit RO - - base class code. */
112#define VBOX_PCI_CACHE_LINE_SIZE 0x0c /**< 8-bit RW - - system cache line size */
113#define VBOX_PCI_LATENCY_TIMER 0x0d /**< 8-bit RW - - master latency timer, hardwired to 0 for PCIe */
114#define VBOX_PCI_HEADER_TYPE 0x0e /**< 8-bit RO - - header type (0 - device, 1 - bridge, 2 - CardBus bridge) */
115#define VBOX_PCI_BIST 0x0f /**< 8-bit RW - - built-in self test control */
116#define VBOX_PCI_CAPABILITY_LIST 0x34 /**< 8-bit RO? - - linked list of new capabilities implemented by the device, 2 bottom bits reserved */
117#define VBOX_PCI_INTERRUPT_LINE 0x3c /**< 8-bit RW - - interrupt line. */
118#define VBOX_PCI_INTERRUPT_PIN 0x3d /**< 8-bit RO - - interrupt pin. */
119
120/* Type 0 header, device */
121#define VBOX_PCI_BASE_ADDRESS_0 0x10 /**< 32-bit RW */
122#define VBOX_PCI_BASE_ADDRESS_1 0x14 /**< 32-bit RW */
123#define VBOX_PCI_BASE_ADDRESS_2 0x18 /**< 32-bit RW */
124#define VBOX_PCI_BASE_ADDRESS_3 0x1c /**< 32-bit RW */
125#define VBOX_PCI_BASE_ADDRESS_4 0x20 /**< 32-bit RW */
126#define VBOX_PCI_BASE_ADDRESS_5 0x24 /**< 32-bit RW */
127#define VBOX_PCI_CARDBUS_CIS 0x28 /**< 32-bit ?? */
128#define VBOX_PCI_SUBSYSTEM_VENDOR_ID 0x2c /**< 16-bit RO */
129#define VBOX_PCI_SUBSYSTEM_ID 0x2e /**< 16-bit RO */
130#define VBOX_PCI_ROM_ADDRESS 0x30 /**< 32-bit ?? */
131/* #define VBOX_PCI_CAPABILITY_LIST 0x34 */ /**< 8-bit? ?? */
132#define VBOX_PCI_RESERVED_35 0x35 /**< 8-bit ?? - - reserved */
133#define VBOX_PCI_RESERVED_36 0x36 /**< 8-bit ?? - - reserved */
134#define VBOX_PCI_RESERVED_37 0x37 /**< 8-bit ?? - - reserved */
135#define VBOX_PCI_RESERVED_38 0x38 /**< 32-bit ?? - - reserved */
136/* #define VBOX_PCI_INTERRUPT_LINE 0x3c */ /**< 8-bit RW - - interrupt line. */
137/* #define VBOX_PCI_INTERRUPT_PIN 0x3d */ /**< 8-bit RO - - interrupt pin. */
138#define VBOX_PCI_MIN_GNT 0x3e /**< 8-bit RO - - burst period length (in 1/4 microsecond units) */
139#define VBOX_PCI_MAX_LAT 0x3f /**< 8-bit RO - - how often the device needs access to the PCI bus (in 1/4 microsecond units) */
140
141/* Type 1 header, PCI-to-PCI bridge */
142/* #define VBOX_PCI_BASE_ADDRESS_0 0x10 */ /**< 32-bit RW */
143/* #define VBOX_PCI_BASE_ADDRESS_1 0x14 */ /**< 32-bit RW */
144#define VBOX_PCI_PRIMARY_BUS 0x18 /**< 8-bit ?? - - primary bus number. */
145#define VBOX_PCI_SECONDARY_BUS 0x19 /**< 8-bit ?? - - secondary bus number. */
146#define VBOX_PCI_SUBORDINATE_BUS 0x1a /**< 8-bit ?? - - highest subordinate bus number. (behind the bridge) */
147#define VBOX_PCI_SEC_LATENCY_TIMER 0x1b /**< 8-bit ?? - - secondary latency timer. */
148#define VBOX_PCI_IO_BASE 0x1c /**< 8-bit ?? - - I/O range base. */
149#define VBOX_PCI_IO_LIMIT 0x1d /**< 8-bit ?? - - I/O range limit. */
150#define VBOX_PCI_SEC_STATUS 0x1e /**< 16-bit ?? - - secondary status register. */
151#define VBOX_PCI_MEMORY_BASE 0x20 /**< 16-bit ?? - - memory range base. */
152#define VBOX_PCI_MEMORY_LIMIT 0x22 /**< 16-bit ?? - - memory range limit. */
153#define VBOX_PCI_PREF_MEMORY_BASE 0x24 /**< 16-bit ?? - - prefetchable memory range base. */
154#define VBOX_PCI_PREF_MEMORY_LIMIT 0x26 /**< 16-bit ?? - - prefetchable memory range limit. */
155#define VBOX_PCI_PREF_BASE_UPPER32 0x28 /**< 32-bit ?? - - prefetchable memory range high base.*/
156#define VBOX_PCI_PREF_LIMIT_UPPER32 0x2c /**< 32-bit ?? - - prefetchable memory range high limit. */
157#define VBOX_PCI_IO_BASE_UPPER16 0x30 /**< 16-bit ?? - - memory range high base. */
158#define VBOX_PCI_IO_LIMIT_UPPER16 0x32 /**< 16-bit ?? - - memory range high limit. */
159/* #define VBOX_PCI_CAPABILITY_LIST 0x34 */ /**< 8-bit? ?? */
160/* #define VBOX_PCI_RESERVED_35 0x35 */ /**< 8-bit ?? - - reserved */
161/* #define VBOX_PCI_RESERVED_36 0x36 */ /**< 8-bit ?? - - reserved */
162/* #define VBOX_PCI_RESERVED_37 0x37 */ /**< 8-bit ?? - - reserved */
163#define VBOX_PCI_ROM_ADDRESS_BR 0x38 /**< 32-bit ?? - - expansion ROM base address */
164#define VBOX_PCI_BRIDGE_CONTROL 0x3e /**< 16-bit? ?? - - bridge control */
165
166/* Type 2 header, PCI-to-CardBus bridge */
167#define VBOX_PCI_CARDBUS_BASE_ADDRESS 0x10 /**< 32-bit RW - - CardBus Socket/ExCa base address */
168#define VBOX_PCI_CARDBUS_CAPLIST 0x14 /**< 8-bit RO? - - offset of capabilities list */
169#define VBOX_PCI_CARDBUS_RESERVED_15 0x15 /**< 8-bit ?? - - reserved */
170#define VBOX_PCI_CARDBUS_SEC_STATUS 0x16 /**< 16-bit ?? - - secondary status */
171#define VBOX_PCI_CARDBUS_PCIBUS_NUMBER 0x18 /**< 8-bit ?? - - PCI bus number */
172#define VBOX_PCI_CARDBUS_CARDBUS_NUMBER 0x19 /**< 8-bit ?? - - CardBus bus number */
173/* #define VBOX_PCI_SUBORDINATE_BUS 0x1a */ /**< 8-bit ?? - - highest subordinate bus number. (behind the bridge) */
174/* #define VBOX_PCI_SEC_LATENCY_TIMER 0x1b */ /**< 8-bit ?? - - secondary latency timer. */
175#define VBOX_PCI_CARDBUS_MEMORY_BASE0 0x1c /**< 32-bit RW - - memory base address 0 */
176#define VBOX_PCI_CARDBUS_MEMORY_LIMIT0 0x20 /**< 32-bit RW - - memory limit 0 */
177#define VBOX_PCI_CARDBUS_MEMORY_BASE1 0x24 /**< 32-bit RW - - memory base address 1 */
178#define VBOX_PCI_CARDBUS_MEMORY_LIMIT1 0x28 /**< 32-bit RW - - memory limit 1 */
179#define VBOX_PCI_CARDBUS_IO_BASE0 0x2c /**< 32-bit RW - - IO base address 0 */
180#define VBOX_PCI_CARDBUS_IO_LIMIT0 0x30 /**< 32-bit RW - - IO limit 0 */
181#define VBOX_PCI_CARDBUS_IO_BASE1 0x34 /**< 32-bit RW - - IO base address 1 */
182#define VBOX_PCI_CARDBUS_IO_LIMIT1 0x38 /**< 32-bit RW - - IO limit 1 */
183/* #define VBOX_PCI_INTERRUPT_LINE 0x3c */ /**< 8-bit RW - - interrupt line. */
184/* #define VBOX_PCI_INTERRUPT_PIN 0x3d */ /**< 8-bit RO - - interrupt pin. */
185/* #define VBOX_PCI_BRIDGE_CONTROL 0x3e */ /**< 16-bit? ?? - - bridge control */
186/** @} */
187
188
189/* Possible values in status bitmask */
190#define VBOX_PCI_STATUS_CAP_LIST 0x10 /* Support Capability List */
191#define VBOX_PCI_STATUS_66MHZ 0x20 /* Support 66 Mhz PCI 2.1 bus */
192#define VBOX_PCI_STATUS_UDF 0x40 /* Support User Definable Features [obsolete] */
193#define VBOX_PCI_STATUS_FAST_BACK 0x80 /* Accept fast-back to back */
194#define VBOX_PCI_STATUS_PARITY 0x100 /* Detected parity error */
195#define VBOX_PCI_STATUS_DEVSEL_MASK 0x600 /* DEVSEL timing */
196#define VBOX_PCI_STATUS_DEVSEL_FAST 0x000
197#define VBOX_PCI_STATUS_DEVSEL_MEDIUM 0x200
198#define VBOX_PCI_STATUS_DEVSEL_SLOW 0x400
199#define VBOX_PCI_STATUS_SIG_TARGET_ABORT 0x800 /* Set on target abort */
200#define VBOX_PCI_STATUS_REC_TARGET_ABORT 0x1000 /* Master ack of " */
201#define VBOX_PCI_STATUS_REC_MASTER_ABORT 0x2000 /* Set on master abort */
202#define VBOX_PCI_STATUS_SIG_SYSTEM_ERROR 0x4000 /* Set when we drive SERR */
203#define VBOX_PCI_STATUS_DETECTED_PARITY 0x8000 /* Set on parity error */
204
205
206/* Command bitmask */
207#define VBOX_PCI_COMMAND_IO 0x1 /* Enable response in I/O space */
208#define VBOX_PCI_COMMAND_MEMORY 0x2 /* Enable response in Memory space */
209#define VBOX_PCI_COMMAND_MASTER 0x4 /* Enable bus mastering */
210#define VBOX_PCI_COMMAND_SPECIAL 0x8 /* Enable response to special cycles */
211#define VBOX_PCI_COMMAND_INVALIDATE 0x10 /* Use memory write and invalidate */
212#define VBOX_PCI_COMMAND_VGA_PALETTE 0x20 /* Enable palette snooping */
213#define VBOX_PCI_COMMAND_PARITY 0x40 /* Enable parity checking */
214#define VBOX_PCI_COMMAND_WAIT 0x80 /* Enable address/data stepping */
215#define VBOX_PCI_COMMAND_SERR 0x100 /* Enable SERR */
216#define VBOX_PCI_COMMAND_FAST_BACK 0x200 /* Enable back-to-back writes */
217#define VBOX_PCI_COMMAND_INTX_DISABLE 0x400 /* INTx Emulation Disable */
218
219
220/* Capability list values (capability offset 0) */
221/* Next value pointer in offset 1, or 0 if none */
222#define VBOX_PCI_CAP_ID_PM 0x01 /* Power Management */
223#define VBOX_PCI_CAP_ID_AGP 0x02 /* Accelerated Graphics Port */
224#define VBOX_PCI_CAP_ID_VPD 0x03 /* Vital Product Data */
225#define VBOX_PCI_CAP_ID_SLOTID 0x04 /* Slot Identification */
226#define VBOX_PCI_CAP_ID_MSI 0x05 /* Message Signalled Interrupts */
227#define VBOX_PCI_CAP_ID_CHSWP 0x06 /* CompactPCI HotSwap */
228#define VBOX_PCI_CAP_ID_PCIX 0x07 /* PCI-X */
229#define VBOX_PCI_CAP_ID_HT 0x08 /* HyperTransport */
230#define VBOX_PCI_CAP_ID_VNDR 0x09 /* Vendor specific */
231#define VBOX_PCI_CAP_ID_DBG 0x0A /* Debug port */
232#define VBOX_PCI_CAP_ID_CCRC 0x0B /* CompactPCI Central Resource Control */
233#define VBOX_PCI_CAP_ID_SHPC 0x0C /* PCI Standard Hot-Plug Controller */
234#define VBOX_PCI_CAP_ID_SSVID 0x0D /* Bridge subsystem vendor/device ID */
235#define VBOX_PCI_CAP_ID_AGP3 0x0E /* AGP Target PCI-PCI bridge */
236#define VBOX_PCI_CAP_ID_SECURE 0x0F /* Secure device (?) */
237#define VBOX_PCI_CAP_ID_EXP 0x10 /* PCI Express */
238#define VBOX_PCI_CAP_ID_MSIX 0x11 /* MSI-X */
239#define VBOX_PCI_CAP_ID_SATA 0x12 /* Serial-ATA HBA */
240#define VBOX_PCI_CAP_ID_AF 0x13 /* PCI Advanced Features */
241
242/* Extended Capabilities (PCI-X 2.0 and Express), start at 0x100, next - bits [20..32] */
243#define VBOX_PCI_EXT_CAP_ID_ERR 0x01 /* Advanced Error Reporting */
244#define VBOX_PCI_EXT_CAP_ID_VC 0x02 /* Virtual Channel */
245#define VBOX_PCI_EXT_CAP_ID_DSN 0x03 /* Device Serial Number */
246#define VBOX_PCI_EXT_CAP_ID_PWR 0x04 /* Power Budgeting */
247#define VBOX_PCI_EXT_CAP_ID_RCLINK 0x05 /* Root Complex Link Declaration */
248#define VBOX_PCI_EXT_CAP_ID_RCILINK 0x06 /* Root Complex Internal Link Declaration */
249#define VBOX_PCI_EXT_CAP_ID_RCECOLL 0x07 /* Root Complex Event Collector */
250#define VBOX_PCI_EXT_CAP_ID_MFVC 0x08 /* Multi-Function Virtual Channel */
251#define VBOX_PCI_EXT_CAP_ID_RBCB 0x0a /* Root Bridge Control Block */
252#define VBOX_PCI_EXT_CAP_ID_VNDR 0x0b /* Vendor specific */
253#define VBOX_PCI_EXT_CAP_ID_ACS 0x0d /* Access Controls */
254#define VBOX_PCI_EXT_CAP_ID_ARI 0x0e
255#define VBOX_PCI_EXT_CAP_ID_ATS 0x0f
256#define VBOX_PCI_EXT_CAP_ID_SRIOV 0x10
257
258
259/* MSI flags, aka Message Control (2 bytes, capability offset 2) */
260#define VBOX_PCI_MSI_FLAGS_ENABLE 0x0001 /* MSI feature enabled */
261#define VBOX_PCI_MSI_FLAGS_64BIT 0x0080 /* 64-bit addresses allowed */
262#define VBOX_PCI_MSI_FLAGS_MASKBIT 0x0100 /* Per-vector masking support */
263/* Encoding for 3-bit patterns for message queue (per chapter 6.8.1 of PCI spec),
264 someone very similar to log_2().
265 000 1
266 001 2
267 010 4
268 011 8
269 100 16
270 101 32
271 110 Reserved
272 111 Reserved */
273#define VBOX_PCI_MSI_FLAGS_QSIZE 0x0070 /* Message queue size configured (i.e. vectors per device allocated) */
274#define VBOX_PCI_MSI_FLAGS_QMASK 0x000e /* Maximum queue size available (i.e. vectors per device possible) */
275
276/* MSI-X flags (2 bytes, capability offset 2) */
277#define VBOX_PCI_MSIX_FLAGS_ENABLE 0x8000 /* MSI-X enable */
278#define VBOX_PCI_MSIX_FLAGS_FUNCMASK 0x4000 /* Function mask */
279
280/* Power management flags (2 bytes, capability offset 2) */
281#define VBOX_PCI_PM_CAP_VER_MASK 0x0007 /* Version mask */
282#define VBOX_PCI_PM_CAP_PME_CLOCK 0x0008 /* PME clock required */
283#define VBOX_PCI_PM_CAP_RESERVED 0x0010 /* Reserved field */
284#define VBOX_PCI_PM_CAP_DSI 0x0020 /* Device specific initialization */
285#define VBOX_PCI_PM_CAP_AUX_POWER 0x01C0 /* Auxilliary power support mask */
286#define VBOX_PCI_PM_CAP_D1 0x0200 /* D1 power state support */
287#define VBOX_PCI_PM_CAP_D2 0x0400 /* D2 power state support */
288#define VBOX_PCI_PM_CAP_PME 0x0800 /* PME pin supported */
289#define VBOX_PCI_PM_CAP_PME_MASK 0xF800 /* PME Mask of all supported states */
290#define VBOX_PCI_PM_CAP_PME_D0 0x0800 /* PME# from D0 */
291#define VBOX_PCI_PM_CAP_PME_D1 0x1000 /* PME# from D1 */
292#define VBOX_PCI_PM_CAP_PME_D2 0x2000 /* PME# from D2 */
293#define VBOX_PCI_PM_CAP_PME_D3 0x4000 /* PME# from D3 (hot) */
294#define VBOX_PCI_PM_CAP_PME_D3cold 0x8000 /* PME# from D3 (cold) */
295
296/* Power management control flags (2 bytes, capability offset 4) */
297#define VBOX_PCI_PM_CTRL_STATE_MASK 0x0003 /* Current power state (D0 to D3) */
298#define VBOX_PCI_PM_CTRL_NO_SOFT_RESET 0x0008 /* No reset for D3hot->D0 */
299#define VBOX_PCI_PM_CTRL_PME_ENABLE 0x0100 /* PME pin enable */
300#define VBOX_PCI_PM_CTRL_DATA_SEL_MASK 0x1e00 /* Data select (??) */
301#define VBOX_PCI_PM_CTRL_DATA_SCALE_MASK 0x6000 /* Data scale (??) */
302#define VBOX_PCI_PM_CTRL_PME_STATUS 0x8000 /* PME pin status */
303
304/* PCI-X config flags (2 bytes, capability offset 2) */
305#define VBOX_PCI_X_CMD_DPERR_E 0x0001 /* Data Parity Error Recovery Enable */
306#define VBOX_PCI_X_CMD_ERO 0x0002 /* Enable Relaxed Ordering */
307#define VBOX_PCI_X_CMD_MAX_OUTSTANDING_SPLIT_TRANS 0x0070
308#define VBOX_PCI_X_CMD_READ_512 0x0000 /* 512 byte maximum read byte count */
309#define VBOX_PCI_X_CMD_READ_1K 0x0004 /* 1Kbyte maximum read byte count */
310#define VBOX_PCI_X_CMD_READ_2K 0x0008 /* 2Kbyte maximum read byte count */
311#define VBOX_PCI_X_CMD_READ_4K 0x000c /* 4Kbyte maximum read byte count */
312#define VBOX_PCI_X_CMD_MAX_READ 0x000c /* Max Memory Read Byte Count */
313
314/* PCI-X config flags (4 bytes, capability offset 4) */
315#define VBOX_PCI_X_STATUS_DEVFN 0x000000ff /* A copy of devfn */
316#define VBOX_PCI_X_STATUS_BUS 0x0000ff00 /* A copy of bus nr */
317#define VBOX_PCI_X_STATUS_64BIT 0x00010000 /* 64-bit device */
318#define VBOX_PCI_X_STATUS_133MHZ 0x00020000 /* 133 MHz capable */
319#define VBOX_PCI_X_STATUS_SPL_DISC 0x00040000 /* Split Completion Discarded */
320#define VBOX_PCI_X_STATUS_UNX_SPL 0x00080000 /* Unexpected Split Completion */
321#define VBOX_PCI_X_STATUS_COMPLEX 0x00100000 /* Device Complexity, 0 = simple device, 1 = bridge device */
322#define VBOX_PCI_X_STATUS_MAX_READ 0x00600000 /* Designed Max Memory Read Count, 0 = 512 bytes, 1 = 1024, 2 = 2048, 3 = 4096 */
323#define VBOX_PCI_X_STATUS_MAX_SPLIT 0x03800000 /* Designed Max Outstanding Split Transactions */
324#define VBOX_PCI_X_STATUS_MAX_CUM 0x1c000000 /* Designed Max Cumulative Read Size */
325#define VBOX_PCI_X_STATUS_SPL_ERR 0x20000000 /* Rcvd Split Completion Error Msg */
326#define VBOX_PCI_X_STATUS_266MHZ 0x40000000 /* 266 MHz capable */
327#define VBOX_PCI_X_STATUS_533MHZ 0x80000000 /* 533 MHz capable */
328
329/* PCI Express config flags (2 bytes, capability offset 2) */
330#define VBOX_PCI_EXP_FLAGS_VERS 0x000f /* Capability version */
331#define VBOX_PCI_EXP_FLAGS_TYPE 0x00f0 /* Device/Port type */
332#define VBOX_PCI_EXP_TYPE_ENDPOINT 0x0 /* Express Endpoint */
333#define VBOX_PCI_EXP_TYPE_LEG_END 0x1 /* Legacy Endpoint */
334#define VBOX_PCI_EXP_TYPE_ROOT_PORT 0x4 /* Root Port */
335#define VBOX_PCI_EXP_TYPE_UPSTREAM 0x5 /* Upstream Port */
336#define VBOX_PCI_EXP_TYPE_DOWNSTREAM 0x6 /* Downstream Port */
337#define VBOX_PCI_EXP_TYPE_PCI_BRIDGE 0x7 /* PCI/PCI-X Bridge */
338#define VBOX_PCI_EXP_TYPE_PCIE_BRIDGE 0x8 /* PCI/PCI-X to PCIE Bridge */
339#define VBOX_PCI_EXP_TYPE_ROOT_INT_EP 0x9 /* Root Complex Integrated Endpoint */
340#define VBOX_PCI_EXP_TYPE_ROOT_EC 0xa /* Root Complex Event Collector */
341#define VBOX_PCI_EXP_FLAGS_SLOT 0x0100 /* Slot implemented */
342#define VBOX_PCI_EXP_FLAGS_IRQ 0x3e00 /* Interrupt message number */
343
344/* PCI Express device capabilities (4 bytes, capability offset 4) */
345#define VBOX_PCI_EXP_DEVCAP_PAYLOAD 0x07 /* Max_Payload_Size */
346#define VBOX_PCI_EXP_DEVCAP_PHANTOM 0x18 /* Phantom functions */
347#define VBOX_PCI_EXP_DEVCAP_EXT_TAG 0x20 /* Extended tags */
348#define VBOX_PCI_EXP_DEVCAP_L0S 0x1c0 /* L0s Acceptable Latency */
349#define VBOX_PCI_EXP_DEVCAP_L1 0xe00 /* L1 Acceptable Latency */
350#define VBOX_PCI_EXP_DEVCAP_ATN_BUT 0x1000 /* Attention Button Present */
351#define VBOX_PCI_EXP_DEVCAP_ATN_IND 0x2000 /* Attention Indicator Present */
352#define VBOX_PCI_EXP_DEVCAP_PWR_IND 0x4000 /* Power Indicator Present */
353#define VBOX_PCI_EXP_DEVCAP_RBE 0x8000 /* Role-Based Error Reporting */
354#define VBOX_PCI_EXP_DEVCAP_PWR_VAL 0x3fc0000 /* Slot Power Limit Value */
355#define VBOX_PCI_EXP_DEVCAP_PWR_SCL 0xc000000 /* Slot Power Limit Scale */
356#define VBOX_PCI_EXP_DEVCAP_FLRESET 0x10000000 /* Function-Level Reset */
357
358/* PCI Express device control (2 bytes, capability offset 8) */
359#define VBOX_PCI_EXP_DEVCTL_CERE 0x0001 /* Correctable Error Reporting En. */
360#define VBOX_PCI_EXP_DEVCTL_NFERE 0x0002 /* Non-Fatal Error Reporting Enable */
361#define VBOX_PCI_EXP_DEVCTL_FERE 0x0004 /* Fatal Error Reporting Enable */
362#define VBOX_PCI_EXP_DEVCTL_URRE 0x0008 /* Unsupported Request Reporting En. */
363#define VBOX_PCI_EXP_DEVCTL_RELAXED 0x0010 /* Enable Relaxed Ordering */
364#define VBOX_PCI_EXP_DEVCTL_PAYLOAD 0x00e0 /* Max_Payload_Size */
365#define VBOX_PCI_EXP_DEVCTL_EXT_TAG 0x0100 /* Extended Tag Field Enable */
366#define VBOX_PCI_EXP_DEVCTL_PHANTOM 0x0200 /* Phantom Functions Enable */
367#define VBOX_PCI_EXP_DEVCTL_AUX_PME 0x0400 /* Auxiliary Power PM Enable */
368#define VBOX_PCI_EXP_DEVCTL_NOSNOOP 0x0800 /* Enable No Snoop */
369#define VBOX_PCI_EXP_DEVCTL_READRQ 0x7000 /* Max_Read_Request_Size */
370#define VBOX_PCI_EXP_DEVCTL_BCRE 0x8000 /* Bridge Configuration Retry Enable */
371#define VBOX_PCI_EXP_DEVCTL_FLRESET 0x8000 /* Function-Level Reset [bit shared with BCRE] */
372
373/* PCI Express device status (2 bytes, capability offset 10) */
374#define VBOX_PCI_EXP_DEVSTA_CED 0x01 /* Correctable Error Detected */
375#define VBOX_PCI_EXP_DEVSTA_NFED 0x02 /* Non-Fatal Error Detected */
376#define VBOX_PCI_EXP_DEVSTA_FED 0x04 /* Fatal Error Detected */
377#define VBOX_PCI_EXP_DEVSTA_URD 0x08 /* Unsupported Request Detected */
378#define VBOX_PCI_EXP_DEVSTA_AUXPD 0x10 /* AUX Power Detected */
379#define VBOX_PCI_EXP_DEVSTA_TRPND 0x20 /* Transactions Pending */
380
381/* PCI Express link capabilities (4 bytes, capability offset 12) */
382#define VBOX_PCI_EXP_LNKCAP_SPEED 0x0000f /* Maximum Link Speed */
383#define VBOX_PCI_EXP_LNKCAP_WIDTH 0x003f0 /* Maximum Link Width */
384#define VBOX_PCI_EXP_LNKCAP_ASPM 0x00c00 /* Active State Power Management */
385#define VBOX_PCI_EXP_LNKCAP_L0S 0x07000 /* L0s Acceptable Latency */
386#define VBOX_PCI_EXP_LNKCAP_L1 0x38000 /* L1 Acceptable Latency */
387#define VBOX_PCI_EXP_LNKCAP_CLOCKPM 0x40000 /* Clock Power Management */
388#define VBOX_PCI_EXP_LNKCAP_SURPRISE 0x80000 /* Surprise Down Error Reporting */
389#define VBOX_PCI_EXP_LNKCAP_DLLA 0x100000 /* Data Link Layer Active Reporting */
390#define VBOX_PCI_EXP_LNKCAP_LBNC 0x200000 /* Link Bandwidth Notification Capability */
391#define VBOX_PCI_EXP_LNKCAP_PORT 0xff000000 /* Port Number */
392
393/* PCI Express link control (2 bytes, capability offset 16) */
394#define VBOX_PCI_EXP_LNKCTL_ASPM 0x0003 /* ASPM Control */
395#define VBOX_PCI_EXP_LNKCTL_RCB 0x0008 /* Read Completion Boundary */
396#define VBOX_PCI_EXP_LNKCTL_DISABLE 0x0010 /* Link Disable */
397#define VBOX_PCI_EXP_LNKCTL_RETRAIN 0x0020 /* Retrain Link */
398#define VBOX_PCI_EXP_LNKCTL_CLOCK 0x0040 /* Common Clock Configuration */
399#define VBOX_PCI_EXP_LNKCTL_XSYNCH 0x0080 /* Extended Synch */
400#define VBOX_PCI_EXP_LNKCTL_CLOCKPM 0x0100 /* Clock Power Management */
401#define VBOX_PCI_EXP_LNKCTL_HWAUTWD 0x0200 /* Hardware Autonomous Width Disable */
402#define VBOX_PCI_EXP_LNKCTL_BWMIE 0x0400 /* Bandwidth Mgmt Interrupt Enable */
403#define VBOX_PCI_EXP_LNKCTL_AUTBWIE 0x0800 /* Autonomous Bandwidth Mgmt Interrupt Enable */
404
405/* PCI Express link status (2 bytes, capability offset 18) */
406#define VBOX_PCI_EXP_LNKSTA_SPEED 0x000f /* Negotiated Link Speed */
407#define VBOX_PCI_EXP_LNKSTA_WIDTH 0x03f0 /* Negotiated Link Width */
408#define VBOX_PCI_EXP_LNKSTA_TR_ERR 0x0400 /* Training Error (obsolete) */
409#define VBOX_PCI_EXP_LNKSTA_TRAIN 0x0800 /* Link Training */
410#define VBOX_PCI_EXP_LNKSTA_SL_CLK 0x1000 /* Slot Clock Configuration */
411#define VBOX_PCI_EXP_LNKSTA_DL_ACT 0x2000 /* Data Link Layer in DL_Active State */
412#define VBOX_PCI_EXP_LNKSTA_BWMGMT 0x4000 /* Bandwidth Mgmt Status */
413#define VBOX_PCI_EXP_LNKSTA_AUTBW 0x8000 /* Autonomous Bandwidth Mgmt Status */
414
415/* PCI Express slot capabilities (4 bytes, capability offset 20) */
416#define VBOX_PCI_EXP_SLTCAP_ATNB 0x0001 /* Attention Button Present */
417#define VBOX_PCI_EXP_SLTCAP_PWRC 0x0002 /* Power Controller Present */
418#define VBOX_PCI_EXP_SLTCAP_MRL 0x0004 /* MRL Sensor Present */
419#define VBOX_PCI_EXP_SLTCAP_ATNI 0x0008 /* Attention Indicator Present */
420#define VBOX_PCI_EXP_SLTCAP_PWRI 0x0010 /* Power Indicator Present */
421#define VBOX_PCI_EXP_SLTCAP_HPS 0x0020 /* Hot-Plug Surprise */
422#define VBOX_PCI_EXP_SLTCAP_HPC 0x0040 /* Hot-Plug Capable */
423#define VBOX_PCI_EXP_SLTCAP_PWR_VAL 0x00007f80 /* Slot Power Limit Value */
424#define VBOX_PCI_EXP_SLTCAP_PWR_SCL 0x00018000 /* Slot Power Limit Scale */
425#define VBOX_PCI_EXP_SLTCAP_INTERLOCK 0x020000 /* Electromechanical Interlock Present */
426#define VBOX_PCI_EXP_SLTCAP_NOCMDCOMP 0x040000 /* No Command Completed Support */
427#define VBOX_PCI_EXP_SLTCAP_PSN 0xfff80000 /* Physical Slot Number */
428
429/* PCI Express slot control (2 bytes, capability offset 24) */
430#define VBOX_PCI_EXP_SLTCTL_ATNB 0x0001 /* Attention Button Pressed Enable */
431#define VBOX_PCI_EXP_SLTCTL_PWRF 0x0002 /* Power Fault Detected Enable */
432#define VBOX_PCI_EXP_SLTCTL_MRLS 0x0004 /* MRL Sensor Changed Enable */
433#define VBOX_PCI_EXP_SLTCTL_PRSD 0x0008 /* Presence Detect Changed Enable */
434#define VBOX_PCI_EXP_SLTCTL_CMDC 0x0010 /* Command Completed Interrupt Enable */
435#define VBOX_PCI_EXP_SLTCTL_HPIE 0x0020 /* Hot-Plug Interrupt Enable */
436#define VBOX_PCI_EXP_SLTCTL_ATNI 0x00c0 /* Attention Indicator Control */
437#define VBOX_PCI_EXP_SLTCTL_PWRI 0x0300 /* Power Indicator Control */
438#define VBOX_PCI_EXP_SLTCTL_PWRC 0x0400 /* Power Controller Control */
439#define VBOX_PCI_EXP_SLTCTL_INTERLOCK 0x0800 /* Electromechanical Interlock Control */
440#define VBOX_PCI_EXP_SLTCTL_LLCHG 0x1000 /* Data Link Layer State Changed Enable */
441
442/* PCI Express slot status (2 bytes, capability offset 26) */
443#define VBOX_PCI_EXP_SLTSTA_ATNB 0x0001 /* Attention Button Pressed */
444#define VBOX_PCI_EXP_SLTSTA_PWRF 0x0002 /* Power Fault Detected */
445#define VBOX_PCI_EXP_SLTSTA_MRLS 0x0004 /* MRL Sensor Changed */
446#define VBOX_PCI_EXP_SLTSTA_PRSD 0x0008 /* Presence Detect Changed */
447#define VBOX_PCI_EXP_SLTSTA_CMDC 0x0010 /* Command Completed */
448#define VBOX_PCI_EXP_SLTSTA_MRL_ST 0x0020 /* MRL Sensor State */
449#define VBOX_PCI_EXP_SLTSTA_PRES 0x0040 /* Presence Detect State */
450#define VBOX_PCI_EXP_SLTSTA_INTERLOCK 0x0080 /* Electromechanical Interlock Status */
451#define VBOX_PCI_EXP_SLTSTA_LLCHG 0x0100 /* Data Link Layer State Changed */
452
453/* PCI Express root control (2 bytes, capability offset 28) */
454#define VBOX_PCI_EXP_RTCTL_SECEE 0x0001 /* System Error on Correctable Error */
455#define VBOX_PCI_EXP_RTCTL_SENFEE 0x0002 /* System Error on Non-Fatal Error */
456#define VBOX_PCI_EXP_RTCTL_SEFEE 0x0004 /* System Error on Fatal Error */
457#define VBOX_PCI_EXP_RTCTL_PMEIE 0x0008 /* PME Interrupt Enable */
458#define VBOX_PCI_EXP_RTCTL_CRSVIS 0x0010 /* Configuration Request Retry Status Visible to SW */
459
460/* PCI Express root capabilities (2 bytes, capability offset 30) */
461#define VBOX_PCI_EXP_RTCAP_CRSVIS 0x0010 /* Configuration Request Retry Status Visible to SW */
462
463/* PCI Express root status (4 bytes, capability offset 32) */
464#define VBOX_PCI_EXP_RTSTA_PME_REQID 0x0000ffff /* PME Requester ID */
465#define VBOX_PCI_EXP_RTSTA_PME_STATUS 0x00010000 /* PME Status */
466#define VBOX_PCI_EXP_RTSTA_PME_PENDING 0x00020000 /* PME is Pending */
467
468
469/**
470 * Callback function for reading from the PCI configuration space.
471 *
472 * @returns The register value.
473 * @param pPciDev Pointer to PCI device. Use pPciDev->pDevIns to get the device instance.
474 * @param Address The configuration space register address. [0..4096]
475 * @param cb The register size. [1,2,4]
476 *
477 * @remarks Called with the PDM lock held. The device lock is NOT take because
478 * that is very likely be a lock order violation.
479 */
480typedef DECLCALLBACK(uint32_t) FNPCICONFIGREAD(PPCIDEVICE pPciDev, uint32_t Address, unsigned cb);
481/** Pointer to a FNPCICONFIGREAD() function. */
482typedef FNPCICONFIGREAD *PFNPCICONFIGREAD;
483/** Pointer to a PFNPCICONFIGREAD. */
484typedef PFNPCICONFIGREAD *PPFNPCICONFIGREAD;
485
486/**
487 * Callback function for writing to the PCI configuration space.
488 *
489 * @param pPciDev Pointer to PCI device. Use pPciDev->pDevIns to get the device instance.
490 * @param Address The configuration space register address. [0..4096]
491 * @param u32Value The value that's being written. The number of bits actually used from
492 * this value is determined by the cb parameter.
493 * @param cb The register size. [1,2,4]
494 *
495 * @remarks Called with the PDM lock held. The device lock is NOT take because
496 * that is very likely be a lock order violation.
497 */
498typedef DECLCALLBACK(void) FNPCICONFIGWRITE(PPCIDEVICE pPciDev, uint32_t Address, uint32_t u32Value, unsigned cb);
499/** Pointer to a FNPCICONFIGWRITE() function. */
500typedef FNPCICONFIGWRITE *PFNPCICONFIGWRITE;
501/** Pointer to a PFNPCICONFIGWRITE. */
502typedef PFNPCICONFIGWRITE *PPFNPCICONFIGWRITE;
503
504/** Fixed I/O region number for ROM. */
505#define PCI_ROM_SLOT 6
506#define VBOX_PCI_ROM_SLOT 6
507/** Max number of I/O regions. */
508#define PCI_NUM_REGIONS 7
509#define VBOX_PCI_NUM_REGIONS 7
510
511/*
512 * Hack to include the PCIDEVICEINT structure at the right place
513 * to avoid duplications of FNPCIIOREGIONMAP and PCI_NUM_REGIONS.
514 */
515#ifdef PCI_INCLUDE_PRIVATE
516# include "PCIInternal.h"
517#endif
518
519/**
520 * PCI Device structure.
521 */
522typedef struct PCIDevice
523{
524 /** PCI config space. */
525 uint8_t config[256];
526
527 /** Internal data. */
528 union
529 {
530#ifdef PCIDEVICEINT_DECLARED
531 PCIDEVICEINT s;
532#endif
533 char padding[328];
534 } Int;
535
536 /** Read only data.
537 * @{
538 */
539 /** PCI device number on the pci bus. */
540 int32_t devfn;
541 uint32_t Alignment0; /**< Alignment. */
542 /** Device name. */
543 R3PTRTYPE(const char *) name;
544 /** Pointer to the device instance which registered the device. */
545 PPDMDEVINSR3 pDevIns;
546 /** @} */
547} PCIDEVICE;
548
549/** @todo handle extended space access. */
550
551DECLINLINE(void) PCIDevSetByte(PPCIDEVICE pPciDev, uint32_t offReg, uint8_t u8Value)
552{
553 pPciDev->config[offReg] = u8Value;
554}
555
556DECLINLINE(uint8_t) PCIDevGetByte(PPCIDEVICE pPciDev, uint32_t offReg)
557{
558 return pPciDev->config[offReg];
559}
560
561DECLINLINE(void) PCIDevSetWord(PPCIDEVICE pPciDev, uint32_t offReg, uint16_t u16Value)
562{
563 *(uint16_t*)&pPciDev->config[offReg] = RT_H2LE_U16(u16Value);
564}
565
566DECLINLINE(uint16_t) PCIDevGetWord(PPCIDEVICE pPciDev, uint32_t offReg)
567{
568 uint16_t u16Value = *(uint16_t*)&pPciDev->config[offReg];
569 return RT_H2LE_U16(u16Value);
570}
571
572DECLINLINE(void) PCIDevSetDWord(PPCIDEVICE pPciDev, uint32_t offReg, uint32_t u32Value)
573{
574 *(uint32_t*)&pPciDev->config[offReg] = RT_H2LE_U32(u32Value);
575}
576
577DECLINLINE(uint32_t) PCIDevGetDWord(PPCIDEVICE pPciDev, uint32_t offReg)
578{
579 uint32_t u32Value = *(uint32_t*)&pPciDev->config[offReg];
580 return RT_H2LE_U32(u32Value);
581}
582
583DECLINLINE(void) PCIDevSetQWord(PPCIDEVICE pPciDev, uint32_t offReg, uint64_t u64Value)
584{
585 *(uint64_t*)&pPciDev->config[offReg] = RT_H2LE_U64(u64Value);
586}
587
588DECLINLINE(uint64_t) PCIDevGetQWord(PPCIDEVICE pPciDev, uint32_t offReg)
589{
590 uint64_t u64Value = *(uint64_t*)&pPciDev->config[offReg];
591 return RT_H2LE_U64(u64Value);
592}
593
594/**
595 * Sets the vendor id config register.
596 * @param pPciDev The PCI device.
597 * @param u16VendorId The vendor id.
598 */
599DECLINLINE(void) PCIDevSetVendorId(PPCIDEVICE pPciDev, uint16_t u16VendorId)
600{
601 PCIDevSetWord(pPciDev, VBOX_PCI_VENDOR_ID, u16VendorId);
602}
603
604/**
605 * Gets the vendor id config register.
606 * @returns the vendor id.
607 * @param pPciDev The PCI device.
608 */
609DECLINLINE(uint16_t) PCIDevGetVendorId(PPCIDEVICE pPciDev)
610{
611 return PCIDevGetWord(pPciDev, VBOX_PCI_VENDOR_ID);
612}
613
614
615/**
616 * Sets the device id config register.
617 * @param pPciDev The PCI device.
618 * @param u16DeviceId The device id.
619 */
620DECLINLINE(void) PCIDevSetDeviceId(PPCIDEVICE pPciDev, uint16_t u16DeviceId)
621{
622 PCIDevSetWord(pPciDev, VBOX_PCI_DEVICE_ID, u16DeviceId);
623}
624
625/**
626 * Gets the device id config register.
627 * @returns the device id.
628 * @param pPciDev The PCI device.
629 */
630DECLINLINE(uint16_t) PCIDevGetDeviceId(PPCIDEVICE pPciDev)
631{
632 return PCIDevGetWord(pPciDev, VBOX_PCI_DEVICE_ID);
633}
634
635/**
636 * Sets the command config register.
637 *
638 * @param pPciDev The PCI device.
639 * @param u16Command The command register value.
640 */
641DECLINLINE(void) PCIDevSetCommand(PPCIDEVICE pPciDev, uint16_t u16Command)
642{
643 PCIDevSetWord(pPciDev, VBOX_PCI_COMMAND, u16Command);
644}
645
646
647/**
648 * Gets the command config register.
649 * @returns The command register value.
650 * @param pPciDev The PCI device.
651 */
652DECLINLINE(uint16_t) PCIDevGetCommand(PPCIDEVICE pPciDev)
653{
654 return PCIDevGetWord(pPciDev, VBOX_PCI_COMMAND);
655}
656
657/**
658 * Checks if the given PCI device is a bus master.
659 * @returns true if the device is a bus master, false if not.
660 * @param pPciDev The PCI device.
661 */
662DECLINLINE(bool) PCIDevIsBusmaster(PPCIDEVICE pPciDev)
663{
664 return (PCIDevGetCommand(pPciDev) & VBOX_PCI_COMMAND_MASTER) != 0;
665}
666
667/**
668 * Checks if INTx interrupts disabled in the command config register.
669 * @returns true if disabled.
670 * @param pPciDev The PCI device.
671 */
672DECLINLINE(bool) PCIDevIsIntxDisabled(PPCIDEVICE pPciDev)
673{
674 return (PCIDevGetCommand(pPciDev) & VBOX_PCI_COMMAND_INTX_DISABLE) != 0;
675}
676
677/**
678 * Gets the status config register.
679 *
680 * @returns status config register.
681 * @param pPciDev The PCI device.
682 */
683DECLINLINE(uint16_t) PCIDevGetStatus(PPCIDEVICE pPciDev)
684{
685 return PCIDevGetWord(pPciDev, VBOX_PCI_STATUS);
686}
687
688/**
689 * Sets the status config register.
690 *
691 * @param pPciDev The PCI device.
692 * @param u16Status The status register value.
693 */
694DECLINLINE(void) PCIDevSetStatus(PPCIDEVICE pPciDev, uint16_t u16Status)
695{
696 PCIDevSetWord(pPciDev, VBOX_PCI_STATUS, u16Status);
697}
698
699
700/**
701 * Sets the revision id config register.
702 *
703 * @param pPciDev The PCI device.
704 * @param u8RevisionId The revision id.
705 */
706DECLINLINE(void) PCIDevSetRevisionId(PPCIDEVICE pPciDev, uint8_t u8RevisionId)
707{
708 PCIDevSetByte(pPciDev, VBOX_PCI_REVISION_ID, u8RevisionId);
709}
710
711
712/**
713 * Sets the register level programming class config register.
714 *
715 * @param pPciDev The PCI device.
716 * @param u8ClassProg The new value.
717 */
718DECLINLINE(void) PCIDevSetClassProg(PPCIDEVICE pPciDev, uint8_t u8ClassProg)
719{
720 PCIDevSetByte(pPciDev, VBOX_PCI_CLASS_PROG, u8ClassProg);
721}
722
723
724/**
725 * Sets the sub-class (aka device class) config register.
726 *
727 * @param pPciDev The PCI device.
728 * @param u8SubClass The sub-class.
729 */
730DECLINLINE(void) PCIDevSetClassSub(PPCIDEVICE pPciDev, uint8_t u8SubClass)
731{
732 PCIDevSetByte(pPciDev, VBOX_PCI_CLASS_SUB, u8SubClass);
733}
734
735
736/**
737 * Sets the base class config register.
738 *
739 * @param pPciDev The PCI device.
740 * @param u8BaseClass The base class.
741 */
742DECLINLINE(void) PCIDevSetClassBase(PPCIDEVICE pPciDev, uint8_t u8BaseClass)
743{
744 PCIDevSetByte(pPciDev, VBOX_PCI_CLASS_BASE, u8BaseClass);
745}
746
747/**
748 * Sets the header type config register.
749 *
750 * @param pPciDev The PCI device.
751 * @param u8HdrType The header type.
752 */
753DECLINLINE(void) PCIDevSetHeaderType(PPCIDEVICE pPciDev, uint8_t u8HdrType)
754{
755 PCIDevSetByte(pPciDev, VBOX_PCI_HEADER_TYPE, u8HdrType);
756}
757
758/**
759 * Gets the header type config register.
760 *
761 * @param pPciDev The PCI device.
762 * @returns u8HdrType The header type.
763 */
764DECLINLINE(uint8_t) PCIDevGetHeaderType(PPCIDEVICE pPciDev)
765{
766 return PCIDevGetByte(pPciDev, VBOX_PCI_HEADER_TYPE);
767}
768
769/**
770 * Sets the BIST (built-in self-test) config register.
771 *
772 * @param pPciDev The PCI device.
773 * @param u8Bist The BIST value.
774 */
775DECLINLINE(void) PCIDevSetBIST(PPCIDEVICE pPciDev, uint8_t u8Bist)
776{
777 PCIDevSetByte(pPciDev, VBOX_PCI_BIST, u8Bist);
778}
779
780/**
781 * Gets the BIST (built-in self-test) config register.
782 *
783 * @param pPciDev The PCI device.
784 * @returns u8Bist The BIST.
785 */
786DECLINLINE(uint8_t) PCIDevGetBIST(PPCIDEVICE pPciDev)
787{
788 return PCIDevGetByte(pPciDev, VBOX_PCI_BIST);
789}
790
791
792/**
793 * Sets a base address config register.
794 *
795 * @param pPciDev The PCI device.
796 * @param iReg Base address register number (0..5).
797 * @param fIOSpace Whether it's I/O (true) or memory (false) space.
798 * @param fPrefetchable Whether the memory is prefetachable. Must be false if fIOSpace == true.
799 * @param f64Bit Whether the memory can be mapped anywhere in the 64-bit address space. Otherwise restrict to 32-bit.
800 * @param u32Addr The address value.
801 */
802DECLINLINE(void) PCIDevSetBaseAddress(PPCIDEVICE pPciDev, uint8_t iReg, bool fIOSpace, bool fPrefetchable, bool f64Bit,
803 uint32_t u32Addr)
804{
805 if (fIOSpace)
806 {
807 Assert(!(u32Addr & 0x3)); Assert(!fPrefetchable); Assert(!f64Bit);
808 u32Addr |= RT_BIT_32(0);
809 }
810 else
811 {
812 Assert(!(u32Addr & 0xf));
813 if (fPrefetchable)
814 u32Addr |= RT_BIT_32(3);
815 if (f64Bit)
816 u32Addr |= 0x2 << 1;
817 }
818 switch (iReg)
819 {
820 case 0: iReg = VBOX_PCI_BASE_ADDRESS_0; break;
821 case 1: iReg = VBOX_PCI_BASE_ADDRESS_1; break;
822 case 2: iReg = VBOX_PCI_BASE_ADDRESS_2; break;
823 case 3: iReg = VBOX_PCI_BASE_ADDRESS_3; break;
824 case 4: iReg = VBOX_PCI_BASE_ADDRESS_4; break;
825 case 5: iReg = VBOX_PCI_BASE_ADDRESS_5; break;
826 default: AssertFailedReturnVoid();
827 }
828
829 PCIDevSetDWord(pPciDev, iReg, u32Addr);
830}
831
832/**
833 * Please document me. I don't seem to be getting as much as calculating
834 * the address of some PCI region.
835 */
836DECLINLINE(uint32_t) PCIDevGetRegionReg(uint32_t iRegion)
837{
838 return iRegion == VBOX_PCI_ROM_SLOT
839 ? VBOX_PCI_ROM_ADDRESS : (VBOX_PCI_BASE_ADDRESS_0 + iRegion * 4);
840}
841
842/**
843 * Sets the sub-system vendor id config register.
844 *
845 * @param pPciDev The PCI device.
846 * @param u16SubSysVendorId The sub-system vendor id.
847 */
848DECLINLINE(void) PCIDevSetSubSystemVendorId(PPCIDEVICE pPciDev, uint16_t u16SubSysVendorId)
849{
850 PCIDevSetWord(pPciDev, VBOX_PCI_SUBSYSTEM_VENDOR_ID, u16SubSysVendorId);
851}
852
853/**
854 * Gets the sub-system vendor id config register.
855 * @returns the sub-system vendor id.
856 * @param pPciDev The PCI device.
857 */
858DECLINLINE(uint16_t) PCIDevGetSubSystemVendorId(PPCIDEVICE pPciDev)
859{
860 return PCIDevGetWord(pPciDev, VBOX_PCI_SUBSYSTEM_VENDOR_ID);
861}
862
863
864/**
865 * Sets the sub-system id config register.
866 *
867 * @param pPciDev The PCI device.
868 * @param u16SubSystemId The sub-system id.
869 */
870DECLINLINE(void) PCIDevSetSubSystemId(PPCIDEVICE pPciDev, uint16_t u16SubSystemId)
871{
872 PCIDevSetWord(pPciDev, VBOX_PCI_SUBSYSTEM_ID, u16SubSystemId);
873}
874
875/**
876 * Gets the sub-system id config register.
877 * @returns the sub-system id.
878 * @param pPciDev The PCI device.
879 */
880DECLINLINE(uint16_t) PCIDevGetSubSystemId(PPCIDEVICE pPciDev)
881{
882 return PCIDevGetWord(pPciDev, VBOX_PCI_SUBSYSTEM_ID);
883}
884
885/**
886 * Sets offset to capability list.
887 *
888 * @param pPciDev The PCI device.
889 * @param u8Offset The offset to capability list.
890 */
891DECLINLINE(void) PCIDevSetCapabilityList(PPCIDEVICE pPciDev, uint8_t u8Offset)
892{
893 PCIDevSetByte(pPciDev, VBOX_PCI_CAPABILITY_LIST, u8Offset);
894}
895
896/**
897 * Returns offset to capability list.
898 *
899 * @returns offset to capability list.
900 * @param pPciDev The PCI device.
901 */
902DECLINLINE(uint8_t) PCIDevGetCapabilityList(PPCIDEVICE pPciDev)
903{
904 return PCIDevGetByte(pPciDev, VBOX_PCI_CAPABILITY_LIST);
905}
906
907/**
908 * Sets the interrupt line config register.
909 *
910 * @param pPciDev The PCI device.
911 * @param u8Line The interrupt line.
912 */
913DECLINLINE(void) PCIDevSetInterruptLine(PPCIDEVICE pPciDev, uint8_t u8Line)
914{
915 PCIDevSetByte(pPciDev, VBOX_PCI_INTERRUPT_LINE, u8Line);
916}
917
918/**
919 * Gets the interrupt line config register.
920 *
921 * @returns The interrupt line.
922 * @param pPciDev The PCI device.
923 */
924DECLINLINE(uint8_t) PCIDevGetInterruptLine(PPCIDEVICE pPciDev)
925{
926 return PCIDevGetByte(pPciDev, VBOX_PCI_INTERRUPT_LINE);
927}
928
929/**
930 * Sets the interrupt pin config register.
931 *
932 * @param pPciDev The PCI device.
933 * @param u8Pin The interrupt pin.
934 */
935DECLINLINE(void) PCIDevSetInterruptPin(PPCIDEVICE pPciDev, uint8_t u8Pin)
936{
937 PCIDevSetByte(pPciDev, VBOX_PCI_INTERRUPT_PIN, u8Pin);
938}
939
940/**
941 * Gets the interrupt pin config register.
942 *
943 * @returns The interrupt pin.
944 * @param pPciDev The PCI device.
945 */
946DECLINLINE(uint8_t) PCIDevGetInterruptPin(PPCIDEVICE pPciDev)
947{
948 return PCIDevGetByte(pPciDev, VBOX_PCI_INTERRUPT_PIN);
949}
950
951#ifdef PCIDEVICEINT_DECLARED
952DECLINLINE(void) pciDevSetRequestedDevfunc(PPCIDEVICE pDev)
953{
954 pDev->Int.s.fFlags |= PCIDEV_FLAG_REQUESTED_DEVFUNC;
955}
956
957DECLINLINE(void) pciDevClearRequestedDevfunc(PPCIDEVICE pDev)
958{
959 pDev->Int.s.fFlags &= ~PCIDEV_FLAG_REQUESTED_DEVFUNC;
960}
961
962DECLINLINE(bool) pciDevIsRequestedDevfunc(PPCIDEVICE pDev)
963{
964 return (pDev->Int.s.fFlags & PCIDEV_FLAG_REQUESTED_DEVFUNC) != 0;
965}
966
967DECLINLINE(void) pciDevSetPci2PciBridge(PPCIDEVICE pDev)
968{
969 pDev->Int.s.fFlags |= PCIDEV_FLAG_PCI_TO_PCI_BRIDGE;
970}
971
972DECLINLINE(bool) pciDevIsPci2PciBridge(PPCIDEVICE pDev)
973{
974 return (pDev->Int.s.fFlags & PCIDEV_FLAG_PCI_TO_PCI_BRIDGE) != 0;
975}
976
977DECLINLINE(void) pciDevSetPciExpress(PPCIDEVICE pDev)
978{
979 pDev->Int.s.fFlags |= PCIDEV_FLAG_PCI_EXPRESS_DEVICE;
980}
981
982DECLINLINE(bool) pciDevIsPciExpress(PPCIDEVICE pDev)
983{
984 return (pDev->Int.s.fFlags & PCIDEV_FLAG_PCI_EXPRESS_DEVICE) != 0;
985}
986
987DECLINLINE(void) pciDevSetMsiCapable(PPCIDEVICE pDev)
988{
989 pDev->Int.s.fFlags |= PCIDEV_FLAG_MSI_CAPABLE;
990}
991
992DECLINLINE(void) pciDevClearMsiCapable(PPCIDEVICE pDev)
993{
994 pDev->Int.s.fFlags &= ~PCIDEV_FLAG_MSI_CAPABLE;
995}
996
997DECLINLINE(bool) pciDevIsMsiCapable(PPCIDEVICE pDev)
998{
999 return (pDev->Int.s.fFlags & PCIDEV_FLAG_MSI_CAPABLE) != 0;
1000}
1001
1002DECLINLINE(void) pciDevSetMsi64Capable(PPCIDEVICE pDev)
1003{
1004 pDev->Int.s.fFlags |= PCIDEV_FLAG_MSI64_CAPABLE;
1005}
1006
1007DECLINLINE(void) pciDevClearMsi64Capable(PPCIDEVICE pDev)
1008{
1009 pDev->Int.s.fFlags &= ~PCIDEV_FLAG_MSI64_CAPABLE;
1010}
1011
1012DECLINLINE(bool) pciDevIsMsi64Capable(PPCIDEVICE pDev)
1013{
1014 return (pDev->Int.s.fFlags & PCIDEV_FLAG_MSI64_CAPABLE) != 0;
1015}
1016
1017DECLINLINE(void) pciDevSetMsixCapable(PPCIDEVICE pDev)
1018{
1019 pDev->Int.s.fFlags |= PCIDEV_FLAG_MSIX_CAPABLE;
1020}
1021
1022DECLINLINE(void) pciDevClearMsixCapable(PPCIDEVICE pDev)
1023{
1024 pDev->Int.s.fFlags &= ~PCIDEV_FLAG_MSIX_CAPABLE;
1025}
1026
1027DECLINLINE(bool) pciDevIsMsixCapable(PPCIDEVICE pDev)
1028{
1029 return (pDev->Int.s.fFlags & PCIDEV_FLAG_MSIX_CAPABLE) != 0;
1030}
1031
1032DECLINLINE(void) pciDevSetPassthrough(PPCIDEVICE pDev)
1033{
1034 pDev->Int.s.fFlags |= PCIDEV_FLAG_PASSTHROUGH;
1035}
1036
1037DECLINLINE(void) pciDevClearPassthrough(PPCIDEVICE pDev)
1038{
1039 pDev->Int.s.fFlags &= ~PCIDEV_FLAG_PASSTHROUGH;
1040}
1041
1042DECLINLINE(bool) pciDevIsPassthrough(PPCIDEVICE pDev)
1043{
1044 return (pDev->Int.s.fFlags & PCIDEV_FLAG_PASSTHROUGH) != 0;
1045}
1046
1047#endif /* PCIDEVICEINT_DECLARED */
1048
1049#if defined(__cplusplus) && defined(IN_RING3)
1050/* For RTStrPrintf(). */
1051#include <iprt/string.h>
1052
1053/**
1054 * Class representing PCI address. PCI device consist of
1055 * bus, device and function numbers. Generally device PCI
1056 * address could be changed during runtime, but only by
1057 * an OS PCI driver.
1058 *
1059 * @remarks C++ classes (structs included) are not generally accepted in
1060 * VMM devices or drivers. An exception may be granted for this class
1061 * if it's contained to ring-3 and that this is a one time exception
1062 * which sets no precedent.
1063 */
1064struct PCIBusAddress
1065{
1066 /** @todo: think if we'll need domain, which is higher
1067 * word of the address. */
1068 int miBus;
1069 int miDevice;
1070 int miFn;
1071
1072 PCIBusAddress()
1073 {
1074 clear();
1075 }
1076
1077 PCIBusAddress(int iBus, int iDevice, int iFn)
1078 {
1079 init(iBus, iDevice, iFn);
1080 }
1081
1082 PCIBusAddress(int32_t iAddr)
1083 {
1084 clear();
1085 fromLong(iAddr);
1086 }
1087
1088 PCIBusAddress& clear()
1089 {
1090 miBus = miDevice = miFn = -1;
1091 return *this;
1092 }
1093
1094 void init(int iBus, int iDevice, int iFn)
1095 {
1096 miBus = iBus;
1097 miDevice = iDevice;
1098 miFn = iFn;
1099 }
1100
1101 void init(const PCIBusAddress &a)
1102 {
1103 miBus = a.miBus;
1104 miDevice = a.miDevice;
1105 miFn = a.miFn;
1106 }
1107
1108 bool operator<(const PCIBusAddress &a) const
1109 {
1110 if (miBus < a.miBus)
1111 return true;
1112
1113 if (miBus > a.miBus)
1114 return false;
1115
1116 if (miDevice < a.miDevice)
1117 return true;
1118
1119 if (miDevice > a.miDevice)
1120 return false;
1121
1122 if (miFn < a.miFn)
1123 return true;
1124
1125 if (miFn > a.miFn)
1126 return false;
1127
1128 return false;
1129 }
1130
1131 bool operator==(const PCIBusAddress &a) const
1132 {
1133 return (miBus == a.miBus)
1134 && (miDevice == a.miDevice)
1135 && (miFn == a.miFn);
1136 }
1137
1138 bool operator!=(const PCIBusAddress &a) const
1139 {
1140 return (miBus != a.miBus)
1141 || (miDevice != a.miDevice)
1142 || (miFn != a.miFn);
1143 }
1144
1145 bool valid() const
1146 {
1147 return (miBus != -1)
1148 && (miDevice != -1)
1149 && (miFn != -1);
1150 }
1151
1152 int32_t asLong() const
1153 {
1154 Assert(valid());
1155 return (miBus << 8) | (miDevice << 3) | miFn;
1156 }
1157
1158 PCIBusAddress& fromLong(int32_t value)
1159 {
1160 miBus = (value >> 8) & 0xff;
1161 miDevice = (value & 0xff) >> 3;
1162 miFn = (value & 7);
1163 return *this;
1164 }
1165
1166 /** Create string representation of this PCI address. */
1167 bool format(char* szBuf, int32_t cBufSize)
1168 {
1169 if (cBufSize < (/* bus */ 2 + /* : */ 1 + /* device */ 2 + /* . */ 1 + /* function*/ 1 + /* \0 */1))
1170 return false;
1171
1172 if (valid())
1173 RTStrPrintf(szBuf, cBufSize, "%02x:%02x.%01x", miBus, miDevice, miFn);
1174 else
1175 RTStrPrintf(szBuf, cBufSize, "%s", "<bad>");
1176
1177 return true;
1178 }
1179
1180 static const size_t cMaxAddrSize = 10;
1181};
1182#endif /* __cplusplus */
1183
1184/** @} */
1185
1186#endif
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette