Script to prevent loading of the Apple USB FTDI interface 0 driver on Mac OS X

AppleUSBFTDILoader.swift

#!/usr/bin/swift

/*

 AppleUSBFTDILoader.swift
 Brian Doyle
 April 17, 2019

 Released under MIT license:

 --- LICENSE START --

 Copyright 2019 Brian Doyle

 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

 --- LICENSE END --

 The purpose of this script is to aid debugging of an Espressif ESP32-WROVER-KIT on Mac OS X.

 To use, set the execute bit and run with sudo, e.g.

 chmod 755 AppleUSBFTDILoader.swift
 sudo ./AppleUSBFTDILoader.swift

 ---

 This script follows the approach described by Liviu Ionescu at
 https://gnu-mcu-eclipse.github.io/arch/riscv/ftdi-jtag-drivers/

 Thank you Liviu!

 The Apple FTDI driver that ships with Mojave detects both interfaces of the ESP32-WROVER-KIT's
 FTDI 2232HL chip and maps them to serial ports at /dev/cu.usbserial-XXXX. Once mapped,
 openocd cannot open the first interface for JTAG debugging.

 This script unloads the Apple USB FTDI driver, then reloads it with all personalities except the
 one matching the first serial port. Consequently, openocd can use the first interface for debugging,
 while the second interface will be mapped to a serial port for program uploading and monitoring.

 When the Dual RS232-HS driver loads, Mac OS will display a dialog asking if you'd like to add it
 as a network interface.  You can suppress this dialog on future loads by adding it as an interface in
 System Preferences -> Network and then setting the service to inactive.

*/

import Foundation

func abort(_ message: String) -> Never {
    fatalError("Error: " + message)
}

func executeSubshell(with commands: [String]) {
    let commands = ["set -e"] + commands
    let commandsText = commands.joined(separator: "\n")

    guard let commandsData = commandsText.data(using: .utf8) else {
        abort("failed to convert commandsText to Data")
    }

    let pipe = Pipe()
    pipe.fileHandleForWriting.writeabilityHandler = { fileHandle in
        fileHandle.write(commandsData)
        pipe.fileHandleForWriting.closeFile()
    }

    let process = Process()
    process.executableURL = URL(fileURLWithPath: "/bin/bash")
    process.standardError = FileHandle.standardError
    process.standardInput = pipe
    process.standardOutput = FileHandle.standardOutput

    do {
        try process.run()
    } catch {
        abort(error.localizedDescription)
    }

    process.waitUntilExit()
}

guard
    let data = FileManager.default.contents(atPath: "/System/Library/Extensions/AppleUSBFTDI.kext/Contents/Info.plist"),
    let dictionary = try? PropertyListSerialization.propertyList(from: data, options: [], format: nil) as? [String: Any],
    let bundleId = dictionary["CFBundleIdentifier"] as? String,
    let ioKitPersonalities = dictionary["IOKitPersonalities"] as? [String: Any]
    else {
        abort("unable to load IOKitPersonalities from AppleUSBFTDI.kext")
    }

let unloadCommand = "/sbin/kextunload -b \(bundleId)"

let loadCommands = ioKitPersonalities.keys
    .filter { $0 != "AppleUSBEFTDI-6010-0" }
    .map { "/usr/bin/kextutil -b \(bundleId) -p '\($0)'" }

let commands = [unloadCommand] + loadCommands

executeSubshell(with: commands)

Hi Brian, I'm wondering if you can release this script under any license? I'd like to update the ESP-IDF instructions to use this approach. Would be great if we could use your script.

Hi Ivan, I'll release it under MIT license (I'll add the text to the file) and you can feel free to do what you'd like with it. That said, I believe it's not necessary. My WROVER-KIT is at my office and I should be able to get down there in the next few days to look at it, but I believe it doesn't work out of the box because of a jumper setting. It's been a while since I wrote this so I don't recall exactly what it was, but I do remember that after I set the jumpers properly I didn't need it. I'll post back here once I have a look at my board and see how my jumpers are setup.

Thanks Brian!