Skip to content

Commit 879cf5d

Browse files
Goldfish64Goldfish64
committed
Docs: Move boot args to separate page
1 parent fc424c5 commit 879cf5d

3 files changed

Lines changed: 144 additions & 17 deletions

File tree

‎Docs/modules.md‎

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
# Driver Module List
2+
3+
## Core Controller (HyperVController)
4+
Core Hyper-V controller module.
5+
6+
| Boot argument | Description |
7+
|----------------|-------------|
8+
| -hvctrldbg | Enables debug printing in DEBUG builds
9+
10+
## CPU Disabler (HyperVCPU)
11+
Disables additional CPUs under macOS 10.4.
12+
13+
| Boot argument | Description |
14+
|----------------|-------------|
15+
| -hvcpudbg | Enables debug printing in DEBUG builds
16+
17+
## File Copy (HyperVFileCopy)
18+
Provides host to guest file copy support (Guest Services). Requires the `hvfilecopyd` userspace daemon to be running.
19+
20+
| Boot argument | Description |
21+
|----------------|-------------|
22+
| -hvfcopydbg | Enables debug printing in DEBUG builds
23+
| -hvfcopymsgdbg | Enables debug printing of message data in DEBUG builds
24+
| -hvfcopyoff | Disables this module
25+
26+
## Graphics Bridge (HyperVGraphicsBridge)
27+
Provides basic graphics support for macOS.
28+
29+
| Boot argument | Description |
30+
|----------------|-------------|
31+
| -hvgfxbdbg | Enables debug printing in DEBUG builds
32+
| -hvgfxbmsgdbg | Enables debug printing of message data in DEBUG builds
33+
| -hvgfxboff | Disables this module
34+
35+
## Heartbeat (HyperVHeartbeat)
36+
Provides heartbeat reporting to Hyper-V.
37+
38+
| Boot argument | Description |
39+
|----------------|-------------|
40+
| -hvheartdbg | Enables debug printing in DEBUG builds
41+
| -hvheartmsgdbg | Enables debug printing of message data in DEBUG builds
42+
| -hvheartoff | Disables this module
43+
44+
## Keyboard (HyperVKeyboard)
45+
Provides keyboard support.
46+
47+
| Boot argument | Description |
48+
|----------------|-------------|
49+
| -hvkbddbg | Enables debug printing in DEBUG builds
50+
| -hvkbdmsgdbg | Enables debug printing of message data in DEBUG builds
51+
| -hvkbdoff | Disables this module
52+
53+
## Mouse (HyperVMouse)
54+
Provides mouse support.
55+
56+
| Boot argument | Description |
57+
|----------------|-------------|
58+
| -hvmousdbg | Enables debug printing in DEBUG builds
59+
| -hvmousmsgdbg | Enables debug printing of message data in DEBUG builds
60+
| -hvmousoff | Disables this module
61+
62+
## Network (HyperVNetwork)
63+
Provides networking support.
64+
65+
| Boot argument | Description |
66+
|----------------|-------------|
67+
| -hvnetdbg | Enables debug printing in DEBUG builds
68+
| -hvnetmsgdbg | Enables debug printing of message data in DEBUG builds
69+
| -hvnetoff | Disables this module
70+
71+
## PCI Bridge (HyperVPCIBridge)
72+
Provides PCI passthrough support.
73+
74+
| Boot argument | Description |
75+
|----------------|-------------|
76+
| -hvpcibdbg | Enables debug printing in DEBUG builds
77+
| -hvpcibmsgdbg | Enables debug printing of message data in DEBUG builds
78+
| -hvpciboff | Disables this module
79+
80+
## PCI Module Device (HyperVModuleDevice)
81+
Provides MMIO allocation/deallocation functions for PCI passthrough.
82+
83+
| Boot argument | Description |
84+
|----------------|-------------|
85+
| -hvpcimdbg | Enables debug printing in DEBUG builds
86+
87+
## PCI Provider (HyperVPCIProvider)
88+
Provides IOACPIPlatformDevice nub on generation 2 VMS for fake PCI root bridge (HyperVPCIRoot).
89+
90+
| Boot argument | Description |
91+
|----------------|-------------|
92+
| -hvpcipdbg | Enables debug printing in DEBUG builds
93+
94+
## PCI Root Bridge (HyperVPCIRoot)
95+
Provides a fake PCI root bridge for proper macOS functionality on generation 2 VMs, and provides support for PCI passthrough.
96+
97+
| Boot argument | Description |
98+
|----------------|-------------|
99+
| -hvpcirdbg | Enables debug printing in DEBUG builds
100+
101+
## Shutdown (HyperVShutdown)
102+
Provides software shutdown through Virtual Machine Connection and PowerShell. Requires the `hvshutdownd` userspace daemon to be running.
103+
104+
| Boot argument | Description |
105+
|----------------|-------------|
106+
| -hvshutdbg | Enables debug printing in DEBUG builds
107+
| -hvshutmsgdbg | Enables debug printing of message data in DEBUG builds
108+
| -hvshutoff | Disables this module
109+
110+
## Storage (HyperVStorage)
111+
Provides SCSI storage support.
112+
113+
| Boot argument | Description |
114+
|----------------|-------------|
115+
| -hvstordbg | Enables debug printing in DEBUG builds
116+
| -hvstormsgdbg | Enables debug printing of message data in DEBUG builds
117+
| -hvstoroff | Disables this module
118+
119+
## Time Synchronization (HyperVTimeSync)
120+
Provides host to guest time synchronization support. Requires the `hvtimesyncd` userspace daemon to be running.
121+
122+
| Boot argument | Description |
123+
|----------------|-------------|
124+
| -hvtimedbg | Enables debug printing in DEBUG builds
125+
| -hvtimemsgdbg | Enables debug printing of message data in DEBUG builds
126+
| -hvtimeoff | Disables this module
127+
128+
## VMBus Controller (HyperVVMBus)
129+
Provides root of VMBus devices and services.
130+
131+
| Boot argument | Description |
132+
|----------------|-------------|
133+
| -hvvmbusdbg | Enables debug printing in DEBUG builds
134+
| -hvvmbusnocpu | Force all channels to use CPU 0 on Windows Server 2012 / Windows 8 and newer.
135+
136+
## VMBus Device Nub (HyperVVMBusDevice)
137+
Provides connection nub for child VMBus device modules.
138+
139+
| Boot argument | Description |
140+
|----------------|-------------|
141+
| -hvvmbusdebdbg | Enables debug printing in DEBUG builds

‎MacHyperVSupport.xcodeproj/project.pbxproj‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -352,6 +352,7 @@
352352
41E2EC77263F894300BBE18F /* HyperVControllerInterrupts.cpp */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.cpp; path = HyperVControllerInterrupts.cpp; sourceTree = "<group>"; };
353353
41E5E20A28C5766700E6E84F /* HyperVController.cpp */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.cpp; path = HyperVController.cpp; sourceTree = "<group>"; };
354354
41E5E20B28C5766700E6E84F /* HyperVController.hpp */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.h; path = HyperVController.hpp; sourceTree = "<group>"; };
355+
41EFDF66292A859F0021E9A3 /* modules.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = modules.md; sourceTree = "<group>"; };
355356
41F2E3D32665B42100CE26CE /* kern_config.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = kern_config.hpp; sourceTree = "<group>"; };
356357
41F2E3D42665B42100CE26CE /* hde64.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = hde64.h; sourceTree = "<group>"; };
357358
41F2E3D52665B42100CE26CE /* kern_time.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = kern_time.hpp; sourceTree = "<group>"; };
@@ -691,6 +692,7 @@
691692
isa = PBXGroup;
692693
children = (
693694
41C604AB28B2F87600FB77ED /* HyperV-versions.md */,
695+
41EFDF66292A859F0021E9A3 /* modules.md */,
694696
);
695697
path = Docs;
696698
sourceTree = "<group>";

‎README.md‎

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -98,23 +98,7 @@ All Intel macOS versions are supported.
9898
- `qemu-img convert -f raw -O vhdx Installer.dmg Installer.vhdx`
9999

100100
### Boot arguments
101-
| Module | Debug | Message Debug | Off |
102-
|---------------------|------------------|-------------------|-------------------|
103-
| CPU disabler (10.4) | -hvcpudbg | N/A | N/A |
104-
| Graphics bridge | -hvgfxbdbg | -hvgfxbmsgdbg | -hvgfxboff |
105-
| Heartbeat | -hvheartdbg | -hvheartmsgdbg | -hvheartoff |
106-
| Keyboard | -hvkbddbg | -hvkbdmsgdbg | -hvkbdoff |
107-
| Mouse | -hvmousdbg | -hvmousmsgdbg | -hvmousoff |
108-
| Network | -hvnetdbg | -hvnetmsgdbg | -hvnetoff |
109-
| PCI bridge | -hvpcibdbg | -hvpcibmsgdbg | -hvpciboff |
110-
| PCI module support | -hvpcimdbg | N/A | N/A |
111-
| PCI provider | -hvpcipdbg | N/A | N/A |
112-
| PCI root bridge | -hvpcirdbg | N/A | N/A |
113-
| Shutdown | -hvshutdbg | -hvshutmsgdbg | -hvshutoff |
114-
| Storage | -hvstordbg | -hvstormsgdbg | -hvstoroff |
115-
| Time sync | -hvtimedbg | -hvtimemsgdbg | -hvtimeoff |
116-
| VMBus controller | -hvvmbusdbg | N/A | N/A |
117-
| VMBus device nub | -hvvmbusdevdbg | N/A | N/A |
101+
See the [module list](Docs/modules.md) for boot arguments for each module.
118102

119103
### Credits
120104
- [Apple](https://www.apple.com) for macOS

0 commit comments

Comments
 (0)