net: conn_mgr_connectivity: idle timeout parameter

Add an interface idle timeout parameter to the connectivity
binding structure. This will be used to track idle timeouts for
interfaces.

Signed-off-by: Jordan Yates <[email protected]>

Author: JordanYates

include/zephyr/net/conn_mgr_connectivity.h

@@ -44,6 +44,7 @@ extern "C" {
 enum {
 	NET_EVENT_CONN_CMD_IF_TIMEOUT_VAL,
 	NET_EVENT_CONN_CMD_IF_FATAL_ERROR_VAL,
+	NET_EVENT_CONN_CMD_IF_IDLE_TIMEOUT_VAL,
 
 	NET_EVENT_CONN_CMD_MAX
 };
@@ -54,6 +55,7 @@ BUILD_ASSERT(NET_EVENT_CONN_CMD_MAX <= NET_MGMT_MAX_COMMANDS,
 enum net_event_conn_cmd {
 	NET_MGMT_CMD(NET_EVENT_CONN_CMD_IF_TIMEOUT),
 	NET_MGMT_CMD(NET_EVENT_CONN_CMD_IF_FATAL_ERROR),
+	NET_MGMT_CMD(NET_EVENT_CONN_CMD_IF_IDLE_TIMEOUT),
 };
 
 /** @endcond */
@@ -70,6 +72,12 @@ enum net_event_conn_cmd {
 #define NET_EVENT_CONN_IF_FATAL_ERROR					\
 	(NET_MGMT_CONN_IF_EVENT | NET_EVENT_CONN_CMD_IF_FATAL_ERROR)
 
+/**
+ * @brief net_mgmt event raised when an interface times out due to inactivity
+ */
+#define NET_EVENT_CONN_IF_IDLE_TIMEOUT					\
+	(NET_MGMT_CONN_IF_EVENT | NET_EVENT_CONN_CMD_IF_IDLE_TIMEOUT)
+
 
 /**
  * @brief Per-iface connectivity flags
@@ -264,6 +272,32 @@ int conn_mgr_if_get_timeout(struct net_if *iface);
  */
 int conn_mgr_if_set_timeout(struct net_if *iface, int timeout);
 
+/**
+ * @brief Get the idle timeout for an iface
+ *
+ * If the provided iface is bound to a connectivity implementation, retrieves the idle timeout
+ * setting in seconds for it.
+ *
+ * @param iface - Pointer to the iface to check.
+ * @return int - The connectivity timeout value (in seconds) if it could be retrieved, otherwise
+ *		 CONN_MGR_IF_NO_TIMEOUT.
+ */
+int conn_mgr_if_get_idle_timeout(struct net_if *iface);
+
+/**
+ * @brief Set the idle timeout for an iface.
+ *
+ * If the provided iface is bound to a connectivity implementation, sets the idle timeout setting
+ * in seconds for it.
+ *
+ * @param iface - Pointer to the network interface to modify.
+ * @param timeout - The timeout value to set (in seconds).
+ *		    Pass @ref CONN_MGR_IF_NO_TIMEOUT to disable the timeout.
+ * @retval 0 on success.
+ * @retval -ENOTSUP if the provided iface is not bound to a connectivity implementation.
+ */
+int conn_mgr_if_set_idle_timeout(struct net_if *iface, int timeout);
+
 /**
  * @}
  */

include/zephyr/net/conn_mgr_connectivity_impl.h

@@ -193,6 +193,16 @@ struct conn_mgr_conn_binding {
 	 */
 	int timeout;
 
+	/**
+	 * Usage timeout (seconds)
+	 *
+	 * Indicates to the connectivity implementation how long the interface can be idle
+	 * for before automatically taking the interface down.
+	 *
+	 * Set to @ref CONN_MGR_IF_NO_TIMEOUT to indicate that no idle timeout should be used.
+	 */
+	int idle_timeout;
+
 	/** @} */
 
 /** @cond INTERNAL_HIDDEN */

subsys/net/conn_mgr/conn_mgr_connectivity.c

@@ -197,7 +197,7 @@ int conn_mgr_if_get_timeout(struct net_if *iface)
 	int value;
 
 	if (binding == NULL) {
-		return false;
+		return CONN_MGR_IF_NO_TIMEOUT;
 	}
 
 	conn_mgr_binding_lock(binding);
@@ -226,6 +226,41 @@ int conn_mgr_if_set_timeout(struct net_if *iface, int timeout)
 	return 0;
 }
 
+int conn_mgr_if_get_idle_timeout(struct net_if *iface)
+{
+	struct conn_mgr_conn_binding *binding = conn_mgr_if_get_binding(iface);
+	int value;
+
+	if (binding == NULL) {
+		return CONN_MGR_IF_NO_TIMEOUT;
+	}
+
+	conn_mgr_binding_lock(binding);
+
+	value = binding->idle_timeout;
+
+	conn_mgr_binding_unlock(binding);
+
+	return value;
+}
+
+int conn_mgr_if_set_idle_timeout(struct net_if *iface, int timeout)
+{
+	struct conn_mgr_conn_binding *binding = conn_mgr_if_get_binding(iface);
+
+	if (binding == NULL) {
+		return -ENOTSUP;
+	}
+
+	conn_mgr_binding_lock(binding);
+
+	binding->idle_timeout = timeout;
+
+	conn_mgr_binding_unlock(binding);
+
+	return 0;
+}
+
 /* Automated behavior handling */
 
 /**
@@ -375,6 +410,7 @@ void conn_mgr_conn_init(void)
 			/* Set initial default values for binding state */
 
 			binding->timeout = CONN_MGR_IF_NO_TIMEOUT;
+			binding->idle_timeout = CONN_MGR_IF_NO_TIMEOUT;
 
 			/* Call binding initializer */