PROTOCOLS
Arguments
Defined in fuchsia.boot/arguments.fidl
Protocol for retrieving boot arguments.
Collect
Get all boot arguments with keys starting with
prefix. Returns a vector with strings of the form 'key=value'.
TODO(fxbug.dev/33460) - remove Collect once boot arguments have been componentised.
Request
| Name | Type |
|---|---|
prefix |
string[64]
|
Response
| Name | Type |
|---|---|
results |
vector<string>[32]
|
GetBool
Get the boolean value of a boot argument keys,
or return defaultval if the argument is not present.
A key is considered to be false if its string value is exactly
"off", "0", or "false". Any other value (including empty) is returned
as true.
Request
| Name | Type |
|---|---|
key |
string[64]
|
defaultval |
bool
|
Response
| Name | Type |
|---|---|
value |
bool
|
GetBools
Get the boolean values of a list of boot arguments keys.key,
or return keys.defaultval for each if not present.
Request
| Name | Type |
|---|---|
keys |
vector<BoolPair>[32]
|
Response
| Name | Type |
|---|---|
values |
vector<bool>[32]
|
GetString
Get the value of a boot argument key.
Request
| Name | Type |
|---|---|
key |
string[64]
|
Response
| Name | Type |
|---|---|
value |
string[128]?
|
GetStrings
Get the values of a list of arguments specified in keys.
Request
| Name | Type |
|---|---|
keys |
vector<string>[32]
|
Response
| Name | Type |
|---|---|
values |
vector<string>[193]
|
FactoryItems
Defined in fuchsia.boot/factory-items.fidl
Protocol for retrieving factory boot item payloads.
Get
Gets a payload for a ZBI_TYPE_STORAGE_BOOTFS_FACTORY boot item with
extra field set to extra.
NOTE: We return the length of the item, as VMOs must be page-aligned.
Request
| Name | Type |
|---|---|
extra |
uint32
|
Response
| Name | Type |
|---|---|
payload |
handle<vmo>?
|
length |
uint32
|
Items
Defined in fuchsia.boot/items.fidl
Protocol for retrieving boot item payloads.
Get
Get a payload for a boot item of type and extra.
NOTE: We return the length of the item, as VMOs must be page-aligned.
TODO: Refactor API: fxbug.dev/34597
For a list of types, refer to <zircon/boot/image.h>.
For a list of extras, refer to <zircon/boot/driver-config.h>.
Request
| Name | Type |
|---|---|
type |
uint32
|
extra |
uint32
|
Response
| Name | Type |
|---|---|
payload |
handle<vmo>?
|
length |
uint32
|
GetBootloaderFile
Gets the payload for a ZBI_TYPE_BOOTLOADER_FILE boot item.
Note: ZX_PROP_VMO_CONTENT_SIZE will be set to the actual file content size
Request
| Name | Type |
|---|---|
filename |
string[255]
|
Response
| Name | Type |
|---|---|
payload |
handle<vmo>?
|
ReadOnlyLog
Defined in fuchsia.boot/log.fidl
Protocol for providing the kernel log, readable.
Get
Get read-only handle to the kernel log.
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
log |
handle<debuglog>
|
RootJob
Defined in fuchsia.boot/root-job.fidl
Protocol for providing the root job.
TODO(fxbug.dev/33856): Do not use this without first consulting the Zircon team.
Get
Get the root job.
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
job |
handle<job>
|
RootJobForInspect
Defined in fuchsia.boot/root-job.fidl
Protocol for providing the root job with restricted rights, specifically: INSPECT | ENUMERATE | DUPLICATE | TRANSFER
Get
Get the root job.
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
job |
handle<job>
|
RootResource
Defined in fuchsia.boot/root-resource.fidl
Protocol for providing the root resource.
Get
Get the root resource.
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
resource |
handle<resource>
|
WriteOnlyLog
Defined in fuchsia.boot/log.fidl
Protocol for providing the kernel log, writable.
Get
Get write-only handle to the kernel log.
Request
| Name | Type |
|---|
Response
| Name | Type |
|---|---|
log |
handle<debuglog>
|
STRUCTS
BoolPair
Defined in fuchsia.boot/arguments.fidl
| Name | Type | Description | Default |
|---|---|---|---|
key |
string[64]
|
No default | |
defaultval |
bool
|
No default |
CONSTANTS
| Name | Value | Type | Description |
|---|---|---|---|
| MAX_ARGS_COLLECT_LENGTH |
193
|
uint8 |
|
| MAX_ARGS_NAME_LENGTH |
64
|
uint8 |
|
| MAX_ARGS_VALUE_LENGTH |
128
|
uint8 |
|
| MAX_ARGS_VECTOR_LENGTH |
32
|
uint8 |
|
| MAX_FILE_NAME_LENGTH |
255
|
uint8 |