<br />

Added: HEAD

## **PROTOCOLS**

## CompositeNodeManager

*Defined in [fuchsia.driver.framework/composite_node_spec.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/composite_node_spec.fidl;l=79)*

Protocol through which board drivers can create composite node specs.

Composite node specs are created at runtime to dynamically bridge the
static bind rules of a composite driver with the dynamic bind properties
of nodes in the system so that the driver bind rules are more generic and reusable.

<br />

### AddSpec

Adds the given composite node specification to the driver framework.

#### Request

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

#### Response

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

## Driver

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

This protocol is used by the Driver Framework's Driver Host to communicate various messages and
lifecycle hooks to the driver. The connection for this protocol is established through the
\|DriverRegistration\| defined in the `driver_symbols` library.

Once the driver has closed its server end, the Driver Framework will initiate the shutdown
of all dispatchers belonging to this driver.

<br />

### HealthCheck

Requests the driver to perform a self-diagnostic check.

The Driver Host never issues `HealthCheck` between `Driver.Suspend` and
the completion of `Driver.Resume`, answering
`HealthCheckError.INVALID_STATE` itself while the driver is suspended or
transitioning power states.

#### Request

| Name | Type |
|---|---|
| `request` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#HealthCheckRequest` |

#### Response

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

### OnHealthAlert

Proactively emitted by the driver when it detects an asynchronous
self-fault or suspects an upstream/downstream neighbor.

#### Response

| Name | Type |
|---|---|
| `alert` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#HealthAlert` |

### Resume

Returns when the driver has resumed the hardware.
This is called when the power framework requests the power element move to the on power state.
The driver should turn the hardware back on as a response to this call.

\|power_element_lease\| is the lease associated with the current wake if the
wake was from a wake vector. Otherwise it is None.

Note on execution order after a resume is requested by the power element:

- This method is called (the dispatcher does not accept any other work at this point)
- Once this method completes, dispatchers start accepting new work in the work queue

Added: HEAD

#### Request

| Name | Type |
|---|---|
| `power_element_lease` | `https://fuchsia.dev/reference/fuchsia.power.broker//https://fuchsia.dev/reference/fuchsia.power.broker#LeaseToken` |

#### Response

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

### Start

Starts the driver with the given \|start_args\|.

Drivers should finish their initial setup and enumeration before returning from \|Start\|.
In particular they should enumerate all currently available nodes by utilizing
`fuchsia.driver.framework/Node.AddChild` and waiting for all calls to be completed.

The Framework will not consider the driver to be started until this call has returned
successfully. Therefore a driver will not have \|Stop\| called on it until after it has
replied to \|Start\| successfully.

If a driver returns an error, it will not have \|Stop\| called on it before the
Driver Framework initiates shutdown of the driver's dispatchers. Therefore it should have
performed all necessary cleanup before returning an error.

#### Request

| Name | Type |
|---|---|
| `start_args` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#DriverStartArgs` |

#### Response

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

### Stop

Stops the driver. To stop, the driver should teardown any resources it set up in or after
\|Start\|. This is a one-way FIDL method. When the driver has completed stopping, it should
close its server end. Asynchronous operations should fully complete before closing
the server end.

#### Request

\<EMPTY\>

### Suspend

Returns when the driver has suspended the hardware.
This is called when the power element requests the off power state.
The driver should turn off the hardware as a response to this call.

Note on execution order after a suspend is requested by the power element:

- dispatchers stop accepting new work in the work queue
- dispatcher drains previously queued work
- Once all work is drained, this method is called

The driver will not immediately \|Stop\| after it has been suspended.
It will first go through \|Resume\| before it is told to \|Stop\|.
Added: HEAD

#### Request

\<EMPTY\>

#### Response

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

## Health

*Defined in [fuchsia.driver.framework/health.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/health.fidl;l=141)*

Protocol composed into `Driver` for performing active health checks and
receiving proactive health alerts.

<br />

### HealthCheck

Requests the driver to perform a self-diagnostic check.

The Driver Host never issues `HealthCheck` between `Driver.Suspend` and
the completion of `Driver.Resume`, answering
`HealthCheckError.INVALID_STATE` itself while the driver is suspended or
transitioning power states.

#### Request

| Name | Type |
|---|---|
| `request` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#HealthCheckRequest` |

#### Response

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

### OnHealthAlert

Proactively emitted by the driver when it detects an asynchronous
self-fault or suspects an upstream/downstream neighbor.

#### Response

| Name | Type |
|---|---|
| `alert` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#HealthAlert` |

## Node

*Defined in [fuchsia.driver.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=333)*

Protocol through which a driver manages a node that it is bound to.
Drivers should maintain their client connection to the node. Dropping
the client connection while the driver is running will cause the
driver framework to remove the driver and node from the topology.
If the driver has set `host_restart_on_crash` to "true" in their
component manifest, dropping the connection will initiate a restart of
the driver host and driver.

<br />

### AddChild

Adds a child node to this node.

If `node` is present, this driver takes responsibility for binding to
the newly created child. Otherwise, the driver framework will locate an
appropriate driver to bind the child to.

#### Request

| Name | Type |
|---|---|
| `args` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#NodeAddArgs` |
| `controller` | `server_end:https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#NodeController` |
| `node` | `server_end:https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#Node?` |

#### Response

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

### ProvideResource

Provides a resource that other nodes can depend on. The lifetime of the
provided resource is tied to the `controller` client connection. Dropping
the client connection will cause the resource to be removed.
Added: HEAD

#### Request

| Name | Type |
|---|---|
| `resource` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#ResourceArgs` |
| `controller` | `server_end:https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#ResourceController` |

#### Response

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

## NodeController

*Defined in [fuchsia.driver.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=249)*

Protocol through which a parent node controls one of its children.

<br />

### OnBind

Event that is triggered when the associated `Node` is bound to a driver.
Replaced with WaitForDriver.

#### Response

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

### Remove

Removes the node and all of its children.

#### Request

\<EMPTY\>

### RequestBind

Request that the framework attempts to bind a driver to this node.
This is an *additional* request for binding as the framework attempts to bind a node once
when the node is created.

- error `ZX_ERR_ALREADY_BOUND` if the node is already bound and `force_rebind` is false.
- error `ZX_ERR_ALREADY_EXISTS` if the node has an outstanding \|RequestBind\| call which has not completed.

#### Request

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

#### Response

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

### WaitForDriver

Hanging get style call that returns a terminal state for the associated `Node`,
or the composite node that is parented by this node.
For a successfully started driver this returns immediately with the token of the
node that the driver started on.
If an error happens we wait until bootup is complete, which is when all drivers that
can bind and start have done so, before returning the error.

#### Request

\<EMPTY\>

#### Response

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

## NodeManager

*Defined in [fuchsia.driver.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=407)*

Protocol through which a client can add a Node2 to the driver topology.
Added: HEAD

<br />

### AddNode

Adds a Node2 to the driver framework.

#### Request

| Name | Type |
|---|---|
| `node` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#Node2` |
| `controller` | `server_end:https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#NodeController` |
| `node_ref` | `server_end:https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#Node?` |

#### Response

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

## ResourceController

*Defined in [fuchsia.driver.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=357)*

Protocol through which the resource's provider can use to control it.
Added: HEAD

<br />

### Remove

Removes the resource.

#### Request

\<EMPTY\>

## **STRUCTS**

### BindRule2

*Defined in [fuchsia.driver.framework/composite_node_spec.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/composite_node_spec.fidl;l=16)*

Represents a bind rule in a parent specification.

<br />

| Field | Type | Description | Default |
|---|---|---|---|
| `key` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#NodePropertyKeyString` | Property key. | No default |
| `condition` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#Condition` | Condition for evaluating the property values in the matching process. The values must be ACCEPT or REJECT. | No default |
| `values` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#NodePropertyValue>:64` | A list of property values. Must not be empty. The property values must be the same type. | No default |

### CompositeNodeManager_AddSpec_Response

*Defined in [fuchsia.driver.framework/composite_node_spec.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/composite_node_spec.fidl;l=81)*

\<EMPTY\>

### Driver_Resume_Response

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

\<EMPTY\>

### Driver_Start_Response

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

\<EMPTY\>

### Driver_Suspend_Response

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

\<EMPTY\>

### HealthDiagnosticItem

*Defined in [fuchsia.driver.framework/health.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/health.fidl;l=76)*

Key-value diagnostic property captured during a driver health check.

<br />

| Field | Type | Description | Default |
|---|---|---|---|
| `key` | `string:64` |   | No default |
| `value` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#HealthDiagnosticValue` |   | No default |

### NodeController_RequestBind_Response

*Defined in [fuchsia.driver.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=267)*

\<EMPTY\>

### NodeManager_AddNode_Response

*Defined in [fuchsia.driver.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=413)*

\<EMPTY\>

### NodeProperty2

*Defined in [fuchsia.driver.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=72)*

| Field | Type | Description | Default |
|---|---|---|---|
| `key` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#NodePropertyKeyString` | Property key. | No default |
| `value` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#NodePropertyValue` | Property value. | No default |

### NodePropertyEntry2

*Defined in [fuchsia.driver.framework/driver_start_args.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/driver_start_args.fidl;l=17)*

Contains the node properties that belong to a node.

<br />

| Field | Type | Description | Default |
|---|---|---|---|
| `name` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#NodeName` | Name of the node that has \|node_properties\|. | No default |
| `properties` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#NodeProperties` | 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. | No default |

### Node_AddChild_Response

*Defined in [fuchsia.driver.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=343)*

\<EMPTY\>

### Node_ProvideResource_Response

*Defined in [fuchsia.driver.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=352)*

\<EMPTY\>

### ParentSpec2

*Defined in [fuchsia.driver.framework/composite_node_spec.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/composite_node_spec.fidl;l=33)*

Specification for a node that parents the composite node created from the
composite node specification.

<br />

| Field | Type | Description | Default |
|---|---|---|---|
| `bind_rules` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#BindRule2>:64` | Parent's bind rules. Property keys must be unique. Must not be empty. | No default |
| `properties` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#NodeProperty2>:64` | Properties for matching against a composite driver's bind rules. Keys must be unique and string-based. | No default |

### ResourceProperty

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

<br />

| Field | Type | Description | Default |
|---|---|---|---|
| `key` | `string` | Key for the property. | No default |
| `value` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#ResourcePropertyValue` | Value for the property. | No default |

## **ENUMS**

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

Type: `uint32`

*Defined in [fuchsia.driver.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=112)*

| Name | Value | Description |
|---|---|---|
| ### PLATFORM | `1` |   |
| ### ACPI | `2` |   |
| ### DEVICE_TREE | `3` |   |
| ### PCI | `4` |   |
| ### USB | `5` |   |
| ### GPIO | `6` |   |
| ### I2C | `7` |   |
| ### SPI | `8` |   |
| ### SDIO | `9` |   |
| ### UART | `10` |   |
| ### SPMI | `11` |   |
| ### USB_PERIPHERAL | `12` |   |
| ### VIRTIO | `13` |   |

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

Type: `uint32`

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

Error codes for the CompositeNodeManager protocol.

<br />

| Name | Value | Description |
|---|---|---|
| ### MISSING_ARGS | `1` | An argument of the composite node spec was not provided. |
| ### EMPTY_NODES | `2` | The given composite node spec's `nodes` is empty. |
| ### ALREADY_EXISTS | `3` | The `name` in the given composite node spec is a duplicate of an already created composite node spec. |
| ### DRIVER_INDEX_FAILURE | `4` | The spec failed to be added to the driver index. |
| ### DUPLICATE_PARENTS | `5` | The `parents` and `parents2` fields were both specified. |

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

Type: `uint32`

*Defined in [fuchsia.driver.framework/composite_node_spec.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/composite_node_spec.fidl;l=8)*

Represents a bind rule condition.

<br />

| Name | Value | Description |
|---|---|---|
| ### UNKNOWN | `0` |   |
| ### ACCEPT | `1` |   |
| ### REJECT | `2` |   |

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

Type: `uint32`

*Defined in [fuchsia.driver.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=145)*

| Name | Value | Description |
|---|---|---|
| ### UNSTABLE_BETWEEN_DRIVER_RESTART | `0` | When the driver is restarted, the device address may change. |
| ### UNSTABLE_BETWEEN_BOOT | `1` | When the system is restarted, the device address may change. |
| ### UNSTABLE_BETWEEN_SOFTWARE_UPDATE | `2` | When the system is updated, the device address may change. |
| ### STABLE | `3` | The device address on the bus is guaranteed stable for the lifetime of the system. |

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

Type: `uint8`

*Defined in [fuchsia.driver.framework/driver_info.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/driver_info.fidl;l=11)*

The type of Fuchsia package that a driver component is inside of.
More details about the various package categories are available at:
https://fuchsia.dev/fuchsia-src/concepts/packages/package#types_of_packages

<br />

| Name | Value | Description |
|---|---|---|
| ### BOOT | `0` | BOOT packages are inside the Zircon boot image. |
| ### BASE | `1` | BASE packages are included in the Fuchsia build as static local packages. |
| ### CACHED | `2` | CACHED packages are BASE packages that can be updated during a resolve if a full package resolver is available. |
| ### UNIVERSE | `3` | UNIVERSE packages get onto the device only when resolved by the full package resolver. |

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

Type: `uint32`

*Defined in [fuchsia.driver.framework/health.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/health.fidl;l=43)*

Error codes returned when a health check cannot be completed.

<br />

| Name | Value | Description |
|---|---|---|
| ### TIMEOUT | `1` | The driver did not respond within the level's deadline (dispatcher wedged). |
| ### INTERNAL_ERROR | `2` | Internal framework or transport error while routing the check. |
| ### NOT_SUPPORTED | `3` | The driver or requested `HealthCheckRequest` level is not supported. |
| ### INVALID_STATE | `4` | The driver is not in the RUNNING state (e.g., Starting, Stopping, Suspended). |
| ### UNAVAILABLE | `5` | The requested level cannot be evaluated right now: hardware powered off, suspended, not yet initialized, or transiently busy. Consumers must treat this as no information, not as unhealthy. `PING` must never return this. |
| ### COMMUNICATION_ERROR | `6` | A bus, MMIO, or transport error occurred while performing the check itself. |
| ### NOT_FOUND | `7` | No bound node matched the requested moniker (returned by `fuchsia.driver.development/Manager.RunHealthCheck`). |

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

Type: `uint32`

*Defined in [fuchsia.driver.framework/health.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/health.fidl;l=10)*

Specifies the depth and latency budget of a driver health check.

<br />

| Name | Value | Description |
|---|---|---|
| ### PING | `1` | Software-only liveness: dispatcher responsive, locks acquirable, in-memory state consistent. No bus I/O (I2C/SPI/DSI); MMIO reads only if the block is known to be powered and clocked. Must never return `UNAVAILABLE`. Recommended: \< 1ms. Deadline (enforced by driver-host): 250ms. |
| ### FAST | `2` | Bounded, non-destructive hardware reads or progress windows (wait one frame period for a TE/VSync edge, read a status register over I2C/DSI). Must not clear read-on-clear registers or disturb active DMA or scanout. Recommended: \< 25ms. Deadline: 2s. |
| ### DEEP | `3` | Extended self-test / BIST. May interrupt active I/O for the duration of the check but must restore prior state. Only issued on explicit operator request (ffx / lab tests), never during framework-initiated sweeps. Recommended: \< 10s. Deadline: 2min. |

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

Type: `uint32`

*Defined in [fuchsia.driver.framework/health.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/health.fidl;l=32)*

Operational health status reported for a driver or condition.

<br />

| Name | Value | Description |
|---|---|---|
| ### OK | `1` | Driver and hardware are operating within normal parameters. |
| ### DEGRADED | `2` | Driver is functioning but experiencing elevated errors, resource leaks, or quality degradation. |
| ### UNHEALTHY | `3` | Driver or underlying hardware is wedged, unresponsive, or failed initialization. |

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

Type: `uint32`

*Defined in [fuchsia.driver.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=288)*

Error codes for the Node protocol.

<br />

| Name | Value | Description |
|---|---|---|
| ### INTERNAL | `1` |   |
| ### NODE_REMOVED | `2` |   |
| ### NAME_MISSING | `3` |   |
| ### NAME_INVALID | `4` | The Node's name is invalid. Specifically, it must not contain a period in its name. |
| ### NAME_ALREADY_EXISTS | `5` | A sibling Node exists with the same name. |
| ### OFFER_SOURCE_NAME_MISSING | `6` | An offer for this Node is missing a source name. |
| ### OFFER_REF_EXISTS | `7` | An offer for this Node should not have a source or target. |
| ### SYMBOL_NAME_MISSING | `8` | A symbol for this Node is missing a name. |
| ### SYMBOL_ADDRESS_MISSING | `9` | A symbol for this Node is missing an address. |
| ### SYMBOL_ALREADY_EXISTS | `10` | There is another symbol for this Node with the same name. |
| ### UNBIND_CHILDREN_IN_PROGRESS | `11` | The node is in the process of unbinding all of its children. |
| ### UNSUPPORTED_ARGS | `12` | The Node contains unsupported arguments, such as deprecated property keys or offers. |
| ### DUPLICATE_PROPERTY_KEYS | `13` | The Node contains multiple properties with the same key. |
| ### OFFER_SOURCE_INSTANCE_FILTER_MISSING | `14` | The Node is missing source instance filters, |
| ### OFFER_RENAMED_INSTANCES_MISSING | `15` | The Node is missing renamed instances, |

## **TABLES**

### BusInfo

*Defined in [fuchsia.driver.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=159)*

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `bus` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#BusType` | The type of bus this node sits on. |
| ### 2 | `address` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#DeviceAddress` | A unique identifier that describes the identity of this device on the given bus. |
| ### 3 | `address_stability` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#DeviceAddressStability` | How stable the address. |

### CompositeDriverInfo

*Defined in [fuchsia.driver.framework/driver_info.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/driver_info.fidl;l=69)*

Information for a composite driver.

<br />

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `composite_name` | `string` | The name of the composite as specified in the driver's composite bind rules. |
| ### 2 | `driver_info` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#DriverInfo` | General information for the driver. |

### CompositeDriverMatch

*Defined in [fuchsia.driver.framework/driver_info.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/driver_info.fidl;l=78)*

Information for a composite driver that has matched with a composite.

<br />

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `composite_driver` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#CompositeDriverInfo` | Information for the composite driver that has matched. |
| ### 2 | `parent_names` | `vector<string>` | 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 | `primary_parent_index` | `uint32` | The primary node index. Identified by the primary node in the driver's composite bind rules. |

### CompositeInfo

*Defined in [fuchsia.driver.framework/driver_info.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/driver_info.fidl;l=92)*

Information for a composite that is defined by a composite node spec.

<br />

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `spec` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#CompositeNodeSpec` | The spec information that this composite node spec was created with. |
| ### 2 | `matched_driver` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#CompositeDriverMatch` | Information for the node spec that is available only when a driver has matched to the properties in this spec's parents. |

### CompositeNodeSpec

*Defined in [fuchsia.driver.framework/composite_node_spec.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/composite_node_spec.fidl;l=43)*

Struct that represents a composite node specification.

<br />

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `name` | `string` | The composite node spec's name. |
| ### 3 | `parents2` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#ParentSpec2>` | The nodes in the composite node spec. Must not be empty. The first node is the primary node. |
| ### 4 | `driver_host` | `string:128` | An identifier for the driver host which a driver that binds to this node spec should live in. All drivers which specify the same identifier will be colocated into the same driver host. If the driver host hasn't been started, it will be started upon the time the node is bound to. |

### CompositeParent

*Defined in [fuchsia.driver.framework/driver_info.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/driver_info.fidl;l=102)*

A parent to a composite that is defined by a composite node spec.

<br />

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `composite` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#CompositeInfo` | Information about the composite that this is a parent of. |
| ### 2 | `index` | `uint32` | The index of this parent in the spec's parents. |

### Dependency

*Defined in [fuchsia.driver.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=388)*

Represents a dependency that a node has on a resource.
The dependency is resolved by matching a resource against the `selector`'s constraints.
Added: HEAD

<br />

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `selector` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#Selector` | The resources must match the selector's constraints to be depended on. |
| ### 2 | `tags` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#ResourceProperty>:64` | Additional properties tagged to the resource for driver binding |

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

*Defined in [fuchsia.driver.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=81)*

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `connector` | `client_end:https://fuchsia.dev/reference/fuchsia.device.fs//https://fuchsia.dev/reference/fuchsia.device.fs#Connector` | 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 | `class_name` | `string:255` | 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 | `inspect` | `handle<vmo>` | 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 | `connector_supports` | `https://fuchsia.dev/reference/fuchsia.device.fs//https://fuchsia.dev/reference/fuchsia.device.fs#ConnectionType` | 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 | `controller_connector` | `client_end:https://fuchsia.dev/reference/fuchsia.device.fs//https://fuchsia.dev/reference/fuchsia.device.fs#Connector` | 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 Added: HEAD |

### DeviceCategory

*Defined in [fuchsia.driver.framework/driver_info.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/driver_info.fidl;l=24)*

Device categories as provided in the driver's component manifest.

<br />

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `category` | `string` |   |
| ### 2 | `subcategory` | `string` |   |

### DriverInfo

*Defined in [fuchsia.driver.framework/driver_info.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/driver_info.fidl;l=30)*

General information for a driver, used with both composite and normal drivers.

<br />

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `url` | `string:4096` | URL of the driver component. |
| ### 2 | `name` | `string` | Name of the driver, taken from the first field of the `ZIRCON_DRIVER` macro in the driver. |
| ### 3 | `colocate` | `bool` | If this is true then the driver should be colocated in its parent's DriverHost. |
| ### 4 | `package_type` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#DriverPackageType` | The type of package this driver is in. |
| ### 5 | `is_fallback` | `bool` | 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` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#DeviceCategory>` | Device categories |
| ### 7 | `bind_rules_bytecode` | `vector<uint8>` | 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 | `driver_framework_version` | `uint8` | 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 | `is_disabled` | `bool` | Whether the driver is disabled. If true, this driver is not chosen to bind to nodes. |

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

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

Arguments for starting a driver.

<br />

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `node` | `client_end:https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#Node` | Node that the driver is bound to. |
| ### 2 | `symbols` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#NodeSymbol>:64` | 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` | `https://fuchsia.dev/reference/fuchsia.url//https://fuchsia.dev/reference/fuchsia.url#Url` | URL of the package containing the driver. This is purely informational, used only to provide data for inspect. |
| ### 4 | `program` | `https://fuchsia.dev/reference/fuchsia.data//https://fuchsia.dev/reference/fuchsia.data#Dictionary` | 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` | `vector<https://fuchsia.dev/reference/fuchsia.component.runner//https://fuchsia.dev/reference/fuchsia.component.runner#ComponentNamespaceEntry>:32` | Incoming namespace provided to the driver. |
| ### 6 | `outgoing_dir` | `server_end:https://fuchsia.dev/reference/fuchsia.io//https://fuchsia.dev/reference/fuchsia.io#Directory` | Outgoing directory served by the driver. |
| ### 7 | `config` | `handle<vmo>` | Configuration passed to the driver. |
| ### 8 | `node_name` | `string` | The name of the node the driver is bound to. |
| ### 10 | `node_offers` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#NodeOffersVector` | Node offers of the node the driver is bound to. |
| ### 11 | `node_token` | `handle<event>` | Provides a token representing this node which can be exchanged with the driver framework to discern additional information about this node. |
| ### 12 | `node_properties_2` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#NodePropertyDictionary2` |   |
| ### 13 | `vmar` | `handle<vmar>` | Root VMAR the driver is mapped into. All child mappings should be placed into this VMAR if they want to have the same scheduler profile applied to them. |
| ### 14 | `power_element_args` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#PowerElementArgs` | Handles related to the driver's power elements on products where suspend is enabled by the `fuchsia.power.SuspendEnabled` config capability. If the driver's manifest contains `suspend_enabled = "true"` in the program section of its manifest, the `element_server`, `lessor_client`, and `token` are passed to the driver, otherwise the handles are retained by the driver host. `control_client` is always retained by the driver host and never passed to the driver. Added: HEAD |
| ### 15 | `log_sink` | `client_end:https://fuchsia.dev/reference/fuchsia.logger//https://fuchsia.dev/reference/fuchsia.logger#LogSink` | Log sink channel. |

### HealthCheckResponse

*Defined in [fuchsia.driver.framework/health.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/health.fidl;l=104)*

Response returned by a driver health check.

<br />

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `diagnostics` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#HealthDiagnosticItem>:32` | Diagnostic key-value telemetry for the driver as a whole (power mode, activity counters, last-event timestamps), as opposed to a single condition. |
| ### 2 | `conditions` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#HealthCondition>:16` | Active fault or warning conditions. Absent or empty when the driver is healthy (`HealthStatus.OK`). Overall driver status is the maximum severity across `conditions` (`UNHEALTHY > DEGRADED > OK`), or `OK` if absent or empty. |

### HealthCondition

*Defined in [fuchsia.driver.framework/health.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/health.fidl;l=82)*

One condition detected by a driver health check.

<br />

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `status` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#HealthStatus` | Severity of this condition. Consumers treat an omitted value as `UNHEALTHY`, so always set it. |
| ### 2 | `reason_code` | `string:128` | Short machine-readable token (e.g. "DSI_CRI_FIFO_WEDGED", "TE_INTERRUPT_STALLED"). Must be unique within a response. |
| ### 3 | `message` | `string:1024` | Human-readable detail for this condition. |
| ### 4 | `diagnostics` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#HealthDiagnosticItem>:32` | Diagnostic values specific to this condition. |
| ### 5 | `first_observed` | `https://fuchsia.dev/reference/zx//https://fuchsia.dev/reference/zx#InstantBoot` | Boot-timeline instant at which this condition was first observed. |
| ### 6 | `last_observed` | `https://fuchsia.dev/reference/zx//https://fuchsia.dev/reference/zx#InstantBoot` | Boot-timeline instant at which this condition was most recently observed. |
| ### 7 | `occurrence_count` | `uint64` | Number of times this condition has been observed since `first_observed`. |

### Node2

*Defined in [fuchsia.driver.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=399)*

Represents a node added to the driver topology. The node is created after all of its dependencies
are matched to a resource.
Added: HEAD

<br />

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `name` | `string` |   |
| ### 2 | `dependencies` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#Dependency>` |   |

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

*Defined in [fuchsia.driver.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=184)*

Arguments for adding a node.

<br />

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `name` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#NodeName` | Name of the node. |
| ### 3 | `symbols` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#NodeSymbol>:64` | Functions to provide to the driver that is bound to this node. |
| ### 5 | `devfs_args` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#DevfsAddArgs` | The arguments for how this node should be added to devfs. |
| ### 6 | `offers2` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#NodeOffersVector` | Capabilities to offer to the driver that is bound to this node. The driver must ensure these capabilities are added to its outgoing directory or in the \|offers_dictionary\| (if any of these are \|dictionary_offer\| type) before adding the child node. |
| ### 7 | `bus_info` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#BusInfo` | 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 | `properties2` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#NodeProperties` | Properties of the node. |
| ### 9 | `offers_dictionary` | `https://fuchsia.dev/reference/fuchsia.component.sandbox//https://fuchsia.dev/reference/fuchsia.component.sandbox#DictionaryRef` | This can be used to provide additional offers, through a dictionary, to the driver that is bound to this node. The user MUST use the \|offers2\| field to specify \|dictionary_offer\| type offers for offers that exist in this dictionary. Added: HEAD |
| ### 10 | `driver_host` | `string:128` | An identifier for the driver host which a driver that binds to this node should live in. All drivers which specify the same identifier will be colocated into the same driver host. If the driver host hasn't been started, it will be started upon the time the node is bound to. Only respected if the driver binds directly to this node. If a composite binds to this node, then this field will be ignored as it should be expressed in the composite node spec instead. |

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

*Defined in [fuchsia.driver.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=272)*

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `node_token` | `handle<event>` | Provides a token representing this node which can be exchanged with the driver framework to discern additional information about this node. |

### NodeControllerRequestBindRequest

*Defined in [fuchsia.driver.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=259)*

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `force_rebind` | `bool` | If this is true, then the node unbinds from its matched driver before it attempts to bind through the normal bind process. |
| ### 2 | `driver_url_suffix` | `string` | 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". |

### NodeSymbol

*Defined in [fuchsia.driver.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=45)*

Definition of a symbol provided by a driver for a node. A symbol is local to
a driver host.

<br />

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `name` | `string:128` | Name of the symbol. |
| ### 2 | `address` | `uint64` | Virtual address of the symbol, within a driver host's process. |
| ### 3 | `module_name` | `string:128` | Module name that provided the symbol. Will not be provided when the symbol originates from the primary parent. |

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

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

<br />

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `control_client` | `client_end:https://fuchsia.dev/reference/fuchsia.power.broker//https://fuchsia.dev/reference/fuchsia.power.broker#ElementControl` |   |
| ### 2 | `runner_server` | `server_end:https://fuchsia.dev/reference/fuchsia.power.broker//https://fuchsia.dev/reference/fuchsia.power.broker#ElementRunner` |   |
| ### 3 | `lessor_client` | `client_end:https://fuchsia.dev/reference/fuchsia.power.broker//https://fuchsia.dev/reference/fuchsia.power.broker#Lessor` |   |
| ### 4 | `token` | `https://fuchsia.dev/reference/fuchsia.power.broker//https://fuchsia.dev/reference/fuchsia.power.broker#DependencyToken` |   |

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

*Defined in [fuchsia.driver.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=224)*

Arguments for providing a resource.
Added: HEAD

<br />

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `name` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#ResourceName` | Name of the resource. Required. |
| ### 2 | `properties` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#ResourceProperties` | Properties of the resource. Required. |
| ### 3 | `offers` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#NodeOffersVector` | Capabilities the resource offers to the node that depends on it. Required. |
| ### 4 | `bus_info` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#BusInfo` | 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. Optional. |

### Selector

*Defined in [fuchsia.driver.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=373)*

Selector used to match resources as a dependency for nodes.
Added: HEAD

<br />

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `offers` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#Offer>:128` | The resource must contain these offers. |
| ### 2 | `include_properties` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#ResourceProperty>:64` | The resource must contain these properties. The property keys must be unique for the Selector to be considered valid. |
| ### 3 | `exclude_properties` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#ResourceProperty>:64` | The resource must not contain these properties. |

## **UNIONS**

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

*Defined in [fuchsia.driver.framework/composite_node_spec.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/composite_node_spec.fidl;l=81)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#CompositeNodeManager_AddSpec_Response` |   |
| ### 2 | `err` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#CompositeNodeSpecError` |   |
| ### 3 | `framework_err` | `internal` |   |

<br />

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

*Defined in [fuchsia.driver.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=128)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `int_value` | `uint8` | A fixed integer id, eg a spi bus address |
| ### 2 | `array_int_value` | `vector<uint8>:10` | An array of integers, eg a PCI BDF. |
| ### 3 | `char_int_value` | `string:4` | A uint32 value that can be interpretted as a 4 character sequence. |
| ### 4 | `array_char_int_value` | `vector<string:4>:10` | An array of character sequences, eg a ACPI node path. |
| ### 5 | `string_value` | `string:32` | A generic string, eg the device tree node path. |

<br />

### DriverResult [flexible](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.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=239)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `driver_started_node_token` | `handle<event>` | The token that belongs to the node that a driver has started successfully on. |
| ### 2 | `match_error` | `https://fuchsia.dev/reference/zx//https://fuchsia.dev/reference/zx#Result` | The node failed to find a matching driver or composite spec. |
| ### 3 | `start_error` | `https://fuchsia.dev/reference/zx//https://fuchsia.dev/reference/zx#Result` | The driver that bound to the node failed to start successfully. |

<br />

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

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

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

<br />

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

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

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

<br />

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

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

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

<br />

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

*Defined in [fuchsia.driver.framework/health.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/health.fidl;l=121)*

Payload of a proactive health alert emitted by a driver via `OnHealthAlert`.
"Upstream" is what the driver depends on (parents: buses, clocks, power
domains, composite parents). "Downstream" is what depends on the driver
(children / consumers).

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `self_fault` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#HealthCheckResponse` | The driver detected an internal hardware or software fault, or recovered from a previously reported fault (when `conditions` is empty). Edge-triggered: send when the driver's overall status worsens (OK-\>DEGRADED, DEGRADED-\>UNHEALTHY) and again with empty `conditions` when it recovers; never per occurrence of an already-reported condition. |
| ### 2 | `upstream_neighbor_fault` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#HealthCheckResponse` | The driver cannot make progress because an upstream dependency (parent/bus/clock/power/register provider) is unresponsive or invalid. |
| ### 3 | `downstream_neighbor_fault` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#HealthCheckResponse` | The driver cannot make progress because a downstream consumer (child/client) is wedged or failing to drain queues/buffers. |

<br />

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

*Defined in [fuchsia.driver.framework/health.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/health.fidl;l=66)*

Diagnostic value returned in a HealthCheckResponse.

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `string_value` | `string:256` |   |
| ### 2 | `int_value` | `int64` |   |
| ### 3 | `uint_value` | `uint64` |   |
| ### 4 | `bool_value` | `bool` |   |
| ### 5 | `timestamp` | `https://fuchsia.dev/reference/zx//https://fuchsia.dev/reference/zx#InstantBoot` | Boot-timeline instant, e.g. time of the last interrupt or input report. |

<br />

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

*Defined in [fuchsia.driver.framework/health.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/health.fidl;l=150)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#HealthCheckResponse` |   |
| ### 2 | `err` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#HealthCheckError` |   |
| ### 3 | `framework_err` | `internal` |   |

<br />

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

*Defined in [fuchsia.driver.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=267)*

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

<br />

### NodeController_WaitForDriver_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.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=284)*

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

<br />

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

*Defined in [fuchsia.driver.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=413)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#NodeManager_AddNode_Response` |   |
| ### 2 | `err` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#NodeError` |   |
| ### 3 | `framework_err` | `internal` |   |

<br />

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

*Defined in [fuchsia.driver.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=57)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `int_value` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#NodePropertyValueUint` |   |
| ### 2 | `string_value` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#NodePropertyValueString` |   |
| ### 3 | `bool_value` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#NodePropertyValueBool` |   |
| ### 4 | `enum_value` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#NodePropertyValueEnum` |   |

<br />

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

*Defined in [fuchsia.driver.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=343)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#Node_AddChild_Response` |   |
| ### 2 | `err` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#NodeError` |   |
| ### 3 | `framework_err` | `internal` |   |

<br />

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

*Defined in [fuchsia.driver.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=352)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#Node_ProvideResource_Response` |   |
| ### 2 | `err` | `https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#NodeError` |   |
| ### 3 | `framework_err` | `internal` |   |

<br />

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

*Defined in [fuchsia.driver.framework/topology.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=64)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `zircon_transport` | `https://fuchsia.dev/reference/fuchsia.component.decl//https://fuchsia.dev/reference/fuchsia.component.decl#Offer` |   |
| ### 2 | `driver_transport` | `https://fuchsia.dev/reference/fuchsia.component.decl//https://fuchsia.dev/reference/fuchsia.component.decl#Offer` |   |
| ### 3 | `dictionary_offer` | `https://fuchsia.dev/reference/fuchsia.component.decl//https://fuchsia.dev/reference/fuchsia.component.decl#Offer` | An offer that lives in the \|offers_dictionary\|. This is equivalent to a \|zircon_transport\| offer for all other purposes (eg. bind property generation). |

<br />

## **CONSTANTS**

| Name | Value | Type | Description |
|---|---|---|---|
| [MAX_DEVICE_ADDRESS_ARRAY_LEN](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=30) | `10` | `uint32` |   |
| [MAX_DEVICE_ADDRESS_STR_LEN](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=31) | `32` | `uint32` |   |
| [MAX_DRIVER_HOST_LENGTH](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=41) | `128` | `uint8` |   |
| [MAX_MODULE_NAME_LENGTH](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=28) | `128` | `uint8` |   |
| [MAX_NAMESPACE_COUNT](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/driver_start_args.fidl;l=14) | `https://fuchsia.dev/reference/fuchsia.component.runner//https://fuchsia.dev/reference/fuchsia.component.runner#MAX_NAMESPACE_COUNT` | `uint32` |   |
| [MAX_NODE_NAME_LENGTH](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=25) | `128` | `uint8` |   |
| [MAX_OFFER_COUNT](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=21) | `https://fuchsia.dev/reference/fuchsia.component//https://fuchsia.dev/reference/fuchsia.component#MAX_DYNAMIC_OFFER_COUNT` | `uint32` |   |
| [MAX_PROPERTY_COUNT](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=23) | `64` | `uint8` |   |
| [MAX_RESOURCE_NAME_LENGTH](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=33) | `128` | `uint8` |   |
| [MAX_SYMBOL_COUNT](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=22) | `64` | `uint8` |   |
| [MAX_SYMBOL_NAME_LENGTH](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=26) | `128` | `uint8` |   |

## **ALIASES**

| Name | Value | Description |
|---|---|---|
| [NodeName](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=37) | `string`\[`https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#MAX_NODE_NAME_LENGTH`\] |   |
| [NodeOffersVector](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=35) | `vector`\[`https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#MAX_OFFER_COUNT`\] |   |
| [NodeProperties](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=39) | `vector`\[`https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#MAX_PROPERTY_COUNT`\] |   |
| [NodePropertyDictionary2](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/driver_start_args.fidl;l=35) | `vector`\[`https://fuchsia.dev/reference/fidl//https://fuchsia.dev/reference/fidl#MAX`\] |   |
| [NodePropertyKeyString](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=14) | `string`\[`256`\] |   |
| [NodePropertyKeyUint](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=15) | `uint32` |   |
| [NodePropertyValueBool](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=18) | `bool` |   |
| [NodePropertyValueEnum](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=19) | `string`\[`256`\] |   |
| [NodePropertyValueString](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=17) | `string`\[`256`\] |   |
| [NodePropertyValueUint](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=16) | `uint32` |   |
| [ResourceName](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=171) | `string` | Added: HEAD |
| [ResourceProperties](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=173) | `vector`\[`https://fuchsia.dev/reference/fidl/fuchsia.driver.framework#MAX_PROPERTY_COUNT`\] | Added: HEAD |
| [ResourcePropertyValue](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=181) | `fuchsia.driver.framework/NodePropertyValue` | Added: HEAD |
| [ResourcePropertyValueBool](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=179) | `bool` | Added: HEAD |
| [ResourcePropertyValueString](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=177) | `string` | Added: HEAD |
| [ResourcePropertyValueUint](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.driver.framework/topology.fidl;l=175) | `uint32` | Added: HEAD |