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
Response
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 |
int32
|
test_output |
handle<channel>?
|
ConnectProxy
Give this device a channel to its shadow in another process.
Request
| Name | Type |
|---|
shadow |
handle<channel>
|
Unbind
Ask devhost to unbind this device. On success, the remote end of this
interface channel will close instead of returning a result.
Request
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
RemoveDevice
Ask the devhost to remove this device. On success, the remote end of
this interface channel will close instead of returning a result.
Request
Suspend
Ask devhost to suspend this device, using the target state indicated by flags.
Request
Response
CompleteCompatibilityTests
Inform devhost about the compatibility test status when compatibility tests
fail or complete successfully.
Request
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 rpc.
Request
| Name | Type |
|---|
rpc |
handle<channel>
|
protocol_id |
uint32
|
local_device_id |
uint64
|
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 |
|---|
rpc |
handle<channel>
|
driver_path |
string[1024]
|
driver |
handle<vmo>
|
parent_proxy |
handle<handle>?
|
proxy_args |
string[1024]?
|
local_device_id |
uint64
|
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 |
|---|
rpc |
handle<channel>
|
components |
vector<uint64>[8]
|
name |
string[31]
|
local_device_id |
uint64
|
Response
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 |
|---|
rpc |
handle<channel>
|
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
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 |
|---|
rpc |
handle<channel>
|
props |
vector<uint64>[256]
|
name |
string[31]
|
protocol_id |
uint32
|
driver_path |
string[1024]?
|
args |
string[1024]?
|
client_remote |
handle<channel>?
|
Response
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
UnbindDone
Sent as the response to |Unbind|.
Request
RemoveDone
Sent as the response to |CompleteRemoval|.
Request
RemoveDevice
Record the removal of this device.
Request
Response
MakeVisible
Mark this device as visible.
Request
Response
BindDevice
Attempt to bind a driver against this device. If driver_path is null,
this will initiate the driver matching algorithm.
TODO(teisenbe): Specify the behavior of invoking this multiple times. I believe
the current behavior is a bug.
Request
| Name | Type |
|---|
driver_path |
string[1024]?
|
Response
GetTopologicalPath
Returns the topological path of this device.
Request
Response
LoadFirmware
Requests that the firmware at the given path be loaded and returned.
Request
| Name | Type |
|---|
fw_path |
string[1024]
|
Response
Retrieve the metadata blob associated with this device and the given key.
Request
Response
Retrieve the metadata size associated with this device and the given key.
Request
Response
Add metadata blob associated with this device and the given key.
TODO(teisenbe): Document the behavior of calling this twice with the same
key. I believe the current behavior results in inaccessible data that is
kept around for the lifetime of the device.
Request
| Name | Type |
|---|
key |
uint32
|
data |
vector<uint8>[8192]?
|
Response
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
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]
|
props |
vector<uint64>[256]
|
components |
vector<DeviceComponent>
|
coresident_device_index |
uint32
|
Response
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
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
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 |
int32
|
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 |
int32
|
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 |
int32
|
written |
uint64
|
available |
uint64
|
STRUCTS
Coordinator_AddDevice_Response
generated
| Name | Type | Description | Default |
|---|
local_device_id |
uint64
|
|
No default |
Coordinator_AddDeviceInvisible_Response
generated
| Name | Type | Description | Default |
|---|
local_device_id |
uint64
|
|
No default |
Coordinator_RemoveDevice_Response
generated
| Name | Type | Description | 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 |
generated
| Name | Type | Description | Default |
|---|
data |
vector<uint8>[8192]
|
|
No default |
generated
| Name | Type | Description | Default |
|---|
size |
uint64
|
|
No default |
generated
| Name | Type | Description | Default |
|---|
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 |
ENUMS
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
Coordinator_AddDevice_Result
generated
Coordinator_AddDeviceInvisible_Result
generated
Coordinator_RemoveDevice_Result
generated
Coordinator_MakeVisible_Result
generated
Coordinator_BindDevice_Result
generated
Coordinator_GetTopologicalPath_Result
generated
Coordinator_LoadFirmware_Result
generated
generated
generated
generated
generated
Coordinator_AddCompositeDevice_Result
generated
Coordinator_DirectoryWatch_Result
generated
Coordinator_RunCompatibilityTests_Result
generated
BITS
AddDeviceConfig
Type: uint32
| Name | Value | Description |
|---|
| ALLOW_MULTI_COMPOSITE |
1 |
Device can be a component in multiple composite devices
|
CONSTANTS
