iPXE
Functions | Variables
efi_init.c File Reference
#include <string.h>
#include <errno.h>
#include <ipxe/init.h>
#include <ipxe/efi/efi.h>
#include <ipxe/efi/efi_driver.h>
#include <ipxe/efi/Protocol/LoadedImage.h>

Go to the source code of this file.

Functions

 FILE_LICENCE (GPL2_OR_LATER)
EFI_SYSTEM_TABLE_C2 (PLATFORM, _systab)
 System table passed to entry point.
static EFI_STATUS EFIAPI efi_unload (EFI_HANDLE image_handle __unused)
 Shut down EFI environment.
static EFIAPI void efi_shutdown_hook (EFI_EVENT event __unused, void *context __unused)
 Shut down in preparation for booting an OS.
static void * efi_find_table (EFI_GUID *guid)
 Look up EFI configuration table.
EFI_STATUS efi_init (EFI_HANDLE image_handle, EFI_SYSTEM_TABLE *systab)
 Initialise EFI environment.

Variables

EFI_HANDLE efi_image_handle
 Image handle passed to entry point.
EFI_LOADED_IMAGE_PROTOCOLefi_loaded_image
 Loaded image protocol for this image.
int efi_shutdown_in_progress
 EFI shutdown is in progress.
static EFI_EVENT efi_shutdown_event
 Event used to signal shutdown.

Function Documentation

FILE_LICENCE ( GPL2_OR_LATER  )
EFI_SYSTEM_TABLE* _C2 ( PLATFORM  ,
_systab   
)

System table passed to entry point.

We construct the symbol name efi_systab via the PLATFORM macro. This ensures that the symbol is defined only in EFI builds, and so prevents EFI code from being incorrectly linked in to a non-EFI build.

static EFI_STATUS EFIAPI efi_unload ( EFI_HANDLE image_handle  __unused) [static]

Shut down EFI environment.

Parameters:
image_handleImage handle

Definition at line 221 of file efi_init.c.

References EFI_SYSTEM_TABLE::BootServices, EFI_BOOT_SERVICES::CloseEvent, DBGC, efi_driver_disconnect_all(), efi_driver_uninstall(), efi_shutdown_event, efi_systab, and shutdown_exit().

Referenced by efi_init().

                                                                         {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        EFI_SYSTEM_TABLE *systab = efi_systab;

        DBGC ( systab, "EFI image unloading\n" );

        /* Shut down */
        shutdown_exit();

        /* Disconnect any remaining devices */
        efi_driver_disconnect_all();

        /* Uninstall driver binding protocol */
        efi_driver_uninstall();

        /* Uninstall exit boot services event */
        bs->CloseEvent ( efi_shutdown_event );

        DBGC ( systab, "EFI image unloaded\n" );

        return 0;
}
static EFIAPI void efi_shutdown_hook ( EFI_EVENT event  __unused,
void *context  __unused 
) [static]

Shut down in preparation for booting an OS.

This hook gets called at ExitBootServices time in order to make sure that everything is properly shut down before the OS takes over.

Definition at line 60 of file efi_init.c.

References efi_shutdown_in_progress, and shutdown_boot().

Referenced by efi_init().

                                                                {

        /* Mark shutdown as being in progress, to indicate that large
         * parts of the system (e.g. timers) are no longer functional.
         */
        efi_shutdown_in_progress = 1;

        /* Shut down iPXE */
        shutdown_boot();
}
static void* efi_find_table ( EFI_GUID guid) [static]

Look up EFI configuration table.

Parameters:
guidConfiguration table GUID
Return values:
tableConfiguration table, or NULL

Definition at line 78 of file efi_init.c.

References EFI_SYSTEM_TABLE::ConfigurationTable, efi_systab, memcmp(), NULL, EFI_SYSTEM_TABLE::NumberOfTableEntries, EFI_CONFIGURATION_TABLE::VendorGuid, and EFI_CONFIGURATION_TABLE::VendorTable.

Referenced by efi_init().

                                                {
        unsigned int i;

        for ( i = 0 ; i < efi_systab->NumberOfTableEntries ; i++ ) {
                if ( memcmp ( &efi_systab->ConfigurationTable[i].VendorGuid,
                              guid, sizeof ( *guid ) ) == 0 )
                        return efi_systab->ConfigurationTable[i].VendorTable;
        }

        return NULL;
}
EFI_STATUS efi_init ( EFI_HANDLE  image_handle,
EFI_SYSTEM_TABLE systab 
)

Initialise EFI environment.

Parameters:
image_handleImage handle
systabSystem table
Return values:
efircEFI return status code

Definition at line 97 of file efi_init.c.

References EFI_SYSTEM_TABLE::BootServices, EFI_BOOT_SERVICES::CloseEvent, EFI_SYSTEM_TABLE::ConOut, EFI_BOOT_SERVICES::CreateEvent, DBGC, EEFI, EFI_CONFIG_TABLES, efi_driver_install(), efi_driver_uninstall(), efi_find_table(), efi_guid_ntoa(), efi_loaded_image_protocol_guid, EFI_NOT_AVAILABLE_YET, EFI_OPEN_PROTOCOL_GET_PROTOCOL, EFI_PROTOCOLS, efi_shutdown_event, efi_shutdown_hook(), efi_systab, efi_unload(), EFIRC, EVT_SIGNAL_EXIT_BOOT_SERVICES, for_each_table_entry, efi_protocol::guid, efi_config_table::guid, EFI_LOADED_IMAGE_PROTOCOL::ImageBase, EFI_BOOT_SERVICES::LocateProtocol, NULL, EFI_BOOT_SERVICES::OpenProtocol, efi_protocol::protocol, rc, efi_protocol::required, efi_config_table::required, EFI_SYSTEM_TABLE::RuntimeServices, strerror(), efi_config_table::table, TPL_CALLBACK, and EFI_LOADED_IMAGE_PROTOCOL::Unload.

Referenced by _efi_start(), and _efidrv_start().

                                                 {
        EFI_BOOT_SERVICES *bs;
        struct efi_protocol *prot;
        struct efi_config_table *tab;
        void *loaded_image;
        EFI_STATUS efirc;
        int rc;

        /* Store image handle and system table pointer for future use */
        efi_image_handle = image_handle;
        efi_systab = systab;

        /* Sanity checks */
        if ( ! systab ) {
                efirc = EFI_NOT_AVAILABLE_YET;
                goto err_sanity;
        }
        if ( ! systab->ConOut ) {
                efirc = EFI_NOT_AVAILABLE_YET;
                goto err_sanity;
        }
        if ( ! systab->BootServices ) {
                DBGC ( systab, "EFI provided no BootServices entry point\n" );
                efirc = EFI_NOT_AVAILABLE_YET;
                goto err_sanity;
        }
        if ( ! systab->RuntimeServices ) {
                DBGC ( systab, "EFI provided no RuntimeServices entry "
                       "point\n" );
                efirc = EFI_NOT_AVAILABLE_YET;
                goto err_sanity;
        }
        DBGC ( systab, "EFI handle %p systab %p\n", image_handle, systab );
        bs = systab->BootServices;

        /* Look up used protocols */
        for_each_table_entry ( prot, EFI_PROTOCOLS ) {
                if ( ( efirc = bs->LocateProtocol ( &prot->guid, NULL,
                                                    prot->protocol ) ) == 0 ) {
                        DBGC ( systab, "EFI protocol %s is at %p\n",
                               efi_guid_ntoa ( &prot->guid ),
                               *(prot->protocol) );
                } else {
                        DBGC ( systab, "EFI does not provide protocol %s\n",
                               efi_guid_ntoa ( &prot->guid ) );
                        /* Fail if protocol is required */
                        if ( prot->required )
                                goto err_missing_protocol;
                }
        }

        /* Look up used configuration tables */
        for_each_table_entry ( tab, EFI_CONFIG_TABLES ) {
                if ( ( *(tab->table) = efi_find_table ( &tab->guid ) ) ) {
                        DBGC ( systab, "EFI configuration table %s is at %p\n",
                               efi_guid_ntoa ( &tab->guid ), *(tab->table) );
                } else {
                        DBGC ( systab, "EFI does not provide configuration "
                               "table %s\n", efi_guid_ntoa ( &tab->guid ) );
                        if ( tab->required ) {
                                efirc = EFI_NOT_AVAILABLE_YET;
                                goto err_missing_table;
                        }
                }
        }

        /* Get loaded image protocol */
        if ( ( efirc = bs->OpenProtocol ( image_handle,
                                &efi_loaded_image_protocol_guid,
                                &loaded_image, image_handle, NULL,
                                EFI_OPEN_PROTOCOL_GET_PROTOCOL ) ) != 0 ) {
                rc = -EEFI ( efirc );
                DBGC ( systab, "EFI could not get loaded image protocol: %s",
                       strerror ( rc ) );
                goto err_no_loaded_image;
        }
        efi_loaded_image = loaded_image;
        DBGC ( systab, "EFI image base address %p\n",
               efi_loaded_image->ImageBase );

        /* EFI is perfectly capable of gracefully shutting down any
         * loaded devices if it decides to fall back to a legacy boot.
         * For no particularly comprehensible reason, it doesn't
         * bother doing so when ExitBootServices() is called.
         */
        if ( ( efirc = bs->CreateEvent ( EVT_SIGNAL_EXIT_BOOT_SERVICES,
                                         TPL_CALLBACK, efi_shutdown_hook,
                                         NULL, &efi_shutdown_event ) ) != 0 ) {
                rc = -EEFI ( efirc );
                DBGC ( systab, "EFI could not create ExitBootServices event: "
                       "%s\n", strerror ( rc ) );
                goto err_create_event;
        }

        /* Install driver binding protocol */
        if ( ( rc = efi_driver_install() ) != 0 ) {
                DBGC ( systab, "EFI could not install driver: %s\n",
                       strerror ( rc ) );
                efirc = EFIRC ( rc );
                goto err_driver_install;
        }

        /* Install image unload method */
        efi_loaded_image->Unload = efi_unload;

        return 0;

        efi_driver_uninstall();
 err_driver_install:
        bs->CloseEvent ( efi_shutdown_event );
 err_create_event:
 err_no_loaded_image:
 err_missing_table:
 err_missing_protocol:
 err_sanity:
        return efirc;
}

Variable Documentation

Loaded image protocol for this image.

Definition at line 33 of file efi_init.c.

Referenced by _efi_start(), chained_locate(), efi_local_open_path(), efi_local_open_volume(), and efi_set_autoboot().

EFI shutdown is in progress.

Definition at line 45 of file efi_init.c.

Referenced by efi_currticks(), and efi_shutdown_hook().

Event used to signal shutdown.

Definition at line 48 of file efi_init.c.

Referenced by efi_init(), and efi_unload().