Merge branch 'leventelist-gpiod_support2' into dev

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/CMakeLists.txt

@@ -104,6 +104,7 @@ list(APPEND direwolf_SOURCES
   dwgpsnmea.c
   dwgpsd.c
   mheard.c
+  gpio_common.c
   )
 
 if(LINUX)

src/audio.h

@@ -5,7 +5,7 @@
  *
  * Purpose:   	Interface to audio device commonly called a "sound card"
  *		for historical reasons.
- *		
+ *
  *---------------------------------------------------------------*/
 
 
@@ -19,13 +19,14 @@
 #include "direwolf.h"		/* for MAX_RADIO_CHANS and MAX_TOTAL_CHANS used throughout the application. */
 #include "ax25_pad.h"		/* for AX25_MAX_ADDR_LEN */
 #include "version.h"
-				
+#include "gpio_common.h"
+
 
 /*
- * PTT control. 
+ * PTT control.
  */
 
-enum ptt_method_e { 
+enum ptt_method_e {
 	PTT_METHOD_NONE,	/* VOX or no transmit. */
 	PTT_METHOD_SERIAL,	/* Serial port RTS or DTR. */
 	PTT_METHOD_GPIO,	/* General purpose I/O using sysfs, deprecated after 2020, Linux only. */
@@ -63,7 +64,7 @@ enum medium_e { MEDIUM_NONE = 0,	// Channel is not valid for use.
 
 
 typedef enum sanity_e { SANITY_APRS, SANITY_AX25, SANITY_NONE } sanity_t;
-			 
+
 
 struct audio_s {
 
@@ -276,7 +277,7 @@ struct audio_s {
 
 
 	/* Additional properties for transmit. */
-	
+
 	/* Originally we had control outputs only for PTT. */
 	/* In version 1.2, we generalize this to allow others such as DCD. */
 	/* In version 1.4 we add CON for connected to another station. */
@@ -288,8 +289,8 @@ struct audio_s {
 #define OCTYPE_CON 2
 
 #define NUM_OCTYPES 3		/* number of values above.   i.e. last value +1. */
-	
-	    struct {  		
+
+	    struct {
 
 	        ptt_method_t ptt_method; /* none, serial port, GPIO, LPT, HAMLIB, CM108. */
 
@@ -304,7 +305,7 @@ struct audio_s {
 					/* have a name like /dev/hidraw1 for Linux or */
 					/* \\?\hid#vid_0d8c&pid_0008&mi_03#8&39d3555&0&0000#{4d1e55b2-f16f-11cf-88cb-001111000030} */
 					/* for Windows.  Largest observed was 95 but add some extra to be safe. */
-			
+
 	        ptt_line_t ptt_line;	/* Control line when using serial port. PTT_LINE_RTS, PTT_LINE_DTR. */
 	        ptt_line_t ptt_line2;	/* Optional second one:  PTT_LINE_NONE when not used. */
 
@@ -330,6 +331,11 @@ struct audio_s {
 
 	        int ptt_invert;		/* Invert the output. */
 	        int ptt_invert2;	/* Invert the secondary output. */
+#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

@@ -0,0 +1,224 @@
+/*------------------------------------------------------------------
+ *
+ * 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
+#define GPIO_CONSUMER "DIREWOLF"
+
+//Types
+typedef struct gpio_common {
+  struct gpiod_line_request *request;
+  unsigned int offset;
+  bool used;
+} gpio_common_t;
+
+// local variables
+
+static gpio_common_t gpio[GPIO_MAX_LINES];
+
+
+// Function implementations
+
+void gpio_common_init(void) {
+  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;
+  }
+}
+
+
+gpio_num_t gpio_common_open_line(const char *chip_name, unsigned int line, bool active_low) {
+  gpio_num_t gpio_num;
+  int ret;
+
+  struct gpiod_request_config *req_cfg = NULL;
+	struct gpiod_line_settings *settings;
+	struct gpiod_line_config *line_cfg;
+	struct gpiod_chip *chip;
+
+  gpio_num = GPIO_COMMON_UNKNOWN;
+
+  if (chip_name == NULL) {
+    text_color_set(DW_COLOR_ERROR);
+    dw_printf("No chip name supplied.\n");
+    goto out;
+  }
+
+  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++) {
+    if (gpio[i].used == false) {
+      gpio_num = i;
+      break;
+    }
+  }
+
+  if (gpio_num == GPIO_COMMON_UNKNOWN) {
+    text_color_set(DW_COLOR_ERROR);
+    dw_printf("Too many GPIOs open.\n");
+    goto out;
+  }
+
+  chip = gpiod_chip_open(chip_name);
+
+  if (chip == NULL) {
+    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) {
+    text_color_set(DW_COLOR_ERROR);
+    dw_printf("Unable to allocate memory for line settings \n");
+    gpio_num = GPIO_COMMON_UNKNOWN;
+    goto close_chip;
+  }
+
+  gpiod_line_settings_set_direction(settings,
+					  GPIOD_LINE_DIRECTION_OUTPUT);
+	gpiod_line_settings_set_output_value(settings, 0);
+  gpiod_line_settings_set_active_low(settings, active_low);
+
+  line_cfg = gpiod_line_config_new();
+
+  if (!line_cfg) {
+    gpio_num = GPIO_COMMON_UNKNOWN;
+    goto free_settings;
+  }
+
+  ret = gpiod_line_config_add_line_settings(line_cfg, &line, 1,
+						  settings);
+  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;
+  }
+
+  req_cfg = gpiod_request_config_new();
+	if (!req_cfg) {
+		goto free_line_config;
+  }
+
+  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) {
+    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 {
+    gpio[gpio_num].used = true;
+    gpio[gpio_num].offset = line;
+  }
+
+free_line_config:
+	gpiod_line_config_free(line_cfg);
+
+free_settings:
+	gpiod_line_settings_free(settings);
+
+close_chip:
+	gpiod_chip_close(chip);
+
+
+out:
+
+  return gpio_num;
+}
+
+
+int gpio_common_release_line(gpio_num_t gpio_num) {
+  if (gpio_num >= GPIO_MAX_LINES) {
+    return GPIO_COMMON_ERR;
+  }
+
+  if (gpio[gpio_num].request != NULL) {
+    gpiod_line_request_release(gpio[gpio_num].request);
+    gpio[gpio_num].request = NULL;
+  }
+
+  return 0;
+}
+
+
+int gpio_common_set(gpio_num_t gpio_num, bool val) {
+  if (gpio_num >= GPIO_MAX_LINES || gpio[gpio_num].request == NULL) {
+    return GPIO_COMMON_ERR;
+  }
+  uint16_t gpiod_val;
+
+  if (val) {
+    gpiod_val = GPIOD_LINE_VALUE_ACTIVE;
+  } else {
+    gpiod_val = GPIOD_LINE_VALUE_INACTIVE;
+  }
+
+
+  int ret = gpiod_line_request_set_value(gpio[gpio_num].request, gpio[gpio_num].offset, gpiod_val);
+  if (ret < 0) {
+    text_color_set(DW_COLOR_ERROR);
+    dw_printf("Error setting line\n");
+    return GPIO_COMMON_ERR;
+  }
+  return 0;
+}
+
+
+int gpio_common_close(void) {
+
+  for (gpio_num_t i = 0; i < GPIO_MAX_LINES; i++) {
+    gpio_common_release_line(i);
+  }
+
+  return 0;
+}
+
+#endif		// LIBGPIOD_VERSION_MAJOR >= 2
+
+#endif		// USE_GPIOD
+
+// end gpio_common.c

src/gpio_common.h

@@ -0,0 +1,39 @@
+#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" {
+#endif
+
+#include <gpiod.h>
+#include <stdint.h>
+
+// Types
+typedef uint16_t gpio_num_t;
+
+// Return values
+#define GPIO_COMMON_UNKNOWN           UINT16_MAX
+#define GPIO_COMMON_OK                0
+#define GPIO_COMMON_ERR               -1
+
+
+// Public functions
+
+void gpio_common_init(void);
+gpio_num_t gpio_common_open_line(const char *chip_name, unsigned int line, bool active_low);
+int gpio_common_close(void);
+int gpio_common_set(gpio_num_t gpio_num, bool val);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif		// LIBGPIOD_VERSION_MAJOR >= 2
+
+#endif 		// USE_GPIOD
+
+#endif // GPIO_COMMON_H