Skip to content

std.os.uefi.protocol.ip6_config

Standard libraryZig 0.17.1Official documentation
Sourcestd/os/uefi/protocol/ip6_config.zig

Source line 1

std.os.uefi.protocol.ip6_config.cc

alias

Source line 6

Alias of std.os.uefi.cc

std.os.uefi.protocol.ip6_config.Event

alias

Source line 4

Alias of std.os.uefi.Event

std.os.uefi.protocol.ip6_config.Guid

alias

Source line 3

Alias of std.os.uefi.Guid

std.os.uefi.protocol.ip6_config.Ip6

alias

Source line 8

Alias of std.os.uefi.protocol.Ip6

std.os.uefi.protocol.ip6_config.Ip6Config

container

Source line 10

Fields

_set_data: *const fn (*const Ip6Config, DataType, usize, *const anyopaque) callconv(cc) Status
_get_data: *const fn (*const Ip6Config, DataType, *usize, ?*const anyopaque) callconv(cc) Status
_register_data_notify: *const fn (*const Ip6Config, DataType, Event) callconv(cc) Status
_unregister_data_notify: *const fn (*const Ip6Config, DataType, Event) callconv(cc) Status

std.os.uefi.protocol.ip6_config.Ip6Config.DataType

container

Source line 119

Fields

interface_info: InterfaceInfo
alt_interface_id: InterfaceId
policy: Policy
dup_addr_detect_transmits: DupAddrDetectTransmits
manual_address: [*]ManualAddress
gateway: [*]Ip6.Address
dns_server: [*]Ip6.Address

std.os.uefi.protocol.ip6_config.Ip6Config.DupAddrDetectTransmits

container

Source line 149

Fields

dup_addr_detect_transmits: u32

std.os.uefi.protocol.ip6_config.Ip6Config.getData

function

Source line 63

pub fn getData( self: *const Ip6Config, comptime data_type: std.meta.Tag(DataType), ) GetDataError!@FieldType(DataType, @tagName(data_type))

Parameters

self: *const Ip6Config
data_type: std.meta.Tag(DataType)

Errors

BufferTooSmall
InvalidParameter
NotFound
NotReady
Unexpected UnexpectedError

std.os.uefi.protocol.ip6_config.Ip6Config.GetDataError

error-set

Source line 26

Errors

BufferTooSmall
InvalidParameter
NotFound
NotReady
Unexpected UnexpectedError

std.os.uefi.protocol.ip6_config.Ip6Config.guid

constant

Source line 110

std.os.uefi.protocol.ip6_config.Ip6Config.InterfaceId

container

Source line 140

Fields

id: [8]u8

std.os.uefi.protocol.ip6_config.Ip6Config.InterfaceInfo

container

Source line 129

Fields

name: [32]u16
if_type: u8
hw_address_size: u32
hw_address: MacAddress
address_info_count: u32
address_info: [*]Ip6.AddressInfo
route_count: u32
route_table: Ip6.RouteTable

std.os.uefi.protocol.ip6_config.Ip6Config.ManualAddress

container

Source line 153

Fields

address: Ip6.Address
is_anycast: bool
prefix_length: u8

std.os.uefi.protocol.ip6_config.Ip6Config.Policy

container

Source line 144

Fields

manual
automatic

std.os.uefi.protocol.ip6_config.Ip6Config.registerDataNotify

function

Source line 82

pub fn registerDataNotify( self: *const Ip6Config, data_type: DataType, event: Event, ) RegisterDataNotifyError!void

Parameters

self: *const Ip6Config
data_type: DataType
event: Event

Errors

AccessDenied
InvalidParameter
OutOfResources
Unexpected UnexpectedError
Unsupported

std.os.uefi.protocol.ip6_config.Ip6Config.RegisterDataNotifyError

error-set

Source line 32

Errors

AccessDenied
InvalidParameter
OutOfResources
Unexpected UnexpectedError
Unsupported

std.os.uefi.protocol.ip6_config.Ip6Config.setData

function

Source line 43

pub fn setData( self: *const Ip6Config, comptime data_type: std.meta.Tag(DataType), payload: *const @FieldType(DataType, @tagName(data_type)), ) SetDataError!void

Parameters

self: *const Ip6Config
data_type: std.meta.Tag(DataType)
payload: *const @FieldType(DataType, @tagName(data_type))

Errors

AccessDenied
BadBufferSize
DeviceError
InvalidParameter
NotReady
OutOfResources
Unexpected UnexpectedError
Unsupported
WriteProtected

std.os.uefi.protocol.ip6_config.Ip6Config.SetDataError

error-set

Source line 16

Errors

AccessDenied
BadBufferSize
DeviceError
InvalidParameter
NotReady
OutOfResources
Unexpected UnexpectedError
Unsupported
WriteProtected

std.os.uefi.protocol.ip6_config.Ip6Config.unregisterDataNotify

function

Source line 97

pub fn unregisterDataNotify( self: *const Ip6Config, data_type: DataType, event: Event, ) UnregisterDataNotifyError!void

Parameters

self: *const Ip6Config
data_type: DataType
event: Event

Errors

InvalidParameter
NotFound
Unexpected UnexpectedError

std.os.uefi.protocol.ip6_config.Ip6Config.UnregisterDataNotifyError

error-set

Source line 38

Errors

InvalidParameter
NotFound
Unexpected UnexpectedError

std.os.uefi.protocol.ip6_config.MacAddress

alias

Source line 7

Alias of std.os.uefi.MacAddress

std.os.uefi.protocol.ip6_config.Status

alias

Source line 5

Alias of std.os.uefi.Status

std.os.uefi.protocol.ip6_config.std

alias

Source line 1

Alias of std

std.os.uefi.protocol.ip6_config.uefi

alias

Source line 2

Alias of std.os.uefi

Source code

std/os/uefi/protocol/ip6_config.zig

const std = @import("std");
const uefi = std.os.uefi;
const Guid = uefi.Guid;
const Event = uefi.Event;
const Status = uefi.Status;
const cc = uefi.cc;
const MacAddress = uefi.MacAddress;
const Ip6 = uefi.protocol.Ip6;

pub const Ip6Config = extern struct {
    _set_data: *const fn (*const Ip6Config, DataType, usize, *const anyopaque) callconv(cc) Status,
    _get_data: *const fn (*const Ip6Config, DataType, *usize, ?*const anyopaque) callconv(cc) Status,
    _register_data_notify: *const fn (*const Ip6Config, DataType, Event) callconv(cc) Status,
    _unregister_data_notify: *const fn (*const Ip6Config, DataType, Event) callconv(cc) Status,

    pub const SetDataError = uefi.UnexpectedError || error{
        InvalidParameter,
        WriteProtected,
        AccessDenied,
        NotReady,
        BadBufferSize,
        Unsupported,
        OutOfResources,
        DeviceError,
    };
    pub const GetDataError = uefi.UnexpectedError || error{
        InvalidParameter,
        BufferTooSmall,
        NotReady,
        NotFound,
    };
    pub const RegisterDataNotifyError = uefi.UnexpectedError || error{
        InvalidParameter,
        Unsupported,
        OutOfResources,
        AccessDenied,
    };
    pub const UnregisterDataNotifyError = uefi.UnexpectedError || error{
        InvalidParameter,
        NotFound,
    };

    pub fn setData(
        self: *const Ip6Config,
        comptime data_type: std.meta.Tag(DataType),
        payload: *const @FieldType(DataType, @tagName(data_type)),
    ) SetDataError!void {
        const data_size = @sizeOf(@TypeOf(payload));
        switch (self._set_data(self, data_type, data_size, @ptrCast(payload))) {
            .success => {},
            .invalid_parameter => return error.InvalidParameter,
            .write_protected => return error.WriteProtected,
            .access_denied => return error.AccessDenied,
            .not_ready => return error.NotReady,
            .bad_buffer_size => return error.BadBufferSize,
            .unsupported => return error.Unsupported,
            .out_of_resources => return error.OutOfResources,
            .device_error => return error.DeviceError,
            else => |status| return uefi.unexpectedStatus(status),
        }
    }

    pub fn getData(
        self: *const Ip6Config,
        comptime data_type: std.meta.Tag(DataType),
    ) GetDataError!@FieldType(DataType, @tagName(data_type)) {
        const DataPayload = @FieldType(DataType, @tagName(data_type));

        var payload: DataPayload = undefined;
        var payload_size: usize = @sizeOf(DataPayload);

        switch (self._get_data(self, data_type, &payload_size, @ptrCast(&payload))) {
            .success => return payload,
            .invalid_parameter => return error.InvalidParameter,
            .buffer_too_small => return error.BufferTooSmall,
            .not_ready => return error.NotReady,
            .not_found => return error.NotFound,
            else => |status| return uefi.unexpectedStatus(status),
        }
    }

    pub fn registerDataNotify(
        self: *const Ip6Config,
        data_type: DataType,
        event: Event,
    ) RegisterDataNotifyError!void {
        switch (self._register_data_notify(self, data_type, event)) {
            .success => {},
            .invalid_parameter => return error.InvalidParameter,
            .unsupported => return error.Unsupported,
            .out_of_resources => return error.OutOfResources,
            .access_denied => return error.AccessDenied,
            else => |status| return uefi.unexpectedStatus(status),
        }
    }

    pub fn unregisterDataNotify(
        self: *const Ip6Config,
        data_type: DataType,
        event: Event,
    ) UnregisterDataNotifyError!void {
        switch (self._unregister_data_notify(self, data_type, event)) {
            .success => {},
            .invalid_parameter => return error.InvalidParameter,
            .not_found => return error.NotFound,
            else => |status| return uefi.unexpectedStatus(status),
        }
    }

    pub const guid align(8) = Guid{
        .time_low = 0x937fe521,
        .time_mid = 0x95ae,
        .time_high_and_version = 0x4d1a,
        .clock_seq_high_and_reserved = 0x89,
        .clock_seq_low = 0x29,
        .node = [_]u8{ 0x48, 0xbc, 0xd9, 0x0a, 0xd3, 0x1a },
    };

    pub const DataType = union(enum(u32)) {
        interface_info: InterfaceInfo,
        alt_interface_id: InterfaceId,
        policy: Policy,
        dup_addr_detect_transmits: DupAddrDetectTransmits,
        manual_address: [*]ManualAddress,
        gateway: [*]Ip6.Address,
        dns_server: [*]Ip6.Address,
    };

    pub const InterfaceInfo = extern struct {
        name: [32]u16,
        if_type: u8,
        hw_address_size: u32,
        hw_address: MacAddress,
        address_info_count: u32,
        address_info: [*]Ip6.AddressInfo,
        route_count: u32,
        route_table: Ip6.RouteTable,
    };

    pub const InterfaceId = extern struct {
        id: [8]u8,
    };

    pub const Policy = enum(u32) {
        manual,
        automatic,
    };

    pub const DupAddrDetectTransmits = extern struct {
        dup_addr_detect_transmits: u32,
    };

    pub const ManualAddress = extern struct {
        address: Ip6.Address,
        is_anycast: bool,
        prefix_length: u8,
    };
};