From 0b6f4bfa2ed3452f77746299631c7d16ffe57d15 Mon Sep 17 00:00:00 2001 From: Hector Martin Date: Wed, 3 Feb 2021 03:35:19 +0900 Subject: [PATCH] Initial commit Signed-off-by: Hector Martin --- .gitignore | 1 + AppleHPMLib.h | 43 ++++++ LICENSE | 201 ++++++++++++++++++++++++++++ Makefile | 9 ++ README.md | 36 +++++ main.cpp | 356 ++++++++++++++++++++++++++++++++++++++++++++++++++ ssops.h | 36 +++++ 7 files changed, 682 insertions(+) create mode 100644 .gitignore create mode 100644 AppleHPMLib.h create mode 100644 LICENSE create mode 100644 Makefile create mode 100644 README.md create mode 100644 main.cpp create mode 100644 ssops.h diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d9a9ed6 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +macvdmtool diff --git a/AppleHPMLib.h b/AppleHPMLib.h new file mode 100644 index 0000000..fc9e1d7 --- /dev/null +++ b/AppleHPMLib.h @@ -0,0 +1,43 @@ +// +// Copyright © 2019 osy86. All rights reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +#ifndef AppleHPMLib_h +#define AppleHPMLib_h + +#include + +#define kAppleHPMLibType CFUUIDGetConstantUUIDWithBytes(kCFAllocatorDefault, \ + 0x12, 0xA1, 0xDC, 0xCF, 0xCF, 0x7A, 0x47, 0x75, \ + 0xBE, 0xE5, 0x9C, 0x43, 0x19, 0xF4, 0xCD, 0x2B \ +) +#define kAppleHPMLibInterface CFUUIDGetConstantUUIDWithBytes(kCFAllocatorDefault, \ + 0xC1, 0x3A, 0xCD, 0xD9, 0x20, 0x9E, 0x4B, 0x01, \ + 0xB7, 0xBE, 0xE0, 0x5C, 0xD8, 0x83, 0xC7, 0xB1 \ +) + +typedef struct { + IUNKNOWN_C_GUTS; + uint16_t field_20; + uint16_t field_22; + IOReturn (*Read)(void *, uint64_t chipAddr, uint8_t dataAddr, void *buffer, uint64_t maxLen, uint32_t flags, uint64_t *readLen); + IOReturn (*Write)(void *, uint64_t chipAddr, uint8_t dataAd6dr, const void *buffer, uint64_t len, uint32_t flags); + IOReturn (*Command)(void *, uint64_t chipAddr, uint32_t cmd, uint32_t flags); + IOReturn (*field_40)(void); + IOReturn (*field_48)(void); + IOReturn (*field_50)(void); +} AppleHPMLib; + +#endif /* AppleHPMLib_h */ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..0d770e1 --- /dev/null +++ b/Makefile @@ -0,0 +1,9 @@ +CXXFLAGS := -std=c++14 +LDFLAGS := -framework CoreFoundation -framework IOKit -lc++ + +OBJS := main.o + +all: macvdmtool + +macvdmtool: $(OBJS) + cc -o $@ $(OBJS) $(LDFLAGS) diff --git a/README.md b/README.md new file mode 100644 index 0000000..d42c576 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# Apple Silicon to Apple Silicon VDM tool + +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. + +## Disclaimer + +I have no idea what I'm doing with IOKit and CoreFoundation -marcan + +## Copyright + +This is based on portions of [ThunderboltPatcher](https://github.com/osy/ThunderboltPatcher) and licensed under Apache-2.0. + +* Copyright (C) 2019 osy86. All rights reserved. +* Copyright (C) 2021 The Asahi Linux Contributors + +## Building + +Install the XCode commandline tools and type `make`. + +## Usage + +Run it as root (`sudo ./macvdmtool`). + +``` +Usage: ./macvdmtool +Commands: + serial - enter serial mode on both ends + reboot - reboot the target + reboot serial - reboot the target and enter serial mode + dfu - put the target into DFU mode + nop - do nothing +``` + +Use `/dev/cu.debug_console` on the local machine as your serial device. To use it with m1n1, `export M1N1DEVICE=/dev/cu.debug-console`. + +For typical development, the command you want to use is `macvdmtool reboot serial`. This will reboot the target, and immediately put it back into serial mode, with the right timing to make it work. diff --git a/main.cpp b/main.cpp new file mode 100644 index 0000000..b186068 --- /dev/null +++ b/main.cpp @@ -0,0 +1,356 @@ +/* SPDX-License-Identifier: Apache-2.0 */ +/* Based on https://github.com/osy/ThunderboltPatcher */ + +#include +#include +#include +#include +#include +#include "AppleHPMLib.h" +#include "ssops.h" + +#include +#include + +struct failure: public std::runtime_error { + failure(const char *x) : std::runtime_error(x) {} +}; + +struct IOObjectDeleter { + io_object_t arg; + + IOObjectDeleter(io_object_t arg) : arg(arg) {} + + ~IOObjectDeleter() { + IOObjectRelease(arg); + } +}; + +struct HPMPluginInstance { + IOCFPlugInInterface **plugin = nullptr; + AppleHPMLib **device; + + HPMPluginInstance(io_service_t service) { + SInt32 score; + IOReturn ret = IOCreatePlugInInterfaceForService(service, kAppleHPMLibType, kIOCFPlugInInterfaceID, &plugin, &score); + if (ret != kIOReturnSuccess) + throw failure("IOCreatePlugInInterfaceForService failed"); + + HRESULT res = (*plugin)->QueryInterface(plugin, CFUUIDGetUUIDBytes(kAppleHPMLibInterface), (LPVOID *) &device); + if (res != S_OK) + throw failure("QueryInterface failed"); + } + + ~HPMPluginInstance() { + if (plugin) { + printf("Exiting DBMa mode... "); + if (this->command(0, 'DBMa', "\x00") == 0) + printf("OK\n"); + else + printf("Failed\n"); + IODestroyPlugInInterface(plugin); + } + } + + std::string readRegister(uint64_t chipAddr, uint8_t dataAddr, int flags = 0) { + std::string ret; + ret.resize(64); + uint64_t rlen = 0; + IOReturn x = (*device)->Read(device, chipAddr, dataAddr, &ret[0], 64, flags, &rlen); + if (x != 0) + throw failure("readRegister failed"); + return ret; + } + + void writeRegister(uint64_t chipAddr, uint8_t dataAddr, std::string value) { + IOReturn x = (*device)->Write(device, chipAddr, dataAddr, &value[0], value.length(), 0); + if (x != 0) + throw failure("writeRegister failed"); + } + + int command(uint64_t chipAddr, uint32_t cmd, std::string args="") { + if (args.length()) + (*device)->Write(device, chipAddr, 9, args.data(), args.length(), 0); + auto ret = (*device)->Command(device, chipAddr, cmd, 0); + if (ret) + return -1; + auto res = this->readRegister(chipAddr, 9); + return res[0] & 0xfu; + } + +}; + +uint32_t GetUnlockKey() { + CFMutableDictionaryRef matching = IOServiceMatching("IOPlatformExpertDevice"); + if (!matching) + throw failure("IOServiceMatching failed (IOPED)"); + + io_iterator_t iter = 0; + IOObjectDeleter iterDel (iter); + io_service_t service = IOServiceGetMatchingService(kIOMasterPortDefault, matching); + if (!service) + throw failure("IOServiceGetMatchingService failed (IOPED)"); + + IOObjectDeleter deviceDel (service); + + io_name_t deviceName; + if (IORegistryEntryGetName(service, deviceName) != kIOReturnSuccess) { + throw failure("IORegistryEntryGetName failed (IOPED)"); + } + + printf("Mac type: %s\n", deviceName); + + return (deviceName[0] << 24) | (deviceName[1] << 16) | (deviceName[2] << 8) | deviceName[3]; +} + +std::unique_ptr FindDevice() { + std::unique_ptr ret; + + printf("Looking for HPM devices...\n"); + + CFMutableDictionaryRef matching = IOServiceMatching("AppleHPM"); + if (!matching) + throw failure("IOServiceMatching failed"); + + io_iterator_t iter = 0; + IOObjectDeleter iterDel (iter); + if (IOServiceGetMatchingServices(kIOMasterPortDefault, matching, &iter) != kIOReturnSuccess) + throw failure("IOServiceGetMatchingServices failed"); + + io_service_t device; + while ((device = IOIteratorNext(iter))) { + IOObjectDeleter deviceDel (device); + io_string_t pathName; + + if (IORegistryEntryGetPath(device, kIOServicePlane, pathName) != kIOReturnSuccess) { + fprintf(stderr, "Failed to get device path for object %d.", device); + continue; + } + + CFNumberRef data; + int32_t rid; + data = (CFNumberRef)IORegistryEntryCreateCFProperty(device, + CFSTR("RID"), + kCFAllocatorDefault, 0); + if (!data) + throw failure("No RID"); + + CFNumberGetValue(data, kCFNumberSInt32Type, &rid); + CFRelease(data); + + // RID=0 seems to always be the right port + if (rid != 0) + continue; + + printf("Found: %s\n", pathName); + ret = std::make_unique(device); + } + + if (!ret) + throw failure("No matching devices"); + + return ret; +}; + +void UnlockAce(HPMPluginInstance &inst, int no, uint32_t key) { + printf("Unlocking... "); + std::stringstream args; + put(args, key); + if (inst.command(no, 'LOCK', args.str())) { + printf(" Failed.\n"); + printf("Trying to reset... "); + if (inst.command(no, 'Gaid')) { + printf("Failed.\n"); + throw failure("Failed to unlock device"); + } + printf("OK.\nUnlocking... "); + if (inst.command(no, 'LOCK', args.str())) { + printf(" Failed.\n"); + throw failure("Failed to unlock device"); + } + } + + printf("OK\n"); +} + +void DoVDM(HPMPluginInstance &inst, int no, std::vector vdm) { + + auto rs = inst.readRegister(no, 0x4d); + uint8_t rxst = rs[0]; + + std::stringstream args; + put(args, (uint8_t)(((3<<4) | vdm.size()))); + for(uint32_t i : vdm) + put(args, i); + + auto v = args.str(); + + if (inst.command(no, 'VDMs', args.str())) + throw failure("Failed to send VDM\n"); + + int i; + for (i = 0; i < 16; i++) { + rs = inst.readRegister(no, 0x4d); + if ((uint8_t)rs[0] != rxst) + break; + } + if (i >= 16) + throw failure("Did not get a reply to VDM\n"); + + uint32_t vdmhdr; + std::stringstream reply; + reply.str(rs); + get(reply, rxst); + get(reply, vdmhdr); + + if (vdmhdr != (vdm[0] | 0x40)) { + printf("VDM failed (reply: 0x%08x)\n", vdmhdr); + throw failure("VDM failed"); + } +} + +int DoSerial(HPMPluginInstance &inst, int no) { + printf("Putting target into serial mode... "); + + std::vector serial{0x5ac8012, 0x1840306}; + DoVDM(inst, no, serial); + + printf("OK\n"); + + printf("Putting local end into serial mode... "); + + std::stringstream args; + put(args, (uint32_t)0x1840306); + + if (inst.command(no, 'DVEn', args.str())) { + printf("Failed.\n"); + return 1; + } + printf("OK\n"); + + return 0; +} + +int DoReboot(HPMPluginInstance &inst, int no) { + printf("Rebooting target into normal mode... "); + + std::vector serial{0x5ac8012, 0x105, 0x80000000}; + DoVDM(inst, no, serial); + + printf("OK\n"); + return 0; +} + +int DoRebootSerial(HPMPluginInstance &inst, int no) { + + if (DoReboot(inst, no)) + return 1; + + printf("Waiting for connection..."); + fflush(stdout); + + sleep(1); + int i; + for (i = 0; i < 30; i++) { + printf("."); + fflush(stdout); + auto t = inst.readRegister(no, 0x3f); + if (t[0] & 1) + break; + usleep(100000); + } + if (i >= 30) { + printf(" Timed out\n"); + return 1; + } + printf(" Connected\n"); + sleep(1); + + return DoSerial(inst, no); +} + +int DoDFU(HPMPluginInstance &inst, int no) { + printf("Rebooting target into DFU mode... "); + + std::vector serial{0x5ac8012, 0x106, 0x80010000}; + DoVDM(inst, no, serial); + + printf("OK\n"); + return 0; +} + +int main2(int argc, char **argv) { + if (argc < 2) { + printf("Usage: %s \n", argv[0]); + printf("Commands:\n"); + printf(" serial - enter serial mode on both ends\n"); + printf(" reboot - reboot the target\n"); + printf(" reboot serial - reboot the target and enter serial mode\n"); + printf(" dfu - put the target into DFU mode\n"); + printf(" nop - do nothing\n"); + return 1; + } + + uint32_t key = GetUnlockKey(); + + auto inst = FindDevice(); + int no = 0; + + auto t = inst->readRegister(no, 0x3f); + std::string type = (t[0] & 1) ? ((t[0] & 2) == 0 ? "Source" : "Sink") : "None"; + printf("Connection: %s\n", type.c_str()); + + if (!(t[0] & 1)) + throw failure("No connection detected"); + + auto res = inst->readRegister(no, 0x03); + res.erase(res.find('\0')); + printf("Status: %s\n", res.c_str()); + + if (res != "DBMa") { + UnlockAce(*inst, no, key); + printf("Entering DBMa mode... "); + + if (inst->command(no, 'DBMa', "\x01")) + throw failure("Failed to enter DBMa mode"); + + res = inst->readRegister(no, 0x03); + res.erase(res.find('\0')); + + printf("Status: %s\n", res.c_str()); + if (res != "DBMa") + throw failure("Failed to enter DBMa mode"); + } + + std::string cmd = argv[1]; + std::string arg = ""; + + if (argc >= 3) + arg = argv[2]; + + if (cmd == "serial") + return DoSerial(*inst, no); + else if (cmd == "reboot") { + if (arg == "serial") + return DoRebootSerial(*inst, no); + else + return DoReboot(*inst, no); + } else if (cmd == "dfu") + return DoDFU(*inst, no); + else if (cmd == "nop") + return 0; + + printf("Unknown command\n"); + return 1; +} + + +int main(int argc, char **argv) { + // This makes sure we call the HPMPluginInstance destructor. + try { + return main2(argc, argv); + } catch(failure e) { + printf("%s\n", e.what()); + return -1; + } +} diff --git a/ssops.h b/ssops.h new file mode 100644 index 0000000..52adc65 --- /dev/null +++ b/ssops.h @@ -0,0 +1,36 @@ +/* SPDX-License-Identifier: Apache-2.0 */ +/* Based on https://github.com/osy/ThunderboltPatcher */ + +#include +#include +#include + +template +std::stringstream& put ( std::stringstream& str, const T& value ) +{ + union coercion { T value; char data[ sizeof ( T ) ]; }; + + coercion c; + + c.value = value; + + str.write ( c.data, sizeof ( T ) ); + + return str; +} + +template +std::stringstream& get ( std::stringstream& str, T& value ) +{ + union coercion { T value; char data[ sizeof ( T ) ]; }; + + coercion c; + + c.value = value; + + str.read ( c.data, sizeof ( T ) ); + + value = c.value; + + return str; +}