# Develop a driver To adapt hardware, follow the [driver checklist](/porting/drivers). It covers component drivers and board-package services in dependency order. UniXNU has three driver layers. Each layer runs in a different environment and has a different build and load path. | Layer | Runs in | Built as | Loaded by | | --- | --- | --- | --- | | UEFI driver | UEFI boot services | EDK II `.efi` | Firmware dispatch, UniXNU `[[driver]]`, or a kit | | Built-in XNU driver | XNU kernel | Static archive linked into the kernel | The kernel at boot | | Kext bundle | XNU kernel, staged by UEFI | `.kext` bundle | An XNU loader that implements the protocol | ## Procedure {#procedure} 1. Search the [component catalog](/reference/components) and [existing repositories](/drivers/repositories) for the hardware interface. Read the candidate's scope, ABI, dependencies and implementation. 2. Choose the [execution layer](#choosing-a-layer) from when the capability is needed: firmware, built-in XNU or a supported loader's kext path. 3. Identify the provider and resources using [matching](#matching) and [device-tree rules](/drivers/device-tree-matching). Record the actual board values. 4. Follow the corresponding implementation procedure: [UEFI](/drivers/uefi-drivers), [built-in XNU](/drivers/xnu-drivers#procedure), or [kext staging](/drivers/kexts#procedure). Add the component and recipe to the device selection. 5. Build the affected artifact and follow the subsystem's [adaptation checks](/porting/drivers). Record source/build results and device behavior separately in [porting.toml](/porting/records). ## Choosing a layer | Need | Layer | | --- | --- | | Display, input or storage available before XNU | UEFI driver | | Platform expert, CPU, interrupt controller, storage, display or GPU inside XNU | Built-in XNU driver | | A bundle that an external loader validates and injects at runtime | Kext bundle | A UEFI driver can provide the framebuffer and input for the UniXNU menu. It can also publish a protocol that another UEFI driver consumes. A built-in XNU driver has full kernel API access. It is compiled against the exact XNU build ABI and force-loaded into the kernel. A kext bundle keeps the standard bundle layout. UniXNU stages the plist and the executable and passes them to the loader. The loader owns validation, dependency resolution and injection. ## Matching UEFI drivers bind through the UEFI driver model or run as applications. XNU drivers bind through `IOKitPersonalities`. A personality names the provider class, the driver class, an optional name match and a probe score. | Key | Meaning | | --- | --- | | `IOClass` | Driver class | | `IOProviderClass` | Provider class | | `IONameMatch` | Provider name or `compatible` value | | `IOProbeScore` | Higher scores probe first | | `IOMatchCategory` | Allows a second driver to match the same provider | | `IOResourceMatch` | Waits for a named resource, for example `IOBSD` | Built-in personalities live in `iokit/KernelConfigTables.cpp`. Kext personalities live in the bundle `Info.plist`. ## Device tree The ADT describes the hardware. The platform expert publishes a nub for each `arm-io` child. A driver reads its resources from the provider: ```cpp OSData *reg = OSDynamicCast(OSData, provider->getProperty("reg")); ``` The `compatible` property selects a driver. `IONameMatch` compares against the provider name. ## Driver directories | Directory | Contents | | --- | --- | | `drivers/` | Built-in XNU driver source and reference `Info.plist` | | `kits/` | Kernel library linked into a driver or the kernel | | `package/UniXNUPkg/Driver` | UEFI drivers | | `package/UniXNUPkg/Test` | UEFI test drivers and payloads | Drivers and kits are independent repositories. Profiles select catalog components, and feeds or local overrides supply sources. Check the [component catalog](/reference/components) before adding an implementation. ## Next steps - [Driver repositories](/drivers/repositories) - [UEFI drivers](/drivers/uefi-drivers) - [XNU drivers](/drivers/xnu-drivers) - [Adreno 740 driver](/drivers/adreno740) - [Kext bundles](/drivers/kexts) - [Device tree matching](/drivers/device-tree-matching)