drivers/*.c, NEWS.adoc: update drivers to use reconnect_trying() with enum arg values for consistent reporting [#3541]

Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>

Author: jimklimov

NEWS.adoc

@@ -159,7 +159,8 @@ https://github.com/networkupstools/nut/milestone/13
     * Introduced a `reconnect_max_tries` setting for NUT drivers, so they can
       be configured to exit after the specified number of reconnection attempts
       (so that the OS service management facility can completely recycle the
-      driver program). [#3541]
+      driver program). Multiple drivers updated to use the new facility to
+      consistently report `reconnect_trying()` states. [#3541]
 
  - NUT client libraries:
     * Complete support for actions documented in `docs/net-protocol.txt`

drivers/adelsystem_cbi.c

@@ -34,7 +34,7 @@
 #endif
 
 #define DRIVER_NAME	"NUT ADELSYSTEM DC-UPS CB/CBI driver (libmodbus link type: " NUT_MODBUS_LINKTYPE_STR ")"
-#define DRIVER_VERSION	"0.08"
+#define DRIVER_VERSION	"0.09"
 
 /* variables */
 static modbus_t *mbctx = NULL;							/* modbus memory context */
@@ -1330,7 +1330,7 @@ void modbus_reconnect(void)
 	int rval;
 
 	upsdebugx(1, "modbus_reconnect, trying to reconnect to modbus server");
-	dstate_setinfo("driver.state", "reconnect.trying");
+	reconnect_trying(RECONNECT_TRYING);
 
 	/* clear current modbus context */
 	modbus_close(mbctx);
@@ -1391,5 +1391,5 @@ void modbus_reconnect(void)
 /* #elif (defined NUT_MODBUS_TIMEOUT_ARG_timeval) // some un-castable type in fields */
 #endif /* NUT_MODBUS_TIMEOUT_ARG_* */
 
-	dstate_setinfo("driver.state", "quiet");
+	reconnect_trying(RECONNECT_SUCCESS);
 }

drivers/apc_modbus.c

@@ -43,7 +43,7 @@
 #endif
 
 #define DRIVER_NAME	"NUT APC Modbus driver " DRIVER_NAME_NUT_MODBUS_HAS_USB_WITH_STR " USB support (libmodbus link type: " NUT_MODBUS_LINKTYPE_STR ")"
-#define DRIVER_VERSION	"0.20"
+#define DRIVER_VERSION	"0.21"
 
 #if defined NUT_MODBUS_HAS_USB
 
@@ -955,7 +955,7 @@ static void _apc_modbus_create_reopen_matcher(void)
 
 static int _apc_modbus_reopen(void)
 {
-	dstate_setinfo("driver.state", "reconnect.trying");
+	reconnect_trying(RECONNECT_TRYING);
 
 	if (modbus_connect(modbus_ctx) < 0) {
 		upslogx(LOG_ERR, "%s: Unable to connect Modbus: %s", __func__, modbus_strerror(errno));
@@ -975,9 +975,10 @@ static int _apc_modbus_reopen(void)
 
 	is_open = 1;
 
-	dstate_setinfo("driver.state", "reconnect.updateinfo");
+	reconnect_trying(RECONNECT_UPDATEINFO);
 	_apc_modbus_read_inventory();
-	dstate_setinfo("driver.state", "quiet");
+
+	reconnect_trying(RECONNECT_SUCCESS);
 
 	return 1;
 }

drivers/apcsmart.c

@@ -38,7 +38,7 @@
 #include "apcsmart_tabs.h"
 
 #define DRIVER_NAME	"APC Smart protocol driver"
-#define DRIVER_VERSION	"3.39"
+#define DRIVER_VERSION	"3.40"
 
 #ifdef WIN32
 # ifndef ECANCELED
@@ -2395,7 +2395,7 @@ void upsdrv_updateinfo(void)
 		/* become aggressive after a few tries */
 		if (!(last_worked % 60)) {
 			upslogx(LOG_WARNING, "Trying to reconnect to the UPS");
-			dstate_setinfo("driver.state", "reconnect.trying");
+			reconnect_trying(RECONNECT_TRYING);
 
 			upsdebugx(1, "%s: call upsdrv_cleanup", __func__);
 			/* dstate_setinfo("driver.state", "cleanup.upsdrv"); */
@@ -2413,11 +2413,11 @@ void upsdrv_updateinfo(void)
 			upsdrv_initinfo();
 
 			upsdebugx(1, "%s: call upsdrv_updateinfo", __func__);
-			dstate_setinfo("driver.state", "reconnect.updateinfo");
+			reconnect_trying(RECONNECT_UPDATEINFO);
 			/* dstate_setinfo("driver.state", "init.updateinfo"); */
 			upsdrv_updateinfo();
 
-			dstate_setinfo("driver.state", "init.quiet");
+			reconnect_trying(RECONNECT_SUCCESS);
 		}
 
 		upsdebugx(1, "%s: nudging UPS with 'Y', iteration #%d ...",

drivers/bcmxcp_usb.c

@@ -11,7 +11,7 @@
 #include <unistd.h>
 
 #define SUBDRIVER_NAME    "USB communication subdriver"
-#define SUBDRIVER_VERSION "0.28"
+#define SUBDRIVER_VERSION "0.29"
 
 /* communication driver description structure */
 upsdrv_info_t comm_upsdrv_info = {
@@ -385,7 +385,7 @@ void upsdrv_cleanup(void)
 
 void upsdrv_reconnect(void)
 {
-	dstate_setinfo("driver.state", "reconnect.trying");
+	reconnect_trying(RECONNECT_TRYING);
 
 	upsdebugx(4, "==================================================");
 	upsdebugx(4, "= device has been disconnected, try to reconnect =");
@@ -396,7 +396,12 @@ void upsdrv_reconnect(void)
 
 	upsdrv_initups();
 
-	dstate_setinfo("driver.state", "quiet");
+	if (upsdev) {
+		reconnect_trying(RECONNECT_SUCCESS);
+		/* dstate_dataok() is called in bcmxcp.c::upsdrv_updateinfo() */
+	} else {
+		dstate_datastale();
+	}
 }
 
 /* USB functions */

drivers/blazer_usb.c

@@ -37,7 +37,7 @@
 #endif	/* WIN32 */
 
 #define DRIVER_NAME	"Megatec/Q1 protocol USB driver"
-#define DRIVER_VERSION	"0.25"
+#define DRIVER_VERSION	"0.26"
 
 /* driver description structure */
 upsdrv_info_t upsdrv_info = {
@@ -483,21 +483,27 @@ ssize_t blazer_command(const char *cmd, char *buf, size_t buflen)
 {
 #ifndef TESTING
 	ssize_t	ret;
+	int	reconnecting = (udev == NULL);
 
-	if (udev == NULL) {
-		dstate_setinfo("driver.state", "reconnect.trying");
+	if (reconnecting) {
+		reconnect_trying(RECONNECT_TRYING);
 
 		ret = usb->open_dev(&udev, &usbdevice, reopen_matcher, NULL);
 
 		if (ret < 1) {
+			/* dstate_datastale/dstate_dataok managed in blazer.c::upsdrv_updateinfo() */
 			return ret;
 		}
 
-		dstate_setinfo("driver.state", "reconnect.updateinfo");
+		reconnect_trying(RECONNECT_UPDATEINFO);
 	}
 
 	ret = (*subdriver_command)(cmd, buf, buflen);
 	if (ret >= 0) {
+		/* clean read: forget any overflow streak */
+		if (reconnecting) {
+			reconnect_trying(RECONNECT_SUCCESS);
+		}
 		return ret;
 	}
 
@@ -540,6 +546,8 @@ ssize_t blazer_command(const char *cmd, char *buf, size_t buflen)
 	case LIBUSB_ERROR_NOT_FOUND:		/* No such file or directory */
 	fallthrough_case_reconnect:
 		/* Uh oh, got to reconnect! */
+		/* Not accounting just yet with reconnect_trying(RECONNECT_TRYING),
+		 * to avoid off-by-one counter errors */
 		dstate_setinfo("driver.state", "reconnect.trying");
 		usb->close_dev(udev);
 		udev = NULL;
@@ -558,6 +566,14 @@ ssize_t blazer_command(const char *cmd, char *buf, size_t buflen)
 		break;
 	}
 
+	if (reconnecting) {
+		/* Success after updateinfo in the bulk of this method body */
+		upsdebugx(1, "%s: libusb returned %" PRIiSIZE
+			" which was not classified as a known error, assuming reconnection succeeded",
+			__func__, ret);
+		reconnect_trying(RECONNECT_SUCCESS);
+	}
+
 	return ret;
 #else	/* if TESTING: */
 	const struct {

drivers/generic_modbus.c

@@ -31,7 +31,7 @@
 #endif
 
 #define DRIVER_NAME	"NUT Generic Modbus driver (libmodbus link type: " NUT_MODBUS_LINKTYPE_STR ")"
-#define DRIVER_VERSION	"0.10"
+#define DRIVER_VERSION	"0.11"
 
 /* variables */
 static modbus_t *mbctx = NULL;                             /* modbus memory context */
@@ -1063,7 +1063,7 @@ void modbus_reconnect(void)
 	int rval;
 
 	upsdebugx(2, "modbus_reconnect, trying to reconnect to modbus server");
-	dstate_setinfo("driver.state", "reconnect.trying");
+	reconnect_trying(RECONNECT_TRYING);
 
 	/* clear current modbus context */
 	modbus_close(mbctx);
@@ -1124,5 +1124,5 @@ void modbus_reconnect(void)
 /* #elif (defined NUT_MODBUS_TIMEOUT_ARG_timeval) // some un-castable type in fields */
 #endif /* NUT_MODBUS_TIMEOUT_ARG_* */
 
-	dstate_setinfo("driver.state", "quiet");
+	reconnect_trying(RECONNECT_SUCCESS);
 }

drivers/nhs_ser.c

@@ -4,7 +4,7 @@
  *
  * Copyright (C) 2024   Lucas Willian Bocchi <lucas@lucas.inf.br>
  *     Initial Release (as nhs-nut.c)
- * Copyright (C) 2024 - 2025 Jim Klimov <jimklimov+nut@gmail.com>
+ * Copyright (C) 2024 - 2026 Jim Klimov <jimklimov+nut@gmail.com>
  *     Codebase adjusted to NUT standards
  *
  * This program is free software; you can redistribute it and/or modify
@@ -43,7 +43,7 @@
 #include <math.h>
 
 #define DRIVER_NAME	"NHS Nobreak Drivers"
-#define DRIVER_VERSION	"0.04"
+#define DRIVER_VERSION	"0.05"
 #define MANUFACTURER	"NHS Sistemas Eletronicos LTDA"
 
 #define DEFAULTBAUD	2400
@@ -1706,7 +1706,7 @@ static unsigned int get_numbat(void) {
 
 /* Return serial_fd after the reconnection attempt, for easier calls */
 static int reconnect_ups_if_needed(void) {
-	/* retries to open port */
+	/* retries to open port until we declare "data stale" loudly */
 	static unsigned int	retries = 0;
 
 	/* If comms failed earlier, try to resuscitate */
@@ -1715,7 +1715,7 @@ static int reconnect_ups_if_needed(void) {
 			__func__, porta);
 
 		/* Uh oh, got to reconnect! */
-		dstate_setinfo("driver.state", "reconnect.trying");
+		reconnect_trying(RECONNECT_TRYING);
 
 		while (serial_fd <= 0) {
 			upsdebugx(1, "%s: Trying to reopen serial...", __func__);
@@ -1732,7 +1732,7 @@ static int reconnect_ups_if_needed(void) {
 				upslogx(LOG_NOTICE, "Communications with UPS re-established");
 			}
 			retries = 0;
-			dstate_setinfo("driver.state", "quiet");
+			reconnect_trying(RECONNECT_SUCCESS);
 		} else {
 			if (retries == MAXTRIES) {
 				upslogx(LOG_WARNING, "Communications with UPS lost: port reopen failed!");

drivers/nutdrv_qx.c

@@ -58,7 +58,7 @@
 #	define DRIVER_NAME	"Generic Q* Serial driver"
 #endif	/* QX_USB */
 
-#define DRIVER_VERSION	"0.52"
+#define DRIVER_VERSION	"0.53"
 
 #ifdef QX_SERIAL
 #	include "serial.h"
@@ -3908,6 +3908,7 @@ static ssize_t	qx_command(const char *cmd, size_t cmdlen, char *buf, size_t bufl
 	/* Persists across calls; only consecutive overflows accumulate (any clean
 	 * read zeroes it, see the switch on `ret` below). */
 	static int	overflow_tries = 0;
+	int	reconnecting = (udev == NULL);
 # endif
 #endif
 
@@ -3927,22 +3928,25 @@ static ssize_t	qx_command(const char *cmd, size_t cmdlen, char *buf, size_t bufl
 	if (is_usb) {
 #  endif	/* QX_SERIAL (&& QX_USB)*/
 
-		if (udev == NULL) {
-			dstate_setinfo("driver.state", "reconnect.trying");
+		if (reconnecting) {
+			reconnect_trying(RECONNECT_TRYING);
 
 			ret = usb->open_dev(&udev, &usbdevice, reopen_matcher, NULL);
 
 			if (ret < 1) {
 				return ret;
 			}
 
-			dstate_setinfo("driver.state", "reconnect.updateinfo");
+			reconnect_trying(RECONNECT_UPDATEINFO);
 		}
 
 		ret = (*subdriver_command)(cmd, cmdlen, buf, buflen);
 
 		if (ret >= 0) {
 			overflow_tries = 0;	/* clean read: forget any overflow streak */
+			if (reconnecting) {
+				reconnect_trying(RECONNECT_SUCCESS);
+			}
 			return ret;
 		}
 
@@ -3999,6 +4003,8 @@ static ssize_t	qx_command(const char *cmd, size_t cmdlen, char *buf, size_t bufl
 		case LIBUSB_ERROR_NOT_FOUND:	/* No such file or directory */
 		fallthrough_case_reconnect:
 			/* Uh oh, got to reconnect! */
+			/* Not accounting just yet with reconnect_trying(RECONNECT_TRYING),
+			 * to avoid off-by-one counter errors */
 			dstate_setinfo("driver.state", "reconnect.trying");
 			usb->close_dev(udev);
 			udev = NULL;
@@ -4031,6 +4037,14 @@ static ssize_t	qx_command(const char *cmd, size_t cmdlen, char *buf, size_t bufl
 			break;
 		}
 
+		if (reconnecting) {
+			/* Success after updateinfo in the bulk of this method body */
+			upsdebugx(1, "%s: libusb returned %" PRIiSIZE
+				" which was not classified as a known error, assuming reconnection succeeded",
+				__func__, ret);
+			reconnect_trying(RECONNECT_SUCCESS);
+		}
+
 #  ifdef QX_SERIAL
 	/* Communication: serial */
 	} else {	/* !is_usb */
@@ -4045,6 +4059,7 @@ static ssize_t	qx_command(const char *cmd, size_t cmdlen, char *buf, size_t bufl
 		ret = ser_send_buf(upsfd, cmd, cmdlen);
 
 		if (ret <= 0) {
+			/* TOTHINK: Is any special reconnect logic/tracking needed? */
 			upsdebugx(3, "send: %s (%" PRIiSIZE ")",
 				ret ? strerror(errno) : "timeout", ret);
 			return ret;

drivers/powerman-pdu.c

@@ -23,7 +23,7 @@
 #include <libpowerman.h>	/* pm_err_t and other beasts */
 
 #define DRIVER_NAME	"Powerman PDU client driver"
-#define DRIVER_VERSION	"0.17"
+#define DRIVER_VERSION	"0.18"
 
 /* driver description structure */
 upsdrv_info_t upsdrv_info = {
@@ -218,7 +218,7 @@ static int reconnect_ups(void)
 {
 	pm_err_t rv;
 
-	dstate_setinfo("driver.state", "reconnect.trying");
+	reconnect_trying(RECONNECT_TRYING);
 
 	upsdebugx(4, "===================================================");
 	upsdebugx(4, "= connection lost with Powerman, try to reconnect =");
@@ -228,10 +228,11 @@ static int reconnect_ups(void)
 	pm_disconnect(pm);
 
 	/* Connect to the PowerMan daemon */
-	if ((rv = pm_connect(device_path, NULL, &pm, 0)) != PM_ESUCCESS)
+	if ((rv = pm_connect(device_path, NULL, &pm, 0)) != PM_ESUCCESS) {
+		dstate_datastale();
 		return 0;
-	else {
-		dstate_setinfo("driver.state", "quiet");
+	} else {
+		reconnect_trying(RECONNECT_SUCCESS);
 		upsdebugx(4, "connection restored with Powerman");
 		return 1;
 	}