From 81c80c8ba9e7ba053f2571a1945581b70f310b4d Mon Sep 17 00:00:00 2001
From: Michael Brown <mcb30@ipxe.org>
Date: Wed, 8 Jul 2015 16:24:11 +0100
Subject: [PATCH] [interface] Add intf_poke() helper

Reduce the cost of implementing object methods which convey no
information beyond the fact that the method has been called.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
---
 src/core/interface.c         | 25 +++++++++++++++++++++++++
 src/include/ipxe/interface.h |  5 +++++
 2 files changed, 30 insertions(+)

diff --git a/src/core/interface.c b/src/core/interface.c
index 400fac14..ba148c13 100644
--- a/src/core/interface.c
+++ b/src/core/interface.c
@@ -311,3 +311,28 @@ void intf_restart ( struct interface *intf, int rc ) {
 	 */
 	intf->desc = desc;
 }
+
+/**
+ * Poke an object interface
+ *
+ * @v intf		Object interface
+ * @v type		Operation type
+ *
+ * This is a helper function to implement methods which take no
+ * parameters and return nothing.
+ */
+void intf_poke ( struct interface *intf,
+		 void ( type ) ( struct interface *intf ) ) {
+	struct interface *dest;
+	intf_poke_TYPE ( void * ) *op =
+		intf_get_dest_op_untyped ( intf, type, &dest );
+	void *object = intf_object ( dest );
+
+	if ( op ) {
+		op ( object );
+	} else {
+		/* Default is to do nothing */
+	}
+
+	intf_put ( dest );
+}
diff --git a/src/include/ipxe/interface.h b/src/include/ipxe/interface.h
index efb83746..a8d82377 100644
--- a/src/include/ipxe/interface.h
+++ b/src/include/ipxe/interface.h
@@ -145,6 +145,11 @@ extern void intf_close ( struct interface *intf, int rc );
 extern void intf_shutdown ( struct interface *intf, int rc );
 extern void intf_restart ( struct interface *intf, int rc );
 
+extern void intf_poke ( struct interface *intf,
+			void ( type ) ( struct interface *intf ) );
+#define intf_poke_TYPE( object_type ) \
+	typeof ( void ( object_type ) )
+
 extern struct interface_descriptor null_intf_desc;
 extern struct interface null_intf;