efi_driver.h File Reference

EFI driver interface. More...

#include <ipxe/device.h>
#include <ipxe/tables.h>
#include <ipxe/efi/efi.h>
#include <ipxe/efi/Protocol/DevicePath.h>

Go to the source code of this file.

Data Structures
struct	efi_device
	An EFI device. More...
struct	efi_driver
	An EFI driver. More...

Macros
#define	EFI_DRIVERS   __table ( struct efi_driver, "efi_drivers" )
	EFI driver table. More...
#define	__efi_driver(order)   __table_entry ( EFI_DRIVERS, order )
	Declare an EFI driver. More...
#define	EFI_DRIVER_EARLY   01
	Early drivers. More...
#define	EFI_DRIVER_HARDWARE   02
	Hardware drivers. More...
#define	EFI_DRIVER_NII   03
	NII protocol drivers. More...
#define	EFI_DRIVER_SNP   04
	SNP protocol drivers. More...
#define	EFI_DRIVER_MNP   05
	MNP protocol drivers. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static void	efidev_set_drvdata (struct efi_device *efidev, void *priv)
	Set EFI driver-private data. More...
static void *	efidev_get_drvdata (struct efi_device *efidev)
	Get EFI driver-private data. More...
struct efi_device *	efidev_alloc (EFI_HANDLE device)
	Allocate new EFI device. More...
void	efidev_free (struct efi_device *efidev)
	Free EFI device. More...
struct efi_device *	efidev_parent (struct device *dev)
	Get parent EFI device. More...
int	efi_driver_install (void)
	Install EFI driver. More...
void	efi_driver_uninstall (void)
	Uninstall EFI driver. More...
int	efi_driver_exclude (EFI_HANDLE device, EFI_GUID *protocol)
	Try to disconnect an existing EFI driver. More...
int	efi_driver_connect_all (void)
	Connect EFI driver to all possible devices. More...
void	efi_driver_disconnect_all (void)
	Disconnect EFI driver from all possible devices. More...
void	efi_driver_reconnect_all (void)
	Reconnect original EFI drivers to all possible devices. More...

Detailed Description

EFI driver interface.

Definition in file efi_driver.h.

Macro Definition Documentation

EFI_DRIVERS

#define EFI_DRIVERS   __table ( struct efi_driver, "efi_drivers" )

EFI driver table.

Definition at line 67 of file efi_driver.h.

__efi_driver

#define __efi_driver

(

order

)

__table_entry ( EFI_DRIVERS, order )

Declare an EFI driver.

Definition at line 70 of file efi_driver.h.

EFI_DRIVER_EARLY

#define EFI_DRIVER_EARLY   01

Early drivers.

Definition at line 72 of file efi_driver.h.

EFI_DRIVER_HARDWARE

#define EFI_DRIVER_HARDWARE   02

Hardware drivers.

Definition at line 73 of file efi_driver.h.

EFI_DRIVER_NII

#define EFI_DRIVER_NII   03

NII protocol drivers.

Definition at line 74 of file efi_driver.h.

EFI_DRIVER_SNP

#define EFI_DRIVER_SNP   04

SNP protocol drivers.

Definition at line 75 of file efi_driver.h.

EFI_DRIVER_MNP

#define EFI_DRIVER_MNP   05

MNP protocol drivers.

Definition at line 76 of file efi_driver.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

efidev_set_drvdata()

static void efidev_set_drvdata ( struct efi_device *  efidev, void *  priv  )

inlinestatic

Set EFI driver-private data.

Parameters

efidev	EFI device
priv	Private data

Definition at line 84 of file efi_driver.h.

                                                     {
        efidev->priv = priv;
}

References efi_device::priv, and priv.

Referenced by efipci_start(), mnpnet_start(), nii_start(), snpnet_start(), and usbio_start().

efidev_get_drvdata()

static void* efidev_get_drvdata ( struct efi_device *  efidev )

inlinestatic

Get EFI driver-private data.

Parameters

efidev

EFI device

Return values

priv	Private data

Definition at line 95 of file efi_driver.h.

                                                                      {
        return efidev->priv;
}

References efi_device::priv.

Referenced by efipci_stop(), mnpnet_stop(), mnptemp_create(), nii_stop(), snpnet_stop(), and usbio_stop().

efidev_alloc()

struct efi_device* efidev_alloc

(

EFI_HANDLE

device

)

Allocate new EFI device.

Parameters

device

EFI device handle

Return values

efidev

EFI device, or NULL on error

Definition at line 57 of file efi_driver.c.

                                                       {
        struct efi_device *efidev = NULL;
        EFI_DEVICE_PATH_PROTOCOL *path;
        EFI_DEVICE_PATH_PROTOCOL *path_end;
        size_t path_len;
        int rc;

        /* Open device path */
        if ( ( rc = efi_open ( device, &efi_device_path_protocol_guid,
                               &path ) ) != 0 ) {
                DBGC ( device, "EFIDRV %s could not open device path: %s\n",
                       efi_handle_name ( device ), strerror ( rc ) );
                return NULL;
        }
        path_len = ( efi_path_len ( path ) + sizeof ( *path_end ) );

        /* Allocate and initialise structure */
        efidev = zalloc ( sizeof ( *efidev ) + path_len );
        if ( ! efidev )
                return NULL;
        efidev->device = device;
        efidev->dev.desc.bus_type = BUS_TYPE_EFI;
        efidev->path = ( ( ( void * ) efidev ) + sizeof ( *efidev ) );
        memcpy ( efidev->path, path, path_len );
        INIT_LIST_HEAD ( &efidev->dev.children );
        list_add ( &efidev->dev.siblings, &efi_devices );

        return efidev;
}

References device_description::bus_type, BUS_TYPE_EFI, device::children, DBGC, device::desc, efi_device::dev, efi_device::device, device, efi_device_path_protocol_guid, efi_handle_name(), efi_open, efi_path_len(), INIT_LIST_HEAD, list_add, memcpy(), NULL, efi_device::path, rc, device::siblings, strerror(), and zalloc().

Referenced by efi_driver_start(), and mnptemp_create().

efidev_free()

void efidev_free

(

struct efi_device *

efidev

)

Free EFI device.

Parameters

efidev

EFI device

Definition at line 92 of file efi_driver.c.

                                               {

        assert ( list_empty ( &efidev->dev.children ) );
        list_del ( &efidev->dev.siblings );
        free ( efidev );
}

References assert(), device::children, efi_device::dev, free, list_del, list_empty, and device::siblings.

Referenced by efi_driver_start(), efi_driver_stop(), mnptemp_create(), and mnptemp_destroy().

efidev_parent()

struct efi_device* efidev_parent

(

struct device *

dev

)

Get parent EFI device.

Parameters

dev	Generic device

Return values

efidev

Parent EFI device, or NULL

Definition at line 129 of file efi_driver.c.

                                                         {
        struct device *parent;
        struct efi_device *efidev;

        /* Walk upwards until we find a registered EFI device */
        while ( ( parent = dev->parent ) ) {
                list_for_each_entry ( efidev, &efi_devices, dev.siblings ) {
                        if ( parent == &efidev->dev )
                                return efidev;
                }
                dev = parent;
        }

        return NULL;
}

References efi_device::dev, list_for_each_entry, NULL, device::parent, and device::siblings.

Referenced by efi_parent_path(), and efi_snp_probe().

efi_driver_install()

int efi_driver_install

(

void

)

Install EFI driver.

Return values

rc	Return status code

Definition at line 388 of file efi_driver.c.

                                {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        EFI_STATUS efirc;
        int rc;

        /* Calculate driver version number.  We use the build
         * timestamp (in seconds since the Epoch) shifted right by six
         * bits: this gives us an approximately one-minute resolution
         * and a scheme which will last until the year 10680.
         */
        efi_driver_binding.Version = ( build_timestamp >> 6 );

        /* Install protocols on image handle */
        efi_driver_binding.ImageHandle = efi_image_handle;
        efi_driver_binding.DriverBindingHandle = efi_image_handle;
        if ( ( efirc = bs->InstallMultipleProtocolInterfaces (
                        &efi_image_handle,
                        &efi_driver_binding_protocol_guid, &efi_driver_binding,
                        &efi_component_name2_protocol_guid, &efi_wtf,
                        NULL ) ) != 0 ) {
                rc = -EEFI ( efirc );
                DBGC ( &efi_driver_binding, "EFIDRV could not install "
                       "protocols: %s\n", strerror ( rc ) );
                return rc;
        }

        return 0;
}

References EFI_SYSTEM_TABLE::BootServices, build_timestamp, DBGC, _EFI_DRIVER_BINDING_PROTOCOL::DriverBindingHandle, EEFI, efi_component_name2_protocol_guid, efi_driver_binding, efi_driver_binding_protocol_guid, efi_image_handle, efi_systab, efi_wtf, _EFI_DRIVER_BINDING_PROTOCOL::ImageHandle, EFI_BOOT_SERVICES::InstallMultipleProtocolInterfaces, NULL, rc, strerror(), and _EFI_DRIVER_BINDING_PROTOCOL::Version.

Referenced by efi_init().

efi_driver_uninstall()

void efi_driver_uninstall

(

void

)

Uninstall EFI driver.

Definition at line 421 of file efi_driver.c.

                                   {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;

        /* Uninstall protocols */
        bs->UninstallMultipleProtocolInterfaces (
                efi_image_handle,
                &efi_driver_binding_protocol_guid, &efi_driver_binding,
                &efi_component_name2_protocol_guid, &efi_wtf, NULL );
}

References EFI_SYSTEM_TABLE::BootServices, efi_component_name2_protocol_guid, efi_driver_binding, efi_driver_binding_protocol_guid, efi_image_handle, efi_systab, efi_wtf, NULL, and EFI_BOOT_SERVICES::UninstallMultipleProtocolInterfaces.

Referenced by efi_init(), and efi_unload().

efi_driver_exclude()

int efi_driver_exclude	(	EFI_HANDLE	device,
		EFI_GUID *	protocol
	)

Try to disconnect an existing EFI driver.

Parameters

device	EFI device
protocol	Protocol GUID

Return values

rc	Return status code

Definition at line 438 of file efi_driver.c.

                                                                 {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        EFI_OPEN_PROTOCOL_INFORMATION_ENTRY *openers;
        EFI_OPEN_PROTOCOL_INFORMATION_ENTRY *opener;
        EFI_HANDLE driver;
        UINTN count;
        unsigned int i;
        EFI_STATUS efirc;
        int rc;

        /* Retrieve list of openers */
        if ( ( efirc = bs->OpenProtocolInformation ( device, protocol, &openers,
                                                     &count ) ) != 0 ) {
                rc = -EEFI ( efirc );
                DBGC ( device, "EFIDRV %s could not list %s openers: %s\n",
                       efi_handle_name ( device ), efi_guid_ntoa ( protocol ),
                       strerror ( rc ) );
                goto err_list;
        }

        /* Identify BY_DRIVER opener */
        driver = NULL;
        for ( i = 0 ; i < count ; i++ ) {
                opener = &openers[i];
                if ( opener->Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER ) {
                        driver = opener->AgentHandle;
                        break;
                }
        }

        /* Try to disconnect driver */
        DBGC ( device, "EFIDRV %s disconnecting %s drivers\n",
               efi_handle_name ( device ), efi_guid_ntoa ( protocol ) );
        if ( driver ) {
                DBGC ( device, "EFIDRV %s disconnecting %s driver ",
                       efi_handle_name ( device ), efi_guid_ntoa ( protocol ) );
                DBGC ( device, "%s\n", efi_handle_name ( driver ) );
                if ( ( rc = efi_disconnect ( device, driver ) ) != 0 ) {
                        DBGC ( device, "EFIDRV %s could not disconnect ",
                               efi_handle_name ( device ) );
                        DBGC ( device, "%s: %s\n",
                               efi_handle_name ( driver ), strerror ( rc ) );
                        goto err_disconnect;
                }
        }

        /* Success */
        rc = 0;

 err_disconnect:
        bs->FreePool ( openers );
 err_list:
        return rc;
}

References EFI_OPEN_PROTOCOL_INFORMATION_ENTRY::AgentHandle, EFI_OPEN_PROTOCOL_INFORMATION_ENTRY::Attributes, EFI_SYSTEM_TABLE::BootServices, count, DBGC, EEFI, efi_disconnect(), efi_guid_ntoa(), efi_handle_name(), EFI_OPEN_PROTOCOL_BY_DRIVER, efi_systab, EFI_BOOT_SERVICES::FreePool, NULL, EFI_BOOT_SERVICES::OpenProtocolInformation, protocol, rc, and strerror().

Referenced by efipci_exclude(), nii_exclude(), snpnet_exclude(), and usbio_exclude().

efi_driver_connect_all()

int efi_driver_connect_all

(

void

)

Connect EFI driver to all possible devices.

Return values

rc	Return status code

Definition at line 637 of file efi_driver.c.

                                    {

        DBGC ( &efi_driver_binding, "EFIDRV connecting our drivers\n" );
        return efi_driver_handles ( efi_driver_connect );
}

References DBGC, efi_driver_binding, efi_driver_connect(), and efi_driver_handles().

Referenced by efi_probe().

efi_driver_disconnect_all()

void efi_driver_disconnect_all

(

void

)

Disconnect EFI driver from all possible devices.

Return values

rc	Return status code

Definition at line 648 of file efi_driver.c.

                                        {

        DBGC ( &efi_driver_binding, "EFIDRV disconnecting our drivers\n" );
        efi_driver_handles ( efi_driver_disconnect );
}

References DBGC, efi_driver_binding, efi_driver_disconnect(), and efi_driver_handles().

Referenced by efi_remove(), and efi_unload().

efi_driver_reconnect_all()

void efi_driver_reconnect_all

(

void

)

Reconnect original EFI drivers to all possible devices.

Return values

rc	Return status code

Definition at line 659 of file efi_driver.c.

                                       {

        DBGC ( &efi_driver_binding, "EFIDRV reconnecting old drivers\n" );
        efi_driver_handles ( efi_driver_reconnect );
}

References DBGC, efi_driver_binding, efi_driver_handles(), and efi_driver_reconnect().

Referenced by _efi_start(), efi_block_boot(), and efi_image_exec().