跳转到内容

std.os.uefi.protocol.serial_io

标准库Zig 0.17.1官方原文
源码std/os/uefi/protocol/serial_io.zig

第 1 行

std.os.uefi.protocol.serial_io.cc

别名

第 5 行

别名目标 std.os.uefi.cc

std.os.uefi.protocol.serial_io.Guid

别名

第 3 行

别名目标 std.os.uefi.Guid

std.os.uefi.protocol.serial_io.SerialIo

容器

第 7 行

字段

revision: u64
_reset: *const fn (*SerialIo) callconv(cc) Status
_set_attribute: *const fn (*SerialIo, u64, u32, u32, ParityType, u8, StopBitsType) callconv(cc) Status
_set_control: *const fn (*SerialIo, u32) callconv(cc) Status
_get_control: *const fn (*const SerialIo, *u32) callconv(cc) Status
_write: *const fn (*SerialIo, *usize, *const anyopaque) callconv(cc) Status
_read: *const fn (*SerialIo, *usize, *anyopaque) callconv(cc) Status
mode: *Mode
device_type_guid: ?*Guid

std.os.uefi.protocol.serial_io.SerialIo.getControl

函数

第 83 行

获取串行设备控制位的状态。

pub fn getControl(self: *SerialIo) GetControlError!u32

参数

self: *SerialIo

错误

DeviceError
Unexpected UnexpectedError

std.os.uefi.protocol.serial_io.SerialIo.GetControlError

错误集合

第 27 行

错误

DeviceError
Unexpected UnexpectedError

std.os.uefi.protocol.serial_io.SerialIo.guid

常量

第 114 行

std.os.uefi.protocol.serial_io.SerialIo.Mode

容器

第 139 行

字段

control_mask: u32
timeout: u32
baud_rate: u64
receive_fifo_depth: u32
data_bits: u32
parity: u32
stop_bits: u32

std.os.uefi.protocol.serial_io.SerialIo.ParityType

容器

第 123 行

字段

default_parity
no_parity
even_parity
odd_parity
mark_parity
space_parity

std.os.uefi.protocol.serial_io.SerialIo.read

函数

第 104 行

从串行设备读取数据。

pub fn read(self: *SerialIo, buffer: []u8) ReadError!usize

参数

self: *SerialIo
buffer: []u8

错误

DeviceError
Timeout
Unexpected UnexpectedError

std.os.uefi.protocol.serial_io.SerialIo.ReadError

错误集合

第 32 行

错误

DeviceError
Timeout
Unexpected UnexpectedError

std.os.uefi.protocol.serial_io.SerialIo.reset

函数

第 38 行

重置串行设备。

pub fn reset(self: *SerialIo) ResetError!void

参数

self: *SerialIo

错误

DeviceError
Unexpected UnexpectedError

std.os.uefi.protocol.serial_io.SerialIo.ResetError

错误集合

第 18 行

错误

DeviceError
Unexpected UnexpectedError

std.os.uefi.protocol.serial_io.SerialIo.setAttribute

函数

第 47 行

设置串行设备的波特率、接收 FIFO 深度、发送/接收超时、奇偶校验、数据位及停止位。

pub fn setAttribute( self: *SerialIo, baud_rate: u64, receiver_fifo_depth: u32, timeout: u32, parity: ParityType, data_bits: u8, stop_bits: StopBitsType, ) SetAttributeError!void

参数

self: *SerialIo
baud_rate: u64
receiver_fifo_depth: u32
timeout: u32
parity: ParityType
data_bits: u8
stop_bits: StopBitsType

错误

DeviceError
InvalidParameter
Unexpected UnexpectedError

std.os.uefi.protocol.serial_io.SerialIo.SetAttributeError

错误集合

第 19 行

错误

DeviceError
InvalidParameter
Unexpected UnexpectedError

std.os.uefi.protocol.serial_io.SerialIo.setControl

函数

第 73 行

设置串行设备的控制位。

pub fn setControl(self: *SerialIo, control: u32) SetControlError!void

参数

self: *SerialIo
control: u32

错误

DeviceError
Unexpected UnexpectedError
Unsupported

std.os.uefi.protocol.serial_io.SerialIo.SetControlError

错误集合

第 23 行

错误

DeviceError
Unexpected UnexpectedError
Unsupported

std.os.uefi.protocol.serial_io.SerialIo.StopBitsType

容器

第 132 行

字段

default_stop_bits
one_stop_bit
one_five_stop_bits
two_stop_bits

std.os.uefi.protocol.serial_io.SerialIo.write

函数

第 93 行

向串行设备写入数据。

pub fn write(self: *SerialIo, buffer: []const u8) WriteError!usize

参数

self: *SerialIo
buffer: []const u8

错误

DeviceError
Timeout
Unexpected UnexpectedError

std.os.uefi.protocol.serial_io.SerialIo.WriteError

错误集合

第 28 行

错误

DeviceError
Timeout
Unexpected UnexpectedError

std.os.uefi.protocol.serial_io.Status

别名

第 4 行

别名目标 std.os.uefi.Status

std.os.uefi.protocol.serial_io.std

别名

第 1 行

别名目标 std

std.os.uefi.protocol.serial_io.uefi

别名

第 2 行

别名目标 std.os.uefi

源码

std/os/uefi/protocol/serial_io.zig

const std = @import("std");
const uefi = std.os.uefi;
const Guid = uefi.Guid;
const Status = uefi.Status;
const cc = uefi.cc;

pub const SerialIo = extern struct {
    revision: u64,
    _reset: *const fn (*SerialIo) callconv(cc) Status,
    _set_attribute: *const fn (*SerialIo, u64, u32, u32, ParityType, u8, StopBitsType) callconv(cc) Status,
    _set_control: *const fn (*SerialIo, u32) callconv(cc) Status,
    _get_control: *const fn (*const SerialIo, *u32) callconv(cc) Status,
    _write: *const fn (*SerialIo, *usize, *const anyopaque) callconv(cc) Status,
    _read: *const fn (*SerialIo, *usize, *anyopaque) callconv(cc) Status,
    mode: *Mode,
    device_type_guid: ?*Guid,

    pub const ResetError = uefi.UnexpectedError || error{DeviceError};
    pub const SetAttributeError = uefi.UnexpectedError || error{
        InvalidParameter,
        DeviceError,
    };
    pub const SetControlError = uefi.UnexpectedError || error{
        Unsupported,
        DeviceError,
    };
    pub const GetControlError = uefi.UnexpectedError || error{DeviceError};
    pub const WriteError = uefi.UnexpectedError || error{
        DeviceError,
        Timeout,
    };
    pub const ReadError = uefi.UnexpectedError || error{
        DeviceError,
        Timeout,
    };

    /// 重置串行设备。
    pub fn reset(self: *SerialIo) ResetError!void {
        switch (self._reset(self)) {
            .success => {},
            .device_error => return error.DeviceError,
            else => |status| return uefi.unexpectedStatus(status),
        }
    }

    /// 设置串行设备的波特率、接收 FIFO 深度、发送/接收超时、奇偶校验、数据位及停止位。
    pub fn setAttribute(
        self: *SerialIo,
        baud_rate: u64,
        receiver_fifo_depth: u32,
        timeout: u32,
        parity: ParityType,
        data_bits: u8,
        stop_bits: StopBitsType,
    ) SetAttributeError!void {
        switch (self._set_attribute(
            self,
            baud_rate,
            receiver_fifo_depth,
            timeout,
            parity,
            data_bits,
            stop_bits,
        )) {
            .success => {},
            .invalid_parameter => return error.InvalidParameter,
            .device_error => return error.DeviceError,
            else => |status| return uefi.unexpectedStatus(status),
        }
    }

    /// 设置串行设备的控制位。
    pub fn setControl(self: *SerialIo, control: u32) SetControlError!void {
        switch (self._set_control(self, control)) {
            .success => {},
            .unsupported => return error.Unsupported,
            .device_error => return error.DeviceError,
            else => |status| return uefi.unexpectedStatus(status),
        }
    }

    /// 获取串行设备控制位的状态。
    pub fn getControl(self: *SerialIo) GetControlError!u32 {
        var control: u32 = undefined;
        switch (self._get_control(self, &control)) {
            .success => return control,
            .device_error => return error.DeviceError,
            else => |status| return uefi.unexpectedStatus(status),
        }
    }

    /// 向串行设备写入数据。
    pub fn write(self: *SerialIo, buffer: []const u8) WriteError!usize {
        var len: usize = buffer.len;
        switch (self._write(self, &len, buffer.ptr)) {
            .success => return len,
            .device_error => return error.DeviceError,
            .timeout => return error.Timeout,
            else => |status| return uefi.unexpectedStatus(status),
        }
    }

    /// 从串行设备读取数据。
    pub fn read(self: *SerialIo, buffer: []u8) ReadError!usize {
        var len: usize = buffer.len;
        switch (self._read(self, &len, buffer.ptr)) {
            .success => return len,
            .device_error => return error.DeviceError,
            .timeout => return error.Timeout,
            else => |status| return uefi.unexpectedStatus(status),
        }
    }

    pub const guid align(8) = Guid{
        .time_low = 0xBB25CF6F,
        .time_mid = 0xF1D4,
        .time_high_and_version = 0x11D2,
        .clock_seq_high_and_reserved = 0x9a,
        .clock_seq_low = 0x0c,
        .node = [_]u8{ 0x00, 0x90, 0x27, 0x3f, 0xc1, 0xfd },
    };

    pub const ParityType = enum(u32) {
        default_parity,
        no_parity,
        even_parity,
        odd_parity,
        mark_parity,
        space_parity,
    };

    pub const StopBitsType = enum(u32) {
        default_stop_bits,
        one_stop_bit,
        one_five_stop_bits,
        two_stop_bits,
    };

    pub const Mode = extern struct {
        control_mask: u32,
        timeout: u32,
        baud_rate: u64,
        receive_fifo_depth: u32,
        data_bits: u32,
        parity: u32,
        stop_bits: u32,
    };
};