efi_disklog.c File Reference

EFI disk log console. More...

#include <assert.h>
#include <errno.h>
#include <string.h>
#include <ipxe/console.h>
#include <ipxe/disklog.h>
#include <ipxe/init.h>
#include <ipxe/umalloc.h>
#include <ipxe/efi/efi.h>
#include <ipxe/efi/Protocol/BlockIo.h>
#include <ipxe/efi/Protocol/PartitionInfo.h>
#include <config/console.h>

Go to the source code of this file.

Macros
#define	CONSOLE_DISKLOG   ( CONSOLE_USAGE_ALL & ~CONSOLE_USAGE_LOG )

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static int	efi_disklog_write (void)
	Write current logical block.
static void	efi_disklog_putchar (int character)
	Write character to console.
static int	efi_disklog_open (EFI_HANDLE handle)
	Open EFI disk log partition.
static void	efi_disklog_init (void)
	Initialise EFI disk log console.
struct init_fn efi_disklog_init_fn	__init_fn (INIT_CONSOLE)
	EFI disk log console initialisation function.
static void	efi_disklog_shutdown (int booting __unused)
	Shut down EFI disk log console.
struct startup_fn efi_disklog_startup_fn	__startup_fn (STARTUP_EARLY)
	EFI disk log console shutdown function.
	IPXE_NOTE (DISKLOG)

Variables
static EFI_HANDLE	efi_disklog_handle
	EFI disk log console device handle.
static EFI_BLOCK_IO_PROTOCOL *	efi_disklog_block
	EFI disk log console block I/O protocol.
static UINT32	efi_disklog_media_id
	EFI disk log console media ID.
static struct disklog	efi_disklog
	EFI disk log console.
struct console_driver efi_disklog_console	__console_driver
	EFI disk log console driver.
static struct disklog_operations	efi_disklog_op
	EFI disk log console operations.

Detailed Description

EFI disk log console.

Definition in file efi_disklog.c.

Macro Definition Documentation

CONSOLE_DISKLOG

#define CONSOLE_DISKLOG   ( CONSOLE_USAGE_ALL & ~CONSOLE_USAGE_LOG )

Definition at line 48 of file efi_disklog.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

efi_disklog_write()

int efi_disklog_write ( void )

static

Write current logical block.

Return values

rc	Return status code

Definition at line 70 of file efi_disklog.c.

                                      {
        EFI_BLOCK_IO_PROTOCOL *block = efi_disklog_block;
        struct disklog *disklog = &efi_disklog;
        EFI_STATUS efirc;
        int rc;
 
        /* Write disk block */
        if ( ( efirc = block->WriteBlocks ( block, efi_disklog_media_id,
                                            disklog->lba, disklog->blksize,
                                            disklog->buffer ) ) != 0 ) {
                rc = -EEFI ( efirc );
                DBGC ( disklog, "EFIDISKLOG %s could not write LBA %#llx: "
                       "%s\n", efi_handle_name ( efi_disklog_handle ),
                       ( ( unsigned long long ) disklog->lba ),
                       strerror ( rc ) );
                return rc;
        }
 
        return 0;
}

References disklog::blksize, block, disklog::buffer, DBGC, EEFI, efi_disklog, efi_disklog_block, efi_disklog_handle, efi_disklog_media_id, efi_handle_name(), disklog::lba, rc, and strerror().

efi_disklog_putchar()

void efi_disklog_putchar ( int character )

static

Write character to console.

Parameters

character

Character

Definition at line 101 of file efi_disklog.c.

                                                  {
 
        /* Write character */
        disklog_putchar ( &efi_disklog, character );
}

References disklog_putchar(), and efi_disklog.

efi_disklog_open()

int efi_disklog_open ( EFI_HANDLE handle )

static

Open EFI disk log partition.

Parameters

handle

Block device handle

Return values

rc	Return status code

Definition at line 113 of file efi_disklog.c.

                                                  {
        struct disklog *disklog = &efi_disklog;
        EFI_BLOCK_IO_PROTOCOL *block;
        EFI_BLOCK_IO_MEDIA *media;
        EFI_PARTITION_INFO_PROTOCOL *part;
        void *buffer;
        EFI_STATUS efirc;
        int rc;
 
        /* Record handle */
        efi_disklog_handle = handle;
 
        /* Open block I/O protocol for ephemeral usage */
        if ( ( rc = efi_open ( handle, &efi_block_io_protocol_guid,
                               &block ) ) != 0 ) {
                DBGC ( disklog, "EFIDISKLOG %s could not open: %s\n",
                       efi_handle_name ( handle ), strerror ( rc ) );
                goto err_open;
        }
        media = block->Media;
        efi_disklog_block = block;
        efi_disklog_media_id = media->MediaId;
 
        /* Check this is a partition */
        if ( ! media->LogicalPartition ) {
                DBGC2 ( disklog, "EFIDISKLOG %s is not a partition\n",
                        efi_handle_name ( handle ) );
                rc = -ENOTTY;
                goto err_not_partition;
        }
 
        /* Check partition type (if exposed by the platform) */
        if ( ( rc = efi_open ( handle, &efi_partition_info_protocol_guid,
                               &part ) ) == 0 ) {
                if ( ( part->Type != PARTITION_TYPE_MBR ) ||
                     ( part->Info.Mbr.OSIndicator != DISKLOG_PARTITION_TYPE )){
                        DBGC ( disklog, "EFIDISKLOG %s is not a log "
                               "partition\n", efi_handle_name ( handle ) );
                        rc = -ENOTTY;
                        goto err_not_log;
                }
        } else {
                DBGC2 ( disklog, "EFIDISKLOG %s has no partition info\n",
                        efi_handle_name ( handle ) );
                /* Continue anyway */
        }
 
        /* Allocate buffer */
        buffer = umalloc ( media->BlockSize );
        if ( ! buffer ) {
                rc = -ENOMEM;
                goto err_alloc;
        }
 
        /* Read partition signature */
        if ( ( efirc = block->ReadBlocks ( block, efi_disklog_media_id, 0,
                                           media->BlockSize, buffer ) ) != 0 ){
                rc = -EEFI ( efirc );
                DBGC ( disklog, "EFIDISKLOG %s could not read block 0: %s\n",
                       efi_handle_name ( handle ), strerror ( rc ) );
                goto err_read;
        }
 
        /* Initialise disk log console */
        disklog_init ( disklog, &efi_disklog_op, &efi_disklog_console, buffer,
                       media->BlockSize, 0, media->LastBlock );
 
        /* Open disk log console */
        if ( ( rc = disklog_open ( disklog ) ) != 0 ) {
                DBGC ( disklog, "EFIDISKLOG %s could not initialise log: "
                       "%s\n", efi_handle_name ( handle ), strerror ( rc ) );
                goto err_init;
        }
 
        /* Reopen handle for long-term use */
        if ( ( rc = efi_open_by_driver ( handle, &efi_block_io_protocol_guid,
                                         &block ) ) != 0 ) {
                DBGC ( disklog, "EFIDISKLOG %s could not reopen: %s\n",
                       efi_handle_name ( handle ), strerror ( rc ) );
                goto err_reopen;
        }
        if ( block != efi_disklog_block ) {
                DBGC ( disklog, "EFIDISKLOG %s changed during reopening\n",
                       efi_handle_name ( handle ) );
                rc = -EPIPE;
                goto err_reopen_mismatch;
        }
 
        DBGC ( disklog, "EFIDISKLOG using %s\n", efi_handle_name ( handle ) );
        DBGC2 ( disklog, "EFIDISKLOG has %zd-byte LBA [%#x,%#llx]\n",
                disklog->blksize, 0,
                ( ( unsigned long long ) disklog->max_lba ) );
        return 0;
 
 err_reopen_mismatch:
        efi_close_by_driver ( handle, &efi_block_io_protocol_guid );
 err_reopen:
 err_init:
 err_read:
        ufree ( buffer );
 err_alloc:
 err_not_log:
 err_not_partition:
        efi_disklog_block = NULL;
 err_open:
        efi_disklog_handle = NULL;
        return rc;
}

References disklog::blksize, block, buffer, DBGC, DBGC2, disklog_init(), disklog_open(), DISKLOG_PARTITION_TYPE, EEFI, efi_block_io_protocol_guid, efi_close_by_driver(), efi_disklog, efi_disklog_block, efi_disklog_handle, efi_disklog_media_id, efi_disklog_op, EFI_HANDLE, efi_handle_name(), efi_open, efi_open_by_driver, efi_partition_info_protocol_guid, ENOMEM, ENOTTY, EPIPE, handle, EFI_PARTITION_INFO_PROTOCOL::Info, disklog::max_lba, EFI_PARTITION_INFO_PROTOCOL::Mbr, media, NULL, MBR_PARTITION_RECORD::OSIndicator, PARTITION_TYPE_MBR, rc, strerror(), EFI_PARTITION_INFO_PROTOCOL::Type, ufree(), and umalloc().

Referenced by efi_disklog_init().

efi_disklog_init()

void efi_disklog_init ( void )

static

Initialise EFI disk log console.

Definition at line 226 of file efi_disklog.c.

                                      {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        EFI_GUID *protocol = &efi_block_io_protocol_guid;
        EFI_HANDLE *handles;
        UINTN count;
        unsigned int i;
        EFI_STATUS efirc;
        int rc;
 
        /* Locate all block I/O protocol handles */
        if ( ( efirc = bs->LocateHandleBuffer ( ByProtocol, protocol,
                                                NULL, &count,
                                                &handles ) ) != 0 ) {
                rc = -EEFI ( efirc );
                DBGC ( &efi_disklog, "EFIDISKLOG could not locate block I/O: "
                       "%s\n", strerror ( rc ) );
                goto err_locate;
        }
 
        /* Try each handle in turn */
        for ( i = 0 ; i < count ; i++ ) {
                if ( ( rc = efi_disklog_open ( handles[i] ) ) == 0 )
                        break;
        }
 
        bs->FreePool ( handles );
 err_locate:
        return;
}

References ByProtocol, count, DBGC, EEFI, efi_block_io_protocol_guid, efi_disklog, efi_disklog_open(), EFI_HANDLE, efi_systab, EFI_BOOT_SERVICES::FreePool, EFI_BOOT_SERVICES::LocateHandleBuffer, NULL, protocol, rc, and strerror().

Referenced by __init_fn().

__init_fn()

struct init_fn efi_disklog_init_fn __init_fn

(

INIT_CONSOLE

)

EFI disk log console initialisation function.

References __init_fn, efi_disklog_init(), and INIT_CONSOLE.

efi_disklog_shutdown()

void efi_disklog_shutdown ( int booting __unused )

static

Shut down EFI disk log console.

Parameters

booting

System is shutting down for OS boot

Definition at line 269 of file efi_disklog.c.

                                                          {
        struct disklog *disklog = &efi_disklog;
 
        /* Do nothing if we have no EFI disk log console */
        if ( ! efi_disklog_handle )
                return;
 
        /* Close EFI disk log console */
        DBGC ( disklog, "EFIDISKLOG %s closed\n",
               efi_handle_name ( efi_disklog_handle ) );
        efi_close_by_driver ( efi_disklog_handle,
                              &efi_block_io_protocol_guid );
        ufree ( disklog->buffer );
        disklog->buffer = NULL;
        efi_disklog_handle = NULL;
        efi_disklog_block = NULL;
}

References __unused, disklog::buffer, DBGC, efi_block_io_protocol_guid, efi_close_by_driver(), efi_disklog, efi_disklog_block, efi_disklog_handle, efi_handle_name(), NULL, and ufree().

Referenced by __startup_fn().

__startup_fn()

struct startup_fn efi_disklog_startup_fn __startup_fn

(

STARTUP_EARLY

)

EFI disk log console shutdown function.

References __startup_fn, efi_disklog_shutdown(), and STARTUP_EARLY.

IPXE_NOTE()

IPXE_NOTE

(

DISKLOG

)

Variable Documentation

efi_disklog_handle

EFI_HANDLE efi_disklog_handle

static

EFI disk log console device handle.

Definition at line 52 of file efi_disklog.c.

Referenced by efi_disklog_open(), efi_disklog_shutdown(), and efi_disklog_write().

efi_disklog_block

EFI_BLOCK_IO_PROTOCOL* efi_disklog_block

static

EFI disk log console block I/O protocol.

Definition at line 55 of file efi_disklog.c.

Referenced by efi_disklog_open(), efi_disklog_shutdown(), and efi_disklog_write().

efi_disklog_media_id

UINT32 efi_disklog_media_id

static

EFI disk log console media ID.

Definition at line 58 of file efi_disklog.c.

Referenced by efi_disklog_open(), and efi_disklog_write().

efi_disklog

struct disklog efi_disklog

static

EFI disk log console.

Definition at line 61 of file efi_disklog.c.

Referenced by efi_disklog_init(), efi_disklog_open(), efi_disklog_putchar(), efi_disklog_shutdown(), efi_disklog_write(), and PROVIDE_REQUIRING_SYMBOL().

__console_driver

struct console_driver efi_disklog_console __console_driver

Initial value:

                    = {
        .putchar = efi_disklog_putchar,
        .disabled = CONSOLE_DISABLED,
        .usage = CONSOLE_DISKLOG,
}

EFI disk log console driver.

Definition at line 63 of file efi_disklog.c.

efi_disklog_op

struct disklog_operations efi_disklog_op

static

Initial value:

                               = {
        .write = efi_disklog_write,
}

EFI disk log console operations.

Definition at line 92 of file efi_disklog.c.

                                                {
        .write = efi_disklog_write,
};

Referenced by efi_disklog_open().