<br />

Added: 7

## **PROTOCOLS**

## DriverLists

*Defined in [fuchsia.driver.test/internal.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/internal.fidl;l=52)*

This protocol is served when running with the driver_test_realm to be used by the
driver index to dynamically get the list of drivers.
Added: HEAD

<br />

### GetDriverLists

#### Request

\<EMPTY\>

#### Response

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.test#DriverLists_GetDriverLists_Result` |

## Internal

*Defined in [fuchsia.driver.test/internal.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/internal.fidl;l=21)*

This protocol is served when running with the driver_test_realm to be used by the
fake-resolver component to access the various directories and metadata of the test it needs.
Added: HEAD

<br />

### GetBootDirectory

Get the '/boot' directory to be used for the "fuchsia-boot:///" resolver.
If an invalid \|boot_dir\| is returned, the driver test realm's '/pkg' directory is
treated as the boot directory.

#### Request

\<EMPTY\>

#### Response

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.test#Internal_GetBootDirectory_Result` |

### GetBootDriverOverrides

#### Request

\<EMPTY\>

#### Response

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.test#Internal_GetBootDriverOverrides_Result` |

### GetTestPackage

Gets the test component's package directory. This is used to read drivers in this package.
If a test resolution context is available through \|GetTestResolutionContext\|, subpackages
in this test package are also discovered.

#### Request

\<EMPTY\>

#### Response

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.test#Internal_GetTestPackage_Result` |

### GetTestResolutionContext

Gets the test component's resolution context. This is used to open subpackages of the
test package.

#### Request

\<EMPTY\>

#### Response

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.test#Internal_GetTestResolutionContext_Result` |

## ManifestProvider

*Defined in [fuchsia.driver.test/realm.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/realm.fidl;l=217)*
Added: HEAD

<br />

### GetManifest

#### Request

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.test#GetManifestRequest` |

#### Response

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.test#ManifestProvider_GetManifest_Result` |

## Realm

*Defined in [fuchsia.driver.test/realm.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/realm.fidl;l=199)*

This protocol is for the DriverTestRealm. It is an integration test
framework for drivers.

<br />

### Start

Start the realm. Calling this will cause DriverTestRealm to start
servicing other protocols (like /dev/). `args` is used to configure
the DriverTestRealm.

- error `ZX_ERR_ALREADY_EXISTS` the realm has already had `Start` called.

#### Request

| Name | Type |
|---|---|
| `args` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.test#RealmArgs` |

#### Response

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.test#Realm_Start_Result` |

## ResourceProvider

*Defined in [fuchsia.driver.test/internal.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/internal.fidl;l=62)*
Added: HEAD

<br />

### GetDeviceTree

#### Request

\<EMPTY\>

#### Response

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.test#ResourceProvider_GetDeviceTree_Result` |

## **STRUCTS**

### DriverLists_GetDriverLists_Response

*Defined in [fuchsia.driver.test/internal.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/internal.fidl;l=54)*

| Field | Type | Description | Default |
|---|---|---|---|
| `boot_drivers` | `vector<string:150>:200` |   | No default |
| `base_drivers` | `vector<string:150>:200` |   | No default |

### DriverLog

*Defined in [fuchsia.driver.test/realm.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/realm.fidl;l=28)*
Added: 27

<br />

| Field | Type | Description | Default |
|---|---|---|---|
| `name` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.test#DriverName` |   | No default |
| `log_level` | `https://fuchsia.dev/reference/fuchsia.diagnostics.types//https://fuchsia.dev/reference/fuchsia.diagnostics.types#Severity` |   | No default |

### Expose

*Defined in [fuchsia.driver.test/realm.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/realm.fidl;l=47)*
Added: HEAD

<br />

| Field | Type | Description | Default |
|---|---|---|---|
| `service_name` | `string` |   | No default |
| `collection` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.test#Collection` |   | No default |

### Internal_GetBootDirectory_Response [resource](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#value-vs-resource)

*Defined in [fuchsia.driver.test/internal.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/internal.fidl;l=38)*

| Field | Type | Description | Default |
|---|---|---|---|
| `boot_dir` | `client_end:https://fuchsia.dev/reference/fuchsia.io//https://fuchsia.dev/reference/fuchsia.io#Directory?` |   | No default |

### Internal_GetBootDriverOverrides_Response

*Defined in [fuchsia.driver.test/internal.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/internal.fidl;l=42)*

| Field | Type | Description | Default |
|---|---|---|---|
| `boot_overrides` | `vector<string:150>:200` |   | No default |

### Internal_GetTestPackage_Response [resource](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#value-vs-resource)

*Defined in [fuchsia.driver.test/internal.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/internal.fidl;l=25)*

| Field | Type | Description | Default |
|---|---|---|---|
| `test_pkg_dir` | `client_end:https://fuchsia.dev/reference/fuchsia.io//https://fuchsia.dev/reference/fuchsia.io#Directory?` |   | No default |

### Internal_GetTestResolutionContext_Response

*Defined in [fuchsia.driver.test/internal.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/internal.fidl;l=31)*

| Field | Type | Description | Default |
|---|---|---|---|
| `context` | `https://fuchsia.dev/reference/fuchsia.component.resolution//https://fuchsia.dev/reference/fuchsia.component.resolution#Context?` |   | No default |

### ManifestProvider_GetManifest_Response [resource](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#value-vs-resource)

*Defined in [fuchsia.driver.test/realm.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/realm.fidl;l=218)*

| Field | Type | Description | Default |
|---|---|---|---|
| `manifest` | `handle<stream>` |   | No default |

### Offer

*Defined in [fuchsia.driver.test/realm.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/realm.fidl;l=41)*
Added: HEAD

<br />

| Field | Type | Description | Default |
|---|---|---|---|
| `protocol_name` | `string` |   | No default |
| `collection` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.test#Collection` |   | No default |

### Realm_Start_Response

*Defined in [fuchsia.driver.test/realm.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/realm.fidl;l=207)*

\<EMPTY\>

### ResourceProvider_GetDeviceTree_Response [resource](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#value-vs-resource)

*Defined in [fuchsia.driver.test/internal.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/internal.fidl;l=63)*

| Field | Type | Description | Default |
|---|---|---|---|
| `devicetree` | `handle<vmo>` |   | No default |

### SoftwareDevice

*Defined in [fuchsia.driver.test/realm.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/realm.fidl;l=53)*
Added: HEAD

<br />

| Field | Type | Description | Default |
|---|---|---|---|
| `device_name` | `string` |   | No default |
| `device_id` | `uint32` |   | No default |

## **ENUMS**

### Collection [strict](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible)

Type: `uint32`

*Defined in [fuchsia.driver.test/realm.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/realm.fidl;l=34)*
Added: HEAD

<br />

| Name | Value | Description |
|---|---|---|
| ### UNKNOWN | `0` |   |
| ### BOOT_DRIVERS | `1` |   |
| ### PACKAGE_DRIVERS | `2` |   |

## **TABLES**

### GetManifestRequest

*Defined in [fuchsia.driver.test/realm.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/realm.fidl;l=211)*
Added: HEAD

<br />

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `using_subpackage` | `bool` |   |

### RealmArgs [resource](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#value-vs-resource)

*Defined in [fuchsia.driver.test/realm.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/realm.fidl;l=59)*

A list of arguments that can be used to configure DriverTestRealm.

<br />

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `boot` | `client_end:https://fuchsia.dev/reference/fuchsia.io//https://fuchsia.dev/reference/fuchsia.io#Directory` | This is what DriverManager will see as its boot directory. Default: DriverTestRealm's package directory |
| ### 2 | `root_driver` | `string` | The URL for the driver that will be bound to root. Default: fuchsia-boot:///dtr#meta/test-parent-sys.cm NOTE: The test parent driver is not included by default. This must be included in your package to work correctly. |
| ### 4 | `driver_tests_enable_all` | `bool` | If this is true, then DriverManager will enable the unit tests for each driver that is loaded. Default: false |
| ### 5 | `driver_tests_enable` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.driver.test#DriverName>` | If this is true, then DriverManager will enable the unit tests for each driver in this vector. Default: empty |
| ### 6 | `driver_tests_disable` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.driver.test#DriverName>` | If this is true, then DriverManager will disable the unit tests for each driver in this vector. This overrides both a specific request for enabling a test and the 'driver_tests_enable_all' parameter. Default: empty |
| ### 7 | `driver_log_level` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.driver.test#DriverLog>` | Set a log level for the specific driver. Default: Log levels are set to INFO |
| ### 8 | `driver_disable` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.driver.test#DriverName>` | Disable specific drivers. These drivers will not be bound or loaded. Default: empty |
| ### 9 | `driver_bind_eager` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.driver.test#DriverName>` | Specify drivers to bind 'eagerly'. This turns a driver that normally binds as a fallback driver into a driver that will be bound normally. Default: empty |
| ### 10 | `board_name` | `string` | Specify the board name that drivers are aware of. Default: driver-integration-test |
| ### 11 | `offers` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.driver.test#Offer>` | DEPRECATED: Use dtr_offers. Specify additional offers from the test to a driver collection Default: empty Added: HEAD |
| ### 12 | `exposes` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.driver.test#Expose>` | DEPRECATED: Use dtr_exposes. Specify services to expose from the test to a driver collection Default: empty Added: HEAD |
| ### 13 | `pkg` | `client_end:https://fuchsia.dev/reference/fuchsia.io//https://fuchsia.dev/reference/fuchsia.io#Directory` | DEPRECATED: Use test_component to provide resolved test component. The driver test realm can load drivers packaged with the test suite through this directory. Note that this directory must be readable and executable. This can be used if the test suite needs to use some drivers packaged with the DriverTestRealm in addition to drivers packaged with the test suite. In that case, the user can leave RealmArgs::boot unset and use RealmArgs::pkg and RealmArgs::driver_urls. Drivers in this directory can be registered using the `driver_urls` argument below. Default: DriverTestRealm's package directory. Added: HEAD |
| ### 14 | `dtr_offers` | `vector<https://fuchsia.dev/reference/fuchsia.component.test//https://fuchsia.dev/reference/fuchsia.component.test#Capability>` | Specify offers from the test to the driver test realm. The driver test realm will forward these to the driver collections. Default: empty Added: 22 |
| ### 15 | `dtr_exposes` | `vector<https://fuchsia.dev/reference/fuchsia.component.test//https://fuchsia.dev/reference/fuchsia.component.test#Capability>` | Specify exposes from the driver test realm to the test. The driver test realm will forward these from the driver collections. Default: empty Added: 22 |
| ### 16 | `test_component` | `https://fuchsia.dev/reference/fuchsia.component.resolution//https://fuchsia.dev/reference/fuchsia.component.resolution#Component` | The resolved component information of the test component that is starting the driver test realm. This will be used to discover drivers that the test wants to provide to the driver test realm. Drivers can be both in the test component package, or a subpackage of the test component package. By default all drivers discovered that don't also exist in the \|boot\| directory will be considered to be base drivers. Use \|boot_driver_components\| to provide a list of drivers that should be boot drivers. Default: empty Added: 23 |
| ### 17 | `driver_index_stop_timeout_millis` | `int64` | How long the driver index waits idle before it saves state, escrows its handles with the component framework, and shuts down. Default: never shuts down Added: HEAD |
| ### 18 | `software_devices` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.driver.test#SoftwareDevice>:20` | A list of software only devices that should be created. Typically this is used to create fake hardware for tests. Devices will be spawned as platform devices under the platform bus. Note that the platform bus must be the root driver for this to do anything meaningful. Added: HEAD |
| ### 19 | `boot_driver_components` | `vector<string>` | The list of driver component names that should be considered as boot drivers. Boot drivers are started in the boot-drivers collection which has more capabilities available to it. Entries should be the component name (eg: "my_driver_component.cm"). Default: empty Added: 24 |
| ### 20 | `devicetree` | `handle<vmo>` | Devicetree blob that should be handed to the board driver. Added: 27 |
| ### 21 | `platform_vid` | `uint32` | Platform Vendor ID which should be specified to the platform bus driver. Added: 27 |
| ### 22 | `platform_pid` | `uint32` | Platform ID which should be specified to the platform bus driver. Added: 27 |

## **UNIONS**

### DriverLists_GetDriverLists_Result [strict](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible)

*Defined in [fuchsia.driver.test/internal.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/internal.fidl;l=54)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.test#DriverLists_GetDriverLists_Response` |   |
| ### 2 | `err` | `https://fuchsia.dev/reference/zx//https://fuchsia.dev/reference/zx#Status` |   |

<br />

### Internal_GetBootDirectory_Result [strict](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible) [resource](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#value-vs-resource)

*Defined in [fuchsia.driver.test/internal.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/internal.fidl;l=38)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.test#Internal_GetBootDirectory_Response` |   |
| ### 2 | `err` | `https://fuchsia.dev/reference/zx//https://fuchsia.dev/reference/zx#Status` |   |

<br />

### Internal_GetBootDriverOverrides_Result [strict](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible)

*Defined in [fuchsia.driver.test/internal.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/internal.fidl;l=42)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.test#Internal_GetBootDriverOverrides_Response` |   |
| ### 2 | `err` | `https://fuchsia.dev/reference/zx//https://fuchsia.dev/reference/zx#Status` |   |

<br />

### Internal_GetTestPackage_Result [strict](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible) [resource](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#value-vs-resource)

*Defined in [fuchsia.driver.test/internal.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/internal.fidl;l=25)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.test#Internal_GetTestPackage_Response` |   |
| ### 2 | `err` | `https://fuchsia.dev/reference/zx//https://fuchsia.dev/reference/zx#Status` |   |

<br />

### Internal_GetTestResolutionContext_Result [strict](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible)

*Defined in [fuchsia.driver.test/internal.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/internal.fidl;l=31)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.test#Internal_GetTestResolutionContext_Response` |   |
| ### 2 | `err` | `https://fuchsia.dev/reference/zx//https://fuchsia.dev/reference/zx#Status` |   |

<br />

### ManifestProvider_GetManifest_Result [strict](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible) [resource](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#value-vs-resource)

*Defined in [fuchsia.driver.test/realm.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/realm.fidl;l=218)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.test#ManifestProvider_GetManifest_Response` |   |
| ### 2 | `err` | `https://fuchsia.dev/reference/zx//https://fuchsia.dev/reference/zx#Status` |   |

<br />

### Realm_Start_Result [strict](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible)

*Defined in [fuchsia.driver.test/realm.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/realm.fidl;l=207)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.test#Realm_Start_Response` |   |
| ### 2 | `err` | `https://fuchsia.dev/reference/zx//https://fuchsia.dev/reference/zx#Status` |   |
| ### 3 | `framework_err` | `internal` |   |

<br />

### ResourceProvider_GetDeviceTree_Result [strict](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible) [resource](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#value-vs-resource)

*Defined in [fuchsia.driver.test/internal.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/internal.fidl;l=63)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.test#ResourceProvider_GetDeviceTree_Response` |   |
| ### 2 | `err` | `https://fuchsia.dev/reference/zx//https://fuchsia.dev/reference/zx#Status` |   |

<br />

## **CONSTANTS**

| Name | Value | Type | Description |
|---|---|---|---|
| [MAX_DRIVERS](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/internal.fidl;l=15) | `200` | `uint32` | Added: HEAD |
| [MAX_DRIVER_URL](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/internal.fidl;l=13) | `150` | `uint32` | Added: HEAD |
| [MAX_SOFTWARE_DEVICES](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/realm.fidl;l=19) | `20` | `uint32` | Added: HEAD |

## **ALIASES**

| Name | Value | Description |
|---|---|---|
| [DriverName](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.test/realm.fidl;l=16) | `string`\[`https://fuchsia.dev/reference/fidl//https://fuchsia.dev/reference/fidl#MAX`\] | A driver name is the name defined in ZIRCON_DRIVER_BEGIN begin macro for a specific driver. |