blob: 12d547e84da6515ecadc237e413667a623e7a2bf [file] [log] [blame]
// Copyright 2021 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
library fuchsia.driver.development;
using fuchsia.device.manager;
using fuchsia.url;
using zx;
type BindRulesBytecode = strict union {
/// Bind rules in the old bytecode format.
1: bytecode_v1
vector<fuchsia.device.manager.BindInstruction>:fuchsia.device.manager.BIND_RULES_INSTRUCTIONS_MAX;
/// Bind rules in the new bytecode format.
2: bytecode_v2 vector<uint8>:MAX;
};
type DriverInfo = table {
/// Path to the driver shared library.
1: libname string:fuchsia.device.manager.DEVICE_PATH_MAX;
/// Name of the driver, taken from the first field of the `ZIRCON_DRIVER`
/// macro in the driver.
2: name string:MAX;
/// URL of the driver component's manifest. This will only be populated if
/// the driver is a component.
3: url string:fuchsia.url.MAX_URL_LENGTH;
/// Bind rules which declare set of constraints to evaluate in order to
/// determine whether the driver indexer should bind this driver to a
/// device.
4: bind_rules BindRulesBytecode;
};
type DeviceFlags = strict bits : uint32 {
//// This device is never destroyed
IMMORTAL = 0x0001;
/// This device requires that children are created in a
/// new driver_host attached to a proxy device
MUST_ISOLATE = 0x0002;
/// This device may be bound multiple times
MULTI_BIND = 0x0004;
/// This device is bound and not eligible for binding
/// again until unbound. Not allowed on MULTI_BIND ctx.
BOUND = 0x0008;
/// Device has been remove()'d
DEAD = 0x0010;
/// This device is a fragment of a composite device and
/// can be part of multiple composite devices.
ALLOW_MULTI_COMPOSITE = 0x0020;
/// Device is a proxy -- its "parent" is the device it's
/// a proxy to.
PROXY = 0x0040;
/// Device is not visible in devfs or bindable.
/// Devices may be created in this state, but may not
/// return to this state once made visible.
INVISIBLE = 0x0080;
/// Device should not go through auto-bind process.
SKIP_AUTOBIND = 0x0100;
};
type DeviceInfo = table {
/// Unique ID identifying the device.
1: id uint64;
/// List of ids representing parents. If more than one, this device is a
/// composite device node.
2: parent_ids vector<uint64>:MAX;
/// List of ids representing children.
3: child_ids vector<uint64>:MAX;
/// The process KOID of the driver host the driver resides within.
4: driver_host_koid zx.koid;
/// The topological path of the driver. Once drivers are components, this
/// will also be the collection relative moniker.
5: topological_path string:fuchsia.device.manager.DEVICE_PATH_MAX;
/// Path to the driver shared library.
6: bound_driver_libname string:fuchsia.device.manager.DEVICE_PATH_MAX;
7: bound_driver_url string:fuchsia.url.MAX_URL_LENGTH;
8: property_list fuchsia.device.manager.DevicePropertyList;
9: flags DeviceFlags;
};
/// Interface for developing and debugging drivers.
/// This interface should only be used for development and disabled in release builds.
@discoverable
protocol DriverIndex {
/// Returns a list of all drivers that are known to the system.
/// If a |driver_filter| is provided, the returned list will be filtered to
/// only include drivers specified in the filter.
/// ZX_ERR_NOT_FOUND indicates that there is no driver matching the given path for at least
/// one driver in |driver_filter|.
/// ZX_ERR_BUFFER_TOO_SMALL indicates that the driver's bind program is longer than the
/// maximum number of instructions (BIND_PROGRAM_INSTRUCTIONS_MAX).
GetDriverInfo(struct {
driver_filter vector<string:MAX>:MAX;
}) -> (struct {
drivers vector<DriverInfo>:MAX;
}) error zx.status;
};
/// Interface for developing and debugging drivers.
/// This interface should only be used for development and disabled in release builds.
@discoverable
protocol DriverDevelopment {
compose DriverIndex;
/// Restart all Driver Hosts containing the driver specified by `driver path`.
/// ZX_ERR_NOT_FOUND indicates that there is no driver matching the given path.
RestartDriverHosts(struct {
driver_path string:fuchsia.device.manager.DEVICE_PATH_MAX;
}) -> (struct {}) error zx.status;
/// Returns the list of devices that are running on the system.
/// If a |device_filter| is provided, the returned list will be filtered to
/// only include devices specified in the filter.
/// ZX_ERR_NOT_FOUND indicates that there is no device matching the given path for at least one
/// device in |device_filter|.
/// ZX_ERR_BAD_PATH indicates that the given path is not valid.
/// ZX_ERR_BUFFER_TOO_SMALL indicates either that the given path is too long,
/// or that the device has more than the maximum number of properties (PROPERTIES_MAX).
GetDeviceInfo(struct {
device_filter vector<string:MAX>:MAX;
}) -> (struct {
devices vector<DeviceInfo>:MAX;
}) error zx.status;
};