[efi] Move abstract device path and handle functions to efi_utils.c

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

8 files changed, 131 insertions, 85 deletions

diff --git a/src/image/efi_image.c b/src/image/efi_image.c
index 613c9d923..ce1d4b837 100644
--- a/src/image/efi_image.c
+++ b/src/image/efi_image.c
@@ -26,7 +26,7 @@ FILE_LICENCE ( GPL2_OR_LATER );
 #include <ipxe/efi/efi_snp.h>
 #include <ipxe/efi/efi_download.h>
 #include <ipxe/efi/efi_file.h>
-#include <ipxe/efi/efi_driver.h>
+#include <ipxe/efi/efi_utils.h>
 #include <ipxe/efi/efi_strings.h>
 #include <ipxe/efi/efi_wrap.h>
 #include <ipxe/image.h>
diff --git a/src/include/ipxe/efi/efi_driver.h b/src/include/ipxe/efi/efi_driver.h
index 1b890b061..e16a24daa 100644
--- a/src/include/ipxe/efi/efi_driver.h
+++ b/src/include/ipxe/efi/efi_driver.h
@@ -82,11 +82,7 @@ static inline void * efidev_get_drvdata ( struct efi_device *efidev ) {
 	return efidev->priv;
 }
 
-extern EFI_DEVICE_PATH_PROTOCOL *
-efi_devpath_end ( EFI_DEVICE_PATH_PROTOCOL *path );
 extern struct efi_device * efidev_parent ( struct device *dev );
-extern int efidev_child_add ( struct efi_device *efidev, EFI_HANDLE device );
-extern void efidev_child_del ( struct efi_device *efidev, EFI_HANDLE device );
 extern int efi_driver_install ( void );
 extern void efi_driver_uninstall ( void );
 extern int efi_driver_connect_all ( void );
diff --git a/src/include/ipxe/efi/efi_utils.h b/src/include/ipxe/efi/efi_utils.h
new file mode 100644
index 000000000..23972c7a3
--- /dev/null
+++ b/src/include/ipxe/efi/efi_utils.h
@@ -0,0 +1,19 @@
+#ifndef _IPXE_EFI_UTILS_H
+#define _IPXE_EFI_UTILS_H
+
+/** @file
+ *
+ * EFI utilities
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER );
+
+#include <ipxe/efi/efi.h>
+#include <ipxe/efi/Protocol/DevicePath.h>
+
+extern EFI_DEVICE_PATH_PROTOCOL *
+efi_devpath_end ( EFI_DEVICE_PATH_PROTOCOL *path );
+extern int efi_child_add ( EFI_HANDLE parent, EFI_HANDLE child );
+extern void efi_child_del ( EFI_HANDLE parent, EFI_HANDLE child );
+
+#endif /* _IPXE_EFI_UTILS_H */
diff --git a/src/include/ipxe/errfile.h b/src/include/ipxe/errfile.h
index f3e21d440..1029670ac 100644
--- a/src/include/ipxe/errfile.h
+++ b/src/include/ipxe/errfile.h
@@ -305,6 +305,7 @@ FILE_LICENCE ( GPL2_OR_LATER );
 #define ERRFILE_xenstore	      ( ERRFILE_OTHER | 0x00420000 )
 #define ERRFILE_xenbus		      ( ERRFILE_OTHER | 0x00430000 )
 #define ERRFILE_xengrant	      ( ERRFILE_OTHER | 0x00440000 )
+#define ERRFILE_efi_utils	      ( ERRFILE_OTHER | 0x00450000 )
 
 /** @} */
 
diff --git a/src/interface/efi/efi_debug.c b/src/interface/efi/efi_debug.c
index 4cbd831c4..4b8448cb0 100644
--- a/src/interface/efi/efi_debug.c
+++ b/src/interface/efi/efi_debug.c
@@ -32,7 +32,7 @@ FILE_LICENCE ( GPL2_OR_LATER );
 #include <ipxe/uuid.h>
 #include <ipxe/base16.h>
 #include <ipxe/efi/efi.h>
-#include <ipxe/efi/efi_driver.h>
+#include <ipxe/efi/efi_utils.h>
 #include <ipxe/efi/Protocol/ComponentName.h>
 #include <ipxe/efi/Protocol/ComponentName2.h>
 #include <ipxe/efi/Protocol/DevicePathToText.h>
diff --git a/src/interface/efi/efi_driver.c b/src/interface/efi/efi_driver.c
index 3a1945a5f..ba7784cd7 100644
--- a/src/interface/efi/efi_driver.c
+++ b/src/interface/efi/efi_driver.c
@@ -44,24 +44,6 @@ static EFI_DRIVER_BINDING_PROTOCOL efi_driver_binding;
 static LIST_HEAD ( efi_devices );
 
 /**
- * Find end of device path
- *
- * @v path		Path to device
- * @ret path_end	End of device path
- */
-EFI_DEVICE_PATH_PROTOCOL * efi_devpath_end ( EFI_DEVICE_PATH_PROTOCOL *path ) {
-
-	while ( path->Type != END_DEVICE_PATH_TYPE ) {
-		path = ( ( ( void * ) path ) +
-			 /* There's this amazing new-fangled thing known as
-			  * a UINT16, but who wants to use one of those? */
-			 ( ( path->Length[1] << 8 ) | path->Length[0] ) );
-	}
-
-	return path;
-}
-
-/**
  * Find EFI device
  *
  * @v device		EFI device handle
@@ -101,61 +83,6 @@ struct efi_device * efidev_parent ( struct device *dev ) {
 }
 
 /**
- * Add EFI device as child of EFI device
- *
- * @v efidev		EFI device
- * @v device		EFI child device handle
- * @ret efirc		EFI status code
- */
-int efidev_child_add ( struct efi_device *efidev, EFI_HANDLE device ) {
-	EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
-	void *devpath;
-	EFI_STATUS efirc;
-	int rc;
-
-	/* Re-open the device path protocol */
-	if ( ( efirc = bs->OpenProtocol ( efidev->device,
-					  &efi_device_path_protocol_guid,
-					  &devpath,
-					  efi_image_handle, device,
-					  EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
-					  ) ) != 0 ) {
-		rc = -EEFI ( efirc );
-		DBGC ( efidev->device, "EFIDRV %p %s could not add child",
-		       efidev->device, efi_handle_name ( efidev->device ) );
-		DBGC ( efidev->device, " %p %s: %s\n", device,
-		       efi_handle_name ( device ), strerror ( rc ) );
-		DBGC_EFI_OPENERS ( efidev->device, efidev->device,
-				   &efi_device_path_protocol_guid );
-		return rc;
-	}
-
-	DBGC2 ( efidev->device, "EFIDRV %p %s added child",
-		efidev->device, efi_handle_name ( efidev->device ) );
-	DBGC2 ( efidev->device, " %p %s\n", device, efi_handle_name ( device ));
-	return 0;
-}
-
-/**
- * Remove EFI device as child of EFI device
- *
- * @v efidev		EFI device
- * @v device		EFI child device handle
- * @ret efirc		EFI status code
- */
-void efidev_child_del ( struct efi_device *efidev, EFI_HANDLE device ) {
-	EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
-
-	bs->CloseProtocol ( efidev->device,
-			    &efi_device_path_protocol_guid,
-			    efi_image_handle, device );
-	DBGC2 ( efidev->device, "EFIDRV %p %s removed child",
-		efidev->device, efi_handle_name ( efidev->device ) );
-	DBGC2 ( efidev->device, " %p %s\n",
-		device, efi_handle_name ( device ) );
-}
-
-/**
  * Check to see if driver supports a device
  *
  * @v driver		EFI driver
@@ -242,7 +169,7 @@ efi_driver_start ( EFI_DRIVER_BINDING_PROTOCOL *driver __unused,
 	/* Try to start this device */
 	for_each_table_entry ( efidrv, EFI_DRIVERS ) {
 		if ( ( rc = efidrv->supported ( device ) ) != 0 ) {
-			DBGC ( device, "EFIDEV %p %s is not supported by "
+			DBGC ( device, "EFIDRV %p %s is not supported by "
 			       "driver \"%s\": %s\n", device,
 			       efi_handle_name ( device ), efidrv->name,
 			       strerror ( rc ) );
diff --git a/src/interface/efi/efi_snp.c b/src/interface/efi/efi_snp.c
index 2eec29cab..bd45d744d 100644
--- a/src/interface/efi/efi_snp.c
+++ b/src/interface/efi/efi_snp.c
@@ -31,6 +31,7 @@ FILE_LICENCE ( GPL2_OR_LATER );
 #include <ipxe/efi/efi.h>
 #include <ipxe/efi/efi_driver.h>
 #include <ipxe/efi/efi_strings.h>
+#include <ipxe/efi/efi_utils.h>
 #include <ipxe/efi/efi_snp.h>
 #include <usr/autoboot.h>
 
@@ -1047,11 +1048,11 @@ static int efi_snp_probe ( struct net_device *netdev ) {
 	}
 
 	/* Add as child of EFI parent device */
-	if ( ( rc = efidev_child_add ( efidev, snpdev->handle ) ) != 0 ) {
+	if ( ( rc = efi_child_add ( efidev->device, snpdev->handle ) ) != 0 ) {
 		DBGC ( snpdev, "SNPDEV %p could not become child of %p %s: "
 		       "%s\n", snpdev, efidev->device,
 		       efi_handle_name ( efidev->device ), strerror ( rc ) );
-		goto err_efidev_child_add;
+		goto err_efi_child_add;
 	}
 
 	/* Install HII */
@@ -1078,8 +1079,8 @@ static int efi_snp_probe ( struct net_device *netdev ) {
 
 	if ( snpdev->package_list )
 		efi_snp_hii_uninstall ( snpdev );
-	efidev_child_del ( efidev, snpdev->handle );
- err_efidev_child_add:
+	efi_child_del ( efidev->device, snpdev->handle );
+ err_efi_child_add:
 	bs->UninstallMultipleProtocolInterfaces (
 			snpdev->handle,
 			&efi_simple_network_protocol_guid, &snpdev->snp,
@@ -1149,7 +1150,7 @@ static void efi_snp_remove ( struct net_device *netdev ) {
 	/* Uninstall the SNP */
 	if ( snpdev->package_list )
 		efi_snp_hii_uninstall ( snpdev );
-	efidev_child_del ( snpdev->efidev, snpdev->handle );
+	efi_child_del ( snpdev->efidev->device, snpdev->handle );
 	list_del ( &snpdev->list );
 	bs->UninstallMultipleProtocolInterfaces (
 			snpdev->handle,
diff --git a/src/interface/efi/efi_utils.c b/src/interface/efi/efi_utils.c
new file mode 100644
index 000000000..9a3ec1598
--- /dev/null
+++ b/src/interface/efi/efi_utils.c
@@ -0,0 +1,102 @@
+/*
+ * Copyright (C) 2011 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
+ * 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 Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ */
+
+FILE_LICENCE ( GPL2_OR_LATER );
+
+#include <string.h>
+#include <errno.h>
+#include <ipxe/efi/efi.h>
+#include <ipxe/efi/efi_utils.h>
+
+/** @file
+ *
+ * EFI utilities
+ *
+ */
+
+/**
+ * Find end of device path
+ *
+ * @v path		Path to device
+ * @ret path_end	End of device path
+ */
+EFI_DEVICE_PATH_PROTOCOL * efi_devpath_end ( EFI_DEVICE_PATH_PROTOCOL *path ) {
+
+	while ( path->Type != END_DEVICE_PATH_TYPE ) {
+		path = ( ( ( void * ) path ) +
+			 /* There's this amazing new-fangled thing known as
+			  * a UINT16, but who wants to use one of those? */
+			 ( ( path->Length[1] << 8 ) | path->Length[0] ) );
+	}
+
+	return path;
+}
+
+/**
+ * Add EFI device as child of another EFI device
+ *
+ * @v parent		EFI parent device handle
+ * @v child		EFI child device handle
+ * @ret rc		Return status code
+ */
+int efi_child_add ( EFI_HANDLE parent, EFI_HANDLE child ) {
+	EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
+	void *devpath;
+	EFI_STATUS efirc;
+	int rc;
+
+	/* Re-open the device path protocol */
+	if ( ( efirc = bs->OpenProtocol ( parent,
+					  &efi_device_path_protocol_guid,
+					  &devpath,
+					  efi_image_handle, child,
+					  EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
+					  ) ) != 0 ) {
+		rc = -EEFI ( efirc );
+		DBGC ( parent, "EFIDEV %p %s could not add child",
+		       parent, efi_handle_name ( parent ) );
+		DBGC ( parent, " %p %s: %s\n", child,
+		       efi_handle_name ( child ), strerror ( rc ) );
+		DBGC_EFI_OPENERS ( parent, parent,
+				   &efi_device_path_protocol_guid );
+		return rc;
+	}
+
+	DBGC2 ( parent, "EFIDEV %p %s added child",
+		parent, efi_handle_name ( parent ) );
+	DBGC2 ( parent, " %p %s\n", child, efi_handle_name ( child ) );
+	return 0;
+}
+
+/**
+ * Remove EFI device as child of another EFI device
+ *
+ * @v parent		EFI parent device handle
+ * @v child		EFI child device handle
+ */
+void efi_child_del ( EFI_HANDLE parent, EFI_HANDLE child ) {
+	EFI_BOOT_SERVICES *bs = efi_systab->BootServices;
+
+	bs->CloseProtocol ( parent, &efi_device_path_protocol_guid,
+			    efi_image_handle, child );
+	DBGC2 ( parent, "EFIDEV %p %s removed child",
+		parent, efi_handle_name ( parent ) );
+	DBGC2 ( parent, " %p %s\n",
+		child, efi_handle_name ( child ) );
+}