efi_pxe.h File Reference

EFI PXE base code protocol. More...

#include <ipxe/efi/efi.h>
#include <ipxe/netdevice.h>

Go to the source code of this file.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
int	efi_pxe_install (EFI_HANDLE handle, struct net_device *netdev)
	Install PXE base code protocol.
void	efi_pxe_uninstall (EFI_HANDLE handle)
	Uninstall PXE base code protocol.

Detailed Description

EFI PXE base code protocol.

Definition in file efi_pxe.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

References EFI_HANDLE, handle, and netdev.

efi_pxe_install()

int efi_pxe_install ( EFI_HANDLE handle, struct net_device * netdev )

extern

Install PXE base code protocol.

Parameters

handle	EFI handle
netdev	Underlying network device

Return values

rc	Return status code

Definition at line 1573 of file efi_pxe.c.

                                                                     {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        struct tcpip_net_protocol *ipv6 = tcpip_net_protocol ( AF_INET6 );
        struct efi_pxe *pxe;
        struct in_addr ip;
        BOOLEAN use_ipv6;
        int leak = 0;
        EFI_STATUS efirc;
        int rc;
 
        /* Allocate and initialise structure */
        pxe = zalloc ( sizeof ( *pxe ) );
        if ( ! pxe ) {
                rc = -ENOMEM;
                goto err_alloc;
        }
        ref_init ( &pxe->refcnt, efi_pxe_free );
        pxe->netdev = netdev_get ( netdev );
        pxe->name = netdev->name;
        pxe->handle = handle;
        memcpy ( &pxe->base, &efi_pxe_base_code_protocol, sizeof ( pxe->base ));
        pxe->base.Mode = &pxe->mode;
        memcpy ( &pxe->apple, &efi_apple_net_boot_protocol,
                 sizeof ( pxe->apple ) );
        intf_init ( &pxe->tftp, &efi_pxe_tftp_desc, &pxe->refcnt );
        intf_init ( &pxe->udp, &efi_pxe_udp_desc, &pxe->refcnt );
        INIT_LIST_HEAD ( &pxe->queue );
        process_init_stopped ( &pxe->process, &efi_pxe_process_desc,
                               &pxe->refcnt );
 
        /* Crude heuristic: assume that we prefer to use IPv4 if we
         * have an IPv4 address for the network device, otherwise
         * prefer IPv6 (if available).
         */
        fetch_ipv4_setting ( netdev_settings ( netdev ), &ip_setting, &ip );
        use_ipv6 = ( ip.s_addr ? FALSE : ( ipv6 != NULL ) );
 
        /* Start base code */
        efi_pxe_start ( &pxe->base, use_ipv6 );
 
        /* Install PXE base code protocol */
        if ( ( efirc = bs->InstallMultipleProtocolInterfaces (
                        &handle,
                        &efi_pxe_base_code_protocol_guid, &pxe->base,
                        &efi_apple_net_boot_protocol_guid, &pxe->apple,
                        NULL ) ) != 0 ) {
                rc = -EEFI ( efirc );
                DBGC ( pxe, "PXE %s could not install base code protocol: %s\n",
                       pxe->name, strerror ( rc ) );
                goto err_install_protocol;
        }
 
        /* Transfer reference to list and return */
        list_add_tail ( &pxe->list, &efi_pxes );
        DBGC ( pxe, "PXE %s installed for %s\n",
               pxe->name, efi_handle_name ( handle ) );
        return 0;
 
        if ( ( efirc = bs->UninstallMultipleProtocolInterfaces (
                        handle,
                        &efi_pxe_base_code_protocol_guid, &pxe->base,
                        &efi_apple_net_boot_protocol_guid, &pxe->apple,
                        NULL ) ) != 0 ) {
                DBGC ( pxe, "PXE %s could not uninstall: %s\n",
                       pxe->name, strerror ( -EEFI ( efirc ) ) );
                leak = 1;
        }
        efi_nullify_pxe ( &pxe->base );
        efi_nullify_apple ( &pxe->apple );
 err_install_protocol:
        if ( ! leak )
                ref_put ( &pxe->refcnt );
 err_alloc:
        if ( leak )
                DBGC ( pxe, "PXE %s nullified and leaked\n", pxe->name );
        return rc;
}

References AF_INET6, efi_pxe::apple, efi_pxe::base, DBGC, EEFI, efi_apple_net_boot_protocol, efi_apple_net_boot_protocol_guid, EFI_HANDLE, efi_handle_name(), efi_nullify_apple(), efi_nullify_pxe(), efi_pxe_base_code_protocol, efi_pxe_base_code_protocol_guid, efi_pxe_free(), efi_pxe_process_desc, efi_pxe_start(), efi_pxe_tftp_desc, efi_pxe_udp_desc, efi_systab, ENOMEM, FALSE, fetch_ipv4_setting(), efi_pxe::handle, handle, INIT_LIST_HEAD, EFI_BOOT_SERVICES::InstallMultipleProtocolInterfaces, intf_init(), ip, ip_setting, efi_pxe::list, list_add_tail, memcpy(), _EFI_PXE_BASE_CODE_PROTOCOL::Mode, efi_pxe::mode, efi_pxe::name, efi_pxe::netdev, netdev, netdev_get(), netdev_settings(), NULL, efi_pxe::process, process_init_stopped(), efi_pxe::queue, rc, ref_init, ref_put, efi_pxe::refcnt, strerror(), tcpip_net_protocol(), efi_pxe::tftp, efi_pxe::udp, EFI_BOOT_SERVICES::UninstallMultipleProtocolInterfaces, and zalloc().

Referenced by efi_image_exec().

efi_pxe_uninstall()

void efi_pxe_uninstall ( EFI_HANDLE handle )

extern

Uninstall PXE base code protocol.

Parameters

handle

EFI handle

Definition at line 1656 of file efi_pxe.c.

                                             {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        struct efi_pxe *pxe;
        int leak = efi_shutdown_in_progress;
        EFI_STATUS efirc;
 
        /* Locate PXE base code */
        pxe = efi_pxe_find ( handle );
        if ( ! pxe ) {
                DBG ( "PXE could not find base code for %s\n",
                      efi_handle_name ( handle ) );
                return;
        }
 
        /* Stop base code */
        efi_pxe_stop ( &pxe->base );
 
        /* Uninstall PXE base code protocol */
        if ( ( ! efi_shutdown_in_progress ) &&
             ( ( efirc = bs->UninstallMultipleProtocolInterfaces (
                        handle,
                        &efi_pxe_base_code_protocol_guid, &pxe->base,
                        &efi_apple_net_boot_protocol_guid, &pxe->apple,
                        NULL ) ) != 0 ) ) {
                DBGC ( pxe, "PXE %s could not uninstall: %s\n",
                       pxe->name, strerror ( -EEFI ( efirc ) ) );
                leak = 1;
        }
        efi_nullify_pxe ( &pxe->base );
        efi_nullify_apple ( &pxe->apple );
 
        /* Remove from list and drop list's reference */
        list_del ( &pxe->list );
        if ( ! leak )
                ref_put ( &pxe->refcnt );
 
        /* Report leakage, if applicable */
        if ( leak && ( ! efi_shutdown_in_progress ) )
                DBGC ( pxe, "PXE %s nullified and leaked\n", pxe->name );
}

References efi_pxe::apple, efi_pxe::base, DBG, DBGC, EEFI, efi_apple_net_boot_protocol_guid, EFI_HANDLE, efi_handle_name(), efi_nullify_apple(), efi_nullify_pxe(), efi_pxe_base_code_protocol_guid, efi_pxe_find(), efi_pxe_stop(), efi_shutdown_in_progress, efi_systab, handle, efi_pxe::list, list_del, efi_pxe::name, NULL, ref_put, efi_pxe::refcnt, strerror(), and EFI_BOOT_SERVICES::UninstallMultipleProtocolInterfaces.

Referenced by efi_image_exec().