snponly.c File Reference

EFI chainloaded-device-only driver. More...

#include <string.h>
#include <errno.h>
#include <ipxe/init.h>
#include <ipxe/efi/efi.h>
#include <ipxe/efi/efi_driver.h>
#include <ipxe/efi/efi_utils.h>
#include <ipxe/efi/mnpnet.h>
#include <ipxe/efi/Protocol/SimpleNetwork.h>
#include <ipxe/efi/Protocol/NetworkInterfaceIdentifier.h>
#include "snpnet.h"
#include "nii.h"

Go to the source code of this file.

Data Structures
struct	chained_protocol
	A chainloaded protocol. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
static void	chained_locate (struct chained_protocol *chained)
	Locate chainloaded protocol. More...
static int	chained_supported (EFI_HANDLE device, struct chained_protocol *chained)
	Check to see if driver supports a device. More...
static int	snponly_supported (EFI_HANDLE device)
	Check to see if driver supports a device. More...
static int	niionly_supported (EFI_HANDLE device)
	Check to see if driver supports a device. More...
static int	mnponly_supported (EFI_HANDLE device)
	Check to see if driver supports a device. More...
struct efi_driver snponly_driver	__efi_driver (EFI_DRIVER_NORMAL)
	EFI SNP chainloading-device-only driver. More...
static void	chained_init (void)
	Initialise EFI chainloaded-device-only driver. More...
struct init_fn chained_init_fn	__init_fn (INIT_LATE)
	EFI chainloaded-device-only initialisation function. More...

Variables
static struct chained_protocol	chained_snp
	Chainloaded SNP protocol. More...
static struct chained_protocol	chained_nii
	Chainloaded NII protocol. More...
static struct chained_protocol	chained_mnp
	Chainloaded MNP protocol. More...

Detailed Description

EFI chainloaded-device-only driver.

Definition in file snponly.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

chained_locate()

static void chained_locate ( struct chained_protocol *  chained )

static

Locate chainloaded protocol.

Parameters

chained

Chainloaded protocol

Definition at line 88 of file snponly.c.

                                                                {
        EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
        EFI_HANDLE device = efi_loaded_image->DeviceHandle;
        EFI_HANDLE handle;
        void *match = NULL;
        void *interface;
        unsigned int skip;
        EFI_STATUS efirc;
        int rc;

        /* Identify target device handle */
        for ( skip = 0 ; ; skip++ ) {

                /* Locate handle supporting this protocol */
                if ( ( rc = efi_locate_device ( device, chained->protocol,
                                                &handle, skip ) ) != 0 ) {
                        if ( skip == 0 ) {
                                DBGC ( device, "CHAINED %s does not support "
                                       "%s: %s\n", efi_handle_name ( device ),
                                       efi_guid_ntoa ( chained->protocol ),
                                       strerror ( rc ) );
                        }
                        break;
                }

                /* Get protocol instance */
                if ( ( efirc = bs->OpenProtocol (
                                        handle, chained->protocol, &interface,
                                        efi_image_handle, handle,
                                        EFI_OPEN_PROTOCOL_GET_PROTOCOL )) != 0){
                        rc = -EEFI ( efirc );
                        DBGC ( device, "CHAINED %s could not open %s on ",
                               efi_handle_name ( device ),
                               efi_guid_ntoa ( chained->protocol ) );
                        DBGC ( device, "%s: %s\n",
                               efi_handle_name ( handle ), strerror ( rc ) );
                        break;
                }
                bs->CloseProtocol ( handle, chained->protocol,
                                    efi_image_handle, handle );

                /* Stop if we reach a non-matching protocol instance */
                if ( match && ( match != interface ) ) {
                        DBGC ( device, "CHAINED %s found non-matching %s on ",
                               efi_handle_name ( device ),
                               efi_guid_ntoa ( chained->protocol ) );
                        DBGC ( device, "%s\n", efi_handle_name ( handle ) );
                        break;
                }

                /* Record this handle */
                chained->device = handle;
                match = interface;
                DBGC ( device, "CHAINED %s found %s on ",
                       efi_handle_name ( device ),
                       efi_guid_ntoa ( chained->protocol ) );
                DBGC ( device, "%s\n", efi_handle_name ( chained->device ) );
        }
}

References EFI_SYSTEM_TABLE::BootServices, EFI_BOOT_SERVICES::CloseProtocol, DBGC, chained_protocol::device, EFI_LOADED_IMAGE_PROTOCOL::DeviceHandle, EEFI, efi_guid_ntoa(), efi_handle_name(), efi_image_handle, efi_loaded_image, efi_locate_device(), EFI_OPEN_PROTOCOL_GET_PROTOCOL, efi_systab, handle, NULL, EFI_BOOT_SERVICES::OpenProtocol, chained_protocol::protocol, rc, and strerror().

Referenced by chained_init().

chained_supported()

static int chained_supported ( EFI_HANDLE  device, struct chained_protocol *  chained  )

static

Check to see if driver supports a device.

Parameters

device	EFI device handle
chained	Chainloaded protocol

Return values

rc	Return status code

Definition at line 155 of file snponly.c.

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

        /* Get protocol */
        if ( ( efirc = bs->OpenProtocol ( device, chained->protocol, &interface,
                                          efi_image_handle, device,
                                          EFI_OPEN_PROTOCOL_GET_PROTOCOL ))!=0){
                rc = -EEFI ( efirc );
                DBGCP ( device, "CHAINED %s is not a %s device\n",
                        efi_handle_name ( device ),
                        efi_guid_ntoa ( chained->protocol ) );
                goto err_open_protocol;
        }

        /* Ignore non-matching handles */
        if ( device != chained->device ) {
                DBGC2 ( device, "CHAINED %s is not the chainloaded %s\n",
                        efi_handle_name ( device ),
                        efi_guid_ntoa ( chained->protocol ) );
                rc = -ENOTTY;
                goto err_no_match;
        }

        /* Success */
        rc = 0;
        DBGC ( device, "CHAINED %s is the chainloaded %s\n",
               efi_handle_name ( device ),
               efi_guid_ntoa ( chained->protocol ) );

 err_no_match:
        bs->CloseProtocol ( device, chained->protocol, efi_image_handle,
                            device );
 err_open_protocol:
        return rc;
}

References EFI_SYSTEM_TABLE::BootServices, EFI_BOOT_SERVICES::CloseProtocol, DBGC, DBGC2, DBGCP, chained_protocol::device, EEFI, efi_guid_ntoa(), efi_handle_name(), efi_image_handle, EFI_OPEN_PROTOCOL_GET_PROTOCOL, efi_systab, ENOTTY, EFI_BOOT_SERVICES::OpenProtocol, chained_protocol::protocol, and rc.

Referenced by mnponly_supported(), niionly_supported(), and snponly_supported().

snponly_supported()

static int snponly_supported ( EFI_HANDLE  device )

static

Check to see if driver supports a device.

Parameters

device

EFI device handle

Return values

rc	Return status code

Definition at line 201 of file snponly.c.

                                                   {

        return chained_supported ( device, &chained_snp );
}

References chained_snp, and chained_supported().

niionly_supported()

static int niionly_supported ( EFI_HANDLE  device )

static

Check to see if driver supports a device.

Parameters

device

EFI device handle

Return values

rc	Return status code

Definition at line 212 of file snponly.c.

                                                   {

        return chained_supported ( device, &chained_nii );
}

References chained_nii, and chained_supported().

mnponly_supported()

static int mnponly_supported ( EFI_HANDLE  device )

static

Check to see if driver supports a device.

Parameters

device

EFI device handle

Return values

rc	Return status code

Definition at line 223 of file snponly.c.

                                                   {

        return chained_supported ( device, &chained_mnp );
}

References chained_mnp, and chained_supported().

__efi_driver()

struct efi_driver snponly_driver __efi_driver

(

EFI_DRIVER_NORMAL

)

EFI SNP chainloading-device-only driver.

EFI MNP chainloading-device-only driver.

EFI NII chainloading-device-only driver.

chained_init()

static void chained_init ( void  )

static

Initialise EFI chainloaded-device-only driver.

Definition at line 256 of file snponly.c.

                                  {

        chained_locate ( &chained_snp );
        chained_locate ( &chained_nii );
        chained_locate ( &chained_mnp );
}

References chained_locate(), chained_mnp, chained_nii, and chained_snp.

__init_fn()

struct init_fn chained_init_fn __init_fn

(

INIT_LATE

)

EFI chainloaded-device-only initialisation function.

Variable Documentation

chained_snp

struct chained_protocol chained_snp

static

Initial value:

= {
        .protocol = &efi_simple_network_protocol_guid,
}

Chainloaded SNP protocol.

Definition at line 69 of file snponly.c.

Referenced by chained_init(), and snponly_supported().

chained_nii

struct chained_protocol chained_nii

static

Initial value:

= {
        .protocol = &efi_nii31_protocol_guid,
}

Chainloaded NII protocol.

Definition at line 74 of file snponly.c.

Referenced by chained_init(), and niionly_supported().

chained_mnp

struct chained_protocol chained_mnp

static

Initial value:

= {
        .protocol = &efi_managed_network_service_binding_protocol_guid,
}

Chainloaded MNP protocol.

Definition at line 79 of file snponly.c.

Referenced by chained_init(), and mnponly_supported().