Apple Docs mentions that driver should be approved(enabled) in Settings app.
I wonder is there any API available to check that driver is not enabled?
To my mind, App with driver should have a following flow:
Run App
Check that driver is(not) enabled
Display message(alert) and ask to enable driver in Settings. Optionally: provide shortcut to exact Settings page
Unfortunately, it's not obvious how to check that driver is enabled.
Selecting any option will automatically load the page
Post
Replies
Boosts
Views
Activity
According to Communicating Between a DriverKit Extension and a Client App we can use IOConnectCallScalarMethod to send/get data to Driver.
We use unchecked variation of IOConnectCallScalarMethod to call method in our Driver from Client App. In a Driver's method we set arguments->scalarOutputCount greater than 16. However in a Client app outputCount equal to 16, so we can get only a portion of output.
Is 16 limit enforced by IOConnectCallScalarMethod implementation? How we can get more than 16? Should we use IOConnectCallStructMethod instead?
We inspired by announce that DriverKit will come to iPadOs this fall and decided to experiment with DriverKit on macOS.
We started from scratch but followed all the recommendations from Sample.
With our installer code we can:
Install driver extension to macOS system. (systemextensionsctl list shows [activated enabled]) for our driver
See driver record using ioreg. So it's displayed: MyDriver <class IOUserService, id 0x10000193b, registered, matched, active, busy 0 (0 ms), retain 7>
See *.MyDriver process in Activity Monitor
In client code we can find a match:
private let dextIdentifier = "MyDriver"
private var lastResult: kern_return_t = kIOReturnSuccess
private var connection: io_connect_t = IO_OBJECT_NULL
var iterator: io_iterator_t = IO_OBJECT_NULL
var driver: io_service_t = IO_OBJECT_NULL
lastResult = IOServiceGetMatchingServices(kIOMasterPortDefault, IOServiceNameMatching(dextIdentifier), &iterator)
print("Search for services ...")
while case let service = IOIteratorNext(iterator),
service != IO_OBJECT_NULL {
driver = service
}
IOObjectRelease(iterator)
guard driver != IO_OBJECT_NULL else { return }
So driver is not IO_OBJECT_NULL. But we stuck on IOServiceOpen. So code:
lastResult = IOServiceOpen(driver, mach_task_self_, UInt32(kIOHIDServerConnectType), &connection);
validateLastResult(forOperation: "opening service")
prints opening service: (iokit/common) general error since IOServiceOpen returns 0x2bc
What we tried:
Disable SIP in recovery mode and set systemextensionsctl developer on
Result: opening service: (iokit/common) general error
Add com.apple.developer.driverkit.userclient-access to our client App.
Result: App crashes on start and in Console we see: taskgated-helper - Unsatisfied entitlements: com.apple.developer.driverkit.userclient-access. We requested this entitlement.
We found post were com.apple.developer.driverkit.allow-any-userclient-access suggested as solution.
Result: Driver extension is not started and we see in Console:
taskgated-helper MyDriver: Unsatisfied entitlements: com.apple.developer.driverkit.allow-any-userclient-access
amfid /Library/SystemExtensions/B7624EEF-3688-4735-A58B-26FEF4DE353C/MyDriver.dext/MyDriver signature not valid: -67671
We recreated appIds, profiles on developer account that has com.apple.developer.driverkit.allow-any-userclient-access from Apple.
Result: Driver extension is started but we still see opening service: (iokit/common) general error
We modified CommunicatingBetweenADriverKitExtensionAndAClientApp.zip by setting our appIds and profiles and run in in SIP disabled mode.
Result: opening service: (iokit/common) general error
Our environment:
macOS Monterey 12.4
XCode Version 13.4 (13F17a)
Driver Code is pretty straightforward:
///// iig
class MyDriver: public IOUserClient
{
public:
virtual bool init(void) override;
virtual kern_return_t Start(IOService * provider) override;
virtual kern_return_t Stop(IOService* provider) override;
virtual void free(void) override;
};
///// cpp
#define Log(fmt, ...) os_log(OS_LOG_DEFAULT, "MyDriver - " fmt "\n", ##__VA_ARGS__)
struct MyDriver_IVars {
OSAction* callbackAction = nullptr;
};
bool MyDriver::init() {
bool result = false;
Log("init()");
result = super::init();
if (result != true)
{
Log("init() - super::init failed.");
goto Exit;
}
ivars = IONewZero(MyDriver_IVars, 1);
if (ivars == nullptr)
{
Log("init() - Failed to allocate memory for ivars.");
goto Exit;
}
Log("init() - Finished.");
return true;
Exit:
return false;
}
kern_return_t
IMPL(MyDriver, Start)
{
kern_return_t ret;
ret = Start(provider, SUPERDISPATCH);
if(ret != kIOReturnSuccess) {
Log("Start() - super::Start failed with error: 0x%08x.", ret);
goto Exit;
}
ret = RegisterService();
if (ret != kIOReturnSuccess)
{
Log("Start() - Failed to register service with error: 0x%08x.", ret);
goto Exit;
}
Log("Start() - Finished.");
ret = kIOReturnSuccess;
Exit:
return ret;
}
kern_return_t
IMPL(MyDriver, Stop)
{
kern_return_t ret = kIOReturnSuccess;
Log("Stop()");
ret = Stop(provider, SUPERDISPATCH);
if (ret != kIOReturnSuccess)
{
Log("Stop() - super::Stop failed with error: 0x%08x.", ret);
}
return ret;
}
void MyDriver::free(void)
{
Log("free()");
IOSafeDeleteNULL(ivars, MyDriver_IVars, 1);
super::free();
}
We develop and test App for macOS. We start to see system alert - "UlTests-Runner" would like to access data from other apps on each UITest run.
Our test suite does cleanup of files generated by App so we need access outside of UITests-Runner sandbox.
We enabled Full Disk Access for UITests-Runner at Settings -> Privacy & Security -> Full Disk Access but unfortunately still see this alert.
Is there any way to permanently remove/hide this alert or remove sandbox for 'UITests-Runner' since we want to run tests on CI and having this alert is not an option?
Note: everything works fine on previous versions of macOS.
Environment:
macOS - 15.1 (24B83)
Xcode - Version 16.1 (16B40)
Based on official docs click is available for iPadOS apps.
We utilized click action to create universal UITests for macOS and iPadOS targets.
It works fine on iPadOS 16.x but, unfortunately, stops to work in iOS 17 simulators for iPad.
Environment:
MacOS - 13.5.2 (22G91).
Xcode - Version 15.0 (15A240d).
Simulator - Version 15.0 (1015.2).
SimulatorKit 935.1.
CoreSimulator 920.6.
Steps to reproduce:
Create new multiplatform app
Add simple button. For example:
struct ContentView: View {
@State var title = "Click Me"
var body: some View {
VStack {
Button(title) {
title = "Clicked"
}
.background(Color.blue)
.foregroundColor(.white)
}
.padding()
}
}
Add UITest that clicks on button. For example:
func testClick() throws {
let app = XCUIApplication()
app.launch()
app.buttons["Click Me"].click()
XCTAssertTrue(app.buttons["Clicked"].exists)
}
Expected result: test is passed
Actual result: test is failed since buttons["Click Me"].click() doesn't click in button.
Workaround:
Replacement .click() to .tap() fixes the issue but it makes impossible to create universal tests with single action for both platforms
struct SheetView: View {
@Binding var showSheet: Bool
var body: some View {
LazyVStack {
Button("Dismiss") {
showSheet.toggle()
}
}
}
}
struct ContentView: View {
@State private var showSheet = false
var body: some View {
Button("Show") {
showSheet.toggle()
}
.sheet(isPresented: $showSheet) {
SheetView(showSheet: $showSheet)
}
}
}
Xcode displays === AttributeGraph: cycle detected through attribute 119104 === message in console when SheetView is presented on screen.
Environment: macOS 14.4.1
Xcode: Version 15.2
We are developing driver for our USB device. Our approach is to run and test driver on macOS first and then verify on iPadOS 16. In the driver we add custom property -"kUSBSerialNumberString" into default properties:
OSDictionary * Driver::devicePropertiesWithSerialNumber() {
kern_return_t ret;
OSDictionary *properties = NULL;
OSDictionary *dictionary = NULL;
OSObjectPtr value;
const IOUSBDeviceDescriptor *deviceDescriptor;
deviceDescriptor = ivars->device->CopyDeviceDescriptor();
ret = CopyProperties(&properties);
value = copyStringAtIndex(deviceDescriptor->iSerialNumber, kIOUSBLanguageIDEnglishUS);
Log("Serial number: %{public}s", ((OSString *)value)->getCStringNoCopy());
dictionary = OSDictionary::withDictionary(properties, 0);
OSSafeReleaseNULL(properties);
if (value) {
OSDictionarySetValue(dictionary, "kUSBSerialNumberString", value);
OSSafeReleaseNULL(value);
}
return dictionary;
}
next in kern_return_t IMPL(Driver, Start) we call SetProperties:
ret = SetProperties(devicePropertiesWithSerialNumber());
if(ret != kIOReturnSuccess) {
Log("Start() - Failed to set properties: 0x%08x.", ret);
goto Exit;
}
We can read our property on macOS using:
func getDeviceProperty(device: io_object_t, key: String) -> AnyObject? {
IORegistryEntryCreateCFProperty(
device, key as CFString, kCFAllocatorDefault, .zero
)?.takeRetainedValue()
}
if let serialNumber = getDeviceProperty(device: driver, key: "kUSBSerialNumberString") {
print("serialNumber: \(serialNumber)")
}
However getDevicePropertyon iPadOS returns nil. We are wondering is any limitation for IORegistry entries(properties) on iPadOS16? Is any way to add custom property to IORegistry?
BTW, we added debug method to print all the available properties for IORegistry:
private func debugRegistry(device: io_object_t) {
var dictionary: Unmanaged<CFMutableDictionary>?
IORegistryEntryCreateCFProperties(device, &dictionary, kCFAllocatorDefault, .zero)
if let dictionary = dictionary {
let values = dictionary.takeUnretainedValue()
print(values)
}
}
It returns just 1 property for iPadOS:
{
IOClass = IOUserService;
}
and much more for macOS including our custom one:
{
CFBundleIdentifier = "****";
CFBundleIdentifierKernel = "com.apple.kpi.iokit";
IOClass = IOUserService;
IOMatchCategory = "***";
IOMatchedPersonality = {
CFBundleIdentifier = "****";
CFBundleIdentifierKernel = "com.apple.kpi.iokit";
IOClass = IOUserService;
IOMatchCategory = "****";
IOPersonalityPublisher = "****";
IOProviderClass = IOUSBHostInterface;
IOResourceMatch = IOKit;
IOUserClass = Driver;
IOUserServerCDHash = 9cfd03b5c1b90da709ffb1455a053c5d7cdf47ac;
IOUserServerName = "*****";
UserClientProperties = {
IOClass = IOUserUserClient;
IOUserClass = DriverUserClient;
};
bConfigurationValue = 1;
bInterfaceNumber = 1;
bcdDevice = 512;
idProduct = XXXXX;
idVendor = XXXXX;
};
IOPersonalityPublisher = "*****";
IOPowerManagement = {
CapabilityFlags = 2;
CurrentPowerState = 2;
MaxPowerState = 2;
};
IOProbeScore = 100000;
IOProviderClass = IOUSBHostInterface;
IOResourceMatch = IOKit;
IOUserClass = Driver;
IOUserServerCDHash = 9cfd03b5c1b90da709ffb1455a053c5d7cdf47ac;
IOUserServerName = "*****";
UserClientProperties = {
IOClass = IOUserUserClient;
IOUserClass = DriverUserClient;
};
bConfigurationValue = 1;
bInterfaceNumber = 1;
bcdDevice = 512;
idProduct = XXXXX;
idVendor = XXXXXX;
kUSBSerialNumberString = XXXXXXXXXXX;
}
We have SwiftUI Alert with destructive button - "Yes, sign out"?
Alert(
title: Text("Are you sure you want to sign out?"),
message: Text("Some message"),
primaryButton: .cancel(
Text("No, don’t sign out")
),
secondaryButton: .destructive(
Text("Yes, sign out"),
action: { print("signOut") }
)
)
Button's text is displayed in pale pink but according to our design we want to change it to dark red. As an option we want change button's color as well.
How we can accomplish it?
As a side note: we found that for iOS we probably can utilise UIView.appearance(whenContainedInInstancesOf: API but it's available only on iOS but we are interested in solution for macOS
We created Driver sample by Xcode template and following macro was added into code:
#define Log(fmt, ...) os_log(OS_LOG_DEFAULT, "Driver - " fmt "\n", ##__VA_ARGS__)
We used this macro in init and start. For example:
bool ForcePlateDriver::init() {
Log("init()");
But our logs are not displayed in Console app.
Did we miss something? Is anything else is required to have logs for Driver?
Our environment:
MacOS Monterey - 12.4 (21F79)
Xcode - Version 13.4 (13F17a)
We implemented communication between Swift App and DriverKit driver using IOConnectCallAsyncStructMethod. So in Swift App we have following code to setup AsyncDataCallback:
func AsyncDataCallback(refcon: UnsafeMutableRawPointer?, result: IOReturn, args: UnsafeMutablePointer<UnsafeMutableRawPointer?>?, numArgs: UInt32) -> Void {
// handle args
}
var asyncRef: [io_user_reference_t] = .init(repeating: 0, count: 8)
asyncRef[kIOAsyncCalloutFuncIndex] = unsafeBitCast(AsyncDataCallback as IOAsyncCallback, to: UInt64.self)
asyncRef[kIOAsyncCalloutRefconIndex] = unsafeBitCast(self, to: UInt64.self)
......
let notificationPort = IONotificationPortCreate(kIOMasterPortDefault)
let machNotificationPort = IONotificationPortGetMachPort(notificationPort)
let runLoopSource = IONotificationPortGetRunLoopSource(notificationPort)!
CFRunLoopAddSource(CFRunLoopGetCurrent(), runLoopSource.takeUnretainedValue(), CFRunLoopMode.defaultMode)
var input = "someinput".map { UInt8($0.asciiValue!) }
let inputSize = input.count
IOConnectCallAsyncStructMethod(
connection,
123,
machNotificationPort,
&asyncRef,
UInt32(kIOAsyncCalloutCount),
&input,
inputSize,
nil,
nil
)
In the driver's ExternalMethod we save callback in ivars:
ivars->callbackAction = arguments->completion;
ivars->callbackAction->retain();
Next we start communication with our device in a separate thread and execute callback when we get data from device:
SendDataAsync(void *data, uint32_t dataLength) {
const int asyncDataCount = 16;
if (ivars->callbackAction != nullptr) {
Log("SendDataAsync() - got %u bytes", dataLength);
uint64_t asyncData[asyncDataCount] = { };
asyncData[0] = dataLength;
memcpy(asyncData + 1, data, dataLength);
AsyncCompletion(ivars->callbackAction, kIOReturnSuccess, asyncData, asyncDataCount);
}
Limitation 1:
Our device produces data packet every 10 ms. So driver gets 100 data packets per second. Receive rate is good and we verified it by logs. However we see some delay in AsyncCallback in Swift App. It looks like async calls are queued since we see that Swift App gets callbacks for a few seconds when we stopped to send data from Driver. We measured receive rate in Swift App and it is about 50 data packets per second.
So what's a minimum call rate for AsyncCompletion? Is it higher than 10 ms?
Maybe there is other more efficient way to asynchronously pass data from Driver to Swift App?
Limitation 2:
We thought we can buffer data packets and decrease AsyncCompletion call rate. However asyncData could be only 16 of uint64_t by declaration typedef uint64_t IOUserClientAsyncArgumentsArray[16];. Size of our data packer is 112 bytes that perfectly fits to max args size(8*16 = 128 bytes). So we can't cache and send 2 data packets.
How we can avoid this limitation and send more data via AsyncCompletion?
Is there any other API for asynchronous communication that allows send more data back?
We are developing our Driver using DriverKit. In client App we successfully discover our driver but can't get IORegistry properties except IOClass. So in a client App we use following code to read properties:
private func debugRegistry(device: io_object_t) {
var dictionary: Unmanaged<CFMutableDictionary>?
IORegistryEntryCreateCFProperties(device, &dictionary, kCFAllocatorDefault, .zero)
if let dictionary = dictionary {
let values = dictionary.takeUnretainedValue()
print(values)
}
}
output is:
{
IOClass = IOUserService;
}
We tested same code on macOS and output contains about 20+ properties. It looks like IOKi doesn't allow to read other properties except IOClass.
Environment:
Xcode - Version 14.1 beta 2 (14B5024i).
iPadOS - iOS 16.1 (20B5050f)
We are building iPadOS App that uses bundled DriveKit driver to communicate with USB device. This bundled driver should be enabled first by user from App's settings or Privacy & Security page. We read in Apple Docs that openSettingsURLString is recommended way to navigate user to App's settings.
We added alert that is shown on App launch and has option to open settings.
Our solution perfectly works on local DEBUG build. So user is navigated to App's settings when he click "Open Settings".
However it doesn't work for TestFlight/App Store builds. "Open Settings" just opens system Settings app on some random page.
Code:
let settingsURL = URL(string: UIApplication.openSettingsURLString)!
UIApplication.shared.open(settingsURL)
Environment:
Xcode Version 14.1(14B47b)
iPadOS 16.1.1(20B101)
Note: Our Settings.bundle contains Root.plist with no custom settings:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict/>
</plist>
We read speculations that some permission request should be triggered before navigation. Unfortunately, there is no API that checks or requests permission for DriverKit in the moment.
We requested com.apple.developer.driverkit.transport.usb entitlement a few days ago and it looks like it was granted since we see(can select) it at:
App Id -> Additional Capabilities Tab -> DriverKit USB Transport - Vendor ID.
We tried to choose both options at Additional Entitlements page
Default and Driver Kit and System Extension Template for **** Mac Dev. Generated profile displays DriverKit USB Transport - Vendor ID in Enabled Capabilities in browser. However downloaded profile doesn't include com.apple.developer.driverkit.transport.usb. As a result our Driver fails to start and in Console we see:
Driver: Unsatisfied entitlements: com.apple.developer.driverkit.transport.usb
/Library/SystemExtensions/675FA894-8985-4D86-B0FF-B892B9AEA27B/Driver.dext/Driver signature not valid: -67671
BTW, we tried to modify existing profile and create a new one.
Did we miss something? Is any way to check entitlement status with Apple support?
We followed WWDC Session: System Extensions and DriverKit and recreated a code to do USB device communication via IOUSBHostPipe:
struct MyDriver_IVars {
IOUSBHostInterface *interface;
IOUSBHostPipe *inPipe;
OSAction *ioCompleteCallback;
IOBufferMemoryDescriptor *inData;
uint16_t maxPacketSize;
};
kern_return_t
IMPL(MyDriver, Start)
{
...
ivars->maxPacketSize = 64;
ret = ivars->interface->CreateIOBuffer(
kIOMemoryDirectionInOut,
ivars->maxPacketSize,
&ivars->inData);
ret = CreateActionReadComplete(0, &ivars->ioCompleteCallback);
ret = ivars->inPipe->AsyncIO(ivars->inData,
ivars->maxPacketSize,
ivars->ioCompleteCallback,
0);
...
}
Our Driver is started by OS when device is connected. We see that ReadComplete callback is called:
void IMPL(MyDriver, ReadComplete)
{
Log("ReadComplete() - status - %d; bytes count - %d", status, actualByteCount);
}
However it's not obvious how to read data received in this callback. I suspect that we should use IOBufferMemoryDescriptor *inData but we didn't find any good example/sample and documentation is poor.
Our callback is called only once. It's not clear how to read a series of data from device? Should we create some loop and call inPipe->AsyncIO from callback?
Also it would be helpful to see how to pass data to device. I hope we should fill IOBufferMemoryDescriptor *inData.
We are experimenting with DriverKit on macOS while DriverKit is still in beta on iPadOS. We want to build a Driver for iPad that will allow to communicate our iPad App with USB device.
What we did:
Configured and implemented a driver that uses USBDriverKit::IOUSBHostInterface as provider. This driver is automatically matched/started by macOS when we plug our device into USB port. Next we utilised USBDriverKit::IOUSBHostPipe to send/receive data from our device. We print data from device in logs for now.
Studied Communicating Between a DriverKit Extension and a Client App
Configured and implemented a driver that based on IOUserClient and allows to open communication channel by macOs App using IOServiceOpen API. Driver has callback to pass data to macOS Client App.
Currently we want to combine 2 drivers and pass data received from USB device to our client App using callback. Unfortunately, we stuck since now we have 2 instances of driver:
First instance is automatically run by macOS when device is plugged
Second instance is created when we are connecting from Client App and virtual kern_return_t NewUserClient(uint32_t type, IOUserClient** userClient) method is called.
So we can't use second instance to do USB device communication since it has wrong provider(IOUserClient) in kern_return_t Start(IOService * provider) but we need IOUSBHostInterface to start:
ivars->interface = OSDynamicCast(IOUSBHostInterface, provider);
if(ivars->interface == NULL) {
ret = kIOReturnNoDevice;
goto Exit;
}
Are we doing it wrong? Maybe instead of automatic matching for IOUSBHostInterface we should do it manually from UserClient driver or use another approach?
As we learned we have to create a new service instance in NewUserClient method and can't return driver that was run by OS:
kern_return_t IMPL(MyDriver, NewUserClient)
{
kern_return_t ret = kIOReturnSuccess;
IOService* client = nullptr;
ret = Create(this, "UserClientProperties", &client);
if (ret != kIOReturnSuccess)
{
goto Exit;
}
*userClient = OSDynamicCast(IOUserClient, client);
if (*userClient == NULL)
{
client->release();
ret = kIOReturnError;
goto Exit;
}
Exit:
return ret;
}
BTW, maybe there is much easier way to forward data from USB device to iPadOS App?