snpnet.c File Reference

SNP NIC driver. More...

#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <errno.h>
#include <ipxe/iobuf.h>
#include <ipxe/netdevice.h>
#include <ipxe/ethernet.h>
#include <ipxe/if_ether.h>
#include <ipxe/vsprintf.h>
#include <ipxe/timer.h>
#include <ipxe/efi/efi.h>
#include <ipxe/efi/Protocol/SimpleNetwork.h>
#include <ipxe/efi/efi_driver.h>
#include <ipxe/efi/efi_utils.h>
#include <ipxe/efi/efi_snp.h>
#include "snpnet.h"

Go to the source code of this file.

Data Structures
struct	snp_nic
	An SNP NIC. More...
struct	snp_insomniac_patch
	An SNP interface patch to inhibit shutdown for insomniac devices. More...

Macros
#define	SNP_RX_QUOTA   4
	Maximum number of received packets per poll. More...
#define	SNP_INITIALIZE_RETRY_MAX   10
	Maximum initialisation retry count. More...
#define	SNP_INITIALIZE_RETRY_DELAY_MS   10
	Delay between each initialisation retry. More...
#define	SNP_RX_PAD   8
	Additional padding for receive buffers. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER)
static const char *	snpnet_mac_text (EFI_MAC_ADDRESS *mac, size_t len)
	Format SNP MAC address (for debugging) More...
static void	snpnet_dump_mode (struct net_device *netdev)
	Dump SNP mode information (for debugging) More...
static void	snpnet_check_link (struct net_device *netdev)
	Check link state. More...
static int	snpnet_transmit (struct net_device *netdev, struct io_buffer *iobuf)
	Transmit packet. More...
static void	snpnet_poll_tx (struct net_device *netdev)
	Poll for completed packets. More...
static void	snpnet_poll_rx (struct net_device *netdev)
	Poll for received packets. More...
static void	snpnet_poll (struct net_device *netdev)
	Poll for completed packets. More...
static int	snpnet_rx_filters (struct net_device *netdev)
	Set receive filters. More...
static int	snpnet_open (struct net_device *netdev)
	Open network device. More...
static void	snpnet_close (struct net_device *netdev)
	Close network device. More...
int	snpnet_supported (EFI_HANDLE device, EFI_GUID *protocol, int inhibit_wifi)
	Check to see if driver supports a device. More...
static int	snpnet_is_insomniac (EFI_HANDLE device)
	Check if device must be insomniac. More...
static EFI_STATUS EFIAPI	snpnet_do_nothing (EFI_SIMPLE_NETWORK_PROTOCOL *snp __unused)
	Ignore shutdown attempt. More...
static int	snpnet_insomniac_patch (EFI_HANDLE device, struct snp_insomniac_patch *patch)
	Patch SNP protocol interface to prevent shutdown. More...
static int	snpnet_insomniac_restore (EFI_HANDLE device, struct snp_insomniac_patch *patch)
	Restore patched SNP protocol interface. More...
int	snpnet_exclude (EFI_HANDLE device)
	Exclude existing drivers. More...
int	snpnet_start (struct efi_device *efidev)
	Attach driver to device. More...
void	snpnet_stop (struct efi_device *efidev)
	Detach driver from device. More...

Variables
static struct net_device_operations	snpnet_operations
	SNP network device operations. More...

Detailed Description

SNP NIC driver.

Definition in file snpnet.c.

Macro Definition Documentation

SNP_RX_QUOTA

#define SNP_RX_QUOTA   4

Maximum number of received packets per poll.

Definition at line 68 of file snpnet.c.

SNP_INITIALIZE_RETRY_MAX

#define SNP_INITIALIZE_RETRY_MAX   10

Maximum initialisation retry count.

Definition at line 71 of file snpnet.c.

SNP_INITIALIZE_RETRY_DELAY_MS

#define SNP_INITIALIZE_RETRY_DELAY_MS   10

Delay between each initialisation retry.

Definition at line 74 of file snpnet.c.

SNP_RX_PAD

#define SNP_RX_PAD   8

Additional padding for receive buffers.

Some SNP implementations seem to require additional space in the allocated receive buffers, otherwise full-length packets will be silently dropped.

The EDK2 MnpDxe driver happens to allocate an additional 8 bytes of padding (4 for a VLAN tag, 4 for the Ethernet frame checksum). Match this behaviour since drivers are very likely to have been tested against MnpDxe.

Definition at line 87 of file snpnet.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER

)

snpnet_mac_text()

static const char* snpnet_mac_text ( EFI_MAC_ADDRESS *  mac, size_t  len  )

static

Format SNP MAC address (for debugging)

Parameters

mac	MAC address
len	Length of MAC address

Return values

text	MAC address as text

Definition at line 104 of file snpnet.c.

                                                                         {
        static char buf[ sizeof ( *mac ) * 3 /* "xx:" or "xx\0" */ ];
        size_t used = 0;
        unsigned int i;

        for ( i = 0 ; i < len ; i++ ) {
                used += ssnprintf ( &buf[used], ( sizeof ( buf ) - used ),
                                    "%s%02x", ( used ? ":" : "" ),
                                    mac->Addr[i] );
        }
        return buf;
}

References len, mac, and ssnprintf().

Referenced by snpnet_dump_mode().

snpnet_dump_mode()

static void snpnet_dump_mode ( struct net_device *  netdev )

static

Dump SNP mode information (for debugging)

Parameters

netdev

Network device

Definition at line 122 of file snpnet.c.

                                                           {
        struct snp_nic *snp = netdev->priv;
        EFI_SIMPLE_NETWORK_MODE *mode = snp->snp->Mode;
        size_t mac_len = mode->HwAddressSize;
        unsigned int i;

        /* Do nothing unless debugging is enabled */
        if ( ! DBG_EXTRA )
                return;

        DBGC2 ( snp, "SNP %s st %d type %d hdr %d pkt %d rxflt %#x/%#x%s "
                "nvram %d acc %d mcast %d/%d\n", netdev->name, mode->State,
                mode->IfType, mode->MediaHeaderSize, mode->MaxPacketSize,
                mode->ReceiveFilterSetting, mode->ReceiveFilterMask,
                ( mode->MultipleTxSupported ? " multitx" : "" ),
                mode->NvRamSize, mode->NvRamAccessSize,
                mode->MCastFilterCount, mode->MaxMCastFilterCount );
        DBGC2 ( snp, "SNP %s hw %s", netdev->name,
                snpnet_mac_text ( &mode->PermanentAddress, mac_len ) );
        DBGC2 ( snp, " addr %s%s",
                snpnet_mac_text ( &mode->CurrentAddress, mac_len ),
                ( mode->MacAddressChangeable ? "" : "(f)" ) );
        DBGC2 ( snp, " bcast %s\n",
                snpnet_mac_text ( &mode->BroadcastAddress, mac_len ) );
        for ( i = 0 ; i < mode->MCastFilterCount ; i++ ) {
                DBGC2 ( snp, "SNP %s mcast %s\n", netdev->name,
                        snpnet_mac_text ( &mode->MCastFilter[i], mac_len ) );
        }
        DBGC2 ( snp, "SNP %s media %s\n", netdev->name,
                ( mode->MediaPresentSupported ?
                  ( mode->MediaPresent ? "present" : "not present" ) :
                  "presence not supported" ) );
}

References DBG_EXTRA, DBGC2, mode, _EFI_SIMPLE_NETWORK_PROTOCOL::Mode, net_device::name, netdev, net_device::priv, snp_nic::snp, and snpnet_mac_text().

Referenced by snpnet_open().

snpnet_check_link()

static void snpnet_check_link ( struct net_device *  netdev )

static

Check link state.

Parameters

netdev

Network device

Definition at line 161 of file snpnet.c.

                                                            {
        struct snp_nic *snp = netdev->priv;
        EFI_SIMPLE_NETWORK_MODE *mode = snp->snp->Mode;

        /* Do nothing unless media presence detection is supported */
        if ( ! mode->MediaPresentSupported )
                return;

        /* Report any link status change */
        if ( mode->MediaPresent && ( ! netdev_link_ok ( netdev ) ) ) {
                netdev_link_up ( netdev );
        } else if ( ( ! mode->MediaPresent ) && netdev_link_ok ( netdev ) ) {
                netdev_link_down ( netdev );
        }
}

References mode, _EFI_SIMPLE_NETWORK_PROTOCOL::Mode, netdev, netdev_link_down(), netdev_link_ok(), netdev_link_up(), net_device::priv, and snp_nic::snp.

Referenced by snpnet_poll(), and snpnet_start().

snpnet_transmit()

static int snpnet_transmit ( struct net_device *  netdev, struct io_buffer *  iobuf  )

static

Transmit packet.

Parameters

netdev	Network device
iobuf	I/O buffer

Return values

rc	Return status code

Definition at line 184 of file snpnet.c.

                                                       {
        struct snp_nic *snp = netdev->priv;
        EFI_STATUS efirc;
        int rc;

        /* Do nothing if shutdown is in progress */
        if ( efi_shutdown_in_progress )
                return -ECANCELED;

        /* Defer the packet if there is already a transmission in progress */
        if ( snp->txbuf ) {
                netdev_tx_defer ( netdev, iobuf );
                return 0;
        }

        /* Pad to minimum Ethernet length, to work around underlying
         * drivers that do not correctly handle frame padding
         * themselves.
         */
        iob_pad ( iobuf, ETH_ZLEN );

        /* Transmit packet */
        if ( ( efirc = snp->snp->Transmit ( snp->snp, 0, iob_len ( iobuf ),
                                            iobuf->data, NULL, NULL,
                                            NULL ) ) != 0 ) {
                rc = -EEFI ( efirc );
                DBGC ( snp, "SNP %s could not transmit: %s\n",
                       netdev->name, strerror ( rc ) );
                return rc;
        }
        snp->txbuf = iobuf;

        return 0;
}

References io_buffer::data, DBGC, ECANCELED, EEFI, efi_shutdown_in_progress, ETH_ZLEN, iob_len(), iob_pad(), net_device::name, netdev, netdev_tx_defer(), NULL, net_device::priv, rc, snp_nic::snp, strerror(), and _EFI_SIMPLE_NETWORK_PROTOCOL::Transmit.

snpnet_poll_tx()

static void snpnet_poll_tx ( struct net_device *  netdev )

static

Poll for completed packets.

Parameters

netdev

Network device

Definition at line 225 of file snpnet.c.

                                                         {
        struct snp_nic *snp = netdev->priv;
        struct io_buffer *iobuf;
        UINT32 irq;
        VOID *txbuf;
        EFI_STATUS efirc;
        int rc;

        /* Get status */
        txbuf = NULL;
        if ( ( efirc = snp->snp->GetStatus ( snp->snp, &irq, &txbuf ) ) != 0 ) {
                rc = -EEFI ( efirc );
                DBGC ( snp, "SNP %s could not get status: %s\n",
                       netdev->name, strerror ( rc ) );
                netdev_rx_err ( netdev, NULL, rc );
                return;
        }

        /* Do nothing unless we have a completion */
        if ( ! txbuf )
                return;

        /* Sanity check */
        if ( ! snp->txbuf ) {
                DBGC ( snp, "SNP %s reported spurious TX completion\n",
                       netdev->name );
                netdev_tx_err ( netdev, NULL, -EPIPE );
                return;
        }

        /* Complete transmission */
        iobuf = snp->txbuf;
        snp->txbuf = NULL;
        netdev_tx_complete ( netdev, iobuf );
}

References DBGC, EEFI, EPIPE, _EFI_SIMPLE_NETWORK_PROTOCOL::GetStatus, net_device::name, netdev, netdev_rx_err(), netdev_tx_complete(), netdev_tx_err(), NULL, net_device::priv, rc, snp_nic::snp, strerror(), snp_nic::txbuf, and VOID.

Referenced by snpnet_poll().

snpnet_poll_rx()

static void snpnet_poll_rx ( struct net_device *  netdev )

static

Poll for received packets.

Parameters

netdev

Network device

Definition at line 266 of file snpnet.c.

                                                         {
        struct snp_nic *snp = netdev->priv;
        UINTN len;
        unsigned int quota;
        EFI_STATUS efirc;
        int rc;

        /* Retrieve up to SNP_RX_QUOTA packets */
        for ( quota = SNP_RX_QUOTA ; quota ; quota-- ) {

                /* Allocate buffer, if required */
                if ( ! snp->rxbuf ) {
                        snp->rxbuf = alloc_iob ( snp->mtu + SNP_RX_PAD );
                        if ( ! snp->rxbuf ) {
                                /* Leave for next poll */
                                break;
                        }
                }

                /* Receive packet */
                len = iob_tailroom ( snp->rxbuf );
                if ( ( efirc = snp->snp->Receive ( snp->snp, NULL, &len,
                                                   snp->rxbuf->data, NULL,
                                                   NULL, NULL ) ) != 0 ) {

                        /* EFI_NOT_READY is just the usual "no packet"
                         * status indication; ignore it.
                         */
                        if ( efirc == EFI_NOT_READY )
                                break;

                        /* Anything else is an error */
                        rc = -EEFI ( efirc );
                        DBGC ( snp, "SNP %s could not receive: %s\n",
                               netdev->name, strerror ( rc ) );
                        netdev_rx_err ( netdev, NULL, rc );
                        break;
                }

                /* Hand off to network stack */
                iob_put ( snp->rxbuf, len );
                netdev_rx ( netdev, snp->rxbuf );
                snp->rxbuf = NULL;
        }
}

References alloc_iob(), DBGC, EEFI, EFI_NOT_READY, iob_put, iob_tailroom(), len, net_device::name, netdev, netdev_rx(), netdev_rx_err(), NULL, net_device::priv, rc, _EFI_SIMPLE_NETWORK_PROTOCOL::Receive, snp_nic::snp, SNP_RX_PAD, SNP_RX_QUOTA, and strerror().

Referenced by snpnet_poll().

snpnet_poll()

static void snpnet_poll ( struct net_device *  netdev )

static

Poll for completed packets.

Parameters

netdev

Network device

Definition at line 317 of file snpnet.c.

                                                      {

        /* Do nothing if shutdown is in progress */
        if ( efi_shutdown_in_progress )
                return;

        /* Process any TX completions */
        snpnet_poll_tx ( netdev );

        /* Process any RX completions */
        snpnet_poll_rx ( netdev );

        /* Check for link state changes */
        snpnet_check_link ( netdev );
}

References efi_shutdown_in_progress, netdev, snpnet_check_link(), snpnet_poll_rx(), and snpnet_poll_tx().

snpnet_rx_filters()

static int snpnet_rx_filters ( struct net_device *  netdev )

static

Set receive filters.

Parameters

netdev

Network device

Return values

rc	Return status code

Definition at line 339 of file snpnet.c.

                                                           {
        struct snp_nic *snp = netdev->priv;
        UINT32 filters[] = {
                snp->snp->Mode->ReceiveFilterMask,
                ( EFI_SIMPLE_NETWORK_RECEIVE_UNICAST |
                  EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST |
                  EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST ),
                ( EFI_SIMPLE_NETWORK_RECEIVE_UNICAST |
                  EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST |
                  EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST ),
                ( EFI_SIMPLE_NETWORK_RECEIVE_UNICAST |
                  EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST ),
                ( EFI_SIMPLE_NETWORK_RECEIVE_UNICAST ),
        };
        unsigned int i;
        EFI_STATUS efirc;
        int rc;

        /* Try possible receive filters in turn */
        for ( i = 0; i < ( sizeof ( filters ) / sizeof ( filters[0] ) ); i++ ) {
                efirc = snp->snp->ReceiveFilters ( snp->snp, filters[i],
                                EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST, TRUE,
                                0, NULL );
                if ( efirc == 0 )
                        return 0;
                rc = -EEFI ( efirc );
                DBGC ( snp, "SNP %s could not set receive filters %#02x (have "
                       "%#02x): %s\n", netdev->name, filters[i],
                       snp->snp->Mode->ReceiveFilterSetting, strerror ( rc ) );
        }

        return rc;
}

References DBGC, EEFI, EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST, EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST, EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST, EFI_SIMPLE_NETWORK_RECEIVE_UNICAST, _EFI_SIMPLE_NETWORK_PROTOCOL::Mode, net_device::name, netdev, NULL, net_device::priv, rc, EFI_SIMPLE_NETWORK_MODE::ReceiveFilterMask, _EFI_SIMPLE_NETWORK_PROTOCOL::ReceiveFilters, EFI_SIMPLE_NETWORK_MODE::ReceiveFilterSetting, snp_nic::snp, strerror(), and TRUE.

Referenced by snpnet_open().

snpnet_open()

static int snpnet_open ( struct net_device *  netdev )

static

Open network device.

Parameters

netdev

Network device

Return values

rc	Return status code

Definition at line 379 of file snpnet.c.

                                                     {
        struct snp_nic *snp = netdev->priv;
        EFI_MAC_ADDRESS *mac = ( ( void * ) netdev->ll_addr );
        EFI_SIMPLE_NETWORK_MODE *mode = snp->snp->Mode;
        EFI_STATUS efirc;
        unsigned int retry;
        int rc;

        /* Try setting MAC address (before initialising) */
        if ( ( efirc = snp->snp->StationAddress ( snp->snp, FALSE, mac ) ) !=0){
                rc = -EEFI ( efirc );
                DBGC ( snp, "SNP %s could not set station address before "
                       "initialising: %s\n", netdev->name, strerror ( rc ) );
                /* Ignore error */
        }

        /* Initialise NIC, retrying multiple times if link stays down */
        for ( retry = 0 ; ; ) {

                /* Initialise NIC, if not already initialised */
                if ( ( mode->State != EfiSimpleNetworkInitialized ) &&
                     ( ( efirc = snp->snp->Initialize ( snp->snp,
                                                        0, 0 ) ) != 0 ) ) {
                        rc = -EEFI ( efirc );
                        snpnet_dump_mode ( netdev );
                        DBGC ( snp, "SNP %s could not initialise: %s\n",
                               netdev->name, strerror ( rc ) );
                        return rc;
                }

                /* Stop if we have link up (or no link detection capability) */
                if ( ( ! mode->MediaPresentSupported ) || mode->MediaPresent )
                        break;

                /* Stop if we have exceeded our retry count.  This is
                 * not a failure; it is plausible that we genuinely do
                 * not have link up.
                 */
                if ( ++retry >= SNP_INITIALIZE_RETRY_MAX )
                        break;
                DBGC ( snp, "SNP %s retrying initialisation (retry %d)\n",
                       netdev->name, retry );

                /* Delay to allow time for link to establish */
                mdelay ( SNP_INITIALIZE_RETRY_DELAY_MS );

                /* Shut down and retry (unless device is insomniac);
                 * this is sometimes necessary in order to persuade
                 * the underlying SNP driver to actually update the
                 * link state.
                 */
                if ( ( ! netdev_insomniac ( netdev ) ) &&
                     ( ( efirc = snp->snp->Shutdown ( snp->snp ) ) != 0 ) ) {
                        rc = -EEFI ( efirc );
                        snpnet_dump_mode ( netdev );
                        DBGC ( snp, "SNP %s could not shut down: %s\n",
                               netdev->name, strerror ( rc ) );
                        return rc;
                }
        }

        /* Try setting MAC address (after initialising) */
        if ( ( efirc = snp->snp->StationAddress ( snp->snp, FALSE, mac ) ) !=0){
                rc = -EEFI ( efirc );
                DBGC ( snp, "SNP %s could not set station address after "
                       "initialising: %s\n", netdev->name, strerror ( rc ) );
                /* Ignore error */
        }

        /* Set receive filters */
        if ( ( rc = snpnet_rx_filters ( netdev ) ) != 0 ) {
                /* Ignore error */
        }

        /* Dump mode information (for debugging) */
        snpnet_dump_mode ( netdev );

        return 0;
}

References DBGC, EEFI, EfiSimpleNetworkInitialized, FALSE, _EFI_SIMPLE_NETWORK_PROTOCOL::Initialize, net_device::ll_addr, mac, mdelay(), mode, _EFI_SIMPLE_NETWORK_PROTOCOL::Mode, net_device::name, netdev, netdev_insomniac(), net_device::priv, rc, _EFI_SIMPLE_NETWORK_PROTOCOL::Shutdown, snp_nic::snp, SNP_INITIALIZE_RETRY_DELAY_MS, SNP_INITIALIZE_RETRY_MAX, snpnet_dump_mode(), snpnet_rx_filters(), _EFI_SIMPLE_NETWORK_PROTOCOL::StationAddress, and strerror().

snpnet_close()

static void snpnet_close ( struct net_device *  netdev )

static

Close network device.

Parameters

netdev

Network device

Definition at line 464 of file snpnet.c.

                                                       {
        struct snp_nic *snp = netdev->priv;
        EFI_STATUS efirc;
        int rc;

        /* Shut down NIC (unless whole system shutdown is in progress,
         * or device is insomniac).
         */
        if ( ( ! efi_shutdown_in_progress ) &&
             ( ! netdev_insomniac ( netdev ) ) &&
             ( ( efirc = snp->snp->Shutdown ( snp->snp ) ) != 0 ) ) {
                rc = -EEFI ( efirc );
                DBGC ( snp, "SNP %s could not shut down: %s\n",
                       netdev->name, strerror ( rc ) );
                /* Nothing we can do about this */
        }

        /* Discard transmit buffer, if applicable */
        if ( snp->txbuf ) {
                netdev_tx_complete_err ( netdev, snp->txbuf, -ECANCELED );
                snp->txbuf = NULL;
        }

        /* Discard receive buffer, if applicable */
        if ( snp->rxbuf ) {
                free_iob ( snp->rxbuf );
                snp->rxbuf = NULL;
        }
}

References DBGC, ECANCELED, EEFI, efi_shutdown_in_progress, free_iob(), net_device::name, netdev, netdev_insomniac(), netdev_tx_complete_err(), NULL, net_device::priv, rc, _EFI_SIMPLE_NETWORK_PROTOCOL::Shutdown, snp_nic::snp, and strerror().

snpnet_supported()

int snpnet_supported	(	EFI_HANDLE	device,
		EFI_GUID *	protocol,
		int	inhibit_wifi
	)

Check to see if driver supports a device.

Parameters

device	EFI device handle
protocol	Protocol GUID
inhibit_wifi	Inhibit wireless devices

Return values

rc	Return status code

Definition at line 510 of file snpnet.c.

                                          {
        EFI_HANDLE parent;
        int rc;

        /* Check that this is not a device we are providing ourselves */
        if ( find_snpdev ( device ) != NULL ) {
                DBGCP ( device, "HANDLE %s is provided by this binary\n",
                        efi_handle_name ( device ) );
                return -ENOTTY;
        }

        /* Test for presence of protocol */
        if ( ( rc = efi_test ( device, protocol ) ) != 0 ) {
                DBGCP ( device, "HANDLE %s is not a %s device\n",
                        efi_handle_name ( device ),
                        efi_guid_ntoa ( protocol ) );
                return rc;
        }

        /* Check that there are no instances of this protocol further
         * up this device path.
         */
        if ( ( rc = efi_locate_device ( device, protocol,
                                        &parent, 1 ) ) == 0 ) {
                DBGC2 ( device, "HANDLE %s has %s-supporting parent ",
                        efi_handle_name ( device ),
                        efi_guid_ntoa ( protocol ) );
                DBGC2 ( device, "%s\n", efi_handle_name ( parent ) );
                return -ENOTTY;
        }
        DBGC ( device, "HANDLE %s is a %s device\n",
               efi_handle_name ( device ), efi_guid_ntoa ( protocol ) );

        /* Check for wireless devices, if applicable */
        if ( inhibit_wifi &&
             ( ( efi_test ( device, &efi_wifi2_protocol_guid ) ) == 0 ) ) {
                DBGC ( device, "HANDLE %s is wireless: assuming vendor %s "
                       "driver is too unreliable to use\n",
                       efi_handle_name ( device ),
                       efi_guid_ntoa ( protocol ) );
                return -ENOTTY;
        }

        return 0;
}

References DBGC, DBGC2, DBGCP, efi_guid_ntoa(), efi_handle_name(), efi_locate_device(), efi_test, efi_wifi2_protocol_guid, ENOTTY, find_snpdev(), NULL, protocol, and rc.

Referenced by mnp_supported(), nii_supported(), and snp_supported().

snpnet_is_insomniac()

static int snpnet_is_insomniac ( EFI_HANDLE  device )

static

Check if device must be insomniac.

Parameters

device	EFI device handle
is_insomniac	Device must be insomniac

Definition at line 563 of file snpnet.c.

                                                     {
        int rc;

        /* Check for wireless devices
         *
         * The UEFI model for wireless network configuration is
         * somewhat underdefined.  At the time of writing, the EDK2
         * "UEFI WiFi Connection Manager" driver provides only one way
         * to configure wireless network credentials, which is to
         * enter them interactively via an HII form.  Credentials are
         * not stored (or exposed via any protocol interface), and so
         * any temporary disconnection from the wireless network will
         * inevitably leave the interface in an unusable state that
         * cannot be recovered without user intervention.
         *
         * Experimentation shows that at least some wireless network
         * drivers will disconnect from the wireless network when the
         * SNP Shutdown() method is called, or if the device is not
         * polled sufficiently frequently to maintain its association
         * to the network.  We therefore inhibit calls to Shutdown()
         * and Stop() for any such SNP protocol interfaces, and mark
         * our network device as insomniac so that it will be polled
         * even when closed.
         */
        if ( ( rc = efi_test ( device, &efi_wifi2_protocol_guid ) ) == 0 ) {
                DBGC ( device, "SNP %s is wireless: assuming insomniac\n",
                       efi_handle_name ( device ) );
                return 1;
        }

        return 0;
}

References DBGC, efi_handle_name(), efi_test, efi_wifi2_protocol_guid, and rc.

Referenced by snpnet_exclude(), and snpnet_start().

snpnet_do_nothing()

static EFI_STATUS EFIAPI snpnet_do_nothing ( EFI_SIMPLE_NETWORK_PROTOCOL *snp  __unused )

static

Ignore shutdown attempt.

Parameters

snp	SNP interface

Return values

efirc

EFI status code

Definition at line 603 of file snpnet.c.

                                                                {

        return 0;
}

Referenced by snpnet_insomniac_patch(), and snpnet_insomniac_restore().

snpnet_insomniac_patch()

static int snpnet_insomniac_patch ( EFI_HANDLE  device, struct snp_insomniac_patch *  patch  )

static

Patch SNP protocol interface to prevent shutdown.

Parameters

device	EFI device handle
patch	Interface patch

Return values

rc	Return status code

Definition at line 615 of file snpnet.c.

                                                                        {
        EFI_SIMPLE_NETWORK_PROTOCOL *interface;
        int rc;

        /* Open interface for ephemeral use */
        if ( ( rc = efi_open ( device, &efi_simple_network_protocol_guid,
                               &interface ) ) != 0 ) {
                DBGC ( device, "SNP %s cannot open SNP protocol for patching: "
                       "%s\n", efi_handle_name ( device ), strerror ( rc ) );
                return rc;
        }

        /* Record original Shutdown() and Stop() methods */
        patch->shutdown = interface->Shutdown;
        patch->stop = interface->Stop;

        /* Inhibit other UEFI drivers' calls to Shutdown() and Stop()
         *
         * This is necessary since disconnecting the MnpDxe driver
         * will attempt to shut down the SNP device, which would leave
         * us with an unusable device.
         */
        interface->Shutdown = snpnet_do_nothing;
        interface->Stop = snpnet_do_nothing;
        DBGC ( device, "SNP %s patched to inhibit shutdown\n",
               efi_handle_name ( device ) );

        return 0;
}

References DBGC, efi_handle_name(), efi_open, efi_simple_network_protocol_guid, rc, snp_insomniac_patch::shutdown, snpnet_do_nothing(), snp_insomniac_patch::stop, and strerror().

Referenced by snpnet_exclude().

snpnet_insomniac_restore()

static int snpnet_insomniac_restore ( EFI_HANDLE  device, struct snp_insomniac_patch *  patch  )

static

Restore patched SNP protocol interface.

Parameters

device	EFI device handle
patch	Interface patch to fill in

Return values

rc	Return status code

Definition at line 653 of file snpnet.c.

                                                                          {
        EFI_SIMPLE_NETWORK_PROTOCOL *interface;
        int rc;

        /* Avoid returning uninitialised data on error */
        memset ( patch, 0, sizeof ( *patch ) );

        /* Open interface for ephemeral use */
        if ( ( rc = efi_open ( device, &efi_simple_network_protocol_guid,
                               &interface ) ) != 0 ) {
                DBGC ( device, "SNP %s cannot open patched SNP protocol: %s\n",
                       efi_handle_name ( device ), strerror ( rc ) );
                return rc;
        }

        /* Restore original Shutdown() and Stop() methods, if possible */
        if ( interface->Shutdown == snpnet_do_nothing )
                interface->Shutdown = patch->shutdown;
        if ( interface->Stop == snpnet_do_nothing )
                interface->Stop = patch->stop;

        /* Check that original methods were restored (by us or others) */
        if ( ( interface->Shutdown != patch->shutdown ) ||
             ( interface->Stop != patch->stop ) ) {
                DBGC ( device, "SNP %s could not restore patched SNP "
                       "protocol\n", efi_handle_name ( device ) );
                return -EBUSY;
        }

        return 0;
}

References DBGC, EBUSY, efi_handle_name(), efi_open, efi_simple_network_protocol_guid, memset(), rc, snp_insomniac_patch::shutdown, snpnet_do_nothing(), snp_insomniac_patch::stop, and strerror().

Referenced by snpnet_exclude().

snpnet_exclude()

int snpnet_exclude

(

EFI_HANDLE

device

)

Exclude existing drivers.

Parameters

device

EFI device handle

Return values

rc	Return status code

Definition at line 692 of file snpnet.c.

                                         {
        EFI_GUID *protocol = &efi_simple_network_protocol_guid;
        struct snp_insomniac_patch patch;
        int insomniac;
        int rc;

        /* Check if this is a device that must not ever be shut down */
        insomniac = snpnet_is_insomniac ( device );

        /* Inhibit calls to Shutdown() and Stop(), if applicable */
        if ( insomniac &&
             ( ( rc = snpnet_insomniac_patch ( device, &patch ) ) != 0 ) ) {
                goto err_patch;
        }

        /* Exclude existing SNP drivers */
        if ( ( rc = efi_driver_exclude ( device, protocol ) ) != 0 ) {
                DBGC ( device, "SNP %s could not exclude drivers: %s\n",
                       efi_handle_name ( device ), strerror ( rc ) );
                goto err_exclude;
        }

 err_exclude:
        if ( insomniac )
                snpnet_insomniac_restore ( device, &patch );
 err_patch:
        return rc;
}

References DBGC, efi_driver_exclude(), efi_handle_name(), efi_simple_network_protocol_guid, protocol, rc, snpnet_insomniac_patch(), snpnet_insomniac_restore(), snpnet_is_insomniac(), and strerror().

snpnet_start()

int snpnet_start

(

struct efi_device *

efidev

)

Attach driver to device.

Parameters

efidev

EFI device

Return values

rc	Return status code

Definition at line 727 of file snpnet.c.

                                               {
        EFI_HANDLE device = efidev->device;
        EFI_SIMPLE_NETWORK_PROTOCOL *interface;
        EFI_SIMPLE_NETWORK_MODE *mode;
        struct net_device *netdev;
        struct snp_nic *snp;
        EFI_STATUS efirc;
        int rc;

        /* Open SNP protocol */
        if ( ( rc = efi_open_by_driver ( device,
                                         &efi_simple_network_protocol_guid,
                                         &interface ) ) != 0 ) {
                DBGC ( device, "SNP %s cannot open SNP protocol: %s\n",
                       efi_handle_name ( device ), strerror ( rc ) );
                DBGC_EFI_OPENERS ( device, device,
                                   &efi_simple_network_protocol_guid );
                goto err_open_protocol;
        }

        /* Allocate and initialise structure */
        netdev = alloc_etherdev ( sizeof ( *snp ) );
        if ( ! netdev ) {
                rc = -ENOMEM;
                goto err_alloc;
        }
        netdev_init ( netdev, &snpnet_operations );
        snp = netdev->priv;
        snp->efidev = efidev;
        snp->snp = interface;
        mode = snp->snp->Mode;
        efidev_set_drvdata ( efidev, netdev );

        /* Populate underlying device information */
        efi_device_info ( device, "SNP", &snp->dev );
        snp->dev.driver_name = "SNP";
        snp->dev.parent = &efidev->dev;
        list_add ( &snp->dev.siblings, &efidev->dev.children );
        INIT_LIST_HEAD ( &snp->dev.children );
        netdev->dev = &snp->dev;

        /* Check if device is insomniac */
        if ( snpnet_is_insomniac ( device ) )
                netdev->state |= NETDEV_INSOMNIAC;

        /* Bring to the correct state for a closed interface */
        if ( ( mode->State == EfiSimpleNetworkStopped ) &&
             ( ( efirc = snp->snp->Start ( snp->snp ) ) != 0 ) ) {
                rc = -EEFI ( efirc );
                DBGC ( device, "SNP %s could not start: %s\n",
                       efi_handle_name ( device ), strerror ( rc ) );
                goto err_start;
        }
        if ( ( mode->State == EfiSimpleNetworkInitialized ) &&
             ( ! netdev_insomniac ( netdev ) ) &&
             ( ( efirc = snp->snp->Shutdown ( snp->snp ) ) != 0 ) ) {
                rc = -EEFI ( efirc );
                DBGC ( device, "SNP %s could not shut down: %s\n",
                       efi_handle_name ( device ), strerror ( rc ) );
                goto err_shutdown;
        }

        /* Populate network device parameters */
        if ( mode->HwAddressSize != netdev->ll_protocol->hw_addr_len ) {
                DBGC ( device, "SNP %s has invalid hardware address length "
                       "%d\n", efi_handle_name ( device ), mode->HwAddressSize);
                rc = -ENOTSUP;
                goto err_hw_addr_len;
        }
        memcpy ( netdev->hw_addr, &mode->PermanentAddress,
                 netdev->ll_protocol->hw_addr_len );
        if ( mode->HwAddressSize != netdev->ll_protocol->ll_addr_len ) {
                DBGC ( device, "SNP %s has invalid link-layer address length "
                       "%d\n", efi_handle_name ( device ), mode->HwAddressSize);
                rc = -ENOTSUP;
                goto err_ll_addr_len;
        }
        memcpy ( netdev->ll_addr, &mode->CurrentAddress,
                 netdev->ll_protocol->ll_addr_len );
        snp->mtu = ( snp->snp->Mode->MaxPacketSize +
                     snp->snp->Mode->MediaHeaderSize );

        /* Register network device */
        if ( ( rc = register_netdev ( netdev ) ) != 0 )
                goto err_register_netdev;
        DBGC ( device, "SNP %s registered as %s\n",
               efi_handle_name ( device ), netdev->name );

        /* Set initial link state */
        if ( snp->snp->Mode->MediaPresentSupported ) {
                snpnet_check_link ( netdev );
        } else {
                netdev_link_up ( netdev );
        }

        return 0;

        unregister_netdev ( netdev );
 err_register_netdev:
 err_ll_addr_len:
 err_hw_addr_len:
 err_shutdown:
 err_start:
        list_del ( &snp->dev.siblings );
        netdev_nullify ( netdev );
        netdev_put ( netdev );
 err_alloc:
        efi_close_by_driver ( device, &efi_simple_network_protocol_guid );
 err_open_protocol:
        return rc;
}

References alloc_etherdev(), device::children, DBGC, DBGC_EFI_OPENERS, efi_device::dev, net_device::dev, efi_device::device, EEFI, efi_close_by_driver(), efi_device_info(), efi_handle_name(), efi_open_by_driver, efi_simple_network_protocol_guid, snp_nic::efidev, efidev_set_drvdata(), EfiSimpleNetworkInitialized, EfiSimpleNetworkStopped, ENOMEM, ENOTSUP, net_device::hw_addr, ll_protocol::hw_addr_len, INIT_LIST_HEAD, list_add, list_del, net_device::ll_addr, ll_protocol::ll_addr_len, net_device::ll_protocol, EFI_SIMPLE_NETWORK_MODE::MaxPacketSize, EFI_SIMPLE_NETWORK_MODE::MediaHeaderSize, EFI_SIMPLE_NETWORK_MODE::MediaPresentSupported, memcpy(), mode, _EFI_SIMPLE_NETWORK_PROTOCOL::Mode, net_device::name, netdev, netdev_init(), NETDEV_INSOMNIAC, netdev_insomniac(), netdev_link_up(), netdev_nullify(), netdev_put(), net_device::priv, rc, register_netdev(), _EFI_SIMPLE_NETWORK_PROTOCOL::Shutdown, snp_nic::snp, snpnet_check_link(), snpnet_is_insomniac(), snpnet_operations, _EFI_SIMPLE_NETWORK_PROTOCOL::Start, net_device::state, strerror(), and unregister_netdev().

snpnet_stop()

void snpnet_stop

(

struct efi_device *

efidev

)

Detach driver from device.

Parameters

efidev

EFI device

Definition at line 844 of file snpnet.c.

                                               {
        struct net_device *netdev = efidev_get_drvdata ( efidev );
        struct snp_nic *snp = netdev->priv;
        EFI_HANDLE device = efidev->device;
        EFI_STATUS efirc;
        int rc;

        /* Unregister network device */
        unregister_netdev ( netdev );

        /* Stop SNP protocol (unless whole system shutdown is in progress) */
        if ( ( ! efi_shutdown_in_progress ) &&
             ( ( efirc = snp->snp->Stop ( snp->snp ) ) != 0 ) ) {
                rc = -EEFI ( efirc );
                DBGC ( device, "SNP %s could not stop: %s\n",
                       efi_handle_name ( device ), strerror ( rc ) );
                /* Nothing we can do about this */
        }

        /* Free network device */
        list_del ( &snp->dev.siblings );
        netdev_nullify ( netdev );
        netdev_put ( netdev );

        /* Close SNP protocol */
        efi_close_by_driver ( device, &efi_simple_network_protocol_guid );
}

References DBGC, efi_device::device, EEFI, efi_close_by_driver(), efi_handle_name(), efi_shutdown_in_progress, efi_simple_network_protocol_guid, snp_nic::efidev, efidev_get_drvdata(), list_del, netdev, netdev_nullify(), netdev_put(), net_device::priv, rc, snp_nic::snp, _EFI_SIMPLE_NETWORK_PROTOCOL::Stop, strerror(), and unregister_netdev().

Variable Documentation

snpnet_operations

struct net_device_operations snpnet_operations

static

Initial value:

= {
        .open = snpnet_open,
        .close = snpnet_close,
        .transmit = snpnet_transmit,
        .poll = snpnet_poll,
}

SNP network device operations.

Definition at line 495 of file snpnet.c.

Referenced by snpnet_start().