std.os.uefi.protocol.ip6.cc
alias
Alias of std.os.uefi.cc
std.os.uefi.protocol.ip6.Event
alias
Alias of std.os.uefi.Event
std.os.uefi.protocol.ip6.Guid
alias
Alias of std.os.uefi.Guid
std.os.uefi.protocol.ip6.Ip6
container
Fields
_get_mode_data: *const fn (*const Ip6, ?*Mode, ?*ManagedNetworkConfigData, ?*SimpleNetwork) callconv(cc) Status
_configure: *const fn (*Ip6, ?*const Config) callconv(cc) Status
_groups: *const fn (*Ip6, bool, ?*const Address) callconv(cc) Status
_routes: *const fn (*Ip6, bool, ?*const Address, u8, ?*const Address) callconv(cc) Status
_neighbors: *const fn (*Ip6, bool, *const Address, ?*const MacAddress, u32, bool) callconv(cc) Status
_transmit: *const fn (*Ip6, *CompletionToken) callconv(cc) Status
_receive: *const fn (*Ip6, *CompletionToken) callconv(cc) Status
_cancel: *const fn (*Ip6, ?*CompletionToken) callconv(cc) Status
_poll: *const fn (*Ip6) callconv(cc) Status
GetModeDataErrorConfigureErrorGroupsErrorRoutesErrorNeighborsErrorTransmitErrorReceiveErrorCancelErrorPollErrorModeDatagetModeDataconfiguredisableleaveAllGroupsgroupsroutesneighborstransmitreceivecancelpollguidDeleteFlagJoinFlagModeConfigAddressAddressInfoRouteTableNeighborStateNeighborCacheIcmpTypeCompletionToken
std.os.uefi.protocol.ip6.Ip6.Address
type
std.os.uefi.protocol.ip6.Ip6.AddressInfo
container
Fields
address: Address
prefix_length: u8
std.os.uefi.protocol.ip6.Ip6.cancel
function
Abort an asynchronous transmits or receive request.
pub fn cancel(self: *Ip6, token: ?*CompletionToken) CancelError!void
Parameters
self: *Ip6
token: ?*CompletionToken
Errors
- DeviceError
- InvalidParameter
- NotFound
- NotStarted
- Unexpected UnexpectedError
std.os.uefi.protocol.ip6.Ip6.CancelError
error-set
Errors
- DeviceError
- InvalidParameter
- NotFound
- NotStarted
- Unexpected UnexpectedError
std.os.uefi.protocol.ip6.Ip6.CompletionToken
container
Fields
std.os.uefi.protocol.ip6.Ip6.Config
container
Fields
std.os.uefi.protocol.ip6.Ip6.configure
function
Assign IPv6 address and other configuration parameter to this EFI IPv6 Protocol driver instance.
To reset the configuration, use disable instead.
pub fn configure(self: *Ip6, ip6_config_data: *const Config) ConfigureError!void
Parameters
Errors
- AlreadyStarted
- DeviceError
- InvalidParameter
- NoMapping
- OutOfResources
- Unexpected UnexpectedError
- Unsupported
std.os.uefi.protocol.ip6.Ip6.ConfigureError
error-set
Errors
- AlreadyStarted
- DeviceError
- InvalidParameter
- NoMapping
- OutOfResources
- Unexpected UnexpectedError
- Unsupported
std.os.uefi.protocol.ip6.Ip6.DeleteFlag
container
Fields
delete
add
std.os.uefi.protocol.ip6.Ip6.disable
function
pub fn disable(self: *Ip6) ConfigureError!void
Parameters
self: *Ip6
Errors
- AlreadyStarted
- DeviceError
- InvalidParameter
- NoMapping
- OutOfResources
- Unexpected UnexpectedError
- Unsupported
std.os.uefi.protocol.ip6.Ip6.getModeData
function
Gets the current operational settings for this instance of the EFI IPv6 Protocol driver.
pub fn getModeData(self: *const Ip6) GetModeDataError!ModeData
Parameters
self: *const Ip6
Errors
- InvalidParameter
- OutOfResources
- Unexpected UnexpectedError
std.os.uefi.protocol.ip6.Ip6.GetModeDataError
error-set
Errors
- InvalidParameter
- OutOfResources
- Unexpected UnexpectedError
std.os.uefi.protocol.ip6.Ip6.groups
function
Joins and leaves multicast groups.
To leave all groups, use leaveAllGroups instead.
pub fn groups( self: *Ip6, join_flag: JoinFlag, group_address: *const Address, ) GroupsError!void
Parameters
Errors
- AlreadyStarted
- DeviceError
- InvalidParameter
- NotFound
- NotStarted
- OutOfResources
- Unexpected UnexpectedError
- Unsupported
std.os.uefi.protocol.ip6.Ip6.GroupsError
error-set
Errors
- AlreadyStarted
- DeviceError
- InvalidParameter
- NotFound
- NotStarted
- OutOfResources
- Unexpected UnexpectedError
- Unsupported
std.os.uefi.protocol.ip6.Ip6.guid
constant
std.os.uefi.protocol.ip6.Ip6.IcmpType
container
Fields
type: u8
code: u8
std.os.uefi.protocol.ip6.Ip6.JoinFlag
container
Fields
join
leave
std.os.uefi.protocol.ip6.Ip6.leaveAllGroups
function
pub fn leaveAllGroups(self: *Ip6) GroupsError!void
Parameters
self: *Ip6
Errors
- AlreadyStarted
- DeviceError
- InvalidParameter
- NotFound
- NotStarted
- OutOfResources
- Unexpected UnexpectedError
- Unsupported
std.os.uefi.protocol.ip6.Ip6.Mode
container
Fields
is_started: bool
max_packet_size: u32
config_data: Config
is_configured: bool
address_count: u32
address_list: [*]AddressInfo
group_count: u32
group_table: [*]Address
route_count: u32
route_table: [*]RouteTable
neighbor_count: u32
neighbor_cache: [*]NeighborCache
prefix_count: u32
prefix_table: [*]AddressInfo
icmp_type_count: u32
icmp_type_list: [*]IcmpType
std.os.uefi.protocol.ip6.Ip6.ModeData
container
Fields
std.os.uefi.protocol.ip6.Ip6.NeighborCache
container
Fields
std.os.uefi.protocol.ip6.Ip6.neighbors
function
Add or delete Neighbor cache entries.
pub fn neighbors( self: *Ip6, delete_flag: DeleteFlag, target_ip6_address: *const Address, target_link_address: ?*const MacAddress, timeout: u32, override: bool, ) NeighborsError!void
Parameters
self: *Ip6
delete_flag: DeleteFlag
target_ip6_address: *const Address
target_link_address: ?*const MacAddress
timeout: u32
override: bool
Errors
- AccessDenied
- InvalidParameter
- NotFound
- NotStarted
- OutOfResources
- Unexpected UnexpectedError
std.os.uefi.protocol.ip6.Ip6.NeighborsError
error-set
Errors
- AccessDenied
- InvalidParameter
- NotFound
- NotStarted
- OutOfResources
- Unexpected UnexpectedError
std.os.uefi.protocol.ip6.Ip6.NeighborState
container
Fields
incomplete
reachable
stale
delay
probe
std.os.uefi.protocol.ip6.Ip6.poll
function
Polls for incoming data packets and processes outgoing data packets.
Returns true if a packet was received or processed.
pub fn poll(self: *Ip6) PollError!bool
Parameters
self: *Ip6
Errors
- DeviceError
- InvalidParameter
- NotStarted
- Timeout
- Unexpected UnexpectedError
std.os.uefi.protocol.ip6.Ip6.PollError
error-set
Errors
- DeviceError
- InvalidParameter
- NotStarted
- Timeout
- Unexpected UnexpectedError
std.os.uefi.protocol.ip6.Ip6.receive
function
Places a receiving request into the receiving queue.
pub fn receive(self: *Ip6, token: *CompletionToken) ReceiveError!void
Parameters
self: *Ip6
token: *CompletionToken
Errors
- AccessDenied
- DeviceError
- InvalidParameter
- NoMapping
- NoMedia
- NotReady
- NotStarted
- OutOfResources
- Unexpected UnexpectedError
std.os.uefi.protocol.ip6.Ip6.ReceiveError
error-set
Errors
- AccessDenied
- DeviceError
- InvalidParameter
- NoMapping
- NoMedia
- NotReady
- NotStarted
- OutOfResources
- Unexpected UnexpectedError
std.os.uefi.protocol.ip6.Ip6.routes
function
Adds and deletes routing table entries.
pub fn routes( self: *Ip6, delete_route: DeleteFlag, destination: ?*const Address, prefix_length: u8, gateway_address: ?*const Address, ) RoutesError!void
Parameters
self: *Ip6
delete_route: DeleteFlag
destination: ?*const Address
prefix_length: u8
gateway_address: ?*const Address
Errors
- AccessDenied
- InvalidParameter
- NotFound
- NotStarted
- OutOfResources
- Unexpected UnexpectedError
std.os.uefi.protocol.ip6.Ip6.RoutesError
error-set
Errors
- AccessDenied
- InvalidParameter
- NotFound
- NotStarted
- OutOfResources
- Unexpected UnexpectedError
std.os.uefi.protocol.ip6.Ip6.RouteTable
container
Fields
std.os.uefi.protocol.ip6.Ip6.transmit
function
Places outgoing data packets into the transmit queue.
pub fn transmit(self: *Ip6, token: *CompletionToken) TransmitError!void
Parameters
self: *Ip6
token: *CompletionToken
Errors
- AccessDenied
- BadBufferSize
- BufferTooSmall
- DeviceError
- InvalidParameter
- NoMapping
- NoMedia
- NotFound
- NotReady
- NotStarted
- OutOfResources
- Unexpected UnexpectedError
std.os.uefi.protocol.ip6.Ip6.TransmitError
error-set
Errors
- AccessDenied
- BadBufferSize
- BufferTooSmall
- DeviceError
- InvalidParameter
- NoMapping
- NoMedia
- NotFound
- NotReady
- NotStarted
- OutOfResources
- Unexpected UnexpectedError
std.os.uefi.protocol.ip6.MacAddress
alias
Alias of std.os.uefi.MacAddress
std.os.uefi.protocol.ip6.ManagedNetworkConfigData
alias
Alias of std.os.uefi.protocol.managed_network.ManagedNetwork.Config
std.os.uefi.protocol.ip6.SimpleNetwork
alias
Alias of std.os.uefi.protocol.SimpleNetwork
std.os.uefi.protocol.ip6.Status
alias
Alias of std.os.uefi.Status
std.os.uefi.protocol.ip6.std
alias
Alias of std
std.os.uefi.protocol.ip6.uefi
alias
Alias of std.os.uefi
Source code
std/os/uefi/protocol/ip6.zig
const std = @import("std");
const uefi = std.os.uefi;
const Guid = uefi.Guid;
const Event = uefi.Event;
const Status = uefi.Status;
const MacAddress = uefi.MacAddress;
const ManagedNetworkConfigData = uefi.protocol.ManagedNetwork.Config;
const SimpleNetwork = uefi.protocol.SimpleNetwork;
const cc = uefi.cc;
pub const Ip6 = extern struct {
_get_mode_data: *const fn (*const Ip6, ?*Mode, ?*ManagedNetworkConfigData, ?*SimpleNetwork) callconv(cc) Status,
_configure: *const fn (*Ip6, ?*const Config) callconv(cc) Status,
_groups: *const fn (*Ip6, bool, ?*const Address) callconv(cc) Status,
_routes: *const fn (*Ip6, bool, ?*const Address, u8, ?*const Address) callconv(cc) Status,
_neighbors: *const fn (*Ip6, bool, *const Address, ?*const MacAddress, u32, bool) callconv(cc) Status,
_transmit: *const fn (*Ip6, *CompletionToken) callconv(cc) Status,
_receive: *const fn (*Ip6, *CompletionToken) callconv(cc) Status,
_cancel: *const fn (*Ip6, ?*CompletionToken) callconv(cc) Status,
_poll: *const fn (*Ip6) callconv(cc) Status,
pub const GetModeDataError = uefi.UnexpectedError || error{
InvalidParameter,
OutOfResources,
};
pub const ConfigureError = uefi.UnexpectedError || error{
InvalidParameter,
OutOfResources,
NoMapping,
AlreadyStarted,
DeviceError,
Unsupported,
};
pub const GroupsError = uefi.UnexpectedError || error{
InvalidParameter,
NotStarted,
OutOfResources,
Unsupported,
AlreadyStarted,
NotFound,
DeviceError,
};
pub const RoutesError = uefi.UnexpectedError || error{
NotStarted,
InvalidParameter,
OutOfResources,
NotFound,
AccessDenied,
};
pub const NeighborsError = uefi.UnexpectedError || error{
NotStarted,
InvalidParameter,
OutOfResources,
NotFound,
AccessDenied,
};
pub const TransmitError = uefi.UnexpectedError || error{
NotStarted,
NoMapping,
InvalidParameter,
AccessDenied,
NotReady,
NotFound,
OutOfResources,
BufferTooSmall,
BadBufferSize,
DeviceError,
NoMedia,
};
pub const ReceiveError = uefi.UnexpectedError || error{
NotStarted,
NoMapping,
InvalidParameter,
OutOfResources,
DeviceError,
AccessDenied,
NotReady,
NoMedia,
};
pub const CancelError = uefi.UnexpectedError || error{
InvalidParameter,
NotStarted,
NotFound,
DeviceError,
};
pub const PollError = uefi.UnexpectedError || error{
NotStarted,
InvalidParameter,
DeviceError,
Timeout,
};
pub const ModeData = struct {
ip6_mode: Mode,
mnp_config: ManagedNetworkConfigData,
snp_mode: SimpleNetwork,
};
/// Gets the current operational settings for this instance of the EFI IPv6 Protocol driver.
pub fn getModeData(self: *const Ip6) GetModeDataError!ModeData {
var data: ModeData = undefined;
switch (self._get_mode_data(self, &data.ip6_mode, &data.mnp_config, &data.snp_mode)) {
.success => return data,
.invalid_parameter => return error.InvalidParameter,
.out_of_resources => return error.OutOfResources,
else => |status| return uefi.unexpectedStatus(status),
}
}
/// Assign IPv6 address and other configuration parameter to this EFI IPv6 Protocol driver instance.
///
/// To reset the configuration, use `disable` instead.
pub fn configure(self: *Ip6, ip6_config_data: *const Config) ConfigureError!void {
switch (self._configure(self, ip6_config_data)) {
.success => {},
.invalid_parameter => return error.InvalidParameter,
.out_of_resources => return error.OutOfResources,
.no_mapping => return error.NoMapping,
.already_started => return error.AlreadyStarted,
.device_error => return error.DeviceError,
.unsupported => return error.Unsupported,
else => |status| return uefi.unexpectedStatus(status),
}
}
pub fn disable(self: *Ip6) ConfigureError!void {
switch (self._configure(self, null)) {
.success => {},
.invalid_parameter => return error.InvalidParameter,
.out_of_resources => return error.OutOfResources,
.no_mapping => return error.NoMapping,
.already_started => return error.AlreadyStarted,
.device_error => return error.DeviceError,
.unsupported => return error.Unsupported,
else => |status| return uefi.unexpectedStatus(status),
}
}
pub fn leaveAllGroups(self: *Ip6) GroupsError!void {
switch (self._groups(self, false, null)) {
.success => {},
.invalid_parameter => return error.InvalidParameter,
.not_started => return error.NotStarted,
.out_of_resources => return error.OutOfResources,
.unsupported => return error.Unsupported,
.already_started => return error.AlreadyStarted,
.not_found => return error.NotFound,
.device_error => return error.DeviceError,
else => |status| return uefi.unexpectedStatus(status),
}
}
/// Joins and leaves multicast groups.
///
/// To leave all groups, use `leaveAllGroups` instead.
pub fn groups(
self: *Ip6,
join_flag: JoinFlag,
group_address: *const Address,
) GroupsError!void {
switch (self._groups(
self,
// set to TRUE to join the multicast group session and FALSE to leave
join_flag == .join,
group_address,
)) {
.success => {},
.invalid_parameter => return error.InvalidParameter,
.not_started => return error.NotStarted,
.out_of_resources => return error.OutOfResources,
.unsupported => return error.Unsupported,
.already_started => return error.AlreadyStarted,
.not_found => return error.NotFound,
.device_error => return error.DeviceError,
else => |status| return uefi.unexpectedStatus(status),
}
}
/// Adds and deletes routing table entries.
pub fn routes(
self: *Ip6,
delete_route: DeleteFlag,
destination: ?*const Address,
prefix_length: u8,
gateway_address: ?*const Address,
) RoutesError!void {
switch (self._routes(
self,
delete_route == .delete,
destination,
prefix_length,
gateway_address,
)) {
.success => {},
.not_started => return error.NotStarted,
.invalid_parameter => return error.InvalidParameter,
.out_of_resources => return error.OutOfResources,
.not_found => return error.NotFound,
.access_denied => return error.AccessDenied,
else => |status| return uefi.unexpectedStatus(status),
}
}
/// Add or delete Neighbor cache entries.
pub fn neighbors(
self: *Ip6,
delete_flag: DeleteFlag,
target_ip6_address: *const Address,
target_link_address: ?*const MacAddress,
timeout: u32,
override: bool,
) NeighborsError!void {
switch (self._neighbors(
self,
// set to TRUE to delete this route from the routing table.
// set to FALSE to add this route to the routing table.
delete_flag == .delete,
target_ip6_address,
target_link_address,
timeout,
override,
)) {
.success => {},
.not_started => return error.NotStarted,
.invalid_parameter => return error.InvalidParameter,
.out_of_resources => return error.OutOfResources,
.not_found => return error.NotFound,
.access_denied => return error.AccessDenied,
else => |status| return uefi.unexpectedStatus(status),
}
}
/// Places outgoing data packets into the transmit queue.
pub fn transmit(self: *Ip6, token: *CompletionToken) TransmitError!void {
switch (self._transmit(self, token)) {
.success => {},
.not_started => return error.NotStarted,
.no_mapping => return error.NoMapping,
.invalid_parameter => return error.InvalidParameter,
.access_denied => return error.AccessDenied,
.not_ready => return error.NotReady,
.not_found => return error.NotFound,
.out_of_resources => return error.OutOfResources,
.buffer_too_small => return error.BufferTooSmall,
.bad_buffer_size => return error.BadBufferSize,
.device_error => return error.DeviceError,
.no_media => return error.NoMedia,
else => |status| return uefi.unexpectedStatus(status),
}
}
/// Places a receiving request into the receiving queue.
pub fn receive(self: *Ip6, token: *CompletionToken) ReceiveError!void {
switch (self._receive(self, token)) {
.success => {},
.not_started => return error.NotStarted,
.no_mapping => return error.NoMapping,
.invalid_parameter => return error.InvalidParameter,
.out_of_resources => return error.OutOfResources,
.device_error => return error.DeviceError,
.access_denied => return error.AccessDenied,
.not_ready => return error.NotReady,
.no_media => return error.NoMedia,
else => |status| return uefi.unexpectedStatus(status),
}
}
/// Abort an asynchronous transmits or receive request.
pub fn cancel(self: *Ip6, token: ?*CompletionToken) CancelError!void {
switch (self._cancel(self, token)) {
.success => {},
.invalid_parameter => return error.InvalidParameter,
.not_started => return error.NotStarted,
.not_found => return error.NotFound,
.device_error => return error.DeviceError,
else => |status| return uefi.unexpectedStatus(status),
}
}
/// Polls for incoming data packets and processes outgoing data packets.
///
/// Returns true if a packet was received or processed.
pub fn poll(self: *Ip6) PollError!bool {
switch (self._poll(self)) {
.success => return true,
.not_ready => return false,
.not_started => return error.NotStarted,
.invalid_parameter => return error.InvalidParameter,
.device_error => return error.DeviceError,
.timeout => return error.Timeout,
else => |status| return uefi.unexpectedStatus(status),
}
}
pub const guid align(8) = Guid{
.time_low = 0x2c8759d5,
.time_mid = 0x5c2d,
.time_high_and_version = 0x66ef,
.clock_seq_high_and_reserved = 0x92,
.clock_seq_low = 0x5f,
.node = [_]u8{ 0xb6, 0x6c, 0x10, 0x19, 0x57, 0xe2 },
};
pub const DeleteFlag = enum {
delete,
add,
};
pub const JoinFlag = enum {
join,
leave,
};
pub const Mode = extern struct {
is_started: bool,
max_packet_size: u32,
config_data: Config,
is_configured: bool,
address_count: u32,
address_list: [*]AddressInfo,
group_count: u32,
group_table: [*]Address,
route_count: u32,
route_table: [*]RouteTable,
neighbor_count: u32,
neighbor_cache: [*]NeighborCache,
prefix_count: u32,
prefix_table: [*]AddressInfo,
icmp_type_count: u32,
icmp_type_list: [*]IcmpType,
};
pub const Config = extern struct {
default_protocol: u8,
accept_any_protocol: bool,
accept_icmp_errors: bool,
accept_promiscuous: bool,
destination_address: Address,
station_address: Address,
traffic_class: u8,
hop_limit: u8,
flow_label: u32,
receive_timeout: u32,
transmit_timeout: u32,
};
pub const Address = [16]u8;
pub const AddressInfo = extern struct {
address: Address,
prefix_length: u8,
};
pub const RouteTable = extern struct {
gateway: Address,
destination: Address,
prefix_length: u8,
};
pub const NeighborState = enum(u32) {
incomplete,
reachable,
stale,
delay,
probe,
};
pub const NeighborCache = extern struct {
neighbor: Address,
link_address: MacAddress,
state: NeighborState,
};
pub const IcmpType = extern struct {
type: u8,
code: u8,
};
pub const CompletionToken = extern struct {
event: Event,
status: Status,
packet: *anyopaque, // union TODO
};
};