Added serial RPC transport and lots more...

Added RPC function to get server version number.
Substantially reworked GNUMakefile with conditionals.
Renamed rpc_*() and xdr_*() to hal_*() for consistency.
Moved hal_io_fmc.c from stm32 repo.

1 files changed, 104 insertions, 21 deletions

diff --git a/GNUmakefile b/GNUmakefile
index 0637f76..dc518b3 100644
--- a/GNUmakefile
+++ b/GNUmakefile
@@ -1,4 +1,4 @@
-# Copyright (c) 2015, NORDUnet A/S
+# Copyright (c) 2015-2016, NORDUnet A/S
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -36,28 +36,98 @@ STATIC_PKEY_STATE_BLOCKS = 6
 
 INC		= hal.h hal_internal.h
 LIB		= libhal.a
-OBJ		= core.o csprng.o hash.o aes_keywrap.o pbkdf2.o \
-		  modexp.o rsa.o ecdsa.o asn1.o errorstrings.o \
-		  ${IO_OBJ} ${RPC_OBJ} ${KS_OBJ}
 
-IO_OBJ_EIM	= hal_io_eim.o novena-eim.o
-IO_OBJ_I2C 	= hal_io_i2c.o
+OBJ		= errorstrings.o ${CORE_OBJ} ${IO_OBJ} ${RPC_OBJ} ${KS_OBJ}
+CORE_OBJ	:= core.o csprng.o hash.o aes_keywrap.o pbkdf2.o \
+		   modexp.o rsa.o ecdsa.o asn1.o
 
-# Default I/O bus is EIM, override this to use I2C instead
-IO_OBJ		= ${IO_OBJ_EIM}
+USAGE = "usage: make [IO_BUS=eim|i2c|fmc] [RPC_CLIENT=local|remote|mixed] [RPC_SERVER=yes] [KS=mmap|volatile|flash]"
 
-RPC_OBJ_COMMON	= rpc_api.o rpc_hash.o rpc_misc.o rpc_pkey.o rpc_xdr.o
-RPC_OBJ_CLIENT	= rpc_client.o rpc_client_loopback.o
-RPC_OBJ_SERVER	= rpc_server.o rpc_server_loopback.o
-
-# Default should be to build the RPC server code. We'll probably end up
-# needing a makefile conditional to handle all this properly.
-RPC_OBJ		= ${RPC_OBJ_COMMON} ${RPC_OBJ_CLIENT} ${RPC_OBJ_SERVER}
-
-KS_OBJ_COMMON	= ks.o
-KS_OBJ_MMAP	= ${KS_OBJ_COMMON} ks_mmap.o
-KS_OBJ_VOLATILE	= ${KS_OBJ_COMMON} ks_volatile.o
-KS_OBJ_FLASH	= ${KS_OBJ_COMMON} ks_flash.o
+# I/O bus to the FPGA
+#
+# IO_BUS = eim | i2c | fmc
+#   eim: EIM bus from Novena
+#   i2c: older I2C bus from Novena
+#   fmc: FMC bus from dev-bridge board
+
+IO_BUS ?= eim
+ifeq (${IO_BUS},eim)
+  IO_OBJ = hal_io_eim.o novena-eim.o
+else ifeq (${IO_BUS},i2c)
+  IO_OBJ = hal_io_i2c.o
+else ifeq (${IO_BUS},fmc)
+  IO_OBJ = hal_io_fmc.o
+endif
+
+# RPC_CLIENT = local | remote | mixed
+#   local: Build for Novena or dev-bridge, access FPGA cores directly.
+#   remote: Build for other host, communicate with RPC server.
+#   mixed: Do hashing locally in software, other functions remotely.
+#
+# RPC_SERVER = yes
+#
+# RPC_TRANSPORT = loopback | serial
+#   loopback: communicate over loopback socket on Novena
+#   serial: communicate over USB in serial pass-through mode
+
+RPC_CORE_OBJ = rpc_api.o rpc_hash.o rpc_misc.o rpc_pkey.o
+
+ifdef RPC_SERVER
+  RPC_SERVER_OBJ = rpc_server.o ${RPC_CORE_OBJ}
+  RPC_TRANSPORT ?= serial
+endif
+
+ifdef RPC_CLIENT
+  RPC_CLIENT_OBJ = rpc_client.o
+  ifeq (${RPC_CLIENT},local)
+    RPC_CLIENT_OBJ += ${RPC_CORE_OBJ}
+  else
+    RPC_TRANSPORT ?= serial
+    ifeq (${RPC_CLIENT},mixed)
+      CFLAGS += -DHAL_ENABLE_SOFTWARE_HASH_CORES
+    endif
+    ifndef RPC_SERVER
+      # If we're only building a remote RPC client lib, don't include
+      # the modules that access the FPGA cores.
+      CORE_OBJ :=
+      IO_OBJ :=
+    endif
+  endif
+endif
+
+ifdef RPC_TRANSPORT
+  RPC_TRANSPORT_OBJ = xdr.o
+  ifeq (${RPC_TRANSPORT},loopback)
+    ifdef RPC_SERVER
+      RPC_TRANSPORT_OBJ += rpc_server_loopback.o
+    endif
+    ifdef RPC_CLIENT
+      RPC_TRANSPORT_OBJ += rpc_client_loopback.o
+    endif
+  else ifeq (${RPC_TRANSPORT},serial)
+    RPC_TRANSPORT_OBJ += slip.o
+    ifdef RPC_SERVER
+      RPC_TRANSPORT_OBJ += rpc_server_serial.o
+    endif
+    ifdef RPC_CLIENT
+      RPC_TRANSPORT_OBJ += rpc_client_serial.o
+    endif
+  endif
+endif
+
+RPC_OBJ = ${RPC_SERVER_OBJ} ${RPC_CLIENT_OBJ} ${RPC_TRANSPORT_OBJ}
+
+# RPC client locality, for rpc_client.c. This has to be kept in sync with
+# hal_internal.h. Yeah, it's ugly, but the C preprocessor can only
+# compare integers, not strings.
+
+ifeq (${RPC_CLIENT},local)
+  RPC_CLIENT_FLAG = 0
+else ifeq (${RPC_CLIENT},remote)
+  RPC_CLIENT_FLAG = 1
+else ifeq (${RPC_CLIENT},mixed)
+  RPC_CLIENT_FLAG = 2
+endif
 
 # The mmap and flash keystore implementations are both server code.
 #
@@ -67,7 +137,15 @@ KS_OBJ_FLASH	= ${KS_OBJ_COMMON} ks_flash.o
 # Default at the moment is mmap, since that should work on the Novena
 # and we haven't yet written the flash code for the bridge board.
 
-KS_OBJ		= ${KS_OBJ_MMAP}
+KS_OBJ = ks.o
+KS ?= mmap
+ifeq (${KS},mmap)
+  KS_OBJ += ks_mmap.o
+else ifeq (${KS},volatile)
+  KS_OBJ += ks_volatile.o
+else ifeq (${KS},flash)
+  KS_OBJ += ks_flash.o
+endif
 
 TFMDIR		:= $(abspath ../thirdparty/libtfm)
 CFLAGS		+= -g3 -Wall -fPIC -std=c99 -I${TFMDIR} -DHAL_ECDSA_DEBUG_ONLY_STATIC_TEST_VECTOR_RANDOM=1
@@ -76,10 +154,13 @@ LDFLAGS		:= -g3 -L${TFMDIR} -ltfm
 CFLAGS		+= -DHAL_STATIC_HASH_STATE_BLOCKS=${STATIC_HASH_STATE_BLOCKS}
 CFLAGS		+= -DHAL_STATIC_HMAC_STATE_BLOCKS=${STATIC_HMAC_STATE_BLOCKS}
 CFLAGS		+= -DHAL_STATIC_PKEY_STATE_BLOCKS=${STATIC_PKEY_STATE_BLOCKS}
+CFLAGS		+= -DRPC_CLIENT=${RPC_CLIENT_FLAG}
 
 all: ${LIB}
 	cd tests; ${MAKE} CFLAGS='${CFLAGS} -I..' LDFLAGS='${LDFLAGS}' $@
+ifneq (${CORE_OBJ},)
 	cd utils; ${MAKE} CFLAGS='${CFLAGS} -I..' LDFLAGS='${LDFLAGS}' $@
+endif
 
 ${OBJ}: ${INC}
 
@@ -89,8 +170,10 @@ ${LIB}: ${OBJ}
 asn1.o rsa.o ecdsa.o:		asn1_internal.h
 ecdsa.o:			ecdsa_curves.h
 novena-eim.o hal_io_eim.o:	novena-eim.h
+slip.o rpc_client_serial.o rpc_server_serial.o:	slip_internal.h
 
 test: all
+	export RPC_CLIENT RPC_SERVER
 	cd tests; ${MAKE} -k $@
 
 clean: