PROTOCOLS
Administrator
Defined in fuchsia.device.manager/administrator.fidl
Provides administration services for the device manager service and the device tree it controls.
Suspend
Ask all devices to enter the suspend state indicated by flags. Flags should be some
combination of DEVICE_SUSPEND_FLAG_* from the DDK.
Request
| Name | Type |
|---|---|
flags |
uint32
|
Response
| Name | Type |
|---|---|
status |
zx/status
|
DeviceController
Defined in fuchsia.device.manager/coordinator.fidl
Protocol for controlling devices in a devhost process from the devcoordinator
BindDriver
Bind the requested driver to this device. driver_path is informational,
but all calls to BindDriver/CreateDevice should use the same driver_path
each time they use a driver VMO with the same contents. Returns a status
and optionally a channel to the driver's test output. test_output will be
not present unless the driver is configured to run its run_unit_tests hook, in
which case the other end of the channel will have been passed to the driver.
Request
| Name | Type |
|---|---|
driver_path |
string[1024]
|
driver |
handle<vmo>
|
Response
| Name | Type |
|---|---|
status |
zx/status
|
test_output |
handle<channel>?
|
ConnectProxy
Give this device a channel to its shadow in another process.
Request
| Name | Type |
|---|---|
shadow |
handle<channel>
|
Init
Ask devhost to call the device init hook.
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
status |
zx/status
|
Unbind
Ask devhost to unbind this device. On success, the remote end of this interface channel will close instead of returning a result.
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
result |
DeviceController_Unbind_Result
|
CompleteRemoval
Ask the devhost to complete the removal of this device, which previously had invoked |ScheduleRemove|. This is a special case that can be removed once |device_remove| invokes |unbind|.
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
result |
DeviceController_CompleteRemoval_Result
|
Suspend
Ask devhost to suspend this device, using the target state indicated by flags.
Request
| Name | Type |
|---|---|
flags |
uint32
|
Response
| Name | Type |
|---|---|
status |
zx/status
|
Resume
Ask devhost to resume this device, using the target system state indicated by 'target_system_state'.
Request
| Name | Type |
|---|---|
target_system_state |
uint32
|
Response
| Name | Type |
|---|---|
status |
zx/status
|
CompleteCompatibilityTests
Inform devhost about the compatibility test status when compatibility tests fail or complete successfully.
Request
| Name | Type |
|---|---|
status |
CompatibilityTestStatus
|
DevhostController
Defined in fuchsia.device.manager/coordinator.fidl
Protocol for controlling a devhost process from the devcoordinator
CreateDeviceStub
Create a device in the devhost that only implements the device protocol
and claims to support the given protocol_id. This device will communicate
with the devcoordinator via coordinator. Implements DeviceController on device_controller_rpc
Request
| Name | Type |
|---|---|
coordinator_rpc |
Coordinator
|
device_controller_rpc |
request<DeviceController>
|
protocol_id |
uint32
|
local_device_id |
LocalDeviceId
|
CreateDevice
Create a device in the devhost representing the shadowed half of device
in another devhost. This new device will communicate with the devcoordinator
via rpc, and with its other half via parent_proxy.
The new device will have the given driver responsible for running its half
of the driver's cross-process protocol. It's create() method will be invoked,
giving it access to parent_proxy and proxy_args.
parent_proxy, if present, will usually be a channel to the upper half of a shadowed device. The one exception is when this method is used to create the Platform Bus, in which case it will be a channel to a fuchsia.boot.Items protocol.
local_device_id will be a unique value within the device's devhost
Request
| Name | Type |
|---|---|
coordinator_rpc |
Coordinator
|
device_controller_rpc |
request<DeviceController>
|
driver_path |
string[1024]
|
driver |
handle<vmo>
|
parent_proxy |
handle<handle>?
|
proxy_args |
string[1024]?
|
local_device_id |
LocalDeviceId
|
CreateCompositeDevice
Introduce a composite device that has the given name and properties.
components will be a list of all of the composite's components,
described using devhost local device ids. The order of the components
will match the original composite creation request. The new device will
communicate with devcoordinator via rpc.
local_device_id will be a unique value within the device's devhost, identifying
the resulting composite device.
Request
| Name | Type |
|---|---|
coordinator_rpc |
Coordinator
|
device_controller_rpc |
request<DeviceController>
|
components |
vector<uint64>[16]
|
name |
string[31]
|
local_device_id |
LocalDeviceId
|
Response
| Name | Type |
|---|---|
status |
zx/status
|
Coordinator
Defined in fuchsia.device.manager/coordinator.fidl
Interface for the devices in devhosts to coordinate with the devcoordinator.
AddDevice
Record the addition of a new device that can be communicated with via rpc.
For binding purposes, it is has properties props. name and driver_path
are informational and used for debugging. The device will have protocol_id
as its primary protocol id. args should only be used for shadowed devices,
and will be forwarded to the shadow device. client_remote, if present,
will be passed to the device as an open connection for the client.
On success, the returned local_device_id is the identifier assigned by devmgr.
Request
| Name | Type |
|---|---|
coordinator |
request<Coordinator>
|
device_controller |
DeviceController
|
props |
vector<uint64>[256]
|
name |
string[31]
|
protocol_id |
uint32
|
driver_path |
string[1024]?
|
args |
string[1024]?
|
device_add_config |
AddDeviceConfig
|
client_remote |
handle<channel>?
|
Response
| Name | Type |
|---|---|
result |
Coordinator_AddDevice_Result
|
AddDeviceInvisible
Behaves as AddDevice, but marks the device as initially invisible. This means that it will not be visible to other devices or the devfs until it is later marked visible (via MakeVisible).
Request
| Name | Type |
|---|---|
coordinator |
request<Coordinator>
|
device_controller |
DeviceController
|
props |
vector<uint64>[256]
|
name |
string[31]
|
protocol_id |
uint32
|
driver_path |
string[1024]?
|
args |
string[1024]?
|
client_remote |
handle<channel>?
|
Response
| Name | Type |
|---|---|
result |
Coordinator_AddDeviceInvisible_Result
|
ScheduleRemove
Requests the devcoordinator schedule the removal of this device, and the unbinding of its children. If |unbind_self| is true, the unbind hook for this device will also be called.
Request
| Name | Type |
|---|---|
unbind_self |
bool
|
ScheduleUnbindChildren
Requests the devcoordinator schedule the unbinding of this device's children.
Request
| Name | Type |
|---|
MakeVisible
Mark this device as visible.
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
result |
Coordinator_MakeVisible_Result
|
BindDevice
Attempt to bind a driver against this device. If driver_path is null,
this will initiate the driver matching algorithm.
Request
| Name | Type |
|---|---|
driver_path |
string[1024]?
|
Response
| Name | Type |
|---|---|
result |
Coordinator_BindDevice_Result
|
GetTopologicalPath
Returns the topological path of this device.
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
result |
Coordinator_GetTopologicalPath_Result
|
LoadFirmware
Requests that the firmware at the given path be loaded and returned.
Request
| Name | Type |
|---|---|
fw_path |
string[1024]
|
Response
| Name | Type |
|---|---|
result |
Coordinator_LoadFirmware_Result
|
GetMetadata
Retrieve the metadata blob associated with this device and the given key.
Request
| Name | Type |
|---|---|
key |
uint32
|
Response
| Name | Type |
|---|---|
result |
Coordinator_GetMetadata_Result
|
GetMetadataSize
Retrieve the metadata size associated with this device and the given key.
Request
| Name | Type |
|---|---|
key |
uint32
|
Response
| Name | Type |
|---|---|
result |
Coordinator_GetMetadataSize_Result
|
AddMetadata
Add metadata blob associated with this device and the given key.
Request
| Name | Type |
|---|---|
key |
uint32
|
data |
vector<uint8>[8192]?
|
Response
| Name | Type |
|---|---|
result |
Coordinator_AddMetadata_Result
|
PublishMetadata
Behaves like AddMetadata, but instead of associating it with the
requesting device, associates it with the device at device_path. If
the device at device_path is not a child of the requesting device AND
the requesting device is not running in the sys devhost, then this will
fail.
Request
| Name | Type |
|---|---|
device_path |
string[1024]
|
key |
uint32
|
data |
vector<uint8>[8192]?
|
Response
| Name | Type |
|---|---|
result |
Coordinator_PublishMetadata_Result
|
AddCompositeDevice
Adds the given composite device. This causes the devcoordinator to try to match the components against the existing device tree, and to monitor all new device additions in order to find the components as they are created.
Request
| Name | Type |
|---|---|
name |
string[31]
|
comp_desc |
CompositeDeviceDescriptor
|
Response
| Name | Type |
|---|---|
result |
Coordinator_AddCompositeDevice_Result
|
DirectoryWatch
Watches a directory, receiving events of added messages on the watcher request channel. See fuchsia.io.Directory for more information.
Request
| Name | Type |
|---|---|
mask |
uint32
|
options |
uint32
|
watcher |
handle<channel>
|
Response
| Name | Type |
|---|---|
result |
Coordinator_DirectoryWatch_Result
|
RunCompatibilityTests
Run Compatibility tests for the driver that binds to this device. The hook_wait_time is the time that the driver expects to take for each device hook in nanoseconds. Returns whether the compatibility tests started, and does not convey anything about the status of the test.
Request
| Name | Type |
|---|---|
hook_wait_time |
int64
|
Response
| Name | Type |
|---|---|
result |
Coordinator_RunCompatibilityTests_Result
|
DebugDumper
Defined in fuchsia.device.manager/debug.fidl
Dumps text debug information.
All methods dump ascii text into a VMO, this allows the caller the flexibility to decide
how much data they want. Use the returned written value to read the data, no string
termination is guaranteed.
DumpTree
Print device tree into output, returns bytes written and bytes available to write.
Request
| Name | Type |
|---|---|
output |
handle<vmo>
|
Response
| Name | Type |
|---|---|
status |
zx/status
|
written |
uint64
|
available |
uint64
|
DumpDrivers
Print information about all drivers into output, returns bytes written and bytes available to write.
Request
| Name | Type |
|---|---|
output |
handle<vmo>
|
Response
| Name | Type |
|---|---|
status |
zx/status
|
written |
uint64
|
available |
uint64
|
DumpBindingProperties
Print all devices and their binding properties into output, returns bytes written
and bytes available to write.
Request
| Name | Type |
|---|---|
output |
handle<vmo>
|
Response
| Name | Type |
|---|---|
status |
zx/status
|
written |
uint64
|
available |
uint64
|
STRUCTS
DeviceController_Unbind_Response
generated
| Name | Type | Description | Default |
|---|
DeviceController_CompleteRemoval_Response
generated
| Name | Type | Description | Default |
|---|
Coordinator_AddDevice_Response
generated
| Name | Type | Description | Default |
|---|---|---|---|
local_device_id |
LocalDeviceId
|
No default |
Coordinator_AddDeviceInvisible_Response
generated
| Name | Type | Description | Default |
|---|---|---|---|
local_device_id |
LocalDeviceId
|
No default |
Coordinator_MakeVisible_Response
generated
| Name | Type | Description | Default |
|---|
Coordinator_BindDevice_Response
generated
| Name | Type | Description | Default |
|---|
Coordinator_GetTopologicalPath_Response
generated
| Name | Type | Description | Default |
|---|---|---|---|
path |
string[1024]
|
No default |
Coordinator_LoadFirmware_Response
generated
| Name | Type | Description | Default |
|---|---|---|---|
vmo |
handle<vmo>
|
No default | |
size |
uint64
|
No default |
Coordinator_GetMetadata_Response
generated
| Name | Type | Description | Default |
|---|---|---|---|
data |
vector<uint8>[8192]
|
No default |
Coordinator_GetMetadataSize_Response
generated
| Name | Type | Description | Default |
|---|---|---|---|
size |
uint64
|
No default |
Coordinator_AddMetadata_Response
generated
| Name | Type | Description | Default |
|---|
Coordinator_PublishMetadata_Response
generated
| Name | Type | Description | Default |
|---|
Coordinator_AddCompositeDevice_Response
generated
| Name | Type | Description | Default |
|---|
Coordinator_DirectoryWatch_Response
generated
| Name | Type | Description | Default |
|---|
Coordinator_RunCompatibilityTests_Response
generated
| Name | Type | Description | Default |
|---|
BindInstruction
Defined in fuchsia.device.manager/coordinator.fidl
| Name | Type | Description | Default |
|---|---|---|---|
op |
uint32
|
bitfield that encodes the operation and execution conditions |
No default |
arg |
uint32
|
bitfield that encodes the arguments |
No default |
DeviceComponentPart
Defined in fuchsia.device.manager/coordinator.fidl
A part of a description of a DeviceComponent
| Name | Type | Description | Default |
|---|---|---|---|
match_program_count |
uint32
|
No default | |
match_program |
[32]
|
No default |
DeviceComponent
Defined in fuchsia.device.manager/coordinator.fidl
A piece of a composite device
| Name | Type | Description | Default |
|---|---|---|---|
parts_count |
uint32
|
No default | |
parts |
[16]
|
No default |
DeviceMetadata
Defined in fuchsia.device.manager/coordinator.fidl
Metadata that can be added to a device
| Name | Type | Description | Default |
|---|---|---|---|
key |
uint32
|
No default | |
data |
vector<uint8>[8192]
|
No default |
CompositeDeviceDescriptor
Defined in fuchsia.device.manager/coordinator.fidl
Composite device parts and properties
| Name | Type | Description | Default |
|---|---|---|---|
props |
vector<uint64>[256]
|
No default | |
components |
vector<DeviceComponent>[16]
|
No default | |
coresident_device_index |
uint32
|
No default | |
metadata |
vector<DeviceMetadata>[32]?
|
No default |
ENUMS
SystemPowerState
Type: uint8
Defined in fuchsia.device.manager/administrator.fidl
| Name | Value | Description |
|---|---|---|
SYSTEM_POWER_STATE_FULLY_ON |
1 |
|
SYSTEM_POWER_STATE_REBOOT |
2 |
|
SYSTEM_POWER_STATE_REBOOT_BOOTLOADER |
3 |
|
SYSTEM_POWER_STATE_REBOOT_RECOVERY |
4 |
|
SYSTEM_POWER_STATE_POWEROFF |
5 |
|
SYSTEM_POWER_STATE_MEXEC |
6 |
|
SYSTEM_POWER_STATE_SUSPEND_RAM |
7 |
CompatibilityTestStatus
Type: uint32
Defined in fuchsia.device.manager/coordinator.fidl
A enum of CompatibilityTestStatus
| Name | Value | Description |
|---|---|---|
OK |
1 |
|
ERR_BIND_NO_DDKADD |
2 |
|
ERR_BIND_TIMEOUT |
3 |
|
ERR_UNBIND_NO_DDKREMOVE |
4 |
|
ERR_UNBIND_TIMEOUT |
5 |
|
ERR_SUSPEND_DDKREMOVE |
6 |
|
ERR_INTERNAL |
7 |
UNIONS
DeviceController_Unbind_Result
generated
| Name | Type | Description |
|---|---|---|
response |
DeviceController_Unbind_Response
|
|
err |
zx/status
|
DeviceController_CompleteRemoval_Result
generated
| Name | Type | Description |
|---|---|---|
response |
DeviceController_CompleteRemoval_Response
|
|
err |
zx/status
|
Coordinator_AddDevice_Result
generated
| Name | Type | Description |
|---|---|---|
response |
Coordinator_AddDevice_Response
|
|
err |
zx/status
|
Coordinator_AddDeviceInvisible_Result
generated
| Name | Type | Description |
|---|---|---|
response |
Coordinator_AddDeviceInvisible_Response
|
|
err |
zx/status
|
Coordinator_MakeVisible_Result
generated
| Name | Type | Description |
|---|---|---|
response |
Coordinator_MakeVisible_Response
|
|
err |
zx/status
|
Coordinator_BindDevice_Result
generated
| Name | Type | Description |
|---|---|---|
response |
Coordinator_BindDevice_Response
|
|
err |
zx/status
|
Coordinator_GetTopologicalPath_Result
generated
| Name | Type | Description |
|---|---|---|
response |
Coordinator_GetTopologicalPath_Response
|
|
err |
zx/status
|
Coordinator_LoadFirmware_Result
generated
| Name | Type | Description |
|---|---|---|
response |
Coordinator_LoadFirmware_Response
|
|
err |
zx/status
|
Coordinator_GetMetadata_Result
generated
| Name | Type | Description |
|---|---|---|
response |
Coordinator_GetMetadata_Response
|
|
err |
zx/status
|
Coordinator_GetMetadataSize_Result
generated
| Name | Type | Description |
|---|---|---|
response |
Coordinator_GetMetadataSize_Response
|
|
err |
zx/status
|
Coordinator_AddMetadata_Result
generated
| Name | Type | Description |
|---|---|---|
response |
Coordinator_AddMetadata_Response
|
|
err |
zx/status
|
Coordinator_PublishMetadata_Result
generated
| Name | Type | Description |
|---|---|---|
response |
Coordinator_PublishMetadata_Response
|
|
err |
zx/status
|
Coordinator_AddCompositeDevice_Result
generated
| Name | Type | Description |
|---|---|---|
response |
Coordinator_AddCompositeDevice_Response
|
|
err |
zx/status
|
Coordinator_DirectoryWatch_Result
generated
| Name | Type | Description |
|---|---|---|
response |
Coordinator_DirectoryWatch_Response
|
|
err |
zx/status
|
Coordinator_RunCompatibilityTests_Result
generated
| Name | Type | Description |
|---|---|---|
response |
Coordinator_RunCompatibilityTests_Response
|
|
err |
zx/status
|
BITS
AddDeviceConfig
Type: uint32
| Name | Value | Description |
|---|---|---|
| ALLOW_MULTI_COMPOSITE | 1 | Device can be a component in multiple composite devices |
CONSTANTS
| Name | Value | Type | Description |
|---|---|---|---|
| SUSPEND_FLAG_REBOOT |
3705405696
|
uint32 |
All available suspend flags |
| SUSPEND_FLAG_REBOOT_BOOTLOADER |
3705405697
|
uint32 |
|
| SUSPEND_FLAG_REBOOT_RECOVERY |
3705405698
|
uint32 |
|
| SUSPEND_FLAG_POWEROFF |
3705405952
|
uint32 |
|
| SUSPEND_FLAG_MEXEC |
3705406208
|
uint32 |
|
| SUSPEND_FLAG_SUSPEND_RAM |
3705406464
|
uint32 |
|
| MAX_SYSTEM_POWER_STATES |
7
|
uint32 |
|
| DEVICE_NAME_MAX |
31
|
uint32 |
This definition must match |
| DEVICE_PATH_MAX |
1024
|
uint32 |
Maximum number of bytes in a path |
| DEVICE_ARGS_MAX |
1024
|
uint32 |
Maximum number of bytes in a device arguments string. |
| METADATA_BYTES_MAX |
8192
|
uint32 |
Maximum number of bytes in a metadata payload |
| METADATA_MAX |
32
|
uint32 |
Maximum number of metadata that can be added to a device |
| PROPERTIES_MAX |
256
|
uint32 |
Maximum number of properties that can be attached to a device |
| COMPONENTS_MAX |
16
|
uint32 |
Maximum number of components that a composite device can have |
| DEVICE_COMPONENT_PARTS_MAX |
16
|
uint32 |
Maximum number of parts that a composite device component can have |
| DEVICE_COMPONENT_PART_INSTRUCTIONS_MAX |
32
|
uint32 |
Maximum instructions in a match program |
TYPE ALIASES
| Name | Value | Description |
|---|---|---|
| DeviceProperty |
uint64 |
|
| LocalDeviceId |
uint64 |