PROTOCOLS
Device
Defined in fuchsia.hardware.serial/serial.fidl
A serial device.
GetClass
Lookup what type of serial device this is.
Request
<EMPTY>
Response
| Name | Type |
|---|---|
device_class |
Class
|
Read
Reads data from the serial port.
Request
<EMPTY>
Response
| Name | Type |
|---|---|
payload |
Device_Read_Result
|
SetConfig
Set the configuration of this serial device.
Request
| Name | Type |
|---|---|
config |
Config
|
Response
| Name | Type |
|---|---|
s |
zx/Status
|
Write
Writes data to the serial port.
Request
| Name | Type |
|---|---|
data |
vector<uint8>
|
Response
| Name | Type |
|---|---|
payload |
Device_Write_Result
|
DeviceProxy
Defined in fuchsia.hardware.serial/serial.fidl
GetChannel
Request
| Name | Type |
|---|---|
req |
server_end:Device
|
STRUCTS
Config
Defined in fuchsia.hardware.serial/serial.fidl
| Field | Type | Description | Default |
|---|---|---|---|
character_width |
CharacterWidth
|
No default | |
stop_width |
StopWidth
|
No default | |
parity |
Parity
|
No default | |
control_flow |
FlowControl
|
No default | |
baud_rate |
uint32
|
No default |
Device_Read_Response
Defined in fuchsia.hardware.serial/serial.fidl
| Field | Type | Description | Default |
|---|---|---|---|
data |
vector<uint8>
|
No default |
Device_Write_Response
Defined in fuchsia.hardware.serial/serial.fidl
<EMPTY>
SerialPortInfo
Defined in fuchsia.hardware.serial/serial.fidl
| Field | Type | Description | Default |
|---|---|---|---|
serial_class |
Class
|
No default | |
serial_vid |
uint32
|
Vendor and product ID of hardware attached to this serial port, or zero if not applicable. |
No default |
serial_pid |
uint32
|
No default |
ENUMS
CharacterWidth strict
Type: uint8
Defined in fuchsia.hardware.serial/serial.fidl
Number of bits per character
| Name | Value | Description |
|---|---|---|
BITS_5 |
1 |
|
BITS_6 |
2 |
|
BITS_7 |
3 |
|
BITS_8 |
4 |
Class strict
Type: uint8
Defined in fuchsia.hardware.serial/serial.fidl
Description of what type of serial device this is TODO(https://fxbug.dev/393643944): Consider replacing this enum.
| Name | Value | Description |
|---|---|---|
GENERIC |
1 |
|
BLUETOOTH_HCI |
2 |
A Bluetooth host controller |
CONSOLE |
3 |
An interactive console |
KERNEL_DEBUG |
4 |
Kernel debug serial |
MCU |
5 |
MCU serial connection |
FlowControl strict
Type: uint8
Defined in fuchsia.hardware.serial/serial.fidl
What flow control mechanism to use
| Name | Value | Description |
|---|---|---|
NONE |
1 |
|
CTS_RTS |
2 |
Clear To Send/Request To Send |
Parity strict
Type: uint8
Defined in fuchsia.hardware.serial/serial.fidl
Which parity computation to use, if any.
| Name | Value | Description |
|---|---|---|
NONE |
1 |
|
EVEN |
2 |
|
ODD |
3 |
StopWidth strict
Type: uint8
Defined in fuchsia.hardware.serial/serial.fidl
Number of stop bits
| Name | Value | Description |
|---|---|---|
BITS_1 |
1 |
|
BITS_2 |
2 |
UNIONS
Device_Read_Result strict
Defined in fuchsia.hardware.serial/serial.fidl
| Ordinal | Variant | Type | Description |
|---|---|---|---|
1 |
response |
Device_Read_Response
|
|
2 |
err |
zx/Status
|
Device_Write_Result strict
Defined in fuchsia.hardware.serial/serial.fidl
| Ordinal | Variant | Type | Description |
|---|---|---|---|
1 |
response |
Device_Write_Response
|
|
2 |
err |
zx/Status
|
SERVICES
Service
Defined in fuchsia.hardware.serial/serial.fidl
| Name | Type | Transport |
|---|---|---|
| device |
fuchsia.hardware.serial/Device
|
Channel |