[efi] Rewrite SNP NIC driver

Rewrite the SNP NIC driver to use non-blocking and deferrable
transmissions, to provide link status detection, to provide
information about the underlying (PCI) hardware device, and to avoid
unnecessary I/O buffer allocations during receive polling.

Signed-off-by: Michael Brown <mcb30@ipxe.org>

src/drivers/net/efi/snp.c

@@ -19,17 +19,12 @@
 
 FILE_LICENCE ( GPL2_OR_LATER );
 
-#include <stdlib.h>
-#include <stdio.h>
-#include <string.h>
 #include <errno.h>
 #include <ipxe/efi/efi.h>
 #include <ipxe/efi/Protocol/SimpleNetwork.h>
 #include <ipxe/efi/efi_driver.h>
 #include <ipxe/efi/efi_snp.h>
-#include <ipxe/efi/efi_pci.h>
 #include "snpnet.h"
-#include "snp.h"
 
 /** @file
  *
@@ -41,10 +36,6 @@ FILE_LICENCE ( GPL2_OR_LATER );
 static EFI_GUID efi_simple_network_protocol_guid
 	= EFI_SIMPLE_NETWORK_PROTOCOL_GUID;
 
-/** EFI PCI I/O protocol GUID */
-static EFI_GUID efi_pci_io_protocol_guid
-	= EFI_PCI_IO_PROTOCOL_GUID;
-
 /**
  * Check to see if driver supports a device
  *
@@ -77,143 +68,10 @@ static int snp_supported ( EFI_HANDLE device ) {
 	return 0;
 }
 
-/**
- * Get underlying PCI device information
- *
- * @v snpdev		SNP device
- * @ret rc		Return status code
- */
-static int snp_pci_info ( struct snp_device *snpdev ) {
-	EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
-	struct efi_device *efidev = snpdev->efidev;
-	EFI_DEVICE_PATH_PROTOCOL *devpath = efidev->path;
-	struct pci_device pci;
-	EFI_HANDLE device;
-	EFI_STATUS efirc;
-	int rc;
-
-	/* Check for presence of PCI I/O protocol */
-	if ( ( efirc = bs->LocateDevicePath ( &efi_pci_io_protocol_guid,
-					      &devpath, &device ) ) != 0 ) {
-		DBGC ( efidev->device, "SNP %p %s is not a PCI device\n",
-		       efidev->device, efi_devpath_text ( efidev->path ) );
-		return -EEFI ( efirc );
-	}
-
-	/* Get PCI device information */
-	if ( ( rc = efipci_info ( device, &pci ) ) != 0 ) {
-		DBGC ( efidev->device, "SNP %p %s could not get PCI "
-		       "information: %s\n", efidev->device,
-		       efi_devpath_text ( efidev->path ), strerror ( rc ) );
-		return rc;
-	}
-
-	/* Populate SNP device information */
-	memcpy ( &snpdev->dev.desc, &pci.dev.desc, sizeof ( snpdev->dev.desc ));
-	snprintf ( snpdev->dev.name, sizeof ( snpdev->dev.name ), "SNP-%s",
-		   pci.dev.name );
-
-	return 0;
-}
-
-/**
- * Attach driver to device
- *
- * @v efidev		EFI device
- * @ret rc		Return status code
- */
-static int snp_start ( struct efi_device *efidev ) {
-	EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
-	EFI_HANDLE device = efidev->device;
-	struct snp_device *snpdev;
-	union {
-		EFI_SIMPLE_NETWORK_PROTOCOL *snp;
-		void *interface;
-	} snp;
-	EFI_STATUS efirc;
-	int rc;
-
-	/* Check that this is not a device we are providing ourselves */
-	if ( find_snpdev ( efidev->device ) != NULL ) {
-		DBGCP ( device, "SNP %p %s is provided by this binary\n",
-			device, efi_devpath_text ( efidev->path ) );
-		rc = -ENOTTY;
-		goto err_own;
-	}
-
-	/* Allocate and initialise structure */
-	snpdev = zalloc ( sizeof ( *snpdev ) );
-	if ( ! snpdev ) {
-		rc = -ENOMEM;
-		goto err_alloc;
-	}
-	snpdev->efidev = efidev;
-	snpdev->dev.driver_name = "SNP";
-	INIT_LIST_HEAD ( &snpdev->dev.children );
-
-	/* See if device is an SNP device */
-	if ( ( efirc = bs->OpenProtocol ( device,
-					  &efi_simple_network_protocol_guid,
-					  &snp.interface, efi_image_handle,
-					  device,
-					  ( EFI_OPEN_PROTOCOL_BY_DRIVER |
-					    EFI_OPEN_PROTOCOL_EXCLUSIVE )))!=0){
-		rc = -EEFI ( efirc );
-		DBGCP ( device, "SNP %p %s cannot open SNP protocol: %s\n",
-			device, efi_devpath_text ( efidev->path ),
-			strerror ( rc ) );
-		goto err_open_protocol;
-	}
-	snpdev->snp = snp.snp;
-
-	/* Get underlying device information */
-	if ( ( rc = snp_pci_info ( snpdev ) ) != 0 )
-		goto err_info;
-
-	/* Mark SNP device as a child of the EFI device */
-	snpdev->dev.parent = &efidev->dev;
-	list_add ( &snpdev->dev.siblings, &efidev->dev.children );
-
-	/* Create SNP network device */
-	if ( ( rc = snpnet_probe ( snpdev ) ) != 0 )
-		goto err_probe;
-
-	efidev_set_drvdata ( efidev, snpdev );
-	return 0;
-
-	snpnet_remove ( snpdev );
- err_probe:
-	list_del ( &snpdev->dev.siblings );
- err_info:
-	bs->CloseProtocol ( device, &efi_simple_network_protocol_guid,
-			    efi_image_handle, device );
- err_open_protocol:
-	free ( snpdev );
- err_alloc:
- err_own:
-	return rc;
-}
-
-/**
- * Detach driver from device
- *
- * @v efidev		EFI device
-  */
-static void snp_stop ( struct efi_device *efidev ) {
-	EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
-	struct snp_device *snpdev = efidev_get_drvdata ( efidev );
-
-	snpnet_remove ( snpdev );
-	list_del ( &snpdev->dev.siblings );
-	bs->CloseProtocol ( efidev->device, &efi_simple_network_protocol_guid,
-			    efi_image_handle, efidev->device );
-	free ( snpdev );
-}
-
 /** EFI SNP driver */
 struct efi_driver snp_driver __efi_driver ( EFI_DRIVER_NORMAL ) = {
 	.name = "SNP",
 	.supported = snp_supported,
-	.start = snp_start,
-	.stop = snp_stop,
+	.start = snpnet_start,
+	.stop = snpnet_stop,
 };

src/drivers/net/efi/snp.h

@@ -1,48 +0,0 @@
-/*
- * Copyright (C) 2010 VMware, Inc.  All Rights Reserved.
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License as
- * published by the Free Software Foundation; either version 2 of the
- * License, or any later version.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
- */
-
-#ifndef _SNP_H
-#define _SNP_H
-
-/** @file
- *
- * SNP driver
- *
- */
-
-FILE_LICENCE ( GPL2_OR_LATER );
-
-#include <ipxe/device.h>
-#include <ipxe/efi/efi.h>
-#include <ipxe/efi/Protocol/SimpleNetwork.h>
-
-/** An SNP device */
-struct snp_device {
-	/** EFI device */
-	struct efi_device *efidev;
-	/** Simple network protocol */
-	EFI_SIMPLE_NETWORK_PROTOCOL *snp;
-	/** Generic device */
-	struct device dev;
-	/** Network device */
-	struct net_device *netdev;
-	/** State to restore when removing the device */
-	UINT32 removal_state;
-};
-
-#endif /* _SNP_H */

src/drivers/net/efi/snpnet.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2010 VMware, Inc.  All Rights Reserved.
+ * Copyright (C) 2014 Michael Brown <mbrown@fensystems.co.uk>.
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License as
@@ -13,38 +13,85 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
  */
 
 FILE_LICENCE ( GPL2_OR_LATER );
 
-#include <errno.h>
+#include <stdlib.h>
+#include <stdio.h>
 #include <string.h>
-#include <ipxe/io.h>
+#include <errno.h>
 #include <ipxe/iobuf.h>
 #include <ipxe/netdevice.h>
-#include <ipxe/if_ether.h>
 #include <ipxe/ethernet.h>
 #include <ipxe/efi/efi.h>
 #include <ipxe/efi/Protocol/SimpleNetwork.h>
-#include "snp.h"
+#include <ipxe/efi/efi_driver.h>
+#include <ipxe/efi/efi_pci.h>
 #include "snpnet.h"
 
 /** @file
  *
- * SNP network device driver
+ * SNP NIC driver
  *
  */
 
-/** SNP net device structure */
-struct snpnet_device {
-	/** The underlying simple network protocol */
+/** An SNP NIC */
+struct snp_nic {
+	/** EFI device */
+	struct efi_device *efidev;
+	/** Simple network protocol */
 	EFI_SIMPLE_NETWORK_PROTOCOL *snp;
+	/** Generic device */
+	struct device dev;
+
+	/** Maximum packet size
+	 *
+	 * This is calculated as the sum of MediaHeaderSize and
+	 * MaxPacketSize, and may therefore be an overestimate.
+	 */
+	size_t mtu;
 
-	/** State that the SNP should be in after close */
-	UINT32 close_state;
+	/** Current transmit buffer */
+	struct io_buffer *txbuf;
+	/** Current receive buffer */
+	struct io_buffer *rxbuf;
 };
 
+/** Maximum number of received packets per poll */
+#define SNP_RX_QUOTA 4
+
+/** EFI simple network protocol GUID */
+static EFI_GUID efi_simple_network_protocol_guid
+	= EFI_SIMPLE_NETWORK_PROTOCOL_GUID;
+
+/** EFI PCI I/O protocol GUID */
+static EFI_GUID efi_pci_io_protocol_guid
+	= EFI_PCI_IO_PROTOCOL_GUID;
+
+/**
+ * Check link state
+ *
+ * @v netdev		Network device
+ */
+static void snpnet_check_link ( struct net_device *netdev ) {
+	struct snp_nic *snp = netdev_priv ( netdev );
+	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 );
+	}
+}
+
 /**
  * Transmit packet
  *
@@ -54,297 +101,438 @@ struct snpnet_device {
  */
 static int snpnet_transmit ( struct net_device *netdev,
 			     struct io_buffer *iobuf ) {
-	struct snpnet_device *snpnetdev = netdev->priv;
-	EFI_SIMPLE_NETWORK_PROTOCOL *snp = snpnetdev->snp;
-	void *txbuf=NULL;
-	size_t len = iob_len ( iobuf );
+	struct snp_nic *snp = netdev_priv ( netdev );
 	EFI_STATUS efirc;
 	int rc;
 
-	if ( ( efirc = snp->Transmit ( snp, 0, len, iobuf->data, NULL, NULL,
-				       NULL ) ) != 0 ) {
-		return -EEFI ( efirc );
+	/* Defer the packet if there is already a transmission in progress */
+	if ( snp->txbuf ) {
+		netdev_tx_defer ( netdev, iobuf );
+		return 0;
 	}
-	/* since GetStatus is so inconsistent, don't try more than one outstanding transmit at a time */
-	while ( txbuf == NULL ) {
-		if ( ( efirc = snp->GetStatus ( snp, NULL, &txbuf ) ) != 0 ) {
-			rc = -EEFI ( efirc );
-			DBGC ( snp, "SNP %p could not get status %s\n", snp,
-			       strerror ( rc ) );
-			break;
-		}
 
+	/* 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;
 	}
-	netdev_tx_complete ( netdev, iobuf );
+	snp->txbuf = iobuf;
+
 	return 0;
 }
 
+/**
+ * Poll for completed packets
+ *
+ * @v netdev		Network device
+ */
+static void snpnet_poll_tx ( struct net_device *netdev ) {
+	struct snp_nic *snp = netdev->priv;
+	UINT32 irq;
+	VOID *txbuf;
+	EFI_STATUS efirc;
+	int rc;
+
+	/* Get status */
+	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 */
+	netdev_tx_complete ( netdev, snp->txbuf );
+	snp->txbuf = NULL;
+}
+
 /**
  * Poll for received packets
  *
  * @v netdev		Network device
  */
-static void snpnet_poll ( struct net_device *netdev ) {
-	struct snpnet_device *snpnetdev = netdev->priv;
-	EFI_SIMPLE_NETWORK_PROTOCOL *snp = snpnetdev->snp;
-	struct io_buffer *iobuf = NULL;
+static void snpnet_poll_rx ( struct net_device *netdev ) {
+	struct snp_nic *snp = netdev->priv;
 	UINTN len;
+	unsigned int quota;
 	EFI_STATUS efirc;
 	int rc;
 
-	/* Process received packets */
-	while ( 1 ) {
-		/* The spec is not clear if the max packet size refers to the
-		 * payload or the entire packet including headers. The Receive
-		 * function needs a buffer large enough to contain the headers,
-		 * and potentially a 4-byte CRC and 4-byte VLAN tag (?), so add
-		 * some breathing room.
-		 */
-		len = snp->Mode->MaxPacketSize + ETH_HLEN + 8;
-		iobuf = alloc_iob ( len );
-		if ( iobuf == NULL ) {
-			netdev_rx_err ( netdev, NULL, -ENOMEM );
-			break;
+	/* 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 );
+			if ( ! snp->rxbuf ) {
+				/* Leave for next poll */
+				break;
+			}
 		}
 
-		efirc = snp->Receive ( snp, NULL, &len, iobuf->data,
-				       NULL, NULL, NULL );
+		/* Receive packet */
+		len = iob_tailroom ( snp->rxbuf );
+		if ( ( efirc = snp->snp->Receive ( snp->snp, NULL, &len,
+						   snp->rxbuf->data, NULL,
+						   NULL, NULL ) ) != 0 ) {
 
-		/* No packets left? */
-		if ( efirc == EFI_NOT_READY ) {
-			free_iob ( iobuf );
-			break;
-		}
+			/* EFI_NOT_READY is just the usual "no packet"
+			 * status indication; ignore it.
+			 */
+			if ( efirc == EFI_NOT_READY )
+				break;
 
-		/* Other error? */
-		if ( efirc != 0 ) {
+			/* Anything else is an error */
 			rc = -EEFI ( efirc );
-			DBGC ( snp, "SNP %p receive packet error: %s "
-				    "(len was %zd, is now %zd)\n",
-			       snp, strerror ( rc ), iob_len(iobuf),
-			       (size_t)len );
-			netdev_rx_err ( netdev, iobuf, rc );
+			DBGC ( snp, "SNP %s could not receive: %s\n",
+			       netdev->name, strerror ( rc ) );
+			netdev_rx_err ( netdev, NULL, rc );
 			break;
 		}
 
-		/* Packet is valid, deliver it */
-		iob_put ( iobuf, len );
-		netdev_rx ( netdev, iob_disown ( iobuf ) );
+		/* Hand off to network stack */
+		iob_put ( snp->rxbuf, len );
+		netdev_rx ( netdev, snp->rxbuf );
+		snp->rxbuf = NULL;
 	}
 }
 
 /**
- * Open NIC
+ * Poll for completed packets
  *
- * @v netdev		Net device
+ * @v netdev		Network device
+ */
+static void snpnet_poll ( struct net_device *netdev ) {
+
+	/* 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 );
+}
+
+/**
+ * Open network device
+ *
+ * @v netdev		Network device
  * @ret rc		Return status code
  */
 static int snpnet_open ( struct net_device *netdev ) {
-	struct snpnet_device *snpnetdev = netdev->priv;
-	EFI_SIMPLE_NETWORK_PROTOCOL *snp = snpnetdev->snp;
-	EFI_MAC_ADDRESS *mac;
-	UINT32 enableFlags, disableFlags;
+	struct snp_nic *snp = netdev->priv;
+	EFI_MAC_ADDRESS *mac = ( ( void * ) netdev->ll_addr );
+	UINT32 filters;
 	EFI_STATUS efirc;
 	int rc;
 
-	snpnetdev->close_state = snp->Mode->State;
-	if ( snp->Mode->State != EfiSimpleNetworkInitialized ) {
-		if ( ( efirc = snp->Initialize ( snp, 0, 0 ) ) != 0 ) {
-			rc = -EEFI ( efirc );
-			DBGC ( snp, "SNP %p could not initialize: %s\n",
-			       snp, strerror ( rc ) );
-			return 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 */
 	}
 
-        /* Use the default MAC address */
-	mac = ( ( void * ) netdev->ll_addr );
-	if ( ( efirc = snp->StationAddress ( snp, FALSE, mac ) ) != 0 ) {
+	/* Initialise NIC */
+	if ( ( efirc = snp->snp->Initialize ( snp->snp, 0, 0 ) ) != 0 ) {
 		rc = -EEFI ( efirc );
-		DBGC ( snp, "SNP %p could not reset station address: %s\n",
-		       snp, strerror ( rc ) );
+		DBGC ( snp, "SNP %s could not initialise: %s\n",
+		       netdev->name, strerror ( rc ) );
+		return rc;
 	}
 
-	/* Set up receive filters to receive unicast and broadcast packets
-	 * always. Also, enable either promiscuous multicast (if possible) or
-	 * promiscuous operation, in order to catch all multicast packets.
-	 */
-	enableFlags = snp->Mode->ReceiveFilterMask &
-		      ( EFI_SIMPLE_NETWORK_RECEIVE_UNICAST |
-			EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST );
-	disableFlags = snp->Mode->ReceiveFilterMask &
-		       ( EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST |
-			 EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS |
-			 EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST );
-	if ( snp->Mode->ReceiveFilterMask &
-	     EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST ) {
-		enableFlags |= EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST;
-	} else if ( snp->Mode->ReceiveFilterMask &
-		    EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS ) {
-		enableFlags |= EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS;
+	/* 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 */
 	}
-	disableFlags &= ~enableFlags;
-	if ( ( efirc = snp->ReceiveFilters ( snp, enableFlags, disableFlags,
-					     FALSE, 0, NULL ) ) != 0 ) {
+
+	/* Set receive filters */
+	filters = ( EFI_SIMPLE_NETWORK_RECEIVE_UNICAST |
+		    EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST |
+		    EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST |
+		    EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS |
+		    EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST );
+	if ( ( efirc = snp->snp->ReceiveFilters ( snp->snp, filters, 0, FALSE,
+						  0, NULL ) ) != 0 ) {
 		rc = -EEFI ( efirc );
-		DBGC ( snp, "SNP %p could not set receive filters: %s\n",
-		       snp, strerror ( rc ) );
+		DBGC ( snp, "SNP %s could not set receive filters: %s\n",
+		       netdev->name, strerror ( rc ) );
+		/* Ignore error */
 	}
 
-	DBGC ( snp, "SNP %p opened\n", snp );
 	return 0;
 }
 
 /**
- * Close NIC
+ * Close network device
  *
- * @v netdev		Net device
+ * @v netdev		Network device
  */
 static void snpnet_close ( struct net_device *netdev ) {
-	struct snpnet_device *snpnetdev = netdev->priv;
-	EFI_SIMPLE_NETWORK_PROTOCOL *snp = snpnetdev->snp;
+	struct snp_nic *snp = netdev->priv;
 	EFI_STATUS efirc;
 	int rc;
 
-	if ( snpnetdev->close_state != EfiSimpleNetworkInitialized ) {
-		if ( ( efirc = snp->Shutdown ( snp ) ) != 0 ) {
-			rc = -EEFI ( efirc );
-			DBGC ( snp, "SNP %p could not shut down: %s\n",
-			       snp, strerror ( rc ) );
-		}
+	/* Shut down NIC */
+	if ( ( 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 */
 	}
-}
 
-/**
- * Enable/disable interrupts
- *
- * @v netdev		Net device
- * @v enable		Interrupts should be enabled
- */
-static void snpnet_irq ( struct net_device *netdev, int enable ) {
-	struct snpnet_device *snpnetdev = netdev->priv;
-	EFI_SIMPLE_NETWORK_PROTOCOL *snp = snpnetdev->snp;
+	/* Discard transmit buffer, if applicable */
+	if ( snp->txbuf ) {
+		netdev_tx_complete_err ( netdev, snp->txbuf, -ECANCELED );
+		snp->txbuf = NULL;
+	}
 
-	/* On EFI, interrupts are never necessary. (This function is only
-	 * required for BIOS PXE.) If interrupts were required, they could be
-	 * simulated using a fast timer.
-	 */
-	DBGC ( snp, "SNP %p cannot %s interrupts\n",
-	       snp, ( enable ? "enable" : "disable" ) );
+	/* Discard receive buffer, if applicable */
+	if ( snp->rxbuf ) {
+		free_iob ( snp->rxbuf );
+		snp->rxbuf = NULL;
+	}
 }
 
 /** SNP network device operations */
 static struct net_device_operations snpnet_operations = {
-	.open		= snpnet_open,
-	.close		= snpnet_close,
-	.transmit	= snpnet_transmit,
-	.poll		= snpnet_poll,
-	.irq   		= snpnet_irq,
+	.open = snpnet_open,
+	.close = snpnet_close,
+	.transmit = snpnet_transmit,
+	.poll = snpnet_poll,
 };
 
 /**
- * Probe SNP device
+ * Get underlying PCI device information
  *
- * @v snpdev		SNP device
+ * @v efidev		EFI device
+ * @v dev		Generic device to fill in
  * @ret rc		Return status code
  */
-int snpnet_probe ( struct snp_device *snpdev ) {
-	EFI_SIMPLE_NETWORK_PROTOCOL *snp = snpdev->snp;
+static int snpnet_pci_info ( struct efi_device *efidev, struct device *dev ) {
+	EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
+	EFI_DEVICE_PATH_PROTOCOL *devpath = efidev->path;
+	struct pci_device pci;
+	EFI_HANDLE device;
 	EFI_STATUS efirc;
+	int rc;
+
+	/* Check for presence of PCI I/O protocol */
+	if ( ( efirc = bs->LocateDevicePath ( &efi_pci_io_protocol_guid,
+					      &devpath, &device ) ) != 0 ) {
+		DBGC ( efidev->device, "SNP %p %s is not a PCI device\n",
+		       efidev->device, efi_devpath_text ( efidev->path ) );
+		return -EEFI ( efirc );
+	}
+
+	/* Get PCI device information */
+	if ( ( rc = efipci_info ( device, &pci ) ) != 0 ) {
+		DBGC ( efidev->device, "SNP %p %s could not get PCI "
+		       "information: %s\n", efidev->device,
+		       efi_devpath_text ( efidev->path ), strerror ( rc ) );
+		return rc;
+	}
+
+	/* Populate SNP device information */
+	memcpy ( &dev->desc, &pci.dev.desc, sizeof ( dev->desc ) );
+	snprintf ( dev->name, sizeof ( dev->name ), "SNP-%s", pci.dev.name );
+
+	return 0;
+}
+
+/**
+ * Get underlying device information
+ *
+ * @v efidev		EFI device
+ * @v dev		Generic device to fill in
+ * @ret rc		Return status code
+ */
+static int snpnet_dev_info ( struct efi_device *efidev, struct device *dev ) {
+	int rc;
+
+	/* Try getting underlying PCI device information */
+	if ( ( rc = snpnet_pci_info ( efidev, dev ) ) == 0 )
+		return 0;
+
+	DBGC ( efidev->device, "SNP %p %s could not get underlying device "
+	       "information\n", efidev->device,
+	       efi_devpath_text ( efidev->path ) );
+	return -ENOTTY;
+}
+
+/**
+ * Attach driver to device
+ *
+ * @v efidev		EFI device
+ * @ret rc		Return status code
+ */
+int snpnet_start ( struct efi_device *efidev ) {
+	EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
+	EFI_HANDLE device = efidev->device;
+	EFI_SIMPLE_NETWORK_MODE *mode;
 	struct net_device *netdev;
-	struct snpnet_device *snpnetdev;
+	struct snp_nic *snp;
+	void *interface;
+	EFI_STATUS efirc;
 	int rc;
 
-	DBGC ( snp, "SNP %p probing...\n", snp );
+	/* Open SNP protocol */
+	if ( ( efirc = bs->OpenProtocol ( device,
+					  &efi_simple_network_protocol_guid,
+					  &interface, efi_image_handle, device,
+					  ( EFI_OPEN_PROTOCOL_BY_DRIVER |
+					    EFI_OPEN_PROTOCOL_EXCLUSIVE )))!=0){
+		rc = -EEFI ( efirc );
+		DBGC ( device, "SNP %p %s cannot open SNP protocol: %s\n",
+		       device, efi_devpath_text ( efidev->path ),
+		       strerror ( rc ) );
+		goto err_open_protocol;
+	}
 
-	/* Allocate net device */
-	netdev = alloc_etherdev ( sizeof ( struct snpnet_device ) );
-	if ( ! netdev )
-		return -ENOMEM;
+	/* Allocate and initialise structure */
+	netdev = alloc_etherdev ( sizeof ( *snp ) );
+	if ( ! netdev ) {
+		rc = -ENOMEM;
+		goto err_alloc;
+	}
 	netdev_init ( netdev, &snpnet_operations );
-	netdev->dev = &snpdev->dev;
-	snpdev->netdev = netdev;
-	snpnetdev = netdev->priv;
-	snpnetdev->snp = snp;
-	snpdev->removal_state = snp->Mode->State;
-
-	/* Start the interface */
-	if ( snp->Mode->State == EfiSimpleNetworkStopped ) {
-		if ( ( efirc = snp->Start ( snp ) ) != 0 ) {
-			rc = -EEFI ( efirc );
-			DBGC ( snp, "SNP %p could not start: %s\n", snp,
-			       strerror ( rc ) );
-			goto err_start;
-		}
+	snp = netdev->priv;
+	snp->efidev = efidev;
+	snp->snp = interface;
+	mode = snp->snp->Mode;
+	efidev_set_drvdata ( efidev, netdev );
+
+	/* Populate underlying device information */
+	if ( ( rc = snpnet_dev_info ( efidev, &snp->dev ) ) != 0 )
+		goto err_info;
+	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;
+
+	/* Bring to the Started state */
+	if ( ( mode->State == EfiSimpleNetworkStopped ) &&
+	     ( ( efirc = snp->snp->Start ( snp->snp ) ) != 0 ) ) {
+		rc = -EEFI ( efirc );
+		DBGC ( device, "SNP %p %s could not start: %s\n", device,
+		       efi_devpath_text ( efidev->path ), strerror ( rc ) );
+		goto err_start;
+	}
+	if ( ( mode->State == EfiSimpleNetworkInitialized ) &&
+	     ( ( efirc = snp->snp->Shutdown ( snp->snp ) ) != 0 ) ) {
+		rc = -EEFI ( efirc );
+		DBGC ( device, "SNP %p %s could not shut down: %s\n", device,
+		       efi_devpath_text ( efidev->path ), strerror ( rc ) );
+		goto err_shutdown;
 	}
 
-	if ( snp->Mode->HwAddressSize > sizeof ( netdev->hw_addr ) ) {
-		DBGC ( snp, "SNP %p hardware address is too large\n", snp );
-		rc = -EINVAL;
-		goto err_hwaddr;
+	/* Populate network device parameters */
+	if ( mode->HwAddressSize != netdev->ll_protocol->hw_addr_len ) {
+		DBGC ( device, "SNP %p %s has invalid hardware address "
+		       "length %d\n", device, efi_devpath_text ( efidev->path ),
+		       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 %p %s has invalid link-layer address "
+		       "length %d\n", device, efi_devpath_text ( efidev->path ),
+		       mode->HwAddressSize );
+		rc = -ENOTSUP;
+		goto err_ll_addr_len;
 	}
-	memcpy ( netdev->hw_addr, snp->Mode->PermanentAddress.Addr,
-		 snp->Mode->HwAddressSize );
+	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;
-
-	/* Mark as link up; we don't handle link state */
-	netdev_link_up ( netdev );
+		goto err_register_netdev;
+	DBGC ( device, "SNP %p %s registered as %s\n", device,
+	       efi_devpath_text ( efidev->path ), netdev->name );
+
+	/* Set initial link state */
+	if ( snp->snp->Mode->MediaPresentSupported ) {
+		snpnet_check_link ( netdev );
+	} else {
+		netdev_link_up ( netdev );
+	}
 
-	DBGC ( snp, "SNP %p added\n", snp );
 	return 0;
 
-err_register:
-err_hwaddr:
-	if ( snpdev->removal_state == EfiSimpleNetworkStopped )
-		snp->Stop ( snp );
-
-err_start:
+	unregister_netdev ( netdev );
+ err_register_netdev:
+ err_ll_addr_len:
+ err_hw_addr_len:
+ err_shutdown:
+ err_start:
+	list_del ( &snp->dev.siblings );
+ err_info:
 	netdev_nullify ( netdev );
 	netdev_put ( netdev );
-	snpdev->netdev = NULL;
+ err_alloc:
+	bs->CloseProtocol ( device, &efi_simple_network_protocol_guid,
+			    efi_image_handle, device );
+ err_open_protocol:
 	return rc;
 }
 
 /**
- * Remove SNP device
+ * Detach driver from device
  *
- * @v snpdev		SNP device
- */
-void snpnet_remove ( struct snp_device *snpdev ) {
-	EFI_SIMPLE_NETWORK_PROTOCOL *snp = snpdev->snp;
-	struct net_device *netdev = snpdev->netdev;
+ * @v efidev		EFI device
+  */
+void snpnet_stop ( struct efi_device *efidev ) {
+	EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
+	struct net_device *netdev = efidev_get_drvdata ( efidev );
+	struct snp_nic *snp = netdev->priv;
 	EFI_STATUS efirc;
 	int rc;
 
-	if ( snp->Mode->State == EfiSimpleNetworkInitialized &&
-	     snpdev->removal_state != EfiSimpleNetworkInitialized ) {
-		DBGC ( snp, "SNP %p shutting down\n", snp );
-		if ( ( efirc = snp->Shutdown ( snp ) ) != 0 ) {
-			rc = -EEFI ( efirc );
-			DBGC ( snp, "SNP %p could not shut down: %s\n",
-			       snp, strerror ( rc ) );
-		}
-	}
+	/* Unregister network device */
+	unregister_netdev ( netdev );
 
-	if ( snp->Mode->State == EfiSimpleNetworkStarted &&
-	     snpdev->removal_state == EfiSimpleNetworkStopped ) {
-		DBGC ( snp, "SNP %p stopping\n", snp );
-		if ( ( efirc = snp->Stop ( snp ) ) != 0 ) {
-			rc = -EEFI ( efirc );
-			DBGC ( snp, "SNP %p could not be stopped: %s\n",
-			       snp, strerror ( rc ) );
-		}
+	/* Stop SNP protocol */
+	if ( ( efirc = snp->snp->Stop ( snp->snp ) ) != 0 ) {
+		rc = -EEFI ( efirc );
+		DBGC ( efidev->device, "SNP %p %s could not stop: %s\n",
+		       efidev->device, efi_devpath_text ( efidev->path ),
+		       strerror ( rc ) );
+		/* Nothing we can do about this */
 	}
 
-	/* Unregister net device */
-	unregister_netdev ( netdev );
-
 	/* Free network device */
+	list_del ( &snp->dev.siblings );
 	netdev_nullify ( netdev );
 	netdev_put ( netdev );
 
-	DBGC ( snp, "SNP %p removed\n", snp );
+	/* Close SNP protocol */
+	bs->CloseProtocol ( efidev->device, &efi_simple_network_protocol_guid,
+			    efi_image_handle, efidev->device );
 }

src/drivers/net/efi/snpnet.h

@@ -1,35 +1,17 @@
-/*
- * Copyright (C) 2010 VMware, Inc.  All Rights Reserved.
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License as
- * published by the Free Software Foundation; either version 2 of the
- * License, or any later version.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
- */
-
 #ifndef _SNPNET_H
 #define _SNPNET_H
 
 /** @file
  *
- * EFI Simple Network Protocol network device driver
+ * SNP NIC driver
  *
  */
 
 FILE_LICENCE ( GPL2_OR_LATER );
 
-struct snp_device;
+struct efi_device;
 
-extern int snpnet_probe ( struct snp_device *snpdev );
-extern void snpnet_remove ( struct snp_device *snpdev );
+extern int snpnet_start ( struct efi_device *efidev );
+extern void snpnet_stop ( struct efi_device *efidev );
 
 #endif /* _SNPNET_H */

src/drivers/net/efi/snponly.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2010 VMware, Inc.  All Rights Reserved.
+ * Copyright (C) 2014 Michael Brown <mbrown@fensystems.co.uk>.
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License as
@@ -13,117 +13,45 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
  */
 
 FILE_LICENCE ( GPL2_OR_LATER );
 
-#include <string.h>
 #include <errno.h>
-#include <ipxe/device.h>
-#include <ipxe/init.h>
 #include <ipxe/efi/efi.h>
-#include <ipxe/efi/Protocol/SimpleNetwork.h>
-#include "snp.h"
+#include <ipxe/efi/efi_driver.h>
 #include "snpnet.h"
 
 /** @file
  *
- * Chain-loading Simple Network Protocol Bus Driver
+ * SNP chainloaded-device-only driver
  *
- * This bus driver allows iPXE to use the EFI Simple Network Protocol provided
- * by the platform to transmit and receive packets. It attaches to only the
- * device handle that iPXE was loaded from, that is, it will only use the
- * Simple Network Protocol on the current loaded image's device handle.
- *
- * Eseentially, this driver provides the EFI equivalent of the "undionly"
- * driver.
  */
 
-/** The one and only SNP network device */
-static struct snp_device snponly_dev;
-
-/** EFI simple network protocol GUID */
-static EFI_GUID efi_simple_network_protocol_guid
-	= EFI_SIMPLE_NETWORK_PROTOCOL_GUID;
-
 /**
- * Probe SNP root bus
+ * Check to see if driver supports a device
  *
- * @v rootdev		SNP bus root device
- *
- * Look at the loaded image's device handle and see if the simple network
- * protocol exists. If so, register a driver for it.
+ * @v device		EFI device handle
+ * @ret rc		Return status code
  */
-static int snpbus_probe ( struct root_device *rootdev ) {
-	EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
-	EFI_STATUS efirc;
-	int rc;
-	void *snp;
-
-	efirc = bs->OpenProtocol ( efi_loaded_image->DeviceHandle,
-				   &efi_simple_network_protocol_guid,
-				   &snp, efi_image_handle, NULL,
-				   EFI_OPEN_PROTOCOL_GET_PROTOCOL );
-	if ( efirc ) {
-		DBG ( "Could not find Simple Network Protocol!\n" );
-		return -ENODEV;
-	}
-	snponly_dev.snp = snp;
+static int snponly_supported ( EFI_HANDLE device ) {
 
-	/* Add to device hierarchy */
-	strncpy ( snponly_dev.dev.name, "EFI SNP",
-		  ( sizeof ( snponly_dev.dev.name ) - 1 ) );
-	snponly_dev.dev.parent = &rootdev->dev;
-	list_add ( &snponly_dev.dev.siblings, &rootdev->dev.children);
-	INIT_LIST_HEAD ( &snponly_dev.dev.children );
+	/* Check that this device is our loaded image's device */
+	if ( device != efi_loaded_image->DeviceHandle )
+		return -ENOTTY;
 
-	/* Create network device */
-	if ( ( rc = snpnet_probe ( &snponly_dev ) ) != 0 )
-		goto err;
+	DBGC ( device, "SNP %p %s is the SNP chainloading device\n",
+	       device, efi_handle_devpath_text ( device ) );
 
 	return 0;
-
-err:
-	list_del ( &snponly_dev.dev.siblings );
-	return rc;
-}
-
-/**
- * Remove SNP root bus
- *
- * @v rootdev		SNP bus root device
- */
-static void snpbus_remove ( struct root_device *rootdev __unused ) {
-	snpnet_remove ( &snponly_dev );
-	list_del ( &snponly_dev.dev.siblings );
-}
-
-/** SNP bus root device driver */
-static struct root_driver snp_root_driver = {
-	.probe = snpbus_probe,
-	.remove = snpbus_remove,
-};
-
-/** SNP bus root device */
-struct root_device snp_root_device __root_device = {
-	.dev = { .name = "EFI SNP" },
-	.driver = &snp_root_driver,
-};
-
-/**
- * Prepare for exit
- *
- * @v booting		System is shutting down for OS boot
- */
-static void snponly_shutdown ( int booting ) {
-	/* If we are shutting down to boot an OS, make sure the SNP does not
-	 * stay active.
-	 */
-	if ( booting )
-		snponly_dev.removal_state = EfiSimpleNetworkStopped;
 }
 
-struct startup_fn startup_snponly __startup_fn ( STARTUP_LATE ) = {
-	.shutdown = snponly_shutdown,
+/** EFI SNP driver */
+struct efi_driver snponly_driver __efi_driver ( EFI_DRIVER_NORMAL ) = {
+	.name = "SNPONLY",
+	.supported = snponly_supported,
+	.start = snpnet_start,
+	.stop = snpnet_stop,
 };