VirtualBox

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

Last change on this file since 79115 was 76585, checked in by vboxsync, 6 years ago

*: scm --fix-header-guard-endif
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 31.4 KB
Line 
1/** @file
2 * PCI - The PCI Controller And Devices Constants. (DEV)
3 */
4
5/*
6 * Copyright (C) 2006-2019 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_INCLUDED_pci_h
27#define VBOX_INCLUDED_pci_h
28#ifndef RT_WITHOUT_PRAGMA_ONCE
29# pragma once
30#endif
31
32#include <VBox/cdefs.h>
33#include <VBox/types.h>
34#include <iprt/assert.h>
35
36/** @defgroup grp_pci PCI - The PCI Controller.
37 * @ingroup grp_devdrv
38 * @{
39 */
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/** @name PCI Configuration Space Registers
78 * @{ */
79/* Commented out values common for different header types */
80/* Common part of the header */
81#define VBOX_PCI_VENDOR_ID 0x00 /**< 16-bit RO */
82#define VBOX_PCI_DEVICE_ID 0x02 /**< 16-bit RO */
83#define VBOX_PCI_COMMAND 0x04 /**< 16-bit RW, some bits RO */
84#define VBOX_PCI_STATUS 0x06 /**< 16-bit RW, some bits RO */
85#define VBOX_PCI_REVISION_ID 0x08 /**< 8-bit RO - - device revision */
86#define VBOX_PCI_CLASS_PROG 0x09 /**< 8-bit RO - - register-level programming class code (device specific). */
87#define VBOX_PCI_CLASS_SUB 0x0a /**< 8-bit RO - - sub-class code. */
88#define VBOX_PCI_CLASS_DEVICE VBOX_PCI_CLASS_SUB
89#define VBOX_PCI_CLASS_BASE 0x0b /**< 8-bit RO - - base class code. */
90#define VBOX_PCI_CACHE_LINE_SIZE 0x0c /**< 8-bit RW - - system cache line size */
91#define VBOX_PCI_LATENCY_TIMER 0x0d /**< 8-bit RW - - master latency timer, hardwired to 0 for PCIe */
92#define VBOX_PCI_HEADER_TYPE 0x0e /**< 8-bit RO - - header type (0 - device, 1 - bridge, 2 - CardBus bridge) */
93#define VBOX_PCI_BIST 0x0f /**< 8-bit RW - - built-in self test control */
94#define VBOX_PCI_CAPABILITY_LIST 0x34 /**< 8-bit RO? - - linked list of new capabilities implemented by the device, 2 bottom bits reserved */
95#define VBOX_PCI_INTERRUPT_LINE 0x3c /**< 8-bit RW - - interrupt line. */
96#define VBOX_PCI_INTERRUPT_PIN 0x3d /**< 8-bit RO - - interrupt pin. */
97
98/* Type 0 header, device */
99#define VBOX_PCI_BASE_ADDRESS_0 0x10 /**< 32-bit RW */
100#define VBOX_PCI_BASE_ADDRESS_1 0x14 /**< 32-bit RW */
101#define VBOX_PCI_BASE_ADDRESS_2 0x18 /**< 32-bit RW */
102#define VBOX_PCI_BASE_ADDRESS_3 0x1c /**< 32-bit RW */
103#define VBOX_PCI_BASE_ADDRESS_4 0x20 /**< 32-bit RW */
104#define VBOX_PCI_BASE_ADDRESS_5 0x24 /**< 32-bit RW */
105#define VBOX_PCI_CARDBUS_CIS 0x28 /**< 32-bit ?? */
106#define VBOX_PCI_SUBSYSTEM_VENDOR_ID 0x2c /**< 16-bit RO */
107#define VBOX_PCI_SUBSYSTEM_ID 0x2e /**< 16-bit RO */
108#define VBOX_PCI_ROM_ADDRESS 0x30 /**< 32-bit ?? */
109/* #define VBOX_PCI_CAPABILITY_LIST 0x34 */ /**< 8-bit? ?? */
110#define VBOX_PCI_RESERVED_35 0x35 /**< 8-bit ?? - - reserved */
111#define VBOX_PCI_RESERVED_36 0x36 /**< 8-bit ?? - - reserved */
112#define VBOX_PCI_RESERVED_37 0x37 /**< 8-bit ?? - - reserved */
113#define VBOX_PCI_RESERVED_38 0x38 /**< 32-bit ?? - - reserved */
114/* #define VBOX_PCI_INTERRUPT_LINE 0x3c */ /**< 8-bit RW - - interrupt line. */
115/* #define VBOX_PCI_INTERRUPT_PIN 0x3d */ /**< 8-bit RO - - interrupt pin. */
116#define VBOX_PCI_MIN_GNT 0x3e /**< 8-bit RO - - burst period length (in 1/4 microsecond units) */
117#define VBOX_PCI_MAX_LAT 0x3f /**< 8-bit RO - - how often the device needs access to the PCI bus (in 1/4 microsecond units) */
118
119/* Type 1 header, PCI-to-PCI bridge */
120/* #define VBOX_PCI_BASE_ADDRESS_0 0x10 */ /**< 32-bit RW */
121/* #define VBOX_PCI_BASE_ADDRESS_1 0x14 */ /**< 32-bit RW */
122#define VBOX_PCI_PRIMARY_BUS 0x18 /**< 8-bit ?? - - primary bus number. */
123#define VBOX_PCI_SECONDARY_BUS 0x19 /**< 8-bit ?? - - secondary bus number. */
124#define VBOX_PCI_SUBORDINATE_BUS 0x1a /**< 8-bit ?? - - highest subordinate bus number. (behind the bridge) */
125#define VBOX_PCI_SEC_LATENCY_TIMER 0x1b /**< 8-bit ?? - - secondary latency timer. */
126#define VBOX_PCI_IO_BASE 0x1c /**< 8-bit ?? - - I/O range base. */
127#define VBOX_PCI_IO_LIMIT 0x1d /**< 8-bit ?? - - I/O range limit. */
128#define VBOX_PCI_SEC_STATUS 0x1e /**< 16-bit ?? - - secondary status register. */
129#define VBOX_PCI_MEMORY_BASE 0x20 /**< 16-bit ?? - - memory range base. */
130#define VBOX_PCI_MEMORY_LIMIT 0x22 /**< 16-bit ?? - - memory range limit. */
131#define VBOX_PCI_PREF_MEMORY_BASE 0x24 /**< 16-bit ?? - - prefetchable memory range base. */
132#define VBOX_PCI_PREF_MEMORY_LIMIT 0x26 /**< 16-bit ?? - - prefetchable memory range limit. */
133#define VBOX_PCI_PREF_BASE_UPPER32 0x28 /**< 32-bit ?? - - prefetchable memory range high base.*/
134#define VBOX_PCI_PREF_LIMIT_UPPER32 0x2c /**< 32-bit ?? - - prefetchable memory range high limit. */
135#define VBOX_PCI_IO_BASE_UPPER16 0x30 /**< 16-bit ?? - - memory range high base. */
136#define VBOX_PCI_IO_LIMIT_UPPER16 0x32 /**< 16-bit ?? - - memory range high limit. */
137/* #define VBOX_PCI_CAPABILITY_LIST 0x34 */ /**< 8-bit? ?? */
138/* #define VBOX_PCI_RESERVED_35 0x35 */ /**< 8-bit ?? - - reserved */
139/* #define VBOX_PCI_RESERVED_36 0x36 */ /**< 8-bit ?? - - reserved */
140/* #define VBOX_PCI_RESERVED_37 0x37 */ /**< 8-bit ?? - - reserved */
141#define VBOX_PCI_ROM_ADDRESS_BR 0x38 /**< 32-bit ?? - - expansion ROM base address */
142#define VBOX_PCI_BRIDGE_CONTROL 0x3e /**< 16-bit? ?? - - bridge control */
143
144/* Type 2 header, PCI-to-CardBus bridge */
145#define VBOX_PCI_CARDBUS_BASE_ADDRESS 0x10 /**< 32-bit RW - - CardBus Socket/ExCa base address */
146#define VBOX_PCI_CARDBUS_CAPLIST 0x14 /**< 8-bit RO? - - offset of capabilities list */
147#define VBOX_PCI_CARDBUS_RESERVED_15 0x15 /**< 8-bit ?? - - reserved */
148#define VBOX_PCI_CARDBUS_SEC_STATUS 0x16 /**< 16-bit ?? - - secondary status */
149#define VBOX_PCI_CARDBUS_PCIBUS_NUMBER 0x18 /**< 8-bit ?? - - PCI bus number */
150#define VBOX_PCI_CARDBUS_CARDBUS_NUMBER 0x19 /**< 8-bit ?? - - CardBus bus number */
151/* #define VBOX_PCI_SUBORDINATE_BUS 0x1a */ /**< 8-bit ?? - - highest subordinate bus number. (behind the bridge) */
152/* #define VBOX_PCI_SEC_LATENCY_TIMER 0x1b */ /**< 8-bit ?? - - secondary latency timer. */
153#define VBOX_PCI_CARDBUS_MEMORY_BASE0 0x1c /**< 32-bit RW - - memory base address 0 */
154#define VBOX_PCI_CARDBUS_MEMORY_LIMIT0 0x20 /**< 32-bit RW - - memory limit 0 */
155#define VBOX_PCI_CARDBUS_MEMORY_BASE1 0x24 /**< 32-bit RW - - memory base address 1 */
156#define VBOX_PCI_CARDBUS_MEMORY_LIMIT1 0x28 /**< 32-bit RW - - memory limit 1 */
157#define VBOX_PCI_CARDBUS_IO_BASE0 0x2c /**< 32-bit RW - - IO base address 0 */
158#define VBOX_PCI_CARDBUS_IO_LIMIT0 0x30 /**< 32-bit RW - - IO limit 0 */
159#define VBOX_PCI_CARDBUS_IO_BASE1 0x34 /**< 32-bit RW - - IO base address 1 */
160#define VBOX_PCI_CARDBUS_IO_LIMIT1 0x38 /**< 32-bit RW - - IO limit 1 */
161/* #define VBOX_PCI_INTERRUPT_LINE 0x3c */ /**< 8-bit RW - - interrupt line. */
162/* #define VBOX_PCI_INTERRUPT_PIN 0x3d */ /**< 8-bit RO - - interrupt pin. */
163/* #define VBOX_PCI_BRIDGE_CONTROL 0x3e */ /**< 16-bit? ?? - - bridge control */
164/** @} */
165
166
167/* Possible values in status bitmask */
168#define VBOX_PCI_STATUS_CAP_LIST 0x10 /* Support Capability List */
169#define VBOX_PCI_STATUS_66MHZ 0x20 /* Support 66 Mhz PCI 2.1 bus */
170#define VBOX_PCI_STATUS_UDF 0x40 /* Support User Definable Features [obsolete] */
171#define VBOX_PCI_STATUS_FAST_BACK 0x80 /* Accept fast-back to back */
172#define VBOX_PCI_STATUS_PARITY 0x100 /* Detected parity error */
173#define VBOX_PCI_STATUS_DEVSEL_MASK 0x600 /* DEVSEL timing */
174#define VBOX_PCI_STATUS_DEVSEL_FAST 0x000
175#define VBOX_PCI_STATUS_DEVSEL_MEDIUM 0x200
176#define VBOX_PCI_STATUS_DEVSEL_SLOW 0x400
177#define VBOX_PCI_STATUS_SIG_TARGET_ABORT 0x800 /* Set on target abort */
178#define VBOX_PCI_STATUS_REC_TARGET_ABORT 0x1000 /* Master ack of " */
179#define VBOX_PCI_STATUS_REC_MASTER_ABORT 0x2000 /* Set on master abort */
180#define VBOX_PCI_STATUS_SIG_SYSTEM_ERROR 0x4000 /* Set when we drive SERR */
181#define VBOX_PCI_STATUS_DETECTED_PARITY 0x8000 /* Set on parity error */
182
183
184/* Command bitmask */
185#define VBOX_PCI_COMMAND_IO 0x1 /* Enable response in I/O space */
186#define VBOX_PCI_COMMAND_MEMORY 0x2 /* Enable response in Memory space */
187#define VBOX_PCI_COMMAND_MASTER 0x4 /* Enable bus mastering */
188#define VBOX_PCI_COMMAND_SPECIAL 0x8 /* Enable response to special cycles */
189#define VBOX_PCI_COMMAND_INVALIDATE 0x10 /* Use memory write and invalidate */
190#define VBOX_PCI_COMMAND_VGA_PALETTE 0x20 /* Enable palette snooping */
191#define VBOX_PCI_COMMAND_PARITY 0x40 /* Enable parity checking */
192#define VBOX_PCI_COMMAND_WAIT 0x80 /* Enable address/data stepping */
193#define VBOX_PCI_COMMAND_SERR 0x100 /* Enable SERR */
194#define VBOX_PCI_COMMAND_FAST_BACK 0x200 /* Enable back-to-back writes */
195#define VBOX_PCI_COMMAND_INTX_DISABLE 0x400 /* INTx Emulation Disable */
196
197
198/* Capability list values (capability offset 0) */
199/* Next value pointer in offset 1, or 0 if none */
200#define VBOX_PCI_CAP_ID_PM 0x01 /* Power Management */
201#define VBOX_PCI_CAP_ID_AGP 0x02 /* Accelerated Graphics Port */
202#define VBOX_PCI_CAP_ID_VPD 0x03 /* Vital Product Data */
203#define VBOX_PCI_CAP_ID_SLOTID 0x04 /* Slot Identification */
204#define VBOX_PCI_CAP_ID_MSI 0x05 /* Message Signalled Interrupts */
205#define VBOX_PCI_CAP_ID_CHSWP 0x06 /* CompactPCI HotSwap */
206#define VBOX_PCI_CAP_ID_PCIX 0x07 /* PCI-X */
207#define VBOX_PCI_CAP_ID_HT 0x08 /* HyperTransport */
208#define VBOX_PCI_CAP_ID_VNDR 0x09 /* Vendor specific */
209#define VBOX_PCI_CAP_ID_DBG 0x0A /* Debug port */
210#define VBOX_PCI_CAP_ID_CCRC 0x0B /* CompactPCI Central Resource Control */
211#define VBOX_PCI_CAP_ID_SHPC 0x0C /* PCI Standard Hot-Plug Controller */
212#define VBOX_PCI_CAP_ID_SSVID 0x0D /* Bridge subsystem vendor/device ID */
213#define VBOX_PCI_CAP_ID_AGP3 0x0E /* AGP Target PCI-PCI bridge */
214#define VBOX_PCI_CAP_ID_SECURE 0x0F /* Secure device (?) */
215#define VBOX_PCI_CAP_ID_EXP 0x10 /* PCI Express */
216#define VBOX_PCI_CAP_ID_MSIX 0x11 /* MSI-X */
217#define VBOX_PCI_CAP_ID_SATA 0x12 /* Serial-ATA HBA */
218#define VBOX_PCI_CAP_ID_AF 0x13 /* PCI Advanced Features */
219
220/* Extended Capabilities (PCI-X 2.0 and Express), start at 0x100, next - bits [20..32] */
221#define VBOX_PCI_EXT_CAP_ID_ERR 0x01 /* Advanced Error Reporting */
222#define VBOX_PCI_EXT_CAP_ID_VC 0x02 /* Virtual Channel */
223#define VBOX_PCI_EXT_CAP_ID_DSN 0x03 /* Device Serial Number */
224#define VBOX_PCI_EXT_CAP_ID_PWR 0x04 /* Power Budgeting */
225#define VBOX_PCI_EXT_CAP_ID_RCLINK 0x05 /* Root Complex Link Declaration */
226#define VBOX_PCI_EXT_CAP_ID_RCILINK 0x06 /* Root Complex Internal Link Declaration */
227#define VBOX_PCI_EXT_CAP_ID_RCECOLL 0x07 /* Root Complex Event Collector */
228#define VBOX_PCI_EXT_CAP_ID_MFVC 0x08 /* Multi-Function Virtual Channel */
229#define VBOX_PCI_EXT_CAP_ID_RBCB 0x0a /* Root Bridge Control Block */
230#define VBOX_PCI_EXT_CAP_ID_VNDR 0x0b /* Vendor specific */
231#define VBOX_PCI_EXT_CAP_ID_ACS 0x0d /* Access Controls */
232#define VBOX_PCI_EXT_CAP_ID_ARI 0x0e
233#define VBOX_PCI_EXT_CAP_ID_ATS 0x0f
234#define VBOX_PCI_EXT_CAP_ID_SRIOV 0x10
235
236
237/* MSI flags, aka Message Control (2 bytes, capability offset 2) */
238#define VBOX_PCI_MSI_FLAGS_ENABLE 0x0001 /* MSI feature enabled */
239#define VBOX_PCI_MSI_FLAGS_64BIT 0x0080 /* 64-bit addresses allowed */
240#define VBOX_PCI_MSI_FLAGS_MASKBIT 0x0100 /* Per-vector masking support */
241/* Encoding for 3-bit patterns for message queue (per chapter 6.8.1 of PCI spec),
242 someone very similar to log_2().
243 000 1
244 001 2
245 010 4
246 011 8
247 100 16
248 101 32
249 110 Reserved
250 111 Reserved */
251#define VBOX_PCI_MSI_FLAGS_QSIZE 0x0070 /* Message queue size configured (i.e. vectors per device allocated) */
252#define VBOX_PCI_MSI_FLAGS_QMASK 0x000e /* Maximum queue size available (i.e. vectors per device possible) */
253
254/* MSI-X flags (2 bytes, capability offset 2) */
255#define VBOX_PCI_MSIX_FLAGS_ENABLE 0x8000 /* MSI-X enable */
256#define VBOX_PCI_MSIX_FLAGS_FUNCMASK 0x4000 /* Function mask */
257
258/* Power management flags (2 bytes, capability offset 2) */
259#define VBOX_PCI_PM_CAP_VER_MASK 0x0007 /* Version mask */
260#define VBOX_PCI_PM_CAP_PME_CLOCK 0x0008 /* PME clock required */
261#define VBOX_PCI_PM_CAP_RESERVED 0x0010 /* Reserved field */
262#define VBOX_PCI_PM_CAP_DSI 0x0020 /* Device specific initialization */
263#define VBOX_PCI_PM_CAP_AUX_POWER 0x01C0 /* Auxilliary power support mask */
264#define VBOX_PCI_PM_CAP_D1 0x0200 /* D1 power state support */
265#define VBOX_PCI_PM_CAP_D2 0x0400 /* D2 power state support */
266#define VBOX_PCI_PM_CAP_PME 0x0800 /* PME pin supported */
267#define VBOX_PCI_PM_CAP_PME_MASK 0xF800 /* PME Mask of all supported states */
268#define VBOX_PCI_PM_CAP_PME_D0 0x0800 /* PME# from D0 */
269#define VBOX_PCI_PM_CAP_PME_D1 0x1000 /* PME# from D1 */
270#define VBOX_PCI_PM_CAP_PME_D2 0x2000 /* PME# from D2 */
271#define VBOX_PCI_PM_CAP_PME_D3 0x4000 /* PME# from D3 (hot) */
272#define VBOX_PCI_PM_CAP_PME_D3cold 0x8000 /* PME# from D3 (cold) */
273
274/* Power management control flags (2 bytes, capability offset 4) */
275#define VBOX_PCI_PM_CTRL_STATE_MASK 0x0003 /* Current power state (D0 to D3) */
276#define VBOX_PCI_PM_CTRL_NO_SOFT_RESET 0x0008 /* No reset for D3hot->D0 */
277#define VBOX_PCI_PM_CTRL_PME_ENABLE 0x0100 /* PME pin enable */
278#define VBOX_PCI_PM_CTRL_DATA_SEL_MASK 0x1e00 /* Data select (??) */
279#define VBOX_PCI_PM_CTRL_DATA_SCALE_MASK 0x6000 /* Data scale (??) */
280#define VBOX_PCI_PM_CTRL_PME_STATUS 0x8000 /* PME pin status */
281
282/* PCI-X config flags (2 bytes, capability offset 2) */
283#define VBOX_PCI_X_CMD_DPERR_E 0x0001 /* Data Parity Error Recovery Enable */
284#define VBOX_PCI_X_CMD_ERO 0x0002 /* Enable Relaxed Ordering */
285#define VBOX_PCI_X_CMD_MAX_OUTSTANDING_SPLIT_TRANS 0x0070
286#define VBOX_PCI_X_CMD_READ_512 0x0000 /* 512 byte maximum read byte count */
287#define VBOX_PCI_X_CMD_READ_1K 0x0004 /* 1Kbyte maximum read byte count */
288#define VBOX_PCI_X_CMD_READ_2K 0x0008 /* 2Kbyte maximum read byte count */
289#define VBOX_PCI_X_CMD_READ_4K 0x000c /* 4Kbyte maximum read byte count */
290#define VBOX_PCI_X_CMD_MAX_READ 0x000c /* Max Memory Read Byte Count */
291
292/* PCI-X config flags (4 bytes, capability offset 4) */
293#define VBOX_PCI_X_STATUS_DEVFN 0x000000ff /* A copy of devfn */
294#define VBOX_PCI_X_STATUS_BUS 0x0000ff00 /* A copy of bus nr */
295#define VBOX_PCI_X_STATUS_64BIT 0x00010000 /* 64-bit device */
296#define VBOX_PCI_X_STATUS_133MHZ 0x00020000 /* 133 MHz capable */
297#define VBOX_PCI_X_STATUS_SPL_DISC 0x00040000 /* Split Completion Discarded */
298#define VBOX_PCI_X_STATUS_UNX_SPL 0x00080000 /* Unexpected Split Completion */
299#define VBOX_PCI_X_STATUS_COMPLEX 0x00100000 /* Device Complexity, 0 = simple device, 1 = bridge device */
300#define VBOX_PCI_X_STATUS_MAX_READ 0x00600000 /* Designed Max Memory Read Count, 0 = 512 bytes, 1 = 1024, 2 = 2048, 3 = 4096 */
301#define VBOX_PCI_X_STATUS_MAX_SPLIT 0x03800000 /* Designed Max Outstanding Split Transactions */
302#define VBOX_PCI_X_STATUS_MAX_CUM 0x1c000000 /* Designed Max Cumulative Read Size */
303#define VBOX_PCI_X_STATUS_SPL_ERR 0x20000000 /* Rcvd Split Completion Error Msg */
304#define VBOX_PCI_X_STATUS_266MHZ 0x40000000 /* 266 MHz capable */
305#define VBOX_PCI_X_STATUS_533MHZ 0x80000000 /* 533 MHz capable */
306
307/* PCI Express config flags (2 bytes, capability offset 2) */
308#define VBOX_PCI_EXP_FLAGS_VERS 0x000f /* Capability version */
309#define VBOX_PCI_EXP_FLAGS_TYPE 0x00f0 /* Device/Port type */
310#define VBOX_PCI_EXP_TYPE_ENDPOINT 0x0 /* Express Endpoint */
311#define VBOX_PCI_EXP_TYPE_LEG_END 0x1 /* Legacy Endpoint */
312#define VBOX_PCI_EXP_TYPE_ROOT_PORT 0x4 /* Root Port */
313#define VBOX_PCI_EXP_TYPE_UPSTREAM 0x5 /* Upstream Port */
314#define VBOX_PCI_EXP_TYPE_DOWNSTREAM 0x6 /* Downstream Port */
315#define VBOX_PCI_EXP_TYPE_PCI_BRIDGE 0x7 /* PCI/PCI-X Bridge */
316#define VBOX_PCI_EXP_TYPE_PCIE_BRIDGE 0x8 /* PCI/PCI-X to PCIE Bridge */
317#define VBOX_PCI_EXP_TYPE_ROOT_INT_EP 0x9 /* Root Complex Integrated Endpoint */
318#define VBOX_PCI_EXP_TYPE_ROOT_EC 0xa /* Root Complex Event Collector */
319#define VBOX_PCI_EXP_FLAGS_SLOT 0x0100 /* Slot implemented */
320#define VBOX_PCI_EXP_FLAGS_IRQ 0x3e00 /* Interrupt message number */
321
322/* PCI Express device capabilities (4 bytes, capability offset 4) */
323#define VBOX_PCI_EXP_DEVCAP_PAYLOAD 0x07 /* Max_Payload_Size */
324#define VBOX_PCI_EXP_DEVCAP_PHANTOM 0x18 /* Phantom functions */
325#define VBOX_PCI_EXP_DEVCAP_EXT_TAG 0x20 /* Extended tags */
326#define VBOX_PCI_EXP_DEVCAP_L0S 0x1c0 /* L0s Acceptable Latency */
327#define VBOX_PCI_EXP_DEVCAP_L1 0xe00 /* L1 Acceptable Latency */
328#define VBOX_PCI_EXP_DEVCAP_ATN_BUT 0x1000 /* Attention Button Present */
329#define VBOX_PCI_EXP_DEVCAP_ATN_IND 0x2000 /* Attention Indicator Present */
330#define VBOX_PCI_EXP_DEVCAP_PWR_IND 0x4000 /* Power Indicator Present */
331#define VBOX_PCI_EXP_DEVCAP_RBE 0x8000 /* Role-Based Error Reporting */
332#define VBOX_PCI_EXP_DEVCAP_PWR_VAL 0x3fc0000 /* Slot Power Limit Value */
333#define VBOX_PCI_EXP_DEVCAP_PWR_SCL 0xc000000 /* Slot Power Limit Scale */
334#define VBOX_PCI_EXP_DEVCAP_FLRESET 0x10000000 /* Function-Level Reset */
335
336/* PCI Express device control (2 bytes, capability offset 8) */
337#define VBOX_PCI_EXP_DEVCTL_CERE 0x0001 /* Correctable Error Reporting En. */
338#define VBOX_PCI_EXP_DEVCTL_NFERE 0x0002 /* Non-Fatal Error Reporting Enable */
339#define VBOX_PCI_EXP_DEVCTL_FERE 0x0004 /* Fatal Error Reporting Enable */
340#define VBOX_PCI_EXP_DEVCTL_URRE 0x0008 /* Unsupported Request Reporting En. */
341#define VBOX_PCI_EXP_DEVCTL_RELAXED 0x0010 /* Enable Relaxed Ordering */
342#define VBOX_PCI_EXP_DEVCTL_PAYLOAD 0x00e0 /* Max_Payload_Size */
343#define VBOX_PCI_EXP_DEVCTL_EXT_TAG 0x0100 /* Extended Tag Field Enable */
344#define VBOX_PCI_EXP_DEVCTL_PHANTOM 0x0200 /* Phantom Functions Enable */
345#define VBOX_PCI_EXP_DEVCTL_AUX_PME 0x0400 /* Auxiliary Power PM Enable */
346#define VBOX_PCI_EXP_DEVCTL_NOSNOOP 0x0800 /* Enable No Snoop */
347#define VBOX_PCI_EXP_DEVCTL_READRQ 0x7000 /* Max_Read_Request_Size */
348#define VBOX_PCI_EXP_DEVCTL_BCRE 0x8000 /* Bridge Configuration Retry Enable */
349#define VBOX_PCI_EXP_DEVCTL_FLRESET 0x8000 /* Function-Level Reset [bit shared with BCRE] */
350
351/* PCI Express device status (2 bytes, capability offset 10) */
352#define VBOX_PCI_EXP_DEVSTA_CED 0x01 /* Correctable Error Detected */
353#define VBOX_PCI_EXP_DEVSTA_NFED 0x02 /* Non-Fatal Error Detected */
354#define VBOX_PCI_EXP_DEVSTA_FED 0x04 /* Fatal Error Detected */
355#define VBOX_PCI_EXP_DEVSTA_URD 0x08 /* Unsupported Request Detected */
356#define VBOX_PCI_EXP_DEVSTA_AUXPD 0x10 /* AUX Power Detected */
357#define VBOX_PCI_EXP_DEVSTA_TRPND 0x20 /* Transactions Pending */
358
359/* PCI Express link capabilities (4 bytes, capability offset 12) */
360#define VBOX_PCI_EXP_LNKCAP_SPEED 0x0000f /* Maximum Link Speed */
361#define VBOX_PCI_EXP_LNKCAP_WIDTH 0x003f0 /* Maximum Link Width */
362#define VBOX_PCI_EXP_LNKCAP_ASPM 0x00c00 /* Active State Power Management */
363#define VBOX_PCI_EXP_LNKCAP_L0S 0x07000 /* L0s Acceptable Latency */
364#define VBOX_PCI_EXP_LNKCAP_L1 0x38000 /* L1 Acceptable Latency */
365#define VBOX_PCI_EXP_LNKCAP_CLOCKPM 0x40000 /* Clock Power Management */
366#define VBOX_PCI_EXP_LNKCAP_SURPRISE 0x80000 /* Surprise Down Error Reporting */
367#define VBOX_PCI_EXP_LNKCAP_DLLA 0x100000 /* Data Link Layer Active Reporting */
368#define VBOX_PCI_EXP_LNKCAP_LBNC 0x200000 /* Link Bandwidth Notification Capability */
369#define VBOX_PCI_EXP_LNKCAP_PORT 0xff000000 /* Port Number */
370
371/* PCI Express link control (2 bytes, capability offset 16) */
372#define VBOX_PCI_EXP_LNKCTL_ASPM 0x0003 /* ASPM Control */
373#define VBOX_PCI_EXP_LNKCTL_RCB 0x0008 /* Read Completion Boundary */
374#define VBOX_PCI_EXP_LNKCTL_DISABLE 0x0010 /* Link Disable */
375#define VBOX_PCI_EXP_LNKCTL_RETRAIN 0x0020 /* Retrain Link */
376#define VBOX_PCI_EXP_LNKCTL_CLOCK 0x0040 /* Common Clock Configuration */
377#define VBOX_PCI_EXP_LNKCTL_XSYNCH 0x0080 /* Extended Synch */
378#define VBOX_PCI_EXP_LNKCTL_CLOCKPM 0x0100 /* Clock Power Management */
379#define VBOX_PCI_EXP_LNKCTL_HWAUTWD 0x0200 /* Hardware Autonomous Width Disable */
380#define VBOX_PCI_EXP_LNKCTL_BWMIE 0x0400 /* Bandwidth Mgmt Interrupt Enable */
381#define VBOX_PCI_EXP_LNKCTL_AUTBWIE 0x0800 /* Autonomous Bandwidth Mgmt Interrupt Enable */
382
383/* PCI Express link status (2 bytes, capability offset 18) */
384#define VBOX_PCI_EXP_LNKSTA_SPEED 0x000f /* Negotiated Link Speed */
385#define VBOX_PCI_EXP_LNKSTA_WIDTH 0x03f0 /* Negotiated Link Width */
386#define VBOX_PCI_EXP_LNKSTA_TR_ERR 0x0400 /* Training Error (obsolete) */
387#define VBOX_PCI_EXP_LNKSTA_TRAIN 0x0800 /* Link Training */
388#define VBOX_PCI_EXP_LNKSTA_SL_CLK 0x1000 /* Slot Clock Configuration */
389#define VBOX_PCI_EXP_LNKSTA_DL_ACT 0x2000 /* Data Link Layer in DL_Active State */
390#define VBOX_PCI_EXP_LNKSTA_BWMGMT 0x4000 /* Bandwidth Mgmt Status */
391#define VBOX_PCI_EXP_LNKSTA_AUTBW 0x8000 /* Autonomous Bandwidth Mgmt Status */
392
393/* PCI Express slot capabilities (4 bytes, capability offset 20) */
394#define VBOX_PCI_EXP_SLTCAP_ATNB 0x0001 /* Attention Button Present */
395#define VBOX_PCI_EXP_SLTCAP_PWRC 0x0002 /* Power Controller Present */
396#define VBOX_PCI_EXP_SLTCAP_MRL 0x0004 /* MRL Sensor Present */
397#define VBOX_PCI_EXP_SLTCAP_ATNI 0x0008 /* Attention Indicator Present */
398#define VBOX_PCI_EXP_SLTCAP_PWRI 0x0010 /* Power Indicator Present */
399#define VBOX_PCI_EXP_SLTCAP_HPS 0x0020 /* Hot-Plug Surprise */
400#define VBOX_PCI_EXP_SLTCAP_HPC 0x0040 /* Hot-Plug Capable */
401#define VBOX_PCI_EXP_SLTCAP_PWR_VAL 0x00007f80 /* Slot Power Limit Value */
402#define VBOX_PCI_EXP_SLTCAP_PWR_SCL 0x00018000 /* Slot Power Limit Scale */
403#define VBOX_PCI_EXP_SLTCAP_INTERLOCK 0x020000 /* Electromechanical Interlock Present */
404#define VBOX_PCI_EXP_SLTCAP_NOCMDCOMP 0x040000 /* No Command Completed Support */
405#define VBOX_PCI_EXP_SLTCAP_PSN 0xfff80000 /* Physical Slot Number */
406
407/* PCI Express slot control (2 bytes, capability offset 24) */
408#define VBOX_PCI_EXP_SLTCTL_ATNB 0x0001 /* Attention Button Pressed Enable */
409#define VBOX_PCI_EXP_SLTCTL_PWRF 0x0002 /* Power Fault Detected Enable */
410#define VBOX_PCI_EXP_SLTCTL_MRLS 0x0004 /* MRL Sensor Changed Enable */
411#define VBOX_PCI_EXP_SLTCTL_PRSD 0x0008 /* Presence Detect Changed Enable */
412#define VBOX_PCI_EXP_SLTCTL_CMDC 0x0010 /* Command Completed Interrupt Enable */
413#define VBOX_PCI_EXP_SLTCTL_HPIE 0x0020 /* Hot-Plug Interrupt Enable */
414#define VBOX_PCI_EXP_SLTCTL_ATNI 0x00c0 /* Attention Indicator Control */
415#define VBOX_PCI_EXP_SLTCTL_PWRI 0x0300 /* Power Indicator Control */
416#define VBOX_PCI_EXP_SLTCTL_PWRC 0x0400 /* Power Controller Control */
417#define VBOX_PCI_EXP_SLTCTL_INTERLOCK 0x0800 /* Electromechanical Interlock Control */
418#define VBOX_PCI_EXP_SLTCTL_LLCHG 0x1000 /* Data Link Layer State Changed Enable */
419
420/* PCI Express slot status (2 bytes, capability offset 26) */
421#define VBOX_PCI_EXP_SLTSTA_ATNB 0x0001 /* Attention Button Pressed */
422#define VBOX_PCI_EXP_SLTSTA_PWRF 0x0002 /* Power Fault Detected */
423#define VBOX_PCI_EXP_SLTSTA_MRLS 0x0004 /* MRL Sensor Changed */
424#define VBOX_PCI_EXP_SLTSTA_PRSD 0x0008 /* Presence Detect Changed */
425#define VBOX_PCI_EXP_SLTSTA_CMDC 0x0010 /* Command Completed */
426#define VBOX_PCI_EXP_SLTSTA_MRL_ST 0x0020 /* MRL Sensor State */
427#define VBOX_PCI_EXP_SLTSTA_PRES 0x0040 /* Presence Detect State */
428#define VBOX_PCI_EXP_SLTSTA_INTERLOCK 0x0080 /* Electromechanical Interlock Status */
429#define VBOX_PCI_EXP_SLTSTA_LLCHG 0x0100 /* Data Link Layer State Changed */
430
431/* PCI Express root control (2 bytes, capability offset 28) */
432#define VBOX_PCI_EXP_RTCTL_SECEE 0x0001 /* System Error on Correctable Error */
433#define VBOX_PCI_EXP_RTCTL_SENFEE 0x0002 /* System Error on Non-Fatal Error */
434#define VBOX_PCI_EXP_RTCTL_SEFEE 0x0004 /* System Error on Fatal Error */
435#define VBOX_PCI_EXP_RTCTL_PMEIE 0x0008 /* PME Interrupt Enable */
436#define VBOX_PCI_EXP_RTCTL_CRSVIS 0x0010 /* Configuration Request Retry Status Visible to SW */
437
438/* PCI Express root capabilities (2 bytes, capability offset 30) */
439#define VBOX_PCI_EXP_RTCAP_CRSVIS 0x0010 /* Configuration Request Retry Status Visible to SW */
440
441/* PCI Express root status (4 bytes, capability offset 32) */
442#define VBOX_PCI_EXP_RTSTA_PME_REQID 0x0000ffff /* PME Requester ID */
443#define VBOX_PCI_EXP_RTSTA_PME_STATUS 0x00010000 /* PME Status */
444#define VBOX_PCI_EXP_RTSTA_PME_PENDING 0x00020000 /* PME is Pending */
445
446
447/** Fixed I/O region number for ROM. */
448#define VBOX_PCI_ROM_SLOT 6
449/** Max number of I/O regions. */
450#define VBOX_PCI_NUM_REGIONS 7
451
452#define PCI_ROM_SLOT VBOX_PCI_ROM_SLOT /**< deprecated */
453#define PCI_NUM_REGIONS VBOX_PCI_NUM_REGIONS /**< deprecated */
454
455/** Number of functions per device. */
456#define VBOX_PCI_MAX_FUNCTIONS 8
457/** Number of devices per bus. */
458#define VBOX_PCI_MAX_DEVICES 32
459/** The device number shift count for a device+function number. */
460#define VBOX_PCI_DEVFN_DEV_SHIFT 3
461/** The device number shift count for a device+function number. */
462#define VBOX_PCI_DEVFN_FUN_MASK 0x7
463/** Make a device+function number. */
464#define VBOX_PCI_DEVFN_MAKE(a_uPciDevNo, a_uPciFunNo) (((a_uPciDevNo) << VBOX_PCI_DEVFN_DEV_SHIFT) | (a_uPciFunNo))
465
466
467#if defined(__cplusplus) && defined(IN_RING3)
468/* For RTStrPrintf(). */
469# include <iprt/string.h>
470
471/**
472 * Class representing PCI address. PCI device consist of
473 * bus, device and function numbers. Generally device PCI
474 * address could be changed during runtime, but only by
475 * an OS PCI driver.
476 *
477 * @remarks C++ classes (structs included) are not generally accepted in
478 * VMM devices or drivers. An exception may be granted for this class
479 * if it's contained to ring-3 and that this is a one time exception
480 * which sets no precedent.
481 */
482struct PCIBusAddress
483{
484 /** @todo: think if we'll need domain, which is higher
485 * word of the address. */
486 int miBus;
487 int miDevice;
488 int miFn;
489
490 PCIBusAddress()
491 {
492 clear();
493 }
494
495 PCIBusAddress(int iBus, int iDevice, int iFn)
496 {
497 init(iBus, iDevice, iFn);
498 }
499
500 PCIBusAddress(int32_t iAddr)
501 {
502 clear();
503 fromLong(iAddr);
504 }
505
506 PCIBusAddress& clear()
507 {
508 miBus = miDevice = miFn = -1;
509 return *this;
510 }
511
512 void init(int iBus, int iDevice, int iFn)
513 {
514 miBus = iBus;
515 miDevice = iDevice;
516 miFn = iFn;
517 }
518
519 void init(const PCIBusAddress &a)
520 {
521 miBus = a.miBus;
522 miDevice = a.miDevice;
523 miFn = a.miFn;
524 }
525
526 bool operator<(const PCIBusAddress &a) const
527 {
528 if (miBus < a.miBus)
529 return true;
530
531 if (miBus > a.miBus)
532 return false;
533
534 if (miDevice < a.miDevice)
535 return true;
536
537 if (miDevice > a.miDevice)
538 return false;
539
540 if (miFn < a.miFn)
541 return true;
542
543 if (miFn > a.miFn)
544 return false;
545
546 return false;
547 }
548
549 bool operator==(const PCIBusAddress &a) const
550 {
551 return (miBus == a.miBus)
552 && (miDevice == a.miDevice)
553 && (miFn == a.miFn);
554 }
555
556 bool operator!=(const PCIBusAddress &a) const
557 {
558 return (miBus != a.miBus)
559 || (miDevice != a.miDevice)
560 || (miFn != a.miFn);
561 }
562
563 bool valid() const
564 {
565 return (miBus != -1)
566 && (miDevice != -1)
567 && (miFn != -1);
568 }
569
570 int32_t asLong() const
571 {
572 Assert(valid());
573 return (miBus << 8) | (miDevice << 3) | miFn;
574 }
575
576 PCIBusAddress& fromLong(int32_t value)
577 {
578 miBus = (value >> 8) & 0xff;
579 miDevice = (value & 0xff) >> 3;
580 miFn = (value & 7);
581 return *this;
582 }
583
584 /** Create string representation of this PCI address. */
585 bool format(char* szBuf, int32_t cBufSize)
586 {
587 if (cBufSize < (/* bus */ 2 + /* : */ 1 + /* device */ 2 + /* . */ 1 + /* function*/ 1 + /* \0 */1))
588 return false;
589
590 if (valid())
591 RTStrPrintf(szBuf, cBufSize, "%02x:%02x.%01x", miBus, miDevice, miFn);
592 else
593 RTStrPrintf(szBuf, cBufSize, "%s", "<bad>");
594
595 return true;
596 }
597
598 static const size_t cMaxAddrSize = 10;
599};
600
601#endif /* __cplusplus && IN_RING3 */
602
603/** @} */
604
605#endif /* !VBOX_INCLUDED_pci_h */
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