fuchsia.driver.framework

Property key.

Condition for evaluating the property values in the matching process. The values must be ACCEPT or REJECT.

A list of property values. Must not be empty. The property values must be the same type.

Key for the property. Integer-based keys are no longer supported. The NodePropertyKey must be a string value.

Value for the property.

Property key.

Property value.

Name of the node that has |node_properties|.

Node properties that belong to the node whose name is |node_name|. If the node is a composite then |properties| is empty and does not contain its parents' properties.

Name of the node that has |node_properties|.

Node properties that belong to the node whose name is |node_name|. If the node is a composite then |properties| is empty and does not contain its parents' properties.

Parent's bind rules. Property keys must be unique. Must not be empty.

Properties for matching against a composite driver's bind rules. Keys must be unique.

PLATFORM

ACPI

DEVICE_TREE

PCI

USB

GPIO

I2C

SPI

SDIO

UART

SPMI

MISSING_ARGS

An argument of the composite node spec was not provided.

EMPTY_NODES

The given composite node spec's nodes is empty.

ALREADY_EXISTS

The name in the given composite node spec is a duplicate of an already created composite node spec.

DRIVER_INDEX_FAILURE

The spec failed to be added to the driver index.

UNKNOWN

ACCEPT

REJECT

UNSTABLE_BETWEEN_DRIVER_RESTART

When the driver is restarted, the device address may change.

UNSTABLE_BETWEEN_BOOT

When the system is restarted, the device address may change.

UNSTABLE_BETWEEN_SOFTWARE_UPDATE

When the system is updated, the device address may change.

STABLE

The device address on the bus is guaranteed stable for the lifetime of the system.

BOOT

BOOT packages are inside the Zircon boot image.

BASE

BASE packages are included in the Fuchsia build as static local packages.

CACHED

CACHED packages are BASE packages that can be updated during a resolve if a full package resolver is available.

UNIVERSE

UNIVERSE packages get onto the device only when resolved by the full package resolver.

INTERNAL

NODE_REMOVED

NAME_MISSING

NAME_INVALID

The Node's name is invalid. Specifically, it must not contain a period in its name.

NAME_ALREADY_EXISTS

A sibling Node exists with the same name.

OFFER_SOURCE_NAME_MISSING

An offer for this Node is missing a source name.

OFFER_REF_EXISTS

An offer for this Node should not have a source or target.

SYMBOL_NAME_MISSING

A symbol for this Node is missing a name.

SYMBOL_ADDRESS_MISSING

A symbol for this Node is missing an address.

SYMBOL_ALREADY_EXISTS

There is another symbol for this Node with the same name.

UNBIND_CHILDREN_IN_PROGRESS

The node is in the process of unbinding all of its children.

UNSUPPORTED_ARGS

The Node contains unsupported arguments, such as deprecated property keys or offers.

1

The type of bus this node sits on.

2

A unique identifier that describes the identity of this device on the given bus.

3

How stable the address.

1

The name of the composite as specified in the driver's composite bind rules.

2

General information for the driver.

1

Information for the composite driver that has matched.

2

A list of all the parent names, ordered by index. These names come from the node definitions in the driver's composite bind rules.

3

The primary node index. Identified by the primary node in the driver's composite bind rules.

1

The spec information that this composite node spec was created with.

2

Information for the node spec that is available only when a driver has matched to the properties in this spec's parents.

1

The composite node spec's name.

2

The nodes in the composite node spec. Must not be empty. The first node is the primary node.

1

Information about the composite that this is a parent of.

2

The index of this parent in the spec's parents.

1

This is the connector to be installed in devfs. Connect() will be called when a client connects to this node in the filesystem. Optional: If this is not provided then an empty node will appear in devfs.

2

This is the class name for installing this node in devfs. The node will be placed within /dev/class/{class_name}. If class_name does not exist under /dev/class/ it will be created. Optional: If this is not provided then the node will only be added via topological path.

3

This is a vmo of inspect data that will be installed in devfs. Optional: If this is not provided then the devfs's inspect data will be empty.

4

The connection types that are supported by the |connector| given. The driver framework should handle connection types that are not supported by the connector. If not provided, only the device type is assumed as supported by the connector.

5

This is the controller connector to be installed in devfs. Connect() will be called when a client connects to the device_controller connection for this node in the filesystem. Optional: If this is not provided then the Node will handle the connection natively. This option should only be used by the compat shim or in tests

1

2

1

URL of the driver component.

2

Name of the driver, taken from the first field of the ZIRCON_DRIVER macro in the driver.

3

If this is true then the driver should be colocated in its parent's DriverHost.

4

The type of package this driver is in.

5

If this is true then the driver is a fallback driver. Fallback drivers have a lesser priority for binding, so they will only be chosen for binding if there is no non-fallback driver that has matched.

6

Device categories

7

Bind rules which declare set of constraints to evaluate in order to determine whether the driver indexer should bind this driver to a device.

8

The version of the driver framework that this driver is using. Supported values are 1 (DFv1) and 2 (DFv2). If not provided, 1 is the assumed version.

9

Whether the driver is disabled. If true, this driver is not chosen to bind to nodes.

1

Node that the driver is bound to.

2

Symbols provided to the driver, for |node|. These come from the driver that added |node|, and are filtered to the symbols requested in the bind program.

3

URL of the package containing the driver. This is purely informational, used only to provide data for inspect.

4

Information about the driver to start. Currently, we support the following entries:

1. "binary": a string containing the package-relative path to the driver binary.
2. "colocate" (optional): a string containing "true" or "false" specifying whether the driver should be colocated in the same driver host as the driver that added |node|. If not specified, the driver will be launched in a new driver host.
3. "default_dispatcher_opts" (optional): an array of strings specifying the options for creating the default dispatcher. A string can be one of the following:
   • allow_sync_calls: allows synchronous calls to be done on the default dispatcher's thread.
4. "default_dispatcher_scheduler_role" (optional): the scheduler role to set for the default dispatcher created for the driver.

5

Incoming namespace provided to the driver.

6

Outgoing directory served by the driver.

7

Configuration passed to the driver.

8

The name of the node the driver is bound to.

9

Node properties of the node the driver is bound to. If the node is non-composite then the "default" entry will contain the node's own properties. If the node is a composite then there is an entry for each of its parents and the "default" entry will reference the primary composite parent node's properties. The composite parent node's properties are those that were provided in the composite node specification and not the original properties of the parent.

10

Node offers of the node the driver is bound to.

11

Provides a token representing this node which can be exchanged with the driver framework to discern additional information about this node.

12

1

Name of the node.

2

Capabilities to offer to the driver that is bound to this node. The driver must ensure these capabilities are added to its outgoing directory before adding the child node.

3

Functions to provide to the driver that is bound to this node.

4

Properties of the node. Deprecated: all new usages should set properties2 and leave this field blank.

5

The arguments for how this node should be added to devfs.

6

Capabilities to offer to the driver that is bound to this node. The driver must ensure these capabilities are added to its outgoing directory before adding the child node.

7

Information that feeds into a structured bus topology for the device. It should only be specified by bus drivers, ideally those which are included by default.

8

Properties of the node. If set, the properties field must be blank. Otherwise, adding the node will return an error.

1

If this is true, then the node unbinds from its matched driver before it attempts to bind through the normal bind process.

2

If this is set, then only drivers matching this URL suffix will be considered in binding. E.g: "gpt.cm", "meta/gpt.cm", "fuchsia-boot:///#meta/gpt.cm".

1

Name of the symbol.

2

Virtual address of the symbol, within a driver host's process.

1

2

3

1

A fixed integer id, eg a spi bus address

2

An array of integers, eg a PCI BDF.

3

A uint32 value that can be interpretted as a 4 character sequence.

4

An array of character sequences, eg a ACPI node path.

5

A generic string, eg the device tree node path.

1

2

3

1

2

3

1

Integer-based keys are no longer supported. Use |string_value| instead.

2

1

2

3

4

1

2

3

1

2