[infiniband] Allow SRP device to be described using an EFI device path

The UEFI specification provides a partial definition of an Infiniband
device path structure.  Use this structure to construct what may be a
plausible path containing at least some of the information required to
identify an SRP target device.

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

4 files changed, 95 insertions, 33 deletions

diff --git a/src/include/ipxe/efi/efi_path.h b/src/include/ipxe/efi/efi_path.h
index 91a6c255..76ded728 100644
--- a/src/include/ipxe/efi/efi_path.h
+++ b/src/include/ipxe/efi/efi_path.h
@@ -18,6 +18,7 @@ struct uri;
 struct iscsi_session;
 struct aoe_device;
 struct fcp_description;
+struct ib_srp_device;
 struct usb_function;
 
 extern EFI_DEVICE_PATH_PROTOCOL *
@@ -31,6 +32,8 @@ extern EFI_DEVICE_PATH_PROTOCOL *
 efi_iscsi_path ( struct iscsi_session *iscsi );
 extern EFI_DEVICE_PATH_PROTOCOL * efi_aoe_path ( struct aoe_device *aoedev );
 extern EFI_DEVICE_PATH_PROTOCOL * efi_fcp_path ( struct fcp_description *desc );
+extern EFI_DEVICE_PATH_PROTOCOL *
+efi_ib_srp_path ( struct ib_srp_device *ib_srp );
 extern EFI_DEVICE_PATH_PROTOCOL * efi_usb_path ( struct usb_function *func );
 
 extern EFI_DEVICE_PATH_PROTOCOL * efi_describe ( struct interface *interface );
diff --git a/src/include/ipxe/ib_srp.h b/src/include/ipxe/ib_srp.h
index ad407b0c..4b6df8d3 100644
--- a/src/include/ipxe/ib_srp.h
+++ b/src/include/ipxe/ib_srp.h
@@ -10,6 +10,8 @@
 FILE_LICENCE ( BSD2 );
 
 #include <stdint.h>
+#include <ipxe/acpi.h>
+#include <ipxe/interface.h>
 #include <ipxe/infiniband.h>
 #include <ipxe/srp.h>
 
@@ -55,4 +57,37 @@ struct sbft_ib_subtable {
 	uint8_t reserved[6];
 } __attribute__ (( packed ));
 
+/**
+ * An Infiniband SRP sBFT created by iPXE
+ */
+struct ipxe_ib_sbft {
+	/** The table header */
+	struct sbft_table table;
+	/** The SCSI subtable */
+	struct sbft_scsi_subtable scsi;
+	/** The SRP subtable */
+	struct sbft_srp_subtable srp;
+	/** The Infiniband subtable */
+	struct sbft_ib_subtable ib;
+};
+
+/** An Infiniband SRP device */
+struct ib_srp_device {
+	/** Reference count */
+	struct refcnt refcnt;
+
+	/** SRP transport interface */
+	struct interface srp;
+	/** CMRC interface */
+	struct interface cmrc;
+
+	/** Infiniband device */
+	struct ib_device *ibdev;
+
+	/** ACPI descriptor */
+	struct acpi_descriptor desc;
+	/** Boot firmware table parameters */
+	struct ipxe_ib_sbft sbft;
+};
+
 #endif /* _IPXE_IB_SRP_H */
diff --git a/src/interface/efi/efi_path.c b/src/interface/efi/efi_path.c
index 76b1e4da..bae0ac4b 100644
--- a/src/interface/efi/efi_path.c
+++ b/src/interface/efi/efi_path.c
@@ -28,6 +28,7 @@
 #include <ipxe/iscsi.h>
 #include <ipxe/aoe.h>
 #include <ipxe/fcp.h>
+#include <ipxe/ib_srp.h>
 #include <ipxe/usb.h>
 #include <ipxe/efi/efi.h>
 #include <ipxe/efi/efi_driver.h>
@@ -369,6 +370,60 @@ EFI_DEVICE_PATH_PROTOCOL * efi_fcp_path ( struct fcp_description *desc ) {
 }
 
 /**
+ * Construct EFI device path for Infiniband SRP device
+ *
+ * @v ib_srp		Infiniband SRP device
+ * @ret path		EFI device path, or NULL on error
+ */
+EFI_DEVICE_PATH_PROTOCOL * efi_ib_srp_path ( struct ib_srp_device *ib_srp ) {
+	const struct ipxe_ib_sbft *sbft = &ib_srp->sbft;
+	union ib_srp_target_port_id *id =
+		container_of ( &sbft->srp.target, union ib_srp_target_port_id,
+			       srp );
+	struct efi_device *efidev;
+	EFI_DEVICE_PATH_PROTOCOL *path;
+	INFINIBAND_DEVICE_PATH *ibpath;
+	EFI_DEVICE_PATH_PROTOCOL *end;
+	size_t prefix_len;
+	size_t len;
+
+	/* Find parent EFI device */
+	efidev = efidev_parent ( ib_srp->ibdev->dev );
+	if ( ! efidev )
+		return NULL;
+
+	/* Calculate device path length */
+	prefix_len = efi_path_len ( efidev->path );
+	len = ( prefix_len + sizeof ( *ibpath ) + sizeof ( *end ) );
+
+	/* Allocate device path */
+	path = zalloc ( len );
+	if ( ! path )
+		return NULL;
+
+	/* Construct device path */
+	memcpy ( path, efidev->path, prefix_len );
+	ibpath = ( ( ( void * ) path ) + prefix_len );
+	ibpath->Header.Type = MESSAGING_DEVICE_PATH;
+	ibpath->Header.SubType = MSG_INFINIBAND_DP;
+	ibpath->Header.Length[0] = sizeof ( *ibpath );
+	ibpath->ResourceFlags = INFINIBAND_RESOURCE_FLAG_STORAGE_PROTOCOL;
+	memcpy ( ibpath->PortGid, &sbft->ib.dgid, sizeof ( ibpath->PortGid ) );
+	memcpy ( &ibpath->ServiceId, &sbft->ib.service_id,
+		 sizeof ( ibpath->ServiceId ) );
+	memcpy ( &ibpath->TargetPortId, &id->ib.ioc_guid,
+		 sizeof ( ibpath->TargetPortId ) );
+	memcpy ( &ibpath->DeviceId, &id->ib.id_ext,
+		 sizeof ( ibpath->DeviceId ) );
+	end = ( ( ( void * ) ibpath ) + sizeof ( *ibpath ) );
+	end->Type = END_DEVICE_PATH_TYPE;
+	end->SubType = END_ENTIRE_DEVICE_PATH_SUBTYPE;
+	end->Length[0] = sizeof ( *end );
+
+	return path;
+}
+
+/**
  * Construct EFI device path for USB function
  *
  * @v func		USB function
diff --git a/src/net/infiniband/ib_srp.c b/src/net/infiniband/ib_srp.c
index 4913f449..e6b43291 100644
--- a/src/net/infiniband/ib_srp.c
+++ b/src/net/infiniband/ib_srp.c
@@ -37,6 +37,7 @@ FILE_LICENCE ( BSD2 );
 #include <ipxe/open.h>
 #include <ipxe/base16.h>
 #include <ipxe/acpi.h>
+#include <ipxe/efi/efi_path.h>
 #include <ipxe/srp.h>
 #include <ipxe/infiniband.h>
 #include <ipxe/ib_cmrc.h>
@@ -70,39 +71,6 @@ struct acpi_model ib_sbft_model __acpi_model;
  */
 
 /**
- * An IB SRP sBFT created by iPXE
- */
-struct ipxe_ib_sbft {
-	/** The table header */
-	struct sbft_table table;
-	/** The SCSI subtable */
-	struct sbft_scsi_subtable scsi;
-	/** The SRP subtable */
-	struct sbft_srp_subtable srp;
-	/** The Infiniband subtable */
-	struct sbft_ib_subtable ib;
-};
-
-/** An Infiniband SRP device */
-struct ib_srp_device {
-	/** Reference count */
-	struct refcnt refcnt;
-
-	/** SRP transport interface */
-	struct interface srp;
-	/** CMRC interface */
-	struct interface cmrc;
-
-	/** Infiniband device */
-	struct ib_device *ibdev;
-
-	/** ACPI descriptor */
-	struct acpi_descriptor desc;
-	/** Boot firmware table parameters */
-	struct ipxe_ib_sbft sbft;
-};
-
-/**
  * Free IB SRP device
  *
  * @v refcnt		Reference count
@@ -153,6 +121,7 @@ static struct interface_descriptor ib_srp_cmrc_desc =
 static struct interface_operation ib_srp_srp_op[] = {
 	INTF_OP ( acpi_describe, struct ib_srp_device *, ib_srp_describe ),
 	INTF_OP ( intf_close, struct ib_srp_device *, ib_srp_close ),
+	EFI_INTF_OP ( efi_describe, struct ib_srp_device *, efi_ib_srp_path ),
 };
 
 /** IB SRP SRP interface descriptor */