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