efi_utils.c File Reference

EFI utilities. More...

#include <stdio.h>
#include <string.h>
#include <errno.h>
#include <ipxe/efi/efi.h>
#include <ipxe/efi/efi_path.h>
#include <ipxe/efi/efi_pci.h>
#include <ipxe/efi/efi_utils.h>

Go to the source code of this file.

Functions
	FILE_LICENCE (GPL2_OR_LATER)
int	efi_locate_device (EFI_HANDLE device, EFI_GUID *protocol, EFI_HANDLE *parent, unsigned int skip)
	Locate parent device supporting a given protocol. More...
int	efi_child_add (EFI_HANDLE parent, EFI_HANDLE child)
	Add EFI device as child of another EFI device. More...
void	efi_child_del (EFI_HANDLE parent, EFI_HANDLE child)
	Remove EFI device as child of another EFI device. More...
static int	efi_device_info_pci (EFI_HANDLE device, const char *prefix, struct device *dev)
	Get underlying PCI device information. More...
void	efi_device_info (EFI_HANDLE device, const char *prefix, struct device *dev)
	Get underlying device information. More...

Detailed Description

EFI utilities.

Definition in file efi_utils.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER

)

efi_locate_device()

int efi_locate_device	(	EFI_HANDLE	device,
		EFI_GUID *	protocol,
		EFI_HANDLE *	parent,
		unsigned int	skip
	)

Locate parent device supporting a given protocol.

Parameters

device	EFI device handle
protocol	Protocol GUID
parent	Parent EFI device handle to fill in
skip	Number of protocol-supporting parent devices to skip

Return values

rc	Return status code

Definition at line 45 of file efi_utils.c.

                                                                {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        EFI_DEVICE_PATH_PROTOCOL *devpath;
        EFI_DEVICE_PATH_PROTOCOL *path;
        EFI_DEVICE_PATH_PROTOCOL *end;
        size_t len;
        EFI_STATUS efirc;
        int rc;

        /* Get device path */
        if ( ( rc = efi_open ( device, &efi_device_path_protocol_guid,
                               &devpath ) ) != 0 ) {
                DBGC ( device, "EFIDEV %s cannot open device path: %s\n",
                       efi_handle_name ( device ), strerror ( rc ) );
                goto err_open_device_path;
        }

        /* Create modifiable copy of device path */
        len = ( efi_path_len ( devpath ) + sizeof ( *end ) );
        path = malloc ( len );
        if ( ! path ) {
                rc = -ENOMEM;
                goto err_alloc_path;
        }
        memcpy ( path, devpath, len );

        /* Locate parent device(s) */
        while ( 1 ) {

                /* Check for presence of specified protocol */
                end = path;
                if ( ( efirc = bs->LocateDevicePath ( protocol, &end,
                                                      parent ) ) != 0 ) {
                        rc = -EEFI ( efirc );
                        DBGC ( device, "EFIDEV %s has no parent supporting "
                               "%s: %s\n", efi_devpath_text ( path ),
                               efi_guid_ntoa ( protocol ), strerror ( rc ) );
                        goto err_locate_protocol;
                }

                /* Stop if we have skipped the requested number of devices */
                if ( ! skip-- )
                        break;

                /* Trim device path */
                efi_path_terminate ( end );
                end = efi_path_prev ( path, end );
                efi_path_terminate ( end );
        }

 err_locate_protocol:
        free ( path );
 err_alloc_path:
 err_open_device_path:
        return rc;
}

References EFI_SYSTEM_TABLE::BootServices, DBGC, EEFI, efi_device_path_protocol_guid, efi_devpath_text(), efi_guid_ntoa(), efi_handle_name(), efi_open, efi_path_len(), efi_path_prev(), efi_path_terminate(), efi_systab, end, ENOMEM, free, len, EFI_BOOT_SERVICES::LocateDevicePath, malloc(), memcpy(), protocol, rc, and strerror().

Referenced by chained_locate(), efi_autoexec_load(), efi_device_info_pci(), nii_pci_open(), and snpnet_supported().

efi_child_add()

int efi_child_add	(	EFI_HANDLE	parent,
		EFI_HANDLE	child
	)

Add EFI device as child of another EFI device.

Parameters

parent	EFI parent device handle
child	EFI child device handle

Return values

rc	Return status code

Definition at line 110 of file efi_utils.c.

                                                          {
        EFI_DEVICE_PATH_PROTOCOL *devpath;
        int rc;

        /* Re-open the device path protocol */
        if ( ( rc = efi_open_by_child ( parent, &efi_device_path_protocol_guid,
                                        child, &devpath ) ) != 0 ) {
                DBGC ( parent, "EFIDEV %s could not add child",
                       efi_handle_name ( parent ) );
                DBGC ( parent, " %s: %s\n",
                       efi_handle_name ( child ), strerror ( rc ) );
                DBGC_EFI_OPENERS ( parent, parent,
                                   &efi_device_path_protocol_guid );
                return rc;
        }

        DBGC2 ( parent, "EFIDEV %s added child", efi_handle_name ( parent ) );
        DBGC2 ( parent, " %s\n", efi_handle_name ( child ) );
        return 0;
}

References DBGC, DBGC2, DBGC_EFI_OPENERS, efi_device_path_protocol_guid, efi_handle_name(), efi_open_by_child, rc, and strerror().

Referenced by efi_snp_hii_install(), and efi_snp_probe().

efi_child_del()

void efi_child_del	(	EFI_HANDLE	parent,
		EFI_HANDLE	child
	)

Remove EFI device as child of another EFI device.

Parameters

parent	EFI parent device handle
child	EFI child device handle

Definition at line 137 of file efi_utils.c.

                                                           {

        efi_close_by_child ( parent, &efi_device_path_protocol_guid, child );
        DBGC2 ( parent, "EFIDEV %s removed child", efi_handle_name ( parent ) );
        DBGC2 ( parent, " %s\n", efi_handle_name ( child ) );
}

References DBGC2, efi_close_by_child(), efi_device_path_protocol_guid, and efi_handle_name().

Referenced by efi_snp_hii_install(), efi_snp_hii_uninstall(), efi_snp_probe(), and efi_snp_remove().

efi_device_info_pci()

static int efi_device_info_pci ( EFI_HANDLE  device, const char *  prefix, struct device *  dev  )

static

Get underlying PCI device information.

Parameters

device	EFI device handle
prefix	Device name prefix
dev	Generic device to fill in

Return values

rc	Return status code

Definition at line 152 of file efi_utils.c.

                                                      {
        EFI_HANDLE pci_device;
        struct efi_pci_device efipci;
        int rc;

        /* Find parent PCI device */
        if ( ( rc = efi_locate_device ( device, &efi_pci_io_protocol_guid,
                                        &pci_device, 0 ) ) != 0 ) {
                DBGC ( device, "EFIDEV %s is not a PCI device: %s\n",
                       efi_handle_name ( device ), strerror ( rc ) );
                return rc;
        }

        /* Get PCI device information */
        if ( ( rc = efipci_info ( pci_device, &efipci ) ) != 0 ) {
                DBGC ( device, "EFIDEV %s could not get PCI information: %s\n",
                       efi_handle_name ( device ), strerror ( rc ) );
                return rc;
        }

        /* Populate device information */
        memcpy ( &dev->desc, &efipci.pci.dev.desc, sizeof ( dev->desc ) );
        snprintf ( dev->name, sizeof ( dev->name ), "%s-%s",
                   prefix, efipci.pci.dev.name );

        return 0;
}

References DBGC, device::desc, pci_device::dev, efi_handle_name(), efi_locate_device(), efi_pci_io_protocol_guid, efipci_info(), memcpy(), device::name, efi_pci_device::pci, prefix, rc, snprintf(), and strerror().

Referenced by efi_device_info().

efi_device_info()

void efi_device_info	(	EFI_HANDLE	device,
		const char *	prefix,
		struct device *	dev
	)

Get underlying device information.

Parameters

device	EFI device handle
prefix	Device name prefix
dev	Generic device to fill in

Definition at line 188 of file efi_utils.c.

                                            {
        int rc;

        /* Try getting underlying PCI device information */
        if ( ( rc = efi_device_info_pci ( device, prefix, dev ) ) == 0 )
                return;

        /* If we cannot get any underlying device information, fall
         * back to providing information about the EFI handle.
         */
        DBGC ( device, "EFIDEV %s could not get underlying device "
               "information\n", efi_handle_name ( device ) );
        dev->desc.bus_type = BUS_TYPE_EFI;
        snprintf ( dev->name, sizeof ( dev->name ), "%s-%p", prefix, device );
}

References device_description::bus_type, BUS_TYPE_EFI, DBGC, device::desc, efi_device_info_pci(), efi_handle_name(), device::name, prefix, rc, and snprintf().

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