DriverKit entitlement eligibility and USB matching for Roland DEMORA audio on macOS

We’re evaluating a macOS driver for Roland DEMORA audio on Apple Silicon. The device identifies as USB VID 0x0582, PID 0x01AF. The audio scope is IF1 for isochronous output and IF2 for isochronous input. We want to leave IF3 available to another client.

Apple’s documentation describes descriptor-based USB transport entitlements and team-specific entitlement approval. Our candidate is a service matched to IOUSBHostDevice that opens IF1 and IF2 concurrently as a client. We’d like to confirm which service and provider arrangement Apple supports for this device.

  1. Can an independent developer team qualify for USBDriverKit transport access to this third-party VID/PID during development? What additional requirements apply for distribution?
  2. Is Roland’s authorization required for either stage? If so, what documentation should the developer provide?
  3. What is the narrowest supported matching and provider arrangement for opening IF1 and IF2 while leaving IF3 available? Is a device-matched service supported, or should separate IOUSBHostInterface services coordinate with the audio service?
  4. For the supported arrangement, which services need the USBDriverKit transport and AudioDriverKit family entitlements, and can those entitlements be provisioned together where needed?

Links to the applicable documentation or a supported example would be appreciated. USB transport entitlement · DriverKit entitlement request process

You posted this twice, also here: https://developer.apple.com/forums/thread/857355

To avoid clogging up the forum, add a reply to your other thread pointing at this one and mark it resolved.

  1. from memory, yes. I can't find the forum post about this, but apparently managed capabilities aren't solely for the use of the device vendor. The end user makes a decision to approve your driver, or not.
  2. no, see above
  3. see https://developer.apple.com/library/archive/qa/qa1076/_index.html. Yes it is ancient, but the matching criteria have not changed. Be careful not to match on any more keys than you need, because you can end up matching nothing. Whether you match with the device or the interface depends on what you are doing. You said your want "service matched to IOUSBHostDevice that opens IF1 and IF2 concurrently" but that sounds more like you want a "two services matched to IF1 and IF2 which are aware of one another".
  4. Sorry I don't know much about AudioDriverKit

Can an independent developer team qualify for USBDriverKit transport access to this third-party VID/PID during development?

The development entitlement can match anything. It's not unusual for development or test hardware to be built using a vid/pid that's unrelated to the final hardware (for example, the bridge board hardware), so one of our goals was to not interfere with that. More practically, we're not really "enabling" any additional functionality, because you could always do DEXT development by disabling SIP.

What additional requirements apply for distribution?

We don't have a public set of formal requirements, but the basic requirement is that you're building a DEXT to support a particular piece of hardware (or a collection of devices).

Is Roland’s authorization required for either stage? If so, what documentation should the developer provide?

Generally speaking, no. Third party drivers have a long history on macOS and preventing/eliminating that is not one of our goals.

What is the narrowest supported matching and provider arrangement for opening IF1 and IF2 while leaving IF3 available? Is a device-matched service supported, or should separate IOUSBHostInterface services coordinate with the audio service?

The link to QA1076 is a good reference but the general answer is that IOKit matching is sufficiently flexible that you should be able to match whatever you need to match.

For the supported arrangement, which services need the USBDriverKit transport and AudioDriverKit family entitlements,

I'm not entirely sure what you mean here, but the general answer is that each family requires it's own entitlement. So a USB Audio DEXT has both the USB entitlement and the audio entitlement. Note that the USB and PCI families were both designed as "support" families, which would be used in conjunction with other families. So a USB audio DEXT works by subclassing one the AudioDriverKit families while and using USBDriverKit to communicate with it's provider.

and can those entitlements be provisioned together where needed?

Yes and, in fact, it's expected that most request include multiple families. Particularly for USB, the entire "point" of USBDriverKit is to use one of the other DriverKit families to provide services back "into" the system. If all you needed to do was talk to a USB device, you could just use the IOUSBHost Framework.

__
Kevin Elliott
DTS Engineer, CoreOS/Hardware