Skip to content

Commit 31c618f

Browse files
VinDuvrickmark
VinDuv
authored and
rickmark
committed
README: Update for Monterey and new MBPs
- Indicate how to get the serial device on Monterey - Document the location of the debug port on 14"/16" MBPs Signed-off-by: Vincent Duvert <[email protected]> Signed-off-by: Rick Mark <[email protected]>
1 parent 2d8d29b commit 31c618f

2 files changed

Lines changed: 105 additions & 6 deletions

File tree

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
macvdmtool
2+
*.o

‎README.md‎

Lines changed: 104 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Apple Silicon to Apple Silicon VDM tool
22

3-
This tool lets you get a serial console on an Apple Silicon device and reboot it remotely, using only another Apple Silicon device running macOS and a standard Type C cable.
3+
This tool lets you send common Apple VDM messages from an Apple Sillicon Mac. It can send messages to the T2 DFU port, the Apple M1 DFU port or any USB-C based iPad. Currently it requires the sending device to be M1 based and the "DFU" port, but it should be possible to use any port and work from an Intel Mac (they have the same USB-C port controller) with some additonal patching.
4+
5+
`dfu` and `reboot` are confirmed to work on iPad and T2. Serial can probably be adapted to work with checkra1n.
46

57
## Disclaimer
68

@@ -15,17 +17,113 @@ This is based on portions of [ThunderboltPatcher](https://github.com/osy/Thunder
1517

1618
Thanks to t8012.dev and mrarm for assistance with the VDM and Ace2 host interface commands.
1719

20+
<<<<<<< HEAD
21+
<<<<<<< HEAD
22+
## Note about macOS 12
23+
24+
To have access to the serial console device on macOS Monterey (12), you need to disable the `AppleSerialShim` extension.
25+
26+
**Note:** This requires downgrading the system security and may cause problems with upgrades. Use it at your own risk!
27+
28+
Start by generating a new kernel cache, without the `AppleSerialShim` extension:
29+
30+
```
31+
sudo kmutil create -n boot -a arm64e -B /Library/KernelCollections/kc.noshim.macho -V release -k /System/Library/Kernels/kernel.release.<soc> -r /System/Library/Extensions -r /System/Library/DriverExtensions -x $(kmutil inspect -V release --no-header | awk '!/AppleSerialShim/ { print " -b "$1; }')
32+
```
33+
34+
Replace `<soc>` with `t8101` on M1 Macs and `t6000` on M1 Pro/Max Macs. If you’re unsure, `uname -v` and look at the end of the version string (`RELEASE_ARM64_<soc>`).
35+
36+
Then, enter 1TR:
37+
38+
1. Power off your Mac
39+
2. Press and hold the Power button until the boot menu appears
40+
3. Select “Options”, then (if necessary) select your macOS volume and enter your administrative password.
41+
42+
Select Utilities>Startup security and switch the macOS installation to reduced security. Exit Startup security.
43+
44+
Select Utilities>Terminal and install your custom kernel:
45+
46+
```
47+
kmutil configure-boot -c /Volume/<volume>/Library/KernelCollections/kc.noshim.macho -C -v /Volume/<volume>
48+
```
49+
50+
Replace `<volume>` with the name of your boot volume.
51+
52+
You can now reboot: macOS should start as normal, and the serial device `/dev/cu.debug-console` should be available.
53+
54+
To revert back to the default kernel, enter 1TR again, access Utilities>Startup security and switch to full or reduced security.
55+
=======
56+
The documentation of the ACE and its USB-PD VPDs is here https://blog.t8012.dev/ace-part-1/
57+
>>>>>>> b396565 (Added T2 and iPad data)
58+
=======
59+
The documentation of the ACE and its USB-PD VPDs is here https://blog.t8012.dev/ace-part-1/
60+
>>>>>>> 239e733 (Added T2 and iPad data)
61+
62+
## Note about macOS 12
63+
64+
To have access to the serial console device on macOS Monterey (12), you need to disable the `AppleSerialShim` extension.
65+
66+
**Note:** This requires downgrading the system security and may cause problems with upgrades. Use it at your own risk!
67+
68+
Start by generating a new kernel cache, without the `AppleSerialShim` extension:
69+
70+
```
71+
sudo kmutil create -n boot -a arm64e -B /Library/KernelCollections/kc.noshim.macho -V release -k /System/Library/Kernels/kernel.release.<soc> -r /System/Library/Extensions -r /System/Library/DriverExtensions -x $(kmutil inspect -V release --no-header | awk '!/AppleSerialShim/ { print " -b "$1; }')
72+
```
73+
74+
Replace `<soc>` with `t8101` on M1 Macs and `t6000` on M1 Pro/Max Macs. If you’re unsure, `uname -v` and look at the end of the version string (`RELEASE_ARM64_<soc>`).
75+
76+
Then, enter 1TR:
77+
78+
1. Power off your Mac
79+
2. Press and hold the Power button until the boot menu appears
80+
3. Select “Options”, then (if necessary) select your macOS volume and enter your administrative password.
81+
82+
Select Utilities>Startup security and switch the macOS installation to reduced security. Exit Startup security.
83+
84+
Select Utilities>Terminal and install your custom kernel:
85+
86+
```
87+
kmutil configure-boot -c /Volume/<volume>/Library/KernelCollections/kc.noshim.macho -C -v /Volume/<volume>
88+
```
89+
90+
Replace `<volume>` with the name of your boot volume.
91+
92+
You can now reboot: macOS should start as normal, and the serial device `/dev/cu.debug-console` should be available.
93+
94+
To revert back to the default kernel, enter 1TR again, access Utilities>Startup security and switch to full or reduced security.
95+
1896
## Building
1997

2098
Install the XCode commandline tools and type `make`.
2199

22100
## Usage
23101

24-
Connect the two devices via their DFU ports. That's the rear port on MacBooks and the port nearest to the power plug on Mac Minis.
25-
26-
You need to use a *USB 3.0 compatible* (SuperSpeed) Type C cable. USB 2.0-only cables, including most cables meant for charging, will not work, as they do not have the required pins. Thunderbolt cables work too.
27-
28-
Run it as root (`sudo ./macvdmtool`).
102+
<<<<<<< HEAD
103+
<<<<<<< HEAD
104+
<<<<<<< HEAD
105+
Connect the two devices via their DFU ports. That's:
106+
- the rear port on MacBook Air and 13" MacBook Pro
107+
- the port next to the MagSafe connector on the 14" and 16" MacBook Pro
108+
- the port nearest to the power plug on Mac Mini
109+
=======
110+
Connect the two devices via their DFU ports. That's the furthest left port on M1 MacBooks, the closest left port on the T2, and the only port on the iPad. See Apple's DFU recovery support articles to identify these ports on other models.
111+
>>>>>>> b396565 (Added T2 and iPad data)
112+
=======
113+
Connect the two devices via their DFU ports. That's the furthest left port on M1 MacBooks, the closest left port on the T2, and the only port on the iPad. See Apple's DFU recovery support articles to identify these ports on other models.
114+
>>>>>>> 239e733 (Added T2 and iPad data)
115+
=======
116+
Connect the two devices via their DFU ports. That's:
117+
- the rear port on MacBook Air and 13" MacBook Pro (Apple M Series)
118+
- the port next to the MagSafe connector on the 14" and 16" MacBook Pro
119+
- the port nearest to the power plug on Mac Mini (Apple M Series)
120+
- the closest (to the user) USB port on T2 based MacBooks
121+
- the only port on the iPad / iPhone
122+
>>>>>>> 567ee0e (README: Update for Monterey and new MBPs)
123+
124+
You need to use a *USB 3.0 compatible* (SuperSpeed) Type C cable. USB 2.0-only cables, including most cables meant for charging, will not work, as they do not have the required pins (USB CC1/CC2 where USB-PD are transmitted). Thunderbolt cables work too.
125+
126+
Run it as root (`sudo ./macvdmtool`) as root privledge is required to open the needed IOKit IOService.
29127

30128
```
31129
Usage: ./macvdmtool <command>

0 commit comments

Comments
 (0)