PTT using GPIO of CM108/CM119.

Author: wb2osz

99-direwolf-cmedia.rules

@@ -0,0 +1,30 @@
+# Normally, all of /dev/hidraw* are accessible only by root.
+#
+#	$ ls -l /dev/hidraw*
+#	crw------- 1 root root 247, 0 Sep 24 09:40 /dev/hidraw0
+#
+# An ordinary user, trying to acccess it will be denied.
+#
+# Unnecessarily running applications as root is generally a bad idea because it makes it too easy
+# to accidentally trash your system.  We need to relax the restrictions so ordinary users can use these devices.
+#
+# If all went well with installation, the  /etc/udev/rules.d directory should contain a file called
+# 99-direwolf-cmedia.rules  containing:
+#
+
+SUBSYSTEM=="hidraw", ATTRS{idVendor}=="0d8c", GROUP="audio", MODE="0660"
+
+#
+# I used the "audio" group, mimicking the permissions on the sound side of the device.
+#
+#	$ ls -l /dev/snd/pcm*
+#	crw-rw----+ 1 root audio 116, 16 Sep 24 09:40 /dev/snd/pcmC0D0p
+#	crw-rw----+ 1 root audio 116, 17 Sep 24 09:40 /dev/snd/pcmC0D1p
+#
+# You should see something similar to this where someone in the "audio" group has read-write access.
+#
+#	$ ls -l /dev/hidraw*
+#	crw-rw---- 1 root audio 247, 0 Oct  6 19:24 /dev/hidraw0
+#
+# Read the User Guide and run the "cm108" application for more information.
+#

CHANGES.md

@@ -11,6 +11,8 @@ This is a snapshot of ongoing development towards version of 1.5.  Some features
 
 - KISS "Set Hardware" command to report transmit queue length.
 
+- PTT using GPIO pin of CM108/CM119 (e.g. DMK URI, RB-USB RIM)
+
 
 ### Bugs Fixed: ###
 

Makefile.linux

@@ -4,7 +4,7 @@
 
 
 
-APPS := direwolf decode_aprs text2tt tt2text ll2utm utm2ll aclients atest log2gpx gen_packets ttcalc kissutil
+APPS := direwolf decode_aprs text2tt tt2text ll2utm utm2ll aclients atest log2gpx gen_packets ttcalc kissutil cm108
 
 all :  $(APPS) direwolf.desktop direwolf.conf
 	@echo " "
@@ -292,6 +292,21 @@ LDFLAGS += -lhamlib
 endif
 
 
+# If, for some reason, can obtain the libudev-dev package, or
+# don't want to install it, comment out the next 3 lines.
+
+ifeq ($(wildcard /usr/include/libudev.h),)
+$(error /usr/include/libudev.h does not exist.  Install it with "sudo apt-get install libudev-dev" or "sudo yum install libudev-dev" )
+endif
+
+
+# Enable cm108 PTT support if libudev header file is present.
+
+enable_cm108 := $(wildcard /usr/include/libudev.h)
+ifneq ($(enable_cm108),)
+CFLAGS += -DUSE_CM108
+LDFLAGS += -ludev
+endif
 
 
 # Name of current directory.
@@ -312,7 +327,7 @@ direwolf : direwolf.o config.o recv.o demod.o dsp.o demod_afsk.o demod_psk.o dem
 		gen_tone.o audio.o audio_stats.o digipeater.o cdigipeater.o pfilter.o dedupe.o tq.o xmit.o morse.o \
 		ptt.o beacon.o encode_aprs.o latlong.o encode_aprs.o latlong.o textcolor.o \
 		dtmf.o aprs_tt.o tt_user.o tt_text.o igate.o waypoint.o serial_port.o log.o telemetry.o \
-		dwgps.o dwgpsnmea.o dwgpsd.o dtime_now.o mheard.o ax25_link.o \
+		dwgps.o dwgpsnmea.o dwgpsd.o dtime_now.o mheard.o ax25_link.o cm108.o \
 		misc.a geotranz.a
 	$(CC) -o $@ $^ $(LDFLAGS)
 	@echo " "
@@ -325,6 +340,11 @@ ifneq ($(enable_hamlib),)
 	@echo "\t>\tThis includes support for hamlib."
 else
 	@echo "\t>\tThis does NOT include support for hamlib."
+endif
+ifneq ($(enable_cm108),)
+	@echo "\t>\tThis includes support for CM108/CM119 PTT."
+else
+	@echo "\t>\tThis does NOT include support for CM108/CM119 PTT."
 endif
 	@echo " "
 
@@ -435,6 +455,12 @@ kissutil : kissutil.c kiss_frame.c ax25_pad.o fcs_calc.o textcolor.o serial_port
 	$(CC) $(CFLAGS) -g -DKISSUTIL -o $@ $^ $(LDFLAGS)
 
 
+# List USB audio adapters than can use GPIO for PTT.
+
+cm108 : cm108.c textcolor.o misc.a
+	$(CC) $(CFLAGS) -g -DCM108_MAIN -o $@ $^ $(LDFLAGS)
+
+
 # Touch Tone to Speech sample application.
 
 ttcalc : ttcalc.o ax25_pad.o fcs_calc.o textcolor.o misc.a
@@ -569,6 +595,7 @@ install : $(APPS) direwolf.conf tocalls.txt symbols-new.txt symbolsX.txt dw-icon
 	$(INSTALL) atest $(INSTALLDIR)/bin
 	$(INSTALL) ttcalc $(INSTALLDIR)/bin
 	$(INSTALL) kissutil $(INSTALLDIR)/bin
+	$(INSTALL) cm108 $(INSTALLDIR)/bin
 	$(INSTALL) dwespeak.sh $(INSTALLDIR)/bin
 #
 # Telemetry Toolkit executables.   Other .conf and .txt files will go into doc directory.
@@ -643,6 +670,11 @@ install : $(APPS) direwolf.conf tocalls.txt symbols-new.txt symbolsX.txt dw-icon
 	$(INSTALL) -D --mode=644 man1/text2tt.1 $(INSTALLDIR)/man/man1/text2tt.1
 	$(INSTALL) -D --mode=644 man1/tt2text.1 $(INSTALLDIR)/man/man1/tt2text.1
 	$(INSTALL) -D --mode=644 man1/utm2ll.1 $(INSTALLDIR)/man/man1/utm2ll.1
+#
+# Set group and mode of HID devices corresponding to C-Media USB Audio adapters.
+# This will allow us to use the CM108/CM119 GPIO pins for PTT.
+#
+	$(INSTALL) -D --mode=644 99-direwolf-cmedia.rules /etc/udev/rules.d/99-direwolf-cmedia.rules
 #
 	@echo " "
 	@echo "If this is your first install, not an upgrade, type this to put a copy"

audio.h

@@ -29,8 +29,9 @@ 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, Linux only. */
-	PTT_METHOD_LPT,	    /* Parallel printer port, Linux only. */
-    PTT_METHOD_HAMLIB }; /* HAMLib, Linux only. */
+	PTT_METHOD_LPT,	    	/* Parallel printer port, Linux only. */
+	PTT_METHOD_HAMLIB, 	/* HAMLib, Linux only. */
+	PTT_METHOD_CM108 };	/* GPIO pin of CM108/CM119/etc.  Linux only. */
 
 typedef enum ptt_method_e ptt_method_t;
 
@@ -191,22 +192,27 @@ struct audio_s {
 
 	    struct {  		
 
-	        ptt_method_t ptt_method; /* none, serial port, GPIO, LPT, HAMLIB. */
+	        ptt_method_t ptt_method; /* none, serial port, GPIO, LPT, HAMLIB, CM108. */
 
 	        char ptt_device[100];	/* Serial device name for PTT.  e.g. COM1 or /dev/ttyS0 */
 					/* Also used for HAMLIB.  Could be host:port when model is 1. */
-					/* For years, 20 characters was plenty and then along comes this crazy name: */
+					/* For years, 20 characters was plenty then we start getting extreme names like this: */
+					/* /dev/serial/by-id/usb-FTDI_Navigator__CAT___2nd_PTT__00000000-if00-port0 */
 					/* /dev/serial/by-id/usb-Prolific_Technology_Inc._USB-Serial_Controller_D-if00-port0 */
 					/* Issue 104, changed to 100 bytes in version 1.5. */
+
+					/* This same field is also used for CM108 GPIO PTT which will */
+					/* have a name like /dev/hidraw1. */
 
 	        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. */
 
 	        int out_gpio_num;	/* GPIO number.  Originally this was only for PTT. */
 					/* It is now more general. */
 					/* octrl array is indexed by PTT, DCD, or CONnected indicator. */
+					/* For CM108, this should be in range of 1-8. */
 
-#define MAX_GPIO_NAME_LEN 16	// 12 would cover any case I've seen so this should be safe
+#define MAX_GPIO_NAME_LEN 20	// 12 would cover any case I've seen so this should be safe
 
 		char out_gpio_name[MAX_GPIO_NAME_LEN];
 					/* orginally, gpio number NN was assumed to simply */
@@ -215,6 +221,8 @@ struct audio_s {
 					/* This is filled in by ptt_init so we don't have to */
 					/* recalculate it each time we access it. */
 
+					/* This could probably be collapsed into ptt_device instead of being separate. */
+
 	        int ptt_lpt_bit;	/* Bit number for parallel printer port.  */
 					/* Bit 0 = pin 2, ..., bit 7 = pin 9. */