VirtualBox

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

Last change on this file since 86716 was 86083, checked in by vboxsync, 4 years ago

VBox/pci.h: Make extra sure we only mask in 3 bits of the PCI function when constructing the DevFn.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 39.5 KB
Line 
1/** @file
2 * PCI - The PCI Controller And Devices Constants. (DEV)
3 */
4
5/*
6 * Copyright (C) 2006-2020 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/** @name PCI device classes.
42 * @{ */
43#define VBOX_PCI_CLASS_UNCLASSIFIED 0x00
44#define VBOX_PCI_CLASS_MASS_STORAGE 0x01
45#define VBOX_PCI_CLASS_NETWORK 0x02
46#define VBOX_PCI_CLASS_DISPLAY 0x03
47#define VBOX_PCI_CLASS_MULTI_MEDIA 0x04
48#define VBOX_PCI_CLASS_MEMORY 0x05
49#define VBOX_PCI_CLASS_BRIDGE 0x06
50#define VBOX_PCI_CLASS_COMM 0x07
51#define VBOX_PCI_CLASS_SYSTEM 0x08
52#define VBOX_PCI_CLASS_INPUT 0x09
53#define VBOX_PCI_CLASS_DOCKING_STATION 0x0a
54#define VBOX_PCI_CLASS_PROCESSOR 0x0b
55#define VBOX_PCI_CLASS_SERIAL_BUS 0x0c
56#define VBOX_PCI_CLASS_WIRELESS 0x0d
57#define VBOX_PCI_CLASS_INTELLIGENT 0x0e
58#define VBOX_PCI_CLASS_SAT_COMM 0x0f
59#define VBOX_PCI_CLASS_ENCRYPTION 0x10
60#define VBOX_PCI_CLASS_SIG_PROC 0x11
61#define VBOX_PCI_CLASS_PROC_ACCEL 0x12
62#define VBOX_PCI_CLASS_NON_ESS_INSTR 0x13
63#define VBOX_PCI_CLASS_CO_PROCESSOR 0x40
64#define VBOX_PCI_CLASS_UNASSIGNED 0xff
65/** @} */
66
67/** @name PCI device sub-classes.
68 * @{ */
69#define VBOX_PCI_SUB_UNCLASSIFIED_NON_VGA 0x00
70#define VBOX_PCI_SUB_UNCLASSIFIED_VGA 0x01
71
72#define VBOX_PCI_SUB_MASS_STORAGE_SCSI_BUS 0x00
73#define VBOX_PCI_SUB_MASS_STORAGE_IDE 0x01
74#define VBOX_PCI_SUB_MASS_STORAGE_FLOPPY 0x02
75#define VBOX_PCI_SUB_MASS_STORAGE_IPI_BUS 0x03
76#define VBOX_PCI_SUB_MASS_STORAGE_RAID 0x04
77#define VBOX_PCI_SUB_MASS_STORAGE_ATA 0x05
78#define VBOX_PCI_SUB_MASS_STORAGE_SATA 0x06
79#define VBOX_PCI_SUB_MASS_STORAGE_SCSI 0x07
80#define VBOX_PCI_SUB_MASS_STORAGE_NVME 0x08
81#define VBOX_PCI_SUB_MASS_STORAGE_OTHER 0x80
82
83#define VBOX_PCI_SUB_NETWORK_ETHERNET 0x00
84#define VBOX_PCI_SUB_NETWORK_TOKEN_RING 0x01
85#define VBOX_PCI_SUB_NETWORK_FDDI 0x02
86#define VBOX_PCI_SUB_NETWORK_ATM 0x03
87#define VBOX_PCI_SUB_NETWORK_ISDN 0x04
88#define VBOX_PCI_SUB_NETWORK_WORLD_FIP 0x05
89#define VBOX_PCI_SUB_NETWORK_PICMG 0x06
90#define VBOX_PCI_SUB_NETWORK_INFINIBAND 0x07
91#define VBOX_PCI_SUB_NETWORK_FABRIC 0x08
92#define VBOX_PCI_SUB_NETWORK_OTHER 0x80
93
94#define VBOX_PCI_SUB_DISPLAY_VGA 0x00
95#define VBOX_PCI_SUB_DISPLAY_XGA 0x01
96#define VBOX_PCI_SUB_DISPLAY_3D 0x02
97#define VBOX_PCI_SUB_DISPLAY_OTHER 0x80
98
99#define VBOX_PCI_SUB_MULTI_MEDIA_MM_VIDEO 0x00
100#define VBOX_PCI_SUB_MULTI_MEDIA_MM_AUDIO 0x01
101#define VBOX_PCI_SUB_MULTI_MEDIA_TELE 0x02
102#define VBOX_PCI_SUB_MULTI_MEDIA_AUDIO 0x03
103#define VBOX_PCI_SUB_MULTI_MEDIA_OTHER 0x80
104
105#define VBOX_PCI_SUB_MEMORY_RAM 0x00
106#define VBOX_PCI_SUB_MEMORY_FLASH 0x01
107#define VBOX_PCI_SUB_MEMORY_OTHER 0x80
108
109#define VBOX_PCI_SUB_BRIDGE_HOST 0x00
110#define VBOX_PCI_SUB_BRIDGE_ISA 0x01
111#define VBOX_PCI_SUB_BRIDGE_EISA 0x02
112#define VBOX_PCI_SUB_BRIDGE_MCA 0x03
113#define VBOX_PCI_SUB_BRIDGE_PCI 0x04
114#define VBOX_PCI_SUB_BRIDGE_PCMCIA 0x05
115#define VBOX_PCI_SUB_BRIDGE_NUBUS 0x06
116#define VBOX_PCI_SUB_BRIDGE_CARDBUS 0x07
117#define VBOX_PCI_SUB_BRIDGE_RACEWAY 0x08
118#define VBOX_PCI_SUB_BRIDGE_SEMI_PCI 0x09
119#define VBOX_PCI_SUB_BRIDGE_INFINIBAND_PCI 0x0a
120#define VBOX_PCI_SUB_BRIDGE_OTHER 0x80
121
122#define VBOX_PCI_SUB_COMM_SERIAL 0x00
123#define VBOX_PCI_SUB_COMM_PARALLEL 0x01
124#define VBOX_PCI_SUB_COMM_MULTIPORT_SERIAL 0x02
125#define VBOX_PCI_SUB_COMM_MODEM 0x03
126#define VBOX_PCI_SUB_COMM_GBIP 0x04
127#define VBOX_PCI_SUB_COMM_SMART_CARD 0x05
128#define VBOX_PCI_SUB_COMM_OTHER 0x80
129
130#define VBOX_PCI_SUB_SYSTEM_PIC 0x00
131#define VBOX_PCI_SUB_SYSTEM_DMA 0x01
132#define VBOX_PCI_SUB_SYSTEM_TIMER 0x02
133#define VBOX_PCI_SUB_SYSTEM_RTC 0x03
134#define VBOX_PCI_SUB_SYSTEM_PCI_HOTPLUG 0x04
135#define VBOX_PCI_SUB_SYSTEM_SD_HOST 0x05
136#define VBOX_PCI_SUB_SYSTEM_IOMMU 0x06
137#define VBOX_PCI_SUB_SYSTEM_OTHER 0x80
138
139#define VBOX_PCI_SUB_INPUT_KEYBOARD 0x00
140#define VBOX_PCI_SUB_INPUT_PEN 0x01
141#define VBOX_PCI_SUB_INPUT_MOUSE 0x02
142#define VBOX_PCI_SUB_INPUT_SCANNER 0x03
143#define VBOX_PCI_SUB_INPUT_GAMEPORT 0x04
144#define VBOX_PCI_SUB_INPUT_OTHER 0x80
145
146#define VBOX_PCI_SUB_DOCKING_ST_GENERIC 0x00
147#define VBOX_PCI_SUB_DOCKING_ST_OTHER 0x80
148
149#define VBOX_PCI_SUB_PROCESSOR_386 0x00
150#define VBOX_PCI_SUB_PROCESSOR_486 0x01
151#define VBOX_PCI_SUB_PROCESSOR_PENTIUM 0x02
152#define VBOX_PCI_SUB_PROCESSOR_PENTIUM_PRO 0x03
153#define VBOX_PCI_SUB_PROCESSOR_ALPHA 0x10
154#define VBOX_PCI_SUB_PROCESSOR_POWERPC 0x20
155#define VBOX_PCI_SUB_PROCESSOR_MIPS 0x30
156#define VBOX_PCI_SUB_PROCESSOR_CO_PROC 0x40
157#define VBOX_PCI_SUB_PROCESSOR_OTHER 0x80
158
159#define VBOX_PCI_SUB_SERIAL_BUS_FIREWIRE 0x00
160#define VBOX_PCI_SUB_SERIAL_BUS_ACCESS 0x01
161#define VBOX_PCI_SUB_SERIAL_BUS_SSA 0x02
162#define VBOX_PCI_SUB_SERIAL_BUS_USB 0x03
163#define VBOX_PCI_SUB_SERIAL_BUS_FIBRE 0x04
164#define VBOX_PCI_SUB_SERIAL_BUS_SMBUS 0x05
165#define VBOX_PCI_SUB_SERIAL_BUS_INFINIBAND 0x06
166#define VBOX_PCI_SUB_SERIAL_BUS_IPMI 0x07
167#define VBOX_PCI_SUB_SERIAL_BUS_SERCOS 0x08
168#define VBOX_PCI_SUB_SERIAL_BUS_CANBUS 0x09
169#define VBOX_PCI_SUB_SERIAL_BUS_OTHER 0x80
170
171#define VBOX_PCI_SUB_WIRELESS_IRDA 0x00
172#define VBOX_PCI_SUB_WIRELESS_IR 0x01
173#define VBOX_PCI_SUB_WIRELESS_RF 0x10
174#define VBOX_PCI_SUB_WIRELESS_BLUETOOTH 0x11
175#define VBOX_PCI_SUB_WIRELESS_BROADBAND 0x12
176#define VBOX_PCI_SUB_WIRELESS_ETH_8021A 0x20
177#define VBOX_PCI_SUB_WIRELESS_ETH_8021B 0x21
178#define VBOX_PCI_SUB_WIRELESS_OTHER 0x80
179
180#define VBOX_PCI_SUB_INTELLIGENT_I20 0x00
181
182#define VBOX_PCI_SUB_SAT_COMM_TV 0x01
183#define VBOX_PCI_SUB_SAT_COMM_AUDIO 0x02
184#define VBOX_PCI_SUB_SAT_COMM_VOICE 0x03
185#define VBOX_PCI_SUB_SAT_COMM_DATA 0x04
186
187#define VBOX_PCI_SUB_ENCRYPT_NETWORK 0x00
188#define VBOX_PCI_SUB_ENCRYPT_ENTERTAINMENT 0x01
189#define VBOX_PCI_SUB_ENCRYPT_OTHER 0x80
190
191#define VBOX_PCI_SUB_SIG_PROC_DPIO 0x00
192#define VBOX_PCI_SUB_SIG_PROC_PERF_COUNTERS 0x01
193#define VBOX_PCI_SUB_SIG_PROC_COMM_SYNC 0x10
194#define VBOX_PCI_SUB_SIG_PROC_MANAGEMENT 0x20
195#define VBOX_PCI_SUB_SIG_PROC_OTHER 0x80
196/** @} */
197
198/**
199 * PCI configuration word 4 (command) and word 6 (status).
200 */
201typedef enum PCICONFIGCOMMAND
202{
203 /** Supports/uses memory accesses. */
204 PCI_COMMAND_IOACCESS = 0x0001,
205 PCI_COMMAND_MEMACCESS = 0x0002,
206 PCI_COMMAND_BUSMASTER = 0x0004
207} PCICONFIGCOMMAND;
208
209
210/**
211 * PCI Address space specification.
212 * This is used when registering a I/O region.
213 */
214/**
215 * Defined by the PCI specification.
216 */
217typedef enum PCIADDRESSSPACE
218{
219 /** Memory. */
220 PCI_ADDRESS_SPACE_MEM = 0x00,
221 /** I/O space. */
222 PCI_ADDRESS_SPACE_IO = 0x01,
223 /** 32-bit BAR. */
224 PCI_ADDRESS_SPACE_BAR32 = 0x00,
225 /** 64-bit BAR. */
226 PCI_ADDRESS_SPACE_BAR64 = 0x04,
227 /** Prefetch memory. */
228 PCI_ADDRESS_SPACE_MEM_PREFETCH = 0x08
229} PCIADDRESSSPACE;
230
231
232
233/** @name PCI Configuration Space Registers
234 * @{ */
235/* Commented out values common for different header types */
236/* Common part of the header */
237#define VBOX_PCI_VENDOR_ID 0x00 /**< 16-bit RO */
238#define VBOX_PCI_DEVICE_ID 0x02 /**< 16-bit RO */
239#define VBOX_PCI_COMMAND 0x04 /**< 16-bit RW, some bits RO */
240#define VBOX_PCI_STATUS 0x06 /**< 16-bit RW, some bits RO */
241#define VBOX_PCI_REVISION_ID 0x08 /**< 8-bit RO - - device revision */
242#define VBOX_PCI_CLASS_PROG 0x09 /**< 8-bit RO - - register-level programming class code (device specific). */
243#define VBOX_PCI_CLASS_SUB 0x0a /**< 8-bit RO - - sub-class code. */
244#define VBOX_PCI_CLASS_DEVICE VBOX_PCI_CLASS_SUB
245#define VBOX_PCI_CLASS_BASE 0x0b /**< 8-bit RO - - base class code. */
246#define VBOX_PCI_CACHE_LINE_SIZE 0x0c /**< 8-bit RW - - system cache line size */
247#define VBOX_PCI_LATENCY_TIMER 0x0d /**< 8-bit RW - - master latency timer, hardwired to 0 for PCIe */
248#define VBOX_PCI_HEADER_TYPE 0x0e /**< 8-bit RO - - header type (0 - device, 1 - bridge, 2 - CardBus bridge) */
249#define VBOX_PCI_BIST 0x0f /**< 8-bit RW - - built-in self test control */
250#define VBOX_PCI_CAPABILITY_LIST 0x34 /**< 8-bit RO? - - linked list of new capabilities implemented by the device, 2 bottom bits reserved */
251#define VBOX_PCI_INTERRUPT_LINE 0x3c /**< 8-bit RW - - interrupt line. */
252#define VBOX_PCI_INTERRUPT_PIN 0x3d /**< 8-bit RO - - interrupt pin. */
253
254/* Type 0 header, device */
255#define VBOX_PCI_BASE_ADDRESS_0 0x10 /**< 32-bit RW */
256#define VBOX_PCI_BASE_ADDRESS_1 0x14 /**< 32-bit RW */
257#define VBOX_PCI_BASE_ADDRESS_2 0x18 /**< 32-bit RW */
258#define VBOX_PCI_BASE_ADDRESS_3 0x1c /**< 32-bit RW */
259#define VBOX_PCI_BASE_ADDRESS_4 0x20 /**< 32-bit RW */
260#define VBOX_PCI_BASE_ADDRESS_5 0x24 /**< 32-bit RW */
261#define VBOX_PCI_CARDBUS_CIS 0x28 /**< 32-bit ?? */
262#define VBOX_PCI_SUBSYSTEM_VENDOR_ID 0x2c /**< 16-bit RO */
263#define VBOX_PCI_SUBSYSTEM_ID 0x2e /**< 16-bit RO */
264#define VBOX_PCI_ROM_ADDRESS 0x30 /**< 32-bit ?? */
265/* #define VBOX_PCI_CAPABILITY_LIST 0x34 */ /**< 8-bit? ?? */
266#define VBOX_PCI_RESERVED_35 0x35 /**< 8-bit ?? - - reserved */
267#define VBOX_PCI_RESERVED_36 0x36 /**< 8-bit ?? - - reserved */
268#define VBOX_PCI_RESERVED_37 0x37 /**< 8-bit ?? - - reserved */
269#define VBOX_PCI_RESERVED_38 0x38 /**< 32-bit ?? - - reserved */
270/* #define VBOX_PCI_INTERRUPT_LINE 0x3c */ /**< 8-bit RW - - interrupt line. */
271/* #define VBOX_PCI_INTERRUPT_PIN 0x3d */ /**< 8-bit RO - - interrupt pin. */
272#define VBOX_PCI_MIN_GNT 0x3e /**< 8-bit RO - - burst period length (in 1/4 microsecond units) */
273#define VBOX_PCI_MAX_LAT 0x3f /**< 8-bit RO - - how often the device needs access to the PCI bus (in 1/4 microsecond units) */
274
275/* Type 1 header, PCI-to-PCI bridge */
276/* #define VBOX_PCI_BASE_ADDRESS_0 0x10 */ /**< 32-bit RW */
277/* #define VBOX_PCI_BASE_ADDRESS_1 0x14 */ /**< 32-bit RW */
278#define VBOX_PCI_PRIMARY_BUS 0x18 /**< 8-bit ?? - - primary bus number. */
279#define VBOX_PCI_SECONDARY_BUS 0x19 /**< 8-bit ?? - - secondary bus number. */
280#define VBOX_PCI_SUBORDINATE_BUS 0x1a /**< 8-bit ?? - - highest subordinate bus number. (behind the bridge) */
281#define VBOX_PCI_SEC_LATENCY_TIMER 0x1b /**< 8-bit ?? - - secondary latency timer. */
282#define VBOX_PCI_IO_BASE 0x1c /**< 8-bit ?? - - I/O range base. */
283#define VBOX_PCI_IO_LIMIT 0x1d /**< 8-bit ?? - - I/O range limit. */
284#define VBOX_PCI_SEC_STATUS 0x1e /**< 16-bit ?? - - secondary status register. */
285#define VBOX_PCI_MEMORY_BASE 0x20 /**< 16-bit ?? - - memory range base. */
286#define VBOX_PCI_MEMORY_LIMIT 0x22 /**< 16-bit ?? - - memory range limit. */
287#define VBOX_PCI_PREF_MEMORY_BASE 0x24 /**< 16-bit ?? - - prefetchable memory range base. */
288#define VBOX_PCI_PREF_MEMORY_LIMIT 0x26 /**< 16-bit ?? - - prefetchable memory range limit. */
289#define VBOX_PCI_PREF_BASE_UPPER32 0x28 /**< 32-bit ?? - - prefetchable memory range high base.*/
290#define VBOX_PCI_PREF_LIMIT_UPPER32 0x2c /**< 32-bit ?? - - prefetchable memory range high limit. */
291#define VBOX_PCI_IO_BASE_UPPER16 0x30 /**< 16-bit ?? - - memory range high base. */
292#define VBOX_PCI_IO_LIMIT_UPPER16 0x32 /**< 16-bit ?? - - memory range high limit. */
293/* #define VBOX_PCI_CAPABILITY_LIST 0x34 */ /**< 8-bit? ?? */
294/* #define VBOX_PCI_RESERVED_35 0x35 */ /**< 8-bit ?? - - reserved */
295/* #define VBOX_PCI_RESERVED_36 0x36 */ /**< 8-bit ?? - - reserved */
296/* #define VBOX_PCI_RESERVED_37 0x37 */ /**< 8-bit ?? - - reserved */
297#define VBOX_PCI_ROM_ADDRESS_BR 0x38 /**< 32-bit ?? - - expansion ROM base address */
298#define VBOX_PCI_BRIDGE_CONTROL 0x3e /**< 16-bit? ?? - - bridge control */
299
300/* Type 2 header, PCI-to-CardBus bridge */
301#define VBOX_PCI_CARDBUS_BASE_ADDRESS 0x10 /**< 32-bit RW - - CardBus Socket/ExCa base address */
302#define VBOX_PCI_CARDBUS_CAPLIST 0x14 /**< 8-bit RO? - - offset of capabilities list */
303#define VBOX_PCI_CARDBUS_RESERVED_15 0x15 /**< 8-bit ?? - - reserved */
304#define VBOX_PCI_CARDBUS_SEC_STATUS 0x16 /**< 16-bit ?? - - secondary status */
305#define VBOX_PCI_CARDBUS_PCIBUS_NUMBER 0x18 /**< 8-bit ?? - - PCI bus number */
306#define VBOX_PCI_CARDBUS_CARDBUS_NUMBER 0x19 /**< 8-bit ?? - - CardBus bus number */
307/* #define VBOX_PCI_SUBORDINATE_BUS 0x1a */ /**< 8-bit ?? - - highest subordinate bus number. (behind the bridge) */
308/* #define VBOX_PCI_SEC_LATENCY_TIMER 0x1b */ /**< 8-bit ?? - - secondary latency timer. */
309#define VBOX_PCI_CARDBUS_MEMORY_BASE0 0x1c /**< 32-bit RW - - memory base address 0 */
310#define VBOX_PCI_CARDBUS_MEMORY_LIMIT0 0x20 /**< 32-bit RW - - memory limit 0 */
311#define VBOX_PCI_CARDBUS_MEMORY_BASE1 0x24 /**< 32-bit RW - - memory base address 1 */
312#define VBOX_PCI_CARDBUS_MEMORY_LIMIT1 0x28 /**< 32-bit RW - - memory limit 1 */
313#define VBOX_PCI_CARDBUS_IO_BASE0 0x2c /**< 32-bit RW - - IO base address 0 */
314#define VBOX_PCI_CARDBUS_IO_LIMIT0 0x30 /**< 32-bit RW - - IO limit 0 */
315#define VBOX_PCI_CARDBUS_IO_BASE1 0x34 /**< 32-bit RW - - IO base address 1 */
316#define VBOX_PCI_CARDBUS_IO_LIMIT1 0x38 /**< 32-bit RW - - IO limit 1 */
317/* #define VBOX_PCI_INTERRUPT_LINE 0x3c */ /**< 8-bit RW - - interrupt line. */
318/* #define VBOX_PCI_INTERRUPT_PIN 0x3d */ /**< 8-bit RO - - interrupt pin. */
319/* #define VBOX_PCI_BRIDGE_CONTROL 0x3e */ /**< 16-bit? ?? - - bridge control */
320/** @} */
321
322
323/* Possible values in status bitmask */
324#define VBOX_PCI_STATUS_CAP_LIST 0x10 /* Support Capability List */
325#define VBOX_PCI_STATUS_66MHZ 0x20 /* Support 66 Mhz PCI 2.1 bus */
326#define VBOX_PCI_STATUS_UDF 0x40 /* Support User Definable Features [obsolete] */
327#define VBOX_PCI_STATUS_FAST_BACK 0x80 /* Accept fast-back to back */
328#define VBOX_PCI_STATUS_PARITY 0x100 /* Detected parity error */
329#define VBOX_PCI_STATUS_DEVSEL_MASK 0x600 /* DEVSEL timing */
330#define VBOX_PCI_STATUS_DEVSEL_FAST 0x000
331#define VBOX_PCI_STATUS_DEVSEL_MEDIUM 0x200
332#define VBOX_PCI_STATUS_DEVSEL_SLOW 0x400
333#define VBOX_PCI_STATUS_SIG_TARGET_ABORT 0x800 /* Set on target abort */
334#define VBOX_PCI_STATUS_REC_TARGET_ABORT 0x1000 /* Master ack of " */
335#define VBOX_PCI_STATUS_REC_MASTER_ABORT 0x2000 /* Set on master abort */
336#define VBOX_PCI_STATUS_SIG_SYSTEM_ERROR 0x4000 /* Set when we drive SERR */
337#define VBOX_PCI_STATUS_DETECTED_PARITY 0x8000 /* Set on parity error */
338
339
340/* Command bitmask */
341#define VBOX_PCI_COMMAND_IO 0x1 /* Enable response in I/O space */
342#define VBOX_PCI_COMMAND_MEMORY 0x2 /* Enable response in Memory space */
343#define VBOX_PCI_COMMAND_MASTER 0x4 /* Enable bus mastering */
344#define VBOX_PCI_COMMAND_SPECIAL 0x8 /* Enable response to special cycles */
345#define VBOX_PCI_COMMAND_INVALIDATE 0x10 /* Use memory write and invalidate */
346#define VBOX_PCI_COMMAND_VGA_PALETTE 0x20 /* Enable palette snooping */
347#define VBOX_PCI_COMMAND_PARITY 0x40 /* Enable parity checking */
348#define VBOX_PCI_COMMAND_WAIT 0x80 /* Enable address/data stepping */
349#define VBOX_PCI_COMMAND_SERR 0x100 /* Enable SERR */
350#define VBOX_PCI_COMMAND_FAST_BACK 0x200 /* Enable back-to-back writes */
351#define VBOX_PCI_COMMAND_INTX_DISABLE 0x400 /* INTx Emulation Disable */
352
353
354/* Capability list values (capability offset 0) */
355/* Next value pointer in offset 1, or 0 if none */
356#define VBOX_PCI_CAP_ID_PM 0x01 /* Power Management */
357#define VBOX_PCI_CAP_ID_AGP 0x02 /* Accelerated Graphics Port */
358#define VBOX_PCI_CAP_ID_VPD 0x03 /* Vital Product Data */
359#define VBOX_PCI_CAP_ID_SLOTID 0x04 /* Slot Identification */
360#define VBOX_PCI_CAP_ID_MSI 0x05 /* Message Signalled Interrupts */
361#define VBOX_PCI_CAP_ID_CHSWP 0x06 /* CompactPCI HotSwap */
362#define VBOX_PCI_CAP_ID_PCIX 0x07 /* PCI-X */
363#define VBOX_PCI_CAP_ID_HT 0x08 /* HyperTransport */
364#define VBOX_PCI_CAP_ID_VNDR 0x09 /* Vendor specific */
365#define VBOX_PCI_CAP_ID_DBG 0x0A /* Debug port */
366#define VBOX_PCI_CAP_ID_CCRC 0x0B /* CompactPCI Central Resource Control */
367#define VBOX_PCI_CAP_ID_SHPC 0x0C /* PCI Standard Hot-Plug Controller */
368#define VBOX_PCI_CAP_ID_SSVID 0x0D /* Bridge subsystem vendor/device ID */
369#define VBOX_PCI_CAP_ID_AGP3 0x0E /* AGP Target PCI-PCI bridge */
370#define VBOX_PCI_CAP_ID_SECURE 0x0F /* Secure device (?) */
371#define VBOX_PCI_CAP_ID_EXP 0x10 /* PCI Express */
372#define VBOX_PCI_CAP_ID_MSIX 0x11 /* MSI-X */
373#define VBOX_PCI_CAP_ID_SATA 0x12 /* Serial-ATA HBA */
374#define VBOX_PCI_CAP_ID_AF 0x13 /* PCI Advanced Features */
375
376/* Extended Capabilities (PCI-X 2.0 and Express), start at 0x100, next - bits [20..32] */
377#define VBOX_PCI_EXT_CAP_ID_ERR 0x01 /* Advanced Error Reporting */
378#define VBOX_PCI_EXT_CAP_ID_VC 0x02 /* Virtual Channel */
379#define VBOX_PCI_EXT_CAP_ID_DSN 0x03 /* Device Serial Number */
380#define VBOX_PCI_EXT_CAP_ID_PWR 0x04 /* Power Budgeting */
381#define VBOX_PCI_EXT_CAP_ID_RCLINK 0x05 /* Root Complex Link Declaration */
382#define VBOX_PCI_EXT_CAP_ID_RCILINK 0x06 /* Root Complex Internal Link Declaration */
383#define VBOX_PCI_EXT_CAP_ID_RCECOLL 0x07 /* Root Complex Event Collector */
384#define VBOX_PCI_EXT_CAP_ID_MFVC 0x08 /* Multi-Function Virtual Channel */
385#define VBOX_PCI_EXT_CAP_ID_RBCB 0x0a /* Root Bridge Control Block */
386#define VBOX_PCI_EXT_CAP_ID_VNDR 0x0b /* Vendor specific */
387#define VBOX_PCI_EXT_CAP_ID_ACS 0x0d /* Access Controls */
388#define VBOX_PCI_EXT_CAP_ID_ARI 0x0e
389#define VBOX_PCI_EXT_CAP_ID_ATS 0x0f
390#define VBOX_PCI_EXT_CAP_ID_SRIOV 0x10
391
392
393/* MSI flags, aka Message Control (2 bytes, capability offset 2) */
394#define VBOX_PCI_MSI_FLAGS_ENABLE 0x0001 /* MSI feature enabled */
395#define VBOX_PCI_MSI_FLAGS_64BIT 0x0080 /* 64-bit addresses allowed */
396#define VBOX_PCI_MSI_FLAGS_MASKBIT 0x0100 /* Per-vector masking support */
397/* Encoding for 3-bit patterns for message queue (per chapter 6.8.1 of PCI spec),
398 someone very similar to log_2().
399 000 1
400 001 2
401 010 4
402 011 8
403 100 16
404 101 32
405 110 Reserved
406 111 Reserved */
407#define VBOX_PCI_MSI_FLAGS_QSIZE 0x0070 /* Message queue size configured (i.e. vectors per device allocated) */
408#define VBOX_PCI_MSI_FLAGS_QMASK 0x000e /* Maximum queue size available (i.e. vectors per device possible) */
409
410/* MSI-X flags (2 bytes, capability offset 2) */
411#define VBOX_PCI_MSIX_FLAGS_ENABLE 0x8000 /* MSI-X enable */
412#define VBOX_PCI_MSIX_FLAGS_FUNCMASK 0x4000 /* Function mask */
413
414/* Power management flags (2 bytes, capability offset 2) */
415#define VBOX_PCI_PM_CAP_VER_MASK 0x0007 /* Version mask */
416#define VBOX_PCI_PM_CAP_PME_CLOCK 0x0008 /* PME clock required */
417#define VBOX_PCI_PM_CAP_RESERVED 0x0010 /* Reserved field */
418#define VBOX_PCI_PM_CAP_DSI 0x0020 /* Device specific initialization */
419#define VBOX_PCI_PM_CAP_AUX_POWER 0x01C0 /* Auxilliary power support mask */
420#define VBOX_PCI_PM_CAP_D1 0x0200 /* D1 power state support */
421#define VBOX_PCI_PM_CAP_D2 0x0400 /* D2 power state support */
422#define VBOX_PCI_PM_CAP_PME 0x0800 /* PME pin supported */
423#define VBOX_PCI_PM_CAP_PME_MASK 0xF800 /* PME Mask of all supported states */
424#define VBOX_PCI_PM_CAP_PME_D0 0x0800 /* PME# from D0 */
425#define VBOX_PCI_PM_CAP_PME_D1 0x1000 /* PME# from D1 */
426#define VBOX_PCI_PM_CAP_PME_D2 0x2000 /* PME# from D2 */
427#define VBOX_PCI_PM_CAP_PME_D3 0x4000 /* PME# from D3 (hot) */
428#define VBOX_PCI_PM_CAP_PME_D3cold 0x8000 /* PME# from D3 (cold) */
429
430/* Power management control flags (2 bytes, capability offset 4) */
431#define VBOX_PCI_PM_CTRL_STATE_MASK 0x0003 /* Current power state (D0 to D3) */
432#define VBOX_PCI_PM_CTRL_NO_SOFT_RESET 0x0008 /* No reset for D3hot->D0 */
433#define VBOX_PCI_PM_CTRL_PME_ENABLE 0x0100 /* PME pin enable */
434#define VBOX_PCI_PM_CTRL_DATA_SEL_MASK 0x1e00 /* Data select (??) */
435#define VBOX_PCI_PM_CTRL_DATA_SCALE_MASK 0x6000 /* Data scale (??) */
436#define VBOX_PCI_PM_CTRL_PME_STATUS 0x8000 /* PME pin status */
437
438/* PCI-X config flags (2 bytes, capability offset 2) */
439#define VBOX_PCI_X_CMD_DPERR_E 0x0001 /* Data Parity Error Recovery Enable */
440#define VBOX_PCI_X_CMD_ERO 0x0002 /* Enable Relaxed Ordering */
441#define VBOX_PCI_X_CMD_MAX_OUTSTANDING_SPLIT_TRANS 0x0070
442#define VBOX_PCI_X_CMD_READ_512 0x0000 /* 512 byte maximum read byte count */
443#define VBOX_PCI_X_CMD_READ_1K 0x0004 /* 1Kbyte maximum read byte count */
444#define VBOX_PCI_X_CMD_READ_2K 0x0008 /* 2Kbyte maximum read byte count */
445#define VBOX_PCI_X_CMD_READ_4K 0x000c /* 4Kbyte maximum read byte count */
446#define VBOX_PCI_X_CMD_MAX_READ 0x000c /* Max Memory Read Byte Count */
447
448/* PCI-X config flags (4 bytes, capability offset 4) */
449#define VBOX_PCI_X_STATUS_DEVFN 0x000000ff /* A copy of devfn */
450#define VBOX_PCI_X_STATUS_BUS 0x0000ff00 /* A copy of bus nr */
451#define VBOX_PCI_X_STATUS_64BIT 0x00010000 /* 64-bit device */
452#define VBOX_PCI_X_STATUS_133MHZ 0x00020000 /* 133 MHz capable */
453#define VBOX_PCI_X_STATUS_SPL_DISC 0x00040000 /* Split Completion Discarded */
454#define VBOX_PCI_X_STATUS_UNX_SPL 0x00080000 /* Unexpected Split Completion */
455#define VBOX_PCI_X_STATUS_COMPLEX 0x00100000 /* Device Complexity, 0 = simple device, 1 = bridge device */
456#define VBOX_PCI_X_STATUS_MAX_READ 0x00600000 /* Designed Max Memory Read Count, 0 = 512 bytes, 1 = 1024, 2 = 2048, 3 = 4096 */
457#define VBOX_PCI_X_STATUS_MAX_SPLIT 0x03800000 /* Designed Max Outstanding Split Transactions */
458#define VBOX_PCI_X_STATUS_MAX_CUM 0x1c000000 /* Designed Max Cumulative Read Size */
459#define VBOX_PCI_X_STATUS_SPL_ERR 0x20000000 /* Rcvd Split Completion Error Msg */
460#define VBOX_PCI_X_STATUS_266MHZ 0x40000000 /* 266 MHz capable */
461#define VBOX_PCI_X_STATUS_533MHZ 0x80000000 /* 533 MHz capable */
462
463/* PCI Express config flags (2 bytes, capability offset 2) */
464#define VBOX_PCI_EXP_FLAGS_VERS 0x000f /* Capability version */
465#define VBOX_PCI_EXP_FLAGS_TYPE 0x00f0 /* Device/Port type */
466#define VBOX_PCI_EXP_TYPE_ENDPOINT 0x0 /* Express Endpoint */
467#define VBOX_PCI_EXP_TYPE_LEG_END 0x1 /* Legacy Endpoint */
468#define VBOX_PCI_EXP_TYPE_ROOT_PORT 0x4 /* Root Port */
469#define VBOX_PCI_EXP_TYPE_UPSTREAM 0x5 /* Upstream Port */
470#define VBOX_PCI_EXP_TYPE_DOWNSTREAM 0x6 /* Downstream Port */
471#define VBOX_PCI_EXP_TYPE_PCI_BRIDGE 0x7 /* PCI/PCI-X Bridge */
472#define VBOX_PCI_EXP_TYPE_PCIE_BRIDGE 0x8 /* PCI/PCI-X to PCIE Bridge */
473#define VBOX_PCI_EXP_TYPE_ROOT_INT_EP 0x9 /* Root Complex Integrated Endpoint */
474#define VBOX_PCI_EXP_TYPE_ROOT_EC 0xa /* Root Complex Event Collector */
475#define VBOX_PCI_EXP_FLAGS_SLOT 0x0100 /* Slot implemented */
476#define VBOX_PCI_EXP_FLAGS_IRQ 0x3e00 /* Interrupt message number */
477
478/* PCI Express device capabilities (4 bytes, capability offset 4) */
479#define VBOX_PCI_EXP_DEVCAP_PAYLOAD 0x07 /* Max_Payload_Size */
480#define VBOX_PCI_EXP_DEVCAP_PHANTOM 0x18 /* Phantom functions */
481#define VBOX_PCI_EXP_DEVCAP_EXT_TAG 0x20 /* Extended tags */
482#define VBOX_PCI_EXP_DEVCAP_L0S 0x1c0 /* L0s Acceptable Latency */
483#define VBOX_PCI_EXP_DEVCAP_L1 0xe00 /* L1 Acceptable Latency */
484#define VBOX_PCI_EXP_DEVCAP_ATN_BUT 0x1000 /* Attention Button Present */
485#define VBOX_PCI_EXP_DEVCAP_ATN_IND 0x2000 /* Attention Indicator Present */
486#define VBOX_PCI_EXP_DEVCAP_PWR_IND 0x4000 /* Power Indicator Present */
487#define VBOX_PCI_EXP_DEVCAP_RBE 0x8000 /* Role-Based Error Reporting */
488#define VBOX_PCI_EXP_DEVCAP_PWR_VAL 0x3fc0000 /* Slot Power Limit Value */
489#define VBOX_PCI_EXP_DEVCAP_PWR_SCL 0xc000000 /* Slot Power Limit Scale */
490#define VBOX_PCI_EXP_DEVCAP_FLRESET 0x10000000 /* Function-Level Reset */
491
492/* PCI Express device control (2 bytes, capability offset 8) */
493#define VBOX_PCI_EXP_DEVCTL_CERE 0x0001 /* Correctable Error Reporting En. */
494#define VBOX_PCI_EXP_DEVCTL_NFERE 0x0002 /* Non-Fatal Error Reporting Enable */
495#define VBOX_PCI_EXP_DEVCTL_FERE 0x0004 /* Fatal Error Reporting Enable */
496#define VBOX_PCI_EXP_DEVCTL_URRE 0x0008 /* Unsupported Request Reporting En. */
497#define VBOX_PCI_EXP_DEVCTL_RELAXED 0x0010 /* Enable Relaxed Ordering */
498#define VBOX_PCI_EXP_DEVCTL_PAYLOAD 0x00e0 /* Max_Payload_Size */
499#define VBOX_PCI_EXP_DEVCTL_EXT_TAG 0x0100 /* Extended Tag Field Enable */
500#define VBOX_PCI_EXP_DEVCTL_PHANTOM 0x0200 /* Phantom Functions Enable */
501#define VBOX_PCI_EXP_DEVCTL_AUX_PME 0x0400 /* Auxiliary Power PM Enable */
502#define VBOX_PCI_EXP_DEVCTL_NOSNOOP 0x0800 /* Enable No Snoop */
503#define VBOX_PCI_EXP_DEVCTL_READRQ 0x7000 /* Max_Read_Request_Size */
504#define VBOX_PCI_EXP_DEVCTL_BCRE 0x8000 /* Bridge Configuration Retry Enable */
505#define VBOX_PCI_EXP_DEVCTL_FLRESET 0x8000 /* Function-Level Reset [bit shared with BCRE] */
506
507/* PCI Express device status (2 bytes, capability offset 10) */
508#define VBOX_PCI_EXP_DEVSTA_CED 0x01 /* Correctable Error Detected */
509#define VBOX_PCI_EXP_DEVSTA_NFED 0x02 /* Non-Fatal Error Detected */
510#define VBOX_PCI_EXP_DEVSTA_FED 0x04 /* Fatal Error Detected */
511#define VBOX_PCI_EXP_DEVSTA_URD 0x08 /* Unsupported Request Detected */
512#define VBOX_PCI_EXP_DEVSTA_AUXPD 0x10 /* AUX Power Detected */
513#define VBOX_PCI_EXP_DEVSTA_TRPND 0x20 /* Transactions Pending */
514
515/* PCI Express link capabilities (4 bytes, capability offset 12) */
516#define VBOX_PCI_EXP_LNKCAP_SPEED 0x0000f /* Maximum Link Speed */
517#define VBOX_PCI_EXP_LNKCAP_WIDTH 0x003f0 /* Maximum Link Width */
518#define VBOX_PCI_EXP_LNKCAP_ASPM 0x00c00 /* Active State Power Management */
519#define VBOX_PCI_EXP_LNKCAP_L0S 0x07000 /* L0s Acceptable Latency */
520#define VBOX_PCI_EXP_LNKCAP_L1 0x38000 /* L1 Acceptable Latency */
521#define VBOX_PCI_EXP_LNKCAP_CLOCKPM 0x40000 /* Clock Power Management */
522#define VBOX_PCI_EXP_LNKCAP_SURPRISE 0x80000 /* Surprise Down Error Reporting */
523#define VBOX_PCI_EXP_LNKCAP_DLLA 0x100000 /* Data Link Layer Active Reporting */
524#define VBOX_PCI_EXP_LNKCAP_LBNC 0x200000 /* Link Bandwidth Notification Capability */
525#define VBOX_PCI_EXP_LNKCAP_PORT 0xff000000 /* Port Number */
526
527/* PCI Express link control (2 bytes, capability offset 16) */
528#define VBOX_PCI_EXP_LNKCTL_ASPM 0x0003 /* ASPM Control */
529#define VBOX_PCI_EXP_LNKCTL_RCB 0x0008 /* Read Completion Boundary */
530#define VBOX_PCI_EXP_LNKCTL_DISABLE 0x0010 /* Link Disable */
531#define VBOX_PCI_EXP_LNKCTL_RETRAIN 0x0020 /* Retrain Link */
532#define VBOX_PCI_EXP_LNKCTL_CLOCK 0x0040 /* Common Clock Configuration */
533#define VBOX_PCI_EXP_LNKCTL_XSYNCH 0x0080 /* Extended Synch */
534#define VBOX_PCI_EXP_LNKCTL_CLOCKPM 0x0100 /* Clock Power Management */
535#define VBOX_PCI_EXP_LNKCTL_HWAUTWD 0x0200 /* Hardware Autonomous Width Disable */
536#define VBOX_PCI_EXP_LNKCTL_BWMIE 0x0400 /* Bandwidth Mgmt Interrupt Enable */
537#define VBOX_PCI_EXP_LNKCTL_AUTBWIE 0x0800 /* Autonomous Bandwidth Mgmt Interrupt Enable */
538
539/* PCI Express link status (2 bytes, capability offset 18) */
540#define VBOX_PCI_EXP_LNKSTA_SPEED 0x000f /* Negotiated Link Speed */
541#define VBOX_PCI_EXP_LNKSTA_WIDTH 0x03f0 /* Negotiated Link Width */
542#define VBOX_PCI_EXP_LNKSTA_TR_ERR 0x0400 /* Training Error (obsolete) */
543#define VBOX_PCI_EXP_LNKSTA_TRAIN 0x0800 /* Link Training */
544#define VBOX_PCI_EXP_LNKSTA_SL_CLK 0x1000 /* Slot Clock Configuration */
545#define VBOX_PCI_EXP_LNKSTA_DL_ACT 0x2000 /* Data Link Layer in DL_Active State */
546#define VBOX_PCI_EXP_LNKSTA_BWMGMT 0x4000 /* Bandwidth Mgmt Status */
547#define VBOX_PCI_EXP_LNKSTA_AUTBW 0x8000 /* Autonomous Bandwidth Mgmt Status */
548
549/* PCI Express slot capabilities (4 bytes, capability offset 20) */
550#define VBOX_PCI_EXP_SLTCAP_ATNB 0x0001 /* Attention Button Present */
551#define VBOX_PCI_EXP_SLTCAP_PWRC 0x0002 /* Power Controller Present */
552#define VBOX_PCI_EXP_SLTCAP_MRL 0x0004 /* MRL Sensor Present */
553#define VBOX_PCI_EXP_SLTCAP_ATNI 0x0008 /* Attention Indicator Present */
554#define VBOX_PCI_EXP_SLTCAP_PWRI 0x0010 /* Power Indicator Present */
555#define VBOX_PCI_EXP_SLTCAP_HPS 0x0020 /* Hot-Plug Surprise */
556#define VBOX_PCI_EXP_SLTCAP_HPC 0x0040 /* Hot-Plug Capable */
557#define VBOX_PCI_EXP_SLTCAP_PWR_VAL 0x00007f80 /* Slot Power Limit Value */
558#define VBOX_PCI_EXP_SLTCAP_PWR_SCL 0x00018000 /* Slot Power Limit Scale */
559#define VBOX_PCI_EXP_SLTCAP_INTERLOCK 0x020000 /* Electromechanical Interlock Present */
560#define VBOX_PCI_EXP_SLTCAP_NOCMDCOMP 0x040000 /* No Command Completed Support */
561#define VBOX_PCI_EXP_SLTCAP_PSN 0xfff80000 /* Physical Slot Number */
562
563/* PCI Express slot control (2 bytes, capability offset 24) */
564#define VBOX_PCI_EXP_SLTCTL_ATNB 0x0001 /* Attention Button Pressed Enable */
565#define VBOX_PCI_EXP_SLTCTL_PWRF 0x0002 /* Power Fault Detected Enable */
566#define VBOX_PCI_EXP_SLTCTL_MRLS 0x0004 /* MRL Sensor Changed Enable */
567#define VBOX_PCI_EXP_SLTCTL_PRSD 0x0008 /* Presence Detect Changed Enable */
568#define VBOX_PCI_EXP_SLTCTL_CMDC 0x0010 /* Command Completed Interrupt Enable */
569#define VBOX_PCI_EXP_SLTCTL_HPIE 0x0020 /* Hot-Plug Interrupt Enable */
570#define VBOX_PCI_EXP_SLTCTL_ATNI 0x00c0 /* Attention Indicator Control */
571#define VBOX_PCI_EXP_SLTCTL_PWRI 0x0300 /* Power Indicator Control */
572#define VBOX_PCI_EXP_SLTCTL_PWRC 0x0400 /* Power Controller Control */
573#define VBOX_PCI_EXP_SLTCTL_INTERLOCK 0x0800 /* Electromechanical Interlock Control */
574#define VBOX_PCI_EXP_SLTCTL_LLCHG 0x1000 /* Data Link Layer State Changed Enable */
575
576/* PCI Express slot status (2 bytes, capability offset 26) */
577#define VBOX_PCI_EXP_SLTSTA_ATNB 0x0001 /* Attention Button Pressed */
578#define VBOX_PCI_EXP_SLTSTA_PWRF 0x0002 /* Power Fault Detected */
579#define VBOX_PCI_EXP_SLTSTA_MRLS 0x0004 /* MRL Sensor Changed */
580#define VBOX_PCI_EXP_SLTSTA_PRSD 0x0008 /* Presence Detect Changed */
581#define VBOX_PCI_EXP_SLTSTA_CMDC 0x0010 /* Command Completed */
582#define VBOX_PCI_EXP_SLTSTA_MRL_ST 0x0020 /* MRL Sensor State */
583#define VBOX_PCI_EXP_SLTSTA_PRES 0x0040 /* Presence Detect State */
584#define VBOX_PCI_EXP_SLTSTA_INTERLOCK 0x0080 /* Electromechanical Interlock Status */
585#define VBOX_PCI_EXP_SLTSTA_LLCHG 0x0100 /* Data Link Layer State Changed */
586
587/* PCI Express root control (2 bytes, capability offset 28) */
588#define VBOX_PCI_EXP_RTCTL_SECEE 0x0001 /* System Error on Correctable Error */
589#define VBOX_PCI_EXP_RTCTL_SENFEE 0x0002 /* System Error on Non-Fatal Error */
590#define VBOX_PCI_EXP_RTCTL_SEFEE 0x0004 /* System Error on Fatal Error */
591#define VBOX_PCI_EXP_RTCTL_PMEIE 0x0008 /* PME Interrupt Enable */
592#define VBOX_PCI_EXP_RTCTL_CRSVIS 0x0010 /* Configuration Request Retry Status Visible to SW */
593
594/* PCI Express root capabilities (2 bytes, capability offset 30) */
595#define VBOX_PCI_EXP_RTCAP_CRSVIS 0x0010 /* Configuration Request Retry Status Visible to SW */
596
597/* PCI Express root status (4 bytes, capability offset 32) */
598#define VBOX_PCI_EXP_RTSTA_PME_REQID 0x0000ffff /* PME Requester ID */
599#define VBOX_PCI_EXP_RTSTA_PME_STATUS 0x00010000 /* PME Status */
600#define VBOX_PCI_EXP_RTSTA_PME_PENDING 0x00020000 /* PME is Pending */
601
602
603/** Fixed I/O region number for ROM. */
604#define VBOX_PCI_ROM_SLOT 6
605/** Max number of I/O regions. */
606#define VBOX_PCI_NUM_REGIONS 7
607
608#define PCI_ROM_SLOT VBOX_PCI_ROM_SLOT /**< deprecated */
609#define PCI_NUM_REGIONS VBOX_PCI_NUM_REGIONS /**< deprecated */
610
611/** Number of functions per device. */
612#define VBOX_PCI_MAX_FUNCTIONS 8
613/** Number of devices per bus. */
614#define VBOX_PCI_MAX_DEVICES 32
615/** The function number mask for a device+function number. */
616#define VBOX_PCI_DEVFN_FUN_MASK 0x7
617/** The device number shift count for a device+function number. */
618#define VBOX_PCI_DEVFN_DEV_SHIFT 3
619/** The device number mask for a device+function number. */
620#define VBOX_PCI_DEVFN_DEV_MASK 0x1f
621/** The bus number shift count for a bus+device+function number. */
622#define VBOX_PCI_BUS_SHIFT 0x8
623/** The bus number mask a bus+device+function number. */
624#define VBOX_PCI_BUS_MASK 0xff
625/** Make a device+function number. */
626#define VBOX_PCI_DEVFN_MAKE(a_uPciDevNo, a_uPciFunNo) ( ((a_uPciDevNo) << VBOX_PCI_DEVFN_DEV_SHIFT) \
627 | ((a_uPciFunNo) & VBOX_PCI_DEVFN_FUN_MASK))
628
629/** Checks whether the PCIBDF is valid. */
630#define PCIBDF_IS_VALID(a_uBusDevFn) (!((a_uBusDevFn) & PCI_BDF_F_INVALID))
631/** Make a PCIBDF given the bus and device:function. */
632#define PCIBDF_MAKE(a_uBus, a_uDevFn) (((a_uBus) << VBOX_PCI_BUS_SHIFT) | (a_uDevFn))
633
634/** Southbridge I/O APIC (w/ AMD IOMMU): Bus. */
635#define VBOX_PCI_BUS_SB_IOAPIC 0
636/** Southbridge I/O APIC (w/ AMD IOMMU): Device. */
637#define VBOX_PCI_DEV_SB_IOAPIC 0x14
638/** Southbridge I/O APIC (w/ AMD IOMMU): Function. */
639#define VBOX_PCI_FN_SB_IOAPIC 0
640/** PCI BDF (hardcoded by linux guests) reserved for the SB I/O APIC when using VMs
641 * with an AMD IOMMU. */
642#define VBOX_PCI_BDF_SB_IOAPIC PCIBDF_MAKE(VBOX_PCI_BUS_SB_IOAPIC, \
643 VBOX_PCI_DEVFN_MAKE(VBOX_PCI_DEV_SB_IOAPIC, VBOX_PCI_FN_SB_IOAPIC))
644
645#if defined(__cplusplus) && defined(IN_RING3)
646/* For RTStrPrintf(). */
647# include <iprt/string.h>
648
649/**
650 * Class representing PCI address. PCI device consist of
651 * bus, device and function numbers. Generally device PCI
652 * address could be changed during runtime, but only by
653 * an OS PCI driver.
654 *
655 * @remarks C++ classes (structs included) are not generally accepted in
656 * VMM devices or drivers. An exception may be granted for this class
657 * if it's contained to ring-3 and that this is a one time exception
658 * which sets no precedent.
659 */
660struct PCIBusAddress
661{
662 /** @todo: think if we'll need domain, which is higher
663 * word of the address. */
664 int miBus;
665 int miDevice;
666 int miFn;
667
668 PCIBusAddress()
669 {
670 clear();
671 }
672
673 PCIBusAddress(int iBus, int iDevice, int iFn)
674 {
675 init(iBus, iDevice, iFn);
676 }
677
678 PCIBusAddress(int32_t iAddr)
679 {
680 clear();
681 fromLong(iAddr);
682 }
683
684 PCIBusAddress& clear()
685 {
686 miBus = miDevice = miFn = -1;
687 return *this;
688 }
689
690 void init(int iBus, int iDevice, int iFn)
691 {
692 miBus = iBus;
693 miDevice = iDevice;
694 miFn = iFn;
695 }
696
697 void init(const PCIBusAddress &a)
698 {
699 miBus = a.miBus;
700 miDevice = a.miDevice;
701 miFn = a.miFn;
702 }
703
704 bool operator<(const PCIBusAddress &a) const
705 {
706 if (miBus < a.miBus)
707 return true;
708
709 if (miBus > a.miBus)
710 return false;
711
712 if (miDevice < a.miDevice)
713 return true;
714
715 if (miDevice > a.miDevice)
716 return false;
717
718 if (miFn < a.miFn)
719 return true;
720
721 if (miFn > a.miFn)
722 return false;
723
724 return false;
725 }
726
727 bool operator==(const PCIBusAddress &a) const
728 {
729 return (miBus == a.miBus)
730 && (miDevice == a.miDevice)
731 && (miFn == a.miFn);
732 }
733
734 bool operator!=(const PCIBusAddress &a) const
735 {
736 return (miBus != a.miBus)
737 || (miDevice != a.miDevice)
738 || (miFn != a.miFn);
739 }
740
741 bool valid() const
742 {
743 return (miBus != -1)
744 && (miDevice != -1)
745 && (miFn != -1);
746 }
747
748 int32_t asLong() const
749 {
750 Assert(valid());
751 return (miBus << 8) | (miDevice << 3) | miFn;
752 }
753
754 PCIBusAddress& fromLong(int32_t value)
755 {
756 miBus = (value >> 8) & 0xff;
757 miDevice = (value & 0xff) >> 3;
758 miFn = (value & 7);
759 return *this;
760 }
761
762 /** Create string representation of this PCI address. */
763 bool format(char* szBuf, int32_t cBufSize)
764 {
765 if (cBufSize < (/* bus */ 2 + /* : */ 1 + /* device */ 2 + /* . */ 1 + /* function*/ 1 + /* \0 */1))
766 return false;
767
768 if (valid())
769 RTStrPrintf(szBuf, cBufSize, "%02x:%02x.%01x", miBus, miDevice, miFn);
770 else
771 RTStrPrintf(szBuf, cBufSize, "%s", "<bad>");
772
773 return true;
774 }
775
776 static const size_t cMaxAddrSize = 10;
777};
778
779#endif /* __cplusplus && IN_RING3 */
780
781/** @} */
782
783#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