efi_snp.h File Reference

iPXE EFI SNP interface More...

#include <ipxe/list.h>
#include <ipxe/netdevice.h>
#include <ipxe/efi/efi.h>
#include <ipxe/efi/Protocol/SimpleNetwork.h>
#include <ipxe/efi/Protocol/NetworkInterfaceIdentifier.h>
#include <ipxe/efi/Protocol/ComponentName2.h>
#include <ipxe/efi/Protocol/DevicePath.h>
#include <ipxe/efi/Protocol/HiiConfigAccess.h>
#include <ipxe/efi/Protocol/HiiDatabase.h>
#include <ipxe/efi/Protocol/LoadFile.h>
#include <ipxe/efi/Protocol/VlanConfig.h>

Go to the source code of this file.

Data Structures
struct	efi_snp_device
	An SNP device. More...

Macros
#define	EFI_SNP_NUM_TX   32
	SNP transmit completion ring size. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER)
	FILE_SECBOOT (PERMITTED)
int	efi_snp_hii_install (struct efi_snp_device *snpdev)
	Install HII protocol and packages for SNP device. More...
int	efi_snp_hii_uninstall (struct efi_snp_device *snpdev)
	Uninstall HII protocol and package for SNP device. More...
struct efi_snp_device *	find_snpdev (EFI_HANDLE handle)
	Find SNP device by EFI device handle. More...
struct efi_snp_device *	last_opened_snpdev (void)
	Get most recently opened SNP device. More...
void	efi_snp_add_claim (int delta)
	Add to SNP claimed/released count. More...
static void	efi_snp_claim (void)
	Claim network devices for use by iPXE. More...
static void	efi_snp_release (void)
	Release network devices for use via SNP. More...

Detailed Description

iPXE EFI SNP interface

Definition in file efi_snp.h.

Macro Definition Documentation

EFI_SNP_NUM_TX

#define EFI_SNP_NUM_TX   32

SNP transmit completion ring size.

Definition at line 26 of file efi_snp.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

efi_snp_hii_install()

int efi_snp_hii_install

(

struct efi_snp_device *

snpdev

)

Install HII protocol and packages for SNP device.

Parameters

snpdev

SNP device

Return values

rc	Return status code

Definition at line 659 of file efi_snp_hii.c.

                                                          {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        VENDOR_DEVICE_PATH *vendor_path;
        EFI_DEVICE_PATH_PROTOCOL *path_end;
        size_t path_prefix_len;
        int leak = 0;
        EFI_STATUS efirc;
        int rc;

        /* Do nothing if HII database protocol is not supported */
        if ( ! efihii ) {
                rc = -ENOTSUP;
                goto err_no_hii;
        }

        /* Initialise HII protocol */
        memcpy ( &snpdev->hii, &efi_snp_device_hii, sizeof ( snpdev->hii ) );

        /* Create HII package list */
        snpdev->package_list = efi_snp_hii_package_list ( snpdev );
        if ( ! snpdev->package_list ) {
                DBGC ( snpdev, "SNPDEV %p could not create HII package list\n",
                       snpdev );
                rc = -ENOMEM;
                goto err_build_package_list;
        }

        /* Allocate the new device path */
        path_prefix_len = efi_path_len ( snpdev->path );
        snpdev->hii_child_path = zalloc ( path_prefix_len +
                                          sizeof ( *vendor_path ) +
                                          sizeof ( *path_end ) );
        if ( ! snpdev->hii_child_path ) {
                DBGC ( snpdev,
                       "SNPDEV %p could not allocate HII child device path\n",
                       snpdev );
                rc = -ENOMEM;
                goto err_alloc_child_path;
        }

        /* Populate the device path */
        memcpy ( snpdev->hii_child_path, snpdev->path, path_prefix_len );
        vendor_path = ( ( ( void * ) snpdev->hii_child_path ) +
                        path_prefix_len );
        vendor_path->Header.Type = HARDWARE_DEVICE_PATH;
        vendor_path->Header.SubType = HW_VENDOR_DP;
        vendor_path->Header.Length[0] = sizeof ( *vendor_path );
        efi_snp_hii_random_guid ( &vendor_path->Guid );
        path_end = ( ( void * ) ( vendor_path + 1 ) );
        efi_path_terminate ( path_end );

        /* Create device path and child handle for HII association */
        if ( ( efirc = bs->InstallMultipleProtocolInterfaces (
                        &snpdev->hii_child_handle,
                        &efi_device_path_protocol_guid, snpdev->hii_child_path,
                        NULL ) ) != 0 ) {
                rc = -EEFI ( efirc );
                DBGC ( snpdev, "SNPDEV %p could not create HII child handle: "
                       "%s\n", snpdev, strerror ( rc ) );
                goto err_hii_child_handle;
        }

        /* Add HII packages */
        if ( ( efirc = efihii->NewPackageList ( efihii, snpdev->package_list,
                                                snpdev->hii_child_handle,
                                                &snpdev->hii_handle ) ) != 0 ) {
                rc = -EEFI ( efirc );
                DBGC ( snpdev, "SNPDEV %p could not add HII packages: %s\n",
                       snpdev, strerror ( rc ) );
                goto err_new_package_list;
        }

        /* Install HII protocol */
        if ( ( efirc = bs->InstallMultipleProtocolInterfaces (
                         &snpdev->hii_child_handle,
                         &efi_hii_config_access_protocol_guid, &snpdev->hii,
                         NULL ) ) != 0 ) {
                rc = -EEFI ( efirc );
                DBGC ( snpdev, "SNPDEV %p could not install HII protocol: %s\n",
                       snpdev, strerror ( rc ) );
                goto err_install_protocol;
        }

        /* Add as child of handle with SNP instance */
        if ( ( rc = efi_child_add ( snpdev->handle,
                                    snpdev->hii_child_handle ) ) != 0 ) {
                DBGC ( snpdev,
                       "SNPDEV %p could not adopt HII child handle: %s\n",
                       snpdev, strerror ( rc ) );
                goto err_efi_child_add;
        }

        return 0;

        efi_child_del ( snpdev->handle, snpdev->hii_child_handle );
 err_efi_child_add:
        if ( ( efirc = bs->UninstallMultipleProtocolInterfaces (
                        snpdev->hii_child_handle,
                        &efi_hii_config_access_protocol_guid, &snpdev->hii,
                        NULL ) ) != 0 ) {
                DBGC ( snpdev, "SNPDEV %p could not uninstall HII protocol: "
                       "%s\n", snpdev, strerror ( -EEFI ( efirc ) ) );
                leak = 1;
        }
        efi_nullify_hii ( &snpdev->hii );
 err_install_protocol:
        if ( ! leak )
                efihii->RemovePackageList ( efihii, snpdev->hii_handle );
 err_new_package_list:
        if ( ( efirc = bs->UninstallMultipleProtocolInterfaces (
                        snpdev->hii_child_handle,
                        &efi_device_path_protocol_guid, snpdev->hii_child_path,
                        NULL ) ) != 0 ) {
                DBGC ( snpdev, "SNPDEV %p could not uninstall HII path: %s\n",
                       snpdev, strerror ( -EEFI ( efirc ) ) );
                leak = 1;
        }
 err_hii_child_handle:
        if ( ! leak ) {
                free ( snpdev->hii_child_path );
                snpdev->hii_child_path = NULL;
        }
 err_alloc_child_path:
        if ( ! leak ) {
                free ( snpdev->package_list );
                snpdev->package_list = NULL;
        }
 err_build_package_list:
 err_no_hii:
        return rc;
}

References EFI_SYSTEM_TABLE::BootServices, DBGC, EEFI, efi_child_add(), efi_child_del(), efi_device_path_protocol_guid, efi_hii_config_access_protocol_guid, efi_nullify_hii(), efi_path_len(), efi_path_terminate(), efi_snp_device_hii, efi_snp_hii_package_list(), efi_snp_hii_random_guid(), efi_systab, efihii, ENOMEM, ENOTSUP, free, VENDOR_DEVICE_PATH::Guid, efi_snp_device::handle, HARDWARE_DEVICE_PATH, VENDOR_DEVICE_PATH::Header, efi_snp_device::hii, efi_snp_device::hii_child_handle, efi_snp_device::hii_child_path, efi_snp_device::hii_handle, HW_VENDOR_DP, EFI_BOOT_SERVICES::InstallMultipleProtocolInterfaces, EFI_DEVICE_PATH_PROTOCOL::Length, memcpy(), _EFI_HII_DATABASE_PROTOCOL::NewPackageList, NULL, efi_snp_device::package_list, efi_snp_device::path, rc, _EFI_HII_DATABASE_PROTOCOL::RemovePackageList, strerror(), EFI_DEVICE_PATH_PROTOCOL::SubType, EFI_DEVICE_PATH_PROTOCOL::Type, EFI_BOOT_SERVICES::UninstallMultipleProtocolInterfaces, and zalloc().

Referenced by efi_snp_probe().

efi_snp_hii_uninstall()

int efi_snp_hii_uninstall

(

struct efi_snp_device *

snpdev

)

Uninstall HII protocol and package for SNP device.

Parameters

snpdev

SNP device

Return values

leak	Uninstallation failed: leak memory

Definition at line 797 of file efi_snp_hii.c.

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

        /* Do nothing if HII database protocol is not supported */
        if ( ! efihii )
                return 0;

        /* Uninstall protocols and remove package list */
        efi_child_del ( snpdev->handle, snpdev->hii_child_handle );
        if ( ( ! efi_shutdown_in_progress ) &&
             ( ( efirc = bs->UninstallMultipleProtocolInterfaces (
                        snpdev->hii_child_handle,
                        &efi_hii_config_access_protocol_guid, &snpdev->hii,
                        NULL ) ) != 0 ) ) {
                DBGC ( snpdev, "SNPDEV %p could not uninstall HII protocol: "
                       "%s\n", snpdev, strerror ( -EEFI ( efirc ) ) );
                leak = 1;
        }
        efi_nullify_hii ( &snpdev->hii );
        if ( ! leak )
                efihii->RemovePackageList ( efihii, snpdev->hii_handle );
        if ( ( ! efi_shutdown_in_progress ) &&
             ( ( efirc = bs->UninstallMultipleProtocolInterfaces (
                        snpdev->hii_child_handle,
                        &efi_device_path_protocol_guid, snpdev->hii_child_path,
                        NULL ) ) != 0 ) ) {
                DBGC ( snpdev, "SNPDEV %p could not uninstall HII path: %s\n",
                       snpdev, strerror ( -EEFI ( efirc ) ) );
                leak = 1;
        }
        if ( ! leak ) {
                free ( snpdev->hii_child_path );
                snpdev->hii_child_path = NULL;
                free ( snpdev->package_list );
                snpdev->package_list = NULL;
        }

        /* Report leakage, if applicable */
        if ( leak && ( ! efi_shutdown_in_progress ) )
                DBGC ( snpdev, "SNPDEV %p HII nullified and leaked\n", snpdev );
        return leak;
}

References EFI_SYSTEM_TABLE::BootServices, DBGC, EEFI, efi_child_del(), efi_device_path_protocol_guid, efi_hii_config_access_protocol_guid, efi_nullify_hii(), efi_shutdown_in_progress, efi_systab, efihii, free, efi_snp_device::handle, efi_snp_device::hii, efi_snp_device::hii_child_handle, efi_snp_device::hii_child_path, efi_snp_device::hii_handle, NULL, efi_snp_device::package_list, _EFI_HII_DATABASE_PROTOCOL::RemovePackageList, strerror(), and EFI_BOOT_SERVICES::UninstallMultipleProtocolInterfaces.

Referenced by efi_snp_probe(), and efi_snp_remove().

find_snpdev()

struct efi_snp_device* find_snpdev

(

EFI_HANDLE

handle

)

Find SNP device by EFI device handle.

Parameters

handle

EFI device handle

Return values

snpdev

SNP device, or NULL

Definition at line 2104 of file efi_snp.c.

                                                          {
        struct efi_snp_device *snpdev;

        list_for_each_entry ( snpdev, &efi_snp_devices, list ) {
                if ( snpdev->handle == handle )
                        return snpdev;
        }
        return NULL;
}

References handle, efi_snp_device::handle, efi_snp_device::list, list_for_each_entry, and NULL.

Referenced by snpnet_supported().

last_opened_snpdev()

struct efi_snp_device* last_opened_snpdev

(

void

)

Get most recently opened SNP device.

Return values

snpdev

Most recently opened SNP device, or NULL

Definition at line 2119 of file efi_snp.c.

                                                    {
        struct net_device *netdev;

        netdev = last_opened_netdev();
        if ( ! netdev )
                return NULL;

        return efi_snp_demux ( netdev );
}

References efi_snp_demux(), last_opened_netdev(), netdev, and NULL.

Referenced by efi_image_exec().

efi_snp_add_claim()

void efi_snp_add_claim

(

int

delta

)

Add to SNP claimed/released count.

Parameters

delta

Claim count change

Definition at line 2134 of file efi_snp.c.

                                     {
        struct efi_snp_device *snpdev;

        /* Raise TPL if we are about to claim devices */
        if ( ! efi_snp_claimed )
                efi_raise_tpl ( &efi_snp_saved_tpl );

        /* Claim SNP devices */
        efi_snp_claimed += delta;
        assert ( efi_snp_claimed >= 0 );

        /* Update SNP mode state for each interface */
        list_for_each_entry ( snpdev, &efi_snp_devices, list )
                efi_snp_set_state ( snpdev );

        /* Restore TPL if we have released devices */
        if ( ! efi_snp_claimed )
                efi_restore_tpl ( &efi_snp_saved_tpl );
}

References assert(), efi_raise_tpl(), efi_restore_tpl(), efi_snp_claimed, efi_snp_saved_tpl, efi_snp_set_state(), efi_snp_device::list, and list_for_each_entry.

Referenced by efi_snp_claim(), and efi_snp_release().

efi_snp_claim()

static void efi_snp_claim ( void  )

inlinestatic

Claim network devices for use by iPXE.

Definition at line 92 of file efi_snp.h.

                                          {
        efi_snp_add_claim ( +1 );
}

References efi_snp_add_claim().

Referenced by _efi_start(), efi_block_boot(), efi_block_io_read(), efi_block_io_reset(), efi_block_io_write(), efi_download_start(), efi_image_exec(), efi_pxe_dhcp(), efi_pxe_mtftp(), efi_pxe_udp_open(), and efi_snp_load_file().

efi_snp_release()

static void efi_snp_release ( void  )

inlinestatic

Release network devices for use via SNP.

Definition at line 100 of file efi_snp.h.

                                            {
        efi_snp_add_claim ( -1 );
}

References efi_snp_add_claim().

Referenced by _efi_start(), efi_block_boot(), efi_block_io_read(), efi_block_io_reset(), efi_block_io_write(), efi_download_close(), efi_download_start(), efi_image_exec(), efi_pxe_dhcp(), efi_pxe_mtftp(), efi_pxe_udp_close(), and efi_snp_load_file().