跳转到内容

std.os.uefi.protocol.block_io

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

第 1 行

std.os.uefi.protocol.block_io.BlockIo

容器

第 6 行

字段

revision: u64
media: *BlockMedia
_reset: *const fn (*BlockIo, extended_verification: bool) callconv(cc) Status
_read_blocks: *const fn (*BlockIo, media_id: u32, lba: u64, buffer_size: usize, buf: [*]u8) callconv(cc) Status
_write_blocks: *const fn (*BlockIo, media_id: u32, lba: u64, buffer_size: usize, buf: [*]const u8) callconv(cc) Status
_flush_blocks: *const fn (*BlockIo) callconv(cc) Status

std.os.uefi.protocol.block_io.BlockIo.BlockMedia

容器

第 91 行

字段

media_id: u32

当前介质 ID。介质更改时,此值也随之更改。

removable_media: bool

若介质可移除,则为 true;否则为 false。

media_present: bool

设备中当前有介质时为 true

logical_partition: bool

若 BlockIo 用于抽象磁盘上的分区结构, 则为 true。若 BlockIo 用于 抽象硬件设备上的逻辑块,则为 false。

read_only: bool

介质标记为只读时为 true,否则为 false。此字段 反映最近一次 WriteBlocks() 时的只读状态

write_caching: bool

若 WriteBlocks() 函数缓存写入数据,则为 true。

block_size: u32

设备固有的块大小。若介质更换,则此

io_align: u32

规定数据传输所用任意缓冲区的对齐要求。 IoAlign 为 0 或 1 表示缓冲区可以位于内存中的任意位置。 否则,IoAlign 必须为 2 的幂,且缓冲区起始地址必须能被 IoAlign 整除,不能有余数。

last_block: u64

设备上的最后一个 LBA。如果介质变化,则更新此字段。

lowest_aligned_lba: u64
logical_blocks_per_physical_block: u32
optimal_transfer_length_granularity: u32

std.os.uefi.protocol.block_io.BlockIo.flushBlocks

函数

第 73 行

将所有已修改数据刷新到物理块设备。

pub fn flushBlocks(self: *Self) FlushBlocksError!void

参数

self: *Self

错误

DeviceError
NoMedia
Unexpected UnexpectedError

std.os.uefi.protocol.block_io.BlockIo.FlushBlocksError

错误集合

第 32 行

错误

DeviceError
NoMedia
Unexpected UnexpectedError

std.os.uefi.protocol.block_io.BlockIo.guid

常量

第 82 行

std.os.uefi.protocol.block_io.BlockIo.readBlocks

函数

第 47 行

从设备读取请求数量的数据块。

pub fn readBlocks(self: *Self, media_id: u32, lba: u64, buf: []u8) ReadBlocksError!void

参数

self: *Self
media_id: u32
lba: u64
buf: []u8

错误

BadBufferSize
DeviceError
InvalidParameter
NoMedia
Unexpected UnexpectedError

std.os.uefi.protocol.block_io.BlockIo.ReadBlocksError

错误集合

第 18 行

错误

BadBufferSize
DeviceError
InvalidParameter
NoMedia
Unexpected UnexpectedError

std.os.uefi.protocol.block_io.BlockIo.reset

函数

第 38 行

重置块设备硬件。

pub fn reset(self: *Self, extended_verification: bool) ResetError!void

参数

self: *Self
extended_verification: bool

错误

DeviceError
Unexpected UnexpectedError

std.os.uefi.protocol.block_io.BlockIo.ResetError

错误集合

第 17 行

错误

DeviceError
Unexpected UnexpectedError

std.os.uefi.protocol.block_io.BlockIo.Self

别名

第 7 行

别名目标 std.os.uefi.protocol.block_io.BlockIo

std.os.uefi.protocol.block_io.BlockIo.writeBlocks

函数

第 59 行

向设备写入指定数量的数据块。

pub fn writeBlocks(self: *Self, media_id: u32, lba: u64, buf: []const u8) WriteBlocksError!void

参数

self: *Self
media_id: u32
lba: u64
buf: []const u8

错误

BadBufferSize
DeviceError
InvalidParameter
MediaChanged
NoMedia
Unexpected UnexpectedError
WriteProtected

std.os.uefi.protocol.block_io.BlockIo.WriteBlocksError

错误集合

第 24 行

错误

BadBufferSize
DeviceError
InvalidParameter
MediaChanged
NoMedia
Unexpected UnexpectedError
WriteProtected

std.os.uefi.protocol.block_io.cc

别名

第 4 行

别名目标 std.os.uefi.cc

std.os.uefi.protocol.block_io.Status

别名

第 3 行

别名目标 std.os.uefi.Status

std.os.uefi.protocol.block_io.std

别名

第 1 行

别名目标 std

std.os.uefi.protocol.block_io.uefi

别名

第 2 行

别名目标 std.os.uefi

源码

std/os/uefi/protocol/block_io.zig

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

pub const BlockIo = extern struct {
    const Self = @This();

    revision: u64,
    media: *BlockMedia,

    _reset: *const fn (*BlockIo, extended_verification: bool) callconv(cc) Status,
    _read_blocks: *const fn (*BlockIo, media_id: u32, lba: u64, buffer_size: usize, buf: [*]u8) callconv(cc) Status,
    _write_blocks: *const fn (*BlockIo, media_id: u32, lba: u64, buffer_size: usize, buf: [*]const u8) callconv(cc) Status,
    _flush_blocks: *const fn (*BlockIo) callconv(cc) Status,

    pub const ResetError = uefi.UnexpectedError || error{DeviceError};
    pub const ReadBlocksError = uefi.UnexpectedError || error{
        DeviceError,
        NoMedia,
        BadBufferSize,
        InvalidParameter,
    };
    pub const WriteBlocksError = uefi.UnexpectedError || error{
        WriteProtected,
        NoMedia,
        MediaChanged,
        DeviceError,
        BadBufferSize,
        InvalidParameter,
    };
    pub const FlushBlocksError = uefi.UnexpectedError || error{
        DeviceError,
        NoMedia,
    };

    /// 重置块设备硬件。
    pub fn reset(self: *Self, extended_verification: bool) ResetError!void {
        switch (self._reset(self, extended_verification)) {
            .success => {},
            .device_error => return error.DeviceError,
            else => |status| return uefi.unexpectedStatus(status),
        }
    }

    /// 从设备读取请求数量的数据块。
    pub fn readBlocks(self: *Self, media_id: u32, lba: u64, buf: []u8) ReadBlocksError!void {
        switch (self._read_blocks(self, media_id, lba, buf.len, buf.ptr)) {
            .success => {},
            .device_error => return error.DeviceError,
            .no_media => return error.NoMedia,
            .bad_buffer_size => return error.BadBufferSize,
            .invalid_parameter => return error.InvalidParameter,
            else => |status| return uefi.unexpectedStatus(status),
        }
    }

    /// 向设备写入指定数量的数据块。
    pub fn writeBlocks(self: *Self, media_id: u32, lba: u64, buf: []const u8) WriteBlocksError!void {
        switch (self._write_blocks(self, media_id, lba, buf.len, buf.ptr)) {
            .success => {},
            .write_protected => return error.WriteProtected,
            .no_media => return error.NoMedia,
            .media_changed => return error.MediaChanged,
            .device_error => return error.DeviceError,
            .bad_buffer_size => return error.BadBufferSize,
            .invalid_parameter => return error.InvalidParameter,
            else => |status| return uefi.unexpectedStatus(status),
        }
    }

    /// 将所有已修改数据刷新到物理块设备。
    pub fn flushBlocks(self: *Self) FlushBlocksError!void {
        switch (self._flush_blocks(self)) {
            .success => {},
            .device_error => return error.DeviceError,
            .no_media => return error.NoMedia,
            else => |status| return uefi.unexpectedStatus(status),
        }
    }

    pub const guid align(8) = uefi.Guid{
        .time_low = 0x964e5b21,
        .time_mid = 0x6459,
        .time_high_and_version = 0x11d2,
        .clock_seq_high_and_reserved = 0x8e,
        .clock_seq_low = 0x39,
        .node = [_]u8{ 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b },
    };

    pub const BlockMedia = extern struct {
        /// 当前介质 ID。介质更改时,此值也随之更改。
        media_id: u32,

        /// 若介质可移除,则为 `true`;否则为 `false`。
        removable_media: bool,
        /// 设备中当前有介质时为 `true`
        media_present: bool,
        /// 若 `BlockIo` 用于抽象磁盘上的分区结构,
        /// 则为 `true`。若 `BlockIo` 用于
        /// 抽象硬件设备上的逻辑块,则为 `false`。
        logical_partition: bool,
        /// 介质标记为只读时为 `true`,否则为 `false`。此字段
        /// 反映最近一次 `WriteBlocks()` 时的只读状态
        read_only: bool,
        /// 若 WriteBlocks() 函数缓存写入数据,则为 `true`。
        write_caching: bool,

        /// 设备固有的块大小。若介质更换,则此
        // 更新该字段。返回每个逻辑块的字节数。
        block_size: u32,
        /// 规定数据传输所用任意缓冲区的对齐要求。
        /// IoAlign 为 0 或 1 表示缓冲区可以位于内存中的任意位置。
        /// 否则,IoAlign 必须为 2 的幂,且缓冲区起始地址必须能被 IoAlign 整除,不能有余数。
        ///
        ///
        io_align: u32,
        /// 设备上的最后一个 LBA。如果介质变化,则更新此字段。
        last_block: u64,

        // 修订版 2
        lowest_aligned_lba: u64,
        logical_blocks_per_physical_block: u32,
        optimal_transfer_length_granularity: u32,
    };
};