fuchsia.driver.test

Added: 7

PROTOCOLS

Internal

Defined in fuchsia.driver.test/internal.fidl

This protocol is served by the driver_test_realm component to be used by the inner fake-resolver component.

Added: HEAD

GetTestPackage

Gets the test component's package directory. This is used to read drivers in this package and find the list of its subpackages.

Request

<EMPTY>

Response

NameType
payload Internal_GetTestPackage_Result

GetTestResolutionContext

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

Request

<EMPTY>

Response

NameType
payload Internal_GetTestResolutionContext_Result

Realm

Defined in fuchsia.driver.test/realm.fidl

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

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

NameType
args RealmArgs

Response

NameType
payload Realm_Start_Result

STRUCTS

DriverLog

Defined in fuchsia.driver.test/realm.fidl

FieldTypeDescriptionDefault
name DriverName No default
log_level fuchsia.diagnostics/Severity No default

Expose

Defined in fuchsia.driver.test/realm.fidl

Added: HEAD

FieldTypeDescriptionDefault
service_name string No default
collection Collection No default

Internal_GetTestPackage_Response resource

Defined in fuchsia.driver.test/internal.fidl

FieldTypeDescriptionDefault
test_pkg_dir fuchsia.io/Directory No default

Internal_GetTestResolutionContext_Response

Defined in fuchsia.driver.test/internal.fidl

FieldTypeDescriptionDefault
context fuchsia.component.resolution/Context No default

Offer

Defined in fuchsia.driver.test/realm.fidl

Added: HEAD

FieldTypeDescriptionDefault
protocol_name string No default
collection Collection No default

Realm_Start_Response

Defined in fuchsia.driver.test/realm.fidl

<EMPTY>

SoftwareDevice

Defined in fuchsia.driver.test/realm.fidl

Added: HEAD

FieldTypeDescriptionDefault
device_name string No default
device_id uint32 No default

ENUMS

Collection strict

Type: uint32

Defined in fuchsia.driver.test/realm.fidl

Added: HEAD

NameValueDescription
0
1
2

TABLES

RealmArgs resource

Defined in fuchsia.driver.test/realm.fidl

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

OrdinalFieldTypeDescription
boot fuchsia.io/Directory

This is what DriverManager will see as its boot directory. Default: DriverTestRealm's package directory

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.

use_driver_framework_v2 bool

If this is true, then DriverManager will load DFv2 drivers. Default: false

Removed: 18
driver_tests_enable_all bool

If this is true, then DriverManager will enable the unit tests for each driver that is loaded. Default: false

driver_tests_enable vector<string>

If this is true, then DriverManager will enable the unit tests for each driver in this vector. Default: empty

driver_tests_disable vector<string>

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

driver_log_level vector<DriverLog>

Set a log level for the specific driver. Default: Log levels are set to INFO

driver_disable vector<string>

Disable specific drivers. These drivers will not be bound or loaded. Default: empty

driver_bind_eager vector<string>

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

board_name string

Specify the board name that drivers are aware of. Default: driver-integration-test

offers vector<Offer>

DEPRECATED: Use dtr_offers. Specify additional offers from the test to a driver collection Default: empty

Added: HEAD
exposes vector<Expose>

DEPRECATED: Use dtr_exposes. Specify services to expose from the test to a driver collection Default: empty

Added: HEAD
pkg 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
dtr_offers vector<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
dtr_exposes vector<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
test_component 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
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
software_devices vector<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
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: NEXT

UNIONS

Internal_GetTestPackage_Result strict resource

Defined in fuchsia.driver.test/internal.fidl

OrdinalVariantTypeDescription
response Internal_GetTestPackage_Response
err zx/Status

Internal_GetTestResolutionContext_Result strict

Defined in fuchsia.driver.test/internal.fidl

OrdinalVariantTypeDescription
response Internal_GetTestResolutionContext_Response
err zx/Status

Realm_Start_Result strict

Defined in fuchsia.driver.test/realm.fidl

OrdinalVariantTypeDescription
response Realm_Start_Response
err zx/Status
framework_err internal

CONSTANTS

NameValueTypeDescription
MAX_SOFTWARE_DEVICES 20 uint32
Added: HEAD

ALIASES

NameValueDescription
DriverName string[fidl/MAX]

A driver name is the name defined in ZIRCON_DRIVER_BEGIN begin macro for a specific driver.