ntloader/kern/efiboot.c

/*
 * Copyright (C) 2014 Michael Brown <mbrown@fensystems.co.uk>.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */

/**
 * @file
 *
 * EFI boot manager invocation
 *
 */

#include <stdio.h>
#include <string.h>
#include "ntloader.h"
#include "cmdline.h"
#include "vdisk.h"
#include "efi.h"
#include "efiboot.h"
#include "efi/Protocol/GraphicsOutput.h"

#ifdef ENABLE_TEXT_DEBUG

/** Original OpenProtocol() method */
static EFI_OPEN_PROTOCOL orig_open_protocol;

/** Dummy "opening gop blocked once" protocol GUID */
static EFI_GUID efi_gop_blocked_guid =
{
    0xbd1598bf, 0x8e65, 0x47e0,
    { 0x80, 0x01, 0xe4, 0x62, 0x4c, 0xab, 0xa4, 0x7f }
};

/** Dummy "opening gop blocked once" protocol instance */
static uint8_t efi_gop_blocked;

/**
 * Intercept OpenProtocol()
 *
 * @v handle		EFI handle
 * @v protocol		Protocol GUID
 * @v interface		Opened interface
 * @v agent_handle	Agent handle
 * @v controller_handle	Controller handle
 * @v attributes	Attributes
 * @ret efirc		EFI status code
 */
static EFI_STATUS EFIAPI
efi_open_protocol_wrapper (EFI_HANDLE handle, EFI_GUID *protocol,
                           VOID **interface, EFI_HANDLE agent_handle,
                           EFI_HANDLE controller_handle,
                           UINT32 attributes)
{
    EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
    EFI_STATUS efirc;

    /* Open the protocol */
    efirc = orig_open_protocol (handle, protocol, interface,
                                agent_handle, controller_handle,
                                attributes);
    if (efirc != 0)
        return efirc;

    /* Block first attempt by bootmgfw.efi to open each
     * EFI_GRAPHICS_OUTPUT_PROTOCOL.  This forces error messages
     * to be displayed in text mode (thereby avoiding the totally
     * blank error screen if the fonts are missing).  We must
     * allow subsequent attempts to succeed, otherwise the OS will
     * fail to boot.
     */
    if ((memcmp (protocol, &efi_gop_guid, sizeof (*protocol)) == 0) &&
        (bs->InstallMultipleProtocolInterfaces (&handle,
                                                &efi_gop_blocked_guid,
                                                &efi_gop_blocked,
                                                NULL) == 0) &&
        (nt_cmdline->textmode))
    {
        DBG ("Forcing text mode output\n");
        return EFI_INVALID_PARAMETER;
    }

    return 0;
}

#endif

/**
 * Boot from EFI device
 *
 * @v path		Device path
 * @v device		Device handle
 */
void efi_boot (EFI_DEVICE_PATH_PROTOCOL *path,
               EFI_HANDLE device)
{
    EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
    union
    {
        EFI_LOADED_IMAGE_PROTOCOL *image;
        void *intf;
    } loaded;
    void *data;
    EFI_HANDLE handle;
    EFI_STATUS efirc;

    /* Allocate memory */
    data = efi_allocate_pages (
        BYTES_TO_PAGES (nt_cmdline->bootmgr_length), EfiLoaderCode);

    /* Copy image */
    memcpy (data, nt_cmdline->bootmgr, nt_cmdline->bootmgr_length);

    /* Load image */
    efirc = bs->LoadImage (FALSE, efi_image_handle, path, data,
                           nt_cmdline->bootmgr_length, &handle);
    if (efirc != 0)
    {
        die ("Could not load bootmgfw.efi: %#lx\n",
             ((unsigned long) efirc));
    }
    DBG ("Loaded bootmgfw.efi\n");

    /* Get loaded image protocol */
    efirc = bs->OpenProtocol (handle,
                              &efi_loaded_image_protocol_guid,
                              &loaded.intf, efi_image_handle, NULL,
                              EFI_OPEN_PROTOCOL_GET_PROTOCOL);
    if (efirc != 0)
    {
        die ("Could not get loaded image protocol: %#lx\n",
             ((unsigned long) efirc));
    }

    /* Force correct device handle */
    if (loaded.image->DeviceHandle != device)
    {
        DBG ("Forcing correct DeviceHandle (%p->%p)\n",
             loaded.image->DeviceHandle, device);
        loaded.image->DeviceHandle = device;
    }

#ifdef ENABLE_TEXT_DEBUG
    /* Intercept calls to OpenProtocol() */
    orig_open_protocol =
        loaded.image->SystemTable->BootServices->OpenProtocol;
    loaded.image->SystemTable->BootServices->OpenProtocol =
        efi_open_protocol_wrapper;
#endif

    efi_cls ();

    /* Start image */
    if ((efirc = bs->StartImage (handle, NULL, NULL)) != 0)
    {
        die ("Could not start bootmgfw.efi: %#lx\n",
             ((unsigned long) efirc));
    }

    die ("bootmgfw.efi returned\n");
}