efi_wrap.h File Reference

EFI driver interface. More...

#include <ipxe/efi/efi.h>

Go to the source code of this file.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
void	efi_wrap_bs (EFI_BOOT_SERVICES *wrapped)
	Wrap a boot services table. More...
void	efi_wrap_rs (EFI_RUNTIME_SERVICES *wrapped)
	Wrap a runtime services table. More...
void	efi_wrap_systab (int global)
	Wrap the public EFI system table. More...
void	efi_unwrap (void)
	Remove boot services table wrapper. More...
void	efi_wrap_image (EFI_HANDLE handle)
	Wrap calls made by a newly loaded image. More...

Detailed Description

EFI driver interface.

Definition in file efi_wrap.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

efi_wrap_bs()

void efi_wrap_bs

(

EFI_BOOT_SERVICES *

wrapper

)

Wrap a boot services table.

Parameters

wrapper

Boot services table to wrap

Definition at line 1413 of file efi_wrap.c.

                                                {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;

        /* Do nothing unless debugging is enabled */
        if ( ! DBG_LOG )
                return;

        /* Build boot services table wrapper */
        memcpy ( wrapper, bs, sizeof ( *wrapper ) );
        wrapper->RaiseTPL               = efi_raise_tpl_wrapper;
        wrapper->RestoreTPL             = efi_restore_tpl_wrapper;
        wrapper->AllocatePages          = efi_allocate_pages_wrapper;
        wrapper->FreePages              = efi_free_pages_wrapper;
        wrapper->GetMemoryMap           = efi_get_memory_map_wrapper;
        wrapper->AllocatePool           = efi_allocate_pool_wrapper;
        wrapper->FreePool               = efi_free_pool_wrapper;
        wrapper->CreateEvent            = efi_create_event_wrapper;
        wrapper->SetTimer               = efi_set_timer_wrapper;
        wrapper->WaitForEvent           = efi_wait_for_event_wrapper;
        wrapper->SignalEvent            = efi_signal_event_wrapper;
        wrapper->CloseEvent             = efi_close_event_wrapper;
        wrapper->CheckEvent             = efi_check_event_wrapper;
        wrapper->InstallProtocolInterface
                = efi_install_protocol_interface_wrapper;
        wrapper->ReinstallProtocolInterface
                = efi_reinstall_protocol_interface_wrapper;
        wrapper->UninstallProtocolInterface
                = efi_uninstall_protocol_interface_wrapper;
        wrapper->HandleProtocol         = efi_handle_protocol_wrapper;
        wrapper->RegisterProtocolNotify = efi_register_protocol_notify_wrapper;
        wrapper->LocateHandle           = efi_locate_handle_wrapper;
        wrapper->LocateDevicePath       = efi_locate_device_path_wrapper;
        wrapper->InstallConfigurationTable
                = efi_install_configuration_table_wrapper;
        wrapper->LoadImage              = efi_load_image_wrapper;
        wrapper->StartImage             = efi_start_image_wrapper;
        wrapper->Exit                   = efi_exit_wrapper;
        wrapper->UnloadImage            = efi_unload_image_wrapper;
        wrapper->ExitBootServices       = efi_exit_boot_services_wrapper;
        wrapper->GetNextMonotonicCount  = efi_get_next_monotonic_count_wrapper;
        wrapper->Stall                  = efi_stall_wrapper;
        wrapper->SetWatchdogTimer       = efi_set_watchdog_timer_wrapper;
        wrapper->ConnectController      = efi_connect_controller_wrapper;
        wrapper->DisconnectController   = efi_disconnect_controller_wrapper;
        wrapper->OpenProtocol           = efi_open_protocol_wrapper;
        wrapper->CloseProtocol          = efi_close_protocol_wrapper;
        wrapper->OpenProtocolInformation
                = efi_open_protocol_information_wrapper;
        wrapper->ProtocolsPerHandle     = efi_protocols_per_handle_wrapper;
        wrapper->LocateHandleBuffer     = efi_locate_handle_buffer_wrapper;
        wrapper->LocateProtocol         = efi_locate_protocol_wrapper;
        wrapper->InstallMultipleProtocolInterfaces
                = efi_install_multiple_protocol_interfaces_wrapper;
        wrapper->UninstallMultipleProtocolInterfaces
                = efi_uninstall_multiple_protocol_interfaces_wrapper;
        wrapper->CreateEventEx          = efi_create_event_ex_wrapper;
}

References EFI_BOOT_SERVICES::AllocatePages, EFI_BOOT_SERVICES::AllocatePool, EFI_SYSTEM_TABLE::BootServices, EFI_BOOT_SERVICES::CheckEvent, EFI_BOOT_SERVICES::CloseEvent, EFI_BOOT_SERVICES::CloseProtocol, EFI_BOOT_SERVICES::ConnectController, EFI_BOOT_SERVICES::CreateEvent, EFI_BOOT_SERVICES::CreateEventEx, DBG_LOG, EFI_BOOT_SERVICES::DisconnectController, efi_allocate_pages_wrapper(), efi_allocate_pool_wrapper(), efi_check_event_wrapper(), efi_close_event_wrapper(), efi_close_protocol_wrapper(), efi_connect_controller_wrapper(), efi_create_event_ex_wrapper(), efi_create_event_wrapper(), efi_disconnect_controller_wrapper(), efi_exit_boot_services_wrapper(), efi_exit_wrapper(), efi_free_pages_wrapper(), efi_free_pool_wrapper(), efi_get_memory_map_wrapper(), efi_get_next_monotonic_count_wrapper(), efi_handle_protocol_wrapper(), efi_install_configuration_table_wrapper(), efi_install_multiple_protocol_interfaces_wrapper(), efi_install_protocol_interface_wrapper(), efi_load_image_wrapper(), efi_locate_device_path_wrapper(), efi_locate_handle_buffer_wrapper(), efi_locate_handle_wrapper(), efi_locate_protocol_wrapper(), efi_open_protocol_information_wrapper(), efi_open_protocol_wrapper(), efi_protocols_per_handle_wrapper(), efi_raise_tpl_wrapper(), efi_register_protocol_notify_wrapper(), efi_reinstall_protocol_interface_wrapper(), efi_restore_tpl_wrapper(), efi_set_timer_wrapper(), efi_set_watchdog_timer_wrapper(), efi_signal_event_wrapper(), efi_stall_wrapper(), efi_start_image_wrapper(), efi_systab, efi_uninstall_multiple_protocol_interfaces_wrapper(), efi_uninstall_protocol_interface_wrapper(), efi_unload_image_wrapper(), efi_wait_for_event_wrapper(), EFI_BOOT_SERVICES::Exit, EFI_BOOT_SERVICES::ExitBootServices, EFI_BOOT_SERVICES::FreePages, EFI_BOOT_SERVICES::FreePool, EFI_BOOT_SERVICES::GetMemoryMap, EFI_BOOT_SERVICES::GetNextMonotonicCount, EFI_BOOT_SERVICES::HandleProtocol, EFI_BOOT_SERVICES::InstallConfigurationTable, EFI_BOOT_SERVICES::InstallMultipleProtocolInterfaces, EFI_BOOT_SERVICES::InstallProtocolInterface, EFI_BOOT_SERVICES::LoadImage, EFI_BOOT_SERVICES::LocateDevicePath, EFI_BOOT_SERVICES::LocateHandle, EFI_BOOT_SERVICES::LocateHandleBuffer, EFI_BOOT_SERVICES::LocateProtocol, memcpy(), EFI_BOOT_SERVICES::OpenProtocol, EFI_BOOT_SERVICES::OpenProtocolInformation, EFI_BOOT_SERVICES::ProtocolsPerHandle, EFI_BOOT_SERVICES::RaiseTPL, EFI_BOOT_SERVICES::RegisterProtocolNotify, EFI_BOOT_SERVICES::ReinstallProtocolInterface, EFI_BOOT_SERVICES::RestoreTPL, EFI_BOOT_SERVICES::SetTimer, EFI_BOOT_SERVICES::SetWatchdogTimer, EFI_BOOT_SERVICES::SignalEvent, EFI_BOOT_SERVICES::Stall, EFI_BOOT_SERVICES::StartImage, EFI_BOOT_SERVICES::UninstallMultipleProtocolInterfaces, EFI_BOOT_SERVICES::UninstallProtocolInterface, EFI_BOOT_SERVICES::UnloadImage, and EFI_BOOT_SERVICES::WaitForEvent.

Referenced by efi_wrap_systab().

efi_wrap_rs()

void efi_wrap_rs

(

EFI_RUNTIME_SERVICES *

wrapper

)

Wrap a runtime services table.

Parameters

wrapper

Runtime services table to wrap

Definition at line 1476 of file efi_wrap.c.

                                                   {
        EFI_RUNTIME_SERVICES *rs = efi_systab->RuntimeServices;

        /* Do nothing unless debugging is enabled */
        if ( ! DBG_LOG )
                return;

        /* Build boot services table wrapper */
        memcpy ( wrapper, rs, sizeof ( *wrapper ) );
        wrapper->GetTime                = efi_get_time_wrapper;
        wrapper->SetTime                = efi_set_time_wrapper;
        wrapper->GetWakeupTime          = efi_get_wakeup_time_wrapper;
        wrapper->SetWakeupTime          = efi_set_wakeup_time_wrapper;
        wrapper->GetVariable            = efi_get_variable_wrapper;
        wrapper->GetNextVariableName    = efi_get_next_variable_name_wrapper;
        wrapper->SetVariable            = efi_set_variable_wrapper;
        wrapper->ResetSystem            = efi_reset_system_wrapper;
}

References DBG_LOG, efi_get_next_variable_name_wrapper(), efi_get_time_wrapper(), efi_get_variable_wrapper(), efi_get_wakeup_time_wrapper(), efi_reset_system_wrapper(), efi_set_time_wrapper(), efi_set_variable_wrapper(), efi_set_wakeup_time_wrapper(), efi_systab, EFI_RUNTIME_SERVICES::GetNextVariableName, EFI_RUNTIME_SERVICES::GetTime, EFI_RUNTIME_SERVICES::GetVariable, EFI_RUNTIME_SERVICES::GetWakeupTime, memcpy(), EFI_RUNTIME_SERVICES::ResetSystem, EFI_SYSTEM_TABLE::RuntimeServices, EFI_RUNTIME_SERVICES::SetTime, EFI_RUNTIME_SERVICES::SetVariable, and EFI_RUNTIME_SERVICES::SetWakeupTime.

Referenced by efi_wrap_systab().

efi_wrap_systab()

void efi_wrap_systab

(

int

global

)

Wrap the public EFI system table.

Parameters

global

Patch global boot services table in-place

Definition at line 1500 of file efi_wrap.c.

                                    {
        static EFI_BOOT_SERVICES local_bs;
        static EFI_RUNTIME_SERVICES local_rs;
        EFI_BOOT_SERVICES *bs;
        EFI_RUNTIME_SERVICES *rs;

        /* Do nothing unless debugging is enabled */
        if ( ! DBG_LOG )
                return;

        /* Preserve original system and boot services tables */
        if ( ! efi_systab_pub ) {
                efi_systab_pub = efi_systab;
                efi_bs_orig = efi_systab_pub->BootServices;
                efi_rs_orig = efi_systab_pub->RuntimeServices;
                memcpy ( &efi_bs_copy, efi_bs_orig, sizeof ( efi_bs_copy ) );
                memcpy ( &efi_rs_copy, efi_rs_orig, sizeof ( efi_rs_copy ) );
        }

        /* Construct and use private system table */
        if ( efi_systab != &efi_systab_priv ) {
                memcpy ( &efi_systab_priv, efi_systab_pub,
                         sizeof ( efi_systab_priv ) );
                efi_systab_priv.BootServices = &efi_bs_copy;
                efi_systab_priv.RuntimeServices = &efi_rs_copy;
                efi_systab = &efi_systab_priv;
        }

        /* Wrap global or local boot services table as applicable */
        bs = ( global ? efi_bs_orig : &local_bs );
        rs = ( global ? efi_rs_orig : &local_rs );
        efi_wrap_bs ( bs );
        efi_wrap_rs ( rs );
        efi_systab_pub->BootServices = bs;
        efi_systab_pub->RuntimeServices = rs;
        DBGC ( colour, "WRAP installed %s wrappers\n",
               ( global ? "global" : "local" ) );
}

References EFI_SYSTEM_TABLE::BootServices, colour, DBG_LOG, DBGC, efi_bs_copy, efi_bs_orig, efi_rs_copy, efi_rs_orig, efi_systab, efi_systab_priv, efi_systab_pub, efi_wrap_bs(), efi_wrap_rs(), memcpy(), and EFI_SYSTEM_TABLE::RuntimeServices.

Referenced by efi_wrap_image().

efi_unwrap()

void efi_unwrap

(

void

)

Remove boot services table wrapper.

Definition at line 1543 of file efi_wrap.c.

                         {

        /* Do nothing unless debugging is enabled */
        if ( ! DBG_LOG )
                return;

        /* Do nothing if wrapping was never enabled */
        if ( ! efi_systab_pub )
                return;

        /* Restore original system and boot services tables */
        memcpy ( efi_bs_orig, &efi_bs_copy, sizeof ( *efi_bs_orig ) );
        efi_systab_pub->BootServices = efi_bs_orig;

        /* Switch back to using public system table */
        efi_systab = efi_systab_pub;
        DBGC ( colour, "WRAP uninstalled wrappers\n" );
}

References EFI_SYSTEM_TABLE::BootServices, colour, DBG_LOG, DBGC, efi_bs_copy, efi_bs_orig, efi_systab, efi_systab_pub, and memcpy().

Referenced by efi_block_exec(), and efi_image_exec().

efi_wrap_image()

void efi_wrap_image

(

EFI_HANDLE

handle

)

Wrap calls made by a newly loaded image.

Parameters

handle

Image handle

Definition at line 1567 of file efi_wrap.c.

                                          {

        /* Do nothing unless debugging is enabled */
        if ( ! DBG_LOG )
                return;

        /* Dump image information */
        efi_dump_image ( handle );

        /* Patch public system table */
        efi_wrap_systab ( 0 );
}

References DBG_LOG, efi_dump_image(), efi_wrap_systab(), and handle.

Referenced by efi_block_exec(), and efi_image_exec().