Issue 590 - Supoort both v1 and v2 of libgpiod.

Author: wb2osz

CHANGES.md

@@ -14,6 +14,8 @@
 
 - Include the direwolf icon in the Windows executable.  Note:  When building from source, environment variable RC must point to windres location.
 
+- Added support for libgpiod version 2.
+
 ## Version 1.7  --  October 2023
 
 ### New Documentation:

src/audio.h

@@ -331,7 +331,11 @@ struct audio_s {
 
 	        int ptt_invert;		/* Invert the output. */
 	        int ptt_invert2;	/* Invert the secondary output. */
-            gpio_num_t gpio_num;	/* Handle from libgpiod.  Valid only when ptt_method is PTT_METHOD_GPIOD. */
+#if USE_GPIOD
+#if LIBGPIOD_VERSION_MAJOR >= 2
+	        gpio_num_t gpio_num;	/* Handle from libgpiod.  Valid only when ptt_method is PTT_METHOD_GPIOD. */
+#endif
+#endif
 
 #ifdef USE_HAMLIB
 

src/direwolf.c

@@ -305,7 +305,7 @@ int main (int argc, char *argv[])
 	text_color_init(t_opt);
 	text_color_set(DW_COLOR_INFO);
 	//dw_printf ("Dire Wolf version %d.%d (%s) BETA TEST 7\n", MAJOR_VERSION, MINOR_VERSION, __DATE__);
-	dw_printf ("Dire Wolf DEVELOPMENT version %d.%d %s (%s)\n", MAJOR_VERSION, MINOR_VERSION, "D", __DATE__);
+	dw_printf ("Dire Wolf DEVELOPMENT version %d.%d %s (%s)\n", MAJOR_VERSION, MINOR_VERSION, "E", __DATE__);
 	//dw_printf ("Dire Wolf version %d.%d\n", MAJOR_VERSION, MINOR_VERSION);
 
 
@@ -321,7 +321,9 @@ int main (int argc, char *argv[])
 	dw_printf (" cm108-ptt");
  #endif
  #if defined(USE_GPIOD)
-	dw_printf (" libgpiod");
+ #define STRINGIFY(x) STRINGIFY2(x)
+ #define STRINGIFY2(x) #x
+        dw_printf (" libgpiod-%s", STRINGIFY(LIBGPIOD_VERSION));
  #endif
  #if (USE_AVAHI_CLIENT|USE_MACOS_DNSSD)
 	dw_printf (" dns-sd");

src/gpio_common.c

@@ -1,10 +1,40 @@
+/*------------------------------------------------------------------
+ *
+ * Module:      gpio_common.c
+ *
+ * Purpose:   	The libgpiod API changed drastically between v1 and v2, as first seen
+ *		in Debian 13 Trixie.
+ *		It is not possible to have the same application code work with both.
+ *		It is necessary to have two sets of code and conditional compilation.
+ *
+ * Environment:	Preprocessor symbols set by build system:
+ *		USE_GPIOD		to include the gpiod code
+ *		LIBGPIOD_VERSION	e.g. 1.2.3
+ *		LIBGPIOD_VERSION_MAJOR	e.g. 1
+ *		LIBGPIOD_VERSION_MINOR	e.g. 2
+ *
+ * Description:	Eventually we would like to put all of the version differences
+ *		in here to avoid cluttering ptt.c more than it is already.
+ *		Currently this is all version 2 code which has no hope of
+ *		building with version 1 library.
+ *
+ *---------------------------------------------------------------*/
+
+#if USE_GPIOD				// Skip all of this if no GPIOD libary present
+
+#if LIBGPIOD_VERSION_MAJOR >= 2		// Someday we might have v1 and v2 sections
+
+#include "direwolf.h"
+
 #include <gpiod.h>
 #include <stdio.h>
 #include <unistd.h>
 
 #include <errno.h>
 #include <string.h>
 
+#include "textcolor.h"
+
 #include "gpio_common.h"
 
 #define GPIO_MAX_LINES 32
@@ -25,7 +55,8 @@ static gpio_common_t gpio[GPIO_MAX_LINES];
 // Function implementations
 
 void gpio_common_init(void) {
-  fprintf(stderr, "Initializing GPIO common structure\n");
+  text_color_set(DW_COLOR_DEBUG);
+  dw_printf("Initializing GPIO common structure\n");
   for (gpio_num_t i = 0; i < GPIO_MAX_LINES; i++) {
     gpio[i].used = false;
   }
@@ -44,11 +75,13 @@ gpio_num_t gpio_common_open_line(const char *chip_name, unsigned int line, bool
   gpio_num = GPIO_COMMON_UNKNOWN;
 
   if (chip_name == NULL) {
-    fprintf(stderr, "No chip name supplied.\n");
+    text_color_set(DW_COLOR_ERROR);
+    dw_printf("No chip name supplied.\n");
     goto out;
   }
 
-  fprintf(stderr, "Opening GPIO line %d on chip %s\n", line, chip_name);
+  text_color_set(DW_COLOR_DEBUG);
+  dw_printf("Opening GPIO line %d on chip %s\n", line, chip_name);
 
   // Get a free slot
   for (gpio_num_t i = 0; i < GPIO_MAX_LINES; i++) {
@@ -59,22 +92,25 @@ gpio_num_t gpio_common_open_line(const char *chip_name, unsigned int line, bool
   }
 
   if (gpio_num == GPIO_COMMON_UNKNOWN) {
-    fprintf(stderr, "Too many GPIOs open.\n");
+    text_color_set(DW_COLOR_ERROR);
+    dw_printf("Too many GPIOs open.\n");
     goto out;
   }
 
   chip = gpiod_chip_open(chip_name);
 
   if (chip == NULL) {
-    fprintf(stderr, "Failed to open GPIO chip %s\n", chip_name);
+    text_color_set(DW_COLOR_ERROR);
+    dw_printf("Failed to open GPIO chip %s\n", chip_name);
     gpio_num = GPIO_COMMON_UNKNOWN;
     goto out;
   }
 
   settings = gpiod_line_settings_new();
 
   if (settings == NULL) {
-    fprintf(stderr, "Unable to allocate memory for line settings \n");
+    text_color_set(DW_COLOR_ERROR);
+    dw_printf("Unable to allocate memory for line settings \n");
     gpio_num = GPIO_COMMON_UNKNOWN;
     goto close_chip;
   }
@@ -93,8 +129,9 @@ gpio_num_t gpio_common_open_line(const char *chip_name, unsigned int line, bool
 
   ret = gpiod_line_config_add_line_settings(line_cfg, &line, 1,
 						  settings);
-	if (ret < 0) {
-    fprintf(stderr, "Failed to add line settings\n");
+  if (ret < 0) {
+    text_color_set(DW_COLOR_ERROR);
+    dw_printf("Failed to add line settings\n");
     gpio_num = GPIO_COMMON_UNKNOWN;
     goto free_line_config;
   }
@@ -104,12 +141,13 @@ gpio_num_t gpio_common_open_line(const char *chip_name, unsigned int line, bool
 		goto free_line_config;
   }
 
-  gpiod_request_config_set_consumer(req_cfg, "FLDIGI");
+  gpiod_request_config_set_consumer(req_cfg, GPIO_CONSUMER);
 
   gpio[gpio_num].request = gpiod_chip_request_lines(chip, req_cfg, line_cfg);
 
   if (gpio[gpio_num].request == NULL) {
-    fprintf(stderr, "Failed to request GPIO line %d\n", gpio_num);
+    text_color_set(DW_COLOR_ERROR);
+    dw_printf("Failed to request GPIO line %d\n", gpio_num);
     gpio_num = GPIO_COMMON_UNKNOWN;
     goto free_line_config;
   } else {
@@ -162,7 +200,8 @@ int gpio_common_set(gpio_num_t gpio_num, bool val) {
 
   int ret = gpiod_line_request_set_value(gpio[gpio_num].request, gpio[gpio_num].offset, gpiod_val);
   if (ret < 0) {
-    fprintf(stderr, "Error setting line\n");
+    text_color_set(DW_COLOR_ERROR);
+    dw_printf("Error setting line\n");
     return GPIO_COMMON_ERR;
   }
   return 0;
@@ -177,3 +216,9 @@ int gpio_common_close(void) {
 
   return 0;
 }
+
+#endif		// LIBGPIOD_VERSION_MAJOR >= 2
+
+#endif		// USE_GPIOD
+
+// end gpio_common.c

src/gpio_common.h

@@ -1,6 +1,9 @@
 #ifndef GPIO_COMMON_H
 #define GPIO_COMMON_H
 
+#if USE_GPIOD		// Skip all if no libgpiod available
+
+#if LIBGPIOD_VERSION_MAJOR >= 2		// Someday we might have v1 and v2 sections
 
 #ifdef __cplusplus
 extern "C" {
@@ -29,4 +32,8 @@ int gpio_common_set(gpio_num_t gpio_num, bool val);
 }
 #endif
 
+#endif		// LIBGPIOD_VERSION_MAJOR >= 2
+
+#endif 		// USE_GPIOD
+
 #endif // GPIO_COMMON_H

src/ptt.c

@@ -163,7 +163,11 @@
 #endif
 
 #ifdef USE_GPIOD
+#if LIBGPIOD_VERSION_MAJOR >= 2
 #include "gpio_common.h"
+#else
+#include <gpiod.h>
+#endif
 #endif
 
 /* So we can have more common code for fd. */
@@ -652,6 +656,42 @@ void export_gpio(int ch, int ot, int invert, int direction)
 	get_access_to_gpio (gpio_value_path);
 }
 
+#if defined(USE_GPIOD)
+
+// TODO:  Maybe move to gpio_common.c or rewrite.
+
+#if LIBGPIOD_VERSION_MAJOR == 1
+
+int gpiod_probe(const char *chip_dev_path, int line_number)
+{
+	// chip_dev_path must be complete device path such as /dev/gpiochip3
+
+	struct gpiod_chip *chip;
+	chip = gpiod_chip_open(chip_dev_path);
+	if (chip == NULL) {
+		text_color_set(DW_COLOR_ERROR);
+		dw_printf ("Can't open GPIOD chip %s.\n", chip_dev_path);
+		return -1;
+	}
+
+	struct gpiod_line *line;
+	line = gpiod_chip_get_line(chip, line_number);
+	if (line == NULL) {
+		text_color_set(DW_COLOR_ERROR);
+		dw_printf ("Can't get GPIOD line %d.\n", line_number);
+		return -1;
+	}
+	if (ptt_debug_level >= 2) {
+		text_color_set(DW_COLOR_DEBUG);
+		dw_printf("GPIOD probe OK. Chip: %s line: %d\n", chip_dev_path, line_number);
+	}
+	return 0;
+}
+
+#endif	// LIBGPIOD_VERSION_MAJOR == 1
+
+#endif	/* USE_GPIOD */
+
 #endif   /* not __WIN32__ */
 
 
@@ -725,8 +765,10 @@ void ptt_init (struct audio_s *audio_config_p)
 #endif
 
 #if USE_GPIOD
+#if LIBGPIOD_VERSION_MAJOR >= 2
 	gpio_common_init();
 #endif
+#endif
 
 #if DEBUG
 	text_color_set(DW_COLOR_DEBUG);
@@ -912,9 +954,15 @@ void ptt_init (struct audio_s *audio_config_p)
 	      if (audio_config_p->achan[ch].octrl[ot].ptt_method == PTT_METHOD_GPIOD) {
 	        const char *chip_name = audio_config_p->achan[ch].octrl[ot].out_gpio_name;
 	        int line_number = audio_config_p->achan[ch].octrl[ot].out_gpio_num;
-			audio_config_p->achan[ch].octrl[ot].gpio_num = gpio_common_open_line(chip_name, line_number, false);
+
+#if LIBGPIOD_VERSION_MAJOR >= 2
+	        audio_config_p->achan[ch].octrl[ot].gpio_num = gpio_common_open_line(chip_name, line_number, false);
 	        if (audio_config_p->achan[ch].octrl[ot].gpio_num == GPIO_COMMON_UNKNOWN) {
-                text_color_set(DW_COLOR_ERROR);
+#else
+	        int rc = gpiod_probe(chip_name, line_number);
+	        if (rc < 0) {
+#endif
+	          text_color_set(DW_COLOR_ERROR);
 		  //No, people won't notice the error message and be confused.  Just terminate.
 	          //dw_printf ("Disable PTT for channel %d\n", ch);
 	          //audio_config_p->achan[ch].octrl[ot].ptt_method = PTT_METHOD_NONE;
@@ -1371,7 +1419,13 @@ void ptt_set (int ot, int chan, int ptt_signal)
 	if (save_audio_config_p->achan[chan].octrl[ot].ptt_method == PTT_METHOD_GPIOD) {
 		const char *chip = save_audio_config_p->achan[chan].octrl[ot].out_gpio_name;
 		int line = save_audio_config_p->achan[chan].octrl[ot].out_gpio_num;
+
+
+#if LIBGPIOD_VERSION_MAJOR >= 2
 		int rc = gpio_common_set(save_audio_config_p->achan[chan].octrl[ot].gpio_num, ptt);
+#else
+		int rc = gpiod_ctxless_set_value(chip, line, ptt, false, "direwolf", NULL, NULL);
+#endif
 		if (ptt_debug_level >= 1) {
 			text_color_set(DW_COLOR_DEBUG);
 			dw_printf("PTT_METHOD_GPIOD chip: %s line: %d ptt: %d  rc: %d\n", chip, line, ptt, rc);