Add serial port discovery

CMakeLists.txt

@@ -125,6 +125,7 @@ if(USE_STATIC_LIBS)
     set(PREFERRED_LIBFTDI libftdi.a ftdi)
     set(PREFERRED_LIBFTDI1 libftdi1.a ftdi1)
     set(PREFERRED_LIBREADLINE libreadline.a)
+    set(PREFERRED_LIBSERIALPORT libserialport.a)
     set(PREFERRED_LIBGPIOD libgpiod.a gpiod)
 else()
     set(PREFERRED_LIBELF elf)
@@ -134,6 +135,7 @@ else()
     set(PREFERRED_LIBFTDI ftdi)
     set(PREFERRED_LIBFTDI1 ftdi1)
     set(PREFERRED_LIBREADLINE readline)
+    set(PREFERRED_LIBSERIALPORT serialport)
     set(PREFERRED_LIBGPIOD gpiod)
 endif()
 
@@ -225,6 +227,15 @@ elseif(MSVC)
     set(HAVE_LIBREADLINE 1)
 endif()
 
+#-------------------------------------
+# Find libserialport
+
+find_library(HAVE_LIBSERIALPORT NAMES ${PREFERRED_LIBSERIALPORT})
+if(HAVE_LIBSERIALPORT)
+    set(LIB_LIBSERIALPORT ${HAVE_LIBSERIALPORT})
+    set(HAVE_LIBSERIALPORT 1)
+endif()
+
 # -------------------------------------
 # Find libgpiod, if needed
 if(HAVE_LINUXGPIO)
@@ -319,6 +330,7 @@ if (DEBUG_CMAKE)
     message(STATUS "HAVE_LIBFTDI: ${HAVE_LIBFTDI}")
     message(STATUS "HAVE_LIBFTDI1: ${HAVE_LIBFTDI1}")
     message(STATUS "HAVE_LIBREADLINE: ${HAVE_LIBREADLINE}")
+    message(STATUS "HAVE_LIBSERIALPORT: ${HAVE_LIBSERIALPORT}")
     message(STATUS "HAVE_LIBELF_H: ${HAVE_LIBELF_H}")
     message(STATUS "HAVE_LIBELF_LIBELF_H: ${HAVE_LIBELF_LIBELF_H}")
     message(STATUS "HAVE_USB_H: ${HAVE_USB_H}")
@@ -377,6 +389,12 @@ else()
     message(STATUS "DON'T HAVE libreadline")
 endif()
 
+if(HAVE_LIBSERIALPORT)
+    message(STATUS "DO HAVE    libserialport")
+else()
+    message(STATUS "DON'T HAVE libserialport")
+endif()
+
 if(BUILD_DOC)
 	message(STATUS "ENABLED    doc")
 else()

src/cmake_config.h.in

@@ -99,3 +99,6 @@
 
 /* Define to 1 if you have the `readline' library (-lreadline). */
 #cmakedefine HAVE_LIBREADLINE 1
+
+/* Define to 1 if you have the `serialport' library */
+#cmakedefine HAVE_LIBSERIALPORT 1

src/configure.ac

@@ -185,6 +185,18 @@ if test x$have_libhidapi = xyes; then
 fi
 AC_SUBST(LIBHIDAPI, $LIBHIDAPI)
 
+AH_TEMPLATE([HAVE_LIBSERIALPORT],
+            [Define if libserialport is found])
+AC_CHECK_LIB([serialport], [sp_open], [have_libserialport=yes])
+if test x$have_libserialport = xyes; then
+   case $target in
+       *)
+               LIBSERIALPORT="-lserialport"
+               ;;
+   esac
+   AC_DEFINE([HAVE_LIBSERIALPORT])
+   AC_CHECK_HEADERS([libserialport.h])
+fi
 
 AH_TEMPLATE([HAVE_LIBFTDI1],
             [Define if FTDI support is enabled via libftdi1])
@@ -604,6 +616,12 @@ else
    echo "DON'T HAVE libreadline"
 fi
 
+if test x$have_libserialport = xyes; then
+   echo "DO HAVE    libserialport"
+else
+   echo "DON'T HAVE libserialport"
+fi
+
 if test x$have_pthread = xyes; then
    echo "DO HAVE    pthread"
 else

src/libavrdude.h

@@ -1249,6 +1249,9 @@ typedef struct {
 extern "C" {
 #endif
 
+int find_serialport_adapter(const SERIALADAPTER *ser, char *port, char *sernum);
+int find_serialport_vid_pid(char *port, int vid, int pid, char *sernum);
+
 int str_starts(const char *str, const char *starts);
 int str_eq(const char *str1, const char *str2);
 int str_contains(const char *str, const char *substr);

src/main.c

@@ -1158,6 +1158,55 @@ int main(int argc, char * argv [])
     }
   }
 
+  // Divide the port string into tokens separated by colon(s).
+  // There are four ways a port string can be presented:
+  // 1) -P [serialadapter]
+  // 2) -P [serialadapter]:[sernum]
+  // 3) -P [usbvid]:[usbpid]
+  // 4) -P [usbvid]:[usbpid]:[sernum]
+  char port_str[256];
+  char port_tok[3][256];
+  memset(port_tok, 0, sizeof(port_tok));
+  strcpy(port_str, (const char *)port);
+	char *tok = strtok(port_str, ":");
+	for (int i = 0; i < 3; i++) {
+    if (!tok)
+      break;
+    strcpy(port_tok[i], tok);
+    tok = strtok(NULL, ":");
+  }
+
+  // Use libserialport to find the actual serial port
+  const char *seradapter;
+  SERIALADAPTER *ser = locate_programmer_set(programmers, port_tok[0], &seradapter);
+  if (is_serialadapter(ser)) {
+    if (find_serialport_adapter(ser, port, port_tok[1]) < 0) {
+      if (port_tok[1][0])
+        pmsg_error("serial adapter %s with serial number %s not found\n", seradapter, port_tok[1]);
+      else
+        pmsg_error("serial adapter %s not found\n", seradapter);
+      exit(1);
+    }
+  } else if (is_programmer(ser)) {
+    if (port_tok[1][0])
+      pmsg_error("invalid serial adapter %s with serial number %s specified\n", seradapter, port_tok[1]);
+    else
+      pmsg_error("invalid serial adapter %s specified\n", port_tok[0]);
+    exit(1);
+  } else {
+    // Port or usb vid/pid
+    int vid, pid;
+    if (sscanf(port_tok[0], "%x", &vid) > 0 && sscanf(port_tok[1], "%x", &pid) > 0) {
+      if(find_serialport_vid_pid(port, vid, pid, port_tok[2]) < 0) {
+        if (port_tok[2][0])
+          pmsg_error("serial adapter with USB VID %s and PID %s and serial number %s not found\n", port_tok[0], port_tok[1], port_tok[2]);
+        else
+          pmsg_error("serial adapter with USB VID %s and PID %s not found\n", port_tok[0], port_tok[1]);
+        exit(1);
+      }
+    }
+  }
+
   /*
    * open the programmer
    */

src/serialadapter.c

@@ -1,6 +1,7 @@
 /*
  * AVRDUDE - A Downloader/Uploader for AVR device programmers
  * Copyright (C) 2023 Stefan Rueger <[email protected]>
+ * Copyright (C) 2023 Hans Eirik Bull
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -24,6 +25,137 @@
 #include "avrdude.h"
 #include "libavrdude.h"
 
+#ifdef HAVE_LIBSERIALPORT
+
+#include <libserialport.h>
+
+int find_serialport_adapter(const SERIALADAPTER *ser, char *serport, char *sernum) {
+  int rv = -1;
+  /* A pointer to a null-terminated array of pointers to
+   * struct sp_port, which will contain the ports found */
+  struct sp_port **port_list;
+
+  /* Call sp_list_ports() to get the ports. The port_list
+   * pointer will be updated to refer to the array created */
+  enum sp_return result = sp_list_ports(&port_list);
+
+  if (result != SP_OK) {
+    pmsg_error("sp_list_ports() failed!\n");
+    return -1;
+  }
+
+  for (int i = 0; port_list[i]; i++) {
+    struct sp_port *prt = port_list[i];
+    int usb_vid, usb_pid;
+    sp_get_port_usb_vid_pid(prt, &usb_vid, &usb_pid);
+
+    // USB VID match
+    if(usb_vid == ser->usbvid) {
+      for (LNODEID usbpid = lfirst(ser->usbpid); usbpid; usbpid = lnext(usbpid)) {
+        // USB PID match
+        if (usb_pid == *(int *)(ldata(usbpid))) {
+          // SN present
+          if (sernum && sernum[0]) {
+            // SN matches
+            char *s = sp_get_port_usb_serial(prt);
+            if(s) {
+              if (str_eq(sernum, s)) {
+                strcpy(serport, sp_get_port_name(prt));
+                rv = 0;
+              }
+            }
+            // SN does not match
+            else {
+              continue;
+            }
+          }
+          // SN not present
+          else {
+            char *p = sp_get_port_name(prt);
+            if(p) {
+              strcpy(serport, p);
+              rv = 0;
+            }
+            else
+              rv = -1;
+          }
+        }
+      }
+    }
+  }
+
+  sp_free_port_list(port_list); // Free the array created by sp_list_ports()
+  return rv;
+}
+
+int find_serialport_vid_pid(char *serport, int vid, int pid, char *sernum) {
+  int rv = -1;
+  /* A pointer to a null-terminated array of pointers to
+   * struct sp_port, which will contain the ports found */
+  struct sp_port **port_list;
+
+  /* Call sp_list_ports() to get the ports. The port_list
+   * pointer will be updated to refer to the array created */
+  enum sp_return result = sp_list_ports(&port_list);
+
+  if (result != SP_OK) {
+    pmsg_error("sp_list_ports() failed!\n");
+    return -1;
+  }
+
+  for (int i = 0; port_list[i]; i++) {
+    struct sp_port *prt = port_list[i];
+    int usb_vid, usb_pid;
+    sp_get_port_usb_vid_pid(prt, &usb_vid, &usb_pid);
+
+    // USB VID and PIDmatch
+    if(usb_vid == vid && usb_pid == pid) {
+      // SN present
+      if (sernum && sernum[0]) {
+        // SN matches
+        char *s = sp_get_port_usb_serial(prt);
+        if(s) {
+          if (str_eq(sernum, s)) {
+            strcpy(serport, sp_get_port_name(prt));
+            rv = 0;
+          }
+        }
+        // SN does not match
+        else {
+          continue;
+        }
+      }
+      // SN not present
+      else {
+        char *p = sp_get_port_name(prt);
+        if(p) {
+          strcpy(serport, p);
+          rv = 0;
+        }
+        else
+          rv = -1;
+      }
+    }
+  }
+
+  sp_free_port_list(port_list); // Free the array created by sp_list_ports()
+  return rv;
+}
+
+#else
+
+int find_serialport_adapter(const SERIALADAPTER *ser, char *port, char *sernum) {
+  pmsg_error("Avrdude built without libserialport support; please compile again with libserialport installed\n");
+  return -1;
+}
+
+int find_serialport_vid_pid(char *port, int vid, int pid, char *sernum) {
+  pmsg_error("Avrdude built without libserialport support; please compile again with libserialport installed\n");
+  return -1;
+}
+
+#endif
+
 void list_serialadapters(FILE *fp, const char *prefix, LISTID programmers) {
   LNODEID ln1, ln2, ln3;
   SERIALADAPTER *sea;