Merge 63500f8dd0 into 93a7b2dfd3

Allow more fine-grained control over CMake targets

CMakeLists.txt

@@ -21,6 +21,25 @@ option(ENABLE_WERROR "Treat all compiler warnings as errors" OFF)
 option(ENABLE_GPS "Enable GPS support" OFF)
 option(BUILD_SHARED_LIBS "Build shared libraries" ON)
 
+# Options for controlling targets. These groups correspond to the README.
+option(ENABLE_BASIC_TOOLS "Build basic tools" ON)
+option(ENABLE_IP_SERVER   "Build tools providing CAN access via IP sockets" ON)
+option(ENABLE_GATEWAY     "Build in-kernel gateway configuration tools" ON)
+option(ENABLE_MEASUREMENT "Build measurement tools" ON)
+option(ENABLE_ISOTP       "Build isotp tools" ON)
+option(ENABLE_LOG_FILE    "Build log file converter tools" ON)
+option(ENABLE_SLCAN       "Build slcan tools" ON)
+option(ENABLE_MCP251XFD   "Build MCP251XFD tools" ON)
+
+# cmake_dependent_option is only available in CMake 3.22 and later.
+if(ANDROID)
+  set(ENABLE_J1939    OFF)
+  set(ENABLE_ISOBUSFS OFF)
+else()
+  option(ENABLE_J1939    "Build J1939 tools"  ON)
+  option(ENABLE_ISOBUSFS "Build ISOBUS tools" ON)
+endif()
+
 find_package(PkgConfig REQUIRED)
 if(ENABLE_GPS)
   pkg_check_modules(GPS REQUIRED libgps)
@@ -48,103 +67,111 @@ include_directories(./include)
 
 check_function_exists(fork HAVE_FORK)
 
-set(PROGRAMS_CANLIB
-  asc2log
-  canbusload
-  candump
-  cangen
-  canplayer
-  cansend
-  cansequence
-  log2asc
-  log2long
-  slcanpty
-)
+# List of all programs to be built.
+# Each program is expected to have a corresponding source file with the same name.
+set(PROGRAMS)
+# List of programs to link against can.
+set(PROGRAMS_CANLIB)
+# List of programs to link against j1939 and can.
+set(PROGRAMS_J1939)
 
-if(HAVE_FORK)
+if(ENABLE_BASIC_TOOLS)
+  list(APPEND PROGRAMS cansniffer)
+  list(APPEND PROGRAMS_CANLIB
+    candump
+    canplayer
+    cansend
+    cangen
+    cansequence
+  )
+endif()
+
+if(ENABLE_IP_SERVER AND HAVE_FORK)
+  list(APPEND PROGRAMS bcmserver)
   list(APPEND PROGRAMS_CANLIB canlogserver)
 endif()
 
-set(PROGRAMS_J1939
-  j1939acd
-  j1939cat
-  j1939spy
-  j1939sr
-  testj1939
-)
-
-set(PROGRAMS_J1939_TIMEDATE
-  j1939-timedate-srv
-  j1939-timedate-cli
-)
-
-set(PROGRAMS_J1939_VEHICLE_POSITION
-  j1939-vehicle-position-srv
-)
-
-set(PROGRAMS_ISOBUSFS
-  isobusfs-srv
-  isobusfs-cli
-)
-
-set(PROGRAMS
-  ${PROGRAMS_CANLIB}
-  canerrsim
-  canfdtest
-  cangw
-  cansniffer
-  isotpdump
-  isotpperf
-  isotprecv
-  isotpsend
-  isotpsniffer
-  isotptun
-  slcan_attach
-  slcand
-)
-
-if(HAVE_FORK)
-  list(APPEND PROGRAMS bcmserver)
-  list(APPEND PROGRAMS isotpserver)
+if(ENABLE_GATEWAY)
+  list(APPEND PROGRAMS cangw)
 endif()
 
-add_executable(can-calc-bit-timing
-  calc-bit-timing/can-calc-bit-timing.c
-)
+if(ENABLE_MEASUREMENT)
+  list(APPEND PROGRAMS
+    canfdtest
+    canerrsim
+  )
+  list(APPEND PROGRAMS_CANLIB canbusload)
 
-add_executable(mcp251xfd-dump
-  mcp251xfd/mcp251xfd-dev-coredump.c
-  mcp251xfd/mcp251xfd-dump.c
-  mcp251xfd/mcp251xfd-main.c
-  mcp251xfd/mcp251xfd-regmap.c
-)
+  add_executable(can-calc-bit-timing
+    calc-bit-timing/can-calc-bit-timing.c
+  )
+  install(TARGETS can-calc-bit-timing DESTINATION ${CMAKE_INSTALL_BINDIR})
+endif()
 
-if(NOT ANDROID)
-  list(APPEND PROGRAMS ${PROGRAMS_J1939})
-
-  add_library(j1939 STATIC
-    libj1939.c
+if(ENABLE_ISOTP)
+  list(APPEND PROGRAMS
+    isotpdump
+    isotpperf
+    isotprecv
+    isotpsend
+    isotpsniffer
+    isotptun
   )
 
-  target_link_libraries(j1939
-    PRIVATE can
+  if(HAVE_FORK)
+    list(APPEND PROGRAMS isotpserver)
+  endif()
+endif()
+
+if(ENABLE_J1939)
+  list(APPEND PROGRAMS_J1939
+    j1939acd
+    j1939cat
+    j1939spy
+    j1939sr
+    testj1939
   )
 
-  add_library(isobusfs
+  add_executable(j1939-timedate-cli
+    j1939_timedate/j1939_timedate_cli.c
+  )
+  target_link_libraries(j1939-timedate-cli
+    PRIVATE can j1939
+  )
+  install(TARGETS j1939-timedate-cli DESTINATION ${CMAKE_INSTALL_BINDIR})
+
+  add_executable(j1939-timedate-srv
+    j1939_timedate/j1939_timedate_srv.c
+  )
+  target_link_libraries(j1939-timedate-srv
+    PRIVATE can j1939
+  )
+  install(TARGETS j1939-timedate-srv DESTINATION ${CMAKE_INSTALL_BINDIR})
+endif()
+
+if(ENABLE_J1939 AND ENABLE_GPS)
+  add_executable(j1939-vehicle-position-srv
+    j1939_vehicle_position/j1939_vehicle_position_srv.c
+  )
+  target_link_libraries(j1939-vehicle-position-srv
+    PRIVATE can j1939 ${GPS_LIBRARIES}
+  )
+  install(TARGETS j1939-vehicle-position-srv DESTINATION ${CMAKE_INSTALL_BINDIR})
+endif()
+
+if(ENABLE_ISOBUSFS)
+  add_library(isobusfs EXCLUDE_FROM_ALL
     isobusfs/isobusfs_cmn.c
     isobusfs/isobusfs_cmn_dh.c
   )
-
   set(PUBLIC_HEADER_ISOBUSFS
     isobusfs/isobusfs_cmn.h
     isobusfs/isobusfs_cmn_cm.h
   )
-
   set_target_properties(isobusfs PROPERTIES
     PUBLIC_HEADER "${PUBLIC_HEADER_ISOBUSFS}"
     SOVERSION 0
   )
-
   install(TARGETS isobusfs
     LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
     PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
@@ -158,10 +185,10 @@ if(NOT ANDROID)
     isobusfs/isobusfs_cli_selftests.c
     isobusfs/isobusfs_cli_int.c
   )
-
   target_link_libraries(isobusfs-cli
     PRIVATE isobusfs can j1939
   )
+  install(TARGETS isobusfs-cli DESTINATION ${CMAKE_INSTALL_BINDIR})
 
   add_executable(isobusfs-srv
     isobusfs/isobusfs_srv.c
@@ -172,66 +199,55 @@ if(NOT ANDROID)
     isobusfs/isobusfs_srv_fh.c
     isobusfs/isobusfs_srv_vh.c
   )
-
   target_link_libraries(isobusfs-srv
     PRIVATE isobusfs can j1939
   )
-
-  install(TARGETS
-    isobusfs-cli
-    isobusfs-srv
-    DESTINATION ${CMAKE_INSTALL_BINDIR})
-
-  set(PUBLIC_HEADER_j1939_TIMEDATE
-    j1939_timedate/j1939_timedate_cmn.h
-  )
-
-  add_executable(j1939-timedate-cli
-    j1939_timedate/j1939_timedate_cli.c
-  )
-
-  target_link_libraries(j1939-timedate-cli
-    PRIVATE can j1939
-  )
-
-  add_executable(j1939-timedate-srv
-    j1939_timedate/j1939_timedate_srv.c
-  )
-
-  target_link_libraries(j1939-timedate-srv
-    PRIVATE can j1939
-  )
-
-  install(TARGETS
-    j1939-timedate-cli
-    j1939-timedate-srv
-    DESTINATION ${CMAKE_INSTALL_BINDIR})
-
-  if(ENABLE_GPS)
-    set(PUBLIC_HEADER_J1939_VEHICLE_POSITION
-      j1939_vehicle_position/j1939_vehicle_position_cmn.h
-    )
-
-    add_executable(j1939-vehicle-position-srv
-      j1939_vehicle_position/j1939_vehicle_position_srv.c
-    )
-
-    target_link_libraries(j1939-vehicle-position-srv
-      PRIVATE can j1939 ${GPS_LIBRARIES}
-    )
-
-    install(TARGETS
-      j1939-vehicle-position-srv
-      DESTINATION ${CMAKE_INSTALL_BINDIR})
-  endif()
-
+  install(TARGETS isobusfs-srv DESTINATION ${CMAKE_INSTALL_BINDIR})
 endif()
 
-add_library(can STATIC
+if(ENABLE_LOG_FILE)
+  list(APPEND PROGRAMS_CANLIB
+    asc2log
+    log2asc
+    log2long
+  )
+endif()
+
+if(ENABLE_SLCAN)
+  list(APPEND PROGRAMS
+    slcan_attach
+    slcand
+  )
+  list(APPEND PROGRAMS_CANLIB slcanpty)
+endif()
+
+if(ENABLE_MCP251XFD)
+  add_executable(mcp251xfd-dump
+    mcp251xfd/mcp251xfd-dev-coredump.c
+    mcp251xfd/mcp251xfd-dump.c
+    mcp251xfd/mcp251xfd-main.c
+    mcp251xfd/mcp251xfd-regmap.c
+  )
+  install(TARGETS mcp251xfd-dump DESTINATION ${CMAKE_INSTALL_BINDIR})
+endif()
+
+list(APPEND PROGRAMS
+  ${PROGRAMS_CANLIB}
+  ${PROGRAMS_J1939}
+)
+
+add_library(can STATIC EXCLUDE_FROM_ALL
   lib.c
   canframelen.c
 )
 
+add_library(j1939 STATIC EXCLUDE_FROM_ALL
+  libj1939.c
+)
+target_link_libraries(j1939
+  PRIVATE can
+)
+
 foreach(name ${PROGRAMS})
   add_executable(${name} ${name}.c)
 
@@ -248,12 +264,6 @@ foreach(name ${PROGRAMS})
   install(TARGETS ${name} DESTINATION ${CMAKE_INSTALL_BINDIR})
 endforeach()
 
-install(TARGETS
-  can-calc-bit-timing
-  mcp251xfd-dump
-  DESTINATION ${CMAKE_INSTALL_BINDIR}
-)
-
 add_custom_target(uninstall
   "${CMAKE_COMMAND}" -P "${CMAKE_SOURCE_DIR}/cmake/make_uninstall.cmake"
   COMMENT "Add uninstall target"

README.md

@@ -50,6 +50,10 @@ subsystem (aka SocketCAN):
 Follow the link to see examples on how this tools can be used:
 [Kickstart guide to can-j1939 on linux](https://github.com/linux-can/can-utils/blob/master/can-j1939-kickstart.md)
 
+#### ISOBus File server tools
+* isobusfs-cli : ISOBus file client
+* isobusfs-srv : ISOBus file server
+
 #### Log file converters
 * asc2log : convert ASC logfile to compact CAN frame logfile
 * log2asc : convert compact CAN frame logfile to ASC logfile

calc-bit-timing/can-calc-bit-timing.c

@@ -1121,6 +1121,11 @@ static const unsigned int common_data_bitrates[] = {
 	4000000,
 	2000000,
 	1000000,
+	800000,
+	500000,
+	250000,
+	125000,
+	100000,
 	0
 };
 

canplayer-bisect

@@ -0,0 +1,205 @@
+#!/bin/bash
+
+if [ -z "${CANPLAYER}" ]; then
+	CANPLAYER="canplayer"
+fi
+
+die() {
+	echo "$*" > /dev/stderr
+	exit 1
+}
+
+usage() {
+	echo "canplayer-bisect <start|stop|clean|good|yes|bad|no|again|where|undo> <logfile> <canplayer options>"
+}
+
+is_ready() {
+	if [ ! -d .canplayer-bisect ]; then
+		usage
+		exit 1
+	fi
+
+	return 0
+}
+
+setup() {
+	is_ready
+
+	LOGFILE=$(cat .canplayer-bisect/logfile |head -n 1)
+
+	SAVED_LEN="$(cat .canplayer-bisect/len|tail -n 1)"
+	LEN="$(wc -l ${LOGFILE} | awk '{ print $1 }')"
+
+	if [ "$LEN" != "$SAVED_LEN" ]; then
+		die "logfile has changed size. restart"
+	fi
+
+	CANPLAYER_ARGS=$(cat .canplayer-bisect/args |head -n 1)
+
+	HEAD="$(cat .canplayer-bisect/head |tail -n 1)"
+	TAIL="$(cat .canplayer-bisect/tail |tail -n 1)"
+}
+
+back() {
+	HEAD="$(cat .canplayer-bisect/head |tail -n 2 |head -n1)"
+	TAIL="$(cat .canplayer-bisect/tail |tail -n 2 |head -n1)"
+}
+
+do_undo() {
+	sed -i '$ d' .canplayer-bisect/head
+	sed -i '$ d' .canplayer-bisect/tail
+}
+
+teardown() {
+	mkdir -p .canplayer-bisect
+	echo $LEN > .canplayer-bisect/len
+	echo $LOGFILE > .canplayer-bisect/logfile
+	echo $CANPLAYER_ARGS > .canplayer-bisect/args
+
+	echo $HEAD >> .canplayer-bisect/head
+	echo $TAIL >> .canplayer-bisect/tail
+}
+
+show() {
+	cat $LOGFILE | sed -n ${HEAD},${TAIL}p
+}
+
+play() {
+	#we *could* pipe directly to canplayer, but then the user can't add -l i to CANPLAYER_ARGS to hunt for packets using looped playback
+	the_show="$(mktemp)"
+	trap "rm -rf \"${the_show}\"" EXIT
+
+	show > "${the_show}"
+	"${CANPLAYER}" ${CANPLAYER_ARGS} -I "${the_show}"
+}
+
+do_show() {
+	setup
+
+	show
+}
+
+check_heads_n_tails() {
+	if [ $HEAD -eq $TAIL ]; then
+		do_stop
+	fi
+}
+
+do_good() {
+	setup
+
+	check_heads_n_tails
+
+	if [ $(( $HEAD + 1 )) -eq $TAIL ]; then
+		TAIL=$HEAD
+	else
+		TAIL=$(( ( $TAIL - $HEAD ) / 2 + $HEAD - 1 ))
+	fi
+
+	teardown
+	play
+}
+
+do_bad() {
+	setup
+
+	check_heads_n_tails
+
+	back
+	if [ $(( $HEAD + 1 )) -eq $TAIL ]; then
+		HEAD=$TAIL
+	else
+		HEAD=$(( ( $TAIL - $HEAD ) / 2 + $HEAD ))
+	fi
+
+	teardown
+	play
+}
+
+do_again() {
+	setup
+	play
+}
+
+do_start() {
+	do_clean
+
+	LEN="$(wc -l ${LOGFILE} | awk '{ print $1 }')"
+
+	HEAD=1
+	TAIL=$LEN
+
+	echo "assuming logfile contains the packets you seek... bisecting to first half"
+
+	teardown
+	play
+}
+
+do_where() {
+	setup
+	echo "between $HEAD and $TAIL (+$(( $TAIL - $HEAD ))) of $LOGFILE"
+}
+
+do_stop() {
+	setup
+
+	if [ "$COMMAND" == "no" ]; then
+		echo "failed to find what you were looking for"
+		exit 1
+	else
+		echo "the packets you seek are:"
+		do_where
+		exit 0
+	fi
+}
+
+do_clean() {
+	rm -rf .canplayer-bisect
+}
+
+if [ -z "$1" ]; then
+	usage
+	exit 1
+fi
+COMMAND=$1
+
+if [ ! -d .canplayer-bisect ] && [ ! -z "$2" ] && [ ! -e "$2" ]; then
+	usage
+	exit 1
+fi
+LOGFILE="$2"
+
+shift
+shift
+CANPLAYER_ARGS="$*"
+
+case "$COMMAND" in
+	start)
+		do_start
+	;;
+	stop)
+		do_stop
+	;;
+	clean)
+		do_clean
+	;;
+	good|yes)
+		do_good
+	;;
+	bad|no)
+		do_bad
+	;;
+	again)
+		do_again
+	;;
+	where)
+		do_where
+	;;
+	undo)
+		do_undo
+	;;
+	show)
+		do_show
+	;;
+esac
+