Skip to content

std.os.uefi.protocol.loaded_image

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

Source line 1

std.os.uefi.protocol.loaded_image.cc

alias

Source line 9

Alias of std.os.uefi.cc

std.os.uefi.protocol.loaded_image.DevicePath

alias

Source line 8

Alias of std.os.uefi.protocol.DevicePath

std.os.uefi.protocol.loaded_image.Guid

alias

Source line 3

Alias of std.os.uefi.Guid

std.os.uefi.protocol.loaded_image.Handle

alias

Source line 4

Alias of std.os.uefi.Handle

std.os.uefi.protocol.loaded_image.LoadedImage

container

Source line 11

Fields

revision: u32
parent_handle: Handle
system_table: *SystemTable
device_handle: ?Handle
file_path: *DevicePath
reserved: *anyopaque
load_options_size: u32
load_options: ?*anyopaque
image_base: [*]u8
image_size: u64
image_code_type: MemoryType
image_data_type: MemoryType
_unload: *const fn (*LoadedImage, Handle) callconv(cc) Status

std.os.uefi.protocol.loaded_image.LoadedImage.device_path_guid

constant

Source line 46

std.os.uefi.protocol.loaded_image.LoadedImage.guid

constant

Source line 37

std.os.uefi.protocol.loaded_image.LoadedImage.unload

function

Source line 29

Unloads an image from memory.

pub fn unload(self: *LoadedImage, handle: Handle) UnloadError!void

Parameters

self: *LoadedImage
handle: Handle

Errors

InvalidParameter
Unexpected UnexpectedError

std.os.uefi.protocol.loaded_image.LoadedImage.UnloadError

error-set

Source line 26

Errors

InvalidParameter
Unexpected UnexpectedError

std.os.uefi.protocol.loaded_image.MemoryType

alias

Source line 7

Alias of std.os.uefi.tables.MemoryType

std.os.uefi.protocol.loaded_image.Status

alias

Source line 5

Alias of std.os.uefi.Status

std.os.uefi.protocol.loaded_image.std

alias

Source line 1

Alias of std

std.os.uefi.protocol.loaded_image.SystemTable

alias

Source line 6

Alias of std.os.uefi.tables.SystemTable

std.os.uefi.protocol.loaded_image.uefi

alias

Source line 2

Alias of std.os.uefi

Source code

std/os/uefi/protocol/loaded_image.zig

const std = @import("std");
const uefi = std.os.uefi;
const Guid = uefi.Guid;
const Handle = uefi.Handle;
const Status = uefi.Status;
const SystemTable = uefi.tables.SystemTable;
const MemoryType = uefi.tables.MemoryType;
const DevicePath = uefi.protocol.DevicePath;
const cc = uefi.cc;

pub const LoadedImage = extern struct {
    revision: u32,
    parent_handle: Handle,
    system_table: *SystemTable,
    device_handle: ?Handle,
    file_path: *DevicePath,
    reserved: *anyopaque,
    load_options_size: u32,
    load_options: ?*anyopaque,
    image_base: [*]u8,
    image_size: u64,
    image_code_type: MemoryType,
    image_data_type: MemoryType,
    _unload: *const fn (*LoadedImage, Handle) callconv(cc) Status,

    pub const UnloadError = uefi.UnexpectedError || error{InvalidParameter};

    /// Unloads an image from memory.
    pub fn unload(self: *LoadedImage, handle: Handle) UnloadError!void {
        switch (self._unload(self, handle)) {
            .success => {},
            .invalid_parameter => return error.InvalidParameter,
            else => |status| return uefi.unexpectedStatus(status),
        }
    }

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

    pub const device_path_guid align(8) = Guid{
        .time_low = 0xbc62157e,
        .time_mid = 0x3e33,
        .time_high_and_version = 0x4fec,
        .clock_seq_high_and_reserved = 0x99,
        .clock_seq_low = 0x20,
        .node = [_]u8{ 0x2d, 0x3b, 0x36, 0xd7, 0x50, 0xdf },
    };
};